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>
26 #include "gsimpleasyncresult.h"
27 #include "gasyncresult.h"
34 * @short_description: Drive management
37 * #GDrive - this represent a piece of hardware connected to the machine.
38 * It's generally only created for removable hardware or hardware with
41 * #GDrive is a container class for #GVolume objects that stem from
42 * the same piece of media. As such, #GDrive abstracts a drive with
43 * (or without) removable media and provides operations for querying
44 * whether media is available, determing whether media change is
45 * automatically detected and ejecting the media.
47 * If the #GDrive reports that media isn't automatically detected, one
48 * can poll for media; typically one should not do this periodically
49 * as a poll for media operation is potententially expensive and may
50 * spin up the drive creating noise.
52 * #GDrive supports starting and stopping drives with authentication
53 * support for the former. This can be used to support a diverse set
54 * of use cases including connecting/disconnecting iSCSI devices,
55 * powering down external disk enclosures and starting/stopping
56 * multi-disk devices such as RAID devices. Note that the actual
57 * semantics and side-effects of starting/stopping a #GDrive may vary
58 * according to implementation. To choose the correct verbs in e.g. a
59 * file manager, use g_drive_get_start_stop_type().
61 * For porting from GnomeVFS note that there is no equivalent of
62 * #GDrive in that API.
65 typedef GDriveIface GDriveInterface;
66 G_DEFINE_INTERFACE(GDrive, g_drive, G_TYPE_OBJECT)
69 g_drive_default_init (GDriveInterface *iface)
75 * Emitted when the drive's state has changed.
77 g_signal_new (I_("changed"),
80 G_STRUCT_OFFSET (GDriveIface, changed),
82 g_cclosure_marshal_VOID__VOID,
86 * GDrive::disconnected:
89 * This signal is emitted when the #GDrive have been
90 * disconnected. If the recipient is holding references to the
91 * object they should release them so the object can be
94 g_signal_new (I_("disconnected"),
97 G_STRUCT_OFFSET (GDriveIface, disconnected),
99 g_cclosure_marshal_VOID__VOID,
103 * GDrive::eject-button:
106 * Emitted when the physical eject button (if any) of a drive has
109 g_signal_new (I_("eject-button"),
112 G_STRUCT_OFFSET (GDriveIface, eject_button),
114 g_cclosure_marshal_VOID__VOID,
118 * GDrive::stop-button:
121 * Emitted when the physical stop button (if any) of a drive has
126 g_signal_new (I_("stop-button"),
129 G_STRUCT_OFFSET (GDriveIface, stop_button),
131 g_cclosure_marshal_VOID__VOID,
139 * Gets the name of @drive.
141 * Returns: a string containing @drive's name. The returned
142 * string should be freed when no longer needed.
145 g_drive_get_name (GDrive *drive)
149 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
151 iface = G_DRIVE_GET_IFACE (drive);
153 return (* iface->get_name) (drive);
160 * Gets the icon for @drive.
162 * Returns: (transfer full): #GIcon for the @drive.
163 * Free the returned object with g_object_unref().
166 g_drive_get_icon (GDrive *drive)
170 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
172 iface = G_DRIVE_GET_IFACE (drive);
174 return (* iface->get_icon) (drive);
178 * g_drive_has_volumes:
181 * Check if @drive has any mountable volumes.
183 * Returns: %TRUE if the @drive contains volumes, %FALSE otherwise.
186 g_drive_has_volumes (GDrive *drive)
190 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
192 iface = G_DRIVE_GET_IFACE (drive);
194 return (* iface->has_volumes) (drive);
198 * g_drive_get_volumes:
201 * Get a list of mountable volumes for @drive.
203 * The returned list should be freed with g_list_free(), after
204 * its elements have been unreffed with g_object_unref().
206 * Returns: (element-type GVolume) (transfer full): #GList containing any #GVolume objects on the given @drive.
209 g_drive_get_volumes (GDrive *drive)
213 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
215 iface = G_DRIVE_GET_IFACE (drive);
217 return (* iface->get_volumes) (drive);
221 * g_drive_is_media_check_automatic:
224 * Checks if @drive is capabable of automatically detecting media changes.
226 * Returns: %TRUE if the @drive is capabable of automatically detecting
227 * media changes, %FALSE otherwise.
230 g_drive_is_media_check_automatic (GDrive *drive)
234 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
236 iface = G_DRIVE_GET_IFACE (drive);
238 return (* iface->is_media_check_automatic) (drive);
242 * g_drive_is_media_removable:
245 * Checks if the @drive supports removable media.
247 * Returns: %TRUE if @drive supports removable media, %FALSE otherwise.
250 g_drive_is_media_removable (GDrive *drive)
254 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
256 iface = G_DRIVE_GET_IFACE (drive);
258 return (* iface->is_media_removable) (drive);
265 * Checks if the @drive has media. Note that the OS may not be polling
266 * the drive for media changes; see g_drive_is_media_check_automatic()
269 * Returns: %TRUE if @drive has media, %FALSE otherwise.
272 g_drive_has_media (GDrive *drive)
276 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
278 iface = G_DRIVE_GET_IFACE (drive);
280 return (* iface->has_media) (drive);
287 * Checks if a drive can be ejected.
289 * Returns: %TRUE if the @drive can be ejected, %FALSE otherwise.
292 g_drive_can_eject (GDrive *drive)
296 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
298 iface = G_DRIVE_GET_IFACE (drive);
300 if (iface->can_eject == NULL)
303 return (* iface->can_eject) (drive);
307 * g_drive_can_poll_for_media:
310 * Checks if a drive can be polled for media changes.
312 * Returns: %TRUE if the @drive can be polled for media changes,
316 g_drive_can_poll_for_media (GDrive *drive)
320 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
322 iface = G_DRIVE_GET_IFACE (drive);
324 if (iface->poll_for_media == NULL)
327 return (* iface->can_poll_for_media) (drive);
333 * @flags: flags affecting the unmount if required for eject
334 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
335 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
336 * @user_data: user data to pass to @callback
338 * Asynchronously ejects a drive.
340 * When the operation is finished, @callback will be called.
341 * You can then call g_drive_eject_finish() to obtain the
342 * result of the operation.
344 * Deprecated: 2.22: Use g_drive_eject_with_operation() instead.
347 g_drive_eject (GDrive *drive,
348 GMountUnmountFlags flags,
349 GCancellable *cancellable,
350 GAsyncReadyCallback callback,
355 g_return_if_fail (G_IS_DRIVE (drive));
357 iface = G_DRIVE_GET_IFACE (drive);
359 if (iface->eject == NULL)
361 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
362 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
363 _("drive doesn't implement eject"));
368 (* iface->eject) (drive, flags, cancellable, callback, user_data);
372 * g_drive_eject_finish:
374 * @result: a #GAsyncResult.
375 * @error: a #GError, or %NULL
377 * Finishes ejecting a drive.
379 * Returns: %TRUE if the drive has been ejected successfully,
382 * Deprecated: 2.22: Use g_drive_eject_with_operation_finish() instead.
385 g_drive_eject_finish (GDrive *drive,
386 GAsyncResult *result,
391 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
392 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
394 if (g_async_result_legacy_propagate_error (result, error))
397 iface = G_DRIVE_GET_IFACE (drive);
399 return (* iface->eject_finish) (drive, result, error);
403 * g_drive_eject_with_operation:
405 * @flags: flags affecting the unmount if required for eject
406 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
408 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
409 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
410 * @user_data: user data passed to @callback.
412 * Ejects a drive. This is an asynchronous operation, and is
413 * finished by calling g_drive_eject_with_operation_finish() with the @drive
414 * and #GAsyncResult data returned in the @callback.
419 g_drive_eject_with_operation (GDrive *drive,
420 GMountUnmountFlags flags,
421 GMountOperation *mount_operation,
422 GCancellable *cancellable,
423 GAsyncReadyCallback callback,
428 g_return_if_fail (G_IS_DRIVE (drive));
430 iface = G_DRIVE_GET_IFACE (drive);
432 if (iface->eject == NULL && iface->eject_with_operation == NULL)
434 g_simple_async_report_error_in_idle (G_OBJECT (drive),
436 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
437 /* Translators: This is an error
438 * message for drive objects that
439 * don't implement any of eject or eject_with_operation. */
440 _("drive doesn't implement eject or eject_with_operation"));
444 if (iface->eject_with_operation != NULL)
445 (* iface->eject_with_operation) (drive, flags, mount_operation, cancellable, callback, user_data);
447 (* iface->eject) (drive, flags, cancellable, callback, user_data);
451 * g_drive_eject_with_operation_finish:
453 * @result: a #GAsyncResult.
454 * @error: a #GError location to store the error occurring, or %NULL to
457 * Finishes ejecting a drive. If any errors occurred during the operation,
458 * @error will be set to contain the errors and %FALSE will be returned.
460 * Returns: %TRUE if the drive was successfully ejected. %FALSE otherwise.
465 g_drive_eject_with_operation_finish (GDrive *drive,
466 GAsyncResult *result,
471 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
472 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
474 if (g_async_result_legacy_propagate_error (result, error))
477 iface = G_DRIVE_GET_IFACE (drive);
478 if (iface->eject_with_operation_finish != NULL)
479 return (* iface->eject_with_operation_finish) (drive, result, error);
481 return (* iface->eject_finish) (drive, result, error);
485 * g_drive_poll_for_media:
487 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
488 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
489 * @user_data: user data to pass to @callback
491 * Asynchronously polls @drive to see if media has been inserted or removed.
493 * When the operation is finished, @callback will be called.
494 * You can then call g_drive_poll_for_media_finish() to obtain the
495 * result of the operation.
498 g_drive_poll_for_media (GDrive *drive,
499 GCancellable *cancellable,
500 GAsyncReadyCallback callback,
505 g_return_if_fail (G_IS_DRIVE (drive));
507 iface = G_DRIVE_GET_IFACE (drive);
509 if (iface->poll_for_media == NULL)
511 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
512 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
513 _("drive doesn't implement polling for media"));
518 (* iface->poll_for_media) (drive, cancellable, callback, user_data);
522 * g_drive_poll_for_media_finish:
524 * @result: a #GAsyncResult.
525 * @error: a #GError, or %NULL
527 * Finishes an operation started with g_drive_poll_for_media() on a drive.
529 * Returns: %TRUE if the drive has been poll_for_mediaed successfully,
533 g_drive_poll_for_media_finish (GDrive *drive,
534 GAsyncResult *result,
539 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
540 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
542 if (g_async_result_legacy_propagate_error (result, error))
545 iface = G_DRIVE_GET_IFACE (drive);
547 return (* iface->poll_for_media_finish) (drive, result, error);
551 * g_drive_get_identifier:
553 * @kind: the kind of identifier to return
555 * Gets the identifier of the given kind for @drive.
557 * Returns: a newly allocated string containing the
558 * requested identfier, or %NULL if the #GDrive
559 * doesn't have this kind of identifier.
562 g_drive_get_identifier (GDrive *drive,
567 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
568 g_return_val_if_fail (kind != NULL, NULL);
570 iface = G_DRIVE_GET_IFACE (drive);
572 if (iface->get_identifier == NULL)
575 return (* iface->get_identifier) (drive, kind);
579 * g_drive_enumerate_identifiers:
582 * Gets the kinds of identifiers that @drive has.
583 * Use g_drive_get_identifier() to obtain the identifiers
586 * Returns: (transfer full) (array zero-terminated=1): a %NULL-terminated
587 * array of strings containing kinds of identifiers. Use g_strfreev()
591 g_drive_enumerate_identifiers (GDrive *drive)
595 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
596 iface = G_DRIVE_GET_IFACE (drive);
598 if (iface->enumerate_identifiers == NULL)
601 return (* iface->enumerate_identifiers) (drive);
605 * g_drive_get_start_stop_type:
608 * Gets a hint about how a drive can be started/stopped.
610 * Returns: A value from the #GDriveStartStopType enumeration.
615 g_drive_get_start_stop_type (GDrive *drive)
619 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
621 iface = G_DRIVE_GET_IFACE (drive);
623 if (iface->get_start_stop_type == NULL)
624 return G_DRIVE_START_STOP_TYPE_UNKNOWN;
626 return (* iface->get_start_stop_type) (drive);
634 * Checks if a drive can be started.
636 * Returns: %TRUE if the @drive can be started, %FALSE otherwise.
641 g_drive_can_start (GDrive *drive)
645 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
647 iface = G_DRIVE_GET_IFACE (drive);
649 if (iface->can_start == NULL)
652 return (* iface->can_start) (drive);
656 * g_drive_can_start_degraded:
659 * Checks if a drive can be started degraded.
661 * Returns: %TRUE if the @drive can be started degraded, %FALSE otherwise.
666 g_drive_can_start_degraded (GDrive *drive)
670 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
672 iface = G_DRIVE_GET_IFACE (drive);
674 if (iface->can_start_degraded == NULL)
677 return (* iface->can_start_degraded) (drive);
683 * @flags: flags affecting the start operation.
684 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
686 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
687 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
688 * @user_data: user data to pass to @callback
690 * Asynchronously starts a drive.
692 * When the operation is finished, @callback will be called.
693 * You can then call g_drive_start_finish() to obtain the
694 * result of the operation.
699 g_drive_start (GDrive *drive,
700 GDriveStartFlags flags,
701 GMountOperation *mount_operation,
702 GCancellable *cancellable,
703 GAsyncReadyCallback callback,
708 g_return_if_fail (G_IS_DRIVE (drive));
710 iface = G_DRIVE_GET_IFACE (drive);
712 if (iface->start == NULL)
714 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
715 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
716 _("drive doesn't implement start"));
720 (* iface->start) (drive, flags, mount_operation, cancellable, callback, user_data);
724 * g_drive_start_finish:
726 * @result: a #GAsyncResult.
727 * @error: a #GError, or %NULL
729 * Finishes starting a drive.
731 * Returns: %TRUE if the drive has been started successfully,
737 g_drive_start_finish (GDrive *drive,
738 GAsyncResult *result,
743 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
744 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
746 if (g_async_result_legacy_propagate_error (result, error))
749 iface = G_DRIVE_GET_IFACE (drive);
751 return (* iface->start_finish) (drive, result, error);
758 * Checks if a drive can be stopped.
760 * Returns: %TRUE if the @drive can be stopped, %FALSE otherwise.
765 g_drive_can_stop (GDrive *drive)
769 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
771 iface = G_DRIVE_GET_IFACE (drive);
773 if (iface->can_stop == NULL)
776 return (* iface->can_stop) (drive);
782 * @flags: flags affecting the unmount if required for stopping.
783 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
785 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
786 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
787 * @user_data: user data to pass to @callback
789 * Asynchronously stops a drive.
791 * When the operation is finished, @callback will be called.
792 * You can then call g_drive_stop_finish() to obtain the
793 * result of the operation.
798 g_drive_stop (GDrive *drive,
799 GMountUnmountFlags flags,
800 GMountOperation *mount_operation,
801 GCancellable *cancellable,
802 GAsyncReadyCallback callback,
807 g_return_if_fail (G_IS_DRIVE (drive));
809 iface = G_DRIVE_GET_IFACE (drive);
811 if (iface->stop == NULL)
813 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
814 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
815 _("drive doesn't implement stop"));
819 (* iface->stop) (drive, flags, mount_operation, cancellable, callback, user_data);
823 * g_drive_stop_finish:
825 * @result: a #GAsyncResult.
826 * @error: a #GError, or %NULL
828 * Finishes stopping a drive.
830 * Returns: %TRUE if the drive has been stopped successfully,
836 g_drive_stop_finish (GDrive *drive,
837 GAsyncResult *result,
842 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
843 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
845 if (g_async_result_legacy_propagate_error (result, error))
848 iface = G_DRIVE_GET_IFACE (drive);
850 return (* iface->stop_finish) (drive, result, error);
854 * g_drive_get_sort_key:
857 * Gets the sort key for @drive, if any.
859 * Returns: Sorting key for @drive or %NULL if no such key is available.
864 g_drive_get_sort_key (GDrive *drive)
866 const gchar *ret = NULL;
869 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
871 iface = G_DRIVE_GET_IFACE (drive);
872 if (iface->get_sort_key != NULL)
873 ret = iface->get_sort_key (drive);