gio/gfile.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2
   3 /* GIO - GLib Input, Output and Streaming Library
   4  *
   5  * Copyright (C) 2006-2007 Red Hat, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  *
  22  * Author: Alexander Larsson <alexl@redhat.com>
  23  */
  24
  25 #include "config.h"
  26 #ifdef HAVE_SPLICE
  27 #include <sys/stat.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30 #include <errno.h>
  31 #endif
  32 #include <string.h>
  33 #include <sys/types.h>
  34 #ifdef HAVE_PWD_H
  35 #include <pwd.h>
  36 #endif
  37 #include "gfile.h"
  38 #include "gvfs.h"
  39 #include "gioscheduler.h"
  40 #include "gsimpleasyncresult.h"
  41 #include "gfileattribute-priv.h"
  42 #include "gfiledescriptorbased.h"
  43 #include "gpollfilemonitor.h"
  44 #include "gappinfo.h"
  45 #include "gfileinputstream.h"
  46 #include "gfileoutputstream.h"
  47 #include "glocalfileoutputstream.h"
  48 #include "glocalfileiostream.h"
  49 #include "gcancellable.h"
  50 #include "gasyncresult.h"
  51 #include "gioerror.h"
  52 #include "glibintl.h"
  53
  54
  55 /**
  56  * SECTION:gfile
  57  * @short_description: File and Directory Handling
  58  * @include: gio/gio.h
  59  * @see_also: #GFileInfo, #GFileEnumerator
  60  *
  61  * #GFile is a high level abstraction for manipulating files on a
  62  * virtual file system. #GFile<!-- -->s are lightweight, immutable
  63  * objects that do no I/O upon creation. It is necessary to understand that
  64  * #GFile objects do not represent files, merely an identifier for a file. All
  65  * file content I/O is implemented as streaming operations (see #GInputStream and
  66  * #GOutputStream).
  67  *
  68  * To construct a #GFile, you can use:
  69  * g_file_new_for_path() if you have a path.
  70  * g_file_new_for_uri() if you have a URI.
  71  * g_file_new_for_commandline_arg() for a command line argument.
  72  * g_file_new_tmp() to create a temporary file from a template.
  73  * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name().
  74  *
  75  * One way to think of a #GFile is as an abstraction of a pathname. For normal
  76  * files the system pathname is what is stored internally, but as #GFile<!-- -->s
  77  * are extensible it could also be something else that corresponds to a pathname
  78  * in a userspace implementation of a filesystem.
  79  *
  80  * #GFile<!-- -->s make up hierarchies of directories and files that correspond to the
  81  * files on a filesystem. You can move through the file system with #GFile using
  82  * g_file_get_parent() to get an identifier for the parent directory, g_file_get_child()
  83  * to get a child within a directory, g_file_resolve_relative_path() to resolve a relative
  84  * path between two #GFile<!-- -->s. There can be multiple hierarchies, so you may not
  85  * end up at the same root if you repeatedly call g_file_get_parent() on two different
  86  * files.
  87  *
  88  * All #GFile<!-- -->s have a basename (get with g_file_get_basename()). These names
  89  * are byte strings that are used to identify the file on the filesystem (relative to
  90  * its parent directory) and there is no guarantees that they have any particular charset
  91  * encoding or even make any sense at all. If you want to use filenames in a user
  92  * interface you should use the display name that you can get by requesting the
  93  * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
  94  * This is guaranteed to be in utf8 and can be used in a user interface. But always
  95  * store the real basename or the #GFile to use to actually access the file, because
  96  * there is no way to go from a display name to the actual name.
  97  *
  98  * Using #GFile as an identifier has the same weaknesses as using a path in that
  99  * there may be multiple aliases for the same file. For instance, hard or
 100  * soft links may cause two different #GFile<!-- -->s to refer to the same file.
 101  * Other possible causes for aliases are: case insensitive filesystems, short
 102  * and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if
 103  * two #GFile<!-- -->s point to the same file you can query for the
 104  * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
 105  * canonicalization of pathnames passed in, so that trivial differences in the
 106  * path string used at creation (duplicated slashes, slash at end of path, "."
 107  * or ".." path segments, etc) does not create different #GFile<!-- -->s.
 108  *
 109  * Many #GFile operations have both synchronous and asynchronous versions
 110  * to suit your application. Asynchronous versions of synchronous functions
 111  * simply have _async() appended to their function names. The asynchronous
 112  * I/O functions call a #GAsyncReadyCallback which is then used to finalize
 113  * the operation, producing a GAsyncResult which is then passed to the
 114  * function's matching _finish() operation.
 115  *
 116  * Some #GFile operations do not have synchronous analogs, as they may
 117  * take a very long time to finish, and blocking may leave an application
 118  * unusable. Notable cases include:
 119  * g_file_mount_mountable() to mount a mountable file.
 120  * g_file_unmount_mountable_with_operation() to unmount a mountable file.
 121  * g_file_eject_mountable_with_operation() to eject a mountable file.
 122  *
 123  * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
 124  * One notable feature of #GFile<!-- -->s are entity tags, or "etags" for
 125  * short. Entity tags are somewhat like a more abstract version of the
 126  * traditional mtime, and can be used to quickly determine if the file has
 127  * been modified from the version on the file system. See the HTTP 1.1
 128  * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
 129  * for HTTP Etag headers, which are a very similar concept.
 130  * </para>
 131  **/
 132
 133 static void               g_file_real_query_info_async            (GFile                  *file,
 134                                                                    const char             *attributes,
 135                                                                    GFileQueryInfoFlags     flags,
 136                                                                    int                     io_priority,
 137                                                                    GCancellable           *cancellable,
 138                                                                    GAsyncReadyCallback     callback,
 139                                                                    gpointer                user_data);
 140 static GFileInfo *        g_file_real_query_info_finish           (GFile                  *file,
 141                                                                    GAsyncResult           *res,
 142                                                                    GError                **error);
 143 static void               g_file_real_query_filesystem_info_async (GFile                  *file,
 144                                                                    const char             *attributes,
 145                                                                    int                     io_priority,
 146                                                                    GCancellable           *cancellable,
 147                                                                    GAsyncReadyCallback     callback,
 148                                                                    gpointer                user_data);
 149 static GFileInfo *        g_file_real_query_filesystem_info_finish (GFile                  *file,
 150                                                                    GAsyncResult           *res,
 151                                                                    GError                **error);
 152 static void               g_file_real_enumerate_children_async    (GFile                  *file,
 153                                                                    const char             *attributes,
 154                                                                    GFileQueryInfoFlags     flags,
 155                                                                    int                     io_priority,
 156                                                                    GCancellable           *cancellable,
 157                                                                    GAsyncReadyCallback     callback,
 158                                                                    gpointer                user_data);
 159 static GFileEnumerator *  g_file_real_enumerate_children_finish   (GFile                  *file,
 160                                                                    GAsyncResult           *res,
 161                                                                    GError                **error);
 162 static void               g_file_real_read_async                  (GFile                  *file,
 163                                                                    int                     io_priority,
 164                                                                    GCancellable           *cancellable,
 165                                                                    GAsyncReadyCallback     callback,
 166                                                                    gpointer                user_data);
 167 static GFileInputStream * g_file_real_read_finish                 (GFile                  *file,
 168                                                                    GAsyncResult           *res,
 169                                                                    GError                **error);
 170 static void               g_file_real_append_to_async             (GFile                  *file,
 171                                                                    GFileCreateFlags        flags,
 172                                                                    int                     io_priority,
 173                                                                    GCancellable           *cancellable,
 174                                                                    GAsyncReadyCallback     callback,
 175                                                                    gpointer                user_data);
 176 static GFileOutputStream *g_file_real_append_to_finish            (GFile                  *file,
 177                                                                    GAsyncResult           *res,
 178                                                                    GError                **error);
 179 static void               g_file_real_create_async                (GFile                  *file,
 180                                                                    GFileCreateFlags        flags,
 181                                                                    int                     io_priority,
 182                                                                    GCancellable           *cancellable,
 183                                                                    GAsyncReadyCallback     callback,
 184                                                                    gpointer                user_data);
 185 static GFileOutputStream *g_file_real_create_finish               (GFile                  *file,
 186                                                                    GAsyncResult           *res,
 187                                                                    GError                **error);
 188 static void               g_file_real_replace_async               (GFile                  *file,
 189                                                                    const char             *etag,
 190                                                                    gboolean                make_backup,
 191                                                                    GFileCreateFlags        flags,
 192                                                                    int                     io_priority,
 193                                                                    GCancellable           *cancellable,
 194                                                                    GAsyncReadyCallback     callback,
 195                                                                    gpointer                user_data);
 196 static GFileOutputStream *g_file_real_replace_finish              (GFile                  *file,
 197                                                                    GAsyncResult           *res,
 198                                                                    GError                **error);
 199 static void               g_file_real_delete_async                (GFile                  *file,
 200                                                                    int                     io_priority,
 201                                                                    GCancellable           *cancellable,
 202                                                                    GAsyncReadyCallback     callback,
 203                                                                    gpointer                user_data);
 204 static gboolean           g_file_real_delete_finish               (GFile                  *file,
 205                                                                    GAsyncResult           *res,
 206                                                                    GError                **error);
 207 static void               g_file_real_open_readwrite_async        (GFile                  *file,
 208                                                                    int                  io_priority,
 209                                                                    GCancellable           *cancellable,
 210                                                                    GAsyncReadyCallback     callback,
 211                                                                    gpointer                user_data);
 212 static GFileIOStream *    g_file_real_open_readwrite_finish       (GFile                  *file,
 213                                                                    GAsyncResult           *res,
 214                                                                    GError                **error);
 215 static void               g_file_real_create_readwrite_async      (GFile                  *file,
 216                                                                    GFileCreateFlags        flags,
 217                                                                    int                     io_priority,
 218                                                                    GCancellable           *cancellable,
 219                                                                    GAsyncReadyCallback     callback,
 220                                                                    gpointer                user_data);
 221 static GFileIOStream *    g_file_real_create_readwrite_finish     (GFile                  *file,
 222                                                                    GAsyncResult           *res,
 223                                                                    GError                **error);
 224 static void               g_file_real_replace_readwrite_async     (GFile                  *file,
 225                                                                    const char             *etag,
 226                                                                    gboolean                make_backup,
 227                                                                    GFileCreateFlags        flags,
 228                                                                    int                     io_priority,
 229                                                                    GCancellable           *cancellable,
 230                                                                    GAsyncReadyCallback     callback,
 231                                                                    gpointer                user_data);
 232 static GFileIOStream *    g_file_real_replace_readwrite_finish    (GFile                  *file,
 233                                                                   GAsyncResult            *res,
 234                                                                   GError                 **error);
 235 static gboolean           g_file_real_set_attributes_from_info    (GFile                  *file,
 236                                                                    GFileInfo              *info,
 237                                                                    GFileQueryInfoFlags     flags,
 238                                                                    GCancellable           *cancellable,
 239                                                                    GError                **error);
 240 static void               g_file_real_set_display_name_async      (GFile                  *file,
 241                                                                    const char             *display_name,
 242                                                                    int                     io_priority,
 243                                                                    GCancellable           *cancellable,
 244                                                                    GAsyncReadyCallback     callback,
 245                                                                    gpointer                user_data);
 246 static GFile *            g_file_real_set_display_name_finish     (GFile                  *file,
 247                                                                    GAsyncResult           *res,
 248                                                                    GError                **error);
 249 static void               g_file_real_set_attributes_async        (GFile                  *file,
 250                                                                    GFileInfo              *info,
 251                                                                    GFileQueryInfoFlags     flags,
 252                                                                    int                     io_priority,
 253                                                                    GCancellable           *cancellable,
 254                                                                    GAsyncReadyCallback     callback,
 255                                                                    gpointer                user_data);
 256 static gboolean           g_file_real_set_attributes_finish       (GFile                  *file,
 257                                                                    GAsyncResult           *res,
 258                                                                    GFileInfo             **info,
 259                                                                    GError                **error);
 260 static void               g_file_real_find_enclosing_mount_async  (GFile                  *file,
 261                                                                    int                     io_priority,
 262                                                                    GCancellable           *cancellable,
 263                                                                    GAsyncReadyCallback     callback,
 264                                                                    gpointer                user_data);
 265 static GMount *           g_file_real_find_enclosing_mount_finish (GFile                  *file,
 266                                                                    GAsyncResult           *res,
 267                                                                    GError                **error);
 268 static void               g_file_real_copy_async                  (GFile                  *source,
 269                                                                    GFile                  *destination,
 270                                                                    GFileCopyFlags          flags,
 271                                                                    int                     io_priority,
 272                                                                    GCancellable           *cancellable,
 273                                                                    GFileProgressCallback   progress_callback,
 274                                                                    gpointer                progress_callback_data,
 275                                                                    GAsyncReadyCallback     callback,
 276                                                                    gpointer                user_data);
 277 static gboolean           g_file_real_copy_finish                 (GFile                  *file,
 278                                                                    GAsyncResult           *res,
 279                                                                    GError                **error);
 280
 281 typedef GFileIface GFileInterface;
 282 G_DEFINE_INTERFACE (GFile, g_file, G_TYPE_OBJECT)
 283
 284 static void
 285 g_file_default_init (GFileIface *iface)
 286 {
 287   iface->enumerate_children_async = g_file_real_enumerate_children_async;
 288   iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
 289   iface->set_display_name_async = g_file_real_set_display_name_async;
 290   iface->set_display_name_finish = g_file_real_set_display_name_finish;
 291   iface->query_info_async = g_file_real_query_info_async;
 292   iface->query_info_finish = g_file_real_query_info_finish;
 293   iface->query_filesystem_info_async = g_file_real_query_filesystem_info_async;
 294   iface->query_filesystem_info_finish = g_file_real_query_filesystem_info_finish;
 295   iface->set_attributes_async = g_file_real_set_attributes_async;
 296   iface->set_attributes_finish = g_file_real_set_attributes_finish;
 297   iface->read_async = g_file_real_read_async;
 298   iface->read_finish = g_file_real_read_finish;
 299   iface->append_to_async = g_file_real_append_to_async;
 300   iface->append_to_finish = g_file_real_append_to_finish;
 301   iface->create_async = g_file_real_create_async;
 302   iface->create_finish = g_file_real_create_finish;
 303   iface->replace_async = g_file_real_replace_async;
 304   iface->replace_finish = g_file_real_replace_finish;
 305   iface->delete_file_async = g_file_real_delete_async;
 306   iface->delete_file_finish = g_file_real_delete_finish;
 307   iface->open_readwrite_async = g_file_real_open_readwrite_async;
 308   iface->open_readwrite_finish = g_file_real_open_readwrite_finish;
 309   iface->create_readwrite_async = g_file_real_create_readwrite_async;
 310   iface->create_readwrite_finish = g_file_real_create_readwrite_finish;
 311   iface->replace_readwrite_async = g_file_real_replace_readwrite_async;
 312   iface->replace_readwrite_finish = g_file_real_replace_readwrite_finish;
 313   iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
 314   iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
 315   iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
 316   iface->copy_async = g_file_real_copy_async;
 317   iface->copy_finish = g_file_real_copy_finish;
 318 }
 319
 320
 321 /**
 322  * g_file_is_native:
 323  * @file: input #GFile.
 324  *
 325  * Checks to see if a file is native to the platform.
 326  *
 327  * A native file s one expressed in the platform-native filename format,
 328  * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
 329  * as it might be on a locally mounted remote filesystem.
 330  *
 331  * On some systems non-native files may be available using
 332  * the native filesystem via a userspace filesystem (FUSE), in
 333  * these cases this call will return %FALSE, but g_file_get_path()
 334  * will still return a native path.
 335  *
 336  * This call does no blocking i/o.
 337  *
 338  * Returns: %TRUE if file is native.
 339  **/
 340 gboolean
 341 g_file_is_native (GFile *file)
 342 {
 343   GFileIface *iface;
 344
 345   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 346
 347   iface = G_FILE_GET_IFACE (file);
 348
 349   return (* iface->is_native) (file);
 350 }
 351
 352
 353 /**
 354  * g_file_has_uri_scheme:
 355  * @file: input #GFile.
 356  * @uri_scheme: a string containing a URI scheme.
 357  *
 358  * Checks to see if a #GFile has a given URI scheme.
 359  *
 360  * This call does no blocking i/o.
 361  *
 362  * Returns: %TRUE if #GFile's backend supports the
 363  *     given URI scheme, %FALSE if URI scheme is %NULL,
 364  *     not supported, or #GFile is invalid.
 365  **/
 366 gboolean
 367 g_file_has_uri_scheme (GFile      *file,
 368                        const char *uri_scheme)
 369 {
 370   GFileIface *iface;
 371
 372   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 373   g_return_val_if_fail (uri_scheme != NULL, FALSE);
 374
 375   iface = G_FILE_GET_IFACE (file);
 376
 377   return (* iface->has_uri_scheme) (file, uri_scheme);
 378 }
 379
 380
 381 /**
 382  * g_file_get_uri_scheme:
 383  * @file: input #GFile.
 384  *
 385  * Gets the URI scheme for a #GFile.
 386  * RFC 3986 decodes the scheme as:
 387  * <programlisting>
 388  * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
 389  * </programlisting>
 390  * Common schemes include "file", "http", "ftp", etc.
 391  *
 392  * This call does no blocking i/o.
 393  *
 394  * Returns: a string containing the URI scheme for the given
 395  *     #GFile. The returned string should be freed with g_free()
 396  *     when no longer needed.
 397  **/
 398 char *
 399 g_file_get_uri_scheme (GFile *file)
 400 {
 401   GFileIface *iface;
 402
 403   g_return_val_if_fail (G_IS_FILE (file), NULL);
 404
 405   iface = G_FILE_GET_IFACE (file);
 406
 407   return (* iface->get_uri_scheme) (file);
 408 }
 409
 410
 411 /**
 412  * g_file_get_basename:
 413  * @file: input #GFile.
 414  *
 415  * Gets the base name (the last component of the path) for a given #GFile.
 416  *
 417  * If called for the top level of a system (such as the filesystem root
 418  * or a uri like sftp://host/) it will return a single directory separator
 419  * (and on Windows, possibly a drive letter).
 420  *
 421  * The base name is a byte string (*not* UTF-8). It has no defined encoding
 422  * or rules other than it may not contain zero bytes.  If you want to use
 423  * filenames in a user interface you should use the display name that you
 424  * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
 425  * attribute with g_file_query_info().
 426  *
 427  * This call does no blocking i/o.
 428  *
 429  * Returns: string containing the #GFile's base name, or %NULL
 430  *     if given #GFile is invalid. The returned string should be
 431  *     freed with g_free() when no longer needed.
 432  **/
 433 char *
 434 g_file_get_basename (GFile *file)
 435 {
 436   GFileIface *iface;
 437
 438   g_return_val_if_fail (G_IS_FILE (file), NULL);
 439
 440   iface = G_FILE_GET_IFACE (file);
 441
 442   return (* iface->get_basename) (file);
 443 }
 444
 445 /**
 446  * g_file_get_path:
 447  * @file: input #GFile.
 448  *
 449  * Gets the local pathname for #GFile, if one exists.
 450  *
 451  * This call does no blocking i/o.
 452  *
 453  * Returns: string containing the #GFile's path, or %NULL if
 454  *     no such path exists. The returned string should be
 455  *     freed with g_free() when no longer needed.
 456  **/
 457 char *
 458 g_file_get_path (GFile *file)
 459 {
 460   GFileIface *iface;
 461
 462   g_return_val_if_fail (G_IS_FILE (file), NULL);
 463
 464   iface = G_FILE_GET_IFACE (file);
 465
 466   return (* iface->get_path) (file);
 467 }
 468
 469 /**
 470  * g_file_get_uri:
 471  * @file: input #GFile.
 472  *
 473  * Gets the URI for the @file.
 474  *
 475  * This call does no blocking i/o.
 476  *
 477  * Returns: a string containing the #GFile's URI.
 478  *     The returned string should be freed with g_free() when no longer needed.
 479  **/
 480 char *
 481 g_file_get_uri (GFile *file)
 482 {
 483   GFileIface *iface;
 484
 485   g_return_val_if_fail (G_IS_FILE (file), NULL);
 486
 487   iface = G_FILE_GET_IFACE (file);
 488
 489   return (* iface->get_uri) (file);
 490 }
 491
 492 /**
 493  * g_file_get_parse_name:
 494  * @file: input #GFile.
 495  *
 496  * Gets the parse name of the @file.
 497  * A parse name is a UTF-8 string that describes the
 498  * file such that one can get the #GFile back using
 499  * g_file_parse_name().
 500  *
 501  * This is generally used to show the #GFile as a nice
 502  * full-pathname kind of string in a user interface,
 503  * like in a location entry.
 504  *
 505  * For local files with names that can safely be converted
 506  * to UTF8 the pathname is used, otherwise the IRI is used
 507  * (a form of URI that allows UTF8 characters unescaped).
 508  *
 509  * This call does no blocking i/o.
 510  *
 511  * Returns: a string containing the #GFile's parse name. The returned
 512  *     string should be freed with g_free() when no longer needed.
 513  **/
 514 char *
 515 g_file_get_parse_name (GFile *file)
 516 {
 517   GFileIface *iface;
 518
 519   g_return_val_if_fail (G_IS_FILE (file), NULL);
 520
 521   iface = G_FILE_GET_IFACE (file);
 522
 523   return (* iface->get_parse_name) (file);
 524 }
 525
 526 /**
 527  * g_file_dup:
 528  * @file: input #GFile.
 529  *
 530  * Duplicates a #GFile handle. This operation does not duplicate
 531  * the actual file or directory represented by the #GFile; see
 532  * g_file_copy() if attempting to copy a file.
 533  *
 534  * This call does no blocking i/o.
 535  *
 536  * Returns: (transfer full): a new #GFile that is a duplicate of the given #GFile.
 537  **/
 538 GFile *
 539 g_file_dup (GFile *file)
 540 {
 541   GFileIface *iface;
 542
 543   g_return_val_if_fail (G_IS_FILE (file), NULL);
 544
 545   iface = G_FILE_GET_IFACE (file);
 546
 547   return (* iface->dup) (file);
 548 }
 549
 550 /**
 551  * g_file_hash:
 552  * @file: (type GFile): #gconstpointer to a #GFile.
 553  *
 554  * Creates a hash value for a #GFile.
 555  *
 556  * This call does no blocking i/o.
 557  *
 558  * Virtual: hash
 559  * Returns: 0 if @file is not a valid #GFile, otherwise an
 560  *     integer that can be used as hash value for the #GFile.
 561  *     This function is intended for easily hashing a #GFile to
 562  *     add to a #GHashTable or similar data structure.
 563  **/
 564 guint
 565 g_file_hash (gconstpointer file)
 566 {
 567   GFileIface *iface;
 568
 569   g_return_val_if_fail (G_IS_FILE (file), 0);
 570
 571   iface = G_FILE_GET_IFACE (file);
 572
 573   return (* iface->hash) ((GFile *)file);
 574 }
 575
 576 /**
 577  * g_file_equal:
 578  * @file1: the first #GFile.
 579  * @file2: the second #GFile.
 580  *
 581  * Checks equality of two given #GFile<!-- -->s. Note that two
 582  * #GFile<!-- -->s that differ can still refer to the same
 583  * file on the filesystem due to various forms of filename
 584  * aliasing.
 585  *
 586  * This call does no blocking i/o.
 587  *
 588  * Returns: %TRUE if @file1 and @file2 are equal.
 589  *     %FALSE if either is not a #GFile.
 590  **/
 591 gboolean
 592 g_file_equal (GFile *file1,
 593               GFile *file2)
 594 {
 595   GFileIface *iface;
 596
 597   g_return_val_if_fail (G_IS_FILE (file1), FALSE);
 598   g_return_val_if_fail (G_IS_FILE (file2), FALSE);
 599
 600   if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
 601     return FALSE;
 602
 603   iface = G_FILE_GET_IFACE (file1);
 604
 605   return (* iface->equal) (file1, file2);
 606 }
 607
 608
 609 /**
 610  * g_file_get_parent:
 611  * @file: input #GFile.
 612  *
 613  * Gets the parent directory for the @file.
 614  * If the @file represents the root directory of the
 615  * file system, then %NULL will be returned.
 616  *
 617  * This call does no blocking i/o.
 618  *
 619  * Returns: (transfer full): a #GFile structure to the parent of the given
 620  *     #GFile or %NULL if there is no parent.
 621  *     Free the returned object with g_object_unref().
 622  **/
 623 GFile *
 624 g_file_get_parent (GFile *file)
 625 {
 626   GFileIface *iface;
 627
 628   g_return_val_if_fail (G_IS_FILE (file), NULL);
 629
 630   iface = G_FILE_GET_IFACE (file);
 631
 632   return (* iface->get_parent) (file);
 633 }
 634
 635 /**
 636  * g_file_has_parent:
 637  * @file: input #GFile
 638  * @parent: (allow-none): the parent to check for, or %NULL
 639  *
 640  * Checks if @file has a parent, and optionally, if it is @parent.
 641  *
 642  * If @parent is %NULL then this function returns %TRUE if @file has any
 643  * parent at all.  If @parent is non-%NULL then %TRUE is only returned
 644  * if @file is a child of @parent.
 645  *
 646  * Returns: %TRUE if @file is a child of @parent (or any parent in the
 647  *          case that @parent is %NULL).
 648  *
 649  * Since: 2.24
 650  **/
 651 gboolean
 652 g_file_has_parent (GFile *file,
 653                    GFile *parent)
 654 {
 655   GFile *actual_parent;
 656   gboolean result;
 657
 658   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 659   g_return_val_if_fail (parent == NULL || G_IS_FILE (parent), FALSE);
 660
 661   actual_parent = g_file_get_parent (file);
 662
 663   if (actual_parent != NULL)
 664     {
 665       if (parent != NULL)
 666         result = g_file_equal (parent, actual_parent);
 667       else
 668         result = TRUE;
 669
 670       g_object_unref (actual_parent);
 671     }
 672   else
 673     result = FALSE;
 674
 675   return result;
 676 }
 677
 678 /**
 679  * g_file_get_child:
 680  * @file: input #GFile.
 681  * @name: string containing the child's basename.
 682  *
 683  * Gets a child of @file with basename equal to @name.
 684  *
 685  * Note that the file with that specific name might not exist, but
 686  * you can still have a #GFile that points to it. You can use this
 687  * for instance to create that file.
 688  *
 689  * This call does no blocking i/o.
 690  *
 691  * Returns: (transfer full): a #GFile to a child specified by @name.
 692  *     Free the returned object with g_object_unref().
 693  **/
 694 GFile *
 695 g_file_get_child (GFile      *file,
 696                   const char *name)
 697 {
 698   g_return_val_if_fail (G_IS_FILE (file), NULL);
 699   g_return_val_if_fail (name != NULL, NULL);
 700
 701   return g_file_resolve_relative_path (file, name);
 702 }
 703
 704 /**
 705  * g_file_get_child_for_display_name:
 706  * @file: input #GFile.
 707  * @display_name: string to a possible child.
 708  * @error: #GError.
 709  *
 710  * Gets the child of @file for a given @display_name (i.e. a UTF8
 711  * version of the name). If this function fails, it returns %NULL and @error will be
 712  * set. This is very useful when constructing a GFile for a new file
 713  * and the user entered the filename in the user interface, for instance
 714  * when you select a directory and type a filename in the file selector.
 715  *
 716  * This call does no blocking i/o.
 717  *
 718  * Returns: (transfer full): a #GFile to the specified child, or
 719  *     %NULL if the display name couldn't be converted.
 720  *     Free the returned object with g_object_unref().
 721  **/
 722 GFile *
 723 g_file_get_child_for_display_name (GFile      *file,
 724                                    const char *display_name,
 725                                    GError **error)
 726 {
 727   GFileIface *iface;
 728
 729   g_return_val_if_fail (G_IS_FILE (file), NULL);
 730   g_return_val_if_fail (display_name != NULL, NULL);
 731
 732   iface = G_FILE_GET_IFACE (file);
 733
 734   return (* iface->get_child_for_display_name) (file, display_name, error);
 735 }
 736
 737 /**
 738  * g_file_has_prefix:
 739  * @file: input #GFile.
 740  * @prefix: input #GFile.
 741  *
 742  * Checks whether @file has the prefix specified by @prefix. In other word,
 743  * if the names of initial elements of @file<!-- -->s pathname match @prefix.
 744  * Only full pathname elements are matched, so a path like /foo is not
 745  * considered a prefix of /foobar, only of /foo/bar.
 746  *
 747  * This call does no i/o, as it works purely on names. As such it can
 748  * sometimes return %FALSE even if @file is inside a @prefix (from a
 749  * filesystem point of view), because the prefix of @file is an alias
 750  * of @prefix.
 751  *
 752  * Virtual: prefix_matches
 753  * Returns:  %TRUE if the @files's parent, grandparent, etc is @prefix.
 754  *     %FALSE otherwise.
 755  **/
 756 gboolean
 757 g_file_has_prefix (GFile *file,
 758                    GFile *prefix)
 759 {
 760   GFileIface *iface;
 761
 762   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 763   g_return_val_if_fail (G_IS_FILE (prefix), FALSE);
 764
 765   if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix))
 766     return FALSE;
 767
 768   iface = G_FILE_GET_IFACE (file);
 769
 770   /* The vtable function differs in arg order since we're
 771      using the old contains_file call */
 772   return (* iface->prefix_matches) (prefix, file);
 773 }
 774
 775 /**
 776  * g_file_get_relative_path:
 777  * @parent: input #GFile.
 778  * @descendant: input #GFile.
 779  *
 780  * Gets the path for @descendant relative to @parent.
 781  *
 782  * This call does no blocking i/o.
 783  *
 784  * Returns: string with the relative path from @descendant
 785  *     to @parent, or %NULL if @descendant doesn't have @parent as prefix.
 786  *     The returned string should be freed with g_free() when no longer needed.
 787  **/
 788 char *
 789 g_file_get_relative_path (GFile *parent,
 790                           GFile *descendant)
 791 {
 792   GFileIface *iface;
 793
 794   g_return_val_if_fail (G_IS_FILE (parent), NULL);
 795   g_return_val_if_fail (G_IS_FILE (descendant), NULL);
 796
 797   if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
 798     return NULL;
 799
 800   iface = G_FILE_GET_IFACE (parent);
 801
 802   return (* iface->get_relative_path) (parent, descendant);
 803 }
 804
 805 /**
 806  * g_file_resolve_relative_path:
 807  * @file: input #GFile.
 808  * @relative_path: a given relative path string.
 809  *
 810  * Resolves a relative path for @file to an absolute path.
 811  *
 812  * This call does no blocking i/o.
 813  *
 814  * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path
 815  *     is %NULL or if @file is invalid.
 816  *     Free the returned object with g_object_unref().
 817  **/
 818 GFile *
 819 g_file_resolve_relative_path (GFile      *file,
 820                               const char *relative_path)
 821 {
 822   GFileIface *iface;
 823
 824   g_return_val_if_fail (G_IS_FILE (file), NULL);
 825   g_return_val_if_fail (relative_path != NULL, NULL);
 826
 827   iface = G_FILE_GET_IFACE (file);
 828
 829   return (* iface->resolve_relative_path) (file, relative_path);
 830 }
 831
 832 /**
 833  * g_file_enumerate_children:
 834  * @file: input #GFile.
 835  * @attributes: an attribute query string.
 836  * @flags: a set of #GFileQueryInfoFlags.
 837  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 838  * @error: #GError for error reporting.
 839  *
 840  * Gets the requested information about the files in a directory. The result
 841  * is a #GFileEnumerator object that will give out #GFileInfo objects for
 842  * all the files in the directory.
 843  *
 844  * The @attributes value is a string that specifies the file attributes that
 845  * should be gathered. It is not an error if it's not possible to read a particular
 846  * requested attribute from a file - it just won't be set. @attributes should
 847  * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
 848  * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
 849  * namespace. An example attribute query be "standard::*,owner::user".
 850  * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
 851  *
 852  * If @cancellable is not %NULL, then the operation can be cancelled by
 853  * triggering the cancellable object from another thread. If the operation
 854  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
 855  *
 856  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
 857  * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
 858  * Other errors are possible too.
 859  *
 860  * Returns: (transfer full): A #GFileEnumerator if successful, %NULL on error.
 861  *     Free the returned object with g_object_unref().
 862  **/
 863 GFileEnumerator *
 864 g_file_enumerate_children (GFile                *file,
 865                            const char           *attributes,
 866                            GFileQueryInfoFlags   flags,
 867                            GCancellable         *cancellable,
 868                            GError              **error)
 869
 870 {
 871   GFileIface *iface;
 872
 873   g_return_val_if_fail (G_IS_FILE (file), NULL);
 874
 875   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 876     return NULL;
 877
 878   iface = G_FILE_GET_IFACE (file);
 879
 880   if (iface->enumerate_children == NULL)
 881     {
 882       g_set_error_literal (error, G_IO_ERROR,
 883                            G_IO_ERROR_NOT_SUPPORTED,
 884                            _("Operation not supported"));
 885       return NULL;
 886     }
 887
 888   return (* iface->enumerate_children) (file, attributes, flags,
 889                                         cancellable, error);
 890 }
 891
 892 /**
 893  * g_file_enumerate_children_async:
 894  * @file: input #GFile.
 895  * @attributes: an attribute query string.
 896  * @flags: a set of #GFileQueryInfoFlags.
 897  * @io_priority: the <link linkend="io-priority">I/O priority</link>
 898  *     of the request.
 899  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 900  * @callback: (scope async) : a #GAsyncReadyCallback to call when the
 901  *     request is satisfied
 902  * @user_data: (closure): the data to pass to callback function
 903  *
 904  * Asynchronously gets the requested information about the files in a directory. The result
 905  * is a #GFileEnumerator object that will give out #GFileInfo objects for
 906  * all the files in the directory.
 907  *
 908  * For more details, see g_file_enumerate_children() which is
 909  * the synchronous version of this call.
 910  *
 911  * When the operation is finished, @callback will be called. You can then call
 912  * g_file_enumerate_children_finish() to get the result of the operation.
 913  **/
 914 void
 915 g_file_enumerate_children_async (GFile               *file,
 916                                  const char          *attributes,
 917                                  GFileQueryInfoFlags  flags,
 918                                  int                  io_priority,
 919                                  GCancellable        *cancellable,
 920                                  GAsyncReadyCallback  callback,
 921                                  gpointer             user_data)
 922 {
 923   GFileIface *iface;
 924
 925   g_return_if_fail (G_IS_FILE (file));
 926
 927   iface = G_FILE_GET_IFACE (file);
 928   (* iface->enumerate_children_async) (file,
 929                                        attributes,
 930                                        flags,
 931                                        io_priority,
 932                                        cancellable,
 933                                        callback,
 934                                        user_data);
 935 }
 936
 937 /**
 938  * g_file_enumerate_children_finish:
 939  * @file: input #GFile.
 940  * @res: a #GAsyncResult.
 941  * @error: a #GError.
 942  *
 943  * Finishes an async enumerate children operation.
 944  * See g_file_enumerate_children_async().
 945  *
 946  * Returns: (transfer full): a #GFileEnumerator or %NULL if an error occurred.
 947  *     Free the returned object with g_object_unref().
 948  **/
 949 GFileEnumerator *
 950 g_file_enumerate_children_finish (GFile         *file,
 951                                   GAsyncResult  *res,
 952                                   GError       **error)
 953 {
 954   GFileIface *iface;
 955
 956   g_return_val_if_fail (G_IS_FILE (file), NULL);
 957   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
 958
 959   if (g_async_result_legacy_propagate_error (res, error))
 960     return NULL;
 961
 962   iface = G_FILE_GET_IFACE (file);
 963   return (* iface->enumerate_children_finish) (file, res, error);
 964 }
 965
 966 /**
 967  * g_file_query_exists:
 968  * @file: input #GFile.
 969  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 970  *
 971  * Utility function to check if a particular file exists. This is
 972  * implemented using g_file_query_info() and as such does blocking I/O.
 973  *
 974  * Note that in many cases it is racy to first check for file existence
 975  * and then execute something based on the outcome of that, because the
 976  * file might have been created or removed in between the operations. The
 977  * general approach to handling that is to not check, but just do the
 978  * operation and handle the errors as they come.
 979  *
 980  * As an example of race-free checking, take the case of reading a file, and
 981  * if it doesn't exist, creating it. There are two racy versions: read it, and
 982  * on error create it; and: check if it exists, if not create it. These
 983  * can both result in two processes creating the file (with perhaps a partially
 984  * written file as the result). The correct approach is to always try to create
 985  * the file with g_file_create() which will either atomically create the file
 986  * or fail with a G_IO_ERROR_EXISTS error.
 987  *
 988  * However, in many cases an existence check is useful in a user
 989  * interface, for instance to make a menu item sensitive/insensitive, so that
 990  * you don't have to fool users that something is possible and then just show
 991  * and error dialog. If you do this, you should make sure to also handle the
 992  * errors that can happen due to races when you execute the operation.
 993  *
 994  * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
 995  */
 996 gboolean
 997 g_file_query_exists (GFile *file,
 998                      GCancellable *cancellable)
 999 {
1000   GFileInfo *info;
1001
1002   g_return_val_if_fail (G_IS_FILE(file), FALSE);
1003
1004   info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1005                             G_FILE_QUERY_INFO_NONE, cancellable, NULL);
1006   if (info != NULL)
1007     {
1008       g_object_unref (info);
1009       return TRUE;
1010     }
1011
1012   return FALSE;
1013 }
1014
1015 /**
1016  * g_file_query_file_type:
1017  * @file: input #GFile.
1018  * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info().
1019  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1020  *
1021  * Utility function to inspect the #GFileType of a file. This is
1022  * implemented using g_file_query_info() and as such does blocking I/O.
1023  *
1024  * The primary use case of this method is to check if a file is a regular file,
1025  * directory, or symlink.
1026  *
1027  * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file
1028  *          does not exist
1029  *
1030  * Since: 2.18
1031  */
1032 GFileType
1033 g_file_query_file_type (GFile *file,
1034                         GFileQueryInfoFlags   flags,
1035                         GCancellable *cancellable)
1036 {
1037   GFileInfo *info;
1038   GFileType file_type;
1039
1040   g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN);
1041   info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags,
1042                             cancellable, NULL);
1043   if (info != NULL)
1044     {
1045       file_type = g_file_info_get_file_type (info);
1046       g_object_unref (info);
1047     }
1048   else
1049     file_type = G_FILE_TYPE_UNKNOWN;
1050
1051   return file_type;
1052 }
1053
1054 /**
1055  * g_file_query_info:
1056  * @file: input #GFile.
1057  * @attributes: an attribute query string.
1058  * @flags: a set of #GFileQueryInfoFlags.
1059  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1060  * @error: a #GError.
1061  *
1062  * Gets the requested information about specified @file. The result
1063  * is a #GFileInfo object that contains key-value attributes (such as
1064  * the type or size of the file).
1065  *
1066  * The @attributes value is a string that specifies the file attributes that
1067  * should be gathered. It is not an error if it's not possible to read a particular
1068  * requested attribute from a file - it just won't be set. @attributes should
1069  * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
1070  * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
1071  * namespace. An example attribute query be "standard::*,owner::user".
1072  * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
1073  *
1074  * If @cancellable is not %NULL, then the operation can be cancelled by
1075  * triggering the cancellable object from another thread. If the operation
1076  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1077  *
1078  * For symlinks, normally the information about the target of the
1079  * symlink is returned, rather than information about the symlink itself.
1080  * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
1081  * information about the symlink itself will be returned. Also, for symlinks
1082  * that point to non-existing files the information about the symlink itself
1083  * will be returned.
1084  *
1085  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1086  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1087  *
1088  * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error.
1089  *     Free the returned object with g_object_unref().
1090  **/
1091 GFileInfo *
1092 g_file_query_info (GFile                *file,
1093                    const char           *attributes,
1094                    GFileQueryInfoFlags   flags,
1095                    GCancellable         *cancellable,
1096                    GError              **error)
1097 {
1098   GFileIface *iface;
1099
1100   g_return_val_if_fail (G_IS_FILE (file), NULL);
1101
1102   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1103     return NULL;
1104
1105   iface = G_FILE_GET_IFACE (file);
1106
1107   if (iface->query_info == NULL)
1108     {
1109       g_set_error_literal (error, G_IO_ERROR,
1110                            G_IO_ERROR_NOT_SUPPORTED,
1111                            _("Operation not supported"));
1112       return NULL;
1113     }
1114
1115   return (* iface->query_info) (file, attributes, flags, cancellable, error);
1116 }
1117
1118 /**
1119  * g_file_query_info_async:
1120  * @file: input #GFile.
1121  * @attributes: an attribute query string.
1122  * @flags: a set of #GFileQueryInfoFlags.
1123  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1124  *     of the request.
1125  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1126  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1127  * @user_data: (closure): the data to pass to callback function
1128  *
1129  * Asynchronously gets the requested information about specified @file. The result
1130  * is a #GFileInfo object that contains key-value attributes (such as type or size
1131  * for the file).
1132  *
1133  * For more details, see g_file_query_info() which is
1134  * the synchronous version of this call.
1135  *
1136  * When the operation is finished, @callback will be called. You can then call
1137  * g_file_query_info_finish() to get the result of the operation.
1138  **/
1139 void
1140 g_file_query_info_async (GFile               *file,
1141                          const char          *attributes,
1142                          GFileQueryInfoFlags  flags,
1143                          int                  io_priority,
1144                          GCancellable        *cancellable,
1145                          GAsyncReadyCallback  callback,
1146                          gpointer             user_data)
1147 {
1148   GFileIface *iface;
1149
1150   g_return_if_fail (G_IS_FILE (file));
1151
1152   iface = G_FILE_GET_IFACE (file);
1153   (* iface->query_info_async) (file,
1154                                attributes,
1155                                flags,
1156                                io_priority,
1157                                cancellable,
1158                                callback,
1159                                user_data);
1160 }
1161
1162 /**
1163  * g_file_query_info_finish:
1164  * @file: input #GFile.
1165  * @res: a #GAsyncResult.
1166  * @error: a #GError.
1167  *
1168  * Finishes an asynchronous file info query.
1169  * See g_file_query_info_async().
1170  *
1171  * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
1172  *     Free the returned object with g_object_unref().
1173  **/
1174 GFileInfo *
1175 g_file_query_info_finish (GFile         *file,
1176                           GAsyncResult  *res,
1177                           GError       **error)
1178 {
1179   GFileIface *iface;
1180
1181   g_return_val_if_fail (G_IS_FILE (file), NULL);
1182   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1183
1184   if (g_async_result_legacy_propagate_error (res, error))
1185     return NULL;
1186
1187   iface = G_FILE_GET_IFACE (file);
1188   return (* iface->query_info_finish) (file, res, error);
1189 }
1190
1191 /**
1192  * g_file_query_filesystem_info:
1193  * @file: input #GFile.
1194  * @attributes:  an attribute query string.
1195  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1196  * @error: a #GError.
1197  *
1198  * Similar to g_file_query_info(), but obtains information
1199  * about the filesystem the @file is on, rather than the file itself.
1200  * For instance the amount of space available and the type of
1201  * the filesystem.
1202  *
1203  * The @attributes value is a string that specifies the file attributes that
1204  * should be gathered. It is not an error if it's not possible to read a particular
1205  * requested attribute from a file - it just won't be set. @attributes should
1206  * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
1207  * means all attributes, and a wildcard like "filesystem::*" means all attributes in the
1208  * filesystem namespace. The standard namespace for filesystem attributes is "filesystem".
1209  * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
1210  * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
1211  * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1212  *
1213  * If @cancellable is not %NULL, then the operation can be cancelled by
1214  * triggering the cancellable object from another thread. If the operation
1215  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1216  *
1217  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1218  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1219  *
1220  * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1221  *     Free the returned object with g_object_unref().
1222  **/
1223 GFileInfo *
1224 g_file_query_filesystem_info (GFile         *file,
1225                               const char    *attributes,
1226                               GCancellable  *cancellable,
1227                               GError       **error)
1228 {
1229   GFileIface *iface;
1230
1231   g_return_val_if_fail (G_IS_FILE (file), NULL);
1232
1233   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1234     return NULL;
1235
1236   iface = G_FILE_GET_IFACE (file);
1237
1238   if (iface->query_filesystem_info == NULL)
1239     {
1240       g_set_error_literal (error, G_IO_ERROR,
1241                            G_IO_ERROR_NOT_SUPPORTED,
1242                            _("Operation not supported"));
1243       return NULL;
1244     }
1245
1246   return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1247 }
1248
1249 /**
1250  * g_file_query_filesystem_info_async:
1251  * @file: input #GFile.
1252  * @attributes: an attribute query string.
1253  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1254  *     of the request.
1255  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1256  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1257  * @user_data: (closure): the data to pass to callback function
1258  *
1259  * Asynchronously gets the requested information about the filesystem
1260  * that the specified @file is on. The result is a #GFileInfo object
1261  * that contains key-value attributes (such as type or size for the
1262  * file).
1263  *
1264  * For more details, see g_file_query_filesystem_info() which is the
1265  * synchronous version of this call.
1266  *
1267  * When the operation is finished, @callback will be called. You can
1268  * then call g_file_query_info_finish() to get the result of the
1269  * operation.
1270  **/
1271 void
1272 g_file_query_filesystem_info_async (GFile               *file,
1273                                     const char          *attributes,
1274                                     int                  io_priority,
1275                                     GCancellable        *cancellable,
1276                                     GAsyncReadyCallback  callback,
1277                                     gpointer             user_data)
1278 {
1279   GFileIface *iface;
1280
1281   g_return_if_fail (G_IS_FILE (file));
1282
1283   iface = G_FILE_GET_IFACE (file);
1284   (* iface->query_filesystem_info_async) (file,
1285                                           attributes,
1286                                           io_priority,
1287                                           cancellable,
1288                                           callback,
1289                                           user_data);
1290 }
1291
1292 /**
1293  * g_file_query_filesystem_info_finish:
1294  * @file: input #GFile.
1295  * @res: a #GAsyncResult.
1296  * @error: a #GError.
1297  *
1298  * Finishes an asynchronous filesystem info query.  See
1299  * g_file_query_filesystem_info_async().
1300  *
1301  * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
1302  *     Free the returned object with g_object_unref().
1303  **/
1304 GFileInfo *
1305 g_file_query_filesystem_info_finish (GFile         *file,
1306                                      GAsyncResult  *res,
1307                                      GError       **error)
1308 {
1309   GFileIface *iface;
1310
1311   g_return_val_if_fail (G_IS_FILE (file), NULL);
1312   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1313
1314   if (g_async_result_legacy_propagate_error (res, error))
1315     return NULL;
1316
1317   iface = G_FILE_GET_IFACE (file);
1318   return (* iface->query_filesystem_info_finish) (file, res, error);
1319 }
1320
1321 /**
1322  * g_file_find_enclosing_mount:
1323  * @file: input #GFile.
1324  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1325  * @error: a #GError.
1326  *
1327  * Gets a #GMount for the #GFile.
1328  *
1329  * If the #GFileIface for @file does not have a mount (e.g. possibly a
1330  * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
1331  * will be returned.
1332  *
1333  * If @cancellable is not %NULL, then the operation can be cancelled by
1334  * triggering the cancellable object from another thread. If the operation
1335  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1336  *
1337  * Returns: (transfer full): a #GMount where the @file is located or %NULL on error.
1338  *     Free the returned object with g_object_unref().
1339  **/
1340 GMount *
1341 g_file_find_enclosing_mount (GFile         *file,
1342                              GCancellable  *cancellable,
1343                              GError       **error)
1344 {
1345   GFileIface *iface;
1346
1347   g_return_val_if_fail (G_IS_FILE (file), NULL);
1348
1349   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1350     return NULL;
1351
1352   iface = G_FILE_GET_IFACE (file);
1353   if (iface->find_enclosing_mount == NULL)
1354     {
1355
1356       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
1357                         /* Translators: This is an error message when trying to find the
1358                          * enclosing (user visible) mount of a file, but none exists. */
1359                    _("Containing mount does not exist"));
1360       return NULL;
1361     }
1362
1363   return (* iface->find_enclosing_mount) (file, cancellable, error);
1364 }
1365
1366 /**
1367  * g_file_find_enclosing_mount_async:
1368  * @file: a #GFile
1369  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1370  *     of the request.
1371  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1372  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1373  * @user_data: (closure): the data to pass to callback function
1374  *
1375  * Asynchronously gets the mount for the file.
1376  *
1377  * For more details, see g_file_find_enclosing_mount() which is
1378  * the synchronous version of this call.
1379  *
1380  * When the operation is finished, @callback will be called. You can then call
1381  * g_file_find_enclosing_mount_finish() to get the result of the operation.
1382  */
1383 void
1384 g_file_find_enclosing_mount_async (GFile              *file,
1385                                    int                   io_priority,
1386                                    GCancellable         *cancellable,
1387                                    GAsyncReadyCallback   callback,
1388                                    gpointer              user_data)
1389 {
1390   GFileIface *iface;
1391
1392   g_return_if_fail (G_IS_FILE (file));
1393
1394   iface = G_FILE_GET_IFACE (file);
1395   (* iface->find_enclosing_mount_async) (file,
1396                                          io_priority,
1397                                          cancellable,
1398                                          callback,
1399                                          user_data);
1400 }
1401
1402 /**
1403  * g_file_find_enclosing_mount_finish:
1404  * @file: a #GFile
1405  * @res: a #GAsyncResult
1406  * @error: a #GError
1407  *
1408  * Finishes an asynchronous find mount request.
1409  * See g_file_find_enclosing_mount_async().
1410  *
1411  * Returns: (transfer full): #GMount for given @file or %NULL on error.
1412  *     Free the returned object with g_object_unref().
1413  **/
1414 GMount *
1415 g_file_find_enclosing_mount_finish (GFile         *file,
1416                                     GAsyncResult  *res,
1417                                     GError       **error)
1418 {
1419   GFileIface *iface;
1420
1421   g_return_val_if_fail (G_IS_FILE (file), NULL);
1422   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1423
1424   if (g_async_result_legacy_propagate_error (res, error))
1425     return NULL;
1426
1427   iface = G_FILE_GET_IFACE (file);
1428   return (* iface->find_enclosing_mount_finish) (file, res, error);
1429 }
1430
1431
1432 /**
1433  * g_file_read:
1434  * @file: #GFile to read.
1435  * @cancellable: (allow-none): a #GCancellable
1436  * @error: a #GError, or %NULL
1437  *
1438  * Opens a file for reading. The result is a #GFileInputStream that
1439  * can be used to read the contents of the file.
1440  *
1441  * If @cancellable is not %NULL, then the operation can be cancelled by
1442  * triggering the cancellable object from another thread. If the operation
1443  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1444  *
1445  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1446  * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1447  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1448  *
1449  * Virtual: read_fn
1450  * Returns: (transfer full): #GFileInputStream or %NULL on error.
1451  *     Free the returned object with g_object_unref().
1452  **/
1453 GFileInputStream *
1454 g_file_read (GFile         *file,
1455              GCancellable  *cancellable,
1456              GError       **error)
1457 {
1458   GFileIface *iface;
1459
1460   g_return_val_if_fail (G_IS_FILE (file), NULL);
1461
1462   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1463     return NULL;
1464
1465   iface = G_FILE_GET_IFACE (file);
1466
1467   if (iface->read_fn == NULL)
1468     {
1469       g_set_error_literal (error, G_IO_ERROR,
1470                            G_IO_ERROR_NOT_SUPPORTED,
1471                            _("Operation not supported"));
1472       return NULL;
1473     }
1474
1475   return (* iface->read_fn) (file, cancellable, error);
1476 }
1477
1478 /**
1479  * g_file_append_to:
1480  * @file: input #GFile.
1481  * @flags: a set of #GFileCreateFlags.
1482  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1483  * @error: a #GError, or %NULL
1484  *
1485  * Gets an output stream for appending data to the file. If
1486  * the file doesn't already exist it is created.
1487  *
1488  * By default files created are generally readable by everyone,
1489  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1490  * will be made readable only to the current user, to the level that
1491  * is supported on the target filesystem.
1492  *
1493  * If @cancellable is not %NULL, then the operation can be cancelled by
1494  * triggering the cancellable object from another thread. If the operation
1495  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1496  *
1497  * Some file systems don't allow all file names, and may
1498  * return an %G_IO_ERROR_INVALID_FILENAME error.
1499  * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
1500  * returned. Other errors are possible too, and depend on what kind of
1501  * filesystem the file is on.
1502  *
1503  * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1504  *     Free the returned object with g_object_unref().
1505  **/
1506 GFileOutputStream *
1507 g_file_append_to (GFile             *file,
1508                   GFileCreateFlags   flags,
1509                   GCancellable      *cancellable,
1510                   GError           **error)
1511 {
1512   GFileIface *iface;
1513
1514   g_return_val_if_fail (G_IS_FILE (file), NULL);
1515
1516   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1517     return NULL;
1518
1519   iface = G_FILE_GET_IFACE (file);
1520
1521   if (iface->append_to == NULL)
1522     {
1523       g_set_error_literal (error, G_IO_ERROR,
1524                            G_IO_ERROR_NOT_SUPPORTED,
1525                            _("Operation not supported"));
1526       return NULL;
1527     }
1528
1529   return (* iface->append_to) (file, flags, cancellable, error);
1530 }
1531
1532 /**
1533  * g_file_create:
1534  * @file: input #GFile.
1535  * @flags: a set of #GFileCreateFlags.
1536  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1537  * @error: a #GError, or %NULL
1538  *
1539  * Creates a new file and returns an output stream for writing to it.
1540  * The file must not already exist.
1541  *
1542  * By default files created are generally readable by everyone,
1543  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1544  * will be made readable only to the current user, to the level that
1545  * is supported on the target filesystem.
1546  *
1547  * If @cancellable is not %NULL, then the operation can be cancelled by
1548  * triggering the cancellable object from another thread. If the operation
1549  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1550  *
1551  * If a file or directory with this name already exists the G_IO_ERROR_EXISTS
1552  * error will be returned.
1553  * Some file systems don't allow all file names, and may
1554  * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1555  * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1556  * Other errors are possible too, and depend on what kind of
1557  * filesystem the file is on.
1558  *
1559  * Returns: (transfer full): a #GFileOutputStream for the newly created file, or
1560  *     %NULL on error.
1561  *     Free the returned object with g_object_unref().
1562  **/
1563 GFileOutputStream *
1564 g_file_create (GFile             *file,
1565                GFileCreateFlags   flags,
1566                GCancellable      *cancellable,
1567                GError           **error)
1568 {
1569   GFileIface *iface;
1570
1571   g_return_val_if_fail (G_IS_FILE (file), NULL);
1572
1573   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1574     return NULL;
1575
1576   iface = G_FILE_GET_IFACE (file);
1577
1578   if (iface->create == NULL)
1579     {
1580       g_set_error_literal (error, G_IO_ERROR,
1581                            G_IO_ERROR_NOT_SUPPORTED,
1582                            _("Operation not supported"));
1583       return NULL;
1584     }
1585
1586   return (* iface->create) (file, flags, cancellable, error);
1587 }
1588
1589 /**
1590  * g_file_replace:
1591  * @file: input #GFile.
1592  * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the
1593  *     current #GFile, or #NULL to ignore.
1594  * @make_backup: %TRUE if a backup should be created.
1595  * @flags: a set of #GFileCreateFlags.
1596  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1597  * @error: a #GError, or %NULL
1598  *
1599  * Returns an output stream for overwriting the file, possibly
1600  * creating a backup copy of the file first. If the file doesn't exist,
1601  * it will be created.
1602  *
1603  * This will try to replace the file in the safest way possible so
1604  * that any errors during the writing will not affect an already
1605  * existing copy of the file. For instance, for local files it
1606  * may write to a temporary file and then atomically rename over
1607  * the destination when the stream is closed.
1608  *
1609  * By default files created are generally readable by everyone,
1610  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1611  * will be made readable only to the current user, to the level that
1612  * is supported on the target filesystem.
1613  *
1614  * If @cancellable is not %NULL, then the operation can be cancelled by
1615  * triggering the cancellable object from another thread. If the operation
1616  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1617  *
1618  * If you pass in a non-#NULL @etag value, then this value is
1619  * compared to the current entity tag of the file, and if they differ
1620  * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
1621  * that the file has been changed since you last read it. You can get
1622  * the new etag from g_file_output_stream_get_etag() after you've
1623  * finished writing and closed the #GFileOutputStream. When you load
1624  * a new file you can use g_file_input_stream_query_info() to get
1625  * the etag of the file.
1626  *
1627  * If @make_backup is %TRUE, this function will attempt to make a backup
1628  * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
1629  * error will be returned. If you want to replace anyway, try again with
1630  * @make_backup set to %FALSE.
1631  *
1632  * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
1633  * and if the file is some other form of non-regular file then a
1634  * G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
1635  * Some file systems don't allow all file names, and may
1636  * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1637  * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1638  * Other errors are possible too, and depend on what kind of
1639  * filesystem the file is on.
1640  *
1641  * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1642  *     Free the returned object with g_object_unref().
1643  **/
1644 GFileOutputStream *
1645 g_file_replace (GFile             *file,
1646                 const char        *etag,
1647                 gboolean           make_backup,
1648                 GFileCreateFlags   flags,
1649                 GCancellable      *cancellable,
1650                 GError           **error)
1651 {
1652   GFileIface *iface;
1653
1654   g_return_val_if_fail (G_IS_FILE (file), NULL);
1655
1656   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1657     return NULL;
1658
1659   iface = G_FILE_GET_IFACE (file);
1660
1661   if (iface->replace == NULL)
1662     {
1663       g_set_error_literal (error, G_IO_ERROR,
1664                            G_IO_ERROR_NOT_SUPPORTED,
1665                            _("Operation not supported"));
1666       return NULL;
1667     }
1668
1669
1670   /* Handle empty tag string as NULL in consistent way. */
1671   if (etag && *etag == 0)
1672     etag = NULL;
1673
1674   return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1675 }
1676
1677 /**
1678  * g_file_open_readwrite:
1679  * @file: #GFile to open
1680  * @cancellable: (allow-none): a #GCancellable
1681  * @error: a #GError, or %NULL
1682  *
1683  * Opens an existing file for reading and writing. The result is
1684  * a #GFileIOStream that can be used to read and write the contents of the file.
1685  *
1686  * If @cancellable is not %NULL, then the operation can be cancelled by
1687  * triggering the cancellable object from another thread. If the operation
1688  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1689  *
1690  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1691  * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1692  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1693  * Note that in many non-local file cases read and write streams are not supported,
1694  * so make sure you really need to do read and write streaming, rather than
1695  * just opening for reading or writing.
1696  *
1697  * Returns: (transfer full): #GFileIOStream or %NULL on error.
1698  *     Free the returned object with g_object_unref().
1699  *
1700  * Since: 2.22
1701  **/
1702 GFileIOStream *
1703 g_file_open_readwrite (GFile                      *file,
1704                        GCancellable               *cancellable,
1705                        GError                    **error)
1706 {
1707   GFileIface *iface;
1708
1709   g_return_val_if_fail (G_IS_FILE (file), NULL);
1710
1711   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1712     return NULL;
1713
1714   iface = G_FILE_GET_IFACE (file);
1715
1716   if (iface->open_readwrite == NULL)
1717     {
1718       g_set_error_literal (error, G_IO_ERROR,
1719                            G_IO_ERROR_NOT_SUPPORTED,
1720                            _("Operation not supported"));
1721       return NULL;
1722     }
1723
1724   return (* iface->open_readwrite) (file, cancellable, error);
1725 }
1726
1727 /**
1728  * g_file_create_readwrite:
1729  * @file: a #GFile
1730  * @flags: a set of #GFileCreateFlags
1731  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
1732  * @error: return location for a #GError, or %NULL
1733  *
1734  * Creates a new file and returns a stream for reading and writing to it.
1735  * The file must not already exist.
1736  *
1737  * By default files created are generally readable by everyone,
1738  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1739  * will be made readable only to the current user, to the level that
1740  * is supported on the target filesystem.
1741  *
1742  * If @cancellable is not %NULL, then the operation can be cancelled by
1743  * triggering the cancellable object from another thread. If the operation
1744  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1745  *
1746  * If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
1747  * error will be returned. Some file systems don't allow all file names,
1748  * and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
1749  * is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
1750  * are possible too, and depend on what kind of filesystem the file is on.
1751  *
1752  * Note that in many non-local file cases read and write streams are not
1753  * supported, so make sure you really need to do read and write streaming,
1754  * rather than just opening for reading or writing.
1755  *
1756  * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error.
1757  *     Free the returned object with g_object_unref().
1758  *
1759  * Since: 2.22
1760  */
1761 GFileIOStream *
1762 g_file_create_readwrite (GFile             *file,
1763                          GFileCreateFlags   flags,
1764                          GCancellable      *cancellable,
1765                          GError           **error)
1766 {
1767   GFileIface *iface;
1768
1769   g_return_val_if_fail (G_IS_FILE (file), NULL);
1770
1771   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1772     return NULL;
1773
1774   iface = G_FILE_GET_IFACE (file);
1775
1776   if (iface->create_readwrite == NULL)
1777     {
1778       g_set_error_literal (error, G_IO_ERROR,
1779                            G_IO_ERROR_NOT_SUPPORTED,
1780                            _("Operation not supported"));
1781       return NULL;
1782     }
1783
1784   return (* iface->create_readwrite) (file, flags, cancellable, error);
1785 }
1786
1787 /**
1788  * g_file_replace_readwrite:
1789  * @file: a #GFile
1790  * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the
1791  *     current #GFile, or #NULL to ignore
1792  * @make_backup: %TRUE if a backup should be created
1793  * @flags: a set of #GFileCreateFlags
1794  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
1795  * @error: return location for a #GError, or %NULL
1796  *
1797  * Returns an output stream for overwriting the file in readwrite mode,
1798  * possibly creating a backup copy of the file first. If the file doesn't
1799  * exist, it will be created.
1800  *
1801  * For details about the behaviour, see g_file_replace() which does the same
1802  * thing but returns an output stream only.
1803  *
1804  * Note that in many non-local file cases read and write streams are not
1805  * supported, so make sure you really need to do read and write streaming,
1806  * rather than just opening for reading or writing.
1807  *
1808  * Returns: (transfer full): a #GFileIOStream or %NULL on error.
1809  *     Free the returned object with g_object_unref().
1810  *
1811  * Since: 2.22
1812  */
1813 GFileIOStream *
1814 g_file_replace_readwrite (GFile             *file,
1815                           const char        *etag,
1816                           gboolean           make_backup,
1817                           GFileCreateFlags   flags,
1818                           GCancellable      *cancellable,
1819                           GError           **error)
1820 {
1821   GFileIface *iface;
1822
1823   g_return_val_if_fail (G_IS_FILE (file), NULL);
1824
1825   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1826     return NULL;
1827
1828   iface = G_FILE_GET_IFACE (file);
1829
1830   if (iface->replace_readwrite == NULL)
1831     {
1832       g_set_error_literal (error, G_IO_ERROR,
1833                            G_IO_ERROR_NOT_SUPPORTED,
1834                            _("Operation not supported"));
1835       return NULL;
1836     }
1837
1838   return (* iface->replace_readwrite) (file, etag, make_backup, flags, cancellable, error);
1839 }
1840
1841 /**
1842  * g_file_read_async:
1843  * @file: input #GFile
1844  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1845  *     of the request.
1846  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1847  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1848  * @user_data: (closure): the data to pass to callback function
1849  *
1850  * Asynchronously opens @file for reading.
1851  *
1852  * For more details, see g_file_read() which is
1853  * the synchronous version of this call.
1854  *
1855  * When the operation is finished, @callback will be called. You can then call
1856  * g_file_read_finish() to get the result of the operation.
1857  **/
1858 void
1859 g_file_read_async (GFile               *file,
1860                    int                  io_priority,
1861                    GCancellable        *cancellable,
1862                    GAsyncReadyCallback  callback,
1863                    gpointer             user_data)
1864 {
1865   GFileIface *iface;
1866
1867   g_return_if_fail (G_IS_FILE (file));
1868
1869   iface = G_FILE_GET_IFACE (file);
1870   (* iface->read_async) (file,
1871                          io_priority,
1872                          cancellable,
1873                          callback,
1874                          user_data);
1875 }
1876
1877 /**
1878  * g_file_read_finish:
1879  * @file: input #GFile.
1880  * @res: a #GAsyncResult.
1881  * @error: a #GError, or %NULL
1882  *
1883  * Finishes an asynchronous file read operation started with
1884  * g_file_read_async().
1885  *
1886  * Returns: (transfer full): a #GFileInputStream or %NULL on error.
1887  *     Free the returned object with g_object_unref().
1888  **/
1889 GFileInputStream *
1890 g_file_read_finish (GFile         *file,
1891                     GAsyncResult  *res,
1892                     GError       **error)
1893 {
1894   GFileIface *iface;
1895
1896   g_return_val_if_fail (G_IS_FILE (file), NULL);
1897   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1898
1899   if (g_async_result_legacy_propagate_error (res, error))
1900     return NULL;
1901
1902   iface = G_FILE_GET_IFACE (file);
1903   return (* iface->read_finish) (file, res, error);
1904 }
1905
1906 /**
1907  * g_file_append_to_async:
1908  * @file: input #GFile.
1909  * @flags: a set of #GFileCreateFlags.
1910  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1911  *     of the request.
1912  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1913  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1914  * @user_data: (closure): the data to pass to callback function
1915  *
1916  * Asynchronously opens @file for appending.
1917  *
1918  * For more details, see g_file_append_to() which is
1919  * the synchronous version of this call.
1920  *
1921  * When the operation is finished, @callback will be called. You can then call
1922  * g_file_append_to_finish() to get the result of the operation.
1923  **/
1924 void
1925 g_file_append_to_async (GFile               *file,
1926                         GFileCreateFlags     flags,
1927                         int                  io_priority,
1928                         GCancellable        *cancellable,
1929                         GAsyncReadyCallback  callback,
1930                         gpointer             user_data)
1931 {
1932   GFileIface *iface;
1933
1934   g_return_if_fail (G_IS_FILE (file));
1935
1936   iface = G_FILE_GET_IFACE (file);
1937   (* iface->append_to_async) (file,
1938                               flags,
1939                               io_priority,
1940                               cancellable,
1941                               callback,
1942                               user_data);
1943 }
1944
1945 /**
1946  * g_file_append_to_finish:
1947  * @file: input #GFile.
1948  * @res: #GAsyncResult
1949  * @error: a #GError, or %NULL
1950  *
1951  * Finishes an asynchronous file append operation started with
1952  * g_file_append_to_async().
1953  *
1954  * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error.
1955  *     Free the returned object with g_object_unref().
1956  **/
1957 GFileOutputStream *
1958 g_file_append_to_finish (GFile         *file,
1959                          GAsyncResult  *res,
1960                          GError       **error)
1961 {
1962   GFileIface *iface;
1963
1964   g_return_val_if_fail (G_IS_FILE (file), NULL);
1965   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1966
1967   if (g_async_result_legacy_propagate_error (res, error))
1968     return NULL;
1969
1970   iface = G_FILE_GET_IFACE (file);
1971   return (* iface->append_to_finish) (file, res, error);
1972 }
1973
1974 /**
1975  * g_file_create_async:
1976  * @file: input #GFile.
1977  * @flags: a set of #GFileCreateFlags.
1978  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1979  *     of the request.
1980  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1981  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1982  * @user_data: (closure): the data to pass to callback function
1983  *
1984  * Asynchronously creates a new file and returns an output stream for writing to it.
1985  * The file must not already exist.
1986  *
1987  * For more details, see g_file_create() which is
1988  * the synchronous version of this call.
1989  *
1990  * When the operation is finished, @callback will be called. You can then call
1991  * g_file_create_finish() to get the result of the operation.
1992  **/
1993 void
1994 g_file_create_async (GFile               *file,
1995                      GFileCreateFlags     flags,
1996                      int                  io_priority,
1997                      GCancellable        *cancellable,
1998                      GAsyncReadyCallback  callback,
1999                      gpointer             user_data)
2000 {
2001   GFileIface *iface;
2002
2003   g_return_if_fail (G_IS_FILE (file));
2004
2005   iface = G_FILE_GET_IFACE (file);
2006   (* iface->create_async) (file,
2007                            flags,
2008                            io_priority,
2009                            cancellable,
2010                            callback,
2011                            user_data);
2012 }
2013
2014 /**
2015  * g_file_create_finish:
2016  * @file: input #GFile.
2017  * @res: a #GAsyncResult.
2018  * @error: a #GError, or %NULL
2019  *
2020  * Finishes an asynchronous file create operation started with
2021  * g_file_create_async().
2022  *
2023  * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2024  *     Free the returned object with g_object_unref().
2025  **/
2026 GFileOutputStream *
2027 g_file_create_finish (GFile         *file,
2028                       GAsyncResult  *res,
2029                       GError       **error)
2030 {
2031   GFileIface *iface;
2032
2033   g_return_val_if_fail (G_IS_FILE (file), NULL);
2034   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2035
2036   if (g_async_result_legacy_propagate_error (res, error))
2037     return NULL;
2038
2039   iface = G_FILE_GET_IFACE (file);
2040   return (* iface->create_finish) (file, res, error);
2041 }
2042
2043 /**
2044  * g_file_replace_async:
2045  * @file: input #GFile.
2046  * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the
2047  *     current #GFile, or NULL to ignore.
2048  * @make_backup: %TRUE if a backup should be created.
2049  * @flags: a set of #GFileCreateFlags.
2050  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2051  *     of the request.
2052  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2053  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2054  * @user_data: (closure): the data to pass to callback function
2055  *
2056  * Asynchronously overwrites the file, replacing the contents, possibly
2057  * creating a backup copy of the file first.
2058  *
2059  * For more details, see g_file_replace() which is
2060  * the synchronous version of this call.
2061  *
2062  * When the operation is finished, @callback will be called. You can then call
2063  * g_file_replace_finish() to get the result of the operation.
2064  **/
2065 void
2066 g_file_replace_async (GFile               *file,
2067                       const char          *etag,
2068                       gboolean             make_backup,
2069                       GFileCreateFlags     flags,
2070                       int                  io_priority,
2071                       GCancellable        *cancellable,
2072                       GAsyncReadyCallback  callback,
2073                       gpointer             user_data)
2074 {
2075   GFileIface *iface;
2076
2077   g_return_if_fail (G_IS_FILE (file));
2078
2079   iface = G_FILE_GET_IFACE (file);
2080   (* iface->replace_async) (file,
2081                             etag,
2082                             make_backup,
2083                             flags,
2084                             io_priority,
2085                             cancellable,
2086                             callback,
2087                             user_data);
2088 }
2089
2090 /**
2091  * g_file_replace_finish:
2092  * @file: input #GFile.
2093  * @res: a #GAsyncResult.
2094  * @error: a #GError, or %NULL
2095  *
2096  * Finishes an asynchronous file replace operation started with
2097  * g_file_replace_async().
2098  *
2099  * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2100  *     Free the returned object with g_object_unref().
2101  **/
2102 GFileOutputStream *
2103 g_file_replace_finish (GFile         *file,
2104                        GAsyncResult  *res,
2105                        GError       **error)
2106 {
2107   GFileIface *iface;
2108
2109   g_return_val_if_fail (G_IS_FILE (file), NULL);
2110   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2111
2112   if (g_async_result_legacy_propagate_error (res, error))
2113     return NULL;
2114
2115   iface = G_FILE_GET_IFACE (file);
2116   return (* iface->replace_finish) (file, res, error);
2117 }
2118
2119
2120 /**
2121  * g_file_open_readwrite_async:
2122  * @file: input #GFile.
2123  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2124  *     of the request.
2125  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2126  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2127  * @user_data: (closure): the data to pass to callback function
2128  *
2129  * Asynchronously opens @file for reading and writing.
2130  *
2131  * For more details, see g_file_open_readwrite() which is
2132  * the synchronous version of this call.
2133  *
2134  * When the operation is finished, @callback will be called. You can then call
2135  * g_file_open_readwrite_finish() to get the result of the operation.
2136  *
2137  * Since: 2.22
2138  **/
2139 void
2140 g_file_open_readwrite_async (GFile                      *file,
2141                              int                         io_priority,
2142                              GCancellable               *cancellable,
2143                              GAsyncReadyCallback         callback,
2144                              gpointer                    user_data)
2145 {
2146   GFileIface *iface;
2147
2148   g_return_if_fail (G_IS_FILE (file));
2149
2150   iface = G_FILE_GET_IFACE (file);
2151   (* iface->open_readwrite_async) (file,
2152                                    io_priority,
2153                                    cancellable,
2154                                    callback,
2155                                    user_data);
2156 }
2157
2158 /**
2159  * g_file_open_readwrite_finish:
2160  * @file: input #GFile.
2161  * @res: a #GAsyncResult.
2162  * @error: a #GError, or %NULL
2163  *
2164  * Finishes an asynchronous file read operation started with
2165  * g_file_open_readwrite_async().
2166  *
2167  * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2168  *     Free the returned object with g_object_unref().
2169  *
2170  * Since: 2.22
2171  **/
2172 GFileIOStream *
2173 g_file_open_readwrite_finish (GFile                      *file,
2174                               GAsyncResult               *res,
2175                               GError                    **error)
2176 {
2177   GFileIface *iface;
2178
2179   g_return_val_if_fail (G_IS_FILE (file), NULL);
2180   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2181
2182   if (g_async_result_legacy_propagate_error (res, error))
2183     return NULL;
2184
2185   iface = G_FILE_GET_IFACE (file);
2186   return (* iface->open_readwrite_finish) (file, res, error);
2187 }
2188
2189
2190 /**
2191  * g_file_create_readwrite_async:
2192  * @file: input #GFile
2193  * @flags: a set of #GFileCreateFlags
2194  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2195  *     of the request
2196  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
2197  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2198  * @user_data: (closure): the data to pass to callback function
2199  *
2200  * Asynchronously creates a new file and returns a stream for reading and
2201  * writing to it. The file must not already exist.
2202  *
2203  * For more details, see g_file_create_readwrite() which is
2204  * the synchronous version of this call.
2205  *
2206  * When the operation is finished, @callback will be called. You can then
2207  * call g_file_create_readwrite_finish() to get the result of the operation.
2208  *
2209  * Since: 2.22
2210  */
2211 void
2212 g_file_create_readwrite_async (GFile               *file,
2213                                GFileCreateFlags     flags,
2214                                int                  io_priority,
2215                                GCancellable        *cancellable,
2216                                GAsyncReadyCallback  callback,
2217                                gpointer             user_data)
2218 {
2219   GFileIface *iface;
2220
2221   g_return_if_fail (G_IS_FILE (file));
2222
2223   iface = G_FILE_GET_IFACE (file);
2224   (* iface->create_readwrite_async) (file,
2225                                      flags,
2226                                      io_priority,
2227                                      cancellable,
2228                                      callback,
2229                                      user_data);
2230 }
2231
2232 /**
2233  * g_file_create_readwrite_finish:
2234  * @file: input #GFile
2235  * @res: a #GAsyncResult
2236  * @error: a #GError, or %NULL
2237  *
2238  * Finishes an asynchronous file create operation started with
2239  * g_file_create_readwrite_async().
2240  *
2241  * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2242  *     Free the returned object with g_object_unref().
2243  *
2244  * Since: 2.22
2245  **/
2246 GFileIOStream *
2247 g_file_create_readwrite_finish (GFile         *file,
2248                                 GAsyncResult  *res,
2249                                 GError       **error)
2250 {
2251   GFileIface *iface;
2252
2253   g_return_val_if_fail (G_IS_FILE (file), NULL);
2254   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2255
2256   if (g_async_result_legacy_propagate_error (res, error))
2257     return NULL;
2258
2259   iface = G_FILE_GET_IFACE (file);
2260   return (* iface->create_readwrite_finish) (file, res, error);
2261 }
2262
2263 /**
2264  * g_file_replace_readwrite_async:
2265  * @file: input #GFile.
2266  * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the
2267  *     current #GFile, or NULL to ignore.
2268  * @make_backup: %TRUE if a backup should be created.
2269  * @flags: a set of #GFileCreateFlags.
2270  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2271  *     of the request.
2272  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2273  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2274  * @user_data: (closure): the data to pass to callback function
2275  *
2276  * Asynchronously overwrites the file in read-write mode, replacing the
2277  * contents, possibly creating a backup copy of the file first.
2278  *
2279  * For more details, see g_file_replace_readwrite() which is
2280  * the synchronous version of this call.
2281  *
2282  * When the operation is finished, @callback will be called. You can then
2283  * call g_file_replace_readwrite_finish() to get the result of the operation.
2284  *
2285  * Since: 2.22
2286  */
2287 void
2288 g_file_replace_readwrite_async (GFile               *file,
2289                                 const char          *etag,
2290                                 gboolean             make_backup,
2291                                 GFileCreateFlags     flags,
2292                                 int                  io_priority,
2293                                 GCancellable        *cancellable,
2294                                 GAsyncReadyCallback  callback,
2295                                 gpointer             user_data)
2296 {
2297   GFileIface *iface;
2298
2299   g_return_if_fail (G_IS_FILE (file));
2300
2301   iface = G_FILE_GET_IFACE (file);
2302   (* iface->replace_readwrite_async) (file,
2303                                       etag,
2304                                       make_backup,
2305                                       flags,
2306                                       io_priority,
2307                                       cancellable,
2308                                       callback,
2309                                       user_data);
2310 }
2311
2312 /**
2313  * g_file_replace_readwrite_finish:
2314  * @file: input #GFile.
2315  * @res: a #GAsyncResult.
2316  * @error: a #GError, or %NULL
2317  *
2318  * Finishes an asynchronous file replace operation started with
2319  * g_file_replace_readwrite_async().
2320  *
2321  * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2322  *     Free the returned object with g_object_unref().
2323  *
2324  * Since: 2.22
2325  */
2326 GFileIOStream *
2327 g_file_replace_readwrite_finish (GFile         *file,
2328                                  GAsyncResult  *res,
2329                                  GError       **error)
2330 {
2331   GFileIface *iface;
2332
2333   g_return_val_if_fail (G_IS_FILE (file), NULL);
2334   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2335
2336   if (g_async_result_legacy_propagate_error (res, error))
2337     return NULL;
2338
2339   iface = G_FILE_GET_IFACE (file);
2340   return (* iface->replace_readwrite_finish) (file, res, error);
2341 }
2342
2343 static gboolean
2344 copy_symlink (GFile           *destination,
2345               GFileCopyFlags   flags,
2346               GCancellable    *cancellable,
2347               const char      *target,
2348               GError         **error)
2349 {
2350   GError *my_error;
2351   gboolean tried_delete;
2352   GFileInfo *info;
2353   GFileType file_type;
2354
2355   tried_delete = FALSE;
2356
2357  retry:
2358   my_error = NULL;
2359   if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
2360     {
2361       /* Maybe it already existed, and we want to overwrite? */
2362       if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
2363           my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
2364         {
2365           g_error_free (my_error);
2366
2367
2368           /* Don't overwrite if the destination is a directory */
2369           info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2370                                     G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2371                                     cancellable, &my_error);
2372           if (info != NULL)
2373             {
2374               file_type = g_file_info_get_file_type (info);
2375               g_object_unref (info);
2376
2377               if (file_type == G_FILE_TYPE_DIRECTORY)
2378                 {
2379                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
2380                                        _("Can't copy over directory"));
2381                   return FALSE;
2382                 }
2383             }
2384
2385           if (!g_file_delete (destination, cancellable, error))
2386             return FALSE;
2387
2388           tried_delete = TRUE;
2389           goto retry;
2390         }
2391             /* Nah, fail */
2392       g_propagate_error (error, my_error);
2393       return FALSE;
2394     }
2395
2396   return TRUE;
2397 }
2398
2399 static GInputStream *
2400 open_source_for_copy (GFile           *source,
2401                       GFile           *destination,
2402                       GFileCopyFlags   flags,
2403                       GCancellable    *cancellable,
2404                       GError         **error)
2405 {
2406   GError *my_error;
2407   GInputStream *in;
2408   GFileInfo *info;
2409   GFileType file_type;
2410
2411   my_error = NULL;
2412   in = (GInputStream *)g_file_read (source, cancellable, &my_error);
2413   if (in != NULL)
2414     return in;
2415
2416   /* There was an error opening the source, try to set a good error for it: */
2417
2418   if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
2419     {
2420       /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2421        * as that is less useful to the app. Better check for errors on the
2422        * target instead.
2423        */
2424       g_error_free (my_error);
2425       my_error = NULL;
2426
2427       info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2428                                 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2429                                 cancellable, &my_error);
2430       if (info != NULL &&
2431           g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_TYPE))
2432         {
2433           file_type = g_file_info_get_file_type (info);
2434           g_object_unref (info);
2435
2436           if (flags & G_FILE_COPY_OVERWRITE)
2437             {
2438               if (file_type == G_FILE_TYPE_DIRECTORY)
2439                 {
2440                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
2441                                        _("Can't copy directory over directory"));
2442                   return NULL;
2443                 }
2444               /* continue to would_recurse error */
2445             }
2446           else
2447             {
2448               g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
2449                                    _("Target file exists"));
2450               return NULL;
2451             }
2452         }
2453       else
2454         {
2455           /* Error getting info from target, return that error
2456            * (except for NOT_FOUND, which is no error here)
2457            */
2458           if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
2459             {
2460               g_propagate_error (error, my_error);
2461               return NULL;
2462             }
2463           g_clear_error (&my_error);
2464         }
2465
2466       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
2467                            _("Can't recursively copy directory"));
2468       return NULL;
2469     }
2470
2471   g_propagate_error (error, my_error);
2472   return NULL;
2473 }
2474
2475 static gboolean
2476 should_copy (GFileAttributeInfo *info,
2477              gboolean            as_move,
2478              gboolean            skip_perms)
2479 {
2480   if (skip_perms && strcmp(info->name, "unix::mode") == 0)
2481         return FALSE;
2482
2483   if (as_move)
2484     return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
2485   return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
2486 }
2487
2488 static char *
2489 build_attribute_list_for_copy (GFileAttributeInfoList *attributes,
2490                                GFileAttributeInfoList *namespaces,
2491                                gboolean                as_move,
2492                                gboolean                skip_perms)
2493 {
2494   GString *s;
2495   gboolean first;
2496   int i;
2497
2498   first = TRUE;
2499   s = g_string_new ("");
2500
2501   if (attributes)
2502     {
2503       for (i = 0; i < attributes->n_infos; i++)
2504         {
2505           if (should_copy (&attributes->infos[i], as_move, skip_perms))
2506             {
2507               if (first)
2508                 first = FALSE;
2509               else
2510                 g_string_append_c (s, ',');
2511
2512               g_string_append (s, attributes->infos[i].name);
2513             }
2514         }
2515     }
2516
2517   if (namespaces)
2518     {
2519       for (i = 0; i < namespaces->n_infos; i++)
2520         {
2521           if (should_copy (&namespaces->infos[i], as_move, FALSE))
2522             {
2523               if (first)
2524                 first = FALSE;
2525               else
2526                 g_string_append_c (s, ',');
2527
2528               g_string_append (s, namespaces->infos[i].name);
2529               g_string_append (s, "::*");
2530             }
2531         }
2532     }
2533
2534   return g_string_free (s, FALSE);
2535 }
2536
2537 /**
2538  * g_file_copy_attributes:
2539  * @source: a #GFile with attributes.
2540  * @destination: a #GFile to copy attributes to.
2541  * @flags: a set of #GFileCopyFlags.
2542  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2543  * @error: a #GError, %NULL to ignore.
2544  *
2545  * Copies the file attributes from @source to @destination.
2546  *
2547  * Normally only a subset of the file attributes are copied,
2548  * those that are copies in a normal file copy operation
2549  * (which for instance does not include e.g. owner). However
2550  * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2551  * all the metadata that is possible to copy is copied. This
2552  * is useful when implementing move by copy + delete source.
2553  *
2554  * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise.
2555  **/
2556 gboolean
2557 g_file_copy_attributes (GFile           *source,
2558                         GFile           *destination,
2559                         GFileCopyFlags   flags,
2560                         GCancellable    *cancellable,
2561                         GError         **error)
2562 {
2563   GFileAttributeInfoList *attributes, *namespaces;
2564   char *attrs_to_read;
2565   gboolean res;
2566   GFileInfo *info;
2567   gboolean as_move;
2568   gboolean source_nofollow_symlinks;
2569   gboolean skip_perms;
2570
2571   as_move = flags & G_FILE_COPY_ALL_METADATA;
2572   source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
2573   skip_perms = (flags & G_FILE_COPY_TARGET_DEFAULT_PERMS) != 0;
2574
2575   /* Ignore errors here, if the target supports no attributes there is nothing to copy */
2576   attributes = g_file_query_settable_attributes (destination, cancellable, NULL);
2577   namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL);
2578
2579   if (attributes == NULL && namespaces == NULL)
2580     return TRUE;
2581
2582   attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move, skip_perms);
2583
2584   /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2585    * we just don't copy it.
2586    */
2587   info = g_file_query_info (source, attrs_to_read,
2588                             source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
2589                             cancellable,
2590                             NULL);
2591
2592   g_free (attrs_to_read);
2593
2594   res = TRUE;
2595   if  (info)
2596     {
2597       res = g_file_set_attributes_from_info (destination,
2598                                              info,
2599                          G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2600                                              cancellable,
2601                                              error);
2602       g_object_unref (info);
2603     }
2604
2605   g_file_attribute_info_list_unref (attributes);
2606   g_file_attribute_info_list_unref (namespaces);
2607
2608   return res;
2609 }
2610
2611 static gboolean
2612 copy_stream_with_progress (GInputStream           *in,
2613                            GOutputStream          *out,
2614                            GFile                  *source,
2615                            GCancellable           *cancellable,
2616                            GFileProgressCallback   progress_callback,
2617                            gpointer                progress_callback_data,
2618                            GError                **error)
2619 {
2620   gssize n_read, n_written;
2621   goffset current_size;
2622   char buffer[1024*64], *p;
2623   gboolean res;
2624   goffset total_size;
2625   GFileInfo *info;
2626
2627   total_size = -1;
2628   /* avoid performance impact of querying total size when it's not needed */
2629   if (progress_callback)
2630     {
2631       info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2632                                              G_FILE_ATTRIBUTE_STANDARD_SIZE,
2633                                              cancellable, NULL);
2634       if (info)
2635         {
2636           if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2637             total_size = g_file_info_get_size (info);
2638           g_object_unref (info);
2639         }
2640
2641       if (total_size == -1)
2642         {
2643           info = g_file_query_info (source,
2644                                     G_FILE_ATTRIBUTE_STANDARD_SIZE,
2645                                     G_FILE_QUERY_INFO_NONE,
2646                                     cancellable, NULL);
2647           if (info)
2648             {
2649               if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2650                 total_size = g_file_info_get_size (info);
2651               g_object_unref (info);
2652             }
2653         }
2654     }
2655
2656   if (total_size == -1)
2657     total_size = 0;
2658
2659   current_size = 0;
2660   res = TRUE;
2661   while (TRUE)
2662     {
2663       n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2664       if (n_read == -1)
2665         {
2666           res = FALSE;
2667           break;
2668         }
2669
2670       if (n_read == 0)
2671         break;
2672
2673       current_size += n_read;
2674
2675       p = buffer;
2676       while (n_read > 0)
2677         {
2678           n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2679           if (n_written == -1)
2680             {
2681               res = FALSE;
2682               break;
2683             }
2684
2685           p += n_written;
2686           n_read -= n_written;
2687         }
2688
2689       if (!res)
2690         break;
2691
2692       if (progress_callback)
2693         progress_callback (current_size, total_size, progress_callback_data);
2694     }
2695
2696   /* Make sure we send full copied size */
2697   if (progress_callback)
2698     progress_callback (current_size, total_size, progress_callback_data);
2699
2700   return res;
2701 }
2702
2703 #ifdef HAVE_SPLICE
2704
2705 static gboolean
2706 do_splice (int     fd_in,
2707            loff_t *off_in,
2708            int     fd_out,
2709            loff_t *off_out,
2710            size_t  len,
2711            long   *bytes_transferd,
2712            GError **error)
2713 {
2714   long result;
2715
2716 retry:
2717   result = splice (fd_in, off_in, fd_out, off_out, len, SPLICE_F_MORE);
2718
2719   if (result == -1)
2720     {
2721       int errsv = errno;
2722
2723       if (errsv == EINTR)
2724         goto retry;
2725       else if (errsv == ENOSYS || errsv == EINVAL)
2726         g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2727                              _("Splice not supported"));
2728       else
2729         g_set_error (error, G_IO_ERROR,
2730                      g_io_error_from_errno (errsv),
2731                      _("Error splicing file: %s"),
2732                      g_strerror (errsv));
2733
2734       return FALSE;
2735     }
2736
2737   *bytes_transferd = result;
2738   return TRUE;
2739 }
2740
2741 static gboolean
2742 splice_stream_with_progress (GInputStream           *in,
2743                              GOutputStream          *out,
2744                              GCancellable           *cancellable,
2745                              GFileProgressCallback   progress_callback,
2746                              gpointer                progress_callback_data,
2747                              GError                **error)
2748 {
2749   int buffer[2];
2750   gboolean res;
2751   goffset total_size;
2752   loff_t offset_in;
2753   loff_t offset_out;
2754   int fd_in, fd_out;
2755
2756   fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
2757   fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
2758
2759   if (pipe (buffer) != 0)
2760     {
2761       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2762                            "Pipe creation failed");
2763       return FALSE;
2764     }
2765
2766   total_size = -1;
2767   /* avoid performance impact of querying total size when it's not needed */
2768   if (progress_callback)
2769     {
2770       struct stat sbuf;
2771
2772       if (fstat (fd_in, &sbuf) == 0)
2773         total_size = sbuf.st_size;
2774     }
2775
2776   if (total_size == -1)
2777     total_size = 0;
2778
2779   offset_in = offset_out = 0;
2780   res = FALSE;
2781   while (TRUE)
2782     {
2783       long n_read;
2784       long n_written;
2785
2786       if (g_cancellable_set_error_if_cancelled (cancellable, error))
2787         break;
2788
2789       if (!do_splice (fd_in, &offset_in, buffer[1], NULL, 1024*64, &n_read, error))
2790         break;
2791
2792       if (n_read == 0)
2793         {
2794           res = TRUE;
2795           break;
2796         }
2797
2798       while (n_read > 0)
2799         {
2800           if (g_cancellable_set_error_if_cancelled (cancellable, error))
2801             goto out;
2802
2803           if (!do_splice (buffer[0], NULL, fd_out, &offset_out, n_read, &n_written, error))
2804             goto out;
2805
2806           n_read -= n_written;
2807         }
2808
2809       if (progress_callback)
2810         progress_callback (offset_in, total_size, progress_callback_data);
2811     }
2812
2813   /* Make sure we send full copied size */
2814   if (progress_callback)
2815     progress_callback (offset_in, total_size, progress_callback_data);
2816
2817  out:
2818   close (buffer[0]);
2819   close (buffer[1]);
2820
2821   return res;
2822 }
2823 #endif
2824
2825 static gboolean
2826 file_copy_fallback (GFile                  *source,
2827                     GFile                  *destination,
2828                     GFileCopyFlags          flags,
2829                     GCancellable           *cancellable,
2830                     GFileProgressCallback   progress_callback,
2831                     gpointer                progress_callback_data,
2832                     GError                **error)
2833 {
2834   GInputStream *in;
2835   GOutputStream *out;
2836   GFileInfo *info;
2837   const char *target;
2838   gboolean result;
2839 #ifdef HAVE_SPLICE
2840   gboolean fallback = TRUE;
2841 #endif
2842
2843   /* need to know the file type */
2844   info = g_file_query_info (source,
2845                             G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
2846                             G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2847                             cancellable,
2848                             error);
2849
2850   if (info == NULL)
2851           return FALSE;
2852
2853   /* Maybe copy the symlink? */
2854   if ((flags & G_FILE_COPY_NOFOLLOW_SYMLINKS) &&
2855       g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK)
2856     {
2857       target = g_file_info_get_symlink_target (info);
2858       if (target)
2859         {
2860           if (!copy_symlink (destination, flags, cancellable, target, error))
2861             {
2862               g_object_unref (info);
2863               return FALSE;
2864             }
2865
2866           g_object_unref (info);
2867           goto copied_file;
2868         }
2869         /* ... else fall back on a regular file copy */
2870         g_object_unref (info);
2871     }
2872   /* Handle "special" files (pipes, device nodes, ...)? */
2873   else if (g_file_info_get_file_type (info) == G_FILE_TYPE_SPECIAL)
2874     {
2875       /* FIXME: could try to recreate device nodes and others? */
2876
2877       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2878                            _("Can't copy special file"));
2879       g_object_unref (info);
2880       return FALSE;
2881     }
2882   /* Everything else should just fall back on a regular copy. */
2883   else
2884     g_object_unref (info);
2885
2886   in = open_source_for_copy (source, destination, flags, cancellable, error);
2887   if (in == NULL)
2888     return FALSE;
2889
2890   if (flags & G_FILE_COPY_OVERWRITE)
2891     {
2892       out = (GOutputStream *)g_file_replace (destination,
2893                                              NULL,
2894                                              flags & G_FILE_COPY_BACKUP,
2895                                              G_FILE_CREATE_REPLACE_DESTINATION,
2896                                              cancellable, error);
2897     }
2898   else
2899     {
2900       out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
2901     }
2902
2903   if (out == NULL)
2904     {
2905       g_object_unref (in);
2906       return FALSE;
2907     }
2908
2909 #ifdef HAVE_SPLICE
2910   if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
2911     {
2912       GError *splice_err = NULL;
2913
2914       result = splice_stream_with_progress (in, out, cancellable,
2915                                             progress_callback, progress_callback_data,
2916                                             &splice_err);
2917
2918       if (result || !g_error_matches (splice_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
2919         {
2920           fallback = FALSE;
2921           if (!result)
2922             g_propagate_error (error, splice_err);
2923         }
2924       else
2925         g_clear_error (&splice_err);
2926     }
2927
2928   if (fallback)
2929 #endif
2930     result = copy_stream_with_progress (in, out, source, cancellable,
2931                                         progress_callback, progress_callback_data,
2932                                         error);
2933
2934   /* Don't care about errors in source here */
2935   g_input_stream_close (in, cancellable, NULL);
2936
2937   /* But write errors on close are bad! */
2938   if (!g_output_stream_close (out, cancellable, result ? error : NULL))
2939     result = FALSE;
2940
2941   g_object_unref (in);
2942   g_object_unref (out);
2943
2944   if (result == FALSE)
2945     return FALSE;
2946
2947  copied_file:
2948   /* Ignore errors here. Failure to copy metadata is not a hard error */
2949   g_file_copy_attributes (source, destination,
2950                           flags, cancellable, NULL);
2951
2952   return TRUE;
2953 }
2954
2955 /**
2956  * g_file_copy:
2957  * @source: input #GFile.
2958  * @destination: destination #GFile
2959  * @flags: set of #GFileCopyFlags
2960  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
2961  * @progress_callback: (allow-none) (scope call): function to callback with
2962  *     progress information, or %NULL if progress information is not needed
2963  * @progress_callback_data: (closure): user data to pass to @progress_callback
2964  * @error: #GError to set on error, or %NULL
2965  *
2966  * Copies the file @source to the location specified by @destination.
2967  * Can not handle recursive copies of directories.
2968  *
2969  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2970  * existing @destination file is overwritten.
2971  *
2972  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2973  * will be copied as symlinks, otherwise the target of the
2974  * @source symlink will be copied.
2975  *
2976  * If @cancellable is not %NULL, then the operation can be cancelled by
2977  * triggering the cancellable object from another thread. If the operation
2978  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2979  *
2980  * If @progress_callback is not %NULL, then the operation can be monitored by
2981  * setting this to a #GFileProgressCallback function. @progress_callback_data
2982  * will be passed to this function. It is guaranteed that this callback will
2983  * be called after all data has been transferred with the total number of bytes
2984  * copied during the operation.
2985  *
2986  * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2987  * error is returned, independent on the status of the @destination.
2988  *
2989  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2990  * error G_IO_ERROR_EXISTS is returned.
2991  *
2992  * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2993  * error is returned. If trying to overwrite a directory with a directory the
2994  * G_IO_ERROR_WOULD_MERGE error is returned.
2995  *
2996  * If the source is a directory and the target does not exist, or
2997  * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
2998  * G_IO_ERROR_WOULD_RECURSE error is returned.
2999  *
3000  * If you are interested in copying the #GFile object itself (not the on-disk
3001  * file), see g_file_dup().
3002  *
3003  * Returns: %TRUE on success, %FALSE otherwise.
3004  **/
3005 gboolean
3006 g_file_copy (GFile                  *source,
3007              GFile                  *destination,
3008              GFileCopyFlags          flags,
3009              GCancellable           *cancellable,
3010              GFileProgressCallback   progress_callback,
3011              gpointer                progress_callback_data,
3012              GError                **error)
3013 {
3014   GFileIface *iface;
3015   GError *my_error;
3016   gboolean res;
3017
3018   g_return_val_if_fail (G_IS_FILE (source), FALSE);
3019   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3020
3021   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3022     return FALSE;
3023
3024   iface = G_FILE_GET_IFACE (destination);
3025   if (iface->copy)
3026     {
3027       my_error = NULL;
3028       res = (* iface->copy) (source, destination,
3029                              flags, cancellable,
3030                              progress_callback, progress_callback_data,
3031                              &my_error);
3032
3033       if (res)
3034         return TRUE;
3035
3036       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3037         {
3038           g_propagate_error (error, my_error);
3039               return FALSE;
3040         }
3041       else
3042         g_clear_error (&my_error);
3043     }
3044
3045   /* If the types are different, and the destination method failed
3046      also try the source method */
3047   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3048     {
3049       iface = G_FILE_GET_IFACE (source);
3050
3051       if (iface->copy)
3052         {
3053           my_error = NULL;
3054           res = (* iface->copy) (source, destination,
3055                                  flags, cancellable,
3056                                  progress_callback, progress_callback_data,
3057                                  &my_error);
3058
3059           if (res)
3060             return TRUE;
3061
3062           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3063             {
3064               g_propagate_error (error, my_error);
3065               return FALSE;
3066             }
3067           else
3068             g_clear_error (&my_error);
3069         }
3070     }
3071
3072   return file_copy_fallback (source, destination, flags, cancellable,
3073                              progress_callback, progress_callback_data,
3074                              error);
3075 }
3076
3077 /**
3078  * g_file_copy_async: (skip)
3079  * @source: input #GFile.
3080  * @destination: destination #GFile
3081  * @flags: set of #GFileCopyFlags
3082  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3083  *     of the request
3084  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
3085  * @progress_callback: (allow-none): function to callback with progress
3086  *     information, or %NULL if progress information is not needed
3087  * @progress_callback_data: (closure): user data to pass to @progress_callback
3088  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3089  * @user_data: the data to pass to callback function
3090  *
3091  * Copies the file @source to the location specified by @destination
3092  * asynchronously. For details of the behaviour, see g_file_copy().
3093  *
3094  * If @progress_callback is not %NULL, then that function that will be called
3095  * just like in g_file_copy(), however the callback will run in the main loop,
3096  * not in the thread that is doing the I/O operation.
3097  *
3098  * When the operation is finished, @callback will be called. You can then call
3099  * g_file_copy_finish() to get the result of the operation.
3100  **/
3101 void
3102 g_file_copy_async (GFile                  *source,
3103                    GFile                  *destination,
3104                    GFileCopyFlags          flags,
3105                    int                     io_priority,
3106                    GCancellable           *cancellable,
3107                    GFileProgressCallback   progress_callback,
3108                    gpointer                progress_callback_data,
3109                    GAsyncReadyCallback     callback,
3110                    gpointer                user_data)
3111 {
3112   GFileIface *iface;
3113
3114   g_return_if_fail (G_IS_FILE (source));
3115   g_return_if_fail (G_IS_FILE (destination));
3116
3117   iface = G_FILE_GET_IFACE (source);
3118   (* iface->copy_async) (source,
3119                          destination,
3120                          flags,
3121                          io_priority,
3122                          cancellable,
3123                          progress_callback,
3124                          progress_callback_data,
3125                          callback,
3126                          user_data);
3127 }
3128
3129 /**
3130  * g_file_copy_finish:
3131  * @file: input #GFile.
3132  * @res: a #GAsyncResult.
3133  * @error: a #GError, or %NULL
3134  *
3135  * Finishes copying the file started with
3136  * g_file_copy_async().
3137  *
3138  * Returns: a %TRUE on success, %FALSE on error.
3139  **/
3140 gboolean
3141 g_file_copy_finish (GFile        *file,
3142                     GAsyncResult *res,
3143                     GError      **error)
3144 {
3145   GFileIface *iface;
3146
3147   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3148   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
3149
3150   if (g_async_result_legacy_propagate_error (res, error))
3151     return FALSE;
3152
3153   iface = G_FILE_GET_IFACE (file);
3154   return (* iface->copy_finish) (file, res, error);
3155 }
3156
3157 /**
3158  * g_file_move:
3159  * @source: #GFile pointing to the source location.
3160  * @destination: #GFile pointing to the destination location.
3161  * @flags: set of #GFileCopyFlags.
3162  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3163  * @progress_callback: (allow-none) (scope call): #GFileProgressCallback function for updates.
3164  * @progress_callback_data: (closure): gpointer to user data for the callback function.
3165  * @error: #GError for returning error conditions, or %NULL
3166  *
3167  *
3168  * Tries to move the file or directory @source to the location specified by @destination.
3169  * If native move operations are supported then this is used, otherwise a copy + delete
3170  * fallback is used. The native implementation may support moving directories (for instance
3171  * on moves inside the same filesystem), but the fallback code does not.
3172  *
3173  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3174  * existing @destination file is overwritten.
3175  *
3176  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3177  * will be copied as symlinks, otherwise the target of the
3178  * @source symlink will be copied.
3179  *
3180  * If @cancellable is not %NULL, then the operation can be cancelled by
3181  * triggering the cancellable object from another thread. If the operation
3182  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3183  *
3184  * If @progress_callback is not %NULL, then the operation can be monitored by
3185  * setting this to a #GFileProgressCallback function. @progress_callback_data
3186  * will be passed to this function. It is guaranteed that this callback will
3187  * be called after all data has been transferred with the total number of bytes
3188  * copied during the operation.
3189  *
3190  * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
3191  * error is returned, independent on the status of the @destination.
3192  *
3193  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
3194  * error G_IO_ERROR_EXISTS is returned.
3195  *
3196  * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
3197  * error is returned. If trying to overwrite a directory with a directory the
3198  * G_IO_ERROR_WOULD_MERGE error is returned.
3199  *
3200  * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
3201  * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
3202  * may be returned (if the native move operation isn't available).
3203  *
3204  * Returns: %TRUE on successful move, %FALSE otherwise.
3205  **/
3206 gboolean
3207 g_file_move (GFile                  *source,
3208              GFile                  *destination,
3209              GFileCopyFlags          flags,
3210              GCancellable           *cancellable,
3211              GFileProgressCallback   progress_callback,
3212              gpointer                progress_callback_data,
3213              GError                **error)
3214 {
3215   GFileIface *iface;
3216   GError *my_error;
3217   gboolean res;
3218
3219   g_return_val_if_fail (G_IS_FILE (source), FALSE);
3220   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3221
3222   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3223     return FALSE;
3224
3225   iface = G_FILE_GET_IFACE (destination);
3226   if (iface->move)
3227     {
3228       my_error = NULL;
3229       res = (* iface->move) (source, destination,
3230                              flags, cancellable,
3231                              progress_callback, progress_callback_data,
3232                              &my_error);
3233
3234       if (res)
3235         return TRUE;
3236
3237       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3238         {
3239           g_propagate_error (error, my_error);
3240           return FALSE;
3241         }
3242     }
3243
3244   /* If the types are different, and the destination method failed
3245      also try the source method */
3246   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3247     {
3248       iface = G_FILE_GET_IFACE (source);
3249
3250       if (iface->move)
3251         {
3252           my_error = NULL;
3253           res = (* iface->move) (source, destination,
3254                                  flags, cancellable,
3255                                  progress_callback, progress_callback_data,
3256                                  &my_error);
3257
3258           if (res)
3259             return TRUE;
3260
3261           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3262             {
3263               g_propagate_error (error, my_error);
3264               return FALSE;
3265             }
3266         }
3267     }
3268
3269   if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
3270     {
3271       g_set_error_literal (error, G_IO_ERROR,
3272                            G_IO_ERROR_NOT_SUPPORTED,
3273                            _("Operation not supported"));
3274       return FALSE;
3275     }
3276
3277   flags |= G_FILE_COPY_ALL_METADATA;
3278   if (!g_file_copy (source, destination, flags, cancellable,
3279                     progress_callback, progress_callback_data,
3280                     error))
3281     return FALSE;
3282
3283   return g_file_delete (source, cancellable, error);
3284 }
3285
3286 /**
3287  * g_file_make_directory:
3288  * @file: input #GFile.
3289  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3290  * @error: a #GError, or %NULL
3291  *
3292  * Creates a directory. Note that this will only create a child directory of
3293  * the immediate parent directory of the path or URI given by the #GFile. To
3294  * recursively create directories, see g_file_make_directory_with_parents().
3295  * This function will fail if the parent directory does not exist, setting
3296  * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating
3297  * directories, this function will fail, setting @error to
3298  * %G_IO_ERROR_NOT_SUPPORTED.
3299  *
3300  * For a local #GFile the newly created directory will have the default
3301  * (current) ownership and permissions of the current process.
3302  *
3303  * If @cancellable is not %NULL, then the operation can be cancelled by
3304  * triggering the cancellable object from another thread. If the operation
3305  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3306  *
3307  * Returns: %TRUE on successful creation, %FALSE otherwise.
3308  **/
3309 gboolean
3310 g_file_make_directory (GFile         *file,
3311                        GCancellable  *cancellable,
3312                        GError       **error)
3313 {
3314   GFileIface *iface;
3315
3316   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3317
3318   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3319     return FALSE;
3320
3321   iface = G_FILE_GET_IFACE (file);
3322
3323   if (iface->make_directory == NULL)
3324     {
3325       g_set_error_literal (error, G_IO_ERROR,
3326                            G_IO_ERROR_NOT_SUPPORTED,
3327                            _("Operation not supported"));
3328       return FALSE;
3329     }
3330
3331   return (* iface->make_directory) (file, cancellable, error);
3332 }
3333
3334 /**
3335  * g_file_make_directory_with_parents:
3336  * @file: input #GFile.
3337  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3338  * @error: a #GError, or %NULL
3339  *
3340  * Creates a directory and any parent directories that may not exist similar to
3341  * 'mkdir -p'. If the file system does not support creating directories, this
3342  * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the
3343  * directory itself already exists, this function will fail setting @error
3344  * to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents().
3345  *
3346  * For a local #GFile the newly created directories will have the default
3347  * (current) ownership and permissions of the current process.
3348  *
3349  * If @cancellable is not %NULL, then the operation can be cancelled by
3350  * triggering the cancellable object from another thread. If the operation
3351  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3352  *
3353  * Returns: %TRUE if all directories have been successfully created, %FALSE
3354  * otherwise.
3355  *
3356  * Since: 2.18
3357  **/
3358 gboolean
3359 g_file_make_directory_with_parents (GFile         *file,
3360                                     GCancellable  *cancellable,
3361                                     GError       **error)
3362 {
3363   gboolean result;
3364   GFile *work_file = NULL;
3365   GList *list = NULL, *l;
3366   GError *my_error = NULL;
3367
3368   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3369
3370   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3371     return FALSE;
3372
3373   result = g_file_make_directory (file, cancellable, &my_error);
3374   if (result || my_error->code != G_IO_ERROR_NOT_FOUND)
3375     {
3376       if (my_error)
3377         g_propagate_error (error, my_error);
3378       return result;
3379     }
3380
3381   work_file = g_object_ref (file);
3382
3383   while (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
3384     {
3385       GFile *parent_file;
3386
3387       g_clear_error (&my_error);
3388
3389       parent_file = g_file_get_parent (work_file);
3390       if (parent_file == NULL)
3391         break;
3392       result = g_file_make_directory (parent_file, cancellable, &my_error);
3393
3394       g_object_unref (work_file);
3395       work_file = g_object_ref (parent_file);
3396
3397       if (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
3398         {
3399           g_clear_error (&my_error);
3400           list = g_list_prepend (list, parent_file);  /* Transfer ownership of ref */
3401         }
3402       else
3403         g_object_unref (parent_file);
3404     }
3405
3406   for (l = list; result && l; l = l->next)
3407     {
3408       result = g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
3409     }
3410
3411   if (work_file)
3412     g_object_unref (work_file);
3413
3414   /* Clean up */
3415   while (list != NULL)
3416     {
3417       g_object_unref ((GFile *) list->data);
3418       list = g_list_remove (list, list->data);
3419     }
3420
3421   if (!result)
3422     {
3423       g_propagate_error (error, my_error);
3424       return result;
3425     }
3426
3427   return g_file_make_directory (file, cancellable, error);
3428 }
3429
3430 /**
3431  * g_file_make_symbolic_link:
3432  * @file: a #GFile with the name of the symlink to create
3433  * @symlink_value: a string with the path for the target of the new symlink
3434  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3435  * @error: a #GError.
3436  *
3437  * Creates a symbolic link named @file which contains the string
3438  * @symlink_value.
3439  *
3440  * If @cancellable is not %NULL, then the operation can be cancelled by
3441  * triggering the cancellable object from another thread. If the operation
3442  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3443  *
3444  * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3445  */
3446 gboolean
3447 g_file_make_symbolic_link (GFile         *file,
3448                            const char    *symlink_value,
3449                            GCancellable  *cancellable,
3450                            GError       **error)
3451 {
3452   GFileIface *iface;
3453
3454   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3455   g_return_val_if_fail (symlink_value != NULL, FALSE);
3456
3457   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3458     return FALSE;
3459
3460   if (*symlink_value == '\0')
3461     {
3462       g_set_error_literal (error, G_IO_ERROR,
3463                            G_IO_ERROR_INVALID_ARGUMENT,
3464                            _("Invalid symlink value given"));
3465       return FALSE;
3466     }
3467
3468   iface = G_FILE_GET_IFACE (file);
3469
3470   if (iface->make_symbolic_link == NULL)
3471     {
3472       g_set_error_literal (error, G_IO_ERROR,
3473                            G_IO_ERROR_NOT_SUPPORTED,
3474                            _("Operation not supported"));
3475       return FALSE;
3476     }
3477
3478   return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
3479 }
3480
3481 /**
3482  * g_file_delete:
3483  * @file: input #GFile.
3484  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3485  * @error: a #GError, or %NULL
3486  *
3487  * Deletes a file. If the @file is a directory, it will only be deleted if it
3488  * is empty.  This has the same semantics as g_unlink().
3489  *
3490  * If @cancellable is not %NULL, then the operation can be cancelled by
3491  * triggering the cancellable object from another thread. If the operation
3492  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3493  *
3494  * Virtual: delete_file
3495  * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3496  **/
3497 gboolean
3498 g_file_delete (GFile         *file,
3499                GCancellable  *cancellable,
3500                GError       **error)
3501 {
3502   GFileIface *iface;
3503
3504   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3505
3506   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3507     return FALSE;
3508
3509   iface = G_FILE_GET_IFACE (file);
3510
3511   if (iface->delete_file == NULL)
3512     {
3513       g_set_error_literal (error, G_IO_ERROR,
3514                            G_IO_ERROR_NOT_SUPPORTED,
3515                            _("Operation not supported"));
3516       return FALSE;
3517     }
3518
3519   return (* iface->delete_file) (file, cancellable, error);
3520 }
3521
3522 /**
3523  * g_file_delete_async:
3524  * @file: input #GFile.
3525  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3526  *     of the request
3527  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3528  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3529  * @user_data: the data to pass to callback function
3530  *
3531  * Asynchronously delete a file. If the @file is a directory, it will
3532  * only be deleted if it is empty.  This has the same semantics as
3533  * g_unlink().
3534  *
3535  * Virtual: delete_file_async
3536  * Since: 2.34
3537  **/
3538 void
3539 g_file_delete_async (GFile               *file,
3540                      int                  io_priority,
3541                      GCancellable        *cancellable,
3542                      GAsyncReadyCallback  callback,
3543                      gpointer             user_data)
3544 {
3545   GFileIface *iface;
3546
3547   g_return_if_fail (G_IS_FILE (file));
3548
3549   iface = G_FILE_GET_IFACE (file);
3550   (* iface->delete_file_async) (file,
3551                                 io_priority,
3552                                 cancellable,
3553                                 callback,
3554                                 user_data);
3555 }
3556
3557 /**
3558  * g_file_delete_finish:
3559  * @file: input #GFile.
3560  * @res: a #GAsyncResult.
3561  * @error: a #GError, or %NULL
3562  *
3563  * Finishes deleting a file started with
3564  * g_file_delete_async().
3565  *
3566  * Virtual: delete_file_finish
3567  * Since: 2.34
3568  **/
3569 gboolean
3570 g_file_delete_finish (GFile            *file,
3571                       GAsyncResult     *result,
3572                       GError          **error)
3573 {
3574   GFileIface *iface;
3575
3576   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3577   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3578
3579   if (g_async_result_legacy_propagate_error (result, error))
3580     return FALSE;
3581
3582   iface = G_FILE_GET_IFACE (file);
3583   return (* iface->delete_file_finish) (file, result, error);
3584 }
3585
3586 /**
3587  * g_file_trash:
3588  * @file: #GFile to send to trash.
3589  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3590  * @error: a #GError, or %NULL
3591  *
3592  * Sends @file to the "Trashcan", if possible. This is similar to
3593  * deleting it, but the user can recover it before emptying the trashcan.
3594  * Not all file systems support trashing, so this call can return the
3595  * %G_IO_ERROR_NOT_SUPPORTED error.
3596  *
3597  *
3598  * If @cancellable is not %NULL, then the operation can be cancelled by
3599  * triggering the cancellable object from another thread. If the operation
3600  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3601  *
3602  * Returns: %TRUE on successful trash, %FALSE otherwise.
3603  **/
3604 gboolean
3605 g_file_trash (GFile         *file,
3606               GCancellable  *cancellable,
3607               GError       **error)
3608 {
3609   GFileIface *iface;
3610
3611   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3612
3613   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3614     return FALSE;
3615
3616   iface = G_FILE_GET_IFACE (file);
3617
3618   if (iface->trash == NULL)
3619     {
3620       g_set_error_literal (error,
3621                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3622                            _("Trash not supported"));
3623       return FALSE;
3624     }
3625
3626   return (* iface->trash) (file, cancellable, error);
3627 }
3628
3629 /**
3630  * g_file_set_display_name:
3631  * @file: input #GFile.
3632  * @display_name: a string.
3633  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3634  * @error: a #GError, or %NULL
3635  *
3636  * Renames @file to the specified display name.
3637  *
3638  * The display name is converted from UTF8 to the correct encoding for the target
3639  * filesystem if possible and the @file is renamed to this.
3640  *
3641  * If you want to implement a rename operation in the user interface the edit name
3642  * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
3643  * widget, and then the result after editing should be passed to g_file_set_display_name().
3644  *
3645  * On success the resulting converted filename is returned.
3646  *
3647  * If @cancellable is not %NULL, then the operation can be cancelled by
3648  * triggering the cancellable object from another thread. If the operation
3649  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3650  *
3651  * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL
3652  *     if there was an error.
3653  *     Free the returned object with g_object_unref().
3654  **/
3655 GFile *
3656 g_file_set_display_name (GFile         *file,
3657                          const char    *display_name,
3658                          GCancellable  *cancellable,
3659                          GError       **error)
3660 {
3661   GFileIface *iface;
3662
3663   g_return_val_if_fail (G_IS_FILE (file), NULL);
3664   g_return_val_if_fail (display_name != NULL, NULL);
3665
3666   if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
3667     {
3668       g_set_error (error,
3669                    G_IO_ERROR,
3670                    G_IO_ERROR_INVALID_ARGUMENT,
3671                    _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
3672       return NULL;
3673     }
3674
3675   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3676     return NULL;
3677
3678   iface = G_FILE_GET_IFACE (file);
3679
3680   return (* iface->set_display_name) (file, display_name, cancellable, error);
3681 }
3682
3683 /**
3684  * g_file_set_display_name_async:
3685  * @file: input #GFile.
3686  * @display_name: a string.
3687  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3688  *     of the request.
3689  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3690  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3691  * @user_data: (closure): the data to pass to callback function
3692  *
3693  * Asynchronously sets the display name for a given #GFile.
3694  *
3695  * For more details, see g_file_set_display_name() which is
3696  * the synchronous version of this call.
3697  *
3698  * When the operation is finished, @callback will be called. You can then call
3699  * g_file_set_display_name_finish() to get the result of the operation.
3700  **/
3701 void
3702 g_file_set_display_name_async (GFile               *file,
3703                                const char          *display_name,
3704                                int                  io_priority,
3705                                GCancellable        *cancellable,
3706                                GAsyncReadyCallback  callback,
3707                                gpointer             user_data)
3708 {
3709   GFileIface *iface;
3710
3711   g_return_if_fail (G_IS_FILE (file));
3712   g_return_if_fail (display_name != NULL);
3713
3714   iface = G_FILE_GET_IFACE (file);
3715   (* iface->set_display_name_async) (file,
3716                                      display_name,
3717                                      io_priority,
3718                                      cancellable,
3719                                      callback,
3720                                      user_data);
3721 }
3722
3723 /**
3724  * g_file_set_display_name_finish:
3725  * @file: input #GFile.
3726  * @res: a #GAsyncResult.
3727  * @error: a #GError, or %NULL
3728  *
3729  * Finishes setting a display name started with
3730  * g_file_set_display_name_async().
3731  *
3732  * Returns: (transfer full): a #GFile or %NULL on error.
3733  *     Free the returned object with g_object_unref().
3734  **/
3735 GFile *
3736 g_file_set_display_name_finish (GFile         *file,
3737                                 GAsyncResult  *res,
3738                                 GError       **error)
3739 {
3740   GFileIface *iface;
3741
3742   g_return_val_if_fail (G_IS_FILE (file), NULL);
3743   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3744
3745   if (g_async_result_legacy_propagate_error (res, error))
3746     return NULL;
3747
3748   iface = G_FILE_GET_IFACE (file);
3749   return (* iface->set_display_name_finish) (file, res, error);
3750 }
3751
3752 /**
3753  * g_file_query_settable_attributes:
3754  * @file: input #GFile.
3755  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3756  * @error: a #GError, or %NULL
3757  *
3758  * Obtain the list of settable attributes for the file.
3759  *
3760  * Returns the type and full attribute name of all the attributes
3761  * that can be set on this file. This doesn't mean setting it will always
3762  * succeed though, you might get an access failure, or some specific
3763  * file may not support a specific attribute.
3764  *
3765  * If @cancellable is not %NULL, then the operation can be cancelled by
3766  * triggering the cancellable object from another thread. If the operation
3767  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3768  *
3769  * Returns: a #GFileAttributeInfoList describing the settable attributes.
3770  * When you are done with it, release it with g_file_attribute_info_list_unref()
3771  **/
3772 GFileAttributeInfoList *
3773 g_file_query_settable_attributes (GFile         *file,
3774                                   GCancellable  *cancellable,
3775                                   GError       **error)
3776 {
3777   GFileIface *iface;
3778   GError *my_error;
3779   GFileAttributeInfoList *list;
3780
3781   g_return_val_if_fail (G_IS_FILE (file), NULL);
3782
3783   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3784     return NULL;
3785
3786   iface = G_FILE_GET_IFACE (file);
3787
3788   if (iface->query_settable_attributes == NULL)
3789     return g_file_attribute_info_list_new ();
3790
3791   my_error = NULL;
3792   list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3793
3794   if (list == NULL)
3795     {
3796       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3797         {
3798           list = g_file_attribute_info_list_new ();
3799           g_error_free (my_error);
3800         }
3801       else
3802         g_propagate_error (error, my_error);
3803     }
3804
3805   return list;
3806 }
3807
3808 /**
3809  * g_file_query_writable_namespaces:
3810  * @file: input #GFile.
3811  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3812  * @error: a #GError, or %NULL
3813  *
3814  * Obtain the list of attribute namespaces where new attributes
3815  * can be created by a user. An example of this is extended
3816  * attributes (in the "xattr" namespace).
3817  *
3818  * If @cancellable is not %NULL, then the operation can be cancelled by
3819  * triggering the cancellable object from another thread. If the operation
3820  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3821  *
3822  * Returns: a #GFileAttributeInfoList describing the writable namespaces.
3823  * When you are done with it, release it with g_file_attribute_info_list_unref()
3824  **/
3825 GFileAttributeInfoList *
3826 g_file_query_writable_namespaces (GFile         *file,
3827                                   GCancellable  *cancellable,
3828                                   GError       **error)
3829 {
3830   GFileIface *iface;
3831   GError *my_error;
3832   GFileAttributeInfoList *list;
3833
3834   g_return_val_if_fail (G_IS_FILE (file), NULL);
3835
3836   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3837     return NULL;
3838
3839   iface = G_FILE_GET_IFACE (file);
3840
3841   if (iface->query_writable_namespaces == NULL)
3842     return g_file_attribute_info_list_new ();
3843
3844   my_error = NULL;
3845   list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
3846
3847   if (list == NULL)
3848     {
3849       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3850         {
3851           list = g_file_attribute_info_list_new ();
3852           g_error_free (my_error);
3853         }
3854       else
3855         g_propagate_error (error, my_error);
3856     }
3857
3858   return list;
3859 }
3860
3861 /**
3862  * g_file_set_attribute:
3863  * @file: input #GFile.
3864  * @attribute: a string containing the attribute's name.
3865  * @type: The type of the attribute
3866  * @value_p: (allow-none): a pointer to the value (or the pointer itself if the type is a pointer type)
3867  * @flags: a set of #GFileQueryInfoFlags.
3868  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3869  * @error: a #GError, or %NULL
3870  *
3871  * Sets an attribute in the file with attribute name @attribute to @value.
3872  *
3873  * Some attributes can be unset by setting @attribute to
3874  * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
3875  *
3876  * If @cancellable is not %NULL, then the operation can be cancelled by
3877  * triggering the cancellable object from another thread. If the operation
3878  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3879  *
3880  * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3881  **/
3882 gboolean
3883 g_file_set_attribute (GFile                      *file,
3884                       const char                 *attribute,
3885                       GFileAttributeType          type,
3886                       gpointer                    value_p,
3887                       GFileQueryInfoFlags         flags,
3888                       GCancellable               *cancellable,
3889                       GError                    **error)
3890 {
3891   GFileIface *iface;
3892
3893   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3894   g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
3895
3896   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3897     return FALSE;
3898
3899   iface = G_FILE_GET_IFACE (file);
3900
3901   if (iface->set_attribute == NULL)
3902     {
3903       g_set_error_literal (error, G_IO_ERROR,
3904                            G_IO_ERROR_NOT_SUPPORTED,
3905                            _("Operation not supported"));
3906       return FALSE;
3907     }
3908
3909   return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
3910 }
3911
3912 /**
3913  * g_file_set_attributes_from_info:
3914  * @file: input #GFile.
3915  * @info: a #GFileInfo.
3916  * @flags: #GFileQueryInfoFlags
3917  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3918  * @error: a #GError, or %NULL
3919  *
3920  * Tries to set all attributes in the #GFileInfo on the target values,
3921  * not stopping on the first error.
3922  *
3923  * If there is any error during this operation then @error will be set to
3924  * the first error. Error on particular fields are flagged by setting
3925  * the "status" field in the attribute value to
3926  * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
3927  * further errors.
3928  *
3929  * If @cancellable is not %NULL, then the operation can be cancelled by
3930  * triggering the cancellable object from another thread. If the operation
3931  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3932  *
3933  * Returns: %TRUE if there was any error, %FALSE otherwise.
3934  **/
3935 gboolean
3936 g_file_set_attributes_from_info (GFile                *file,
3937                                  GFileInfo            *info,
3938                                  GFileQueryInfoFlags   flags,
3939                                  GCancellable         *cancellable,
3940                                  GError              **error)
3941 {
3942   GFileIface *iface;
3943
3944   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3945   g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
3946
3947   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3948     return FALSE;
3949
3950   g_file_info_clear_status (info);
3951
3952   iface = G_FILE_GET_IFACE (file);
3953
3954   return (* iface->set_attributes_from_info) (file,
3955                                               info,
3956                                               flags,
3957                                               cancellable,
3958                                               error);
3959 }
3960
3961
3962 static gboolean
3963 g_file_real_set_attributes_from_info (GFile                *file,
3964                                       GFileInfo            *info,
3965                                       GFileQueryInfoFlags   flags,
3966                                       GCancellable         *cancellable,
3967                                       GError              **error)
3968 {
3969   char **attributes;
3970   int i;
3971   gboolean res;
3972   GFileAttributeValue *value;
3973
3974   res = TRUE;
3975
3976   attributes = g_file_info_list_attributes (info, NULL);
3977
3978   for (i = 0; attributes[i] != NULL; i++)
3979     {
3980       value = _g_file_info_get_attribute_value (info, attributes[i]);
3981
3982       if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
3983         continue;
3984
3985       if (!g_file_set_attribute (file, attributes[i],
3986                                  value->type, _g_file_attribute_value_peek_as_pointer (value),
3987                                  flags, cancellable, error))
3988         {
3989           value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3990           res = FALSE;
3991           /* Don't set error multiple times */
3992           error = NULL;
3993         }
3994       else
3995         value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3996     }
3997
3998   g_strfreev (attributes);
3999
4000   return res;
4001 }
4002
4003 /**
4004  * g_file_set_attributes_async:
4005  * @file: input #GFile.
4006  * @info: a #GFileInfo.
4007  * @flags: a #GFileQueryInfoFlags.
4008  * @io_priority: the <link linkend="io-priority">I/O priority</link>
4009  *     of the request.
4010  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4011  * @callback: (scope async): a #GAsyncReadyCallback.
4012  * @user_data: (closure): a #gpointer.
4013  *
4014  * Asynchronously sets the attributes of @file with @info.
4015  *
4016  * For more details, see g_file_set_attributes_from_info() which is
4017  * the synchronous version of this call.
4018  *
4019  * When the operation is finished, @callback will be called. You can then call
4020  * g_file_set_attributes_finish() to get the result of the operation.
4021  **/
4022 void
4023 g_file_set_attributes_async (GFile               *file,
4024                              GFileInfo           *info,
4025                              GFileQueryInfoFlags  flags,
4026                              int                  io_priority,
4027                              GCancellable        *cancellable,
4028                              GAsyncReadyCallback  callback,
4029                              gpointer             user_data)
4030 {
4031   GFileIface *iface;
4032
4033   g_return_if_fail (G_IS_FILE (file));
4034   g_return_if_fail (G_IS_FILE_INFO (info));
4035
4036   iface = G_FILE_GET_IFACE (file);
4037   (* iface->set_attributes_async) (file,
4038                                    info,
4039                                    flags,
4040                                    io_priority,
4041                                    cancellable,
4042                                    callback,
4043                                    user_data);
4044 }
4045
4046 /**
4047  * g_file_set_attributes_finish:
4048  * @file: input #GFile.
4049  * @result: a #GAsyncResult.
4050  * @info: (out) (transfer full): a #GFileInfo.
4051  * @error: a #GError, or %NULL
4052  *
4053  * Finishes setting an attribute started in g_file_set_attributes_async().
4054  *
4055  * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4056  **/
4057 gboolean
4058 g_file_set_attributes_finish (GFile         *file,
4059                               GAsyncResult  *result,
4060                               GFileInfo    **info,
4061                               GError       **error)
4062 {
4063   GFileIface *iface;
4064
4065   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4066   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4067
4068   /* No standard handling of errors here, as we must set info even
4069    * on errors
4070    */
4071   iface = G_FILE_GET_IFACE (file);
4072   return (* iface->set_attributes_finish) (file, result, info, error);
4073 }
4074
4075 /**
4076  * g_file_set_attribute_string:
4077  * @file: input #GFile.
4078  * @attribute: a string containing the attribute's name.
4079  * @value: a string containing the attribute's value.
4080  * @flags: #GFileQueryInfoFlags.
4081  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4082  * @error: a #GError, or %NULL
4083  *
4084  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4085  * If @attribute is of a different type, this operation will fail.
4086  *
4087  * If @cancellable is not %NULL, then the operation can be cancelled by
4088  * triggering the cancellable object from another thread. If the operation
4089  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4090  *
4091  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4092  **/
4093 gboolean
4094 g_file_set_attribute_string (GFile                *file,
4095                              const char           *attribute,
4096                              const char           *value,
4097                              GFileQueryInfoFlags   flags,
4098                              GCancellable         *cancellable,
4099                              GError              **error)
4100 {
4101   return g_file_set_attribute (file, attribute,
4102                                G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
4103                                flags, cancellable, error);
4104 }
4105
4106 /**
4107  * g_file_set_attribute_byte_string:
4108  * @file: input #GFile.
4109  * @attribute: a string containing the attribute's name.
4110  * @value: a string containing the attribute's new value.
4111  * @flags: a #GFileQueryInfoFlags.
4112  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4113  * @error: a #GError, or %NULL
4114  *
4115  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4116  * If @attribute is of a different type, this operation will fail,
4117  * returning %FALSE.
4118  *
4119  * If @cancellable is not %NULL, then the operation can be cancelled by
4120  * triggering the cancellable object from another thread. If the operation
4121  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4122  *
4123  * Returns: %TRUE if the @attribute was successfully set to @value
4124  * in the @file, %FALSE otherwise.
4125  **/
4126 gboolean
4127 g_file_set_attribute_byte_string  (GFile                *file,
4128                                    const char           *attribute,
4129                                    const char           *value,
4130                                    GFileQueryInfoFlags   flags,
4131                                    GCancellable         *cancellable,
4132                                    GError              **error)
4133 {
4134   return g_file_set_attribute (file, attribute,
4135                                G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
4136                                flags, cancellable, error);
4137 }
4138
4139 /**
4140  * g_file_set_attribute_uint32:
4141  * @file: input #GFile.
4142  * @attribute: a string containing the attribute's name.
4143  * @value: a #guint32 containing the attribute's new value.
4144  * @flags: a #GFileQueryInfoFlags.
4145  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4146  * @error: a #GError, or %NULL
4147  *
4148  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4149  * If @attribute is of a different type, this operation will fail.
4150  *
4151  * If @cancellable is not %NULL, then the operation can be cancelled by
4152  * triggering the cancellable object from another thread. If the operation
4153  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4154  *
4155  * Returns: %TRUE if the @attribute was successfully set to @value
4156  * in the @file, %FALSE otherwise.
4157  **/
4158 gboolean
4159 g_file_set_attribute_uint32 (GFile                *file,
4160                              const char           *attribute,
4161                              guint32               value,
4162                              GFileQueryInfoFlags   flags,
4163                              GCancellable         *cancellable,
4164                              GError              **error)
4165 {
4166   return g_file_set_attribute (file, attribute,
4167                                G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
4168                                flags, cancellable, error);
4169 }
4170
4171 /**
4172  * g_file_set_attribute_int32:
4173  * @file: input #GFile.
4174  * @attribute: a string containing the attribute's name.
4175  * @value: a #gint32 containing the attribute's new value.
4176  * @flags: a #GFileQueryInfoFlags.
4177  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4178  * @error: a #GError, or %NULL
4179  *
4180  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4181  * If @attribute is of a different type, this operation will fail.
4182  *
4183  * If @cancellable is not %NULL, then the operation can be cancelled by
4184  * triggering the cancellable object from another thread. If the operation
4185  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4186  *
4187  * Returns: %TRUE if the @attribute was successfully set to @value
4188  * in the @file, %FALSE otherwise.
4189  **/
4190 gboolean
4191 g_file_set_attribute_int32 (GFile                *file,
4192                             const char           *attribute,
4193                             gint32                value,
4194                             GFileQueryInfoFlags   flags,
4195                             GCancellable         *cancellable,
4196                             GError              **error)
4197 {
4198   return g_file_set_attribute (file, attribute,
4199                                G_FILE_ATTRIBUTE_TYPE_INT32, &value,
4200                                flags, cancellable, error);
4201 }
4202
4203 /**
4204  * g_file_set_attribute_uint64:
4205  * @file: input #GFile.
4206  * @attribute: a string containing the attribute's name.
4207  * @value: a #guint64 containing the attribute's new value.
4208  * @flags: a #GFileQueryInfoFlags.
4209  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4210  * @error: a #GError, or %NULL
4211  *
4212  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4213  * If @attribute is of a different type, this operation will fail.
4214  *
4215  * If @cancellable is not %NULL, then the operation can be cancelled by
4216  * triggering the cancellable object from another thread. If the operation
4217  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4218  *
4219  * Returns: %TRUE if the @attribute was successfully set to @value
4220  * in the @file, %FALSE otherwise.
4221  **/
4222 gboolean
4223 g_file_set_attribute_uint64 (GFile                *file,
4224                              const char           *attribute,
4225                              guint64               value,
4226                              GFileQueryInfoFlags   flags,
4227                              GCancellable         *cancellable,
4228                              GError              **error)
4229  {
4230   return g_file_set_attribute (file, attribute,
4231                                G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
4232                                flags, cancellable, error);
4233 }
4234
4235 /**
4236  * g_file_set_attribute_int64:
4237  * @file: input #GFile.
4238  * @attribute: a string containing the attribute's name.
4239  * @value: a #guint64 containing the attribute's new value.
4240  * @flags: a #GFileQueryInfoFlags.
4241  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4242  * @error: a #GError, or %NULL
4243  *
4244  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4245  * If @attribute is of a different type, this operation will fail.
4246  *
4247  * If @cancellable is not %NULL, then the operation can be cancelled by
4248  * triggering the cancellable object from another thread. If the operation
4249  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4250  *
4251  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4252  **/
4253 gboolean
4254 g_file_set_attribute_int64 (GFile                *file,
4255                             const char           *attribute,
4256                             gint64                value,
4257                             GFileQueryInfoFlags   flags,
4258                             GCancellable         *cancellable,
4259                             GError              **error)
4260 {
4261   return g_file_set_attribute (file, attribute,
4262                                G_FILE_ATTRIBUTE_TYPE_INT64, &value,
4263                                flags, cancellable, error);
4264 }
4265
4266 /**
4267  * g_file_mount_mountable:
4268  * @file: input #GFile.
4269  * @flags: flags affecting the operation
4270  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4271  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4272  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4273  * @user_data: (closure): the data to pass to callback function
4274  *
4275  * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4276  * Using @mount_operation, you can request callbacks when, for instance,
4277  * passwords are needed during authentication.
4278  *
4279  * If @cancellable is not %NULL, then the operation can be cancelled by
4280  * triggering the cancellable object from another thread. If the operation
4281  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4282  *
4283  * When the operation is finished, @callback will be called. You can then call
4284  * g_file_mount_mountable_finish() to get the result of the operation.
4285  **/
4286 void
4287 g_file_mount_mountable (GFile               *file,
4288                         GMountMountFlags     flags,
4289                         GMountOperation     *mount_operation,
4290                         GCancellable        *cancellable,
4291                         GAsyncReadyCallback  callback,
4292                         gpointer             user_data)
4293 {
4294   GFileIface *iface;
4295
4296   g_return_if_fail (G_IS_FILE (file));
4297
4298   iface = G_FILE_GET_IFACE (file);
4299
4300   if (iface->mount_mountable == NULL)
4301     {
4302       g_simple_async_report_error_in_idle (G_OBJECT (file),
4303                                            callback,
4304                                            user_data,
4305                                            G_IO_ERROR,
4306                                            G_IO_ERROR_NOT_SUPPORTED,
4307                                            _("Operation not supported"));
4308       return;
4309     }
4310
4311   (* iface->mount_mountable) (file,
4312                               flags,
4313                               mount_operation,
4314                               cancellable,
4315                               callback,
4316                               user_data);
4317 }
4318
4319 /**
4320  * g_file_mount_mountable_finish:
4321  * @file: input #GFile.
4322  * @result: a #GAsyncResult.
4323  * @error: a #GError, or %NULL
4324  *
4325  * Finishes a mount operation. See g_file_mount_mountable() for details.
4326  *
4327  * Finish an asynchronous mount operation that was started
4328  * with g_file_mount_mountable().
4329  *
4330  * Returns: (transfer full): a #GFile or %NULL on error.
4331  *     Free the returned object with g_object_unref().
4332  **/
4333 GFile *
4334 g_file_mount_mountable_finish (GFile         *file,
4335                                GAsyncResult  *result,
4336                                GError       **error)
4337 {
4338   GFileIface *iface;
4339
4340   g_return_val_if_fail (G_IS_FILE (file), NULL);
4341   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
4342
4343   if (g_async_result_legacy_propagate_error (result, error))
4344     return NULL;
4345
4346   iface = G_FILE_GET_IFACE (file);
4347   return (* iface->mount_mountable_finish) (file, result, error);
4348 }
4349
4350 /**
4351  * g_file_unmount_mountable:
4352  * @file: input #GFile.
4353  * @flags: flags affecting the operation
4354  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4355  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4356  * @user_data: (closure): the data to pass to callback function
4357  *
4358  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4359  *
4360  * If @cancellable is not %NULL, then the operation can be cancelled by
4361  * triggering the cancellable object from another thread. If the operation
4362  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4363  *
4364  * When the operation is finished, @callback will be called. You can then call
4365  * g_file_unmount_mountable_finish() to get the result of the operation.
4366  *
4367  * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4368  **/
4369 void
4370 g_file_unmount_mountable (GFile               *file,
4371                           GMountUnmountFlags   flags,
4372                           GCancellable        *cancellable,
4373                           GAsyncReadyCallback  callback,
4374                           gpointer             user_data)
4375 {
4376   GFileIface *iface;
4377
4378   g_return_if_fail (G_IS_FILE (file));
4379
4380   iface = G_FILE_GET_IFACE (file);
4381
4382   if (iface->unmount_mountable == NULL)
4383     {
4384       g_simple_async_report_error_in_idle (G_OBJECT (file),
4385                                            callback,
4386                                            user_data,
4387                                            G_IO_ERROR,
4388                                            G_IO_ERROR_NOT_SUPPORTED,
4389                                            _("Operation not supported"));
4390       return;
4391     }
4392
4393   (* iface->unmount_mountable) (file,
4394                                 flags,
4395                                 cancellable,
4396                                 callback,
4397                                 user_data);
4398 }
4399
4400 /**
4401  * g_file_unmount_mountable_finish:
4402  * @file: input #GFile.
4403  * @result: a #GAsyncResult.
4404  * @error: a #GError, or %NULL
4405  *
4406  * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4407  *
4408  * Finish an asynchronous unmount operation that was started
4409  * with g_file_unmount_mountable().
4410  *
4411  * Returns: %TRUE if the operation finished successfully. %FALSE
4412  * otherwise.
4413  *
4414  * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead.
4415  **/
4416 gboolean
4417 g_file_unmount_mountable_finish (GFile         *file,
4418                                  GAsyncResult  *result,
4419                                  GError       **error)
4420 {
4421   GFileIface *iface;
4422
4423   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4424   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4425
4426   if (g_async_result_legacy_propagate_error (result, error))
4427     return FALSE;
4428
4429   iface = G_FILE_GET_IFACE (file);
4430   return (* iface->unmount_mountable_finish) (file, result, error);
4431 }
4432
4433 /**
4434  * g_file_unmount_mountable_with_operation:
4435  * @file: input #GFile.
4436  * @flags: flags affecting the operation
4437  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4438  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4439  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4440  * @user_data: (closure): the data to pass to callback function
4441  *
4442  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4443  *
4444  * If @cancellable is not %NULL, then the operation can be cancelled by
4445  * triggering the cancellable object from another thread. If the operation
4446  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4447  *
4448  * When the operation is finished, @callback will be called. You can then call
4449  * g_file_unmount_mountable_finish() to get the result of the operation.
4450  *
4451  * Since: 2.22
4452  **/
4453 void
4454 g_file_unmount_mountable_with_operation (GFile               *file,
4455                                          GMountUnmountFlags   flags,
4456                                          GMountOperation     *mount_operation,
4457                                          GCancellable        *cancellable,
4458                                          GAsyncReadyCallback  callback,
4459                                          gpointer             user_data)
4460 {
4461   GFileIface *iface;
4462
4463   g_return_if_fail (G_IS_FILE (file));
4464
4465   iface = G_FILE_GET_IFACE (file);
4466
4467   if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL)
4468     {
4469       g_simple_async_report_error_in_idle (G_OBJECT (file),
4470                                            callback,
4471                                            user_data,
4472                                            G_IO_ERROR,
4473                                            G_IO_ERROR_NOT_SUPPORTED,
4474                                            _("Operation not supported"));
4475       return;
4476     }
4477
4478   if (iface->unmount_mountable_with_operation != NULL)
4479     (* iface->unmount_mountable_with_operation) (file,
4480                                                  flags,
4481                                                  mount_operation,
4482                                                  cancellable,
4483                                                  callback,
4484                                                  user_data);
4485   else
4486     (* iface->unmount_mountable) (file,
4487                                   flags,
4488                                   cancellable,
4489                                   callback,
4490                                   user_data);
4491 }
4492
4493 /**
4494  * g_file_unmount_mountable_with_operation_finish:
4495  * @file: input #GFile.
4496  * @result: a #GAsyncResult.
4497  * @error: a #GError, or %NULL
4498  *
4499  * Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
4500  *
4501  * Finish an asynchronous unmount operation that was started
4502  * with g_file_unmount_mountable_with_operation().
4503  *
4504  * Returns: %TRUE if the operation finished successfully. %FALSE
4505  * otherwise.
4506  *
4507  * Since: 2.22
4508  **/
4509 gboolean
4510 g_file_unmount_mountable_with_operation_finish (GFile         *file,
4511                                                 GAsyncResult  *result,
4512                                                 GError       **error)
4513 {
4514   GFileIface *iface;
4515
4516   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4517   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4518
4519   if (g_async_result_legacy_propagate_error (result, error))
4520     return FALSE;
4521
4522   iface = G_FILE_GET_IFACE (file);
4523   if (iface->unmount_mountable_with_operation_finish != NULL)
4524     return (* iface->unmount_mountable_with_operation_finish) (file, result, error);
4525   else
4526     return (* iface->unmount_mountable_finish) (file, result, error);
4527 }
4528
4529 /**
4530  * g_file_eject_mountable:
4531  * @file: input #GFile.
4532  * @flags: flags affecting the operation
4533  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4534  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4535  * @user_data: (closure): the data to pass to callback function
4536  *
4537  * Starts an asynchronous eject on a mountable.
4538  * When this operation has completed, @callback will be called with
4539  * @user_user data, and the operation can be finalized with
4540  * g_file_eject_mountable_finish().
4541  *
4542  * If @cancellable is not %NULL, then the operation can be cancelled by
4543  * triggering the cancellable object from another thread. If the operation
4544  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4545  *
4546  * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
4547  **/
4548 void
4549 g_file_eject_mountable (GFile               *file,
4550                         GMountUnmountFlags   flags,
4551                         GCancellable        *cancellable,
4552                         GAsyncReadyCallback  callback,
4553                         gpointer             user_data)
4554 {
4555   GFileIface *iface;
4556
4557   g_return_if_fail (G_IS_FILE (file));
4558
4559   iface = G_FILE_GET_IFACE (file);
4560
4561   if (iface->eject_mountable == NULL)
4562     {
4563       g_simple_async_report_error_in_idle (G_OBJECT (file),
4564                                            callback,
4565                                            user_data,
4566                                            G_IO_ERROR,
4567                                            G_IO_ERROR_NOT_SUPPORTED,
4568                                            _("Operation not supported"));
4569       return;
4570     }
4571
4572   (* iface->eject_mountable) (file,
4573                               flags,
4574                               cancellable,
4575                               callback,
4576                               user_data);
4577 }
4578
4579 /**
4580  * g_file_eject_mountable_finish:
4581  * @file: input #GFile.
4582  * @result: a #GAsyncResult.
4583  * @error: a #GError, or %NULL
4584  *
4585  * Finishes an asynchronous eject operation started by
4586  * g_file_eject_mountable().
4587  *
4588  * Returns: %TRUE if the @file was ejected successfully. %FALSE
4589  * otherwise.
4590  *
4591  * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead.
4592  **/
4593 gboolean
4594 g_file_eject_mountable_finish (GFile         *file,
4595                                GAsyncResult  *result,
4596                                GError       **error)
4597 {
4598   GFileIface *iface;
4599
4600   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4601   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4602
4603   if (g_async_result_legacy_propagate_error (result, error))
4604     return FALSE;
4605
4606   iface = G_FILE_GET_IFACE (file);
4607   return (* iface->eject_mountable_finish) (file, result, error);
4608 }
4609
4610 /**
4611  * g_file_eject_mountable_with_operation:
4612  * @file: input #GFile.
4613  * @flags: flags affecting the operation
4614  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4615  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4616  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4617  * @user_data: (closure): the data to pass to callback function
4618  *
4619  * Starts an asynchronous eject on a mountable.
4620  * When this operation has completed, @callback will be called with
4621  * @user_user data, and the operation can be finalized with
4622  * g_file_eject_mountable_with_operation_finish().
4623  *
4624  * If @cancellable is not %NULL, then the operation can be cancelled by
4625  * triggering the cancellable object from another thread. If the operation
4626  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4627  *
4628  * Since: 2.22
4629  **/
4630 void
4631 g_file_eject_mountable_with_operation (GFile               *file,
4632                                        GMountUnmountFlags   flags,
4633                                        GMountOperation     *mount_operation,
4634                                        GCancellable        *cancellable,
4635                                        GAsyncReadyCallback  callback,
4636                                        gpointer             user_data)
4637 {
4638   GFileIface *iface;
4639
4640   g_return_if_fail (G_IS_FILE (file));
4641
4642   iface = G_FILE_GET_IFACE (file);
4643
4644   if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL)
4645     {
4646       g_simple_async_report_error_in_idle (G_OBJECT (file),
4647                                            callback,
4648                                            user_data,
4649                                            G_IO_ERROR,
4650                                            G_IO_ERROR_NOT_SUPPORTED,
4651                                            _("Operation not supported"));
4652       return;
4653     }
4654
4655   if (iface->eject_mountable_with_operation != NULL)
4656     (* iface->eject_mountable_with_operation) (file,
4657                                                flags,
4658                                                mount_operation,
4659                                                cancellable,
4660                                                callback,
4661                                                user_data);
4662   else
4663     (* iface->eject_mountable) (file,
4664                                 flags,
4665                                 cancellable,
4666                                 callback,
4667                                 user_data);
4668 }
4669
4670 /**
4671  * g_file_eject_mountable_with_operation_finish:
4672  * @file: input #GFile.
4673  * @result: a #GAsyncResult.
4674  * @error: a #GError, or %NULL
4675  *
4676  * Finishes an asynchronous eject operation started by
4677  * g_file_eject_mountable_with_operation().
4678  *
4679  * Returns: %TRUE if the @file was ejected successfully. %FALSE
4680  * otherwise.
4681  *
4682  * Since: 2.22
4683  **/
4684 gboolean
4685 g_file_eject_mountable_with_operation_finish (GFile         *file,
4686                                               GAsyncResult  *result,
4687                                               GError       **error)
4688 {
4689   GFileIface *iface;
4690
4691   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4692   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4693
4694   if (g_async_result_legacy_propagate_error (result, error))
4695     return FALSE;
4696
4697   iface = G_FILE_GET_IFACE (file);
4698   if (iface->eject_mountable_with_operation_finish != NULL)
4699     return (* iface->eject_mountable_with_operation_finish) (file, result, error);
4700   else
4701     return (* iface->eject_mountable_finish) (file, result, error);
4702 }
4703
4704 /**
4705  * g_file_monitor_directory:
4706  * @file: input #GFile.
4707  * @flags: a set of #GFileMonitorFlags.
4708  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4709  * @error: a #GError, or %NULL.
4710  *
4711  * Obtains a directory monitor for the given file.
4712  * This may fail if directory monitoring is not supported.
4713  *
4714  * If @cancellable is not %NULL, then the operation can be cancelled by
4715  * triggering the cancellable object from another thread. If the operation
4716  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4717  *
4718  * Virtual: monitor_dir
4719  * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4720  *     Free the returned object with g_object_unref().
4721  **/
4722 GFileMonitor*
4723 g_file_monitor_directory (GFile             *file,
4724                           GFileMonitorFlags  flags,
4725                           GCancellable      *cancellable,
4726                           GError           **error)
4727 {
4728   GFileIface *iface;
4729
4730   g_return_val_if_fail (G_IS_FILE (file), NULL);
4731
4732   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4733     return NULL;
4734
4735   iface = G_FILE_GET_IFACE (file);
4736
4737   if (iface->monitor_dir == NULL)
4738     {
4739       g_set_error_literal (error, G_IO_ERROR,
4740                            G_IO_ERROR_NOT_SUPPORTED,
4741                            _("Operation not supported"));
4742       return NULL;
4743     }
4744
4745   return (* iface->monitor_dir) (file, flags, cancellable, error);
4746 }
4747
4748 /**
4749  * g_file_monitor_file:
4750  * @file: input #GFile.
4751  * @flags: a set of #GFileMonitorFlags.
4752  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4753  * @error: a #GError, or %NULL.
4754  *
4755  * Obtains a file monitor for the given file. If no file notification
4756  * mechanism exists, then regular polling of the file is used.
4757  *
4758  * If @cancellable is not %NULL, then the operation can be cancelled by
4759  * triggering the cancellable object from another thread. If the operation
4760  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4761  *
4762  * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4763  *     Free the returned object with g_object_unref().
4764  **/
4765 GFileMonitor*
4766 g_file_monitor_file (GFile             *file,
4767                      GFileMonitorFlags  flags,
4768                      GCancellable      *cancellable,
4769                      GError           **error)
4770 {
4771   GFileIface *iface;
4772   GFileMonitor *monitor;
4773
4774   g_return_val_if_fail (G_IS_FILE (file), NULL);
4775
4776   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4777     return NULL;
4778
4779   iface = G_FILE_GET_IFACE (file);
4780
4781   monitor = NULL;
4782
4783   if (iface->monitor_file)
4784     monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
4785
4786 /* Fallback to polling */
4787   if (monitor == NULL)
4788     monitor = _g_poll_file_monitor_new (file);
4789
4790   return monitor;
4791 }
4792
4793 /**
4794  * g_file_monitor:
4795  * @file: input #GFile
4796  * @flags: a set of #GFileMonitorFlags
4797  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
4798  * @error: a #GError, or %NULL
4799  *
4800  * Obtains a file or directory monitor for the given file, depending
4801  * on the type of the file.
4802  *
4803  * If @cancellable is not %NULL, then the operation can be cancelled by
4804  * triggering the cancellable object from another thread. If the operation
4805  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4806  *
4807  * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4808  *     Free the returned object with g_object_unref().
4809  *
4810  * Since: 2.18
4811  */
4812 GFileMonitor*
4813 g_file_monitor (GFile             *file,
4814                 GFileMonitorFlags  flags,
4815                 GCancellable      *cancellable,
4816                 GError           **error)
4817 {
4818   if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
4819     return g_file_monitor_directory (file, flags, cancellable, error);
4820   else
4821     return g_file_monitor_file (file, flags, cancellable, error);
4822 }
4823
4824 /********************************************
4825  *   Default implementation of async ops    *
4826  ********************************************/
4827
4828 typedef struct {
4829   char *attributes;
4830   GFileQueryInfoFlags flags;
4831   GFileInfo *info;
4832 } QueryInfoAsyncData;
4833
4834 static void
4835 query_info_data_free (QueryInfoAsyncData *data)
4836 {
4837   if (data->info)
4838     g_object_unref (data->info);
4839   g_free (data->attributes);
4840   g_free (data);
4841 }
4842
4843 static void
4844 query_info_async_thread (GSimpleAsyncResult *res,
4845                          GObject            *object,
4846                          GCancellable       *cancellable)
4847 {
4848   GError *error = NULL;
4849   QueryInfoAsyncData *data;
4850   GFileInfo *info;
4851
4852   data = g_simple_async_result_get_op_res_gpointer (res);
4853
4854   info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4855
4856   if (info == NULL)
4857     g_simple_async_result_take_error (res, error);
4858   else
4859     data->info = info;
4860 }
4861
4862 static void
4863 g_file_real_query_info_async (GFile               *file,
4864                               const char          *attributes,
4865                               GFileQueryInfoFlags  flags,
4866                               int                  io_priority,
4867                               GCancellable        *cancellable,
4868                               GAsyncReadyCallback  callback,
4869                               gpointer             user_data)
4870 {
4871   GSimpleAsyncResult *res;
4872   QueryInfoAsyncData *data;
4873
4874   data = g_new0 (QueryInfoAsyncData, 1);
4875   data->attributes = g_strdup (attributes);
4876   data->flags = flags;
4877
4878   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
4879   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
4880
4881   g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
4882   g_object_unref (res);
4883 }
4884
4885 static GFileInfo *
4886 g_file_real_query_info_finish (GFile         *file,
4887                                GAsyncResult  *res,
4888                                GError       **error)
4889 {
4890   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4891   QueryInfoAsyncData *data;
4892
4893   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
4894
4895   if (g_simple_async_result_propagate_error (simple, error))
4896     return NULL;
4897
4898   data = g_simple_async_result_get_op_res_gpointer (simple);
4899   if (data->info)
4900     return g_object_ref (data->info);
4901
4902   return NULL;
4903 }
4904
4905 typedef struct {
4906   char *attributes;
4907   GFileInfo *info;
4908 } QueryFilesystemInfoAsyncData;
4909
4910 static void
4911 query_filesystem_info_data_free (QueryFilesystemInfoAsyncData *data)
4912 {
4913   if (data->info)
4914     g_object_unref (data->info);
4915   g_free (data->attributes);
4916   g_free (data);
4917 }
4918
4919 static void
4920 query_filesystem_info_async_thread (GSimpleAsyncResult *res,
4921                                     GObject            *object,
4922                                     GCancellable       *cancellable)
4923 {
4924   GError *error = NULL;
4925   QueryFilesystemInfoAsyncData *data;
4926   GFileInfo *info;
4927
4928   data = g_simple_async_result_get_op_res_gpointer (res);
4929
4930   info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error);
4931
4932   if (info == NULL)
4933     g_simple_async_result_take_error (res, error);
4934   else
4935     data->info = info;
4936 }
4937
4938 static void
4939 g_file_real_query_filesystem_info_async (GFile               *file,
4940                                          const char          *attributes,
4941                                          int                  io_priority,
4942                                          GCancellable        *cancellable,
4943                                          GAsyncReadyCallback  callback,
4944                                          gpointer             user_data)
4945 {
4946   GSimpleAsyncResult *res;
4947   QueryFilesystemInfoAsyncData *data;
4948
4949   data = g_new0 (QueryFilesystemInfoAsyncData, 1);
4950   data->attributes = g_strdup (attributes);
4951
4952   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async);
4953   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free);
4954
4955   g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable);
4956   g_object_unref (res);
4957 }
4958
4959 static GFileInfo *
4960 g_file_real_query_filesystem_info_finish (GFile         *file,
4961                                           GAsyncResult  *res,
4962                                           GError       **error)
4963 {
4964   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4965   QueryFilesystemInfoAsyncData *data;
4966
4967   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_filesystem_info_async);
4968
4969   if (g_simple_async_result_propagate_error (simple, error))
4970     return NULL;
4971
4972   data = g_simple_async_result_get_op_res_gpointer (simple);
4973   if (data->info)
4974     return g_object_ref (data->info);
4975
4976   return NULL;
4977 }
4978
4979 typedef struct {
4980   char *attributes;
4981   GFileQueryInfoFlags flags;
4982   GFileEnumerator *enumerator;
4983 } EnumerateChildrenAsyncData;
4984
4985 static void
4986 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
4987 {
4988   if (data->enumerator)
4989     g_object_unref (data->enumerator);
4990   g_free (data->attributes);
4991   g_free (data);
4992 }
4993
4994 static void
4995 enumerate_children_async_thread (GSimpleAsyncResult *res,
4996                                  GObject            *object,
4997                                  GCancellable       *cancellable)
4998 {
4999   GError *error = NULL;
5000   EnumerateChildrenAsyncData *data;
5001   GFileEnumerator *enumerator;
5002
5003   data = g_simple_async_result_get_op_res_gpointer (res);
5004
5005   enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5006
5007   if (enumerator == NULL)
5008     g_simple_async_result_take_error (res, error);
5009   else
5010     data->enumerator = enumerator;
5011 }
5012
5013 static void
5014 g_file_real_enumerate_children_async (GFile               *file,
5015                                       const char          *attributes,
5016                                       GFileQueryInfoFlags  flags,
5017                                       int                  io_priority,
5018                                       GCancellable        *cancellable,
5019                                       GAsyncReadyCallback  callback,
5020                                       gpointer             user_data)
5021 {
5022   GSimpleAsyncResult *res;
5023   EnumerateChildrenAsyncData *data;
5024
5025   data = g_new0 (EnumerateChildrenAsyncData, 1);
5026   data->attributes = g_strdup (attributes);
5027   data->flags = flags;
5028
5029   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
5030   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
5031
5032   g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
5033   g_object_unref (res);
5034 }
5035
5036 static GFileEnumerator *
5037 g_file_real_enumerate_children_finish (GFile         *file,
5038                                        GAsyncResult  *res,
5039                                        GError       **error)
5040 {
5041   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5042   EnumerateChildrenAsyncData *data;
5043
5044   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
5045
5046   if (g_simple_async_result_propagate_error (simple, error))
5047     return NULL;
5048
5049   data = g_simple_async_result_get_op_res_gpointer (simple);
5050   if (data->enumerator)
5051     return g_object_ref (data->enumerator);
5052
5053   return NULL;
5054 }
5055
5056 static void
5057 open_read_async_thread (GSimpleAsyncResult *res,
5058                         GObject            *object,
5059                         GCancellable       *cancellable)
5060 {
5061   GFileIface *iface;
5062   GFileInputStream *stream;
5063   GError *error = NULL;
5064
5065   iface = G_FILE_GET_IFACE (object);
5066
5067   if (iface->read_fn == NULL)
5068     {
5069       g_set_error_literal (&error, G_IO_ERROR,
5070                            G_IO_ERROR_NOT_SUPPORTED,
5071                            _("Operation not supported"));
5072
5073       g_simple_async_result_take_error (res, error);
5074
5075       return;
5076     }
5077
5078   stream = iface->read_fn (G_FILE (object), cancellable, &error);
5079
5080   if (stream == NULL)
5081     g_simple_async_result_take_error (res, error);
5082   else
5083     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5084 }
5085
5086 static void
5087 g_file_real_read_async (GFile               *file,
5088                         int                  io_priority,
5089                         GCancellable        *cancellable,
5090                         GAsyncReadyCallback  callback,
5091                         gpointer             user_data)
5092 {
5093   GSimpleAsyncResult *res;
5094
5095   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
5096
5097   g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
5098   g_object_unref (res);
5099 }
5100
5101 static GFileInputStream *
5102 g_file_real_read_finish (GFile         *file,
5103                          GAsyncResult  *res,
5104                          GError       **error)
5105 {
5106   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5107   gpointer op;
5108
5109   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
5110
5111   if (g_simple_async_result_propagate_error (simple, error))
5112     return NULL;
5113
5114   op = g_simple_async_result_get_op_res_gpointer (simple);
5115   if (op)
5116     return g_object_ref (op);
5117
5118   return NULL;
5119 }
5120
5121 static void
5122 append_to_async_thread (GSimpleAsyncResult *res,
5123                         GObject            *object,
5124                         GCancellable       *cancellable)
5125 {
5126   GFileIface *iface;
5127   GFileCreateFlags *data;
5128   GFileOutputStream *stream;
5129   GError *error = NULL;
5130
5131   iface = G_FILE_GET_IFACE (object);
5132
5133   data = g_simple_async_result_get_op_res_gpointer (res);
5134
5135   stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
5136
5137   if (stream == NULL)
5138     g_simple_async_result_take_error (res, error);
5139   else
5140     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5141 }
5142
5143 static void
5144 g_file_real_append_to_async (GFile               *file,
5145                              GFileCreateFlags     flags,
5146                              int                  io_priority,
5147                              GCancellable        *cancellable,
5148                              GAsyncReadyCallback  callback,
5149                              gpointer             user_data)
5150 {
5151   GFileCreateFlags *data;
5152   GSimpleAsyncResult *res;
5153
5154   data = g_new0 (GFileCreateFlags, 1);
5155   *data = flags;
5156
5157   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
5158   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5159
5160   g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
5161   g_object_unref (res);
5162 }
5163
5164 static GFileOutputStream *
5165 g_file_real_append_to_finish (GFile         *file,
5166                               GAsyncResult  *res,
5167                               GError       **error)
5168 {
5169   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5170   gpointer op;
5171
5172   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
5173
5174   if (g_simple_async_result_propagate_error (simple, error))
5175     return NULL;
5176
5177   op = g_simple_async_result_get_op_res_gpointer (simple);
5178   if (op)
5179     return g_object_ref (op);
5180
5181   return NULL;
5182 }
5183
5184 static void
5185 create_async_thread (GSimpleAsyncResult *res,
5186                      GObject            *object,
5187                      GCancellable       *cancellable)
5188 {
5189   GFileIface *iface;
5190   GFileCreateFlags *data;
5191   GFileOutputStream *stream;
5192   GError *error = NULL;
5193
5194   iface = G_FILE_GET_IFACE (object);
5195
5196   data = g_simple_async_result_get_op_res_gpointer (res);
5197
5198   stream = iface->create (G_FILE (object), *data, cancellable, &error);
5199
5200   if (stream == NULL)
5201     g_simple_async_result_take_error (res, error);
5202   else
5203     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5204 }
5205
5206 static void
5207 g_file_real_create_async (GFile               *file,
5208                           GFileCreateFlags     flags,
5209                           int                  io_priority,
5210                           GCancellable        *cancellable,
5211                           GAsyncReadyCallback  callback,
5212                           gpointer             user_data)
5213 {
5214   GFileCreateFlags *data;
5215   GSimpleAsyncResult *res;
5216
5217   data = g_new0 (GFileCreateFlags, 1);
5218   *data = flags;
5219
5220   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
5221   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5222
5223   g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
5224   g_object_unref (res);
5225 }
5226
5227 static GFileOutputStream *
5228 g_file_real_create_finish (GFile         *file,
5229                            GAsyncResult  *res,
5230                            GError       **error)
5231 {
5232   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5233   gpointer op;
5234
5235   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
5236
5237   if (g_simple_async_result_propagate_error (simple, error))
5238     return NULL;
5239
5240   op = g_simple_async_result_get_op_res_gpointer (simple);
5241   if (op)
5242     return g_object_ref (op);
5243
5244   return NULL;
5245 }
5246
5247 typedef struct {
5248   GFileOutputStream *stream;
5249   char *etag;
5250   gboolean make_backup;
5251   GFileCreateFlags flags;
5252 } ReplaceAsyncData;
5253
5254 static void
5255 replace_async_data_free (ReplaceAsyncData *data)
5256 {
5257   if (data->stream)
5258     g_object_unref (data->stream);
5259   g_free (data->etag);
5260   g_free (data);
5261 }
5262
5263 static void
5264 replace_async_thread (GSimpleAsyncResult *res,
5265                       GObject            *object,
5266                       GCancellable       *cancellable)
5267 {
5268   GFileIface *iface;
5269   GFileOutputStream *stream;
5270   GError *error = NULL;
5271   ReplaceAsyncData *data;
5272
5273   iface = G_FILE_GET_IFACE (object);
5274
5275   data = g_simple_async_result_get_op_res_gpointer (res);
5276
5277   stream = iface->replace (G_FILE (object),
5278                            data->etag,
5279                            data->make_backup,
5280                            data->flags,
5281                            cancellable,
5282                            &error);
5283
5284   if (stream == NULL)
5285     g_simple_async_result_take_error (res, error);
5286   else
5287     data->stream = stream;
5288 }
5289
5290 static void
5291 g_file_real_replace_async (GFile               *file,
5292                            const char          *etag,
5293                            gboolean             make_backup,
5294                            GFileCreateFlags     flags,
5295                            int                  io_priority,
5296                            GCancellable        *cancellable,
5297                            GAsyncReadyCallback  callback,
5298                            gpointer             user_data)
5299 {
5300   GSimpleAsyncResult *res;
5301   ReplaceAsyncData *data;
5302
5303   data = g_new0 (ReplaceAsyncData, 1);
5304   data->etag = g_strdup (etag);
5305   data->make_backup = make_backup;
5306   data->flags = flags;
5307
5308   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
5309   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
5310
5311   g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
5312   g_object_unref (res);
5313 }
5314
5315 static GFileOutputStream *
5316 g_file_real_replace_finish (GFile         *file,
5317                             GAsyncResult  *res,
5318                             GError       **error)
5319 {
5320   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5321   ReplaceAsyncData *data;
5322
5323   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
5324
5325   if (g_simple_async_result_propagate_error (simple, error))
5326     return NULL;
5327
5328   data = g_simple_async_result_get_op_res_gpointer (simple);
5329   if (data->stream)
5330     return g_object_ref (data->stream);
5331
5332   return NULL;
5333 }
5334
5335 static void
5336 delete_async_thread (GSimpleAsyncResult *res,
5337                      GObject            *object,
5338                      GCancellable       *cancellable)
5339 {
5340   GFileIface *iface;
5341   GError *error = NULL;
5342
5343   iface = G_FILE_GET_IFACE (object);
5344
5345   if (!iface->delete_file (G_FILE (object),
5346                            cancellable,
5347                            &error))
5348     g_simple_async_result_take_error (res, error);
5349 }
5350
5351 static void
5352 g_file_real_delete_async (GFile               *file,
5353                           int                  io_priority,
5354                           GCancellable        *cancellable,
5355                           GAsyncReadyCallback  callback,
5356                           gpointer             user_data)
5357 {
5358   GSimpleAsyncResult *res;
5359
5360   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_delete_async);
5361   g_simple_async_result_run_in_thread (res, delete_async_thread, io_priority, cancellable);
5362   g_object_unref (res);
5363 }
5364
5365 static gboolean
5366 g_file_real_delete_finish (GFile         *file,
5367                            GAsyncResult  *res,
5368                            GError       **error)
5369 {
5370   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5371
5372   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_delete_async);
5373
5374   if (g_simple_async_result_propagate_error (simple, error))
5375     return FALSE;
5376
5377   return TRUE;
5378 }
5379
5380 static void
5381 open_readwrite_async_thread (GSimpleAsyncResult *res,
5382                              GObject            *object,
5383                              GCancellable       *cancellable)
5384 {
5385   GFileIface *iface;
5386   GFileIOStream *stream;
5387   GError *error = NULL;
5388
5389   iface = G_FILE_GET_IFACE (object);
5390
5391   if (iface->open_readwrite == NULL)
5392     {
5393       g_set_error_literal (&error, G_IO_ERROR,
5394                            G_IO_ERROR_NOT_SUPPORTED,
5395                            _("Operation not supported"));
5396
5397       g_simple_async_result_take_error (res, error);
5398
5399       return;
5400     }
5401
5402   stream = iface->open_readwrite (G_FILE (object), cancellable, &error);
5403
5404   if (stream == NULL)
5405     g_simple_async_result_take_error (res, error);
5406   else
5407     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5408 }
5409
5410 static void
5411 g_file_real_open_readwrite_async (GFile               *file,
5412                                   int                  io_priority,
5413                                   GCancellable        *cancellable,
5414                                   GAsyncReadyCallback  callback,
5415                                   gpointer             user_data)
5416 {
5417   GSimpleAsyncResult *res;
5418
5419   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_open_readwrite_async);
5420
5421   g_simple_async_result_run_in_thread (res, open_readwrite_async_thread, io_priority, cancellable);
5422   g_object_unref (res);
5423 }
5424
5425 static GFileIOStream *
5426 g_file_real_open_readwrite_finish (GFile         *file,
5427                                    GAsyncResult  *res,
5428                                    GError       **error)
5429 {
5430   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5431   gpointer op;
5432
5433   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_open_readwrite_async);
5434
5435   if (g_simple_async_result_propagate_error (simple, error))
5436     return NULL;
5437
5438   op = g_simple_async_result_get_op_res_gpointer (simple);
5439   if (op)
5440     return g_object_ref (op);
5441
5442   return NULL;
5443 }
5444
5445 static void
5446 create_readwrite_async_thread (GSimpleAsyncResult *res,
5447                                GObject            *object,
5448                                GCancellable       *cancellable)
5449 {
5450   GFileIface *iface;
5451   GFileCreateFlags *data;
5452   GFileIOStream *stream;
5453   GError *error = NULL;
5454
5455   iface = G_FILE_GET_IFACE (object);
5456
5457   data = g_simple_async_result_get_op_res_gpointer (res);
5458
5459   if (iface->create_readwrite == NULL)
5460     {
5461       g_set_error_literal (&error, G_IO_ERROR,
5462                            G_IO_ERROR_NOT_SUPPORTED,
5463                            _("Operation not supported"));
5464
5465       g_simple_async_result_take_error (res, error);
5466
5467       return;
5468     }
5469
5470   stream = iface->create_readwrite (G_FILE (object), *data, cancellable, &error);
5471
5472   if (stream == NULL)
5473     g_simple_async_result_take_error (res, error);
5474   else
5475     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5476 }
5477
5478 static void
5479 g_file_real_create_readwrite_async (GFile               *file,
5480                                     GFileCreateFlags     flags,
5481                                     int                  io_priority,
5482                                     GCancellable        *cancellable,
5483                                     GAsyncReadyCallback  callback,
5484                                     gpointer             user_data)
5485 {
5486   GFileCreateFlags *data;
5487   GSimpleAsyncResult *res;
5488
5489   data = g_new0 (GFileCreateFlags, 1);
5490   *data = flags;
5491
5492   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_readwrite_async);
5493   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5494
5495   g_simple_async_result_run_in_thread (res, create_readwrite_async_thread, io_priority, cancellable);
5496   g_object_unref (res);
5497 }
5498
5499 static GFileIOStream *
5500 g_file_real_create_readwrite_finish (GFile         *file,
5501                                      GAsyncResult  *res,
5502                                      GError       **error)
5503 {
5504   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5505   gpointer op;
5506
5507   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_readwrite_async);
5508
5509   if (g_simple_async_result_propagate_error (simple, error))
5510     return NULL;
5511
5512   op = g_simple_async_result_get_op_res_gpointer (simple);
5513   if (op)
5514     return g_object_ref (op);
5515
5516   return NULL;
5517 }
5518
5519 typedef struct {
5520   GFileIOStream *stream;
5521   char *etag;
5522   gboolean make_backup;
5523   GFileCreateFlags flags;
5524 } ReplaceRWAsyncData;
5525
5526 static void
5527 replace_rw_async_data_free (ReplaceRWAsyncData *data)
5528 {
5529   if (data->stream)
5530     g_object_unref (data->stream);
5531   g_free (data->etag);
5532   g_free (data);
5533 }
5534
5535 static void
5536 replace_readwrite_async_thread (GSimpleAsyncResult *res,
5537                                 GObject            *object,
5538                                 GCancellable       *cancellable)
5539 {
5540   GFileIface *iface;
5541   GFileIOStream *stream;
5542   GError *error = NULL;
5543   ReplaceRWAsyncData *data;
5544
5545   iface = G_FILE_GET_IFACE (object);
5546
5547   data = g_simple_async_result_get_op_res_gpointer (res);
5548
5549   stream = iface->replace_readwrite (G_FILE (object),
5550                                      data->etag,
5551                                      data->make_backup,
5552                                      data->flags,
5553                                      cancellable,
5554                                      &error);
5555
5556   if (stream == NULL)
5557     g_simple_async_result_take_error (res, error);
5558   else
5559     data->stream = stream;
5560 }
5561
5562 static void
5563 g_file_real_replace_readwrite_async (GFile               *file,
5564                                      const char          *etag,
5565                                      gboolean             make_backup,
5566                                      GFileCreateFlags     flags,
5567                                      int                  io_priority,
5568                                      GCancellable        *cancellable,
5569                                      GAsyncReadyCallback  callback,
5570                                      gpointer             user_data)
5571 {
5572   GSimpleAsyncResult *res;
5573   ReplaceRWAsyncData *data;
5574
5575   data = g_new0 (ReplaceRWAsyncData, 1);
5576   data->etag = g_strdup (etag);
5577   data->make_backup = make_backup;
5578   data->flags = flags;
5579
5580   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_readwrite_async);
5581   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_rw_async_data_free);
5582
5583   g_simple_async_result_run_in_thread (res, replace_readwrite_async_thread, io_priority, cancellable);
5584   g_object_unref (res);
5585 }
5586
5587 static GFileIOStream *
5588 g_file_real_replace_readwrite_finish (GFile         *file,
5589                                       GAsyncResult  *res,
5590                                       GError       **error)
5591 {
5592   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5593   ReplaceRWAsyncData *data;
5594
5595   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_readwrite_async);
5596
5597   if (g_simple_async_result_propagate_error (simple, error))
5598     return NULL;
5599
5600   data = g_simple_async_result_get_op_res_gpointer (simple);
5601   if (data->stream)
5602     return g_object_ref (data->stream);
5603
5604   return NULL;
5605 }
5606
5607 typedef struct {
5608   char *name;
5609   GFile *file;
5610 } SetDisplayNameAsyncData;
5611
5612 static void
5613 set_display_name_data_free (SetDisplayNameAsyncData *data)
5614 {
5615   g_free (data->name);
5616   if (data->file)
5617     g_object_unref (data->file);
5618   g_free (data);
5619 }
5620
5621 static void
5622 set_display_name_async_thread (GSimpleAsyncResult *res,
5623                                GObject            *object,
5624                                GCancellable       *cancellable)
5625 {
5626   GError *error = NULL;
5627   SetDisplayNameAsyncData *data;
5628   GFile *file;
5629
5630   data = g_simple_async_result_get_op_res_gpointer (res);
5631
5632   file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
5633
5634   if (file == NULL)
5635     g_simple_async_result_take_error (res, error);
5636   else
5637     data->file = file;
5638 }
5639
5640 static void
5641 g_file_real_set_display_name_async (GFile               *file,
5642                                     const char          *display_name,
5643                                     int                  io_priority,
5644                                     GCancellable        *cancellable,
5645                                     GAsyncReadyCallback  callback,
5646                                     gpointer             user_data)
5647 {
5648   GSimpleAsyncResult *res;
5649   SetDisplayNameAsyncData *data;
5650
5651   data = g_new0 (SetDisplayNameAsyncData, 1);
5652   data->name = g_strdup (display_name);
5653
5654   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
5655   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
5656
5657   g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
5658   g_object_unref (res);
5659 }
5660
5661 static GFile *
5662 g_file_real_set_display_name_finish (GFile         *file,
5663                                      GAsyncResult  *res,
5664                                      GError       **error)
5665 {
5666   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5667   SetDisplayNameAsyncData *data;
5668
5669   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
5670
5671   if (g_simple_async_result_propagate_error (simple, error))
5672     return NULL;
5673
5674   data = g_simple_async_result_get_op_res_gpointer (simple);
5675   if (data->file)
5676     return g_object_ref (data->file);
5677
5678   return NULL;
5679 }
5680
5681 typedef struct {
5682   GFileQueryInfoFlags flags;
5683   GFileInfo *info;
5684   gboolean res;
5685   GError *error;
5686 } SetInfoAsyncData;
5687
5688 static void
5689 set_info_data_free (SetInfoAsyncData *data)
5690 {
5691   if (data->info)
5692     g_object_unref (data->info);
5693   if (data->error)
5694     g_error_free (data->error);
5695   g_free (data);
5696 }
5697
5698 static void
5699 set_info_async_thread (GSimpleAsyncResult *res,
5700                        GObject            *object,
5701                        GCancellable       *cancellable)
5702 {
5703   SetInfoAsyncData *data;
5704
5705   data = g_simple_async_result_get_op_res_gpointer (res);
5706
5707   data->error = NULL;
5708   data->res = g_file_set_attributes_from_info (G_FILE (object),
5709                                                data->info,
5710                                                data->flags,
5711                                                cancellable,
5712                                                &data->error);
5713 }
5714
5715 static void
5716 g_file_real_set_attributes_async (GFile               *file,
5717                                   GFileInfo           *info,
5718                                   GFileQueryInfoFlags  flags,
5719                                   int                  io_priority,
5720                                   GCancellable        *cancellable,
5721                                   GAsyncReadyCallback  callback,
5722                                   gpointer             user_data)
5723 {
5724   GSimpleAsyncResult *res;
5725   SetInfoAsyncData *data;
5726
5727   data = g_new0 (SetInfoAsyncData, 1);
5728   data->info = g_file_info_dup (info);
5729   data->flags = flags;
5730
5731   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
5732   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
5733
5734   g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
5735   g_object_unref (res);
5736 }
5737
5738 static gboolean
5739 g_file_real_set_attributes_finish (GFile         *file,
5740                                    GAsyncResult  *res,
5741                                    GFileInfo    **info,
5742                                    GError       **error)
5743 {
5744   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5745   SetInfoAsyncData *data;
5746
5747   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
5748
5749   data = g_simple_async_result_get_op_res_gpointer (simple);
5750
5751   if (info)
5752     *info = g_object_ref (data->info);
5753
5754   if (error != NULL && data->error)
5755     *error = g_error_copy (data->error);
5756
5757   return data->res;
5758 }
5759
5760 static void
5761 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
5762                                     GObject            *object,
5763                                     GCancellable       *cancellable)
5764 {
5765   GError *error = NULL;
5766   GMount *mount;
5767
5768   mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
5769
5770   if (mount == NULL)
5771     g_simple_async_result_take_error (res, error);
5772   else
5773     g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
5774 }
5775
5776 static void
5777 g_file_real_find_enclosing_mount_async (GFile               *file,
5778                                         int                  io_priority,
5779                                         GCancellable        *cancellable,
5780                                         GAsyncReadyCallback  callback,
5781                                         gpointer             user_data)
5782 {
5783   GSimpleAsyncResult *res;
5784
5785   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
5786
5787   g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
5788   g_object_unref (res);
5789 }
5790
5791 static GMount *
5792 g_file_real_find_enclosing_mount_finish (GFile         *file,
5793                                           GAsyncResult  *res,
5794                                           GError       **error)
5795 {
5796   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5797   GMount *mount;
5798
5799   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
5800
5801   if (g_simple_async_result_propagate_error (simple, error))
5802     return NULL;
5803
5804   mount = g_simple_async_result_get_op_res_gpointer (simple);
5805   return g_object_ref (mount);
5806 }
5807
5808
5809 typedef struct {
5810   GFile *source;
5811   GFile *destination;
5812   GFileCopyFlags flags;
5813   GFileProgressCallback progress_cb;
5814   gpointer progress_cb_data;
5815   GIOSchedulerJob *job;
5816 } CopyAsyncData;
5817
5818 static void
5819 copy_async_data_free (CopyAsyncData *data)
5820 {
5821   g_object_unref (data->source);
5822   g_object_unref (data->destination);
5823   g_free (data);
5824 }
5825
5826 typedef struct {
5827   CopyAsyncData *data;
5828   goffset current_num_bytes;
5829   goffset total_num_bytes;
5830 } ProgressData;
5831
5832 static gboolean
5833 copy_async_progress_in_main (gpointer user_data)
5834 {
5835   ProgressData *progress = user_data;
5836   CopyAsyncData *data = progress->data;
5837
5838   data->progress_cb (progress->current_num_bytes,
5839                      progress->total_num_bytes,
5840                      data->progress_cb_data);
5841
5842   return FALSE;
5843 }
5844
5845 static void
5846 copy_async_progress_callback (goffset  current_num_bytes,
5847                               goffset  total_num_bytes,
5848                               gpointer user_data)
5849 {
5850   CopyAsyncData *data = user_data;
5851   ProgressData *progress;
5852
5853   progress = g_new (ProgressData, 1);
5854   progress->data = data;
5855   progress->current_num_bytes = current_num_bytes;
5856   progress->total_num_bytes = total_num_bytes;
5857
5858   g_io_scheduler_job_send_to_mainloop_async (data->job,
5859                                              copy_async_progress_in_main,
5860                                              progress,
5861                                              g_free);
5862 }
5863
5864 static gboolean
5865 copy_async_thread (GIOSchedulerJob *job,
5866                    GCancellable    *cancellable,
5867                    gpointer         user_data)
5868 {
5869   GSimpleAsyncResult *res;
5870   CopyAsyncData *data;
5871   gboolean result;
5872   GError *error;
5873
5874   res = user_data;
5875   data = g_simple_async_result_get_op_res_gpointer (res);
5876
5877   error = NULL;
5878   data->job = job;
5879   result = g_file_copy (data->source,
5880                         data->destination,
5881                         data->flags,
5882                         cancellable,
5883                         (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
5884                         data,
5885                         &error);
5886
5887   if (!result)
5888     g_simple_async_result_take_error (res, error);
5889
5890   g_simple_async_result_complete_in_idle (res);
5891
5892   return FALSE;
5893 }
5894
5895 static void
5896 g_file_real_copy_async (GFile                  *source,
5897                         GFile                  *destination,
5898                         GFileCopyFlags          flags,
5899                         int                     io_priority,
5900                         GCancellable           *cancellable,
5901                         GFileProgressCallback   progress_callback,
5902                         gpointer                progress_callback_data,
5903                         GAsyncReadyCallback     callback,
5904                         gpointer                user_data)
5905 {
5906   GSimpleAsyncResult *res;
5907   CopyAsyncData *data;
5908
5909   data = g_new0 (CopyAsyncData, 1);
5910   data->source = g_object_ref (source);
5911   data->destination = g_object_ref (destination);
5912   data->flags = flags;
5913   data->progress_cb = progress_callback;
5914   data->progress_cb_data = progress_callback_data;
5915
5916   res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
5917   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
5918
5919   g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
5920 }
5921
5922 static gboolean
5923 g_file_real_copy_finish (GFile        *file,
5924                          GAsyncResult *res,
5925                          GError      **error)
5926 {
5927   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5928
5929   if (g_simple_async_result_propagate_error (simple, error))
5930     return FALSE;
5931
5932   return TRUE;
5933 }
5934
5935
5936 /********************************************
5937  *   Default VFS operations                 *
5938  ********************************************/
5939
5940 /**
5941  * g_file_new_for_path:
5942  * @path: a string containing a relative or absolute path. The string
5943  *   must be encoded in the glib filename encoding.
5944  *
5945  * Constructs a #GFile for a given path. This operation never
5946  * fails, but the returned object might not support any I/O
5947  * operation if @path is malformed.
5948  *
5949  * Returns: (transfer full): a new #GFile for the given @path.
5950  *   Free the returned object with g_object_unref().
5951  **/
5952 GFile *
5953 g_file_new_for_path (const char *path)
5954 {
5955   g_return_val_if_fail (path != NULL, NULL);
5956
5957   return g_vfs_get_file_for_path (g_vfs_get_default (), path);
5958 }
5959
5960 /**
5961  * g_file_new_for_uri:
5962  * @uri: a UTF8 string containing a URI.
5963  *
5964  * Constructs a #GFile for a given URI. This operation never
5965  * fails, but the returned object might not support any I/O
5966  * operation if @uri is malformed or if the uri type is
5967  * not supported.
5968  *
5969  * Returns: (transfer full): a new #GFile for the given @uri.
5970  *   Free the returned object with g_object_unref().
5971  **/
5972 GFile *
5973 g_file_new_for_uri (const char *uri)
5974 {
5975   g_return_val_if_fail (uri != NULL, NULL);
5976
5977   return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
5978 }
5979
5980 /**
5981  * g_file_new_tmp:
5982  * @tmpl: (type filename) (allow-none): Template for the file
5983  *   name, as in g_file_open_tmp(), or %NULL for a default template.
5984  * @iostream: (out): on return, a #GFileIOStream for the created file.
5985  * @error: a #GError, or %NULL
5986  *
5987  * Opens a file in the preferred directory for temporary files (as
5988  * returned by g_get_tmp_dir()) and returns a #GFile and
5989  * #GFileIOStream pointing to it.
5990  *
5991  * @tmpl should be a string in the GLib file name encoding
5992  * containing a sequence of six 'X' characters, and containing no
5993  * directory components. If it is %NULL, a default template is used.
5994  *
5995  * Unlike the other #GFile constructors, this will return %NULL if
5996  * a temporary file could not be created.
5997  *
5998  * Returns: (transfer full): a new #GFile.
5999  *   Free the returned object with g_object_unref().
6000  *
6001  * Since: 2.32
6002  */
6003 GFile *
6004 g_file_new_tmp (const char     *tmpl,
6005                 GFileIOStream **iostream,
6006                 GError        **error)
6007 {
6008   gint fd;
6009   gchar *path;
6010   GFile *file;
6011   GFileOutputStream *output;
6012
6013   g_return_val_if_fail (iostream != NULL, NULL);
6014
6015   fd = g_file_open_tmp (tmpl, &path, error);
6016   if (fd == -1)
6017     return NULL;
6018
6019   file = g_file_new_for_path (path);
6020
6021   output = _g_local_file_output_stream_new (fd);
6022   *iostream = _g_local_file_io_stream_new (G_LOCAL_FILE_OUTPUT_STREAM (output));
6023
6024   g_object_unref (output);
6025   g_free (path);
6026
6027   return file;
6028 }
6029
6030 /**
6031  * g_file_parse_name:
6032  * @parse_name: a file name or path to be parsed.
6033  *
6034  * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
6035  * This operation never fails, but the returned object might not support any I/O
6036  * operation if the @parse_name cannot be parsed.
6037  *
6038  * Returns: (transfer full): a new #GFile.
6039  **/
6040 GFile *
6041 g_file_parse_name (const char *parse_name)
6042 {
6043   g_return_val_if_fail (parse_name != NULL, NULL);
6044
6045   return g_vfs_parse_name (g_vfs_get_default (), parse_name);
6046 }
6047
6048 static gboolean
6049 is_valid_scheme_character (char c)
6050 {
6051   return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
6052 }
6053
6054 /* Following RFC 2396, valid schemes are built like:
6055  *       scheme        = alpha *( alpha | digit | "+" | "-" | "." )
6056  */
6057 static gboolean
6058 has_valid_scheme (const char *uri)
6059 {
6060   const char *p;
6061
6062   p = uri;
6063
6064   if (!g_ascii_isalpha (*p))
6065     return FALSE;
6066
6067   do {
6068     p++;
6069   } while (is_valid_scheme_character (*p));
6070
6071   return *p == ':';
6072 }
6073
6074 /**
6075  * g_file_new_for_commandline_arg:
6076  * @arg: a command line string.
6077  *
6078  * Creates a #GFile with the given argument from the command line. The value of
6079  * @arg can be either a URI, an absolute path or a relative path resolved
6080  * relative to the current working directory.
6081  * This operation never fails, but the returned object might not support any
6082  * I/O operation if @arg points to a malformed path.
6083  *
6084  * Returns: (transfer full): a new #GFile.
6085  *  Free the returned object with g_object_unref().
6086  **/
6087 GFile *
6088 g_file_new_for_commandline_arg (const char *arg)
6089 {
6090   GFile *file;
6091   char *filename;
6092   char *current_dir;
6093
6094   g_return_val_if_fail (arg != NULL, NULL);
6095
6096   if (g_path_is_absolute (arg))
6097     return g_file_new_for_path (arg);
6098
6099   if (has_valid_scheme (arg))
6100     return g_file_new_for_uri (arg);
6101
6102   current_dir = g_get_current_dir ();
6103   filename = g_build_filename (current_dir, arg, NULL);
6104   g_free (current_dir);
6105
6106   file = g_file_new_for_path (filename);
6107   g_free (filename);
6108
6109   return file;
6110 }
6111
6112 /**
6113  * g_file_mount_enclosing_volume:
6114  * @location: input #GFile.
6115  * @flags: flags affecting the operation
6116  * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
6117  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6118  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
6119  * @user_data: the data to pass to callback function
6120  *
6121  * Starts a @mount_operation, mounting the volume that contains the file @location.
6122  *
6123  * When this operation has completed, @callback will be called with
6124  * @user_user data, and the operation can be finalized with
6125  * g_file_mount_enclosing_volume_finish().
6126  *
6127  * If @cancellable is not %NULL, then the operation can be cancelled by
6128  * triggering the cancellable object from another thread. If the operation
6129  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6130  **/
6131 void
6132 g_file_mount_enclosing_volume (GFile               *location,
6133                                GMountMountFlags     flags,
6134                                GMountOperation     *mount_operation,
6135                                GCancellable        *cancellable,
6136                                GAsyncReadyCallback  callback,
6137                                gpointer             user_data)
6138 {
6139   GFileIface *iface;
6140
6141   g_return_if_fail (G_IS_FILE (location));
6142
6143   iface = G_FILE_GET_IFACE (location);
6144
6145   if (iface->mount_enclosing_volume == NULL)
6146     {
6147       g_simple_async_report_error_in_idle (G_OBJECT (location),
6148                                            callback, user_data,
6149                                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
6150                                            _("volume doesn't implement mount"));
6151
6152       return;
6153     }
6154
6155   (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6156
6157 }
6158
6159 /**
6160  * g_file_mount_enclosing_volume_finish:
6161  * @location: input #GFile.
6162  * @result: a #GAsyncResult.
6163  * @error: a #GError, or %NULL
6164  *
6165  * Finishes a mount operation started by g_file_mount_enclosing_volume().
6166  *
6167  * Returns: %TRUE if successful. If an error
6168  * has occurred, this function will return %FALSE and set @error
6169  * appropriately if present.
6170  **/
6171 gboolean
6172 g_file_mount_enclosing_volume_finish (GFile         *location,
6173                                       GAsyncResult  *result,
6174                                       GError       **error)
6175 {
6176   GFileIface *iface;
6177
6178   g_return_val_if_fail (G_IS_FILE (location), FALSE);
6179   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6180
6181   if (g_async_result_legacy_propagate_error (result, error))
6182     return FALSE;
6183
6184   iface = G_FILE_GET_IFACE (location);
6185
6186   return (* iface->mount_enclosing_volume_finish) (location, result, error);
6187 }
6188
6189 /********************************************
6190  *   Utility functions                      *
6191  ********************************************/
6192
6193 /**
6194  * g_file_query_default_handler:
6195  * @file: a #GFile to open.
6196  * @cancellable: optional #GCancellable object, %NULL to ignore.
6197  * @error: a #GError, or %NULL
6198  *
6199  * Returns the #GAppInfo that is registered as the default
6200  * application to handle the file specified by @file.
6201  *
6202  * If @cancellable is not %NULL, then the operation can be cancelled by
6203  * triggering the cancellable object from another thread. If the operation
6204  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6205  *
6206  * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors.
6207  * When you are done with it, release it with g_object_unref()
6208  **/
6209 GAppInfo *
6210 g_file_query_default_handler (GFile                  *file,
6211                               GCancellable           *cancellable,
6212                               GError                **error)
6213 {
6214   char *uri_scheme;
6215   const char *content_type;
6216   GAppInfo *appinfo;
6217   GFileInfo *info;
6218   char *path;
6219
6220   uri_scheme = g_file_get_uri_scheme (file);
6221   if (uri_scheme && uri_scheme[0] != '\0')
6222     {
6223       appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
6224       g_free (uri_scheme);
6225
6226       if (appinfo != NULL)
6227         return appinfo;
6228     }
6229
6230   info = g_file_query_info (file,
6231                             G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6232                             0,
6233                             cancellable,
6234                             error);
6235   if (info == NULL)
6236     return NULL;
6237
6238   appinfo = NULL;
6239
6240   content_type = g_file_info_get_content_type (info);
6241   if (content_type)
6242     {
6243       /* Don't use is_native(), as we want to support fuse paths if available */
6244       path = g_file_get_path (file);
6245       appinfo = g_app_info_get_default_for_type (content_type,
6246                                                  path == NULL);
6247       g_free (path);
6248     }
6249
6250   g_object_unref (info);
6251
6252   if (appinfo != NULL)
6253     return appinfo;
6254
6255   g_set_error_literal (error, G_IO_ERROR,
6256                        G_IO_ERROR_NOT_SUPPORTED,
6257                        _("No application is registered as handling this file"));
6258   return NULL;
6259
6260 }
6261
6262
6263 #define GET_CONTENT_BLOCK_SIZE 8192
6264
6265 /**
6266  * g_file_load_contents:
6267  * @file: input #GFile.
6268  * @cancellable: optional #GCancellable object, %NULL to ignore.
6269  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6270  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6271  *    or %NULL if the length is not needed
6272  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6273  *    or %NULL if the entity tag is not needed
6274  * @error: a #GError, or %NULL
6275  *
6276  * Loads the content of the file into memory. The data is always
6277  * zero-terminated, but this is not included in the resultant @length.
6278  * The returned @content should be freed with g_free() when no longer
6279  * needed.
6280  *
6281  * If @cancellable is not %NULL, then the operation can be cancelled by
6282  * triggering the cancellable object from another thread. If the operation
6283  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6284  *
6285  * Returns: %TRUE if the @file's contents were successfully loaded.
6286  * %FALSE if there were errors.
6287  **/
6288 gboolean
6289 g_file_load_contents (GFile         *file,
6290                       GCancellable  *cancellable,
6291                       char         **contents,
6292                       gsize         *length,
6293                       char         **etag_out,
6294                       GError       **error)
6295 {
6296   GFileInputStream *in;
6297   GByteArray *content;
6298   gsize pos;
6299   gssize res;
6300   GFileInfo *info;
6301
6302   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6303   g_return_val_if_fail (contents != NULL, FALSE);
6304
6305   in = g_file_read (file, cancellable, error);
6306   if (in == NULL)
6307     return FALSE;
6308
6309   content = g_byte_array_new ();
6310   pos = 0;
6311
6312   g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6313   while ((res = g_input_stream_read (G_INPUT_STREAM (in),
6314                                      content->data + pos,
6315                                      GET_CONTENT_BLOCK_SIZE,
6316                                      cancellable, error)) > 0)
6317     {
6318       pos += res;
6319       g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6320     }
6321
6322   if (etag_out)
6323     {
6324       *etag_out = NULL;
6325
6326       info = g_file_input_stream_query_info (in,
6327                                              G_FILE_ATTRIBUTE_ETAG_VALUE,
6328                                              cancellable,
6329                                              NULL);
6330       if (info)
6331         {
6332           *etag_out = g_strdup (g_file_info_get_etag (info));
6333           g_object_unref (info);
6334         }
6335     }
6336
6337   /* Ignore errors on close */
6338   g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
6339   g_object_unref (in);
6340
6341   if (res < 0)
6342     {
6343       /* error is set already */
6344       g_byte_array_free (content, TRUE);
6345       return FALSE;
6346     }
6347
6348   if (length)
6349     *length = pos;
6350
6351   /* Zero terminate (we got an extra byte allocated for this */
6352   content->data[pos] = 0;
6353
6354   *contents = (char *)g_byte_array_free (content, FALSE);
6355
6356   return TRUE;
6357 }
6358
6359 typedef struct {
6360   GFile *file;
6361   GError *error;
6362   GCancellable *cancellable;
6363   GFileReadMoreCallback read_more_callback;
6364   GAsyncReadyCallback callback;
6365   gpointer user_data;
6366   GByteArray *content;
6367   gsize pos;
6368   char *etag;
6369 } LoadContentsData;
6370
6371
6372 static void
6373 load_contents_data_free (LoadContentsData *data)
6374 {
6375   if (data->error)
6376     g_error_free (data->error);
6377   if (data->cancellable)
6378     g_object_unref (data->cancellable);
6379   if (data->content)
6380     g_byte_array_free (data->content, TRUE);
6381   g_free (data->etag);
6382   g_object_unref (data->file);
6383   g_free (data);
6384 }
6385
6386 static void
6387 load_contents_close_callback (GObject      *obj,
6388                               GAsyncResult *close_res,
6389                               gpointer      user_data)
6390 {
6391   GInputStream *stream = G_INPUT_STREAM (obj);
6392   LoadContentsData *data = user_data;
6393   GSimpleAsyncResult *res;
6394
6395   /* Ignore errors here, we're only reading anyway */
6396   g_input_stream_close_finish (stream, close_res, NULL);
6397   g_object_unref (stream);
6398
6399   res = g_simple_async_result_new (G_OBJECT (data->file),
6400                                    data->callback,
6401                                    data->user_data,
6402                                    g_file_load_contents_async);
6403   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
6404   g_simple_async_result_complete (res);
6405   g_object_unref (res);
6406 }
6407
6408 static void
6409 load_contents_fstat_callback (GObject      *obj,
6410                               GAsyncResult *stat_res,
6411                               gpointer      user_data)
6412 {
6413   GInputStream *stream = G_INPUT_STREAM (obj);
6414   LoadContentsData *data = user_data;
6415   GFileInfo *info;
6416
6417   info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
6418                                                    stat_res, NULL);
6419   if (info)
6420     {
6421       data->etag = g_strdup (g_file_info_get_etag (info));
6422       g_object_unref (info);
6423     }
6424
6425   g_input_stream_close_async (stream, 0,
6426                               data->cancellable,
6427                               load_contents_close_callback, data);
6428 }
6429
6430 static void
6431 load_contents_read_callback (GObject      *obj,
6432                              GAsyncResult *read_res,
6433                              gpointer      user_data)
6434 {
6435   GInputStream *stream = G_INPUT_STREAM (obj);
6436   LoadContentsData *data = user_data;
6437   GError *error = NULL;
6438   gssize read_size;
6439
6440   read_size = g_input_stream_read_finish (stream, read_res, &error);
6441
6442   if (read_size < 0)
6443     {
6444       /* Error or EOF, close the file */
6445       data->error = error;
6446       g_input_stream_close_async (stream, 0,
6447                                   data->cancellable,
6448                                   load_contents_close_callback, data);
6449     }
6450   else if (read_size == 0)
6451     {
6452       g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6453                                             G_FILE_ATTRIBUTE_ETAG_VALUE,
6454                                             0,
6455                                             data->cancellable,
6456                                             load_contents_fstat_callback,
6457                                             data);
6458     }
6459   else if (read_size > 0)
6460     {
6461       data->pos += read_size;
6462
6463       g_byte_array_set_size (data->content,
6464                              data->pos + GET_CONTENT_BLOCK_SIZE);
6465
6466
6467       if (data->read_more_callback &&
6468           !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
6469         g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6470                                               G_FILE_ATTRIBUTE_ETAG_VALUE,
6471                                               0,
6472                                               data->cancellable,
6473                                               load_contents_fstat_callback,
6474                                               data);
6475       else
6476         g_input_stream_read_async (stream,
6477                                    data->content->data + data->pos,
6478                                    GET_CONTENT_BLOCK_SIZE,
6479                                    0,
6480                                    data->cancellable,
6481                                    load_contents_read_callback,
6482                                    data);
6483     }
6484 }
6485
6486 static void
6487 load_contents_open_callback (GObject      *obj,
6488                              GAsyncResult *open_res,
6489                              gpointer      user_data)
6490 {
6491   GFile *file = G_FILE (obj);
6492   GFileInputStream *stream;
6493   LoadContentsData *data = user_data;
6494   GError *error = NULL;
6495   GSimpleAsyncResult *res;
6496
6497   stream = g_file_read_finish (file, open_res, &error);
6498
6499   if (stream)
6500     {
6501       g_byte_array_set_size (data->content,
6502                              data->pos + GET_CONTENT_BLOCK_SIZE);
6503       g_input_stream_read_async (G_INPUT_STREAM (stream),
6504                                  data->content->data + data->pos,
6505                                  GET_CONTENT_BLOCK_SIZE,
6506                                  0,
6507                                  data->cancellable,
6508                                  load_contents_read_callback,
6509                                  data);
6510
6511     }
6512   else
6513     {
6514       res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6515                                                   data->callback,
6516                                                   data->user_data,
6517                                                   error);
6518       g_simple_async_result_complete (res);
6519       load_contents_data_free (data);
6520       g_object_unref (res);
6521     }
6522 }
6523
6524 /**
6525  * g_file_load_partial_contents_async: (skip)
6526  * @file: input #GFile.
6527  * @cancellable: optional #GCancellable object, %NULL to ignore.
6528  * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
6529  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6530  * @user_data: the data to pass to the callback functions.
6531  *
6532  * Reads the partial contents of a file. A #GFileReadMoreCallback should be
6533  * used to stop reading from the file when appropriate, else this function
6534  * will behave exactly as g_file_load_contents_async(). This operation
6535  * can be finished by g_file_load_partial_contents_finish().
6536  *
6537  * Users of this function should be aware that @user_data is passed to
6538  * both the @read_more_callback and the @callback.
6539  *
6540  * If @cancellable is not %NULL, then the operation can be cancelled by
6541  * triggering the cancellable object from another thread. If the operation
6542  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6543  **/
6544 void
6545 g_file_load_partial_contents_async (GFile                 *file,
6546                                     GCancellable          *cancellable,
6547                                     GFileReadMoreCallback  read_more_callback,
6548                                     GAsyncReadyCallback    callback,
6549                                     gpointer               user_data)
6550 {
6551   LoadContentsData *data;
6552
6553   g_return_if_fail (G_IS_FILE (file));
6554
6555   data = g_new0 (LoadContentsData, 1);
6556
6557   if (cancellable)
6558     data->cancellable = g_object_ref (cancellable);
6559   data->read_more_callback = read_more_callback;
6560   data->callback = callback;
6561   data->user_data = user_data;
6562   data->content = g_byte_array_new ();
6563   data->file = g_object_ref (file);
6564
6565   g_file_read_async (file,
6566                      0,
6567                      cancellable,
6568                      load_contents_open_callback,
6569                      data);
6570 }
6571
6572 /**
6573  * g_file_load_partial_contents_finish:
6574  * @file: input #GFile.
6575  * @res: a #GAsyncResult.
6576  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6577  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6578  *     or %NULL if the length is not needed
6579  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6580  *     or %NULL if the entity tag is not needed
6581  * @error: a #GError, or %NULL
6582  *
6583  * Finishes an asynchronous partial load operation that was started
6584  * with g_file_load_partial_contents_async(). The data is always
6585  * zero-terminated, but this is not included in the resultant @length.
6586  * The returned @content should be freed with g_free() when no longer
6587  * needed.
6588  *
6589  * Returns: %TRUE if the load was successful. If %FALSE and @error is
6590  * present, it will be set appropriately.
6591  **/
6592 gboolean
6593 g_file_load_partial_contents_finish (GFile         *file,
6594                                      GAsyncResult  *res,
6595                                      char         **contents,
6596                                      gsize         *length,
6597                                      char         **etag_out,
6598                                      GError       **error)
6599 {
6600   GSimpleAsyncResult *simple;
6601   LoadContentsData *data;
6602
6603   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6604   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
6605   g_return_val_if_fail (contents != NULL, FALSE);
6606
6607   simple = G_SIMPLE_ASYNC_RESULT (res);
6608
6609   if (g_simple_async_result_propagate_error (simple, error))
6610     return FALSE;
6611
6612   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
6613
6614   data = g_simple_async_result_get_op_res_gpointer (simple);
6615
6616   if (data->error)
6617     {
6618       g_propagate_error (error, data->error);
6619       data->error = NULL;
6620       *contents = NULL;
6621       if (length)
6622         *length = 0;
6623       return FALSE;
6624     }
6625
6626   if (length)
6627     *length = data->pos;
6628
6629   if (etag_out)
6630     {
6631       *etag_out = data->etag;
6632       data->etag = NULL;
6633     }
6634
6635   /* Zero terminate */
6636   g_byte_array_set_size (data->content, data->pos + 1);
6637   data->content->data[data->pos] = 0;
6638
6639   *contents = (char *)g_byte_array_free (data->content, FALSE);
6640   data->content = NULL;
6641
6642   return TRUE;
6643 }
6644
6645 /**
6646  * g_file_load_contents_async:
6647  * @file: input #GFile.
6648  * @cancellable: optional #GCancellable object, %NULL to ignore.
6649  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6650  * @user_data: the data to pass to callback function
6651  *
6652  * Starts an asynchronous load of the @file's contents.
6653  *
6654  * For more details, see g_file_load_contents() which is
6655  * the synchronous version of this call.
6656  *
6657  * When the load operation has completed, @callback will be called
6658  * with @user data. To finish the operation, call
6659  * g_file_load_contents_finish() with the #GAsyncResult returned by
6660  * the @callback.
6661  *
6662  * If @cancellable is not %NULL, then the operation can be cancelled by
6663  * triggering the cancellable object from another thread. If the operation
6664  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6665  **/
6666 void
6667 g_file_load_contents_async (GFile               *file,
6668                            GCancellable        *cancellable,
6669                            GAsyncReadyCallback  callback,
6670                            gpointer             user_data)
6671 {
6672   g_file_load_partial_contents_async (file,
6673                                       cancellable,
6674                                       NULL,
6675                                       callback, user_data);
6676 }
6677
6678 /**
6679  * g_file_load_contents_finish:
6680  * @file: input #GFile.
6681  * @res: a #GAsyncResult.
6682  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6683  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6684  *     or %NULL if the length is not needed
6685  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6686  *     or %NULL if the entity tag is not needed
6687  * @error: a #GError, or %NULL
6688  *
6689  * Finishes an asynchronous load of the @file's contents.
6690  * The contents are placed in @contents, and @length is set to the
6691  * size of the @contents string. The @content should be freed with
6692  * g_free() when no longer needed. If @etag_out is present, it will be
6693  * set to the new entity tag for the @file.
6694  *
6695  * Returns: %TRUE if the load was successful. If %FALSE and @error is
6696  * present, it will be set appropriately.
6697  **/
6698 gboolean
6699 g_file_load_contents_finish (GFile         *file,
6700                              GAsyncResult  *res,
6701                              char         **contents,
6702                              gsize         *length,
6703                              char         **etag_out,
6704                              GError       **error)
6705 {
6706   return g_file_load_partial_contents_finish (file,
6707                                               res,
6708                                               contents,
6709                                               length,
6710                                               etag_out,
6711                                               error);
6712 }
6713
6714 /**
6715  * g_file_replace_contents:
6716  * @file: input #GFile.
6717  * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file.
6718  * @length: the length of @contents in bytes.
6719  * @etag: (allow-none): the old <link linkend="gfile-etag">entity tag</link>
6720  *     for the document, or %NULL
6721  * @make_backup: %TRUE if a backup should be created.
6722  * @flags: a set of #GFileCreateFlags.
6723  * @new_etag: (allow-none) (out): a location to a new <link linkend="gfile-etag">entity tag</link>
6724  *      for the document. This should be freed with g_free() when no longer
6725  *      needed, or %NULL
6726  * @cancellable: optional #GCancellable object, %NULL to ignore.
6727  * @error: a #GError, or %NULL
6728  *
6729  * Replaces the contents of @file with @contents of @length bytes.
6730
6731  * If @etag is specified (not %NULL) any existing file must have that etag, or
6732  * the error %G_IO_ERROR_WRONG_ETAG will be returned.
6733  *
6734  * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
6735  *
6736  * If @cancellable is not %NULL, then the operation can be cancelled by
6737  * triggering the cancellable object from another thread. If the operation
6738  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6739  *
6740  * The returned @new_etag can be used to verify that the file hasn't changed the
6741  * next time it is saved over.
6742  *
6743  * Returns: %TRUE if successful. If an error
6744  * has occurred, this function will return %FALSE and set @error
6745  * appropriately if present.
6746  **/
6747 gboolean
6748 g_file_replace_contents (GFile             *file,
6749                          const char        *contents,
6750                          gsize              length,
6751                          const char        *etag,
6752                          gboolean           make_backup,
6753                          GFileCreateFlags   flags,
6754                          char             **new_etag,
6755                          GCancellable      *cancellable,
6756                          GError           **error)
6757 {
6758   GFileOutputStream *out;
6759   gsize pos, remainder;
6760   gssize res;
6761   gboolean ret;
6762
6763   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6764   g_return_val_if_fail (contents != NULL, FALSE);
6765
6766   out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
6767   if (out == NULL)
6768     return FALSE;
6769
6770   pos = 0;
6771   remainder = length;
6772   while (remainder > 0 &&
6773          (res = g_output_stream_write (G_OUTPUT_STREAM (out),
6774                                        contents + pos,
6775                                        MIN (remainder, GET_CONTENT_BLOCK_SIZE),
6776                                        cancellable,
6777                                        error)) > 0)
6778     {
6779       pos += res;
6780       remainder -= res;
6781     }
6782
6783   if (remainder > 0 && res < 0)
6784     {
6785       /* Ignore errors on close */
6786       g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
6787       g_object_unref (out);
6788
6789       /* error is set already */
6790       return FALSE;
6791     }
6792
6793   ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
6794
6795   if (new_etag)
6796     *new_etag = g_file_output_stream_get_etag (out);
6797
6798   g_object_unref (out);
6799
6800   return ret;
6801 }
6802
6803 typedef struct {
6804   GFile *file;
6805   GError *error;
6806   GCancellable *cancellable;
6807   GAsyncReadyCallback callback;
6808   gpointer user_data;
6809   const char *content;
6810   gsize length;
6811   gsize pos;
6812   char *etag;
6813 } ReplaceContentsData;
6814
6815 static void
6816 replace_contents_data_free (ReplaceContentsData *data)
6817 {
6818   if (data->error)
6819     g_error_free (data->error);
6820   if (data->cancellable)
6821     g_object_unref (data->cancellable);
6822   g_object_unref (data->file);
6823   g_free (data->etag);
6824   g_free (data);
6825 }
6826
6827 static void
6828 replace_contents_close_callback (GObject      *obj,
6829                                  GAsyncResult *close_res,
6830                                  gpointer      user_data)
6831 {
6832   GOutputStream *stream = G_OUTPUT_STREAM (obj);
6833   ReplaceContentsData *data = user_data;
6834   GSimpleAsyncResult *res;
6835
6836   /* Ignore errors here, we're only reading anyway */
6837   g_output_stream_close_finish (stream, close_res, NULL);
6838   g_object_unref (stream);
6839
6840   data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
6841
6842   res = g_simple_async_result_new (G_OBJECT (data->file),
6843                                    data->callback,
6844                                    data->user_data,
6845                                    g_file_replace_contents_async);
6846   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
6847   g_simple_async_result_complete (res);
6848   g_object_unref (res);
6849 }
6850
6851 static void
6852 replace_contents_write_callback (GObject      *obj,
6853                                  GAsyncResult *read_res,
6854                                  gpointer      user_data)
6855 {
6856   GOutputStream *stream = G_OUTPUT_STREAM (obj);
6857   ReplaceContentsData *data = user_data;
6858   GError *error = NULL;
6859   gssize write_size;
6860
6861   write_size = g_output_stream_write_finish (stream, read_res, &error);
6862
6863   if (write_size <= 0)
6864     {
6865       /* Error or EOF, close the file */
6866       if (write_size < 0)
6867         data->error = error;
6868       g_output_stream_close_async (stream, 0,
6869                                    data->cancellable,
6870                                    replace_contents_close_callback, data);
6871     }
6872   else if (write_size > 0)
6873     {
6874       data->pos += write_size;
6875
6876       if (data->pos >= data->length)
6877         g_output_stream_close_async (stream, 0,
6878                                      data->cancellable,
6879                                      replace_contents_close_callback, data);
6880       else
6881         g_output_stream_write_async (stream,
6882                                      data->content + data->pos,
6883                                      data->length - data->pos,
6884                                      0,
6885                                      data->cancellable,
6886                                      replace_contents_write_callback,
6887                                      data);
6888     }
6889 }
6890
6891 static void
6892 replace_contents_open_callback (GObject      *obj,
6893                                 GAsyncResult *open_res,
6894                                 gpointer      user_data)
6895 {
6896   GFile *file = G_FILE (obj);
6897   GFileOutputStream *stream;
6898   ReplaceContentsData *data = user_data;
6899   GError *error = NULL;
6900   GSimpleAsyncResult *res;
6901
6902   stream = g_file_replace_finish (file, open_res, &error);
6903
6904   if (stream)
6905     {
6906       g_output_stream_write_async (G_OUTPUT_STREAM (stream),
6907                                    data->content + data->pos,
6908                                    data->length - data->pos,
6909                                    0,
6910                                    data->cancellable,
6911                                    replace_contents_write_callback,
6912                                    data);
6913
6914     }
6915   else
6916     {
6917       res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6918                                                   data->callback,
6919                                                   data->user_data,
6920                                                   error);
6921       g_simple_async_result_complete (res);
6922       replace_contents_data_free (data);
6923       g_object_unref (res);
6924     }
6925 }
6926
6927 /**
6928  * g_file_replace_contents_async:
6929  * @file: input #GFile.
6930  * @contents: (element-type guint8) (array length=length): string of contents to replace the file with.
6931  * @length: the length of @contents in bytes.
6932  * @etag: (allow-none): a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
6933  * @make_backup: %TRUE if a backup should be created.
6934  * @flags: a set of #GFileCreateFlags.
6935  * @cancellable: optional #GCancellable object, %NULL to ignore.
6936  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6937  * @user_data: the data to pass to callback function
6938  *
6939  * Starts an asynchronous replacement of @file with the given
6940  * @contents of @length bytes. @etag will replace the document's
6941  * current entity tag.
6942  *
6943  * When this operation has completed, @callback will be called with
6944  * @user_user data, and the operation can be finalized with
6945  * g_file_replace_contents_finish().
6946  *
6947  * If @cancellable is not %NULL, then the operation can be cancelled by
6948  * triggering the cancellable object from another thread. If the operation
6949  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6950  *
6951  * If @make_backup is %TRUE, this function will attempt to
6952  * make a backup of @file.
6953  **/
6954 void
6955 g_file_replace_contents_async  (GFile               *file,
6956                                 const char          *contents,
6957                                 gsize                length,
6958                                 const char          *etag,
6959                                 gboolean             make_backup,
6960                                 GFileCreateFlags     flags,
6961                                 GCancellable        *cancellable,
6962                                 GAsyncReadyCallback  callback,
6963                                 gpointer             user_data)
6964 {
6965   ReplaceContentsData *data;
6966
6967   g_return_if_fail (G_IS_FILE (file));
6968   g_return_if_fail (contents != NULL);
6969
6970   data = g_new0 (ReplaceContentsData, 1);
6971
6972   if (cancellable)
6973     data->cancellable = g_object_ref (cancellable);
6974   data->callback = callback;
6975   data->user_data = user_data;
6976   data->content = contents;
6977   data->length = length;
6978   data->pos = 0;
6979   data->file = g_object_ref (file);
6980
6981   g_file_replace_async (file,
6982                         etag,
6983                         make_backup,
6984                         flags,
6985                         0,
6986                         cancellable,
6987                         replace_contents_open_callback,
6988                         data);
6989 }
6990
6991 /**
6992  * g_file_replace_contents_finish:
6993  * @file: input #GFile.
6994  * @res: a #GAsyncResult.
6995  * @new_etag: (out) (allow-none): a location of a new <link linkend="gfile-etag">entity tag</link>
6996  *     for the document. This should be freed with g_free() when it is no
6997  *     longer needed, or %NULL
6998  * @error: a #GError, or %NULL
6999  *
7000  * Finishes an asynchronous replace of the given @file. See
7001  * g_file_replace_contents_async(). Sets @new_etag to the new entity
7002  * tag for the document, if present.
7003  *
7004  * Returns: %TRUE on success, %FALSE on failure.
7005  **/
7006 gboolean
7007 g_file_replace_contents_finish (GFile         *file,
7008                                 GAsyncResult  *res,
7009                                 char         **new_etag,
7010                                 GError       **error)
7011 {
7012   GSimpleAsyncResult *simple;
7013   ReplaceContentsData *data;
7014
7015   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7016   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
7017
7018   simple = G_SIMPLE_ASYNC_RESULT (res);
7019
7020   if (g_simple_async_result_propagate_error (simple, error))
7021     return FALSE;
7022
7023   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
7024
7025   data = g_simple_async_result_get_op_res_gpointer (simple);
7026
7027   if (data->error)
7028     {
7029       g_propagate_error (error, data->error);
7030       data->error = NULL;
7031       return FALSE;
7032     }
7033
7034
7035   if (new_etag)
7036     {
7037       *new_etag = data->etag;
7038       data->etag = NULL; /* Take ownership */
7039     }
7040
7041   return TRUE;
7042 }
7043
7044 /**
7045  * g_file_start_mountable:
7046  * @file: input #GFile.
7047  * @flags: flags affecting the operation
7048  * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
7049  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7050  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7051  * @user_data: the data to pass to callback function
7052  *
7053  * Starts a file of type G_FILE_TYPE_MOUNTABLE.
7054  * Using @start_operation, you can request callbacks when, for instance,
7055  * passwords are needed during authentication.
7056  *
7057  * If @cancellable is not %NULL, then the operation can be cancelled by
7058  * triggering the cancellable object from another thread. If the operation
7059  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7060  *
7061  * When the operation is finished, @callback will be called. You can then call
7062  * g_file_mount_mountable_finish() to get the result of the operation.
7063  *
7064  * Since: 2.22
7065  */
7066 void
7067 g_file_start_mountable (GFile                      *file,
7068                         GDriveStartFlags            flags,
7069                         GMountOperation            *start_operation,
7070                         GCancellable               *cancellable,
7071                         GAsyncReadyCallback         callback,
7072                         gpointer                    user_data)
7073 {
7074   GFileIface *iface;
7075
7076   g_return_if_fail (G_IS_FILE (file));
7077
7078   iface = G_FILE_GET_IFACE (file);
7079
7080   if (iface->start_mountable == NULL)
7081     {
7082       g_simple_async_report_error_in_idle (G_OBJECT (file),
7083                                            callback,
7084                                            user_data,
7085                                            G_IO_ERROR,
7086                                            G_IO_ERROR_NOT_SUPPORTED,
7087                                            _("Operation not supported"));
7088       return;
7089     }
7090
7091   (* iface->start_mountable) (file,
7092                               flags,
7093                               start_operation,
7094                               cancellable,
7095                               callback,
7096                               user_data);
7097 }
7098
7099 /**
7100  * g_file_start_mountable_finish:
7101  * @file: input #GFile.
7102  * @result: a #GAsyncResult.
7103  * @error: a #GError, or %NULL
7104  *
7105  * Finishes a start operation. See g_file_start_mountable() for details.
7106  *
7107  * Finish an asynchronous start operation that was started
7108  * with g_file_start_mountable().
7109  *
7110  * Returns: %TRUE if the operation finished successfully. %FALSE
7111  * otherwise.
7112  *
7113  * Since: 2.22
7114  */
7115 gboolean
7116 g_file_start_mountable_finish (GFile                      *file,
7117                                GAsyncResult               *result,
7118                                GError                    **error)
7119 {
7120   GFileIface *iface;
7121
7122   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7123   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7124
7125   if (g_async_result_legacy_propagate_error (result, error))
7126     return FALSE;
7127
7128   iface = G_FILE_GET_IFACE (file);
7129   return (* iface->start_mountable_finish) (file, result, error);
7130 }
7131
7132 /**
7133  * g_file_stop_mountable:
7134  * @file: input #GFile.
7135  * @flags: flags affecting the operation
7136  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
7137  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7138  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7139  * @user_data: the data to pass to callback function
7140  *
7141  * Stops a file of type G_FILE_TYPE_MOUNTABLE.
7142  *
7143  * If @cancellable is not %NULL, then the operation can be cancelled by
7144  * triggering the cancellable object from another thread. If the operation
7145  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7146  *
7147  * When the operation is finished, @callback will be called. You can then call
7148  * g_file_stop_mountable_finish() to get the result of the operation.
7149  *
7150  * Since: 2.22
7151  */
7152 void
7153 g_file_stop_mountable (GFile                      *file,
7154                        GMountUnmountFlags          flags,
7155                        GMountOperation            *mount_operation,
7156                        GCancellable               *cancellable,
7157                        GAsyncReadyCallback         callback,
7158                        gpointer                    user_data)
7159 {
7160   GFileIface *iface;
7161
7162   g_return_if_fail (G_IS_FILE (file));
7163
7164   iface = G_FILE_GET_IFACE (file);
7165
7166   if (iface->stop_mountable == NULL)
7167     {
7168       g_simple_async_report_error_in_idle (G_OBJECT (file),
7169                                            callback,
7170                                            user_data,
7171                                            G_IO_ERROR,
7172                                            G_IO_ERROR_NOT_SUPPORTED,
7173                                            _("Operation not supported"));
7174       return;
7175     }
7176
7177   (* iface->stop_mountable) (file,
7178                              flags,
7179                              mount_operation,
7180                              cancellable,
7181                              callback,
7182                              user_data);
7183 }
7184
7185 /**
7186  * g_file_stop_mountable_finish:
7187  * @file: input #GFile.
7188  * @result: a #GAsyncResult.
7189  * @error: a #GError, or %NULL
7190  *
7191  * Finishes an stop operation, see g_file_stop_mountable() for details.
7192  *
7193  * Finish an asynchronous stop operation that was started
7194  * with g_file_stop_mountable().
7195  *
7196  * Returns: %TRUE if the operation finished successfully. %FALSE
7197  * otherwise.
7198  *
7199  * Since: 2.22
7200  */
7201 gboolean
7202 g_file_stop_mountable_finish (GFile                      *file,
7203                               GAsyncResult               *result,
7204                               GError                    **error)
7205 {
7206   GFileIface *iface;
7207
7208   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7209   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7210
7211   if (g_async_result_legacy_propagate_error (result, error))
7212     return FALSE;
7213
7214   iface = G_FILE_GET_IFACE (file);
7215   return (* iface->stop_mountable_finish) (file, result, error);
7216 }
7217
7218 /**
7219  * g_file_poll_mountable:
7220  * @file: input #GFile.
7221  * @cancellable: optional #GCancellable object, %NULL to ignore.
7222  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7223  * @user_data: the data to pass to callback function
7224  *
7225  * Polls a file of type G_FILE_TYPE_MOUNTABLE.
7226  *
7227  * If @cancellable is not %NULL, then the operation can be cancelled by
7228  * triggering the cancellable object from another thread. If the operation
7229  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7230  *
7231  * When the operation is finished, @callback will be called. You can then call
7232  * g_file_mount_mountable_finish() to get the result of the operation.
7233  *
7234  * Since: 2.22
7235  */
7236 void
7237 g_file_poll_mountable (GFile                      *file,
7238                        GCancellable               *cancellable,
7239                        GAsyncReadyCallback         callback,
7240                        gpointer                    user_data)
7241 {
7242   GFileIface *iface;
7243
7244   g_return_if_fail (G_IS_FILE (file));
7245
7246   iface = G_FILE_GET_IFACE (file);
7247
7248   if (iface->poll_mountable == NULL)
7249     {
7250       g_simple_async_report_error_in_idle (G_OBJECT (file),
7251                                            callback,
7252                                            user_data,
7253                                            G_IO_ERROR,
7254                                            G_IO_ERROR_NOT_SUPPORTED,
7255                                            _("Operation not supported"));
7256       return;
7257     }
7258
7259   (* iface->poll_mountable) (file,
7260                              cancellable,
7261                              callback,
7262                              user_data);
7263 }
7264
7265 /**
7266  * g_file_poll_mountable_finish:
7267  * @file: input #GFile.
7268  * @result: a #GAsyncResult.
7269  * @error: a #GError, or %NULL
7270  *
7271  * Finishes a poll operation. See g_file_poll_mountable() for details.
7272  *
7273  * Finish an asynchronous poll operation that was polled
7274  * with g_file_poll_mountable().
7275  *
7276  * Returns: %TRUE if the operation finished successfully. %FALSE
7277  * otherwise.
7278  *
7279  * Since: 2.22
7280  */
7281 gboolean
7282 g_file_poll_mountable_finish (GFile                      *file,
7283                               GAsyncResult               *result,
7284                               GError                    **error)
7285 {
7286   GFileIface *iface;
7287
7288   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7289   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7290
7291   if (g_async_result_legacy_propagate_error (result, error))
7292     return FALSE;
7293
7294   iface = G_FILE_GET_IFACE (file);
7295   return (* iface->poll_mountable_finish) (file, result, error);
7296 }
7297
7298 /**
7299  * g_file_supports_thread_contexts:
7300  * @file: a #GFile.
7301  *
7302  * Checks if @file supports <link
7303  * linkend="g-main-context-push-thread-default-context">thread-default
7304  * contexts</link>. If this returns %FALSE, you cannot perform
7305  * asynchronous operations on @file in a thread that has a
7306  * thread-default context.
7307  *
7308  * Returns: Whether or not @file supports thread-default contexts.
7309  *
7310  * Since: 2.22
7311  */
7312 gboolean
7313 g_file_supports_thread_contexts (GFile *file)
7314 {
7315  GFileIface *iface;
7316
7317  g_return_val_if_fail (G_IS_FILE (file), FALSE);
7318
7319  iface = G_FILE_GET_IFACE (file);
7320  return iface->supports_thread_contexts;
7321 }