gio/gvolumemonitor.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2
   3 /* GIO - GLib Input, Output and Streaming Library
   4  *
   5  * Copyright (C) 2006-2007 Red Hat, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  *         David Zeuthen <davidz@redhat.com>
  22  */
  23
  24 #include "config.h"
  25 #include "gvolumemonitor.h"
  26 #include "gvolume.h"
  27 #include "gmount.h"
  28 #include "gdrive.h"
  29 #include "glibintl.h"
  30
  31
  32 /**
  33  * SECTION:gvolumemonitor
  34  * @short_description: Volume Monitor
  35  * @include: gio/gio.h
  36  * @see_also: #GFileMonitor
  37  *
  38  * #GVolumeMonitor is for listing the user interesting devices and volumes
  39  * on the computer. In other words, what a file selector or file manager
  40  * would show in a sidebar.
  41  *
  42  * #GVolumeMonitor is not
  43  * [thread-default-context aware][g-main-context-push-thread-default],
  44  * and so should not be used other than from the main thread, with no
  45  * thread-default-context active.
  46  **/
  47
  48 G_DEFINE_TYPE (GVolumeMonitor, g_volume_monitor, G_TYPE_OBJECT)
  49
  50 enum {
  51   VOLUME_ADDED,
  52   VOLUME_REMOVED,
  53   VOLUME_CHANGED,
  54   MOUNT_ADDED,
  55   MOUNT_REMOVED,
  56   MOUNT_PRE_UNMOUNT,
  57   MOUNT_CHANGED,
  58   DRIVE_CONNECTED,
  59   DRIVE_DISCONNECTED,
  60   DRIVE_CHANGED,
  61   DRIVE_EJECT_BUTTON,
  62   DRIVE_STOP_BUTTON,
  63   LAST_SIGNAL
  64 };
  65
  66 static guint signals[LAST_SIGNAL] = { 0 };
  67
  68
  69 static void
  70 g_volume_monitor_finalize (GObject *object)
  71 {
  72   G_OBJECT_CLASS (g_volume_monitor_parent_class)->finalize (object);
  73 }
  74
  75 static void
  76 g_volume_monitor_class_init (GVolumeMonitorClass *klass)
  77 {
  78   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  79
  80   gobject_class->finalize = g_volume_monitor_finalize;
  81
  82   /**
  83    * GVolumeMonitor::volume-added:
  84    * @volume_monitor: The volume monitor emitting the signal.
  85    * @volume: a #GVolume that was added.
  86    *
  87    * Emitted when a mountable volume is added to the system.
  88    **/
  89   signals[VOLUME_ADDED] = g_signal_new (I_("volume-added"),
  90                                         G_TYPE_VOLUME_MONITOR,
  91                                         G_SIGNAL_RUN_LAST,
  92                                         G_STRUCT_OFFSET (GVolumeMonitorClass, volume_added),
  93                                         NULL, NULL,
  94                                         g_cclosure_marshal_VOID__OBJECT,
  95                                         G_TYPE_NONE, 1, G_TYPE_VOLUME);
  96
  97   /**
  98    * GVolumeMonitor::volume-removed:
  99    * @volume_monitor: The volume monitor emitting the signal.
 100    * @volume: a #GVolume that was removed.
 101    *
 102    * Emitted when a mountable volume is removed from the system.
 103    **/
 104   signals[VOLUME_REMOVED] = g_signal_new (I_("volume-removed"),
 105                                           G_TYPE_VOLUME_MONITOR,
 106                                           G_SIGNAL_RUN_LAST,
 107                                           G_STRUCT_OFFSET (GVolumeMonitorClass, volume_removed),
 108                                           NULL, NULL,
 109                                           g_cclosure_marshal_VOID__OBJECT,
 110                                           G_TYPE_NONE, 1, G_TYPE_VOLUME);
 111
 112   /**
 113    * GVolumeMonitor::volume-changed:
 114    * @volume_monitor: The volume monitor emitting the signal.
 115    * @volume: a #GVolume that changed.
 116    *
 117    * Emitted when mountable volume is changed.
 118    **/
 119   signals[VOLUME_CHANGED] = g_signal_new (I_("volume-changed"),
 120                                           G_TYPE_VOLUME_MONITOR,
 121                                           G_SIGNAL_RUN_LAST,
 122                                           G_STRUCT_OFFSET (GVolumeMonitorClass, volume_changed),
 123                                           NULL, NULL,
 124                                           g_cclosure_marshal_VOID__OBJECT,
 125                                           G_TYPE_NONE, 1, G_TYPE_VOLUME);
 126
 127   /**
 128    * GVolumeMonitor::mount-added:
 129    * @volume_monitor: The volume monitor emitting the signal.
 130    * @mount: a #GMount that was added.
 131    *
 132    * Emitted when a mount is added.
 133    **/
 134   signals[MOUNT_ADDED] = g_signal_new (I_("mount-added"),
 135                                        G_TYPE_VOLUME_MONITOR,
 136                                        G_SIGNAL_RUN_LAST,
 137                                        G_STRUCT_OFFSET (GVolumeMonitorClass, mount_added),
 138                                        NULL, NULL,
 139                                        g_cclosure_marshal_VOID__OBJECT,
 140                                        G_TYPE_NONE, 1, G_TYPE_MOUNT);
 141
 142   /**
 143    * GVolumeMonitor::mount-removed:
 144    * @volume_monitor: The volume monitor emitting the signal.
 145    * @mount: a #GMount that was removed.
 146    *
 147    * Emitted when a mount is removed.
 148    **/
 149   signals[MOUNT_REMOVED] = g_signal_new (I_("mount-removed"),
 150                                          G_TYPE_VOLUME_MONITOR,
 151                                          G_SIGNAL_RUN_LAST,
 152                                          G_STRUCT_OFFSET (GVolumeMonitorClass, mount_removed),
 153                                          NULL, NULL,
 154                                          g_cclosure_marshal_VOID__OBJECT,
 155                                          G_TYPE_NONE, 1, G_TYPE_MOUNT);
 156
 157   /**
 158    * GVolumeMonitor::mount-pre-unmount:
 159    * @volume_monitor: The volume monitor emitting the signal.
 160    * @mount: a #GMount that is being unmounted.
 161    *
 162    * May be emitted when a mount is about to be removed.
 163    *
 164    * This signal depends on the backend and is only emitted if
 165    * GIO was used to unmount.
 166    **/
 167   signals[MOUNT_PRE_UNMOUNT] = g_signal_new (I_("mount-pre-unmount"),
 168                                              G_TYPE_VOLUME_MONITOR,
 169                                              G_SIGNAL_RUN_LAST,
 170                                              G_STRUCT_OFFSET (GVolumeMonitorClass, mount_pre_unmount),
 171                                              NULL, NULL,
 172                                              g_cclosure_marshal_VOID__OBJECT,
 173                                              G_TYPE_NONE, 1, G_TYPE_MOUNT);
 174
 175   /**
 176    * GVolumeMonitor::mount-changed:
 177    * @volume_monitor: The volume monitor emitting the signal.
 178    * @mount: a #GMount that changed.
 179    *
 180    * Emitted when a mount changes.
 181    **/
 182   signals[MOUNT_CHANGED] = g_signal_new (I_("mount-changed"),
 183                                          G_TYPE_VOLUME_MONITOR,
 184                                          G_SIGNAL_RUN_LAST,
 185                                          G_STRUCT_OFFSET (GVolumeMonitorClass, mount_changed),
 186                                          NULL, NULL,
 187                                          g_cclosure_marshal_VOID__OBJECT,
 188                                          G_TYPE_NONE, 1, G_TYPE_MOUNT);
 189
 190   /**
 191    * GVolumeMonitor::drive-connected:
 192    * @volume_monitor: The volume monitor emitting the signal.
 193    * @drive: a #GDrive that was connected.
 194    *
 195    * Emitted when a drive is connected to the system.
 196    **/
 197   signals[DRIVE_CONNECTED] = g_signal_new (I_("drive-connected"),
 198                                            G_TYPE_VOLUME_MONITOR,
 199                                            G_SIGNAL_RUN_LAST,
 200                                            G_STRUCT_OFFSET (GVolumeMonitorClass, drive_connected),
 201                                            NULL, NULL,
 202                                            g_cclosure_marshal_VOID__OBJECT,
 203                                            G_TYPE_NONE, 1, G_TYPE_DRIVE);
 204
 205   /**
 206    * GVolumeMonitor::drive-disconnected:
 207    * @volume_monitor: The volume monitor emitting the signal.
 208    * @drive: a #GDrive that was disconnected.
 209    *
 210    * Emitted when a drive is disconnected from the system.
 211    **/
 212   signals[DRIVE_DISCONNECTED] = g_signal_new (I_("drive-disconnected"),
 213                                               G_TYPE_VOLUME_MONITOR,
 214                                               G_SIGNAL_RUN_LAST,
 215                                               G_STRUCT_OFFSET (GVolumeMonitorClass, drive_disconnected),
 216                                               NULL, NULL,
 217                                               g_cclosure_marshal_VOID__OBJECT,
 218                                               G_TYPE_NONE, 1, G_TYPE_DRIVE);
 219
 220   /**
 221    * GVolumeMonitor::drive-changed:
 222    * @volume_monitor: The volume monitor emitting the signal.
 223    * @drive: the drive that changed
 224    *
 225    * Emitted when a drive changes.
 226    **/
 227   signals[DRIVE_CHANGED] = g_signal_new (I_("drive-changed"),
 228                                          G_TYPE_VOLUME_MONITOR,
 229                                          G_SIGNAL_RUN_LAST,
 230                                          G_STRUCT_OFFSET (GVolumeMonitorClass, drive_changed),
 231                                          NULL, NULL,
 232                                          g_cclosure_marshal_VOID__OBJECT,
 233                                          G_TYPE_NONE, 1, G_TYPE_DRIVE);
 234
 235   /**
 236    * GVolumeMonitor::drive-eject-button:
 237    * @volume_monitor: The volume monitor emitting the signal.
 238    * @drive: the drive where the eject button was pressed
 239    *
 240    * Emitted when the eject button is pressed on @drive.
 241    *
 242    * Since: 2.18
 243    **/
 244   signals[DRIVE_EJECT_BUTTON] = g_signal_new (I_("drive-eject-button"),
 245                                               G_TYPE_VOLUME_MONITOR,
 246                                               G_SIGNAL_RUN_LAST,
 247                                               G_STRUCT_OFFSET (GVolumeMonitorClass, drive_eject_button),
 248                                               NULL, NULL,
 249                                               g_cclosure_marshal_VOID__OBJECT,
 250                                               G_TYPE_NONE, 1, G_TYPE_DRIVE);
 251
 252   /**
 253    * GVolumeMonitor::drive-stop-button:
 254    * @volume_monitor: The volume monitor emitting the signal.
 255    * @drive: the drive where the stop button was pressed
 256    *
 257    * Emitted when the stop button is pressed on @drive.
 258    *
 259    * Since: 2.22
 260    **/
 261   signals[DRIVE_STOP_BUTTON] = g_signal_new (I_("drive-stop-button"),
 262                                              G_TYPE_VOLUME_MONITOR,
 263                                              G_SIGNAL_RUN_LAST,
 264                                              G_STRUCT_OFFSET (GVolumeMonitorClass, drive_stop_button),
 265                                              NULL, NULL,
 266                                              g_cclosure_marshal_VOID__OBJECT,
 267                                              G_TYPE_NONE, 1, G_TYPE_DRIVE);
 268
 269 }
 270
 271 static void
 272 g_volume_monitor_init (GVolumeMonitor *monitor)
 273 {
 274 }
 275
 276
 277 /**
 278  * g_volume_monitor_get_connected_drives:
 279  * @volume_monitor: a #GVolumeMonitor.
 280  *
 281  * Gets a list of drives connected to the system.
 282  *
 283  * The returned list should be freed with g_list_free(), after
 284  * its elements have been unreffed with g_object_unref().
 285  *
 286  * Returns: (element-type GDrive) (transfer full): a #GList of connected #GDrive objects.
 287  **/
 288 GList *
 289 g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor)
 290 {
 291   GVolumeMonitorClass *class;
 292
 293   g_return_val_if_fail (G_IS_VOLUME_MONITOR (volume_monitor), NULL);
 294
 295   class = G_VOLUME_MONITOR_GET_CLASS (volume_monitor);
 296
 297   return class->get_connected_drives (volume_monitor);
 298 }
 299
 300 /**
 301  * g_volume_monitor_get_volumes:
 302  * @volume_monitor: a #GVolumeMonitor.
 303  *
 304  * Gets a list of the volumes on the system.
 305  *
 306  * The returned list should be freed with g_list_free(), after
 307  * its elements have been unreffed with g_object_unref().
 308  *
 309  * Returns: (element-type GVolume) (transfer full): a #GList of #GVolume objects.
 310  **/
 311 GList *
 312 g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor)
 313 {
 314   GVolumeMonitorClass *class;
 315
 316   g_return_val_if_fail (G_IS_VOLUME_MONITOR (volume_monitor), NULL);
 317
 318   class = G_VOLUME_MONITOR_GET_CLASS (volume_monitor);
 319
 320   return class->get_volumes (volume_monitor);
 321 }
 322
 323 /**
 324  * g_volume_monitor_get_mounts:
 325  * @volume_monitor: a #GVolumeMonitor.
 326  *
 327  * Gets a list of the mounts on the system.
 328  *
 329  * The returned list should be freed with g_list_free(), after
 330  * its elements have been unreffed with g_object_unref().
 331  *
 332  * Returns: (element-type GMount) (transfer full): a #GList of #GMount objects.
 333  **/
 334 GList *
 335 g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor)
 336 {
 337   GVolumeMonitorClass *class;
 338
 339   g_return_val_if_fail (G_IS_VOLUME_MONITOR (volume_monitor), NULL);
 340
 341   class = G_VOLUME_MONITOR_GET_CLASS (volume_monitor);
 342
 343   return class->get_mounts (volume_monitor);
 344 }
 345
 346 /**
 347  * g_volume_monitor_get_volume_for_uuid:
 348  * @volume_monitor: a #GVolumeMonitor.
 349  * @uuid: the UUID to look for
 350  *
 351  * Finds a #GVolume object by its UUID (see g_volume_get_uuid())
 352  *
 353  * Returns: (transfer full): a #GVolume or %NULL if no such volume is available.
 354  *     Free the returned object with g_object_unref().
 355  **/
 356 GVolume *
 357 g_volume_monitor_get_volume_for_uuid (GVolumeMonitor *volume_monitor,
 358                                       const char     *uuid)
 359 {
 360   GVolumeMonitorClass *class;
 361
 362   g_return_val_if_fail (G_IS_VOLUME_MONITOR (volume_monitor), NULL);
 363   g_return_val_if_fail (uuid != NULL, NULL);
 364
 365   class = G_VOLUME_MONITOR_GET_CLASS (volume_monitor);
 366
 367   return class->get_volume_for_uuid (volume_monitor, uuid);
 368 }
 369
 370 /**
 371  * g_volume_monitor_get_mount_for_uuid:
 372  * @volume_monitor: a #GVolumeMonitor.
 373  * @uuid: the UUID to look for
 374  *
 375  * Finds a #GMount object by its UUID (see g_mount_get_uuid())
 376  *
 377  * Returns: (transfer full): a #GMount or %NULL if no such mount is available.
 378  *     Free the returned object with g_object_unref().
 379  **/
 380 GMount *
 381 g_volume_monitor_get_mount_for_uuid (GVolumeMonitor *volume_monitor,
 382                                      const char     *uuid)
 383 {
 384   GVolumeMonitorClass *class;
 385
 386   g_return_val_if_fail (G_IS_VOLUME_MONITOR (volume_monitor), NULL);
 387   g_return_val_if_fail (uuid != NULL, NULL);
 388
 389   class = G_VOLUME_MONITOR_GET_CLASS (volume_monitor);
 390
 391   return class->get_mount_for_uuid (volume_monitor, uuid);
 392 }