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"
35 * @short_description: Drive management
38 * #GDrive - this represent a piece of hardware connected to the machine.
39 * It's generally only created for removable hardware or hardware with
42 * #GDrive is a container class for #GVolume objects that stem from
43 * the same piece of media. As such, #GDrive abstracts a drive with
44 * (or without) removable media and provides operations for querying
45 * whether media is available, determing whether media change is
46 * automatically detected and ejecting the media.
48 * If the #GDrive reports that media isn't automatically detected, one
49 * can poll for media; typically one should not do this periodically
50 * as a poll for media operation is potententially expensive and may
51 * spin up the drive creating noise.
53 * #GDrive supports starting and stopping drives with authentication
54 * support for the former. This can be used to support a diverse set
55 * of use cases including connecting/disconnecting iSCSI devices,
56 * powering down external disk enclosures and starting/stopping
57 * multi-disk devices such as RAID devices. Note that the actual
58 * semantics and side-effects of starting/stopping a #GDrive may vary
59 * according to implementation. To choose the correct verbs in e.g. a
60 * file manager, use g_drive_get_start_stop_type().
62 * For porting from GnomeVFS note that there is no equivalent of
63 * #GDrive in that API.
66 typedef GDriveIface GDriveInterface;
67 G_DEFINE_INTERFACE(GDrive, g_drive, G_TYPE_OBJECT)
70 g_drive_default_init (GDriveInterface *iface)
76 * Emitted when the drive's state has changed.
78 g_signal_new (I_("changed"),
81 G_STRUCT_OFFSET (GDriveIface, changed),
83 g_cclosure_marshal_VOID__VOID,
87 * GDrive::disconnected:
90 * This signal is emitted when the #GDrive have been
91 * disconnected. If the recipient is holding references to the
92 * object they should release them so the object can be
95 g_signal_new (I_("disconnected"),
98 G_STRUCT_OFFSET (GDriveIface, disconnected),
100 g_cclosure_marshal_VOID__VOID,
104 * GDrive::eject-button:
107 * Emitted when the physical eject button (if any) of a drive has
110 g_signal_new (I_("eject-button"),
113 G_STRUCT_OFFSET (GDriveIface, eject_button),
115 g_cclosure_marshal_VOID__VOID,
119 * GDrive::stop-button:
122 * Emitted when the physical stop button (if any) of a drive has
127 g_signal_new (I_("stop-button"),
130 G_STRUCT_OFFSET (GDriveIface, stop_button),
132 g_cclosure_marshal_VOID__VOID,
140 * Gets the name of @drive.
142 * Returns: a string containing @drive's name. The returned
143 * string should be freed when no longer needed.
146 g_drive_get_name (GDrive *drive)
150 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
152 iface = G_DRIVE_GET_IFACE (drive);
154 return (* iface->get_name) (drive);
161 * Gets the icon for @drive.
163 * Returns: #GIcon for the @drive.
164 * Free the returned object with g_object_unref().
167 g_drive_get_icon (GDrive *drive)
171 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
173 iface = G_DRIVE_GET_IFACE (drive);
175 return (* iface->get_icon) (drive);
179 * g_drive_has_volumes:
182 * Check if @drive has any mountable volumes.
184 * Returns: %TRUE if the @drive contains volumes, %FALSE otherwise.
187 g_drive_has_volumes (GDrive *drive)
191 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
193 iface = G_DRIVE_GET_IFACE (drive);
195 return (* iface->has_volumes) (drive);
199 * g_drive_get_volumes:
202 * Get a list of mountable volumes for @drive.
204 * The returned list should be freed with g_list_free(), after
205 * its elements have been unreffed with g_object_unref().
207 * Returns: #GList containing any #GVolume objects on the given @drive.
210 g_drive_get_volumes (GDrive *drive)
214 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
216 iface = G_DRIVE_GET_IFACE (drive);
218 return (* iface->get_volumes) (drive);
222 * g_drive_is_media_check_automatic:
225 * Checks if @drive is capabable of automatically detecting media changes.
227 * Returns: %TRUE if the @drive is capabable of automatically detecting
228 * media changes, %FALSE otherwise.
231 g_drive_is_media_check_automatic (GDrive *drive)
235 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
237 iface = G_DRIVE_GET_IFACE (drive);
239 return (* iface->is_media_check_automatic) (drive);
243 * g_drive_is_media_removable:
246 * Checks if the @drive supports removable media.
248 * Returns: %TRUE if @drive supports removable media, %FALSE otherwise.
251 g_drive_is_media_removable (GDrive *drive)
255 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
257 iface = G_DRIVE_GET_IFACE (drive);
259 return (* iface->is_media_removable) (drive);
266 * Checks if the @drive has media. Note that the OS may not be polling
267 * the drive for media changes; see g_drive_is_media_check_automatic()
270 * Returns: %TRUE if @drive has media, %FALSE otherwise.
273 g_drive_has_media (GDrive *drive)
277 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
279 iface = G_DRIVE_GET_IFACE (drive);
281 return (* iface->has_media) (drive);
288 * Checks if a drive can be ejected.
290 * Returns: %TRUE if the @drive can be ejected, %FALSE otherwise.
293 g_drive_can_eject (GDrive *drive)
297 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
299 iface = G_DRIVE_GET_IFACE (drive);
301 if (iface->can_eject == NULL)
304 return (* iface->can_eject) (drive);
308 * g_drive_can_poll_for_media:
311 * Checks if a drive can be polled for media changes.
313 * Returns: %TRUE if the @drive can be polled for media changes,
317 g_drive_can_poll_for_media (GDrive *drive)
321 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
323 iface = G_DRIVE_GET_IFACE (drive);
325 if (iface->poll_for_media == NULL)
328 return (* iface->can_poll_for_media) (drive);
334 * @flags: flags affecting the unmount if required for eject
335 * @cancellable: optional #GCancellable object, %NULL to ignore.
336 * @callback: a #GAsyncReadyCallback, or %NULL.
337 * @user_data: user data to pass to @callback
339 * Asynchronously ejects a drive.
341 * When the operation is finished, @callback will be called.
342 * You can then call g_drive_eject_finish() to obtain the
343 * result of the operation.
345 * Deprecated: 2.22: Use g_drive_eject_with_operation() instead.
348 g_drive_eject (GDrive *drive,
349 GMountUnmountFlags flags,
350 GCancellable *cancellable,
351 GAsyncReadyCallback callback,
356 g_return_if_fail (G_IS_DRIVE (drive));
358 iface = G_DRIVE_GET_IFACE (drive);
360 if (iface->eject == NULL)
362 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
363 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
364 _("drive doesn't implement eject"));
369 (* iface->eject) (drive, flags, cancellable, callback, user_data);
373 * g_drive_eject_finish:
375 * @result: a #GAsyncResult.
376 * @error: a #GError, or %NULL
378 * Finishes ejecting a drive.
380 * Returns: %TRUE if the drive has been ejected successfully,
383 * Deprecated: 2.22: Use g_drive_eject_with_operation_finish() instead.
386 g_drive_eject_finish (GDrive *drive,
387 GAsyncResult *result,
392 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
393 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
395 if (G_IS_SIMPLE_ASYNC_RESULT (result))
397 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
398 if (g_simple_async_result_propagate_error (simple, error))
402 iface = G_DRIVE_GET_IFACE (drive);
404 return (* iface->eject_finish) (drive, result, error);
408 * g_drive_eject_with_operation:
410 * @flags: flags affecting the unmount if required for eject
411 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
412 * @cancellable: optional #GCancellable object, %NULL to ignore.
413 * @callback: 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 occuring, 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: optional #GCancellable object, %NULL to ignore.
496 * @callback: 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: a %NULL-terminated array of strings containing
599 * kinds of identifiers. Use g_strfreev() to free.
602 g_drive_enumerate_identifiers (GDrive *drive)
606 g_return_val_if_fail (G_IS_DRIVE (drive), NULL);
607 iface = G_DRIVE_GET_IFACE (drive);
609 if (iface->enumerate_identifiers == NULL)
612 return (* iface->enumerate_identifiers) (drive);
616 * g_drive_get_start_stop_type:
619 * Gets a hint about how a drive can be started/stopped.
621 * Returns: A value from the #GDriveStartStopType enumeration.
626 g_drive_get_start_stop_type (GDrive *drive)
630 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
632 iface = G_DRIVE_GET_IFACE (drive);
634 if (iface->get_start_stop_type == NULL)
635 return G_DRIVE_START_STOP_TYPE_UNKNOWN;
637 return (* iface->get_start_stop_type) (drive);
645 * Checks if a drive can be started.
647 * Returns: %TRUE if the @drive can be started, %FALSE otherwise.
652 g_drive_can_start (GDrive *drive)
656 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
658 iface = G_DRIVE_GET_IFACE (drive);
660 if (iface->can_start == NULL)
663 return (* iface->can_start) (drive);
667 * g_drive_can_start_degraded:
670 * Checks if a drive can be started degraded.
672 * Returns: %TRUE if the @drive can be started degraded, %FALSE otherwise.
677 g_drive_can_start_degraded (GDrive *drive)
681 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
683 iface = G_DRIVE_GET_IFACE (drive);
685 if (iface->can_start_degraded == NULL)
688 return (* iface->can_start_degraded) (drive);
694 * @flags: flags affecting the start operation.
695 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
696 * @cancellable: optional #GCancellable object, %NULL to ignore.
697 * @callback: a #GAsyncReadyCallback, or %NULL.
698 * @user_data: user data to pass to @callback
700 * Asynchronously starts a drive.
702 * When the operation is finished, @callback will be called.
703 * You can then call g_drive_start_finish() to obtain the
704 * result of the operation.
709 g_drive_start (GDrive *drive,
710 GDriveStartFlags flags,
711 GMountOperation *mount_operation,
712 GCancellable *cancellable,
713 GAsyncReadyCallback callback,
718 g_return_if_fail (G_IS_DRIVE (drive));
720 iface = G_DRIVE_GET_IFACE (drive);
722 if (iface->start == NULL)
724 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
725 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
726 _("drive doesn't implement start"));
730 (* iface->start) (drive, flags, mount_operation, cancellable, callback, user_data);
734 * g_drive_start_finish:
736 * @result: a #GAsyncResult.
737 * @error: a #GError, or %NULL
739 * Finishes starting a drive.
741 * Returns: %TRUE if the drive has been started successfully,
747 g_drive_start_finish (GDrive *drive,
748 GAsyncResult *result,
753 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
754 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
756 if (G_IS_SIMPLE_ASYNC_RESULT (result))
758 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
759 if (g_simple_async_result_propagate_error (simple, error))
763 iface = G_DRIVE_GET_IFACE (drive);
765 return (* iface->start_finish) (drive, result, error);
772 * Checks if a drive can be stopped.
774 * Returns: %TRUE if the @drive can be stopped, %FALSE otherwise.
779 g_drive_can_stop (GDrive *drive)
783 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
785 iface = G_DRIVE_GET_IFACE (drive);
787 if (iface->can_stop == NULL)
790 return (* iface->can_stop) (drive);
796 * @flags: flags affecting the unmount if required for stopping.
797 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
798 * @cancellable: optional #GCancellable object, %NULL to ignore.
799 * @callback: a #GAsyncReadyCallback, or %NULL.
800 * @user_data: user data to pass to @callback
802 * Asynchronously stops a drive.
804 * When the operation is finished, @callback will be called.
805 * You can then call g_drive_stop_finish() to obtain the
806 * result of the operation.
811 g_drive_stop (GDrive *drive,
812 GMountUnmountFlags flags,
813 GMountOperation *mount_operation,
814 GCancellable *cancellable,
815 GAsyncReadyCallback callback,
820 g_return_if_fail (G_IS_DRIVE (drive));
822 iface = G_DRIVE_GET_IFACE (drive);
824 if (iface->stop == NULL)
826 g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
827 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
828 _("drive doesn't implement stop"));
832 (* iface->stop) (drive, flags, mount_operation, cancellable, callback, user_data);
836 * g_drive_stop_finish:
838 * @result: a #GAsyncResult.
839 * @error: a #GError, or %NULL
841 * Finishes stopping a drive.
843 * Returns: %TRUE if the drive has been stopped successfully,
849 g_drive_stop_finish (GDrive *drive,
850 GAsyncResult *result,
855 g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);
856 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
858 if (G_IS_SIMPLE_ASYNC_RESULT (result))
860 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
861 if (g_simple_async_result_propagate_error (simple, error))
865 iface = G_DRIVE_GET_IFACE (drive);
867 return (* iface->stop_finish) (drive, result, error);
870 #define __G_DRIVE_C__
871 #include "gioaliasdef.c"