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