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_IS_SIMPLE_ASYNC_RESULT (result
))
396 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
397 if (g_simple_async_result_propagate_error (simple
, error
))
401 iface
= G_DRIVE_GET_IFACE (drive
);
403 return (* iface
->eject_finish
) (drive
, result
, error
);
407 * g_drive_eject_with_operation:
409 * @flags: flags affecting the unmount if required for eject
410 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
412 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
413 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
414 * @user_data: user data passed to @callback.
416 * Ejects a drive. This is an asynchronous operation, and is
417 * finished by calling g_drive_eject_with_operation_finish() with the @drive
418 * and #GAsyncResult data returned in the @callback.
423 g_drive_eject_with_operation (GDrive
*drive
,
424 GMountUnmountFlags flags
,
425 GMountOperation
*mount_operation
,
426 GCancellable
*cancellable
,
427 GAsyncReadyCallback callback
,
432 g_return_if_fail (G_IS_DRIVE (drive
));
434 iface
= G_DRIVE_GET_IFACE (drive
);
436 if (iface
->eject
== NULL
&& iface
->eject_with_operation
== NULL
)
438 g_simple_async_report_error_in_idle (G_OBJECT (drive
),
440 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
441 /* Translators: This is an error
442 * message for drive objects that
443 * don't implement any of eject or eject_with_operation. */
444 _("drive doesn't implement eject or eject_with_operation"));
448 if (iface
->eject_with_operation
!= NULL
)
449 (* iface
->eject_with_operation
) (drive
, flags
, mount_operation
, cancellable
, callback
, user_data
);
451 (* iface
->eject
) (drive
, flags
, cancellable
, callback
, user_data
);
455 * g_drive_eject_with_operation_finish:
457 * @result: a #GAsyncResult.
458 * @error: a #GError location to store the error occurring, or %NULL to
461 * Finishes ejecting a drive. If any errors occurred during the operation,
462 * @error will be set to contain the errors and %FALSE will be returned.
464 * Returns: %TRUE if the drive was successfully ejected. %FALSE otherwise.
469 g_drive_eject_with_operation_finish (GDrive
*drive
,
470 GAsyncResult
*result
,
475 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
476 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
478 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
480 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
481 if (g_simple_async_result_propagate_error (simple
, error
))
485 iface
= G_DRIVE_GET_IFACE (drive
);
486 if (iface
->eject_with_operation_finish
!= NULL
)
487 return (* iface
->eject_with_operation_finish
) (drive
, result
, error
);
489 return (* iface
->eject_finish
) (drive
, result
, error
);
493 * g_drive_poll_for_media:
495 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
496 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
497 * @user_data: user data to pass to @callback
499 * Asynchronously polls @drive to see if media has been inserted or removed.
501 * When the operation is finished, @callback will be called.
502 * You can then call g_drive_poll_for_media_finish() to obtain the
503 * result of the operation.
506 g_drive_poll_for_media (GDrive
*drive
,
507 GCancellable
*cancellable
,
508 GAsyncReadyCallback callback
,
513 g_return_if_fail (G_IS_DRIVE (drive
));
515 iface
= G_DRIVE_GET_IFACE (drive
);
517 if (iface
->poll_for_media
== NULL
)
519 g_simple_async_report_error_in_idle (G_OBJECT (drive
), callback
, user_data
,
520 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
521 _("drive doesn't implement polling for media"));
526 (* iface
->poll_for_media
) (drive
, cancellable
, callback
, user_data
);
530 * g_drive_poll_for_media_finish:
532 * @result: a #GAsyncResult.
533 * @error: a #GError, or %NULL
535 * Finishes an operation started with g_drive_poll_for_media() on a drive.
537 * Returns: %TRUE if the drive has been poll_for_mediaed successfully,
541 g_drive_poll_for_media_finish (GDrive
*drive
,
542 GAsyncResult
*result
,
547 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
548 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
550 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
552 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
553 if (g_simple_async_result_propagate_error (simple
, error
))
557 iface
= G_DRIVE_GET_IFACE (drive
);
559 return (* iface
->poll_for_media_finish
) (drive
, result
, error
);
563 * g_drive_get_identifier:
565 * @kind: the kind of identifier to return
567 * Gets the identifier of the given kind for @drive.
569 * Returns: a newly allocated string containing the
570 * requested identfier, or %NULL if the #GDrive
571 * doesn't have this kind of identifier.
574 g_drive_get_identifier (GDrive
*drive
,
579 g_return_val_if_fail (G_IS_DRIVE (drive
), NULL
);
580 g_return_val_if_fail (kind
!= NULL
, NULL
);
582 iface
= G_DRIVE_GET_IFACE (drive
);
584 if (iface
->get_identifier
== NULL
)
587 return (* iface
->get_identifier
) (drive
, kind
);
591 * g_drive_enumerate_identifiers:
594 * Gets the kinds of identifiers that @drive has.
595 * Use g_drive_get_identifer() to obtain the identifiers
598 * Returns: (transfer full) (array zero-terminated=1): a %NULL-terminated
599 * array of strings containing kinds of identifiers. Use g_strfreev()
603 g_drive_enumerate_identifiers (GDrive
*drive
)
607 g_return_val_if_fail (G_IS_DRIVE (drive
), NULL
);
608 iface
= G_DRIVE_GET_IFACE (drive
);
610 if (iface
->enumerate_identifiers
== NULL
)
613 return (* iface
->enumerate_identifiers
) (drive
);
617 * g_drive_get_start_stop_type:
620 * Gets a hint about how a drive can be started/stopped.
622 * Returns: A value from the #GDriveStartStopType enumeration.
627 g_drive_get_start_stop_type (GDrive
*drive
)
631 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
633 iface
= G_DRIVE_GET_IFACE (drive
);
635 if (iface
->get_start_stop_type
== NULL
)
636 return G_DRIVE_START_STOP_TYPE_UNKNOWN
;
638 return (* iface
->get_start_stop_type
) (drive
);
646 * Checks if a drive can be started.
648 * Returns: %TRUE if the @drive can be started, %FALSE otherwise.
653 g_drive_can_start (GDrive
*drive
)
657 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
659 iface
= G_DRIVE_GET_IFACE (drive
);
661 if (iface
->can_start
== NULL
)
664 return (* iface
->can_start
) (drive
);
668 * g_drive_can_start_degraded:
671 * Checks if a drive can be started degraded.
673 * Returns: %TRUE if the @drive can be started degraded, %FALSE otherwise.
678 g_drive_can_start_degraded (GDrive
*drive
)
682 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
684 iface
= G_DRIVE_GET_IFACE (drive
);
686 if (iface
->can_start_degraded
== NULL
)
689 return (* iface
->can_start_degraded
) (drive
);
695 * @flags: flags affecting the start operation.
696 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
698 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
699 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
700 * @user_data: user data to pass to @callback
702 * Asynchronously starts a drive.
704 * When the operation is finished, @callback will be called.
705 * You can then call g_drive_start_finish() to obtain the
706 * result of the operation.
711 g_drive_start (GDrive
*drive
,
712 GDriveStartFlags flags
,
713 GMountOperation
*mount_operation
,
714 GCancellable
*cancellable
,
715 GAsyncReadyCallback callback
,
720 g_return_if_fail (G_IS_DRIVE (drive
));
722 iface
= G_DRIVE_GET_IFACE (drive
);
724 if (iface
->start
== NULL
)
726 g_simple_async_report_error_in_idle (G_OBJECT (drive
), callback
, user_data
,
727 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
728 _("drive doesn't implement start"));
732 (* iface
->start
) (drive
, flags
, mount_operation
, cancellable
, callback
, user_data
);
736 * g_drive_start_finish:
738 * @result: a #GAsyncResult.
739 * @error: a #GError, or %NULL
741 * Finishes starting a drive.
743 * Returns: %TRUE if the drive has been started successfully,
749 g_drive_start_finish (GDrive
*drive
,
750 GAsyncResult
*result
,
755 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
756 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
758 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
760 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
761 if (g_simple_async_result_propagate_error (simple
, error
))
765 iface
= G_DRIVE_GET_IFACE (drive
);
767 return (* iface
->start_finish
) (drive
, result
, error
);
774 * Checks if a drive can be stopped.
776 * Returns: %TRUE if the @drive can be stopped, %FALSE otherwise.
781 g_drive_can_stop (GDrive
*drive
)
785 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
787 iface
= G_DRIVE_GET_IFACE (drive
);
789 if (iface
->can_stop
== NULL
)
792 return (* iface
->can_stop
) (drive
);
798 * @flags: flags affecting the unmount if required for stopping.
799 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
801 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
802 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
803 * @user_data: user data to pass to @callback
805 * Asynchronously stops a drive.
807 * When the operation is finished, @callback will be called.
808 * You can then call g_drive_stop_finish() to obtain the
809 * result of the operation.
814 g_drive_stop (GDrive
*drive
,
815 GMountUnmountFlags flags
,
816 GMountOperation
*mount_operation
,
817 GCancellable
*cancellable
,
818 GAsyncReadyCallback callback
,
823 g_return_if_fail (G_IS_DRIVE (drive
));
825 iface
= G_DRIVE_GET_IFACE (drive
);
827 if (iface
->stop
== NULL
)
829 g_simple_async_report_error_in_idle (G_OBJECT (drive
), callback
, user_data
,
830 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
831 _("drive doesn't implement stop"));
835 (* iface
->stop
) (drive
, flags
, mount_operation
, cancellable
, callback
, user_data
);
839 * g_drive_stop_finish:
841 * @result: a #GAsyncResult.
842 * @error: a #GError, or %NULL
844 * Finishes stopping a drive.
846 * Returns: %TRUE if the drive has been stopped successfully,
852 g_drive_stop_finish (GDrive
*drive
,
853 GAsyncResult
*result
,
858 g_return_val_if_fail (G_IS_DRIVE (drive
), FALSE
);
859 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
861 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
863 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
864 if (g_simple_async_result_propagate_error (simple
, error
))
868 iface
= G_DRIVE_GET_IFACE (drive
);
870 return (* iface
->stop_finish
) (drive
, result
, error
);
874 * g_drive_get_sort_key:
877 * Gets the sort key for @drive, if any.
879 * Returns: Sorting key for @drive or %NULL if no such key is available.
884 g_drive_get_sort_key (GDrive
*drive
)
886 const gchar
*ret
= NULL
;
889 g_return_val_if_fail (G_IS_DRIVE (drive
), NULL
);
891 iface
= G_DRIVE_GET_IFACE (drive
);
892 if (iface
->get_sort_key
!= NULL
)
893 ret
= iface
->get_sort_key (drive
);