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"
36 * @short_description: Volume management
39 * The #GVolume interface represents user-visible objects that can be
40 * mounted. Note, when porting from GnomeVFS, #GVolume is the moral
41 * equivalent of #GnomeVFSDrive.
43 * Mounting a #GVolume instance is an asynchronous operation. For more
44 * information about asynchronous operations, see #GAsyncReady and
45 * #GSimpleAsyncReady. To mount a #GVolume, first call
46 * g_volume_mount() with (at least) the #GVolume instance, optionally
47 * a #GMountOperation object and a #GAsyncReadyCallback.
49 * Typically, one will only want to pass %NULL for the
50 * #GMountOperation if automounting all volumes when a desktop session
51 * starts since it's not desirable to put up a lot of dialogs asking
54 * The callback will be fired when the operation has resolved (either
55 * with success or failure), and a #GAsyncReady structure will be
56 * passed to the callback. That callback should then call
57 * g_volume_mount_finish() with the #GVolume instance and the
58 * #GAsyncReady data to see if the operation was completed
59 * successfully. If an @error is present when g_volume_mount_finish()
60 * is called, then it will be filled with any error information.
62 * <para id="volume-identifier">
63 * It is sometimes necessary to directly access the underlying
64 * operating system object behind a volume (e.g. for passing a volume
65 * to an application via the commandline). For this purpose, GIO
66 * allows to obtain an 'identifier' for the volume. There can be
67 * different kinds of identifiers, such as Hal UDIs, filesystem labels,
68 * traditional Unix devices (e.g. <filename>/dev/sda2</filename>),
69 * uuids. GIO uses predefind strings as names for the different kinds
70 * of identifiers: #G_VOLUME_IDENTIFIER_KIND_HAL_UDI,
71 * #G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use g_volume_get_identifier()
72 * to obtain an identifier for a volume.
75 * Note that #G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available
76 * when the gvfs hal volume monitor is in use. Other volume monitors
77 * will generally be able to provide the #G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE
78 * identifier, which can be used to obtain a hal device by means of
79 * libhal_manger_find_device_string_match().
82 static void g_volume_base_init (gpointer g_class);
83 static void g_volume_class_init (gpointer g_class,
87 g_volume_get_type (void)
89 static volatile gsize g_define_type_id__volatile = 0;
91 if (g_once_init_enter (&g_define_type_id__volatile))
93 const GTypeInfo volume_info =
95 sizeof (GVolumeIface), /* class_size */
96 g_volume_base_init, /* base_init */
97 NULL, /* base_finalize */
99 NULL, /* class_finalize */
100 NULL, /* class_data */
105 GType g_define_type_id =
106 g_type_register_static (G_TYPE_INTERFACE, I_("GVolume"),
109 g_type_interface_add_prerequisite (g_define_type_id, G_TYPE_OBJECT);
111 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
114 return g_define_type_id__volatile;
118 g_volume_class_init (gpointer g_class,
124 g_volume_base_init (gpointer g_class)
126 static gboolean initialized = FALSE;
133 * Emitted when the volume has been changed.
135 g_signal_new (I_("changed"),
138 G_STRUCT_OFFSET (GVolumeIface, changed),
140 g_cclosure_marshal_VOID__VOID,
146 * This signal is emitted when the #GVolume have been removed. If
147 * the recipient is holding references to the object they should
148 * release them so the object can be finalized.
150 g_signal_new (I_("removed"),
153 G_STRUCT_OFFSET (GVolumeIface, removed),
155 g_cclosure_marshal_VOID__VOID,
164 * @volume: a #GVolume.
166 * Gets the name of @volume.
168 * Returns: the name for the given @volume. The returned string should
169 * be freed with g_free() when no longer needed.
172 g_volume_get_name (GVolume *volume)
176 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
178 iface = G_VOLUME_GET_IFACE (volume);
180 return (* iface->get_name) (volume);
185 * @volume: a #GVolume.
187 * Gets the icon for @volume.
190 * The returned object should be unreffed with g_object_unref()
191 * when no longer needed.
194 g_volume_get_icon (GVolume *volume)
198 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
200 iface = G_VOLUME_GET_IFACE (volume);
202 return (* iface->get_icon) (volume);
207 * @volume: a #GVolume.
209 * Gets the UUID for the @volume. The reference is typically based on
210 * the file system UUID for the volume in question and should be
211 * considered an opaque string. Returns %NULL if there is no UUID
214 * Returns: the UUID for @volume or %NULL if no UUID can be computed.
215 * The returned string should be freed with g_free()
216 * when no longer needed.
219 g_volume_get_uuid (GVolume *volume)
223 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
225 iface = G_VOLUME_GET_IFACE (volume);
227 return (* iface->get_uuid) (volume);
231 * g_volume_get_drive:
232 * @volume: a #GVolume.
234 * Gets the drive for the @volume.
236 * Returns: a #GDrive or %NULL if @volume is not associated with a drive.
237 * The returned object should be unreffed with g_object_unref()
238 * when no longer needed.
241 g_volume_get_drive (GVolume *volume)
245 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
247 iface = G_VOLUME_GET_IFACE (volume);
249 return (* iface->get_drive) (volume);
253 * g_volume_get_mount:
254 * @volume: a #GVolume.
256 * Gets the mount for the @volume.
258 * Returns: a #GMount or %NULL if @volume isn't mounted.
259 * The returned object should be unreffed with g_object_unref()
260 * when no longer needed.
263 g_volume_get_mount (GVolume *volume)
267 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
269 iface = G_VOLUME_GET_IFACE (volume);
271 return (* iface->get_mount) (volume);
276 * g_volume_can_mount:
277 * @volume: a #GVolume.
279 * Checks if a volume can be mounted.
281 * Returns: %TRUE if the @volume can be mounted. %FALSE otherwise.
284 g_volume_can_mount (GVolume *volume)
288 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
290 iface = G_VOLUME_GET_IFACE (volume);
292 if (iface->can_mount == NULL)
295 return (* iface->can_mount) (volume);
299 * g_volume_can_eject:
300 * @volume: a #GVolume.
302 * Checks if a volume can be ejected.
304 * Returns: %TRUE if the @volume can be ejected. %FALSE otherwise.
307 g_volume_can_eject (GVolume *volume)
311 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
313 iface = G_VOLUME_GET_IFACE (volume);
315 if (iface->can_eject == NULL)
318 return (* iface->can_eject) (volume);
322 * g_volume_should_automount:
323 * @volume: a #GVolume
325 * Returns whether the volume should be automatically mounted.
327 * Returns: %TRUE if the volume should be automatically mounted.
330 g_volume_should_automount (GVolume *volume)
334 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
336 iface = G_VOLUME_GET_IFACE (volume);
338 if (iface->should_automount == NULL)
341 return (* iface->should_automount) (volume);
347 * @volume: a #GVolume.
348 * @flags: flags affecting the operation
349 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
350 * @cancellable: optional #GCancellable object, %NULL to ignore.
351 * @callback: a #GAsyncReadyCallback, or %NULL.
352 * @user_data: user data that gets passed to @callback
354 * Mounts a volume. This is an asynchronous operation, and is
355 * finished by calling g_volume_mount_finish() with the @volume
356 * and #GAsyncResult returned in the @callback.
359 g_volume_mount (GVolume *volume,
360 GMountMountFlags flags,
361 GMountOperation *mount_operation,
362 GCancellable *cancellable,
363 GAsyncReadyCallback callback,
368 g_return_if_fail (G_IS_VOLUME (volume));
370 iface = G_VOLUME_GET_IFACE (volume);
372 if (iface->mount_fn == NULL)
374 g_simple_async_report_error_in_idle (G_OBJECT (volume), callback, user_data,
375 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
376 _("volume doesn't implement mount"));
381 (* iface->mount_fn) (volume, flags, mount_operation, cancellable, callback, user_data);
385 * g_volume_mount_finish:
386 * @volume: a #GVolume
387 * @result: a #GAsyncResult
388 * @error: a #GError location to store an error, or %NULL to ignore
390 * Finishes mounting a volume. If any errors occured during the operation,
391 * @error will be set to contain the errors and %FALSE will be returned.
393 * If the mount operation succeeded, g_volume_get_mount() on @volume
394 * is guaranteed to return the mount right after calling this
395 * function; there's no need to listen for the 'mount-added' signal on
398 * Returns: %TRUE, %FALSE if operation failed.
401 g_volume_mount_finish (GVolume *volume,
402 GAsyncResult *result,
407 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
408 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
410 if (G_IS_SIMPLE_ASYNC_RESULT (result))
412 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
413 if (g_simple_async_result_propagate_error (simple, error))
417 iface = G_VOLUME_GET_IFACE (volume);
418 return (* iface->mount_finish) (volume, result, error);
423 * @volume: a #GVolume.
424 * @flags: flags affecting the unmount if required for eject
425 * @cancellable: optional #GCancellable object, %NULL to ignore.
426 * @callback: a #GAsyncReadyCallback, or %NULL.
427 * @user_data: user data that gets passed to @callback
429 * Ejects a volume. This is an asynchronous operation, and is
430 * finished by calling g_volume_eject_finish() with the @volume
431 * and #GAsyncResult returned in the @callback.
433 * Deprecated: 2.22: Use g_volume_eject_with_operation() instead.
436 g_volume_eject (GVolume *volume,
437 GMountUnmountFlags flags,
438 GCancellable *cancellable,
439 GAsyncReadyCallback callback,
444 g_return_if_fail (G_IS_VOLUME (volume));
446 iface = G_VOLUME_GET_IFACE (volume);
448 if (iface->eject == NULL)
450 g_simple_async_report_error_in_idle (G_OBJECT (volume), callback, user_data,
451 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
452 _("volume doesn't implement eject"));
457 (* iface->eject) (volume, flags, cancellable, callback, user_data);
461 * g_volume_eject_finish:
462 * @volume: pointer to a #GVolume.
463 * @result: a #GAsyncResult.
464 * @error: a #GError location to store an error, or %NULL to ignore
466 * Finishes ejecting a volume. If any errors occured during the operation,
467 * @error will be set to contain the errors and %FALSE will be returned.
469 * Returns: %TRUE, %FALSE if operation failed.
471 * Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead.
474 g_volume_eject_finish (GVolume *volume,
475 GAsyncResult *result,
480 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
481 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
483 if (G_IS_SIMPLE_ASYNC_RESULT (result))
485 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
486 if (g_simple_async_result_propagate_error (simple, error))
490 iface = G_VOLUME_GET_IFACE (volume);
491 return (* iface->eject_finish) (volume, result, error);
495 * g_volume_eject_with_operation:
496 * @volume: a #GVolume.
497 * @flags: flags affecting the unmount if required for eject
498 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
499 * @cancellable: optional #GCancellable object, %NULL to ignore.
500 * @callback: a #GAsyncReadyCallback, or %NULL.
501 * @user_data: user data passed to @callback.
503 * Ejects a volume. This is an asynchronous operation, and is
504 * finished by calling g_volume_eject_with_operation_finish() with the @volume
505 * and #GAsyncResult data returned in the @callback.
510 g_volume_eject_with_operation (GVolume *volume,
511 GMountUnmountFlags flags,
512 GMountOperation *mount_operation,
513 GCancellable *cancellable,
514 GAsyncReadyCallback callback,
519 g_return_if_fail (G_IS_VOLUME (volume));
521 iface = G_VOLUME_GET_IFACE (volume);
523 if (iface->eject == NULL && iface->eject_with_operation == NULL)
525 g_simple_async_report_error_in_idle (G_OBJECT (volume),
527 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
528 /* Translators: This is an error
529 * message for volume objects that
530 * don't implement any of eject or eject_with_operation. */
531 _("volume doesn't implement eject or eject_with_operation"));
535 if (iface->eject_with_operation != NULL)
536 (* iface->eject_with_operation) (volume, flags, mount_operation, cancellable, callback, user_data);
538 (* iface->eject) (volume, flags, cancellable, callback, user_data);
542 * g_volume_eject_with_operation_finish:
543 * @volume: a #GVolume.
544 * @result: a #GAsyncResult.
545 * @error: a #GError location to store the error occuring, or %NULL to
548 * Finishes ejecting a volume. If any errors occurred during the operation,
549 * @error will be set to contain the errors and %FALSE will be returned.
551 * Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise.
556 g_volume_eject_with_operation_finish (GVolume *volume,
557 GAsyncResult *result,
562 g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
563 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
565 if (G_IS_SIMPLE_ASYNC_RESULT (result))
567 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
568 if (g_simple_async_result_propagate_error (simple, error))
572 iface = G_VOLUME_GET_IFACE (volume);
573 if (iface->eject_with_operation_finish != NULL)
574 return (* iface->eject_with_operation_finish) (volume, result, error);
576 return (* iface->eject_finish) (volume, result, error);
580 * g_volume_get_identifier:
581 * @volume: a #GVolume
582 * @kind: the kind of identifier to return
584 * Gets the identifier of the given kind for @volume.
585 * See the <link linkend="volume-identifier">introduction</link>
586 * for more information about volume identifiers.
588 * Returns: a newly allocated string containing the
589 * requested identfier, or %NULL if the #GVolume
590 * doesn't have this kind of identifier
593 g_volume_get_identifier (GVolume *volume,
598 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
599 g_return_val_if_fail (kind != NULL, NULL);
601 iface = G_VOLUME_GET_IFACE (volume);
603 if (iface->get_identifier == NULL)
606 return (* iface->get_identifier) (volume, kind);
610 * g_volume_enumerate_identifiers:
611 * @volume: a #GVolume
613 * Gets the kinds of <link linkend="volume-identifier">identifiers</link>
614 * that @volume has. Use g_volume_get_identifer() to obtain
615 * the identifiers themselves.
617 * Returns: a %NULL-terminated array of strings containing
618 * kinds of identifiers. Use g_strfreev() to free.
621 g_volume_enumerate_identifiers (GVolume *volume)
625 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
626 iface = G_VOLUME_GET_IFACE (volume);
628 if (iface->enumerate_identifiers == NULL)
631 return (* iface->enumerate_identifiers) (volume);
635 * g_volume_get_activation_root:
636 * @volume: a #GVolume
638 * Gets the activation root for a #GVolume if it is known ahead of
639 * mount time. Returns %NULL otherwise. If not %NULL and if @volume
640 * is mounted, then the result of g_mount_get_root() on the
641 * #GMount object obtained from g_volume_get_mount() will always
642 * either be equal or a prefix of what this function returns. In
643 * other words, in code
648 * GFile *volume_activation_root;
650 * mount = g_volume_get_mount (volume); /* mounted, so never NULL */
651 * mount_root = g_mount_get_root (mount);
652 * volume_activation_root = g_volume_get_activation_root(volume); /* assume not NULL */
655 * then the expression
658 * (g_file_has_prefix (volume_activation_root, mount_root) ||
659 g_file_equal (volume_activation_root, mount_root))
662 * will always be %TRUE.
664 * Activation roots are typically used in #GVolumeMonitor
665 * implementations to find the underlying mount to shadow, see
666 * g_mount_is_shadowed() for more details.
668 * Returns: the activation root of @volume or %NULL. Use
669 * g_object_unref() to free.
674 g_volume_get_activation_root (GVolume *volume)
678 g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
679 iface = G_VOLUME_GET_IFACE (volume);
681 if (iface->get_activation_root == NULL)
684 return (* iface->get_activation_root) (volume);
689 #define __G_VOLUME_C__
690 #include "gioaliasdef.c"