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         list = g_list_prepend (list, parent_file);  /* Transfer ownership of ref */
3399       else
3400         g_object_unref (parent_file);
3401     }
3402
3403   g_clear_error (&my_error);
3404   for (l = list; result && l; l = l->next)
3405     {
3406       result = g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
3407     }
3408
3409   if (work_file)
3410     g_object_unref (work_file);
3411
3412   /* Clean up */
3413   while (list != NULL)
3414     {
3415       g_object_unref ((GFile *) list->data);
3416       list = g_list_remove (list, list->data);
3417     }
3418
3419   if (!result)
3420     {
3421       g_propagate_error (error, my_error);
3422       return result;
3423     }
3424
3425   return g_file_make_directory (file, cancellable, error);
3426 }
3427
3428 /**
3429  * g_file_make_symbolic_link:
3430  * @file: a #GFile with the name of the symlink to create
3431  * @symlink_value: a string with the path for the target of the new symlink
3432  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3433  * @error: a #GError.
3434  *
3435  * Creates a symbolic link named @file which contains the string
3436  * @symlink_value.
3437  *
3438  * If @cancellable is not %NULL, then the operation can be cancelled by
3439  * triggering the cancellable object from another thread. If the operation
3440  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3441  *
3442  * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3443  */
3444 gboolean
3445 g_file_make_symbolic_link (GFile         *file,
3446                            const char    *symlink_value,
3447                            GCancellable  *cancellable,
3448                            GError       **error)
3449 {
3450   GFileIface *iface;
3451
3452   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3453   g_return_val_if_fail (symlink_value != NULL, FALSE);
3454
3455   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3456     return FALSE;
3457
3458   if (*symlink_value == '\0')
3459     {
3460       g_set_error_literal (error, G_IO_ERROR,
3461                            G_IO_ERROR_INVALID_ARGUMENT,
3462                            _("Invalid symlink value given"));
3463       return FALSE;
3464     }
3465
3466   iface = G_FILE_GET_IFACE (file);
3467
3468   if (iface->make_symbolic_link == NULL)
3469     {
3470       g_set_error_literal (error, G_IO_ERROR,
3471                            G_IO_ERROR_NOT_SUPPORTED,
3472                            _("Operation not supported"));
3473       return FALSE;
3474     }
3475
3476   return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
3477 }
3478
3479 /**
3480  * g_file_delete:
3481  * @file: input #GFile.
3482  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3483  * @error: a #GError, or %NULL
3484  *
3485  * Deletes a file. If the @file is a directory, it will only be deleted if it
3486  * is empty.
3487  *
3488  * If @cancellable is not %NULL, then the operation can be cancelled by
3489  * triggering the cancellable object from another thread. If the operation
3490  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3491  *
3492  * Virtual: delete_file
3493  * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3494  **/
3495 gboolean
3496 g_file_delete (GFile         *file,
3497                GCancellable  *cancellable,
3498                GError       **error)
3499 {
3500   GFileIface *iface;
3501
3502   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3503
3504   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3505     return FALSE;
3506
3507   iface = G_FILE_GET_IFACE (file);
3508
3509   if (iface->delete_file == NULL)
3510     {
3511       g_set_error_literal (error, G_IO_ERROR,
3512                            G_IO_ERROR_NOT_SUPPORTED,
3513                            _("Operation not supported"));
3514       return FALSE;
3515     }
3516
3517   return (* iface->delete_file) (file, cancellable, error);
3518 }
3519
3520 /**
3521  * g_file_delete_async:
3522  * @file: input #GFile.
3523  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3524  *     of the request
3525  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3526  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3527  * @user_data: the data to pass to callback function
3528  *
3529  * Asynchronously delete a file. If the @file is a directory, it will
3530  * only be deleted if it is empty.
3531  *
3532  * Virtual: delete_file_async
3533  * Since: 2.34
3534  **/
3535 void
3536 g_file_delete_async (GFile               *file,
3537                      int                  io_priority,
3538                      GCancellable        *cancellable,
3539                      GAsyncReadyCallback  callback,
3540                      gpointer             user_data)
3541 {
3542   GFileIface *iface;
3543
3544   g_return_if_fail (G_IS_FILE (file));
3545
3546   iface = G_FILE_GET_IFACE (file);
3547   (* iface->delete_file_async) (file,
3548                                 io_priority,
3549                                 cancellable,
3550                                 callback,
3551                                 user_data);
3552 }
3553
3554 /**
3555  * g_file_delete_finish:
3556  * @file: input #GFile.
3557  * @res: a #GAsyncResult.
3558  * @error: a #GError, or %NULL
3559  *
3560  * Finishes deleting a file started with
3561  * g_file_delete_async().
3562  *
3563  * Virtual: delete_file_finish
3564  * Since: 2.34
3565  **/
3566 gboolean
3567 g_file_delete_finish (GFile            *file,
3568                       GAsyncResult     *result,
3569                       GError          **error)
3570 {
3571   GFileIface *iface;
3572
3573   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3574   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3575
3576   if (g_async_result_legacy_propagate_error (result, error))
3577     return FALSE;
3578
3579   iface = G_FILE_GET_IFACE (file);
3580   return (* iface->delete_file_finish) (file, result, error);
3581 }
3582
3583 /**
3584  * g_file_trash:
3585  * @file: #GFile to send to trash.
3586  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3587  * @error: a #GError, or %NULL
3588  *
3589  * Sends @file to the "Trashcan", if possible. This is similar to
3590  * deleting it, but the user can recover it before emptying the trashcan.
3591  * Not all file systems support trashing, so this call can return the
3592  * %G_IO_ERROR_NOT_SUPPORTED error.
3593  *
3594  *
3595  * If @cancellable is not %NULL, then the operation can be cancelled by
3596  * triggering the cancellable object from another thread. If the operation
3597  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3598  *
3599  * Returns: %TRUE on successful trash, %FALSE otherwise.
3600  **/
3601 gboolean
3602 g_file_trash (GFile         *file,
3603               GCancellable  *cancellable,
3604               GError       **error)
3605 {
3606   GFileIface *iface;
3607
3608   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3609
3610   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3611     return FALSE;
3612
3613   iface = G_FILE_GET_IFACE (file);
3614
3615   if (iface->trash == NULL)
3616     {
3617       g_set_error_literal (error,
3618                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3619                            _("Trash not supported"));
3620       return FALSE;
3621     }
3622
3623   return (* iface->trash) (file, cancellable, error);
3624 }
3625
3626 /**
3627  * g_file_set_display_name:
3628  * @file: input #GFile.
3629  * @display_name: a string.
3630  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3631  * @error: a #GError, or %NULL
3632  *
3633  * Renames @file to the specified display name.
3634  *
3635  * The display name is converted from UTF8 to the correct encoding for the target
3636  * filesystem if possible and the @file is renamed to this.
3637  *
3638  * If you want to implement a rename operation in the user interface the edit name
3639  * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
3640  * widget, and then the result after editing should be passed to g_file_set_display_name().
3641  *
3642  * On success the resulting converted filename is returned.
3643  *
3644  * If @cancellable is not %NULL, then the operation can be cancelled by
3645  * triggering the cancellable object from another thread. If the operation
3646  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3647  *
3648  * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL
3649  *     if there was an error.
3650  *     Free the returned object with g_object_unref().
3651  **/
3652 GFile *
3653 g_file_set_display_name (GFile         *file,
3654                          const char    *display_name,
3655                          GCancellable  *cancellable,
3656                          GError       **error)
3657 {
3658   GFileIface *iface;
3659
3660   g_return_val_if_fail (G_IS_FILE (file), NULL);
3661   g_return_val_if_fail (display_name != NULL, NULL);
3662
3663   if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
3664     {
3665       g_set_error (error,
3666                    G_IO_ERROR,
3667                    G_IO_ERROR_INVALID_ARGUMENT,
3668                    _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
3669       return NULL;
3670     }
3671
3672   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3673     return NULL;
3674
3675   iface = G_FILE_GET_IFACE (file);
3676
3677   return (* iface->set_display_name) (file, display_name, cancellable, error);
3678 }
3679
3680 /**
3681  * g_file_set_display_name_async:
3682  * @file: input #GFile.
3683  * @display_name: a string.
3684  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3685  *     of the request.
3686  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3687  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3688  * @user_data: (closure): the data to pass to callback function
3689  *
3690  * Asynchronously sets the display name for a given #GFile.
3691  *
3692  * For more details, see g_file_set_display_name() which is
3693  * the synchronous version of this call.
3694  *
3695  * When the operation is finished, @callback will be called. You can then call
3696  * g_file_set_display_name_finish() to get the result of the operation.
3697  **/
3698 void
3699 g_file_set_display_name_async (GFile               *file,
3700                                const char          *display_name,
3701                                int                  io_priority,
3702                                GCancellable        *cancellable,
3703                                GAsyncReadyCallback  callback,
3704                                gpointer             user_data)
3705 {
3706   GFileIface *iface;
3707
3708   g_return_if_fail (G_IS_FILE (file));
3709   g_return_if_fail (display_name != NULL);
3710
3711   iface = G_FILE_GET_IFACE (file);
3712   (* iface->set_display_name_async) (file,
3713                                      display_name,
3714                                      io_priority,
3715                                      cancellable,
3716                                      callback,
3717                                      user_data);
3718 }
3719
3720 /**
3721  * g_file_set_display_name_finish:
3722  * @file: input #GFile.
3723  * @res: a #GAsyncResult.
3724  * @error: a #GError, or %NULL
3725  *
3726  * Finishes setting a display name started with
3727  * g_file_set_display_name_async().
3728  *
3729  * Returns: (transfer full): a #GFile or %NULL on error.
3730  *     Free the returned object with g_object_unref().
3731  **/
3732 GFile *
3733 g_file_set_display_name_finish (GFile         *file,
3734                                 GAsyncResult  *res,
3735                                 GError       **error)
3736 {
3737   GFileIface *iface;
3738
3739   g_return_val_if_fail (G_IS_FILE (file), NULL);
3740   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3741
3742   if (g_async_result_legacy_propagate_error (res, error))
3743     return NULL;
3744
3745   iface = G_FILE_GET_IFACE (file);
3746   return (* iface->set_display_name_finish) (file, res, error);
3747 }
3748
3749 /**
3750  * g_file_query_settable_attributes:
3751  * @file: input #GFile.
3752  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3753  * @error: a #GError, or %NULL
3754  *
3755  * Obtain the list of settable attributes for the file.
3756  *
3757  * Returns the type and full attribute name of all the attributes
3758  * that can be set on this file. This doesn't mean setting it will always
3759  * succeed though, you might get an access failure, or some specific
3760  * file may not support a specific attribute.
3761  *
3762  * If @cancellable is not %NULL, then the operation can be cancelled by
3763  * triggering the cancellable object from another thread. If the operation
3764  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3765  *
3766  * Returns: a #GFileAttributeInfoList describing the settable attributes.
3767  * When you are done with it, release it with g_file_attribute_info_list_unref()
3768  **/
3769 GFileAttributeInfoList *
3770 g_file_query_settable_attributes (GFile         *file,
3771                                   GCancellable  *cancellable,
3772                                   GError       **error)
3773 {
3774   GFileIface *iface;
3775   GError *my_error;
3776   GFileAttributeInfoList *list;
3777
3778   g_return_val_if_fail (G_IS_FILE (file), NULL);
3779
3780   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3781     return NULL;
3782
3783   iface = G_FILE_GET_IFACE (file);
3784
3785   if (iface->query_settable_attributes == NULL)
3786     return g_file_attribute_info_list_new ();
3787
3788   my_error = NULL;
3789   list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3790
3791   if (list == NULL)
3792     {
3793       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3794         {
3795           list = g_file_attribute_info_list_new ();
3796           g_error_free (my_error);
3797         }
3798       else
3799         g_propagate_error (error, my_error);
3800     }
3801
3802   return list;
3803 }
3804
3805 /**
3806  * g_file_query_writable_namespaces:
3807  * @file: input #GFile.
3808  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3809  * @error: a #GError, or %NULL
3810  *
3811  * Obtain the list of attribute namespaces where new attributes
3812  * can be created by a user. An example of this is extended
3813  * attributes (in the "xattr" namespace).
3814  *
3815  * If @cancellable is not %NULL, then the operation can be cancelled by
3816  * triggering the cancellable object from another thread. If the operation
3817  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3818  *
3819  * Returns: a #GFileAttributeInfoList describing the writable namespaces.
3820  * When you are done with it, release it with g_file_attribute_info_list_unref()
3821  **/
3822 GFileAttributeInfoList *
3823 g_file_query_writable_namespaces (GFile         *file,
3824                                   GCancellable  *cancellable,
3825                                   GError       **error)
3826 {
3827   GFileIface *iface;
3828   GError *my_error;
3829   GFileAttributeInfoList *list;
3830
3831   g_return_val_if_fail (G_IS_FILE (file), NULL);
3832
3833   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3834     return NULL;
3835
3836   iface = G_FILE_GET_IFACE (file);
3837
3838   if (iface->query_writable_namespaces == NULL)
3839     return g_file_attribute_info_list_new ();
3840
3841   my_error = NULL;
3842   list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
3843
3844   if (list == NULL)
3845     {
3846       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3847         {
3848           list = g_file_attribute_info_list_new ();
3849           g_error_free (my_error);
3850         }
3851       else
3852         g_propagate_error (error, my_error);
3853     }
3854
3855   return list;
3856 }
3857
3858 /**
3859  * g_file_set_attribute:
3860  * @file: input #GFile.
3861  * @attribute: a string containing the attribute's name.
3862  * @type: The type of the attribute
3863  * @value_p: (allow-none): a pointer to the value (or the pointer itself if the type is a pointer type)
3864  * @flags: a set of #GFileQueryInfoFlags.
3865  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3866  * @error: a #GError, or %NULL
3867  *
3868  * Sets an attribute in the file with attribute name @attribute to @value.
3869  *
3870  * Some attributes can be unset by setting @attribute to
3871  * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
3872  *
3873  * If @cancellable is not %NULL, then the operation can be cancelled by
3874  * triggering the cancellable object from another thread. If the operation
3875  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3876  *
3877  * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3878  **/
3879 gboolean
3880 g_file_set_attribute (GFile                      *file,
3881                       const char                 *attribute,
3882                       GFileAttributeType          type,
3883                       gpointer                    value_p,
3884                       GFileQueryInfoFlags         flags,
3885                       GCancellable               *cancellable,
3886                       GError                    **error)
3887 {
3888   GFileIface *iface;
3889
3890   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3891   g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
3892
3893   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3894     return FALSE;
3895
3896   iface = G_FILE_GET_IFACE (file);
3897
3898   if (iface->set_attribute == NULL)
3899     {
3900       g_set_error_literal (error, G_IO_ERROR,
3901                            G_IO_ERROR_NOT_SUPPORTED,
3902                            _("Operation not supported"));
3903       return FALSE;
3904     }
3905
3906   return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
3907 }
3908
3909 /**
3910  * g_file_set_attributes_from_info:
3911  * @file: input #GFile.
3912  * @info: a #GFileInfo.
3913  * @flags: #GFileQueryInfoFlags
3914  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3915  * @error: a #GError, or %NULL
3916  *
3917  * Tries to set all attributes in the #GFileInfo on the target values,
3918  * not stopping on the first error.
3919  *
3920  * If there is any error during this operation then @error will be set to
3921  * the first error. Error on particular fields are flagged by setting
3922  * the "status" field in the attribute value to
3923  * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
3924  * further errors.
3925  *
3926  * If @cancellable is not %NULL, then the operation can be cancelled by
3927  * triggering the cancellable object from another thread. If the operation
3928  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3929  *
3930  * Returns: %TRUE if there was any error, %FALSE otherwise.
3931  **/
3932 gboolean
3933 g_file_set_attributes_from_info (GFile                *file,
3934                                  GFileInfo            *info,
3935                                  GFileQueryInfoFlags   flags,
3936                                  GCancellable         *cancellable,
3937                                  GError              **error)
3938 {
3939   GFileIface *iface;
3940
3941   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3942   g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
3943
3944   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3945     return FALSE;
3946
3947   g_file_info_clear_status (info);
3948
3949   iface = G_FILE_GET_IFACE (file);
3950
3951   return (* iface->set_attributes_from_info) (file,
3952                                               info,
3953                                               flags,
3954                                               cancellable,
3955                                               error);
3956 }
3957
3958
3959 static gboolean
3960 g_file_real_set_attributes_from_info (GFile                *file,
3961                                       GFileInfo            *info,
3962                                       GFileQueryInfoFlags   flags,
3963                                       GCancellable         *cancellable,
3964                                       GError              **error)
3965 {
3966   char **attributes;
3967   int i;
3968   gboolean res;
3969   GFileAttributeValue *value;
3970
3971   res = TRUE;
3972
3973   attributes = g_file_info_list_attributes (info, NULL);
3974
3975   for (i = 0; attributes[i] != NULL; i++)
3976     {
3977       value = _g_file_info_get_attribute_value (info, attributes[i]);
3978
3979       if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
3980         continue;
3981
3982       if (!g_file_set_attribute (file, attributes[i],
3983                                  value->type, _g_file_attribute_value_peek_as_pointer (value),
3984                                  flags, cancellable, error))
3985         {
3986           value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3987           res = FALSE;
3988           /* Don't set error multiple times */
3989           error = NULL;
3990         }
3991       else
3992         value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3993     }
3994
3995   g_strfreev (attributes);
3996
3997   return res;
3998 }
3999
4000 /**
4001  * g_file_set_attributes_async:
4002  * @file: input #GFile.
4003  * @info: a #GFileInfo.
4004  * @flags: a #GFileQueryInfoFlags.
4005  * @io_priority: the <link linkend="io-priority">I/O priority</link>
4006  *     of the request.
4007  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4008  * @callback: (scope async): a #GAsyncReadyCallback.
4009  * @user_data: (closure): a #gpointer.
4010  *
4011  * Asynchronously sets the attributes of @file with @info.
4012  *
4013  * For more details, see g_file_set_attributes_from_info() which is
4014  * the synchronous version of this call.
4015  *
4016  * When the operation is finished, @callback will be called. You can then call
4017  * g_file_set_attributes_finish() to get the result of the operation.
4018  **/
4019 void
4020 g_file_set_attributes_async (GFile               *file,
4021                              GFileInfo           *info,
4022                              GFileQueryInfoFlags  flags,
4023                              int                  io_priority,
4024                              GCancellable        *cancellable,
4025                              GAsyncReadyCallback  callback,
4026                              gpointer             user_data)
4027 {
4028   GFileIface *iface;
4029
4030   g_return_if_fail (G_IS_FILE (file));
4031   g_return_if_fail (G_IS_FILE_INFO (info));
4032
4033   iface = G_FILE_GET_IFACE (file);
4034   (* iface->set_attributes_async) (file,
4035                                    info,
4036                                    flags,
4037                                    io_priority,
4038                                    cancellable,
4039                                    callback,
4040                                    user_data);
4041 }
4042
4043 /**
4044  * g_file_set_attributes_finish:
4045  * @file: input #GFile.
4046  * @result: a #GAsyncResult.
4047  * @info: (out) (transfer full): a #GFileInfo.
4048  * @error: a #GError, or %NULL
4049  *
4050  * Finishes setting an attribute started in g_file_set_attributes_async().
4051  *
4052  * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4053  **/
4054 gboolean
4055 g_file_set_attributes_finish (GFile         *file,
4056                               GAsyncResult  *result,
4057                               GFileInfo    **info,
4058                               GError       **error)
4059 {
4060   GFileIface *iface;
4061
4062   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4063   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4064
4065   /* No standard handling of errors here, as we must set info even
4066    * on errors
4067    */
4068   iface = G_FILE_GET_IFACE (file);
4069   return (* iface->set_attributes_finish) (file, result, info, error);
4070 }
4071
4072 /**
4073  * g_file_set_attribute_string:
4074  * @file: input #GFile.
4075  * @attribute: a string containing the attribute's name.
4076  * @value: a string containing the attribute's value.
4077  * @flags: #GFileQueryInfoFlags.
4078  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4079  * @error: a #GError, or %NULL
4080  *
4081  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4082  * If @attribute is of a different type, this operation will fail.
4083  *
4084  * If @cancellable is not %NULL, then the operation can be cancelled by
4085  * triggering the cancellable object from another thread. If the operation
4086  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4087  *
4088  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4089  **/
4090 gboolean
4091 g_file_set_attribute_string (GFile                *file,
4092                              const char           *attribute,
4093                              const char           *value,
4094                              GFileQueryInfoFlags   flags,
4095                              GCancellable         *cancellable,
4096                              GError              **error)
4097 {
4098   return g_file_set_attribute (file, attribute,
4099                                G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
4100                                flags, cancellable, error);
4101 }
4102
4103 /**
4104  * g_file_set_attribute_byte_string:
4105  * @file: input #GFile.
4106  * @attribute: a string containing the attribute's name.
4107  * @value: a string containing the attribute's new value.
4108  * @flags: a #GFileQueryInfoFlags.
4109  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4110  * @error: a #GError, or %NULL
4111  *
4112  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4113  * If @attribute is of a different type, this operation will fail,
4114  * returning %FALSE.
4115  *
4116  * If @cancellable is not %NULL, then the operation can be cancelled by
4117  * triggering the cancellable object from another thread. If the operation
4118  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4119  *
4120  * Returns: %TRUE if the @attribute was successfully set to @value
4121  * in the @file, %FALSE otherwise.
4122  **/
4123 gboolean
4124 g_file_set_attribute_byte_string  (GFile                *file,
4125                                    const char           *attribute,
4126                                    const char           *value,
4127                                    GFileQueryInfoFlags   flags,
4128                                    GCancellable         *cancellable,
4129                                    GError              **error)
4130 {
4131   return g_file_set_attribute (file, attribute,
4132                                G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
4133                                flags, cancellable, error);
4134 }
4135
4136 /**
4137  * g_file_set_attribute_uint32:
4138  * @file: input #GFile.
4139  * @attribute: a string containing the attribute's name.
4140  * @value: a #guint32 containing the attribute's new value.
4141  * @flags: a #GFileQueryInfoFlags.
4142  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4143  * @error: a #GError, or %NULL
4144  *
4145  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4146  * If @attribute is of a different type, this operation will fail.
4147  *
4148  * If @cancellable is not %NULL, then the operation can be cancelled by
4149  * triggering the cancellable object from another thread. If the operation
4150  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4151  *
4152  * Returns: %TRUE if the @attribute was successfully set to @value
4153  * in the @file, %FALSE otherwise.
4154  **/
4155 gboolean
4156 g_file_set_attribute_uint32 (GFile                *file,
4157                              const char           *attribute,
4158                              guint32               value,
4159                              GFileQueryInfoFlags   flags,
4160                              GCancellable         *cancellable,
4161                              GError              **error)
4162 {
4163   return g_file_set_attribute (file, attribute,
4164                                G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
4165                                flags, cancellable, error);
4166 }
4167
4168 /**
4169  * g_file_set_attribute_int32:
4170  * @file: input #GFile.
4171  * @attribute: a string containing the attribute's name.
4172  * @value: a #gint32 containing the attribute's new value.
4173  * @flags: a #GFileQueryInfoFlags.
4174  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4175  * @error: a #GError, or %NULL
4176  *
4177  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4178  * If @attribute is of a different type, this operation will fail.
4179  *
4180  * If @cancellable is not %NULL, then the operation can be cancelled by
4181  * triggering the cancellable object from another thread. If the operation
4182  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4183  *
4184  * Returns: %TRUE if the @attribute was successfully set to @value
4185  * in the @file, %FALSE otherwise.
4186  **/
4187 gboolean
4188 g_file_set_attribute_int32 (GFile                *file,
4189                             const char           *attribute,
4190                             gint32                value,
4191                             GFileQueryInfoFlags   flags,
4192                             GCancellable         *cancellable,
4193                             GError              **error)
4194 {
4195   return g_file_set_attribute (file, attribute,
4196                                G_FILE_ATTRIBUTE_TYPE_INT32, &value,
4197                                flags, cancellable, error);
4198 }
4199
4200 /**
4201  * g_file_set_attribute_uint64:
4202  * @file: input #GFile.
4203  * @attribute: a string containing the attribute's name.
4204  * @value: a #guint64 containing the attribute's new value.
4205  * @flags: a #GFileQueryInfoFlags.
4206  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4207  * @error: a #GError, or %NULL
4208  *
4209  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4210  * If @attribute is of a different type, this operation will fail.
4211  *
4212  * If @cancellable is not %NULL, then the operation can be cancelled by
4213  * triggering the cancellable object from another thread. If the operation
4214  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4215  *
4216  * Returns: %TRUE if the @attribute was successfully set to @value
4217  * in the @file, %FALSE otherwise.
4218  **/
4219 gboolean
4220 g_file_set_attribute_uint64 (GFile                *file,
4221                              const char           *attribute,
4222                              guint64               value,
4223                              GFileQueryInfoFlags   flags,
4224                              GCancellable         *cancellable,
4225                              GError              **error)
4226  {
4227   return g_file_set_attribute (file, attribute,
4228                                G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
4229                                flags, cancellable, error);
4230 }
4231
4232 /**
4233  * g_file_set_attribute_int64:
4234  * @file: input #GFile.
4235  * @attribute: a string containing the attribute's name.
4236  * @value: a #guint64 containing the attribute's new value.
4237  * @flags: a #GFileQueryInfoFlags.
4238  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4239  * @error: a #GError, or %NULL
4240  *
4241  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4242  * If @attribute is of a different type, this operation will fail.
4243  *
4244  * If @cancellable is not %NULL, then the operation can be cancelled by
4245  * triggering the cancellable object from another thread. If the operation
4246  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4247  *
4248  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4249  **/
4250 gboolean
4251 g_file_set_attribute_int64 (GFile                *file,
4252                             const char           *attribute,
4253                             gint64                value,
4254                             GFileQueryInfoFlags   flags,
4255                             GCancellable         *cancellable,
4256                             GError              **error)
4257 {
4258   return g_file_set_attribute (file, attribute,
4259                                G_FILE_ATTRIBUTE_TYPE_INT64, &value,
4260                                flags, cancellable, error);
4261 }
4262
4263 /**
4264  * g_file_mount_mountable:
4265  * @file: input #GFile.
4266  * @flags: flags affecting the operation
4267  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4268  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4269  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4270  * @user_data: (closure): the data to pass to callback function
4271  *
4272  * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4273  * Using @mount_operation, you can request callbacks when, for instance,
4274  * passwords are needed during authentication.
4275  *
4276  * If @cancellable is not %NULL, then the operation can be cancelled by
4277  * triggering the cancellable object from another thread. If the operation
4278  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4279  *
4280  * When the operation is finished, @callback will be called. You can then call
4281  * g_file_mount_mountable_finish() to get the result of the operation.
4282  **/
4283 void
4284 g_file_mount_mountable (GFile               *file,
4285                         GMountMountFlags     flags,
4286                         GMountOperation     *mount_operation,
4287                         GCancellable        *cancellable,
4288                         GAsyncReadyCallback  callback,
4289                         gpointer             user_data)
4290 {
4291   GFileIface *iface;
4292
4293   g_return_if_fail (G_IS_FILE (file));
4294
4295   iface = G_FILE_GET_IFACE (file);
4296
4297   if (iface->mount_mountable == NULL)
4298     {
4299       g_simple_async_report_error_in_idle (G_OBJECT (file),
4300                                            callback,
4301                                            user_data,
4302                                            G_IO_ERROR,
4303                                            G_IO_ERROR_NOT_SUPPORTED,
4304                                            _("Operation not supported"));
4305       return;
4306     }
4307
4308   (* iface->mount_mountable) (file,
4309                               flags,
4310                               mount_operation,
4311                               cancellable,
4312                               callback,
4313                               user_data);
4314 }
4315
4316 /**
4317  * g_file_mount_mountable_finish:
4318  * @file: input #GFile.
4319  * @result: a #GAsyncResult.
4320  * @error: a #GError, or %NULL
4321  *
4322  * Finishes a mount operation. See g_file_mount_mountable() for details.
4323  *
4324  * Finish an asynchronous mount operation that was started
4325  * with g_file_mount_mountable().
4326  *
4327  * Returns: (transfer full): a #GFile or %NULL on error.
4328  *     Free the returned object with g_object_unref().
4329  **/
4330 GFile *
4331 g_file_mount_mountable_finish (GFile         *file,
4332                                GAsyncResult  *result,
4333                                GError       **error)
4334 {
4335   GFileIface *iface;
4336
4337   g_return_val_if_fail (G_IS_FILE (file), NULL);
4338   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
4339
4340   if (g_async_result_legacy_propagate_error (result, error))
4341     return NULL;
4342
4343   iface = G_FILE_GET_IFACE (file);
4344   return (* iface->mount_mountable_finish) (file, result, error);
4345 }
4346
4347 /**
4348  * g_file_unmount_mountable:
4349  * @file: input #GFile.
4350  * @flags: flags affecting the operation
4351  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4352  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4353  * @user_data: (closure): the data to pass to callback function
4354  *
4355  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4356  *
4357  * If @cancellable is not %NULL, then the operation can be cancelled by
4358  * triggering the cancellable object from another thread. If the operation
4359  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4360  *
4361  * When the operation is finished, @callback will be called. You can then call
4362  * g_file_unmount_mountable_finish() to get the result of the operation.
4363  *
4364  * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4365  **/
4366 void
4367 g_file_unmount_mountable (GFile               *file,
4368                           GMountUnmountFlags   flags,
4369                           GCancellable        *cancellable,
4370                           GAsyncReadyCallback  callback,
4371                           gpointer             user_data)
4372 {
4373   GFileIface *iface;
4374
4375   g_return_if_fail (G_IS_FILE (file));
4376
4377   iface = G_FILE_GET_IFACE (file);
4378
4379   if (iface->unmount_mountable == NULL)
4380     {
4381       g_simple_async_report_error_in_idle (G_OBJECT (file),
4382                                            callback,
4383                                            user_data,
4384                                            G_IO_ERROR,
4385                                            G_IO_ERROR_NOT_SUPPORTED,
4386                                            _("Operation not supported"));
4387       return;
4388     }
4389
4390   (* iface->unmount_mountable) (file,
4391                                 flags,
4392                                 cancellable,
4393                                 callback,
4394                                 user_data);
4395 }
4396
4397 /**
4398  * g_file_unmount_mountable_finish:
4399  * @file: input #GFile.
4400  * @result: a #GAsyncResult.
4401  * @error: a #GError, or %NULL
4402  *
4403  * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4404  *
4405  * Finish an asynchronous unmount operation that was started
4406  * with g_file_unmount_mountable().
4407  *
4408  * Returns: %TRUE if the operation finished successfully. %FALSE
4409  * otherwise.
4410  *
4411  * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead.
4412  **/
4413 gboolean
4414 g_file_unmount_mountable_finish (GFile         *file,
4415                                  GAsyncResult  *result,
4416                                  GError       **error)
4417 {
4418   GFileIface *iface;
4419
4420   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4421   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4422
4423   if (g_async_result_legacy_propagate_error (result, error))
4424     return FALSE;
4425
4426   iface = G_FILE_GET_IFACE (file);
4427   return (* iface->unmount_mountable_finish) (file, result, error);
4428 }
4429
4430 /**
4431  * g_file_unmount_mountable_with_operation:
4432  * @file: input #GFile.
4433  * @flags: flags affecting the operation
4434  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4435  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4436  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4437  * @user_data: (closure): the data to pass to callback function
4438  *
4439  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4440  *
4441  * If @cancellable is not %NULL, then the operation can be cancelled by
4442  * triggering the cancellable object from another thread. If the operation
4443  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4444  *
4445  * When the operation is finished, @callback will be called. You can then call
4446  * g_file_unmount_mountable_finish() to get the result of the operation.
4447  *
4448  * Since: 2.22
4449  **/
4450 void
4451 g_file_unmount_mountable_with_operation (GFile               *file,
4452                                          GMountUnmountFlags   flags,
4453                                          GMountOperation     *mount_operation,
4454                                          GCancellable        *cancellable,
4455                                          GAsyncReadyCallback  callback,
4456                                          gpointer             user_data)
4457 {
4458   GFileIface *iface;
4459
4460   g_return_if_fail (G_IS_FILE (file));
4461
4462   iface = G_FILE_GET_IFACE (file);
4463
4464   if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL)
4465     {
4466       g_simple_async_report_error_in_idle (G_OBJECT (file),
4467                                            callback,
4468                                            user_data,
4469                                            G_IO_ERROR,
4470                                            G_IO_ERROR_NOT_SUPPORTED,
4471                                            _("Operation not supported"));
4472       return;
4473     }
4474
4475   if (iface->unmount_mountable_with_operation != NULL)
4476     (* iface->unmount_mountable_with_operation) (file,
4477                                                  flags,
4478                                                  mount_operation,
4479                                                  cancellable,
4480                                                  callback,
4481                                                  user_data);
4482   else
4483     (* iface->unmount_mountable) (file,
4484                                   flags,
4485                                   cancellable,
4486                                   callback,
4487                                   user_data);
4488 }
4489
4490 /**
4491  * g_file_unmount_mountable_with_operation_finish:
4492  * @file: input #GFile.
4493  * @result: a #GAsyncResult.
4494  * @error: a #GError, or %NULL
4495  *
4496  * Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
4497  *
4498  * Finish an asynchronous unmount operation that was started
4499  * with g_file_unmount_mountable_with_operation().
4500  *
4501  * Returns: %TRUE if the operation finished successfully. %FALSE
4502  * otherwise.
4503  *
4504  * Since: 2.22
4505  **/
4506 gboolean
4507 g_file_unmount_mountable_with_operation_finish (GFile         *file,
4508                                                 GAsyncResult  *result,
4509                                                 GError       **error)
4510 {
4511   GFileIface *iface;
4512
4513   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4514   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4515
4516   if (g_async_result_legacy_propagate_error (result, error))
4517     return FALSE;
4518
4519   iface = G_FILE_GET_IFACE (file);
4520   if (iface->unmount_mountable_with_operation_finish != NULL)
4521     return (* iface->unmount_mountable_with_operation_finish) (file, result, error);
4522   else
4523     return (* iface->unmount_mountable_finish) (file, result, error);
4524 }
4525
4526 /**
4527  * g_file_eject_mountable:
4528  * @file: input #GFile.
4529  * @flags: flags affecting the operation
4530  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4531  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4532  * @user_data: (closure): the data to pass to callback function
4533  *
4534  * Starts an asynchronous eject on a mountable.
4535  * When this operation has completed, @callback will be called with
4536  * @user_user data, and the operation can be finalized with
4537  * g_file_eject_mountable_finish().
4538  *
4539  * If @cancellable is not %NULL, then the operation can be cancelled by
4540  * triggering the cancellable object from another thread. If the operation
4541  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4542  *
4543  * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
4544  **/
4545 void
4546 g_file_eject_mountable (GFile               *file,
4547                         GMountUnmountFlags   flags,
4548                         GCancellable        *cancellable,
4549                         GAsyncReadyCallback  callback,
4550                         gpointer             user_data)
4551 {
4552   GFileIface *iface;
4553
4554   g_return_if_fail (G_IS_FILE (file));
4555
4556   iface = G_FILE_GET_IFACE (file);
4557
4558   if (iface->eject_mountable == NULL)
4559     {
4560       g_simple_async_report_error_in_idle (G_OBJECT (file),
4561                                            callback,
4562                                            user_data,
4563                                            G_IO_ERROR,
4564                                            G_IO_ERROR_NOT_SUPPORTED,
4565                                            _("Operation not supported"));
4566       return;
4567     }
4568
4569   (* iface->eject_mountable) (file,
4570                               flags,
4571                               cancellable,
4572                               callback,
4573                               user_data);
4574 }
4575
4576 /**
4577  * g_file_eject_mountable_finish:
4578  * @file: input #GFile.
4579  * @result: a #GAsyncResult.
4580  * @error: a #GError, or %NULL
4581  *
4582  * Finishes an asynchronous eject operation started by
4583  * g_file_eject_mountable().
4584  *
4585  * Returns: %TRUE if the @file was ejected successfully. %FALSE
4586  * otherwise.
4587  *
4588  * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead.
4589  **/
4590 gboolean
4591 g_file_eject_mountable_finish (GFile         *file,
4592                                GAsyncResult  *result,
4593                                GError       **error)
4594 {
4595   GFileIface *iface;
4596
4597   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4598   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4599
4600   if (g_async_result_legacy_propagate_error (result, error))
4601     return FALSE;
4602
4603   iface = G_FILE_GET_IFACE (file);
4604   return (* iface->eject_mountable_finish) (file, result, error);
4605 }
4606
4607 /**
4608  * g_file_eject_mountable_with_operation:
4609  * @file: input #GFile.
4610  * @flags: flags affecting the operation
4611  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4612  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4613  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4614  * @user_data: (closure): the data to pass to callback function
4615  *
4616  * Starts an asynchronous eject on a mountable.
4617  * When this operation has completed, @callback will be called with
4618  * @user_user data, and the operation can be finalized with
4619  * g_file_eject_mountable_with_operation_finish().
4620  *
4621  * If @cancellable is not %NULL, then the operation can be cancelled by
4622  * triggering the cancellable object from another thread. If the operation
4623  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4624  *
4625  * Since: 2.22
4626  **/
4627 void
4628 g_file_eject_mountable_with_operation (GFile               *file,
4629                                        GMountUnmountFlags   flags,
4630                                        GMountOperation     *mount_operation,
4631                                        GCancellable        *cancellable,
4632                                        GAsyncReadyCallback  callback,
4633                                        gpointer             user_data)
4634 {
4635   GFileIface *iface;
4636
4637   g_return_if_fail (G_IS_FILE (file));
4638
4639   iface = G_FILE_GET_IFACE (file);
4640
4641   if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL)
4642     {
4643       g_simple_async_report_error_in_idle (G_OBJECT (file),
4644                                            callback,
4645                                            user_data,
4646                                            G_IO_ERROR,
4647                                            G_IO_ERROR_NOT_SUPPORTED,
4648                                            _("Operation not supported"));
4649       return;
4650     }
4651
4652   if (iface->eject_mountable_with_operation != NULL)
4653     (* iface->eject_mountable_with_operation) (file,
4654                                                flags,
4655                                                mount_operation,
4656                                                cancellable,
4657                                                callback,
4658                                                user_data);
4659   else
4660     (* iface->eject_mountable) (file,
4661                                 flags,
4662                                 cancellable,
4663                                 callback,
4664                                 user_data);
4665 }
4666
4667 /**
4668  * g_file_eject_mountable_with_operation_finish:
4669  * @file: input #GFile.
4670  * @result: a #GAsyncResult.
4671  * @error: a #GError, or %NULL
4672  *
4673  * Finishes an asynchronous eject operation started by
4674  * g_file_eject_mountable_with_operation().
4675  *
4676  * Returns: %TRUE if the @file was ejected successfully. %FALSE
4677  * otherwise.
4678  *
4679  * Since: 2.22
4680  **/
4681 gboolean
4682 g_file_eject_mountable_with_operation_finish (GFile         *file,
4683                                               GAsyncResult  *result,
4684                                               GError       **error)
4685 {
4686   GFileIface *iface;
4687
4688   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4689   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4690
4691   if (g_async_result_legacy_propagate_error (result, error))
4692     return FALSE;
4693
4694   iface = G_FILE_GET_IFACE (file);
4695   if (iface->eject_mountable_with_operation_finish != NULL)
4696     return (* iface->eject_mountable_with_operation_finish) (file, result, error);
4697   else
4698     return (* iface->eject_mountable_finish) (file, result, error);
4699 }
4700
4701 /**
4702  * g_file_monitor_directory:
4703  * @file: input #GFile.
4704  * @flags: a set of #GFileMonitorFlags.
4705  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4706  * @error: a #GError, or %NULL.
4707  *
4708  * Obtains a directory monitor for the given file.
4709  * This may fail if directory monitoring is not supported.
4710  *
4711  * If @cancellable is not %NULL, then the operation can be cancelled by
4712  * triggering the cancellable object from another thread. If the operation
4713  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4714  *
4715  * Virtual: monitor_dir
4716  * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4717  *     Free the returned object with g_object_unref().
4718  **/
4719 GFileMonitor*
4720 g_file_monitor_directory (GFile             *file,
4721                           GFileMonitorFlags  flags,
4722                           GCancellable      *cancellable,
4723                           GError           **error)
4724 {
4725   GFileIface *iface;
4726
4727   g_return_val_if_fail (G_IS_FILE (file), NULL);
4728
4729   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4730     return NULL;
4731
4732   iface = G_FILE_GET_IFACE (file);
4733
4734   if (iface->monitor_dir == NULL)
4735     {
4736       g_set_error_literal (error, G_IO_ERROR,
4737                            G_IO_ERROR_NOT_SUPPORTED,
4738                            _("Operation not supported"));
4739       return NULL;
4740     }
4741
4742   return (* iface->monitor_dir) (file, flags, cancellable, error);
4743 }
4744
4745 /**
4746  * g_file_monitor_file:
4747  * @file: input #GFile.
4748  * @flags: a set of #GFileMonitorFlags.
4749  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4750  * @error: a #GError, or %NULL.
4751  *
4752  * Obtains a file monitor for the given file. If no file notification
4753  * mechanism exists, then regular polling of the file is used.
4754  *
4755  * If @cancellable is not %NULL, then the operation can be cancelled by
4756  * triggering the cancellable object from another thread. If the operation
4757  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4758  *
4759  * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4760  *     Free the returned object with g_object_unref().
4761  **/
4762 GFileMonitor*
4763 g_file_monitor_file (GFile             *file,
4764                      GFileMonitorFlags  flags,
4765                      GCancellable      *cancellable,
4766                      GError           **error)
4767 {
4768   GFileIface *iface;
4769   GFileMonitor *monitor;
4770
4771   g_return_val_if_fail (G_IS_FILE (file), NULL);
4772
4773   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4774     return NULL;
4775
4776   iface = G_FILE_GET_IFACE (file);
4777
4778   monitor = NULL;
4779
4780   if (iface->monitor_file)
4781     monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
4782
4783 /* Fallback to polling */
4784   if (monitor == NULL)
4785     monitor = _g_poll_file_monitor_new (file);
4786
4787   return monitor;
4788 }
4789
4790 /**
4791  * g_file_monitor:
4792  * @file: input #GFile
4793  * @flags: a set of #GFileMonitorFlags
4794  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
4795  * @error: a #GError, or %NULL
4796  *
4797  * Obtains a file or directory monitor for the given file, depending
4798  * on the type of the file.
4799  *
4800  * If @cancellable is not %NULL, then the operation can be cancelled by
4801  * triggering the cancellable object from another thread. If the operation
4802  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4803  *
4804  * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4805  *     Free the returned object with g_object_unref().
4806  *
4807  * Since: 2.18
4808  */
4809 GFileMonitor*
4810 g_file_monitor (GFile             *file,
4811                 GFileMonitorFlags  flags,
4812                 GCancellable      *cancellable,
4813                 GError           **error)
4814 {
4815   if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
4816     return g_file_monitor_directory (file, flags, cancellable, error);
4817   else
4818     return g_file_monitor_file (file, flags, cancellable, error);
4819 }
4820
4821 /********************************************
4822  *   Default implementation of async ops    *
4823  ********************************************/
4824
4825 typedef struct {
4826   char *attributes;
4827   GFileQueryInfoFlags flags;
4828   GFileInfo *info;
4829 } QueryInfoAsyncData;
4830
4831 static void
4832 query_info_data_free (QueryInfoAsyncData *data)
4833 {
4834   if (data->info)
4835     g_object_unref (data->info);
4836   g_free (data->attributes);
4837   g_free (data);
4838 }
4839
4840 static void
4841 query_info_async_thread (GSimpleAsyncResult *res,
4842                          GObject            *object,
4843                          GCancellable       *cancellable)
4844 {
4845   GError *error = NULL;
4846   QueryInfoAsyncData *data;
4847   GFileInfo *info;
4848
4849   data = g_simple_async_result_get_op_res_gpointer (res);
4850
4851   info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4852
4853   if (info == NULL)
4854     g_simple_async_result_take_error (res, error);
4855   else
4856     data->info = info;
4857 }
4858
4859 static void
4860 g_file_real_query_info_async (GFile               *file,
4861                               const char          *attributes,
4862                               GFileQueryInfoFlags  flags,
4863                               int                  io_priority,
4864                               GCancellable        *cancellable,
4865                               GAsyncReadyCallback  callback,
4866                               gpointer             user_data)
4867 {
4868   GSimpleAsyncResult *res;
4869   QueryInfoAsyncData *data;
4870
4871   data = g_new0 (QueryInfoAsyncData, 1);
4872   data->attributes = g_strdup (attributes);
4873   data->flags = flags;
4874
4875   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
4876   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
4877
4878   g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
4879   g_object_unref (res);
4880 }
4881
4882 static GFileInfo *
4883 g_file_real_query_info_finish (GFile         *file,
4884                                GAsyncResult  *res,
4885                                GError       **error)
4886 {
4887   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4888   QueryInfoAsyncData *data;
4889
4890   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
4891
4892   if (g_simple_async_result_propagate_error (simple, error))
4893     return NULL;
4894
4895   data = g_simple_async_result_get_op_res_gpointer (simple);
4896   if (data->info)
4897     return g_object_ref (data->info);
4898
4899   return NULL;
4900 }
4901
4902 typedef struct {
4903   char *attributes;
4904   GFileInfo *info;
4905 } QueryFilesystemInfoAsyncData;
4906
4907 static void
4908 query_filesystem_info_data_free (QueryFilesystemInfoAsyncData *data)
4909 {
4910   if (data->info)
4911     g_object_unref (data->info);
4912   g_free (data->attributes);
4913   g_free (data);
4914 }
4915
4916 static void
4917 query_filesystem_info_async_thread (GSimpleAsyncResult *res,
4918                                     GObject            *object,
4919                                     GCancellable       *cancellable)
4920 {
4921   GError *error = NULL;
4922   QueryFilesystemInfoAsyncData *data;
4923   GFileInfo *info;
4924
4925   data = g_simple_async_result_get_op_res_gpointer (res);
4926
4927   info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error);
4928
4929   if (info == NULL)
4930     g_simple_async_result_take_error (res, error);
4931   else
4932     data->info = info;
4933 }
4934
4935 static void
4936 g_file_real_query_filesystem_info_async (GFile               *file,
4937                                          const char          *attributes,
4938                                          int                  io_priority,
4939                                          GCancellable        *cancellable,
4940                                          GAsyncReadyCallback  callback,
4941                                          gpointer             user_data)
4942 {
4943   GSimpleAsyncResult *res;
4944   QueryFilesystemInfoAsyncData *data;
4945
4946   data = g_new0 (QueryFilesystemInfoAsyncData, 1);
4947   data->attributes = g_strdup (attributes);
4948
4949   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async);
4950   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free);
4951
4952   g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable);
4953   g_object_unref (res);
4954 }
4955
4956 static GFileInfo *
4957 g_file_real_query_filesystem_info_finish (GFile         *file,
4958                                           GAsyncResult  *res,
4959                                           GError       **error)
4960 {
4961   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4962   QueryFilesystemInfoAsyncData *data;
4963
4964   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_filesystem_info_async);
4965
4966   if (g_simple_async_result_propagate_error (simple, error))
4967     return NULL;
4968
4969   data = g_simple_async_result_get_op_res_gpointer (simple);
4970   if (data->info)
4971     return g_object_ref (data->info);
4972
4973   return NULL;
4974 }
4975
4976 typedef struct {
4977   char *attributes;
4978   GFileQueryInfoFlags flags;
4979   GFileEnumerator *enumerator;
4980 } EnumerateChildrenAsyncData;
4981
4982 static void
4983 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
4984 {
4985   if (data->enumerator)
4986     g_object_unref (data->enumerator);
4987   g_free (data->attributes);
4988   g_free (data);
4989 }
4990
4991 static void
4992 enumerate_children_async_thread (GSimpleAsyncResult *res,
4993                                  GObject            *object,
4994                                  GCancellable       *cancellable)
4995 {
4996   GError *error = NULL;
4997   EnumerateChildrenAsyncData *data;
4998   GFileEnumerator *enumerator;
4999
5000   data = g_simple_async_result_get_op_res_gpointer (res);
5001
5002   enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5003
5004   if (enumerator == NULL)
5005     g_simple_async_result_take_error (res, error);
5006   else
5007     data->enumerator = enumerator;
5008 }
5009
5010 static void
5011 g_file_real_enumerate_children_async (GFile               *file,
5012                                       const char          *attributes,
5013                                       GFileQueryInfoFlags  flags,
5014                                       int                  io_priority,
5015                                       GCancellable        *cancellable,
5016                                       GAsyncReadyCallback  callback,
5017                                       gpointer             user_data)
5018 {
5019   GSimpleAsyncResult *res;
5020   EnumerateChildrenAsyncData *data;
5021
5022   data = g_new0 (EnumerateChildrenAsyncData, 1);
5023   data->attributes = g_strdup (attributes);
5024   data->flags = flags;
5025
5026   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
5027   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
5028
5029   g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
5030   g_object_unref (res);
5031 }
5032
5033 static GFileEnumerator *
5034 g_file_real_enumerate_children_finish (GFile         *file,
5035                                        GAsyncResult  *res,
5036                                        GError       **error)
5037 {
5038   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5039   EnumerateChildrenAsyncData *data;
5040
5041   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
5042
5043   if (g_simple_async_result_propagate_error (simple, error))
5044     return NULL;
5045
5046   data = g_simple_async_result_get_op_res_gpointer (simple);
5047   if (data->enumerator)
5048     return g_object_ref (data->enumerator);
5049
5050   return NULL;
5051 }
5052
5053 static void
5054 open_read_async_thread (GSimpleAsyncResult *res,
5055                         GObject            *object,
5056                         GCancellable       *cancellable)
5057 {
5058   GFileIface *iface;
5059   GFileInputStream *stream;
5060   GError *error = NULL;
5061
5062   iface = G_FILE_GET_IFACE (object);
5063
5064   if (iface->read_fn == NULL)
5065     {
5066       g_set_error_literal (&error, G_IO_ERROR,
5067                            G_IO_ERROR_NOT_SUPPORTED,
5068                            _("Operation not supported"));
5069
5070       g_simple_async_result_take_error (res, error);
5071
5072       return;
5073     }
5074
5075   stream = iface->read_fn (G_FILE (object), cancellable, &error);
5076
5077   if (stream == NULL)
5078     g_simple_async_result_take_error (res, error);
5079   else
5080     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5081 }
5082
5083 static void
5084 g_file_real_read_async (GFile               *file,
5085                         int                  io_priority,
5086                         GCancellable        *cancellable,
5087                         GAsyncReadyCallback  callback,
5088                         gpointer             user_data)
5089 {
5090   GSimpleAsyncResult *res;
5091
5092   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
5093
5094   g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
5095   g_object_unref (res);
5096 }
5097
5098 static GFileInputStream *
5099 g_file_real_read_finish (GFile         *file,
5100                          GAsyncResult  *res,
5101                          GError       **error)
5102 {
5103   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5104   gpointer op;
5105
5106   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
5107
5108   if (g_simple_async_result_propagate_error (simple, error))
5109     return NULL;
5110
5111   op = g_simple_async_result_get_op_res_gpointer (simple);
5112   if (op)
5113     return g_object_ref (op);
5114
5115   return NULL;
5116 }
5117
5118 static void
5119 append_to_async_thread (GSimpleAsyncResult *res,
5120                         GObject            *object,
5121                         GCancellable       *cancellable)
5122 {
5123   GFileIface *iface;
5124   GFileCreateFlags *data;
5125   GFileOutputStream *stream;
5126   GError *error = NULL;
5127
5128   iface = G_FILE_GET_IFACE (object);
5129
5130   data = g_simple_async_result_get_op_res_gpointer (res);
5131
5132   stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
5133
5134   if (stream == NULL)
5135     g_simple_async_result_take_error (res, error);
5136   else
5137     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5138 }
5139
5140 static void
5141 g_file_real_append_to_async (GFile               *file,
5142                              GFileCreateFlags     flags,
5143                              int                  io_priority,
5144                              GCancellable        *cancellable,
5145                              GAsyncReadyCallback  callback,
5146                              gpointer             user_data)
5147 {
5148   GFileCreateFlags *data;
5149   GSimpleAsyncResult *res;
5150
5151   data = g_new0 (GFileCreateFlags, 1);
5152   *data = flags;
5153
5154   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
5155   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5156
5157   g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
5158   g_object_unref (res);
5159 }
5160
5161 static GFileOutputStream *
5162 g_file_real_append_to_finish (GFile         *file,
5163                               GAsyncResult  *res,
5164                               GError       **error)
5165 {
5166   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5167   gpointer op;
5168
5169   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
5170
5171   if (g_simple_async_result_propagate_error (simple, error))
5172     return NULL;
5173
5174   op = g_simple_async_result_get_op_res_gpointer (simple);
5175   if (op)
5176     return g_object_ref (op);
5177
5178   return NULL;
5179 }
5180
5181 static void
5182 create_async_thread (GSimpleAsyncResult *res,
5183                      GObject            *object,
5184                      GCancellable       *cancellable)
5185 {
5186   GFileIface *iface;
5187   GFileCreateFlags *data;
5188   GFileOutputStream *stream;
5189   GError *error = NULL;
5190
5191   iface = G_FILE_GET_IFACE (object);
5192
5193   data = g_simple_async_result_get_op_res_gpointer (res);
5194
5195   stream = iface->create (G_FILE (object), *data, cancellable, &error);
5196
5197   if (stream == NULL)
5198     g_simple_async_result_take_error (res, error);
5199   else
5200     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5201 }
5202
5203 static void
5204 g_file_real_create_async (GFile               *file,
5205                           GFileCreateFlags     flags,
5206                           int                  io_priority,
5207                           GCancellable        *cancellable,
5208                           GAsyncReadyCallback  callback,
5209                           gpointer             user_data)
5210 {
5211   GFileCreateFlags *data;
5212   GSimpleAsyncResult *res;
5213
5214   data = g_new0 (GFileCreateFlags, 1);
5215   *data = flags;
5216
5217   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
5218   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5219
5220   g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
5221   g_object_unref (res);
5222 }
5223
5224 static GFileOutputStream *
5225 g_file_real_create_finish (GFile         *file,
5226                            GAsyncResult  *res,
5227                            GError       **error)
5228 {
5229   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5230   gpointer op;
5231
5232   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
5233
5234   if (g_simple_async_result_propagate_error (simple, error))
5235     return NULL;
5236
5237   op = g_simple_async_result_get_op_res_gpointer (simple);
5238   if (op)
5239     return g_object_ref (op);
5240
5241   return NULL;
5242 }
5243
5244 typedef struct {
5245   GFileOutputStream *stream;
5246   char *etag;
5247   gboolean make_backup;
5248   GFileCreateFlags flags;
5249 } ReplaceAsyncData;
5250
5251 static void
5252 replace_async_data_free (ReplaceAsyncData *data)
5253 {
5254   if (data->stream)
5255     g_object_unref (data->stream);
5256   g_free (data->etag);
5257   g_free (data);
5258 }
5259
5260 static void
5261 replace_async_thread (GSimpleAsyncResult *res,
5262                       GObject            *object,
5263                       GCancellable       *cancellable)
5264 {
5265   GFileIface *iface;
5266   GFileOutputStream *stream;
5267   GError *error = NULL;
5268   ReplaceAsyncData *data;
5269
5270   iface = G_FILE_GET_IFACE (object);
5271
5272   data = g_simple_async_result_get_op_res_gpointer (res);
5273
5274   stream = iface->replace (G_FILE (object),
5275                            data->etag,
5276                            data->make_backup,
5277                            data->flags,
5278                            cancellable,
5279                            &error);
5280
5281   if (stream == NULL)
5282     g_simple_async_result_take_error (res, error);
5283   else
5284     data->stream = stream;
5285 }
5286
5287 static void
5288 g_file_real_replace_async (GFile               *file,
5289                            const char          *etag,
5290                            gboolean             make_backup,
5291                            GFileCreateFlags     flags,
5292                            int                  io_priority,
5293                            GCancellable        *cancellable,
5294                            GAsyncReadyCallback  callback,
5295                            gpointer             user_data)
5296 {
5297   GSimpleAsyncResult *res;
5298   ReplaceAsyncData *data;
5299
5300   data = g_new0 (ReplaceAsyncData, 1);
5301   data->etag = g_strdup (etag);
5302   data->make_backup = make_backup;
5303   data->flags = flags;
5304
5305   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
5306   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
5307
5308   g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
5309   g_object_unref (res);
5310 }
5311
5312 static GFileOutputStream *
5313 g_file_real_replace_finish (GFile         *file,
5314                             GAsyncResult  *res,
5315                             GError       **error)
5316 {
5317   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5318   ReplaceAsyncData *data;
5319
5320   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
5321
5322   if (g_simple_async_result_propagate_error (simple, error))
5323     return NULL;
5324
5325   data = g_simple_async_result_get_op_res_gpointer (simple);
5326   if (data->stream)
5327     return g_object_ref (data->stream);
5328
5329   return NULL;
5330 }
5331
5332 static void
5333 delete_async_thread (GSimpleAsyncResult *res,
5334                      GObject            *object,
5335                      GCancellable       *cancellable)
5336 {
5337   GFileIface *iface;
5338   GError *error = NULL;
5339
5340   iface = G_FILE_GET_IFACE (object);
5341
5342   if (!iface->delete_file (G_FILE (object),
5343                            cancellable,
5344                            &error))
5345     g_simple_async_result_take_error (res, error);
5346 }
5347
5348 static void
5349 g_file_real_delete_async (GFile               *file,
5350                           int                  io_priority,
5351                           GCancellable        *cancellable,
5352                           GAsyncReadyCallback  callback,
5353                           gpointer             user_data)
5354 {
5355   GSimpleAsyncResult *res;
5356
5357   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_delete_async);
5358   g_simple_async_result_run_in_thread (res, delete_async_thread, io_priority, cancellable);
5359   g_object_unref (res);
5360 }
5361
5362 static gboolean
5363 g_file_real_delete_finish (GFile         *file,
5364                            GAsyncResult  *res,
5365                            GError       **error)
5366 {
5367   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5368
5369   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_delete_async);
5370
5371   if (g_simple_async_result_propagate_error (simple, error))
5372     return FALSE;
5373
5374   return TRUE;
5375 }
5376
5377 static void
5378 open_readwrite_async_thread (GSimpleAsyncResult *res,
5379                              GObject            *object,
5380                              GCancellable       *cancellable)
5381 {
5382   GFileIface *iface;
5383   GFileIOStream *stream;
5384   GError *error = NULL;
5385
5386   iface = G_FILE_GET_IFACE (object);
5387
5388   if (iface->open_readwrite == NULL)
5389     {
5390       g_set_error_literal (&error, G_IO_ERROR,
5391                            G_IO_ERROR_NOT_SUPPORTED,
5392                            _("Operation not supported"));
5393
5394       g_simple_async_result_take_error (res, error);
5395
5396       return;
5397     }
5398
5399   stream = iface->open_readwrite (G_FILE (object), cancellable, &error);
5400
5401   if (stream == NULL)
5402     g_simple_async_result_take_error (res, error);
5403   else
5404     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5405 }
5406
5407 static void
5408 g_file_real_open_readwrite_async (GFile               *file,
5409                                   int                  io_priority,
5410                                   GCancellable        *cancellable,
5411                                   GAsyncReadyCallback  callback,
5412                                   gpointer             user_data)
5413 {
5414   GSimpleAsyncResult *res;
5415
5416   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_open_readwrite_async);
5417
5418   g_simple_async_result_run_in_thread (res, open_readwrite_async_thread, io_priority, cancellable);
5419   g_object_unref (res);
5420 }
5421
5422 static GFileIOStream *
5423 g_file_real_open_readwrite_finish (GFile         *file,
5424                                    GAsyncResult  *res,
5425                                    GError       **error)
5426 {
5427   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5428   gpointer op;
5429
5430   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_open_readwrite_async);
5431
5432   if (g_simple_async_result_propagate_error (simple, error))
5433     return NULL;
5434
5435   op = g_simple_async_result_get_op_res_gpointer (simple);
5436   if (op)
5437     return g_object_ref (op);
5438
5439   return NULL;
5440 }
5441
5442 static void
5443 create_readwrite_async_thread (GSimpleAsyncResult *res,
5444                                GObject            *object,
5445                                GCancellable       *cancellable)
5446 {
5447   GFileIface *iface;
5448   GFileCreateFlags *data;
5449   GFileIOStream *stream;
5450   GError *error = NULL;
5451
5452   iface = G_FILE_GET_IFACE (object);
5453
5454   data = g_simple_async_result_get_op_res_gpointer (res);
5455
5456   if (iface->create_readwrite == NULL)
5457     {
5458       g_set_error_literal (&error, G_IO_ERROR,
5459                            G_IO_ERROR_NOT_SUPPORTED,
5460                            _("Operation not supported"));
5461
5462       g_simple_async_result_take_error (res, error);
5463
5464       return;
5465     }
5466
5467   stream = iface->create_readwrite (G_FILE (object), *data, cancellable, &error);
5468
5469   if (stream == NULL)
5470     g_simple_async_result_take_error (res, error);
5471   else
5472     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5473 }
5474
5475 static void
5476 g_file_real_create_readwrite_async (GFile               *file,
5477                                     GFileCreateFlags     flags,
5478                                     int                  io_priority,
5479                                     GCancellable        *cancellable,
5480                                     GAsyncReadyCallback  callback,
5481                                     gpointer             user_data)
5482 {
5483   GFileCreateFlags *data;
5484   GSimpleAsyncResult *res;
5485
5486   data = g_new0 (GFileCreateFlags, 1);
5487   *data = flags;
5488
5489   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_readwrite_async);
5490   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5491
5492   g_simple_async_result_run_in_thread (res, create_readwrite_async_thread, io_priority, cancellable);
5493   g_object_unref (res);
5494 }
5495
5496 static GFileIOStream *
5497 g_file_real_create_readwrite_finish (GFile         *file,
5498                                      GAsyncResult  *res,
5499                                      GError       **error)
5500 {
5501   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5502   gpointer op;
5503
5504   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_readwrite_async);
5505
5506   if (g_simple_async_result_propagate_error (simple, error))
5507     return NULL;
5508
5509   op = g_simple_async_result_get_op_res_gpointer (simple);
5510   if (op)
5511     return g_object_ref (op);
5512
5513   return NULL;
5514 }
5515
5516 typedef struct {
5517   GFileIOStream *stream;
5518   char *etag;
5519   gboolean make_backup;
5520   GFileCreateFlags flags;
5521 } ReplaceRWAsyncData;
5522
5523 static void
5524 replace_rw_async_data_free (ReplaceRWAsyncData *data)
5525 {
5526   if (data->stream)
5527     g_object_unref (data->stream);
5528   g_free (data->etag);
5529   g_free (data);
5530 }
5531
5532 static void
5533 replace_readwrite_async_thread (GSimpleAsyncResult *res,
5534                                 GObject            *object,
5535                                 GCancellable       *cancellable)
5536 {
5537   GFileIface *iface;
5538   GFileIOStream *stream;
5539   GError *error = NULL;
5540   ReplaceRWAsyncData *data;
5541
5542   iface = G_FILE_GET_IFACE (object);
5543
5544   data = g_simple_async_result_get_op_res_gpointer (res);
5545
5546   stream = iface->replace_readwrite (G_FILE (object),
5547                                      data->etag,
5548                                      data->make_backup,
5549                                      data->flags,
5550                                      cancellable,
5551                                      &error);
5552
5553   if (stream == NULL)
5554     g_simple_async_result_take_error (res, error);
5555   else
5556     data->stream = stream;
5557 }
5558
5559 static void
5560 g_file_real_replace_readwrite_async (GFile               *file,
5561                                      const char          *etag,
5562                                      gboolean             make_backup,
5563                                      GFileCreateFlags     flags,
5564                                      int                  io_priority,
5565                                      GCancellable        *cancellable,
5566                                      GAsyncReadyCallback  callback,
5567                                      gpointer             user_data)
5568 {
5569   GSimpleAsyncResult *res;
5570   ReplaceRWAsyncData *data;
5571
5572   data = g_new0 (ReplaceRWAsyncData, 1);
5573   data->etag = g_strdup (etag);
5574   data->make_backup = make_backup;
5575   data->flags = flags;
5576
5577   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_readwrite_async);
5578   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_rw_async_data_free);
5579
5580   g_simple_async_result_run_in_thread (res, replace_readwrite_async_thread, io_priority, cancellable);
5581   g_object_unref (res);
5582 }
5583
5584 static GFileIOStream *
5585 g_file_real_replace_readwrite_finish (GFile         *file,
5586                                       GAsyncResult  *res,
5587                                       GError       **error)
5588 {
5589   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5590   ReplaceRWAsyncData *data;
5591
5592   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_readwrite_async);
5593
5594   if (g_simple_async_result_propagate_error (simple, error))
5595     return NULL;
5596
5597   data = g_simple_async_result_get_op_res_gpointer (simple);
5598   if (data->stream)
5599     return g_object_ref (data->stream);
5600
5601   return NULL;
5602 }
5603
5604 typedef struct {
5605   char *name;
5606   GFile *file;
5607 } SetDisplayNameAsyncData;
5608
5609 static void
5610 set_display_name_data_free (SetDisplayNameAsyncData *data)
5611 {
5612   g_free (data->name);
5613   if (data->file)
5614     g_object_unref (data->file);
5615   g_free (data);
5616 }
5617
5618 static void
5619 set_display_name_async_thread (GSimpleAsyncResult *res,
5620                                GObject            *object,
5621                                GCancellable       *cancellable)
5622 {
5623   GError *error = NULL;
5624   SetDisplayNameAsyncData *data;
5625   GFile *file;
5626
5627   data = g_simple_async_result_get_op_res_gpointer (res);
5628
5629   file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
5630
5631   if (file == NULL)
5632     g_simple_async_result_take_error (res, error);
5633   else
5634     data->file = file;
5635 }
5636
5637 static void
5638 g_file_real_set_display_name_async (GFile               *file,
5639                                     const char          *display_name,
5640                                     int                  io_priority,
5641                                     GCancellable        *cancellable,
5642                                     GAsyncReadyCallback  callback,
5643                                     gpointer             user_data)
5644 {
5645   GSimpleAsyncResult *res;
5646   SetDisplayNameAsyncData *data;
5647
5648   data = g_new0 (SetDisplayNameAsyncData, 1);
5649   data->name = g_strdup (display_name);
5650
5651   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
5652   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
5653
5654   g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
5655   g_object_unref (res);
5656 }
5657
5658 static GFile *
5659 g_file_real_set_display_name_finish (GFile         *file,
5660                                      GAsyncResult  *res,
5661                                      GError       **error)
5662 {
5663   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5664   SetDisplayNameAsyncData *data;
5665
5666   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
5667
5668   if (g_simple_async_result_propagate_error (simple, error))
5669     return NULL;
5670
5671   data = g_simple_async_result_get_op_res_gpointer (simple);
5672   if (data->file)
5673     return g_object_ref (data->file);
5674
5675   return NULL;
5676 }
5677
5678 typedef struct {
5679   GFileQueryInfoFlags flags;
5680   GFileInfo *info;
5681   gboolean res;
5682   GError *error;
5683 } SetInfoAsyncData;
5684
5685 static void
5686 set_info_data_free (SetInfoAsyncData *data)
5687 {
5688   if (data->info)
5689     g_object_unref (data->info);
5690   if (data->error)
5691     g_error_free (data->error);
5692   g_free (data);
5693 }
5694
5695 static void
5696 set_info_async_thread (GSimpleAsyncResult *res,
5697                        GObject            *object,
5698                        GCancellable       *cancellable)
5699 {
5700   SetInfoAsyncData *data;
5701
5702   data = g_simple_async_result_get_op_res_gpointer (res);
5703
5704   data->error = NULL;
5705   data->res = g_file_set_attributes_from_info (G_FILE (object),
5706                                                data->info,
5707                                                data->flags,
5708                                                cancellable,
5709                                                &data->error);
5710 }
5711
5712 static void
5713 g_file_real_set_attributes_async (GFile               *file,
5714                                   GFileInfo           *info,
5715                                   GFileQueryInfoFlags  flags,
5716                                   int                  io_priority,
5717                                   GCancellable        *cancellable,
5718                                   GAsyncReadyCallback  callback,
5719                                   gpointer             user_data)
5720 {
5721   GSimpleAsyncResult *res;
5722   SetInfoAsyncData *data;
5723
5724   data = g_new0 (SetInfoAsyncData, 1);
5725   data->info = g_file_info_dup (info);
5726   data->flags = flags;
5727
5728   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
5729   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
5730
5731   g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
5732   g_object_unref (res);
5733 }
5734
5735 static gboolean
5736 g_file_real_set_attributes_finish (GFile         *file,
5737                                    GAsyncResult  *res,
5738                                    GFileInfo    **info,
5739                                    GError       **error)
5740 {
5741   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5742   SetInfoAsyncData *data;
5743
5744   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
5745
5746   data = g_simple_async_result_get_op_res_gpointer (simple);
5747
5748   if (info)
5749     *info = g_object_ref (data->info);
5750
5751   if (error != NULL && data->error)
5752     *error = g_error_copy (data->error);
5753
5754   return data->res;
5755 }
5756
5757 static void
5758 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
5759                                     GObject            *object,
5760                                     GCancellable       *cancellable)
5761 {
5762   GError *error = NULL;
5763   GMount *mount;
5764
5765   mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
5766
5767   if (mount == NULL)
5768     g_simple_async_result_take_error (res, error);
5769   else
5770     g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
5771 }
5772
5773 static void
5774 g_file_real_find_enclosing_mount_async (GFile               *file,
5775                                         int                  io_priority,
5776                                         GCancellable        *cancellable,
5777                                         GAsyncReadyCallback  callback,
5778                                         gpointer             user_data)
5779 {
5780   GSimpleAsyncResult *res;
5781
5782   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
5783
5784   g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
5785   g_object_unref (res);
5786 }
5787
5788 static GMount *
5789 g_file_real_find_enclosing_mount_finish (GFile         *file,
5790                                           GAsyncResult  *res,
5791                                           GError       **error)
5792 {
5793   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5794   GMount *mount;
5795
5796   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
5797
5798   if (g_simple_async_result_propagate_error (simple, error))
5799     return NULL;
5800
5801   mount = g_simple_async_result_get_op_res_gpointer (simple);
5802   return g_object_ref (mount);
5803 }
5804
5805
5806 typedef struct {
5807   GFile *source;
5808   GFile *destination;
5809   GFileCopyFlags flags;
5810   GFileProgressCallback progress_cb;
5811   gpointer progress_cb_data;
5812   GIOSchedulerJob *job;
5813 } CopyAsyncData;
5814
5815 static void
5816 copy_async_data_free (CopyAsyncData *data)
5817 {
5818   g_object_unref (data->source);
5819   g_object_unref (data->destination);
5820   g_free (data);
5821 }
5822
5823 typedef struct {
5824   CopyAsyncData *data;
5825   goffset current_num_bytes;
5826   goffset total_num_bytes;
5827 } ProgressData;
5828
5829 static gboolean
5830 copy_async_progress_in_main (gpointer user_data)
5831 {
5832   ProgressData *progress = user_data;
5833   CopyAsyncData *data = progress->data;
5834
5835   data->progress_cb (progress->current_num_bytes,
5836                      progress->total_num_bytes,
5837                      data->progress_cb_data);
5838
5839   return FALSE;
5840 }
5841
5842 static void
5843 copy_async_progress_callback (goffset  current_num_bytes,
5844                               goffset  total_num_bytes,
5845                               gpointer user_data)
5846 {
5847   CopyAsyncData *data = user_data;
5848   ProgressData *progress;
5849
5850   progress = g_new (ProgressData, 1);
5851   progress->data = data;
5852   progress->current_num_bytes = current_num_bytes;
5853   progress->total_num_bytes = total_num_bytes;
5854
5855   g_io_scheduler_job_send_to_mainloop_async (data->job,
5856                                              copy_async_progress_in_main,
5857                                              progress,
5858                                              g_free);
5859 }
5860
5861 static gboolean
5862 copy_async_thread (GIOSchedulerJob *job,
5863                    GCancellable    *cancellable,
5864                    gpointer         user_data)
5865 {
5866   GSimpleAsyncResult *res;
5867   CopyAsyncData *data;
5868   gboolean result;
5869   GError *error;
5870
5871   res = user_data;
5872   data = g_simple_async_result_get_op_res_gpointer (res);
5873
5874   error = NULL;
5875   data->job = job;
5876   result = g_file_copy (data->source,
5877                         data->destination,
5878                         data->flags,
5879                         cancellable,
5880                         (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
5881                         data,
5882                         &error);
5883
5884   if (!result)
5885     g_simple_async_result_take_error (res, error);
5886
5887   g_simple_async_result_complete_in_idle (res);
5888
5889   return FALSE;
5890 }
5891
5892 static void
5893 g_file_real_copy_async (GFile                  *source,
5894                         GFile                  *destination,
5895                         GFileCopyFlags          flags,
5896                         int                     io_priority,
5897                         GCancellable           *cancellable,
5898                         GFileProgressCallback   progress_callback,
5899                         gpointer                progress_callback_data,
5900                         GAsyncReadyCallback     callback,
5901                         gpointer                user_data)
5902 {
5903   GSimpleAsyncResult *res;
5904   CopyAsyncData *data;
5905
5906   data = g_new0 (CopyAsyncData, 1);
5907   data->source = g_object_ref (source);
5908   data->destination = g_object_ref (destination);
5909   data->flags = flags;
5910   data->progress_cb = progress_callback;
5911   data->progress_cb_data = progress_callback_data;
5912
5913   res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
5914   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
5915
5916   g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
5917 }
5918
5919 static gboolean
5920 g_file_real_copy_finish (GFile        *file,
5921                          GAsyncResult *res,
5922                          GError      **error)
5923 {
5924   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5925
5926   if (g_simple_async_result_propagate_error (simple, error))
5927     return FALSE;
5928
5929   return TRUE;
5930 }
5931
5932
5933 /********************************************
5934  *   Default VFS operations                 *
5935  ********************************************/
5936
5937 /**
5938  * g_file_new_for_path:
5939  * @path: a string containing a relative or absolute path. The string
5940  *   must be encoded in the glib filename encoding.
5941  *
5942  * Constructs a #GFile for a given path. This operation never
5943  * fails, but the returned object might not support any I/O
5944  * operation if @path is malformed.
5945  *
5946  * Returns: (transfer full): a new #GFile for the given @path.
5947  *   Free the returned object with g_object_unref().
5948  **/
5949 GFile *
5950 g_file_new_for_path (const char *path)
5951 {
5952   g_return_val_if_fail (path != NULL, NULL);
5953
5954   return g_vfs_get_file_for_path (g_vfs_get_default (), path);
5955 }
5956
5957 /**
5958  * g_file_new_for_uri:
5959  * @uri: a UTF8 string containing a URI.
5960  *
5961  * Constructs a #GFile for a given URI. This operation never
5962  * fails, but the returned object might not support any I/O
5963  * operation if @uri is malformed or if the uri type is
5964  * not supported.
5965  *
5966  * Returns: (transfer full): a new #GFile for the given @uri.
5967  *   Free the returned object with g_object_unref().
5968  **/
5969 GFile *
5970 g_file_new_for_uri (const char *uri)
5971 {
5972   g_return_val_if_fail (uri != NULL, NULL);
5973
5974   return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
5975 }
5976
5977 /**
5978  * g_file_new_tmp:
5979  * @tmpl: (type filename) (allow-none): Template for the file
5980  *   name, as in g_file_open_tmp(), or %NULL for a default template.
5981  * @iostream: (out): on return, a #GFileIOStream for the created file.
5982  * @error: a #GError, or %NULL
5983  *
5984  * Opens a file in the preferred directory for temporary files (as
5985  * returned by g_get_tmp_dir()) and returns a #GFile and
5986  * #GFileIOStream pointing to it.
5987  *
5988  * @tmpl should be a string in the GLib file name encoding
5989  * containing a sequence of six 'X' characters, and containing no
5990  * directory components. If it is %NULL, a default template is used.
5991  *
5992  * Unlike the other #GFile constructors, this will return %NULL if
5993  * a temporary file could not be created.
5994  *
5995  * Returns: (transfer full): a new #GFile.
5996  *   Free the returned object with g_object_unref().
5997  *
5998  * Since: 2.32
5999  */
6000 GFile *
6001 g_file_new_tmp (const char     *tmpl,
6002                 GFileIOStream **iostream,
6003                 GError        **error)
6004 {
6005   gint fd;
6006   gchar *path;
6007   GFile *file;
6008   GFileOutputStream *output;
6009
6010   g_return_val_if_fail (iostream != NULL, NULL);
6011
6012   fd = g_file_open_tmp (tmpl, &path, error);
6013   if (fd == -1)
6014     return NULL;
6015
6016   file = g_file_new_for_path (path);
6017
6018   output = _g_local_file_output_stream_new (fd);
6019   *iostream = _g_local_file_io_stream_new (G_LOCAL_FILE_OUTPUT_STREAM (output));
6020
6021   g_object_unref (output);
6022   g_free (path);
6023
6024   return file;
6025 }
6026
6027 /**
6028  * g_file_parse_name:
6029  * @parse_name: a file name or path to be parsed.
6030  *
6031  * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
6032  * This operation never fails, but the returned object might not support any I/O
6033  * operation if the @parse_name cannot be parsed.
6034  *
6035  * Returns: (transfer full): a new #GFile.
6036  **/
6037 GFile *
6038 g_file_parse_name (const char *parse_name)
6039 {
6040   g_return_val_if_fail (parse_name != NULL, NULL);
6041
6042   return g_vfs_parse_name (g_vfs_get_default (), parse_name);
6043 }
6044
6045 static gboolean
6046 is_valid_scheme_character (char c)
6047 {
6048   return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
6049 }
6050
6051 /* Following RFC 2396, valid schemes are built like:
6052  *       scheme        = alpha *( alpha | digit | "+" | "-" | "." )
6053  */
6054 static gboolean
6055 has_valid_scheme (const char *uri)
6056 {
6057   const char *p;
6058
6059   p = uri;
6060
6061   if (!g_ascii_isalpha (*p))
6062     return FALSE;
6063
6064   do {
6065     p++;
6066   } while (is_valid_scheme_character (*p));
6067
6068   return *p == ':';
6069 }
6070
6071 /**
6072  * g_file_new_for_commandline_arg:
6073  * @arg: a command line string.
6074  *
6075  * Creates a #GFile with the given argument from the command line. The value of
6076  * @arg can be either a URI, an absolute path or a relative path resolved
6077  * relative to the current working directory.
6078  * This operation never fails, but the returned object might not support any
6079  * I/O operation if @arg points to a malformed path.
6080  *
6081  * Returns: (transfer full): a new #GFile.
6082  *  Free the returned object with g_object_unref().
6083  **/
6084 GFile *
6085 g_file_new_for_commandline_arg (const char *arg)
6086 {
6087   GFile *file;
6088   char *filename;
6089   char *current_dir;
6090
6091   g_return_val_if_fail (arg != NULL, NULL);
6092
6093   if (g_path_is_absolute (arg))
6094     return g_file_new_for_path (arg);
6095
6096   if (has_valid_scheme (arg))
6097     return g_file_new_for_uri (arg);
6098
6099   current_dir = g_get_current_dir ();
6100   filename = g_build_filename (current_dir, arg, NULL);
6101   g_free (current_dir);
6102
6103   file = g_file_new_for_path (filename);
6104   g_free (filename);
6105
6106   return file;
6107 }
6108
6109 /**
6110  * g_file_mount_enclosing_volume:
6111  * @location: input #GFile.
6112  * @flags: flags affecting the operation
6113  * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
6114  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6115  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
6116  * @user_data: the data to pass to callback function
6117  *
6118  * Starts a @mount_operation, mounting the volume that contains the file @location.
6119  *
6120  * When this operation has completed, @callback will be called with
6121  * @user_user data, and the operation can be finalized with
6122  * g_file_mount_enclosing_volume_finish().
6123  *
6124  * If @cancellable is not %NULL, then the operation can be cancelled by
6125  * triggering the cancellable object from another thread. If the operation
6126  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6127  **/
6128 void
6129 g_file_mount_enclosing_volume (GFile               *location,
6130                                GMountMountFlags     flags,
6131                                GMountOperation     *mount_operation,
6132                                GCancellable        *cancellable,
6133                                GAsyncReadyCallback  callback,
6134                                gpointer             user_data)
6135 {
6136   GFileIface *iface;
6137
6138   g_return_if_fail (G_IS_FILE (location));
6139
6140   iface = G_FILE_GET_IFACE (location);
6141
6142   if (iface->mount_enclosing_volume == NULL)
6143     {
6144       g_simple_async_report_error_in_idle (G_OBJECT (location),
6145                                            callback, user_data,
6146                                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
6147                                            _("volume doesn't implement mount"));
6148
6149       return;
6150     }
6151
6152   (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6153
6154 }
6155
6156 /**
6157  * g_file_mount_enclosing_volume_finish:
6158  * @location: input #GFile.
6159  * @result: a #GAsyncResult.
6160  * @error: a #GError, or %NULL
6161  *
6162  * Finishes a mount operation started by g_file_mount_enclosing_volume().
6163  *
6164  * Returns: %TRUE if successful. If an error
6165  * has occurred, this function will return %FALSE and set @error
6166  * appropriately if present.
6167  **/
6168 gboolean
6169 g_file_mount_enclosing_volume_finish (GFile         *location,
6170                                       GAsyncResult  *result,
6171                                       GError       **error)
6172 {
6173   GFileIface *iface;
6174
6175   g_return_val_if_fail (G_IS_FILE (location), FALSE);
6176   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6177
6178   if (g_async_result_legacy_propagate_error (result, error))
6179     return FALSE;
6180
6181   iface = G_FILE_GET_IFACE (location);
6182
6183   return (* iface->mount_enclosing_volume_finish) (location, result, error);
6184 }
6185
6186 /********************************************
6187  *   Utility functions                      *
6188  ********************************************/
6189
6190 /**
6191  * g_file_query_default_handler:
6192  * @file: a #GFile to open.
6193  * @cancellable: optional #GCancellable object, %NULL to ignore.
6194  * @error: a #GError, or %NULL
6195  *
6196  * Returns the #GAppInfo that is registered as the default
6197  * application to handle the file specified by @file.
6198  *
6199  * If @cancellable is not %NULL, then the operation can be cancelled by
6200  * triggering the cancellable object from another thread. If the operation
6201  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6202  *
6203  * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors.
6204  * When you are done with it, release it with g_object_unref()
6205  **/
6206 GAppInfo *
6207 g_file_query_default_handler (GFile                  *file,
6208                               GCancellable           *cancellable,
6209                               GError                **error)
6210 {
6211   char *uri_scheme;
6212   const char *content_type;
6213   GAppInfo *appinfo;
6214   GFileInfo *info;
6215   char *path;
6216
6217   uri_scheme = g_file_get_uri_scheme (file);
6218   if (uri_scheme && uri_scheme[0] != '\0')
6219     {
6220       appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
6221       g_free (uri_scheme);
6222
6223       if (appinfo != NULL)
6224         return appinfo;
6225     }
6226
6227   info = g_file_query_info (file,
6228                             G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6229                             0,
6230                             cancellable,
6231                             error);
6232   if (info == NULL)
6233     return NULL;
6234
6235   appinfo = NULL;
6236
6237   content_type = g_file_info_get_content_type (info);
6238   if (content_type)
6239     {
6240       /* Don't use is_native(), as we want to support fuse paths if available */
6241       path = g_file_get_path (file);
6242       appinfo = g_app_info_get_default_for_type (content_type,
6243                                                  path == NULL);
6244       g_free (path);
6245     }
6246
6247   g_object_unref (info);
6248
6249   if (appinfo != NULL)
6250     return appinfo;
6251
6252   g_set_error_literal (error, G_IO_ERROR,
6253                        G_IO_ERROR_NOT_SUPPORTED,
6254                        _("No application is registered as handling this file"));
6255   return NULL;
6256
6257 }
6258
6259
6260 #define GET_CONTENT_BLOCK_SIZE 8192
6261
6262 /**
6263  * g_file_load_contents:
6264  * @file: input #GFile.
6265  * @cancellable: optional #GCancellable object, %NULL to ignore.
6266  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6267  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6268  *    or %NULL if the length is not needed
6269  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6270  *    or %NULL if the entity tag is not needed
6271  * @error: a #GError, or %NULL
6272  *
6273  * Loads the content of the file into memory. The data is always
6274  * zero-terminated, but this is not included in the resultant @length.
6275  * The returned @content should be freed with g_free() when no longer
6276  * needed.
6277  *
6278  * If @cancellable is not %NULL, then the operation can be cancelled by
6279  * triggering the cancellable object from another thread. If the operation
6280  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6281  *
6282  * Returns: %TRUE if the @file's contents were successfully loaded.
6283  * %FALSE if there were errors.
6284  **/
6285 gboolean
6286 g_file_load_contents (GFile         *file,
6287                       GCancellable  *cancellable,
6288                       char         **contents,
6289                       gsize         *length,
6290                       char         **etag_out,
6291                       GError       **error)
6292 {
6293   GFileInputStream *in;
6294   GByteArray *content;
6295   gsize pos;
6296   gssize res;
6297   GFileInfo *info;
6298
6299   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6300   g_return_val_if_fail (contents != NULL, FALSE);
6301
6302   in = g_file_read (file, cancellable, error);
6303   if (in == NULL)
6304     return FALSE;
6305
6306   content = g_byte_array_new ();
6307   pos = 0;
6308
6309   g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6310   while ((res = g_input_stream_read (G_INPUT_STREAM (in),
6311                                      content->data + pos,
6312                                      GET_CONTENT_BLOCK_SIZE,
6313                                      cancellable, error)) > 0)
6314     {
6315       pos += res;
6316       g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6317     }
6318
6319   if (etag_out)
6320     {
6321       *etag_out = NULL;
6322
6323       info = g_file_input_stream_query_info (in,
6324                                              G_FILE_ATTRIBUTE_ETAG_VALUE,
6325                                              cancellable,
6326                                              NULL);
6327       if (info)
6328         {
6329           *etag_out = g_strdup (g_file_info_get_etag (info));
6330           g_object_unref (info);
6331         }
6332     }
6333
6334   /* Ignore errors on close */
6335   g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
6336   g_object_unref (in);
6337
6338   if (res < 0)
6339     {
6340       /* error is set already */
6341       g_byte_array_free (content, TRUE);
6342       return FALSE;
6343     }
6344
6345   if (length)
6346     *length = pos;
6347
6348   /* Zero terminate (we got an extra byte allocated for this */
6349   content->data[pos] = 0;
6350
6351   *contents = (char *)g_byte_array_free (content, FALSE);
6352
6353   return TRUE;
6354 }
6355
6356 typedef struct {
6357   GFile *file;
6358   GError *error;
6359   GCancellable *cancellable;
6360   GFileReadMoreCallback read_more_callback;
6361   GAsyncReadyCallback callback;
6362   gpointer user_data;
6363   GByteArray *content;
6364   gsize pos;
6365   char *etag;
6366 } LoadContentsData;
6367
6368
6369 static void
6370 load_contents_data_free (LoadContentsData *data)
6371 {
6372   if (data->error)
6373     g_error_free (data->error);
6374   if (data->cancellable)
6375     g_object_unref (data->cancellable);
6376   if (data->content)
6377     g_byte_array_free (data->content, TRUE);
6378   g_free (data->etag);
6379   g_object_unref (data->file);
6380   g_free (data);
6381 }
6382
6383 static void
6384 load_contents_close_callback (GObject      *obj,
6385                               GAsyncResult *close_res,
6386                               gpointer      user_data)
6387 {
6388   GInputStream *stream = G_INPUT_STREAM (obj);
6389   LoadContentsData *data = user_data;
6390   GSimpleAsyncResult *res;
6391
6392   /* Ignore errors here, we're only reading anyway */
6393   g_input_stream_close_finish (stream, close_res, NULL);
6394   g_object_unref (stream);
6395
6396   res = g_simple_async_result_new (G_OBJECT (data->file),
6397                                    data->callback,
6398                                    data->user_data,
6399                                    g_file_load_contents_async);
6400   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
6401   g_simple_async_result_complete (res);
6402   g_object_unref (res);
6403 }
6404
6405 static void
6406 load_contents_fstat_callback (GObject      *obj,
6407                               GAsyncResult *stat_res,
6408                               gpointer      user_data)
6409 {
6410   GInputStream *stream = G_INPUT_STREAM (obj);
6411   LoadContentsData *data = user_data;
6412   GFileInfo *info;
6413
6414   info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
6415                                                    stat_res, NULL);
6416   if (info)
6417     {
6418       data->etag = g_strdup (g_file_info_get_etag (info));
6419       g_object_unref (info);
6420     }
6421
6422   g_input_stream_close_async (stream, 0,
6423                               data->cancellable,
6424                               load_contents_close_callback, data);
6425 }
6426
6427 static void
6428 load_contents_read_callback (GObject      *obj,
6429                              GAsyncResult *read_res,
6430                              gpointer      user_data)
6431 {
6432   GInputStream *stream = G_INPUT_STREAM (obj);
6433   LoadContentsData *data = user_data;
6434   GError *error = NULL;
6435   gssize read_size;
6436
6437   read_size = g_input_stream_read_finish (stream, read_res, &error);
6438
6439   if (read_size < 0)
6440     {
6441       /* Error or EOF, close the file */
6442       data->error = error;
6443       g_input_stream_close_async (stream, 0,
6444                                   data->cancellable,
6445                                   load_contents_close_callback, data);
6446     }
6447   else if (read_size == 0)
6448     {
6449       g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6450                                             G_FILE_ATTRIBUTE_ETAG_VALUE,
6451                                             0,
6452                                             data->cancellable,
6453                                             load_contents_fstat_callback,
6454                                             data);
6455     }
6456   else if (read_size > 0)
6457     {
6458       data->pos += read_size;
6459
6460       g_byte_array_set_size (data->content,
6461                              data->pos + GET_CONTENT_BLOCK_SIZE);
6462
6463
6464       if (data->read_more_callback &&
6465           !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
6466         g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6467                                               G_FILE_ATTRIBUTE_ETAG_VALUE,
6468                                               0,
6469                                               data->cancellable,
6470                                               load_contents_fstat_callback,
6471                                               data);
6472       else
6473         g_input_stream_read_async (stream,
6474                                    data->content->data + data->pos,
6475                                    GET_CONTENT_BLOCK_SIZE,
6476                                    0,
6477                                    data->cancellable,
6478                                    load_contents_read_callback,
6479                                    data);
6480     }
6481 }
6482
6483 static void
6484 load_contents_open_callback (GObject      *obj,
6485                              GAsyncResult *open_res,
6486                              gpointer      user_data)
6487 {
6488   GFile *file = G_FILE (obj);
6489   GFileInputStream *stream;
6490   LoadContentsData *data = user_data;
6491   GError *error = NULL;
6492   GSimpleAsyncResult *res;
6493
6494   stream = g_file_read_finish (file, open_res, &error);
6495
6496   if (stream)
6497     {
6498       g_byte_array_set_size (data->content,
6499                              data->pos + GET_CONTENT_BLOCK_SIZE);
6500       g_input_stream_read_async (G_INPUT_STREAM (stream),
6501                                  data->content->data + data->pos,
6502                                  GET_CONTENT_BLOCK_SIZE,
6503                                  0,
6504                                  data->cancellable,
6505                                  load_contents_read_callback,
6506                                  data);
6507
6508     }
6509   else
6510     {
6511       res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6512                                                   data->callback,
6513                                                   data->user_data,
6514                                                   error);
6515       g_simple_async_result_complete (res);
6516       load_contents_data_free (data);
6517       g_object_unref (res);
6518     }
6519 }
6520
6521 /**
6522  * g_file_load_partial_contents_async: (skip)
6523  * @file: input #GFile.
6524  * @cancellable: optional #GCancellable object, %NULL to ignore.
6525  * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
6526  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6527  * @user_data: the data to pass to the callback functions.
6528  *
6529  * Reads the partial contents of a file. A #GFileReadMoreCallback should be
6530  * used to stop reading from the file when appropriate, else this function
6531  * will behave exactly as g_file_load_contents_async(). This operation
6532  * can be finished by g_file_load_partial_contents_finish().
6533  *
6534  * Users of this function should be aware that @user_data is passed to
6535  * both the @read_more_callback and the @callback.
6536  *
6537  * If @cancellable is not %NULL, then the operation can be cancelled by
6538  * triggering the cancellable object from another thread. If the operation
6539  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6540  **/
6541 void
6542 g_file_load_partial_contents_async (GFile                 *file,
6543                                     GCancellable          *cancellable,
6544                                     GFileReadMoreCallback  read_more_callback,
6545                                     GAsyncReadyCallback    callback,
6546                                     gpointer               user_data)
6547 {
6548   LoadContentsData *data;
6549
6550   g_return_if_fail (G_IS_FILE (file));
6551
6552   data = g_new0 (LoadContentsData, 1);
6553
6554   if (cancellable)
6555     data->cancellable = g_object_ref (cancellable);
6556   data->read_more_callback = read_more_callback;
6557   data->callback = callback;
6558   data->user_data = user_data;
6559   data->content = g_byte_array_new ();
6560   data->file = g_object_ref (file);
6561
6562   g_file_read_async (file,
6563                      0,
6564                      cancellable,
6565                      load_contents_open_callback,
6566                      data);
6567 }
6568
6569 /**
6570  * g_file_load_partial_contents_finish:
6571  * @file: input #GFile.
6572  * @res: a #GAsyncResult.
6573  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6574  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6575  *     or %NULL if the length is not needed
6576  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6577  *     or %NULL if the entity tag is not needed
6578  * @error: a #GError, or %NULL
6579  *
6580  * Finishes an asynchronous partial load operation that was started
6581  * with g_file_load_partial_contents_async(). The data is always
6582  * zero-terminated, but this is not included in the resultant @length.
6583  * The returned @content should be freed with g_free() when no longer
6584  * needed.
6585  *
6586  * Returns: %TRUE if the load was successful. If %FALSE and @error is
6587  * present, it will be set appropriately.
6588  **/
6589 gboolean
6590 g_file_load_partial_contents_finish (GFile         *file,
6591                                      GAsyncResult  *res,
6592                                      char         **contents,
6593                                      gsize         *length,
6594                                      char         **etag_out,
6595                                      GError       **error)
6596 {
6597   GSimpleAsyncResult *simple;
6598   LoadContentsData *data;
6599
6600   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6601   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
6602   g_return_val_if_fail (contents != NULL, FALSE);
6603
6604   simple = G_SIMPLE_ASYNC_RESULT (res);
6605
6606   if (g_simple_async_result_propagate_error (simple, error))
6607     return FALSE;
6608
6609   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
6610
6611   data = g_simple_async_result_get_op_res_gpointer (simple);
6612
6613   if (data->error)
6614     {
6615       g_propagate_error (error, data->error);
6616       data->error = NULL;
6617       *contents = NULL;
6618       if (length)
6619         *length = 0;
6620       return FALSE;
6621     }
6622
6623   if (length)
6624     *length = data->pos;
6625
6626   if (etag_out)
6627     {
6628       *etag_out = data->etag;
6629       data->etag = NULL;
6630     }
6631
6632   /* Zero terminate */
6633   g_byte_array_set_size (data->content, data->pos + 1);
6634   data->content->data[data->pos] = 0;
6635
6636   *contents = (char *)g_byte_array_free (data->content, FALSE);
6637   data->content = NULL;
6638
6639   return TRUE;
6640 }
6641
6642 /**
6643  * g_file_load_contents_async:
6644  * @file: input #GFile.
6645  * @cancellable: optional #GCancellable object, %NULL to ignore.
6646  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6647  * @user_data: the data to pass to callback function
6648  *
6649  * Starts an asynchronous load of the @file's contents.
6650  *
6651  * For more details, see g_file_load_contents() which is
6652  * the synchronous version of this call.
6653  *
6654  * When the load operation has completed, @callback will be called
6655  * with @user data. To finish the operation, call
6656  * g_file_load_contents_finish() with the #GAsyncResult returned by
6657  * the @callback.
6658  *
6659  * If @cancellable is not %NULL, then the operation can be cancelled by
6660  * triggering the cancellable object from another thread. If the operation
6661  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6662  **/
6663 void
6664 g_file_load_contents_async (GFile               *file,
6665                            GCancellable        *cancellable,
6666                            GAsyncReadyCallback  callback,
6667                            gpointer             user_data)
6668 {
6669   g_file_load_partial_contents_async (file,
6670                                       cancellable,
6671                                       NULL,
6672                                       callback, user_data);
6673 }
6674
6675 /**
6676  * g_file_load_contents_finish:
6677  * @file: input #GFile.
6678  * @res: a #GAsyncResult.
6679  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6680  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6681  *     or %NULL if the length is not needed
6682  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6683  *     or %NULL if the entity tag is not needed
6684  * @error: a #GError, or %NULL
6685  *
6686  * Finishes an asynchronous load of the @file's contents.
6687  * The contents are placed in @contents, and @length is set to the
6688  * size of the @contents string. The @content should be freed with
6689  * g_free() when no longer needed. If @etag_out is present, it will be
6690  * set to the new entity tag for the @file.
6691  *
6692  * Returns: %TRUE if the load was successful. If %FALSE and @error is
6693  * present, it will be set appropriately.
6694  **/
6695 gboolean
6696 g_file_load_contents_finish (GFile         *file,
6697                              GAsyncResult  *res,
6698                              char         **contents,
6699                              gsize         *length,
6700                              char         **etag_out,
6701                              GError       **error)
6702 {
6703   return g_file_load_partial_contents_finish (file,
6704                                               res,
6705                                               contents,
6706                                               length,
6707                                               etag_out,
6708                                               error);
6709 }
6710
6711 /**
6712  * g_file_replace_contents:
6713  * @file: input #GFile.
6714  * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file.
6715  * @length: the length of @contents in bytes.
6716  * @etag: (allow-none): the old <link linkend="gfile-etag">entity tag</link>
6717  *     for the document, or %NULL
6718  * @make_backup: %TRUE if a backup should be created.
6719  * @flags: a set of #GFileCreateFlags.
6720  * @new_etag: (allow-none) (out): a location to a new <link linkend="gfile-etag">entity tag</link>
6721  *      for the document. This should be freed with g_free() when no longer
6722  *      needed, or %NULL
6723  * @cancellable: optional #GCancellable object, %NULL to ignore.
6724  * @error: a #GError, or %NULL
6725  *
6726  * Replaces the contents of @file with @contents of @length bytes.
6727
6728  * If @etag is specified (not %NULL) any existing file must have that etag, or
6729  * the error %G_IO_ERROR_WRONG_ETAG will be returned.
6730  *
6731  * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
6732  *
6733  * If @cancellable is not %NULL, then the operation can be cancelled by
6734  * triggering the cancellable object from another thread. If the operation
6735  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6736  *
6737  * The returned @new_etag can be used to verify that the file hasn't changed the
6738  * next time it is saved over.
6739  *
6740  * Returns: %TRUE if successful. If an error
6741  * has occurred, this function will return %FALSE and set @error
6742  * appropriately if present.
6743  **/
6744 gboolean
6745 g_file_replace_contents (GFile             *file,
6746                          const char        *contents,
6747                          gsize              length,
6748                          const char        *etag,
6749                          gboolean           make_backup,
6750                          GFileCreateFlags   flags,
6751                          char             **new_etag,
6752                          GCancellable      *cancellable,
6753                          GError           **error)
6754 {
6755   GFileOutputStream *out;
6756   gsize pos, remainder;
6757   gssize res;
6758   gboolean ret;
6759
6760   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6761   g_return_val_if_fail (contents != NULL, FALSE);
6762
6763   out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
6764   if (out == NULL)
6765     return FALSE;
6766
6767   pos = 0;
6768   remainder = length;
6769   while (remainder > 0 &&
6770          (res = g_output_stream_write (G_OUTPUT_STREAM (out),
6771                                        contents + pos,
6772                                        MIN (remainder, GET_CONTENT_BLOCK_SIZE),
6773                                        cancellable,
6774                                        error)) > 0)
6775     {
6776       pos += res;
6777       remainder -= res;
6778     }
6779
6780   if (remainder > 0 && res < 0)
6781     {
6782       /* Ignore errors on close */
6783       g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
6784       g_object_unref (out);
6785
6786       /* error is set already */
6787       return FALSE;
6788     }
6789
6790   ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
6791
6792   if (new_etag)
6793     *new_etag = g_file_output_stream_get_etag (out);
6794
6795   g_object_unref (out);
6796
6797   return ret;
6798 }
6799
6800 typedef struct {
6801   GFile *file;
6802   GError *error;
6803   GCancellable *cancellable;
6804   GAsyncReadyCallback callback;
6805   gpointer user_data;
6806   const char *content;
6807   gsize length;
6808   gsize pos;
6809   char *etag;
6810 } ReplaceContentsData;
6811
6812 static void
6813 replace_contents_data_free (ReplaceContentsData *data)
6814 {
6815   if (data->error)
6816     g_error_free (data->error);
6817   if (data->cancellable)
6818     g_object_unref (data->cancellable);
6819   g_object_unref (data->file);
6820   g_free (data->etag);
6821   g_free (data);
6822 }
6823
6824 static void
6825 replace_contents_close_callback (GObject      *obj,
6826                                  GAsyncResult *close_res,
6827                                  gpointer      user_data)
6828 {
6829   GOutputStream *stream = G_OUTPUT_STREAM (obj);
6830   ReplaceContentsData *data = user_data;
6831   GSimpleAsyncResult *res;
6832
6833   /* Ignore errors here, we're only reading anyway */
6834   g_output_stream_close_finish (stream, close_res, NULL);
6835   g_object_unref (stream);
6836
6837   data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
6838
6839   res = g_simple_async_result_new (G_OBJECT (data->file),
6840                                    data->callback,
6841                                    data->user_data,
6842                                    g_file_replace_contents_async);
6843   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
6844   g_simple_async_result_complete (res);
6845   g_object_unref (res);
6846 }
6847
6848 static void
6849 replace_contents_write_callback (GObject      *obj,
6850                                  GAsyncResult *read_res,
6851                                  gpointer      user_data)
6852 {
6853   GOutputStream *stream = G_OUTPUT_STREAM (obj);
6854   ReplaceContentsData *data = user_data;
6855   GError *error = NULL;
6856   gssize write_size;
6857
6858   write_size = g_output_stream_write_finish (stream, read_res, &error);
6859
6860   if (write_size <= 0)
6861     {
6862       /* Error or EOF, close the file */
6863       if (write_size < 0)
6864         data->error = error;
6865       g_output_stream_close_async (stream, 0,
6866                                    data->cancellable,
6867                                    replace_contents_close_callback, data);
6868     }
6869   else if (write_size > 0)
6870     {
6871       data->pos += write_size;
6872
6873       if (data->pos >= data->length)
6874         g_output_stream_close_async (stream, 0,
6875                                      data->cancellable,
6876                                      replace_contents_close_callback, data);
6877       else
6878         g_output_stream_write_async (stream,
6879                                      data->content + data->pos,
6880                                      data->length - data->pos,
6881                                      0,
6882                                      data->cancellable,
6883                                      replace_contents_write_callback,
6884                                      data);
6885     }
6886 }
6887
6888 static void
6889 replace_contents_open_callback (GObject      *obj,
6890                                 GAsyncResult *open_res,
6891                                 gpointer      user_data)
6892 {
6893   GFile *file = G_FILE (obj);
6894   GFileOutputStream *stream;
6895   ReplaceContentsData *data = user_data;
6896   GError *error = NULL;
6897   GSimpleAsyncResult *res;
6898
6899   stream = g_file_replace_finish (file, open_res, &error);
6900
6901   if (stream)
6902     {
6903       g_output_stream_write_async (G_OUTPUT_STREAM (stream),
6904                                    data->content + data->pos,
6905                                    data->length - data->pos,
6906                                    0,
6907                                    data->cancellable,
6908                                    replace_contents_write_callback,
6909                                    data);
6910
6911     }
6912   else
6913     {
6914       res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6915                                                   data->callback,
6916                                                   data->user_data,
6917                                                   error);
6918       g_simple_async_result_complete (res);
6919       replace_contents_data_free (data);
6920       g_object_unref (res);
6921     }
6922 }
6923
6924 /**
6925  * g_file_replace_contents_async:
6926  * @file: input #GFile.
6927  * @contents: (element-type guint8) (array length=length): string of contents to replace the file with.
6928  * @length: the length of @contents in bytes.
6929  * @etag: (allow-none): a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
6930  * @make_backup: %TRUE if a backup should be created.
6931  * @flags: a set of #GFileCreateFlags.
6932  * @cancellable: optional #GCancellable object, %NULL to ignore.
6933  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6934  * @user_data: the data to pass to callback function
6935  *
6936  * Starts an asynchronous replacement of @file with the given
6937  * @contents of @length bytes. @etag will replace the document's
6938  * current entity tag.
6939  *
6940  * When this operation has completed, @callback will be called with
6941  * @user_user data, and the operation can be finalized with
6942  * g_file_replace_contents_finish().
6943  *
6944  * If @cancellable is not %NULL, then the operation can be cancelled by
6945  * triggering the cancellable object from another thread. If the operation
6946  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6947  *
6948  * If @make_backup is %TRUE, this function will attempt to
6949  * make a backup of @file.
6950  **/
6951 void
6952 g_file_replace_contents_async  (GFile               *file,
6953                                 const char          *contents,
6954                                 gsize                length,
6955                                 const char          *etag,
6956                                 gboolean             make_backup,
6957                                 GFileCreateFlags     flags,
6958                                 GCancellable        *cancellable,
6959                                 GAsyncReadyCallback  callback,
6960                                 gpointer             user_data)
6961 {
6962   ReplaceContentsData *data;
6963
6964   g_return_if_fail (G_IS_FILE (file));
6965   g_return_if_fail (contents != NULL);
6966
6967   data = g_new0 (ReplaceContentsData, 1);
6968
6969   if (cancellable)
6970     data->cancellable = g_object_ref (cancellable);
6971   data->callback = callback;
6972   data->user_data = user_data;
6973   data->content = contents;
6974   data->length = length;
6975   data->pos = 0;
6976   data->file = g_object_ref (file);
6977
6978   g_file_replace_async (file,
6979                         etag,
6980                         make_backup,
6981                         flags,
6982                         0,
6983                         cancellable,
6984                         replace_contents_open_callback,
6985                         data);
6986 }
6987
6988 /**
6989  * g_file_replace_contents_finish:
6990  * @file: input #GFile.
6991  * @res: a #GAsyncResult.
6992  * @new_etag: (out) (allow-none): a location of a new <link linkend="gfile-etag">entity tag</link>
6993  *     for the document. This should be freed with g_free() when it is no
6994  *     longer needed, or %NULL
6995  * @error: a #GError, or %NULL
6996  *
6997  * Finishes an asynchronous replace of the given @file. See
6998  * g_file_replace_contents_async(). Sets @new_etag to the new entity
6999  * tag for the document, if present.
7000  *
7001  * Returns: %TRUE on success, %FALSE on failure.
7002  **/
7003 gboolean
7004 g_file_replace_contents_finish (GFile         *file,
7005                                 GAsyncResult  *res,
7006                                 char         **new_etag,
7007                                 GError       **error)
7008 {
7009   GSimpleAsyncResult *simple;
7010   ReplaceContentsData *data;
7011
7012   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7013   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
7014
7015   simple = G_SIMPLE_ASYNC_RESULT (res);
7016
7017   if (g_simple_async_result_propagate_error (simple, error))
7018     return FALSE;
7019
7020   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
7021
7022   data = g_simple_async_result_get_op_res_gpointer (simple);
7023
7024   if (data->error)
7025     {
7026       g_propagate_error (error, data->error);
7027       data->error = NULL;
7028       return FALSE;
7029     }
7030
7031
7032   if (new_etag)
7033     {
7034       *new_etag = data->etag;
7035       data->etag = NULL; /* Take ownership */
7036     }
7037
7038   return TRUE;
7039 }
7040
7041 /**
7042  * g_file_start_mountable:
7043  * @file: input #GFile.
7044  * @flags: flags affecting the operation
7045  * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
7046  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7047  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7048  * @user_data: the data to pass to callback function
7049  *
7050  * Starts a file of type G_FILE_TYPE_MOUNTABLE.
7051  * Using @start_operation, you can request callbacks when, for instance,
7052  * passwords are needed during authentication.
7053  *
7054  * If @cancellable is not %NULL, then the operation can be cancelled by
7055  * triggering the cancellable object from another thread. If the operation
7056  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7057  *
7058  * When the operation is finished, @callback will be called. You can then call
7059  * g_file_mount_mountable_finish() to get the result of the operation.
7060  *
7061  * Since: 2.22
7062  */
7063 void
7064 g_file_start_mountable (GFile                      *file,
7065                         GDriveStartFlags            flags,
7066                         GMountOperation            *start_operation,
7067                         GCancellable               *cancellable,
7068                         GAsyncReadyCallback         callback,
7069                         gpointer                    user_data)
7070 {
7071   GFileIface *iface;
7072
7073   g_return_if_fail (G_IS_FILE (file));
7074
7075   iface = G_FILE_GET_IFACE (file);
7076
7077   if (iface->start_mountable == NULL)
7078     {
7079       g_simple_async_report_error_in_idle (G_OBJECT (file),
7080                                            callback,
7081                                            user_data,
7082                                            G_IO_ERROR,
7083                                            G_IO_ERROR_NOT_SUPPORTED,
7084                                            _("Operation not supported"));
7085       return;
7086     }
7087
7088   (* iface->start_mountable) (file,
7089                               flags,
7090                               start_operation,
7091                               cancellable,
7092                               callback,
7093                               user_data);
7094 }
7095
7096 /**
7097  * g_file_start_mountable_finish:
7098  * @file: input #GFile.
7099  * @result: a #GAsyncResult.
7100  * @error: a #GError, or %NULL
7101  *
7102  * Finishes a start operation. See g_file_start_mountable() for details.
7103  *
7104  * Finish an asynchronous start operation that was started
7105  * with g_file_start_mountable().
7106  *
7107  * Returns: %TRUE if the operation finished successfully. %FALSE
7108  * otherwise.
7109  *
7110  * Since: 2.22
7111  */
7112 gboolean
7113 g_file_start_mountable_finish (GFile                      *file,
7114                                GAsyncResult               *result,
7115                                GError                    **error)
7116 {
7117   GFileIface *iface;
7118
7119   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7120   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7121
7122   if (g_async_result_legacy_propagate_error (result, error))
7123     return FALSE;
7124
7125   iface = G_FILE_GET_IFACE (file);
7126   return (* iface->start_mountable_finish) (file, result, error);
7127 }
7128
7129 /**
7130  * g_file_stop_mountable:
7131  * @file: input #GFile.
7132  * @flags: flags affecting the operation
7133  * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
7134  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7135  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7136  * @user_data: the data to pass to callback function
7137  *
7138  * Stops a file of type G_FILE_TYPE_MOUNTABLE.
7139  *
7140  * If @cancellable is not %NULL, then the operation can be cancelled by
7141  * triggering the cancellable object from another thread. If the operation
7142  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7143  *
7144  * When the operation is finished, @callback will be called. You can then call
7145  * g_file_stop_mountable_finish() to get the result of the operation.
7146  *
7147  * Since: 2.22
7148  */
7149 void
7150 g_file_stop_mountable (GFile                      *file,
7151                        GMountUnmountFlags          flags,
7152                        GMountOperation            *mount_operation,
7153                        GCancellable               *cancellable,
7154                        GAsyncReadyCallback         callback,
7155                        gpointer                    user_data)
7156 {
7157   GFileIface *iface;
7158
7159   g_return_if_fail (G_IS_FILE (file));
7160
7161   iface = G_FILE_GET_IFACE (file);
7162
7163   if (iface->stop_mountable == NULL)
7164     {
7165       g_simple_async_report_error_in_idle (G_OBJECT (file),
7166                                            callback,
7167                                            user_data,
7168                                            G_IO_ERROR,
7169                                            G_IO_ERROR_NOT_SUPPORTED,
7170                                            _("Operation not supported"));
7171       return;
7172     }
7173
7174   (* iface->stop_mountable) (file,
7175                              flags,
7176                              mount_operation,
7177                              cancellable,
7178                              callback,
7179                              user_data);
7180 }
7181
7182 /**
7183  * g_file_stop_mountable_finish:
7184  * @file: input #GFile.
7185  * @result: a #GAsyncResult.
7186  * @error: a #GError, or %NULL
7187  *
7188  * Finishes an stop operation, see g_file_stop_mountable() for details.
7189  *
7190  * Finish an asynchronous stop operation that was started
7191  * with g_file_stop_mountable().
7192  *
7193  * Returns: %TRUE if the operation finished successfully. %FALSE
7194  * otherwise.
7195  *
7196  * Since: 2.22
7197  */
7198 gboolean
7199 g_file_stop_mountable_finish (GFile                      *file,
7200                               GAsyncResult               *result,
7201                               GError                    **error)
7202 {
7203   GFileIface *iface;
7204
7205   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7206   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7207
7208   if (g_async_result_legacy_propagate_error (result, error))
7209     return FALSE;
7210
7211   iface = G_FILE_GET_IFACE (file);
7212   return (* iface->stop_mountable_finish) (file, result, error);
7213 }
7214
7215 /**
7216  * g_file_poll_mountable:
7217  * @file: input #GFile.
7218  * @cancellable: optional #GCancellable object, %NULL to ignore.
7219  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7220  * @user_data: the data to pass to callback function
7221  *
7222  * Polls a file of type G_FILE_TYPE_MOUNTABLE.
7223  *
7224  * If @cancellable is not %NULL, then the operation can be cancelled by
7225  * triggering the cancellable object from another thread. If the operation
7226  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7227  *
7228  * When the operation is finished, @callback will be called. You can then call
7229  * g_file_mount_mountable_finish() to get the result of the operation.
7230  *
7231  * Since: 2.22
7232  */
7233 void
7234 g_file_poll_mountable (GFile                      *file,
7235                        GCancellable               *cancellable,
7236                        GAsyncReadyCallback         callback,
7237                        gpointer                    user_data)
7238 {
7239   GFileIface *iface;
7240
7241   g_return_if_fail (G_IS_FILE (file));
7242
7243   iface = G_FILE_GET_IFACE (file);
7244
7245   if (iface->poll_mountable == NULL)
7246     {
7247       g_simple_async_report_error_in_idle (G_OBJECT (file),
7248                                            callback,
7249                                            user_data,
7250                                            G_IO_ERROR,
7251                                            G_IO_ERROR_NOT_SUPPORTED,
7252                                            _("Operation not supported"));
7253       return;
7254     }
7255
7256   (* iface->poll_mountable) (file,
7257                              cancellable,
7258                              callback,
7259                              user_data);
7260 }
7261
7262 /**
7263  * g_file_poll_mountable_finish:
7264  * @file: input #GFile.
7265  * @result: a #GAsyncResult.
7266  * @error: a #GError, or %NULL
7267  *
7268  * Finishes a poll operation. See g_file_poll_mountable() for details.
7269  *
7270  * Finish an asynchronous poll operation that was polled
7271  * with g_file_poll_mountable().
7272  *
7273  * Returns: %TRUE if the operation finished successfully. %FALSE
7274  * otherwise.
7275  *
7276  * Since: 2.22
7277  */
7278 gboolean
7279 g_file_poll_mountable_finish (GFile                      *file,
7280                               GAsyncResult               *result,
7281                               GError                    **error)
7282 {
7283   GFileIface *iface;
7284
7285   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7286   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7287
7288   if (g_async_result_legacy_propagate_error (result, error))
7289     return FALSE;
7290
7291   iface = G_FILE_GET_IFACE (file);
7292   return (* iface->poll_mountable_finish) (file, result, error);
7293 }
7294
7295 /**
7296  * g_file_supports_thread_contexts:
7297  * @file: a #GFile.
7298  *
7299  * Checks if @file supports <link
7300  * linkend="g-main-context-push-thread-default-context">thread-default
7301  * contexts</link>. If this returns %FALSE, you cannot perform
7302  * asynchronous operations on @file in a thread that has a
7303  * thread-default context.
7304  *
7305  * Returns: Whether or not @file supports thread-default contexts.
7306  *
7307  * Since: 2.22
7308  */
7309 gboolean
7310 g_file_supports_thread_contexts (GFile *file)
7311 {
7312  GFileIface *iface;
7313
7314  g_return_val_if_fail (G_IS_FILE (file), FALSE);
7315
7316  iface = G_FILE_GET_IFACE (file);
7317  return iface->supports_thread_contexts;
7318 }