1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
21 * David Zeuthen <davidz@redhat.com>
27 #include "gasyncresult.h"
28 #include "gsimpleasyncresult.h"
35 * @short_description: Volume management
38 * The #GVolume interface represents user-visible objects that can be
39 * mounted. Note, when porting from GnomeVFS, #GVolume is the moral
40 * equivalent of #GnomeVFSDrive.
42 * Mounting a #GVolume instance is an asynchronous operation. For more
43 * information about asynchronous operations, see #GAsyncReady and
44 * #GSimpleAsyncReady. To mount a #GVolume, first call
45 * g_volume_mount() with (at least) the #GVolume instance, optionally
46 * a #GMountOperation object and a #GAsyncReadyCallback.
48 * Typically, one will only want to pass %NULL for the
49 * #GMountOperation if automounting all volumes when a desktop session
50 * starts since it's not desirable to put up a lot of dialogs asking
53 * The callback will be fired when the operation has resolved (either
54 * with success or failure), and a #GAsyncReady structure will be
55 * passed to the callback. That callback should then call
56 * g_volume_mount_finish() with the #GVolume instance and the
57 * #GAsyncReady data to see if the operation was completed
58 * successfully. If an @error is present when g_volume_mount_finish()
59 * is called, then it will be filled with any error information.
61 * <para id="volume-identifier">
62 * It is sometimes necessary to directly access the underlying
63 * operating system object behind a volume (e.g. for passing a volume
64 * to an application via the commandline). For this purpose, GIO
65 * allows to obtain an 'identifier' for the volume. There can be
66 * different kinds of identifiers, such as Hal UDIs, filesystem labels,
67 * traditional Unix devices (e.g. <filename>/dev/sda2</filename>),
68 * uuids. GIO uses predefind strings as names for the different kinds
69 * of identifiers: #G_VOLUME_IDENTIFIER_KIND_HAL_UDI,
70 * #G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use g_volume_get_identifier()
71 * to obtain an identifier for a volume.
74 * Note that #G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available
75 * when the gvfs hal volume monitor is in use. Other volume monitors
76 * will generally be able to provide the #G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE
77 * identifier, which can be used to obtain a hal device by means of
78 * libhal_manger_find_device_string_match().
81 typedef GVolumeIface GVolumeInterface;
82 G_DEFINE_INTERFACE(GVolume, g_volume, G_TYPE_OBJECT)
85 g_volume_default_init (GVolumeInterface *iface)
90 * Emitted when the volume has been changed.
92 g_signal_new (I_("changed"),
95 G_STRUCT_OFFSET (GVolumeIface, changed),
97 g_cclosure_marshal_VOID__VOID,
103 * This signal is emitted when the #GVolume have been removed. If
104 * the recipient is holding references to the object they should
105 * release them so the object can be finalized.
107 g_signal_new (I_("removed"),
110 G_STRUCT_OFFSET (GVolumeIface, removed),
112 g_cclosure_marshal_VOID__VOID,
118 * @volume: a #GVolume.
120 * Gets the name of @volume.
122 * Returns: the name for the given @volume. The returned string should
123 * be freed with g_free() when no longer needed.
126 g_volume_get_name (GVolume *volume)
130 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
132 iface = G_VOLUME_GET_IFACE (volume);
134 return (* iface->get_name) (volume);
139 * @volume: a #GVolume.
141 * Gets the icon for @volume.
143 * Returns: (transfer full): a #GIcon.
144 * The returned object should be unreffed with g_object_unref()
145 * when no longer needed.
148 g_volume_get_icon (GVolume *volume)
152 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
154 iface = G_VOLUME_GET_IFACE (volume);
156 return (* iface->get_icon) (volume);
161 * @volume: a #GVolume.
163 * Gets the UUID for the @volume. The reference is typically based on
164 * the file system UUID for the volume in question and should be
165 * considered an opaque string. Returns %NULL if there is no UUID
168 * Returns: the UUID for @volume or %NULL if no UUID can be computed.
169 * The returned string should be freed with g_free()
170 * when no longer needed.
173 g_volume_get_uuid (GVolume *volume)
177 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
179 iface = G_VOLUME_GET_IFACE (volume);
181 return (* iface->get_uuid) (volume);
185 * g_volume_get_drive:
186 * @volume: a #GVolume.
188 * Gets the drive for the @volume.
190 * Returns: (transfer full): a #GDrive or %NULL if @volume is not associated with a drive.
191 * The returned object should be unreffed with g_object_unref()
192 * when no longer needed.
195 g_volume_get_drive (GVolume *volume)
199 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
201 iface = G_VOLUME_GET_IFACE (volume);
203 return (* iface->get_drive) (volume);
207 * g_volume_get_mount:
208 * @volume: a #GVolume.
210 * Gets the mount for the @volume.
212 * Returns: (transfer full): a #GMount or %NULL if @volume isn't mounted.
213 * The returned object should be unreffed with g_object_unref()
214 * when no longer needed.
217 g_volume_get_mount (GVolume *volume)
221 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
223 iface = G_VOLUME_GET_IFACE (volume);
225 return (* iface->get_mount) (volume);
230 * g_volume_can_mount:
231 * @volume: a #GVolume.
233 * Checks if a volume can be mounted.
235 * Returns: %TRUE if the @volume can be mounted. %FALSE otherwise.
238 g_volume_can_mount (GVolume *volume)
242 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
244 iface = G_VOLUME_GET_IFACE (volume);
246 if (iface->can_mount == NULL)
249 return (* iface->can_mount) (volume);
253 * g_volume_can_eject:
254 * @volume: a #GVolume.
256 * Checks if a volume can be ejected.
258 * Returns: %TRUE if the @volume can be ejected. %FALSE otherwise.
261 g_volume_can_eject (GVolume *volume)
265 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
267 iface = G_VOLUME_GET_IFACE (volume);
269 if (iface->can_eject == NULL)
272 return (* iface->can_eject) (volume);
276 * g_volume_should_automount:
277 * @volume: a #GVolume
279 * Returns whether the volume should be automatically mounted.
281 * Returns: %TRUE if the volume should be automatically mounted.
284 g_volume_should_automount (GVolume *volume)
288 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
290 iface = G_VOLUME_GET_IFACE (volume);
292 if (iface->should_automount == NULL)
295 return (* iface->should_automount) (volume);
301 * @volume: a #GVolume.
302 * @flags: flags affecting the operation
303 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
304 * @cancellable: optional #GCancellable object, %NULL to ignore.
305 * @callback: a #GAsyncReadyCallback, or %NULL.
306 * @user_data: user data that gets passed to @callback
308 * Mounts a volume. This is an asynchronous operation, and is
309 * finished by calling g_volume_mount_finish() with the @volume
310 * and #GAsyncResult returned in the @callback.
313 g_volume_mount (GVolume *volume,
314 GMountMountFlags flags,
315 GMountOperation *mount_operation,
316 GCancellable *cancellable,
317 GAsyncReadyCallback callback,
322 g_return_if_fail (G_IS_VOLUME (volume));
324 iface = G_VOLUME_GET_IFACE (volume);
326 if (iface->mount_fn == NULL)
328 g_simple_async_report_error_in_idle (G_OBJECT (volume), callback, user_data,
329 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
330 _("volume doesn't implement mount"));
335 (* iface->mount_fn) (volume, flags, mount_operation, cancellable, callback, user_data);
339 * g_volume_mount_finish:
340 * @volume: a #GVolume
341 * @result: a #GAsyncResult
342 * @error: a #GError location to store an error, or %NULL to ignore
344 * Finishes mounting a volume. If any errors occured during the operation,
345 * @error will be set to contain the errors and %FALSE will be returned.
347 * If the mount operation succeeded, g_volume_get_mount() on @volume
348 * is guaranteed to return the mount right after calling this
349 * function; there's no need to listen for the 'mount-added' signal on
352 * Returns: %TRUE, %FALSE if operation failed.
355 g_volume_mount_finish (GVolume *volume,
356 GAsyncResult *result,
361 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
362 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
364 if (G_IS_SIMPLE_ASYNC_RESULT (result))
366 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
367 if (g_simple_async_result_propagate_error (simple, error))
371 iface = G_VOLUME_GET_IFACE (volume);
372 return (* iface->mount_finish) (volume, result, error);
377 * @volume: a #GVolume.
378 * @flags: flags affecting the unmount if required for eject
379 * @cancellable: optional #GCancellable object, %NULL to ignore.
380 * @callback: a #GAsyncReadyCallback, or %NULL.
381 * @user_data: user data that gets passed to @callback
383 * Ejects a volume. This is an asynchronous operation, and is
384 * finished by calling g_volume_eject_finish() with the @volume
385 * and #GAsyncResult returned in the @callback.
387 * Deprecated: 2.22: Use g_volume_eject_with_operation() instead.
390 g_volume_eject (GVolume *volume,
391 GMountUnmountFlags flags,
392 GCancellable *cancellable,
393 GAsyncReadyCallback callback,
398 g_return_if_fail (G_IS_VOLUME (volume));
400 iface = G_VOLUME_GET_IFACE (volume);
402 if (iface->eject == NULL)
404 g_simple_async_report_error_in_idle (G_OBJECT (volume), callback, user_data,
405 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
406 _("volume doesn't implement eject"));
411 (* iface->eject) (volume, flags, cancellable, callback, user_data);
415 * g_volume_eject_finish:
416 * @volume: pointer to a #GVolume.
417 * @result: a #GAsyncResult.
418 * @error: a #GError location to store an error, or %NULL to ignore
420 * Finishes ejecting a volume. If any errors occured during the operation,
421 * @error will be set to contain the errors and %FALSE will be returned.
423 * Returns: %TRUE, %FALSE if operation failed.
425 * Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead.
428 g_volume_eject_finish (GVolume *volume,
429 GAsyncResult *result,
434 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
435 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
437 if (G_IS_SIMPLE_ASYNC_RESULT (result))
439 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
440 if (g_simple_async_result_propagate_error (simple, error))
444 iface = G_VOLUME_GET_IFACE (volume);
445 return (* iface->eject_finish) (volume, result, error);
449 * g_volume_eject_with_operation:
450 * @volume: a #GVolume.
451 * @flags: flags affecting the unmount if required for eject
452 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
453 * @cancellable: optional #GCancellable object, %NULL to ignore.
454 * @callback: a #GAsyncReadyCallback, or %NULL.
455 * @user_data: user data passed to @callback.
457 * Ejects a volume. This is an asynchronous operation, and is
458 * finished by calling g_volume_eject_with_operation_finish() with the @volume
459 * and #GAsyncResult data returned in the @callback.
464 g_volume_eject_with_operation (GVolume *volume,
465 GMountUnmountFlags flags,
466 GMountOperation *mount_operation,
467 GCancellable *cancellable,
468 GAsyncReadyCallback callback,
473 g_return_if_fail (G_IS_VOLUME (volume));
475 iface = G_VOLUME_GET_IFACE (volume);
477 if (iface->eject == NULL && iface->eject_with_operation == NULL)
479 g_simple_async_report_error_in_idle (G_OBJECT (volume),
481 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
482 /* Translators: This is an error
483 * message for volume objects that
484 * don't implement any of eject or eject_with_operation. */
485 _("volume doesn't implement eject or eject_with_operation"));
489 if (iface->eject_with_operation != NULL)
490 (* iface->eject_with_operation) (volume, flags, mount_operation, cancellable, callback, user_data);
492 (* iface->eject) (volume, flags, cancellable, callback, user_data);
496 * g_volume_eject_with_operation_finish:
497 * @volume: a #GVolume.
498 * @result: a #GAsyncResult.
499 * @error: a #GError location to store the error occuring, or %NULL to
502 * Finishes ejecting a volume. If any errors occurred during the operation,
503 * @error will be set to contain the errors and %FALSE will be returned.
505 * Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise.
510 g_volume_eject_with_operation_finish (GVolume *volume,
511 GAsyncResult *result,
516 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
517 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
519 if (G_IS_SIMPLE_ASYNC_RESULT (result))
521 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
522 if (g_simple_async_result_propagate_error (simple, error))
526 iface = G_VOLUME_GET_IFACE (volume);
527 if (iface->eject_with_operation_finish != NULL)
528 return (* iface->eject_with_operation_finish) (volume, result, error);
530 return (* iface->eject_finish) (volume, result, error);
534 * g_volume_get_identifier:
535 * @volume: a #GVolume
536 * @kind: the kind of identifier to return
538 * Gets the identifier of the given kind for @volume.
539 * See the <link linkend="volume-identifier">introduction</link>
540 * for more information about volume identifiers.
542 * Returns: a newly allocated string containing the
543 * requested identfier, or %NULL if the #GVolume
544 * doesn't have this kind of identifier
547 g_volume_get_identifier (GVolume *volume,
552 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
553 g_return_val_if_fail (kind != NULL, NULL);
555 iface = G_VOLUME_GET_IFACE (volume);
557 if (iface->get_identifier == NULL)
560 return (* iface->get_identifier) (volume, kind);
564 * g_volume_enumerate_identifiers:
565 * @volume: a #GVolume
567 * Gets the kinds of <link linkend="volume-identifier">identifiers</link>
568 * that @volume has. Use g_volume_get_identifer() to obtain
569 * the identifiers themselves.
571 * Returns: a %NULL-terminated array of strings containing
572 * kinds of identifiers. Use g_strfreev() to free.
575 g_volume_enumerate_identifiers (GVolume *volume)
579 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
580 iface = G_VOLUME_GET_IFACE (volume);
582 if (iface->enumerate_identifiers == NULL)
585 return (* iface->enumerate_identifiers) (volume);
589 * g_volume_get_activation_root:
590 * @volume: a #GVolume
592 * Gets the activation root for a #GVolume if it is known ahead of
593 * mount time. Returns %NULL otherwise. If not %NULL and if @volume
594 * is mounted, then the result of g_mount_get_root() on the
595 * #GMount object obtained from g_volume_get_mount() will always
596 * either be equal or a prefix of what this function returns. In
597 * other words, in code
602 * GFile *volume_activation_root;
604 * mount = g_volume_get_mount (volume); /* mounted, so never NULL */
605 * mount_root = g_mount_get_root (mount);
606 * volume_activation_root = g_volume_get_activation_root(volume); /* assume not NULL */
609 * then the expression
612 * (g_file_has_prefix (volume_activation_root, mount_root) ||
613 g_file_equal (volume_activation_root, mount_root))
616 * will always be %TRUE.
618 * Activation roots are typically used in #GVolumeMonitor
619 * implementations to find the underlying mount to shadow, see
620 * g_mount_is_shadowed() for more details.
622 * Returns: the activation root of @volume or %NULL. Use
623 * g_object_unref() to free.
628 g_volume_get_activation_root (GVolume *volume)
632 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
633 iface = G_VOLUME_GET_IFACE (volume);
635 if (iface->get_activation_root == NULL)
638 return (* iface->get_activation_root) (volume);