/*
 * Copyright (C) 2008, Nokia <ivan.frade@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 */

#ifndef __LIBTRACKER_COMMON_FILE_UTILS_H__
#define __LIBTRACKER_COMMON_FILE_UTILS_H__

#include <stdio.h>

#include <glib.h>
#include <gio/gio.h>

G_BEGIN_DECLS

#if !defined (__LIBTRACKER_COMMON_INSIDE__) && !defined (TRACKER_COMPILATION)
#error "only <libtracker-common/tracker-common.h> must be included directly."
#endif

/* File utils */
FILE*    tracker_file_open          (const gchar  *uri,
                                     const gchar  *how,
                                     gboolean      sequential);
void     tracker_file_close         (FILE         *file,
                                     gboolean      need_again_soon);
goffset  tracker_file_get_size      (const gchar  *uri);
guint64  tracker_file_get_mtime     (const gchar  *uri);
gchar *  tracker_file_get_mime_type (GFile        *file);
gboolean tracker_file_lock          (GFile        *file);
gboolean tracker_file_unlock        (GFile        *file);
gboolean tracker_file_is_locked     (GFile        *file);
gboolean tracker_file_is_hidden     (GFile        *file);
gint     tracker_file_cmp           (GFile        *file_a,
                                     GFile        *file_b);

/* Path utils */
gboolean tracker_path_is_in_path                      (const gchar  *path,
                                                       const gchar  *in_path);
GSList * tracker_path_list_filter_duplicates          (GSList       *roots,
                                                       const gchar  *basename_exception_prefix,
                                                       gboolean      is_recursive);
gchar *  tracker_path_evaluate_name                   (const gchar  *uri);
gboolean tracker_path_has_write_access_or_was_created (const gchar  *path);

/* File system utils */
gboolean tracker_file_system_has_enough_space               (const gchar  *path,
                                                             gulong        required_bytes,
                                                             gboolean      creating_db);
guint64  tracker_file_system_get_remaining_space            (const gchar  *path);
gdouble  tracker_file_system_get_remaining_space_percentage (const gchar  *path);

/* Environment path utils */
gboolean tracker_env_check_xdg_dirs (void);

G_END_DECLS

#endif /* __LIBTRACKER_COMMON_FILE_UTILS_H__ */
