gio/giomodule.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include <config.h>
  24
  25 #include <string.h>
  26
  27 #include "giomodule.h"
  28 #include "giomodule-priv.h"
  29 #include "glocalfilemonitor.h"
  30 #include "glocaldirectorymonitor.h"
  31 #include "gnativevolumemonitor.h"
  32 #include "gvfs.h"
  33 #ifdef G_OS_UNIX
  34 #include "gdesktopappinfo.h"
  35 #endif
  36 #include "gioalias.h"
  37
  38 /**
  39  * SECTION:giomodule
  40  * @short_description: Loadable GIO Modules
  41  * @include: gio/gio.h
  42  *
  43  * Provides an interface and default functions for loading and unloading
  44  * modules. This is used internally to make GIO extensible, but can also
  45  * be used by others to implement module loading.
  46  *
  47  **/
  48
  49 /**
  50  * SECTION:extensionpoints
  51  * @short_description: Extension Points
  52  * @include: gio.h
  53  * @see_also: <link linkend="gio-extension-points">Extending GIO</link>
  54  *
  55  * #GIOExtensionPoint provides a mechanism for modules to extend the
  56  * functionality of the library or application that loaded it in an
  57  * organized fashion.
  58  *
  59  * An extension point is identified by a name, and it may optionally
  60  * require that any implementation must by of a certain type (or derived
  61  * thereof). Use g_io_extension_point_register() to register an
  62  * extension point, and g_io_extension_point_set_required_type() to
  63  * set a required type.
  64  *
  65  * A module can implement an extension point by specifying the #GType
  66  * that implements the functionality. Additionally, each implementation
  67  * of an extension point has a name, and a priority. Use
  68  * g_io_extension_point_implement() to implement an extension point.
  69  *
  70  *  |[
  71  *  GIOExtensionPoint *ep;
  72  *
  73  *  /&ast; Register an extension point &ast;/
  74  *  ep = g_io_extension_point_register ("my-extension-point");
  75  *  g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE);
  76  *  ]|
  77  *
  78  *  |[
  79  *  /&ast; Implement an extension point &ast;/
  80  *  G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE);
  81  *  g_io_extension_point_implement ("my-extension-point",
  82  *                                  my_example_impl_get_type (),
  83  *                                  "my-example",
  84  *                                  10);
  85  *  ]|
  86  *
  87  *  It is up to the code that registered the extension point how
  88  *  it uses the implementations that have been associated with it.
  89  *  Depending on the use case, it may use all implementations, or
  90  *  only the one with the highest priority, or pick a specific
  91  *  one by name.
  92  */
  93 struct _GIOModule {
  94   GTypeModule parent_instance;
  95
  96   gchar       *filename;
  97   GModule     *library;
  98
  99   void (* load)   (GIOModule *module);
 100   void (* unload) (GIOModule *module);
 101 };
 102
 103 struct _GIOModuleClass
 104 {
 105   GTypeModuleClass parent_class;
 106
 107 };
 108
 109 static void      g_io_module_finalize      (GObject      *object);
 110 static gboolean  g_io_module_load_module   (GTypeModule  *gmodule);
 111 static void      g_io_module_unload_module (GTypeModule  *gmodule);
 112
 113 G_DEFINE_TYPE (GIOModule, g_io_module, G_TYPE_TYPE_MODULE);
 114
 115 static void
 116 g_io_module_class_init (GIOModuleClass *class)
 117 {
 118   GObjectClass     *object_class      = G_OBJECT_CLASS (class);
 119   GTypeModuleClass *type_module_class = G_TYPE_MODULE_CLASS (class);
 120
 121   object_class->finalize     = g_io_module_finalize;
 122
 123   type_module_class->load    = g_io_module_load_module;
 124   type_module_class->unload  = g_io_module_unload_module;
 125 }
 126
 127 static void
 128 g_io_module_init (GIOModule *module)
 129 {
 130 }
 131
 132 static void
 133 g_io_module_finalize (GObject *object)
 134 {
 135   GIOModule *module = G_IO_MODULE (object);
 136
 137   g_free (module->filename);
 138
 139   G_OBJECT_CLASS (g_io_module_parent_class)->finalize (object);
 140 }
 141
 142 static gboolean
 143 g_io_module_load_module (GTypeModule *gmodule)
 144 {
 145   GIOModule *module = G_IO_MODULE (gmodule);
 146
 147   if (!module->filename)
 148     {
 149       g_warning ("GIOModule path not set");
 150       return FALSE;
 151     }
 152
 153   module->library = g_module_open (module->filename, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
 154
 155   if (!module->library)
 156     {
 157       g_printerr ("%s\n", g_module_error ());
 158       return FALSE;
 159     }
 160
 161   /* Make sure that the loaded library contains the required methods */
 162   if (! g_module_symbol (module->library,
 163                          "g_io_module_load",
 164                          (gpointer) &module->load) ||
 165       ! g_module_symbol (module->library,
 166                          "g_io_module_unload",
 167                          (gpointer) &module->unload))
 168     {
 169       g_printerr ("%s\n", g_module_error ());
 170       g_module_close (module->library);
 171
 172       return FALSE;
 173     }
 174
 175   /* Initialize the loaded module */
 176   module->load (module);
 177
 178   return TRUE;
 179 }
 180
 181 static void
 182 g_io_module_unload_module (GTypeModule *gmodule)
 183 {
 184   GIOModule *module = G_IO_MODULE (gmodule);
 185
 186   module->unload (module);
 187
 188   g_module_close (module->library);
 189   module->library = NULL;
 190
 191   module->load   = NULL;
 192   module->unload = NULL;
 193 }
 194
 195 /**
 196  * g_io_module_new:
 197  * @filename: filename of the shared library module.
 198  *
 199  * Creates a new GIOModule that will load the specific
 200  * shared library when in use.
 201  *
 202  * Returns: a #GIOModule from given @filename,
 203  * or %NULL on error.
 204  **/
 205 GIOModule *
 206 g_io_module_new (const gchar *filename)
 207 {
 208   GIOModule *module;
 209
 210   g_return_val_if_fail (filename != NULL, NULL);
 211
 212   module = g_object_new (G_IO_TYPE_MODULE, NULL);
 213   module->filename = g_strdup (filename);
 214
 215   return module;
 216 }
 217
 218 static gboolean
 219 is_valid_module_name (const gchar *basename)
 220 {
 221 #if !defined(G_OS_WIN32) && !defined(G_WITH_CYGWIN)
 222   return
 223     g_str_has_prefix (basename, "lib") &&
 224     g_str_has_suffix (basename, ".so");
 225 #else
 226   return g_str_has_suffix (basename, ".dll");
 227 #endif
 228 }
 229
 230 /**
 231  * g_io_modules_load_all_in_directory:
 232  * @dirname: pathname for a directory containing modules to load.
 233  *
 234  * Loads all the modules in the specified directory.
 235  *
 236  * Returns: a list of #GIOModules loaded from the directory,
 237  *      All the modules are loaded into memory, if you want to
 238  *      unload them (enabling on-demand loading) you must call
 239  *      g_type_module_unuse() on all the modules. Free the list
 240  *      with g_list_free().
 241  **/
 242 GList *
 243 g_io_modules_load_all_in_directory (const char *dirname)
 244 {
 245   const gchar *name;
 246   GDir        *dir;
 247   GList *modules;
 248
 249   if (!g_module_supported ())
 250     return NULL;
 251
 252   dir = g_dir_open (dirname, 0, NULL);
 253   if (!dir)
 254     return NULL;
 255
 256   modules = NULL;
 257   while ((name = g_dir_read_name (dir)))
 258     {
 259       if (is_valid_module_name (name))
 260         {
 261           GIOModule *module;
 262           gchar     *path;
 263
 264           path = g_build_filename (dirname, name, NULL);
 265           module = g_io_module_new (path);
 266
 267           if (!g_type_module_use (G_TYPE_MODULE (module)))
 268             {
 269               g_printerr ("Failed to load module: %s\n", path);
 270               g_object_unref (module);
 271               g_free (path);
 272               continue;
 273             }
 274
 275           g_free (path);
 276
 277           modules = g_list_prepend (modules, module);
 278         }
 279     }
 280
 281   g_dir_close (dir);
 282
 283   return modules;
 284 }
 285
 286 G_LOCK_DEFINE_STATIC (loaded_dirs);
 287
 288 extern GType _g_fen_directory_monitor_get_type (void);
 289 extern GType _g_fen_file_monitor_get_type (void);
 290 extern GType _g_inotify_directory_monitor_get_type (void);
 291 extern GType _g_inotify_file_monitor_get_type (void);
 292 extern GType _g_unix_volume_monitor_get_type (void);
 293 extern GType _g_local_vfs_get_type (void);
 294
 295 extern GType g_win32_directory_monitor_get_type (void);
 296
 297 void
 298 _g_io_modules_ensure_loaded (void)
 299 {
 300   GList *modules, *l;
 301   static gboolean loaded_dirs = FALSE;
 302   GIOExtensionPoint *ep;
 303   const char *module_path;
 304
 305   G_LOCK (loaded_dirs);
 306
 307   if (!loaded_dirs)
 308     {
 309       loaded_dirs = TRUE;
 310
 311 #ifdef G_OS_UNIX
 312       ep = g_io_extension_point_register (G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME);
 313       g_io_extension_point_set_required_type (ep, G_TYPE_DESKTOP_APP_INFO_LOOKUP);
 314 #endif
 315
 316       ep = g_io_extension_point_register (G_LOCAL_DIRECTORY_MONITOR_EXTENSION_POINT_NAME);
 317       g_io_extension_point_set_required_type (ep, G_TYPE_LOCAL_DIRECTORY_MONITOR);
 318
 319       ep = g_io_extension_point_register (G_LOCAL_FILE_MONITOR_EXTENSION_POINT_NAME);
 320       g_io_extension_point_set_required_type (ep, G_TYPE_LOCAL_FILE_MONITOR);
 321
 322       ep = g_io_extension_point_register (G_VOLUME_MONITOR_EXTENSION_POINT_NAME);
 323       g_io_extension_point_set_required_type (ep, G_TYPE_VOLUME_MONITOR);
 324
 325       ep = g_io_extension_point_register (G_NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME);
 326       g_io_extension_point_set_required_type (ep, G_TYPE_NATIVE_VOLUME_MONITOR);
 327
 328       ep = g_io_extension_point_register (G_VFS_EXTENSION_POINT_NAME);
 329       g_io_extension_point_set_required_type (ep, G_TYPE_VFS);
 330
 331       modules = g_io_modules_load_all_in_directory (GIO_MODULE_DIR);
 332
 333       module_path = g_getenv ("GIO_EXTRA_MODULES");
 334
 335       if (module_path)
 336         {
 337           int i = 0;
 338           gchar **paths;
 339           paths = g_strsplit (module_path, ":", 0);
 340
 341           while (paths[i] != NULL)
 342             {
 343               modules = g_list_prepend (modules, g_io_modules_load_all_in_directory (paths[i]));
 344               i++;
 345             }
 346
 347           g_strfreev (paths);
 348         }
 349
 350       /* Initialize types from built-in "modules" */
 351 #if defined(HAVE_SYS_INOTIFY_H) || defined(HAVE_LINUX_INOTIFY_H)
 352       _g_inotify_directory_monitor_get_type ();
 353       _g_inotify_file_monitor_get_type ();
 354 #endif
 355 #if defined(HAVE_FEN)
 356       _g_fen_directory_monitor_get_type ();
 357       _g_fen_file_monitor_get_type ();
 358 #endif
 359 #ifdef G_OS_WIN32
 360       g_win32_directory_monitor_get_type ();
 361 #endif
 362 #ifdef G_OS_UNIX
 363       _g_unix_volume_monitor_get_type ();
 364 #endif
 365       _g_local_vfs_get_type ();
 366
 367       for (l = modules; l != NULL; l = l->next)
 368         g_type_module_unuse (G_TYPE_MODULE (l->data));
 369
 370       g_list_free (modules);
 371     }
 372
 373   G_UNLOCK (loaded_dirs);
 374 }
 375
 376 struct _GIOExtension {
 377   char *name;
 378   GType type;
 379   gint priority;
 380 };
 381
 382 struct _GIOExtensionPoint {
 383   GType required_type;
 384   char *name;
 385   GList *extensions;
 386 };
 387
 388 static GHashTable *extension_points = NULL;
 389 G_LOCK_DEFINE_STATIC(extension_points);
 390
 391
 392 static void
 393 g_io_extension_point_free (GIOExtensionPoint *ep)
 394 {
 395   g_free (ep->name);
 396   g_free (ep);
 397 }
 398
 399 /**
 400  * g_io_extension_point_register:
 401  * @name: The name of the extension point
 402  *
 403  * Registers an extension point.
 404  *
 405  * Returns: the new #GIOExtensionPoint. This object is owned by GIO
 406  *    and should not be freed
 407  */
 408 GIOExtensionPoint *
 409 g_io_extension_point_register (const char *name)
 410 {
 411   GIOExtensionPoint *ep;
 412
 413   G_LOCK (extension_points);
 414   if (extension_points == NULL)
 415     extension_points = g_hash_table_new_full (g_str_hash,
 416                                               g_str_equal,
 417                                               NULL,
 418                                               (GDestroyNotify)g_io_extension_point_free);
 419
 420   if (g_hash_table_lookup (extension_points, name) != NULL)
 421     {
 422       g_warning ("Extension point %s registered multiple times", name);
 423       G_UNLOCK (extension_points);
 424       return NULL;
 425     }
 426
 427   ep = g_new0 (GIOExtensionPoint, 1);
 428   ep->name = g_strdup (name);
 429
 430   g_hash_table_insert (extension_points, ep->name, ep);
 431
 432   G_UNLOCK (extension_points);
 433
 434   return ep;
 435 }
 436
 437 /**
 438  * g_io_extension_point_lookup:
 439  * @name: the name of the extension point
 440  *
 441  * Looks up an existing extension point.
 442  *
 443  * Returns: the #GIOExtensionPoint, or %NULL if there is no
 444  *    registered extension point with the given name
 445  */
 446 GIOExtensionPoint *
 447 g_io_extension_point_lookup (const char *name)
 448 {
 449   GIOExtensionPoint *ep;
 450
 451   G_LOCK (extension_points);
 452   ep = NULL;
 453   if (extension_points != NULL)
 454     ep = g_hash_table_lookup (extension_points, name);
 455
 456   G_UNLOCK (extension_points);
 457
 458   return ep;
 459
 460 }
 461
 462 /**
 463  * g_io_extension_point_set_required_type:
 464  * @extension_point: a #GIOExtensionPoint
 465  * @type: the #GType to require
 466  *
 467  * Sets the required type for @extension_point to @type.
 468  * All implementations must henceforth have this type.
 469  */
 470 void
 471 g_io_extension_point_set_required_type (GIOExtensionPoint *extension_point,
 472                                         GType              type)
 473 {
 474   extension_point->required_type = type;
 475 }
 476
 477 /**
 478  * g_io_extension_point_get_required_type:
 479  * @extension_point: a #GIOExtensionPoint
 480  *
 481  * Gets the required type for @extension_point.
 482  *
 483  * Returns: the #GType that all implementations must have,
 484  *     or #G_TYPE_INVALID if the extension point has no required type
 485  */
 486 GType
 487 g_io_extension_point_get_required_type (GIOExtensionPoint *extension_point)
 488 {
 489   return extension_point->required_type;
 490 }
 491
 492 /**
 493  * g_io_extension_point_get_extensions:
 494  * @extension_point: a #GIOExtensionPoint
 495  *
 496  * Gets a list of all extensions that implement this extension point.
 497  * The list is sorted by priority, beginning with the highest priority.
 498  *
 499  * Returns: a #GList of #GIOExtension<!-- -->s. The list is owned by
 500  *   GIO and should not be modified
 501  */
 502 GList *
 503 g_io_extension_point_get_extensions (GIOExtensionPoint *extension_point)
 504 {
 505   return extension_point->extensions;
 506 }
 507
 508 /**
 509  * g_io_extension_point_get_extension_by_name:
 510  * @extension_point: a #GIOExtensionPoint
 511  * @name: the name of the extension to get
 512  *
 513  * Finds a #GIOExtension for an extension point by name.
 514  *
 515  * Returns: the #GIOExtension for @extension_point that has the
 516  *    given name, or %NULL if there is no extension with that name
 517  */
 518 GIOExtension *
 519 g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
 520                                             const char        *name)
 521 {
 522   GList *l;
 523
 524   for (l = extension_point->extensions; l != NULL; l = l->next)
 525     {
 526       GIOExtension *e = l->data;
 527
 528       if (e->name != NULL &&
 529           strcmp (e->name, name) == 0)
 530         return e;
 531     }
 532
 533   return NULL;
 534 }
 535
 536 static gint
 537 extension_prio_compare (gconstpointer  a,
 538                         gconstpointer  b)
 539 {
 540   const GIOExtension *extension_a = a, *extension_b = b;
 541
 542   return extension_b->priority - extension_a->priority;
 543 }
 544
 545 /**
 546  * g_io_extension_point_implement:
 547  * @extension_point_name: the name of the extension point
 548  * @type: the #GType to register as extension
 549  * @extension_name: the name for the extension
 550  * @priority: the priority for the extension
 551  *
 552  * Registers @type as extension for the extension point with name
 553  * @extension_point_name.
 554  *
 555  * If @type has already been registered as an extension for this
 556  * extension point, the existing #GIOExtension object is returned.
 557  *
 558  * Returns: a #GIOExtension object for #GType
 559  */
 560 GIOExtension *
 561 g_io_extension_point_implement (const char *extension_point_name,
 562                                 GType       type,
 563                                 const char *extension_name,
 564                                 gint        priority)
 565 {
 566   GIOExtensionPoint *extension_point;
 567   GIOExtension *extension;
 568   GList *l;
 569
 570   g_return_val_if_fail (extension_point_name != NULL, NULL);
 571
 572   extension_point = g_io_extension_point_lookup (extension_point_name);
 573   if (extension_point == NULL)
 574     {
 575       g_warning ("Tried to implement non-registered extension point %s", extension_point_name);
 576       return NULL;
 577     }
 578
 579   if (extension_point->required_type != 0 &&
 580       !g_type_is_a (type, extension_point->required_type))
 581     {
 582       g_warning ("Tried to register an extension of the type %s to extension point %s. "
 583                  "Expected type is %s.",
 584                  g_type_name (type),
 585                  extension_point_name,
 586                  g_type_name (extension_point->required_type));
 587       return NULL;
 588     }
 589
 590   /* Its safe to register the same type multiple times */
 591   for (l = extension_point->extensions; l != NULL; l = l->next)
 592     {
 593       extension = l->data;
 594       if (extension->type == type)
 595         return extension;
 596     }
 597
 598   extension = g_slice_new0 (GIOExtension);
 599   extension->type = type;
 600   extension->name = g_strdup (extension_name);
 601   extension->priority = priority;
 602
 603   extension_point->extensions = g_list_insert_sorted (extension_point->extensions,
 604                                                       extension, extension_prio_compare);
 605
 606   return extension;
 607 }
 608
 609 /**
 610  * g_io_extension_ref_class:
 611  * @extension: a #GIOExtension
 612  *
 613  * Gets a reference to the class for the type that is
 614  * associated with @extension.
 615  *
 616  * Returns: the #GTypeClass for the type of @extension
 617  */
 618 GTypeClass *
 619 g_io_extension_ref_class (GIOExtension *extension)
 620 {
 621   return g_type_class_ref (extension->type);
 622 }
 623
 624 /**
 625  * g_io_extension_get_type:
 626  * @extension: a #GIOExtension
 627  *
 628  * Gets the type associated with @extension.
 629  *
 630  * Returns: the type of @extension
 631  */
 632 GType
 633 g_io_extension_get_type (GIOExtension *extension)
 634 {
 635   return extension->type;
 636 }
 637
 638 /**
 639  * g_io_extension_get_name:
 640  * @extension: a #GIOExtension
 641  *
 642  * Gets the name under which @extension was registered.
 643  *
 644  * Note that the same type may be registered as extension
 645  * for multiple extension points, under different names.
 646  *
 647  * Returns: the name of @extension.
 648  */
 649 const char *
 650 g_io_extension_get_name (GIOExtension *extension)
 651 {
 652   return extension->name;
 653 }
 654
 655 /**
 656  * g_io_extension_get_priority:
 657  * @extension: a #GIOExtension
 658  *
 659  * Gets the priority with which @extension was registered.
 660  *
 661  * Returns: the priority of @extension
 662  */
 663 gint
 664 g_io_extension_get_priority (GIOExtension *extension)
 665 {
 666   return extension->priority;
 667 }
 668
 669 #define __G_IO_MODULE_C__
 670 #include "gioaliasdef.c"