gtestutils: Fix a typo in a documentation comment
[glib.git] / gio / gunionvolumemonitor.c
blob6af2664b6f9560d2447cf01ec148e05d5dc9b694
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
4 *
5 * Copyright (C) 2006-2007 Red Hat, Inc.
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 of the License, or (at your option) any later version.
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.
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/>.
20 * Author: Alexander Larsson <alexl@redhat.com>
21 * David Zeuthen <davidz@redhat.com>
24 #include "config.h"
26 #include <string.h>
28 #include <glib.h>
29 #include "gunionvolumemonitor.h"
30 #include "gmountprivate.h"
31 #include "giomodule-priv.h"
32 #ifdef G_OS_UNIX
33 #include "gunixvolumemonitor.h"
34 #endif
35 #include "gnativevolumemonitor.h"
37 #include "glibintl.h"
40 struct _GUnionVolumeMonitor {
41 GVolumeMonitor parent;
43 GList *monitors;
46 static void g_union_volume_monitor_remove_monitor (GUnionVolumeMonitor *union_monitor,
47 GVolumeMonitor *child_monitor);
50 #define g_union_volume_monitor_get_type _g_union_volume_monitor_get_type
51 G_DEFINE_TYPE (GUnionVolumeMonitor, g_union_volume_monitor, G_TYPE_VOLUME_MONITOR);
53 static GRecMutex the_volume_monitor_mutex;
55 static GUnionVolumeMonitor *the_volume_monitor = NULL;
57 static void
58 g_union_volume_monitor_finalize (GObject *object)
60 GUnionVolumeMonitor *monitor;
61 GVolumeMonitor *child_monitor;
63 monitor = G_UNION_VOLUME_MONITOR (object);
65 while (monitor->monitors != NULL)
67 child_monitor = monitor->monitors->data;
68 g_union_volume_monitor_remove_monitor (monitor,
69 child_monitor);
70 g_object_unref (child_monitor);
73 G_OBJECT_CLASS (g_union_volume_monitor_parent_class)->finalize (object);
76 static void
77 g_union_volume_monitor_dispose (GObject *object)
79 GUnionVolumeMonitor *monitor;
80 GVolumeMonitor *child_monitor;
81 GList *l;
83 monitor = G_UNION_VOLUME_MONITOR (object);
85 g_rec_mutex_lock (&the_volume_monitor_mutex);
86 the_volume_monitor = NULL;
88 for (l = monitor->monitors; l != NULL; l = l->next)
90 child_monitor = l->data;
91 g_object_run_dispose (G_OBJECT (child_monitor));
94 g_rec_mutex_unlock (&the_volume_monitor_mutex);
96 G_OBJECT_CLASS (g_union_volume_monitor_parent_class)->dispose (object);
99 static GList *
100 get_mounts (GVolumeMonitor *volume_monitor)
102 GUnionVolumeMonitor *monitor;
103 GVolumeMonitor *child_monitor;
104 GList *res;
105 GList *l;
107 monitor = G_UNION_VOLUME_MONITOR (volume_monitor);
109 res = NULL;
111 g_rec_mutex_lock (&the_volume_monitor_mutex);
113 for (l = monitor->monitors; l != NULL; l = l->next)
115 child_monitor = l->data;
117 res = g_list_concat (res, g_volume_monitor_get_mounts (child_monitor));
120 g_rec_mutex_unlock (&the_volume_monitor_mutex);
122 return res;
125 static GList *
126 get_volumes (GVolumeMonitor *volume_monitor)
128 GUnionVolumeMonitor *monitor;
129 GVolumeMonitor *child_monitor;
130 GList *res;
131 GList *l;
133 monitor = G_UNION_VOLUME_MONITOR (volume_monitor);
135 res = NULL;
137 g_rec_mutex_lock (&the_volume_monitor_mutex);
139 for (l = monitor->monitors; l != NULL; l = l->next)
141 child_monitor = l->data;
143 res = g_list_concat (res, g_volume_monitor_get_volumes (child_monitor));
146 g_rec_mutex_unlock (&the_volume_monitor_mutex);
148 return res;
151 static GList *
152 get_connected_drives (GVolumeMonitor *volume_monitor)
154 GUnionVolumeMonitor *monitor;
155 GVolumeMonitor *child_monitor;
156 GList *res;
157 GList *l;
159 monitor = G_UNION_VOLUME_MONITOR (volume_monitor);
161 res = NULL;
163 g_rec_mutex_lock (&the_volume_monitor_mutex);
165 for (l = monitor->monitors; l != NULL; l = l->next)
167 child_monitor = l->data;
169 res = g_list_concat (res, g_volume_monitor_get_connected_drives (child_monitor));
172 g_rec_mutex_unlock (&the_volume_monitor_mutex);
174 return res;
177 static GVolume *
178 get_volume_for_uuid (GVolumeMonitor *volume_monitor, const char *uuid)
180 GUnionVolumeMonitor *monitor;
181 GVolumeMonitor *child_monitor;
182 GVolume *volume;
183 GList *l;
185 monitor = G_UNION_VOLUME_MONITOR (volume_monitor);
187 volume = NULL;
189 g_rec_mutex_lock (&the_volume_monitor_mutex);
191 for (l = monitor->monitors; l != NULL; l = l->next)
193 child_monitor = l->data;
195 volume = g_volume_monitor_get_volume_for_uuid (child_monitor, uuid);
196 if (volume != NULL)
197 break;
201 g_rec_mutex_unlock (&the_volume_monitor_mutex);
203 return volume;
206 static GMount *
207 get_mount_for_uuid (GVolumeMonitor *volume_monitor, const char *uuid)
209 GUnionVolumeMonitor *monitor;
210 GVolumeMonitor *child_monitor;
211 GMount *mount;
212 GList *l;
214 monitor = G_UNION_VOLUME_MONITOR (volume_monitor);
216 mount = NULL;
218 g_rec_mutex_lock (&the_volume_monitor_mutex);
220 for (l = monitor->monitors; l != NULL; l = l->next)
222 child_monitor = l->data;
224 mount = g_volume_monitor_get_mount_for_uuid (child_monitor, uuid);
225 if (mount != NULL)
226 break;
230 g_rec_mutex_unlock (&the_volume_monitor_mutex);
232 return mount;
235 static void
236 g_union_volume_monitor_class_init (GUnionVolumeMonitorClass *klass)
238 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
239 GVolumeMonitorClass *monitor_class = G_VOLUME_MONITOR_CLASS (klass);
241 gobject_class->finalize = g_union_volume_monitor_finalize;
242 gobject_class->dispose = g_union_volume_monitor_dispose;
244 monitor_class->get_connected_drives = get_connected_drives;
245 monitor_class->get_volumes = get_volumes;
246 monitor_class->get_mounts = get_mounts;
247 monitor_class->get_volume_for_uuid = get_volume_for_uuid;
248 monitor_class->get_mount_for_uuid = get_mount_for_uuid;
251 static void
252 child_volume_added (GVolumeMonitor *child_monitor,
253 GVolume *child_volume,
254 GUnionVolumeMonitor *union_monitor)
256 g_signal_emit_by_name (union_monitor,
257 "volume-added",
258 child_volume);
261 static void
262 child_volume_removed (GVolumeMonitor *child_monitor,
263 GVolume *child_volume,
264 GUnionVolumeMonitor *union_monitor)
266 g_signal_emit_by_name (union_monitor,
267 "volume-removed",
268 child_volume);
271 static void
272 child_volume_changed (GVolumeMonitor *child_monitor,
273 GVolume *child_volume,
274 GUnionVolumeMonitor *union_monitor)
276 g_signal_emit_by_name (union_monitor,
277 "volume-changed",
278 child_volume);
281 static void
282 child_mount_added (GVolumeMonitor *child_monitor,
283 GMount *child_mount,
284 GUnionVolumeMonitor *union_monitor)
286 g_signal_emit_by_name (union_monitor,
287 "mount-added",
288 child_mount);
291 static void
292 child_mount_removed (GVolumeMonitor *child_monitor,
293 GMount *child_mount,
294 GUnionVolumeMonitor *union_monitor)
296 g_signal_emit_by_name (union_monitor,
297 "mount-removed",
298 child_mount);
301 static void
302 child_mount_pre_unmount (GVolumeMonitor *child_monitor,
303 GMount *child_mount,
304 GUnionVolumeMonitor *union_monitor)
306 g_signal_emit_by_name (union_monitor,
307 "mount-pre-unmount",
308 child_mount);
312 static void
313 child_mount_changed (GVolumeMonitor *child_monitor,
314 GMount *child_mount,
315 GUnionVolumeMonitor *union_monitor)
317 g_signal_emit_by_name (union_monitor,
318 "mount-changed",
319 child_mount);
322 static void
323 child_drive_connected (GVolumeMonitor *child_monitor,
324 GDrive *child_drive,
325 GUnionVolumeMonitor *union_monitor)
327 g_signal_emit_by_name (union_monitor,
328 "drive-connected",
329 child_drive);
332 static void
333 child_drive_disconnected (GVolumeMonitor *child_monitor,
334 GDrive *child_drive,
335 GUnionVolumeMonitor *union_monitor)
337 g_signal_emit_by_name (union_monitor,
338 "drive-disconnected",
339 child_drive);
342 static void
343 child_drive_changed (GVolumeMonitor *child_monitor,
344 GDrive *child_drive,
345 GUnionVolumeMonitor *union_monitor)
347 g_signal_emit_by_name (union_monitor,
348 "drive-changed",
349 child_drive);
352 static void
353 child_drive_eject_button (GVolumeMonitor *child_monitor,
354 GDrive *child_drive,
355 GUnionVolumeMonitor *union_monitor)
357 g_signal_emit_by_name (union_monitor,
358 "drive-eject-button",
359 child_drive);
362 static void
363 child_drive_stop_button (GVolumeMonitor *child_monitor,
364 GDrive *child_drive,
365 GUnionVolumeMonitor *union_monitor)
367 g_signal_emit_by_name (union_monitor,
368 "drive-stop-button",
369 child_drive);
372 static void
373 g_union_volume_monitor_add_monitor (GUnionVolumeMonitor *union_monitor,
374 GVolumeMonitor *volume_monitor)
376 if (g_list_find (union_monitor->monitors, volume_monitor))
377 return;
379 union_monitor->monitors =
380 g_list_prepend (union_monitor->monitors,
381 g_object_ref (volume_monitor));
383 g_signal_connect (volume_monitor, "volume-added", (GCallback)child_volume_added, union_monitor);
384 g_signal_connect (volume_monitor, "volume-removed", (GCallback)child_volume_removed, union_monitor);
385 g_signal_connect (volume_monitor, "volume-changed", (GCallback)child_volume_changed, union_monitor);
386 g_signal_connect (volume_monitor, "mount-added", (GCallback)child_mount_added, union_monitor);
387 g_signal_connect (volume_monitor, "mount-removed", (GCallback)child_mount_removed, union_monitor);
388 g_signal_connect (volume_monitor, "mount-pre-unmount", (GCallback)child_mount_pre_unmount, union_monitor);
389 g_signal_connect (volume_monitor, "mount-changed", (GCallback)child_mount_changed, union_monitor);
390 g_signal_connect (volume_monitor, "drive-connected", (GCallback)child_drive_connected, union_monitor);
391 g_signal_connect (volume_monitor, "drive-disconnected", (GCallback)child_drive_disconnected, union_monitor);
392 g_signal_connect (volume_monitor, "drive-changed", (GCallback)child_drive_changed, union_monitor);
393 g_signal_connect (volume_monitor, "drive-eject-button", (GCallback)child_drive_eject_button, union_monitor);
394 g_signal_connect (volume_monitor, "drive-stop-button", (GCallback)child_drive_stop_button, union_monitor);
397 static void
398 g_union_volume_monitor_remove_monitor (GUnionVolumeMonitor *union_monitor,
399 GVolumeMonitor *child_monitor)
401 GList *l;
403 l = g_list_find (union_monitor->monitors, child_monitor);
404 if (l == NULL)
405 return;
407 union_monitor->monitors = g_list_delete_link (union_monitor->monitors, l);
409 g_signal_handlers_disconnect_by_func (child_monitor, child_volume_added, union_monitor);
410 g_signal_handlers_disconnect_by_func (child_monitor, child_volume_removed, union_monitor);
411 g_signal_handlers_disconnect_by_func (child_monitor, child_volume_changed, union_monitor);
412 g_signal_handlers_disconnect_by_func (child_monitor, child_mount_added, union_monitor);
413 g_signal_handlers_disconnect_by_func (child_monitor, child_mount_removed, union_monitor);
414 g_signal_handlers_disconnect_by_func (child_monitor, child_mount_pre_unmount, union_monitor);
415 g_signal_handlers_disconnect_by_func (child_monitor, child_mount_changed, union_monitor);
416 g_signal_handlers_disconnect_by_func (child_monitor, child_drive_connected, union_monitor);
417 g_signal_handlers_disconnect_by_func (child_monitor, child_drive_disconnected, union_monitor);
418 g_signal_handlers_disconnect_by_func (child_monitor, child_drive_changed, union_monitor);
419 g_signal_handlers_disconnect_by_func (child_monitor, child_drive_eject_button, union_monitor);
420 g_signal_handlers_disconnect_by_func (child_monitor, child_drive_stop_button, union_monitor);
423 static GType
424 get_default_native_class (gpointer data)
426 GNativeVolumeMonitorClass *klass, *native_class, **native_class_out;
427 const char *use_this;
428 GIOExtensionPoint *ep;
429 GIOExtension *extension;
430 GList *l;
432 native_class_out = data;
434 use_this = g_getenv ("GIO_USE_VOLUME_MONITOR");
436 /* Ensure vfs in modules loaded */
437 _g_io_modules_ensure_loaded ();
439 ep = g_io_extension_point_lookup (G_NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME);
441 native_class = NULL;
442 if (use_this)
444 extension = g_io_extension_point_get_extension_by_name (ep, use_this);
445 if (extension)
447 klass = G_NATIVE_VOLUME_MONITOR_CLASS (g_io_extension_ref_class (extension));
448 if (G_VOLUME_MONITOR_CLASS (klass)->is_supported())
449 native_class = klass;
450 else
451 g_type_class_unref (klass);
455 if (native_class == NULL)
457 for (l = g_io_extension_point_get_extensions (ep); l != NULL; l = l->next)
459 extension = l->data;
460 klass = G_NATIVE_VOLUME_MONITOR_CLASS (g_io_extension_ref_class (extension));
461 if (G_VOLUME_MONITOR_CLASS (klass)->is_supported())
463 native_class = klass;
464 break;
466 else
467 g_type_class_unref (klass);
471 if (native_class)
473 *native_class_out = native_class;
474 return G_TYPE_FROM_CLASS (native_class);
476 else
477 return G_TYPE_INVALID;
480 /* We return the class, with a ref taken.
481 * This way we avoid unloading the class/module
482 * between selecting the type and creating the
483 * instance on the first call.
485 static GNativeVolumeMonitorClass *
486 get_native_class (void)
488 static GOnce once_init = G_ONCE_INIT;
489 GTypeClass *type_class;
491 type_class = NULL;
492 g_once (&once_init, (GThreadFunc)get_default_native_class, &type_class);
494 if (type_class == NULL && once_init.retval != GUINT_TO_POINTER(G_TYPE_INVALID))
495 type_class = g_type_class_ref ((GType)once_init.retval);
497 return (GNativeVolumeMonitorClass *)type_class;
500 static void
501 g_union_volume_monitor_init (GUnionVolumeMonitor *union_monitor)
505 static void
506 populate_union_monitor (GUnionVolumeMonitor *union_monitor)
508 GVolumeMonitor *monitor;
509 GNativeVolumeMonitorClass *native_class;
510 GVolumeMonitorClass *klass;
511 GIOExtensionPoint *ep;
512 GIOExtension *extension;
513 GList *l;
515 native_class = get_native_class ();
517 if (native_class != NULL)
519 monitor = g_object_new (G_TYPE_FROM_CLASS (native_class), NULL);
520 g_union_volume_monitor_add_monitor (union_monitor, monitor);
521 g_object_unref (monitor);
522 g_type_class_unref (native_class);
525 ep = g_io_extension_point_lookup (G_VOLUME_MONITOR_EXTENSION_POINT_NAME);
526 for (l = g_io_extension_point_get_extensions (ep); l != NULL; l = l->next)
528 extension = l->data;
530 klass = G_VOLUME_MONITOR_CLASS (g_io_extension_ref_class (extension));
531 if (klass->is_supported == NULL || klass->is_supported())
533 monitor = g_object_new (g_io_extension_get_type (extension), NULL);
534 g_union_volume_monitor_add_monitor (union_monitor, monitor);
535 g_object_unref (monitor);
537 g_type_class_unref (klass);
541 static GUnionVolumeMonitor *
542 g_union_volume_monitor_new (void)
544 GUnionVolumeMonitor *monitor;
546 monitor = g_object_new (G_TYPE_UNION_VOLUME_MONITOR, NULL);
548 return monitor;
552 * g_volume_monitor_get:
554 * Gets the volume monitor used by gio.
556 * Returns: (transfer full): a reference to the #GVolumeMonitor used by gio. Call
557 * g_object_unref() when done with it.
559 GVolumeMonitor *
560 g_volume_monitor_get (void)
562 GVolumeMonitor *vm;
564 g_rec_mutex_lock (&the_volume_monitor_mutex);
566 if (the_volume_monitor)
567 vm = G_VOLUME_MONITOR (g_object_ref (the_volume_monitor));
568 else
570 the_volume_monitor = g_union_volume_monitor_new ();
571 populate_union_monitor (the_volume_monitor);
572 vm = G_VOLUME_MONITOR (the_volume_monitor);
575 g_rec_mutex_unlock (&the_volume_monitor_mutex);
577 return vm;
580 GMount *
581 _g_mount_get_for_mount_path (const gchar *mount_path,
582 GCancellable *cancellable)
584 GNativeVolumeMonitorClass *klass;
585 GMount *mount;
587 klass = get_native_class ();
588 if (klass == NULL)
589 return NULL;
591 mount = NULL;
593 if (klass->get_mount_for_mount_path)
594 mount = klass->get_mount_for_mount_path (mount_path, cancellable);
596 /* TODO: How do we know this succeeded? Keep in mind that the native
597 * volume monitor may fail (e.g. not being able to connect to
598 * hald). Is the get_mount_for_mount_path() method allowed to
599 * return NULL? Seems like it is ... probably the method needs
600 * to take a boolean and write if it succeeds or not.. Messy.
601 * Very messy.
604 g_type_class_unref (klass);
606 return mount;
610 * g_volume_monitor_adopt_orphan_mount:
611 * @mount: a #GMount object to find a parent for
613 * This function should be called by any #GVolumeMonitor
614 * implementation when a new #GMount object is created that is not
615 * associated with a #GVolume object. It must be called just before
616 * emitting the @mount_added signal.
618 * If the return value is not %NULL, the caller must associate the
619 * returned #GVolume object with the #GMount. This involves returning
620 * it in its g_mount_get_volume() implementation. The caller must
621 * also listen for the "removed" signal on the returned object
622 * and give up its reference when handling that signal
624 * Similary, if implementing g_volume_monitor_adopt_orphan_mount(),
625 * the implementor must take a reference to @mount and return it in
626 * its g_volume_get_mount() implemented. Also, the implementor must
627 * listen for the "unmounted" signal on @mount and give up its
628 * reference upon handling that signal.
630 * There are two main use cases for this function.
632 * One is when implementing a user space file system driver that reads
633 * blocks of a block device that is already represented by the native
634 * volume monitor (for example a CD Audio file system driver). Such
635 * a driver will generate its own #GMount object that needs to be
636 * associated with the #GVolume object that represents the volume.
638 * The other is for implementing a #GVolumeMonitor whose sole purpose
639 * is to return #GVolume objects representing entries in the users
640 * "favorite servers" list or similar.
642 * Returns: (transfer full): the #GVolume object that is the parent for @mount or %NULL
643 * if no wants to adopt the #GMount.
645 * Deprecated: 2.20: Instead of using this function, #GVolumeMonitor
646 * implementations should instead create shadow mounts with the URI of
647 * the mount they intend to adopt. See the proxy volume monitor in
648 * gvfs for an example of this. Also see g_mount_is_shadowed(),
649 * g_mount_shadow() and g_mount_unshadow() functions.
651 GVolume *
652 g_volume_monitor_adopt_orphan_mount (GMount *mount)
654 GVolumeMonitor *child_monitor;
655 GVolumeMonitorClass *child_monitor_class;
656 GVolume *volume;
657 GList *l;
659 g_return_val_if_fail (mount != NULL, NULL);
661 if (the_volume_monitor == NULL)
662 return NULL;
664 volume = NULL;
666 g_rec_mutex_lock (&the_volume_monitor_mutex);
668 for (l = the_volume_monitor->monitors; l != NULL; l = l->next)
670 child_monitor = l->data;
671 child_monitor_class = G_VOLUME_MONITOR_GET_CLASS (child_monitor);
673 if (child_monitor_class->adopt_orphan_mount != NULL)
675 volume = child_monitor_class->adopt_orphan_mount (mount, child_monitor);
676 if (volume != NULL)
677 break;
681 g_rec_mutex_unlock (&the_volume_monitor_mutex);
683 return volume;