gst/gstplugin.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstplugin.c: Plugin subsystem for loading elements, types, and libs
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library 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.
  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  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstplugin
  25  * @short_description: Container for features loaded from a shared object module
  26  * @see_also: #GstPluginFeature, #GstElementFactory
  27  *
  28  * GStreamer is extensible, so #GstElement instances can be loaded at runtime.
  29  * A plugin system can provide one or more of the basic
  30  * <application>GStreamer</application> #GstPluginFeature subclasses.
  31  *
  32  * A plugin should export a symbol <symbol>gst_plugin_desc</symbol> that is a
  33  * struct of type #GstPluginDesc.
  34  * the plugin loader will check the version of the core library the plugin was
  35  * linked against and will create a new #GstPlugin. It will then call the
  36  * #GstPluginInitFunc function that was provided in the
  37  * <symbol>gst_plugin_desc</symbol>.
  38  *
  39  * Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
  40  * can add any object that subclasses #GstPluginFeature.
  41  *
  42  * Usually plugins are always automaticlly loaded so you don't need to call
  43  * gst_plugin_load() explicitly to bring it into memory. There are options to
  44  * statically link plugins to an app or even use GStreamer without a plugin
  45  * repository in which case gst_plugin_load() can be needed to bring the plugin
  46  * into memory.
  47  */
  48
  49 #ifdef HAVE_CONFIG_H
  50 #include "config.h"
  51 #endif
  52
  53 #include "gst_private.h"
  54
  55 #include <glib/gstdio.h>
  56 #include <sys/types.h>
  57 #ifdef HAVE_DIRENT_H
  58 #include <dirent.h>
  59 #endif
  60 #ifdef HAVE_UNISTD_H
  61 #include <unistd.h>
  62 #endif
  63 #include <signal.h>
  64 #include <errno.h>
  65
  66 #include "glib-compat-private.h"
  67
  68 #include <gst/gst.h>
  69
  70 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
  71
  72 static guint _num_static_plugins;       /* 0    */
  73 static GstPluginDesc *_static_plugins;  /* NULL */
  74 static gboolean _gst_plugin_inited;
  75 static gchar **_plugin_loading_whitelist;       /* NULL */
  76
  77 /* static variables for segfault handling of plugin loading */
  78 static char *_gst_plugin_fault_handler_filename = NULL;
  79
  80 /* list of valid licenses.
  81  * One of these must be specified or the plugin won't be loaded
  82  * Contact gstreamer-devel@lists.sourceforge.net if your license should be
  83  * added.
  84  *
  85  * GPL: http://www.gnu.org/copyleft/gpl.html
  86  * LGPL: http://www.gnu.org/copyleft/lesser.html
  87  * QPL: http://www.trolltech.com/licenses/qpl.html
  88  * MPL: http://www.opensource.org/licenses/mozilla1.1.php
  89  * MIT/X11: http://www.opensource.org/licenses/mit-license.php
  90  * 3-clause BSD: http://www.opensource.org/licenses/bsd-license.php
  91  */
  92 static const gchar *valid_licenses[] = {
  93   "LGPL",                       /* GNU Lesser General Public License */
  94   "GPL",                        /* GNU General Public License */
  95   "QPL",                        /* Trolltech Qt Public License */
  96   "GPL/QPL",                    /* Combi-license of GPL + QPL */
  97   "MPL",                        /* MPL 1.1 license */
  98   "BSD",                        /* 3-clause BSD license */
  99   "MIT/X11",                    /* MIT/X11 license */
 100   "Proprietary",                /* Proprietary license */
 101   GST_LICENSE_UNKNOWN,          /* some other license */
 102   NULL
 103 };
 104
 105 static GstPlugin *gst_plugin_register_func (GstPlugin * plugin,
 106     const GstPluginDesc * desc, gpointer user_data);
 107 static void gst_plugin_desc_copy (GstPluginDesc * dest,
 108     const GstPluginDesc * src);
 109
 110 static void gst_plugin_ext_dep_free (GstPluginDep * dep);
 111
 112 G_DEFINE_TYPE (GstPlugin, gst_plugin, GST_TYPE_OBJECT);
 113
 114 static void
 115 gst_plugin_init (GstPlugin * plugin)
 116 {
 117   plugin->priv =
 118       G_TYPE_INSTANCE_GET_PRIVATE (plugin, GST_TYPE_PLUGIN, GstPluginPrivate);
 119 }
 120
 121 static void
 122 gst_plugin_finalize (GObject * object)
 123 {
 124   GstPlugin *plugin = GST_PLUGIN_CAST (object);
 125   GstRegistry *registry = gst_registry_get_default ();
 126   GList *g;
 127
 128   GST_DEBUG ("finalizing plugin %" GST_PTR_FORMAT, plugin);
 129   for (g = registry->plugins; g; g = g->next) {
 130     if (g->data == (gpointer) plugin) {
 131       g_warning ("removing plugin that is still in registry");
 132     }
 133   }
 134   g_free (plugin->filename);
 135   g_free (plugin->basename);
 136
 137   g_list_foreach (plugin->priv->deps, (GFunc) gst_plugin_ext_dep_free, NULL);
 138   g_list_free (plugin->priv->deps);
 139   plugin->priv->deps = NULL;
 140
 141   if (plugin->priv->cache_data) {
 142     gst_structure_free (plugin->priv->cache_data);
 143   }
 144
 145   G_OBJECT_CLASS (gst_plugin_parent_class)->finalize (object);
 146 }
 147
 148 static void
 149 gst_plugin_class_init (GstPluginClass * klass)
 150 {
 151   G_OBJECT_CLASS (klass)->finalize = gst_plugin_finalize;
 152
 153   g_type_class_add_private (klass, sizeof (GstPluginPrivate));
 154 }
 155
 156 GQuark
 157 gst_plugin_error_quark (void)
 158 {
 159   static GQuark quark = 0;
 160
 161   if (!quark)
 162     quark = g_quark_from_static_string ("gst_plugin_error");
 163   return quark;
 164 }
 165
 166 #ifndef GST_REMOVE_DEPRECATED
 167 #ifdef GST_DISABLE_DEPRECATED
 168 void _gst_plugin_register_static (GstPluginDesc * desc);
 169 #endif
 170 /* this function can be called in the GCC constructor extension, before
 171  * the _gst_plugin_initialize() was called. In that case, we store the
 172  * plugin description in a list to initialize it when we open the main
 173  * module later on.
 174  * When the main module is known, we can register the plugin right away.
 175  */
 176 void
 177 _gst_plugin_register_static (GstPluginDesc * desc)
 178 {
 179   g_return_if_fail (desc != NULL);
 180
 181   if (!_gst_plugin_inited) {
 182     /* We can't use any GLib functions here, since g_thread_init hasn't been
 183      * called yet, and we can't call it here either, or programs that don't
 184      * guard their g_thread_init calls in main() will just abort */
 185     ++_num_static_plugins;
 186     _static_plugins =
 187         realloc (_static_plugins, _num_static_plugins * sizeof (GstPluginDesc));
 188     /* assume strings in the GstPluginDesc are static const or live forever */
 189     _static_plugins[_num_static_plugins - 1] = *desc;
 190   } else {
 191     gst_plugin_register_static (desc->major_version, desc->minor_version,
 192         desc->name, desc->description, desc->plugin_init, desc->version,
 193         desc->license, desc->source, desc->package, desc->origin);
 194   }
 195 }
 196 #endif
 197
 198 /**
 199  * gst_plugin_register_static:
 200  * @major_version: the major version number of the GStreamer core that the
 201  *     plugin was compiled for, you can just use GST_VERSION_MAJOR here
 202  * @minor_version: the minor version number of the GStreamer core that the
 203  *     plugin was compiled for, you can just use GST_VERSION_MINOR here
 204  * @name: a unique name of the plugin (ideally prefixed with an application- or
 205  *     library-specific namespace prefix in order to avoid name conflicts in
 206  *     case a similar plugin with the same name ever gets added to GStreamer)
 207  * @description: description of the plugin
 208  * @init_func: pointer to the init function of this plugin.
 209  * @version: version string of the plugin
 210  * @license: effective license of plugin. Must be one of the approved licenses
 211  *     (see #GstPluginDesc above) or the plugin will not be registered.
 212  * @source: source module plugin belongs to
 213  * @package: shipped package plugin belongs to
 214  * @origin: URL to provider of plugin
 215  *
 216  * Registers a static plugin, ie. a plugin which is private to an application
 217  * or library and contained within the application or library (as opposed to
 218  * being shipped as a separate module file).
 219  *
 220  * You must make sure that GStreamer has been initialised (with gst_init() or
 221  * via gst_init_get_option_group()) before calling this function.
 222  *
 223  * Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
 224  *
 225  * Since: 0.10.16
 226  */
 227 gboolean
 228 gst_plugin_register_static (gint major_version, gint minor_version,
 229     const gchar * name, const gchar * description, GstPluginInitFunc init_func,
 230     const gchar * version, const gchar * license, const gchar * source,
 231     const gchar * package, const gchar * origin)
 232 {
 233   GstPluginDesc desc = { major_version, minor_version, name, description,
 234     init_func, version, license, source, package, origin,
 235   };
 236   GstPlugin *plugin;
 237   gboolean res = FALSE;
 238
 239   g_return_val_if_fail (name != NULL, FALSE);
 240   g_return_val_if_fail (description != NULL, FALSE);
 241   g_return_val_if_fail (init_func != NULL, FALSE);
 242   g_return_val_if_fail (version != NULL, FALSE);
 243   g_return_val_if_fail (license != NULL, FALSE);
 244   g_return_val_if_fail (source != NULL, FALSE);
 245   g_return_val_if_fail (package != NULL, FALSE);
 246   g_return_val_if_fail (origin != NULL, FALSE);
 247
 248   /* make sure gst_init() has been called */
 249   g_return_val_if_fail (_gst_plugin_inited != FALSE, FALSE);
 250
 251   GST_LOG ("attempting to load static plugin \"%s\" now...", name);
 252   plugin = g_object_newv (GST_TYPE_PLUGIN, 0, NULL);
 253   if (gst_plugin_register_func (plugin, &desc, NULL) != NULL) {
 254     GST_INFO ("registered static plugin \"%s\"", name);
 255     res = gst_default_registry_add_plugin (plugin);
 256     GST_INFO ("added static plugin \"%s\", result: %d", name, res);
 257   }
 258   return res;
 259 }
 260
 261 /**
 262  * gst_plugin_register_static_full:
 263  * @major_version: the major version number of the GStreamer core that the
 264  *     plugin was compiled for, you can just use GST_VERSION_MAJOR here
 265  * @minor_version: the minor version number of the GStreamer core that the
 266  *     plugin was compiled for, you can just use GST_VERSION_MINOR here
 267  * @name: a unique name of the plugin (ideally prefixed with an application- or
 268  *     library-specific namespace prefix in order to avoid name conflicts in
 269  *     case a similar plugin with the same name ever gets added to GStreamer)
 270  * @description: description of the plugin
 271  * @init_full_func: pointer to the init function with user data of this plugin.
 272  * @version: version string of the plugin
 273  * @license: effective license of plugin. Must be one of the approved licenses
 274  *     (see #GstPluginDesc above) or the plugin will not be registered.
 275  * @source: source module plugin belongs to
 276  * @package: shipped package plugin belongs to
 277  * @origin: URL to provider of plugin
 278  * @user_data: gpointer to user data
 279  *
 280  * Registers a static plugin, ie. a plugin which is private to an application
 281  * or library and contained within the application or library (as opposed to
 282  * being shipped as a separate module file) with a #GstPluginInitFullFunc
 283  * which allows user data to be passed to the callback function (useful
 284  * for bindings).
 285  *
 286  * You must make sure that GStreamer has been initialised (with gst_init() or
 287  * via gst_init_get_option_group()) before calling this function.
 288  *
 289  * Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
 290  *
 291  * Since: 0.10.24
 292  *
 293  */
 294 gboolean
 295 gst_plugin_register_static_full (gint major_version, gint minor_version,
 296     const gchar * name, const gchar * description,
 297     GstPluginInitFullFunc init_full_func, const gchar * version,
 298     const gchar * license, const gchar * source, const gchar * package,
 299     const gchar * origin, gpointer user_data)
 300 {
 301   GstPluginDesc desc = { major_version, minor_version, name, description,
 302     (GstPluginInitFunc) init_full_func, version, license, source, package,
 303     origin,
 304   };
 305   GstPlugin *plugin;
 306   gboolean res = FALSE;
 307
 308   g_return_val_if_fail (name != NULL, FALSE);
 309   g_return_val_if_fail (description != NULL, FALSE);
 310   g_return_val_if_fail (init_full_func != NULL, FALSE);
 311   g_return_val_if_fail (version != NULL, FALSE);
 312   g_return_val_if_fail (license != NULL, FALSE);
 313   g_return_val_if_fail (source != NULL, FALSE);
 314   g_return_val_if_fail (package != NULL, FALSE);
 315   g_return_val_if_fail (origin != NULL, FALSE);
 316
 317   /* make sure gst_init() has been called */
 318   g_return_val_if_fail (_gst_plugin_inited != FALSE, FALSE);
 319
 320   GST_LOG ("attempting to load static plugin \"%s\" now...", name);
 321   plugin = g_object_newv (GST_TYPE_PLUGIN, 0, NULL);
 322   if (gst_plugin_register_func (plugin, &desc, user_data) != NULL) {
 323     GST_INFO ("registered static plugin \"%s\"", name);
 324     res = gst_default_registry_add_plugin (plugin);
 325     GST_INFO ("added static plugin \"%s\", result: %d", name, res);
 326   }
 327   return res;
 328 }
 329
 330 void
 331 _gst_plugin_initialize (void)
 332 {
 333   const gchar *whitelist;
 334   guint i;
 335
 336   _gst_plugin_inited = TRUE;
 337
 338   whitelist = g_getenv ("GST_PLUGIN_LOADING_WHITELIST");
 339   if (whitelist != NULL && *whitelist != '\0') {
 340     _plugin_loading_whitelist = g_strsplit (whitelist,
 341         G_SEARCHPATH_SEPARATOR_S, -1);
 342     for (i = 0; _plugin_loading_whitelist[i] != NULL; ++i) {
 343       GST_INFO ("plugins whitelist entry: %s", _plugin_loading_whitelist[i]);
 344     }
 345   }
 346
 347   /* now register all static plugins */
 348   GST_INFO ("registering %u static plugins", _num_static_plugins);
 349   for (i = 0; i < _num_static_plugins; ++i) {
 350     gst_plugin_register_static (_static_plugins[i].major_version,
 351         _static_plugins[i].minor_version, _static_plugins[i].name,
 352         _static_plugins[i].description, _static_plugins[i].plugin_init,
 353         _static_plugins[i].version, _static_plugins[i].license,
 354         _static_plugins[i].source, _static_plugins[i].package,
 355         _static_plugins[i].origin);
 356   }
 357
 358   if (_static_plugins) {
 359     free (_static_plugins);
 360     _static_plugins = NULL;
 361     _num_static_plugins = 0;
 362   }
 363 }
 364
 365 /* Whitelist entry format:
 366  *
 367  *   plugin1,plugin2@pathprefix or
 368  *   plugin1,plugin2@* or just
 369  *   plugin1,plugin2 or
 370  *   source-package@pathprefix or
 371  *   source-package@* or just
 372  *   source-package
 373  *
 374  * ie. the bit before the path will be checked against both the plugin
 375  * name and the plugin's source package name, to keep the format simple.
 376  */
 377 static gboolean
 378 gst_plugin_desc_matches_whitelist_entry (GstPluginDesc * desc,
 379     const gchar * filename, const gchar * pattern)
 380 {
 381   const gchar *sep;
 382   gboolean ret = FALSE;
 383   gchar *name;
 384
 385   GST_LOG ("Whitelist pattern '%s', plugin: %s of %s@%s", pattern, desc->name,
 386       desc->source, GST_STR_NULL (filename));
 387
 388   /* do we have a path prefix? */
 389   sep = strchr (pattern, '@');
 390   if (sep != NULL && strcmp (sep, "@*") != 0 && strcmp (sep, "@") != 0) {
 391     /* paths are not canonicalised or treated with realpath() here. This
 392      * should be good enough for our use case, since we just use the paths
 393      * autotools uses, and those will be constructed from the same prefix. */
 394     if (filename != NULL && !g_str_has_prefix (filename, sep + 1))
 395       return FALSE;
 396
 397     GST_LOG ("%s matches path prefix %s", GST_STR_NULL (filename), sep + 1);
 398   }
 399
 400   if (sep != NULL) {
 401     name = g_strndup (pattern, (gsize) (sep - pattern));
 402   } else {
 403     name = g_strdup (pattern);
 404   }
 405
 406   g_strstrip (name);
 407   if (!g_ascii_isalnum (*name)) {
 408     GST_WARNING ("Invalid whitelist pattern: %s", pattern);
 409     goto done;
 410   }
 411
 412   /* now check plugin names / source package name */
 413   if (strchr (name, ',') == NULL) {
 414     /* only a single name: either a plugin name or the source package name */
 415     ret = (strcmp (desc->source, name) == 0 || strcmp (desc->name, name) == 0);
 416   } else {
 417     gchar **n, **names;
 418
 419     /* multiple names: assume these are plugin names */
 420     names = g_strsplit (name, ",", -1);
 421     for (n = names; n != NULL && *n != NULL; ++n) {
 422       g_strstrip (*n);
 423       if (strcmp (desc->name, *n) == 0) {
 424         ret = TRUE;
 425         break;
 426       }
 427     }
 428     g_strfreev (names);
 429   }
 430
 431   GST_LOG ("plugin / source package name match: %d", ret);
 432
 433 done:
 434
 435   g_free (name);
 436   return ret;
 437 }
 438
 439 gboolean
 440 priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
 441     const gchar * filename)
 442 {
 443   gchar **entry;
 444
 445   if (_plugin_loading_whitelist == NULL)
 446     return TRUE;
 447
 448   for (entry = _plugin_loading_whitelist; *entry != NULL; ++entry) {
 449     if (gst_plugin_desc_matches_whitelist_entry (desc, filename, *entry)) {
 450       GST_LOG ("Plugin %s is in whitelist", filename);
 451       return TRUE;
 452     }
 453   }
 454
 455   GST_LOG ("Plugin %s (package %s, file %s) not in whitelist", desc->name,
 456       desc->source, filename);
 457   return FALSE;
 458 }
 459
 460 gboolean
 461 priv_gst_plugin_loading_have_whitelist (void)
 462 {
 463   return (_plugin_loading_whitelist != NULL);
 464 }
 465
 466 guint32
 467 priv_gst_plugin_loading_get_whitelist_hash (void)
 468 {
 469   guint32 hash = 0;
 470
 471   if (_plugin_loading_whitelist != NULL) {
 472     gchar **w;
 473
 474     for (w = _plugin_loading_whitelist; *w != NULL; ++w)
 475       hash = (hash << 1) ^ g_str_hash (*w);
 476   }
 477
 478   return hash;
 479 }
 480
 481 /* this function could be extended to check if the plugin license matches the
 482  * applications license (would require the app to register its license somehow).
 483  * We'll wait for someone who's interested in it to code it :)
 484  */
 485 static gboolean
 486 gst_plugin_check_license (const gchar * license)
 487 {
 488   const gchar **check_license = valid_licenses;
 489
 490   g_assert (check_license);
 491
 492   while (*check_license) {
 493     if (strcmp (license, *check_license) == 0)
 494       return TRUE;
 495     check_license++;
 496   }
 497   return FALSE;
 498 }
 499
 500 static gboolean
 501 gst_plugin_check_version (gint major, gint minor)
 502 {
 503   /* return NULL if the major and minor version numbers are not compatible */
 504   /* with ours. */
 505   if (major != GST_VERSION_MAJOR || minor != GST_VERSION_MINOR)
 506     return FALSE;
 507
 508   return TRUE;
 509 }
 510
 511 static GstPlugin *
 512 gst_plugin_register_func (GstPlugin * plugin, const GstPluginDesc * desc,
 513     gpointer user_data)
 514 {
 515   if (!gst_plugin_check_version (desc->major_version, desc->minor_version)) {
 516     if (GST_CAT_DEFAULT)
 517       GST_WARNING ("plugin \"%s\" has incompatible version, not loading",
 518           plugin->filename);
 519     return NULL;
 520   }
 521
 522   if (!desc->license || !desc->description || !desc->source ||
 523       !desc->package || !desc->origin) {
 524     if (GST_CAT_DEFAULT)
 525       GST_WARNING ("plugin \"%s\" has incorrect GstPluginDesc, not loading",
 526           plugin->filename);
 527     return NULL;
 528   }
 529
 530   if (!gst_plugin_check_license (desc->license)) {
 531     if (GST_CAT_DEFAULT)
 532       GST_WARNING ("plugin \"%s\" has invalid license \"%s\", not loading",
 533           plugin->filename, desc->license);
 534     return NULL;
 535   }
 536
 537   if (GST_CAT_DEFAULT)
 538     GST_LOG ("plugin \"%s\" looks good", GST_STR_NULL (plugin->filename));
 539
 540   gst_plugin_desc_copy (&plugin->desc, desc);
 541
 542   /* make resident so we're really sure it never gets unloaded again.
 543    * Theoretically this is not needed, but practically it doesn't hurt.
 544    * And we're rather safe than sorry. */
 545   if (plugin->module)
 546     g_module_make_resident (plugin->module);
 547
 548   if (user_data) {
 549     if (!(((GstPluginInitFullFunc) (desc->plugin_init)) (plugin, user_data))) {
 550       if (GST_CAT_DEFAULT)
 551         GST_WARNING ("plugin \"%s\" failed to initialise", plugin->filename);
 552       return NULL;
 553     }
 554   } else {
 555     if (!((desc->plugin_init) (plugin))) {
 556       if (GST_CAT_DEFAULT)
 557         GST_WARNING ("plugin \"%s\" failed to initialise", plugin->filename);
 558       return NULL;
 559     }
 560   }
 561
 562   if (GST_CAT_DEFAULT)
 563     GST_LOG ("plugin \"%s\" initialised", GST_STR_NULL (plugin->filename));
 564
 565   return plugin;
 566 }
 567
 568 #ifdef HAVE_SIGACTION
 569 static struct sigaction oldaction;
 570 static gboolean _gst_plugin_fault_handler_is_setup = FALSE;
 571
 572 /*
 573  * _gst_plugin_fault_handler_restore:
 574  * segfault handler restorer
 575  */
 576 static void
 577 _gst_plugin_fault_handler_restore (void)
 578 {
 579   if (!_gst_plugin_fault_handler_is_setup)
 580     return;
 581
 582   _gst_plugin_fault_handler_is_setup = FALSE;
 583
 584   sigaction (SIGSEGV, &oldaction, NULL);
 585 }
 586
 587 /*
 588  * _gst_plugin_fault_handler_sighandler:
 589  * segfault handler implementation
 590  */
 591 static void
 592 _gst_plugin_fault_handler_sighandler (int signum)
 593 {
 594   /* We need to restore the fault handler or we'll keep getting it */
 595   _gst_plugin_fault_handler_restore ();
 596
 597   switch (signum) {
 598     case SIGSEGV:
 599       g_print ("\nERROR: ");
 600       g_print ("Caught a segmentation fault while loading plugin file:\n");
 601       g_print ("%s\n\n", _gst_plugin_fault_handler_filename);
 602       g_print ("Please either:\n");
 603       g_print ("- remove it and restart.\n");
 604       g_print ("- run with --gst-disable-segtrap and debug.\n");
 605       exit (-1);
 606       break;
 607     default:
 608       g_print ("Caught unhandled signal on plugin loading\n");
 609       break;
 610   }
 611 }
 612
 613 /*
 614  * _gst_plugin_fault_handler_setup:
 615  * sets up the segfault handler
 616  */
 617 static void
 618 _gst_plugin_fault_handler_setup (void)
 619 {
 620   struct sigaction action;
 621
 622   /* if asked to leave segfaults alone, just return */
 623   if (!gst_segtrap_is_enabled ())
 624     return;
 625
 626   if (_gst_plugin_fault_handler_is_setup)
 627     return;
 628
 629   _gst_plugin_fault_handler_is_setup = TRUE;
 630
 631   memset (&action, 0, sizeof (action));
 632   action.sa_handler = _gst_plugin_fault_handler_sighandler;
 633
 634   sigaction (SIGSEGV, &action, &oldaction);
 635 }
 636 #else /* !HAVE_SIGACTION */
 637 static void
 638 _gst_plugin_fault_handler_restore (void)
 639 {
 640 }
 641
 642 static void
 643 _gst_plugin_fault_handler_setup (void)
 644 {
 645 }
 646 #endif /* HAVE_SIGACTION */
 647
 648 static GStaticMutex gst_plugin_loading_mutex = G_STATIC_MUTEX_INIT;
 649
 650 #define CHECK_PLUGIN_DESC_FIELD(desc,field,fn)                               \
 651   if (G_UNLIKELY ((desc)->field == NULL)) {                                  \
 652     GST_ERROR ("GstPluginDesc for '%s' has no %s", fn, G_STRINGIFY (field)); \
 653   }
 654
 655 /**
 656  * gst_plugin_load_file:
 657  * @filename: the plugin filename to load
 658  * @error: pointer to a NULL-valued GError
 659  *
 660  * Loads the given plugin and refs it.  Caller needs to unref after use.
 661  *
 662  * Returns: a reference to the existing loaded GstPlugin, a reference to the
 663  * newly-loaded GstPlugin, or NULL if an error occurred.
 664  */
 665 GstPlugin *
 666 gst_plugin_load_file (const gchar * filename, GError ** error)
 667 {
 668   GstPluginDesc *desc;
 669   GstPlugin *plugin;
 670   GModule *module;
 671   gboolean ret;
 672   gpointer ptr;
 673   struct stat file_status;
 674   GstRegistry *registry;
 675   gboolean new_plugin = TRUE;
 676
 677   g_return_val_if_fail (filename != NULL, NULL);
 678
 679   registry = gst_registry_get_default ();
 680   g_static_mutex_lock (&gst_plugin_loading_mutex);
 681
 682   plugin = gst_registry_lookup (registry, filename);
 683   if (plugin) {
 684     if (plugin->module) {
 685       /* already loaded */
 686       g_static_mutex_unlock (&gst_plugin_loading_mutex);
 687       return plugin;
 688     } else {
 689       /* load plugin and update fields */
 690       new_plugin = FALSE;
 691     }
 692   }
 693
 694   GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "attempt to load plugin \"%s\"",
 695       filename);
 696
 697   if (g_module_supported () == FALSE) {
 698     GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "module loading not supported");
 699     g_set_error (error,
 700         GST_PLUGIN_ERROR,
 701         GST_PLUGIN_ERROR_MODULE, "Dynamic loading not supported");
 702     goto return_error;
 703   }
 704
 705   if (g_stat (filename, &file_status)) {
 706     GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "problem accessing file");
 707     g_set_error (error,
 708         GST_PLUGIN_ERROR,
 709         GST_PLUGIN_ERROR_MODULE, "Problem accessing file %s: %s", filename,
 710         g_strerror (errno));
 711     goto return_error;
 712   }
 713
 714   module = g_module_open (filename, G_MODULE_BIND_LOCAL);
 715   if (module == NULL) {
 716     GST_CAT_WARNING (GST_CAT_PLUGIN_LOADING, "module_open failed: %s",
 717         g_module_error ());
 718     g_set_error (error,
 719         GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE, "Opening module failed: %s",
 720         g_module_error ());
 721     /* If we failed to open the shared object, then it's probably because a
 722      * plugin is linked against the wrong libraries. Print out an easy-to-see
 723      * message in this case. */
 724     g_warning ("Failed to load plugin '%s': %s", filename, g_module_error ());
 725     goto return_error;
 726   }
 727
 728   ret = g_module_symbol (module, "gst_plugin_desc", &ptr);
 729   if (!ret) {
 730     GST_DEBUG ("Could not find plugin entry point in \"%s\"", filename);
 731     g_set_error (error,
 732         GST_PLUGIN_ERROR,
 733         GST_PLUGIN_ERROR_MODULE,
 734         "File \"%s\" is not a GStreamer plugin", filename);
 735     g_module_close (module);
 736     goto return_error;
 737   }
 738
 739   desc = (GstPluginDesc *) ptr;
 740
 741   if (priv_gst_plugin_loading_have_whitelist () &&
 742       !priv_gst_plugin_desc_is_whitelisted (desc, filename)) {
 743     GST_INFO ("Whitelist specified and plugin not in whitelist, not loading: "
 744         "name=%s, package=%s, file=%s", desc->name, desc->source, filename);
 745     g_set_error (error, GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE,
 746         "Not loading plugin file \"%s\", not in whitelist", filename);
 747     g_module_close (module);
 748     goto return_error;
 749   }
 750
 751   if (new_plugin) {
 752     plugin = g_object_newv (GST_TYPE_PLUGIN, 0, NULL);
 753     plugin->file_mtime = file_status.st_mtime;
 754     plugin->file_size = file_status.st_size;
 755     plugin->filename = g_strdup (filename);
 756     plugin->basename = g_path_get_basename (filename);
 757   }
 758
 759   plugin->module = module;
 760   plugin->orig_desc = desc;
 761
 762   if (new_plugin) {
 763     /* check plugin description: complain about bad values but accept them, to
 764      * maintain backwards compatibility (FIXME: 0.11) */
 765     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, name, filename);
 766     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, description, filename);
 767     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, version, filename);
 768     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, license, filename);
 769     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, source, filename);
 770     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, package, filename);
 771     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, origin, filename);
 772   }
 773
 774   GST_LOG ("Plugin %p for file \"%s\" prepared, calling entry function...",
 775       plugin, filename);
 776
 777   /* this is where we load the actual .so, so let's trap SIGSEGV */
 778   _gst_plugin_fault_handler_setup ();
 779   _gst_plugin_fault_handler_filename = plugin->filename;
 780
 781   GST_LOG ("Plugin %p for file \"%s\" prepared, registering...",
 782       plugin, filename);
 783
 784   if (!gst_plugin_register_func (plugin, plugin->orig_desc, NULL)) {
 785     /* remove signal handler */
 786     _gst_plugin_fault_handler_restore ();
 787     GST_DEBUG ("gst_plugin_register_func failed for plugin \"%s\"", filename);
 788     /* plugin == NULL */
 789     g_set_error (error,
 790         GST_PLUGIN_ERROR,
 791         GST_PLUGIN_ERROR_MODULE,
 792         "File \"%s\" appears to be a GStreamer plugin, but it failed to initialize",
 793         filename);
 794     goto return_error;
 795   }
 796
 797   /* remove signal handler */
 798   _gst_plugin_fault_handler_restore ();
 799   _gst_plugin_fault_handler_filename = NULL;
 800   GST_INFO ("plugin \"%s\" loaded", plugin->filename);
 801
 802   if (new_plugin) {
 803     gst_object_ref (plugin);
 804     gst_default_registry_add_plugin (plugin);
 805   }
 806
 807   g_static_mutex_unlock (&gst_plugin_loading_mutex);
 808   return plugin;
 809
 810 return_error:
 811   {
 812     if (plugin)
 813       gst_object_unref (plugin);
 814     g_static_mutex_unlock (&gst_plugin_loading_mutex);
 815     return NULL;
 816   }
 817 }
 818
 819 static void
 820 gst_plugin_desc_copy (GstPluginDesc * dest, const GstPluginDesc * src)
 821 {
 822   dest->major_version = src->major_version;
 823   dest->minor_version = src->minor_version;
 824   dest->name = g_intern_string (src->name);
 825   dest->description = g_intern_string (src->description);
 826   dest->plugin_init = src->plugin_init;
 827   dest->version = g_intern_string (src->version);
 828   dest->license = g_intern_string (src->license);
 829   dest->source = g_intern_string (src->source);
 830   dest->package = g_intern_string (src->package);
 831   dest->origin = g_intern_string (src->origin);
 832 }
 833
 834 /**
 835  * gst_plugin_get_name:
 836  * @plugin: plugin to get the name of
 837  *
 838  * Get the short name of the plugin
 839  *
 840  * Returns: the name of the plugin
 841  */
 842 const gchar *
 843 gst_plugin_get_name (GstPlugin * plugin)
 844 {
 845   g_return_val_if_fail (plugin != NULL, NULL);
 846
 847   return plugin->desc.name;
 848 }
 849
 850 /**
 851  * gst_plugin_get_description:
 852  * @plugin: plugin to get long name of
 853  *
 854  * Get the long descriptive name of the plugin
 855  *
 856  * Returns: the long name of the plugin
 857  */
 858 G_CONST_RETURN gchar *
 859 gst_plugin_get_description (GstPlugin * plugin)
 860 {
 861   g_return_val_if_fail (plugin != NULL, NULL);
 862
 863   return plugin->desc.description;
 864 }
 865
 866 /**
 867  * gst_plugin_get_filename:
 868  * @plugin: plugin to get the filename of
 869  *
 870  * get the filename of the plugin
 871  *
 872  * Returns: the filename of the plugin
 873  */
 874 G_CONST_RETURN gchar *
 875 gst_plugin_get_filename (GstPlugin * plugin)
 876 {
 877   g_return_val_if_fail (plugin != NULL, NULL);
 878
 879   return plugin->filename;
 880 }
 881
 882 /**
 883  * gst_plugin_get_version:
 884  * @plugin: plugin to get the version of
 885  *
 886  * get the version of the plugin
 887  *
 888  * Returns: the version of the plugin
 889  */
 890 G_CONST_RETURN gchar *
 891 gst_plugin_get_version (GstPlugin * plugin)
 892 {
 893   g_return_val_if_fail (plugin != NULL, NULL);
 894
 895   return plugin->desc.version;
 896 }
 897
 898 /**
 899  * gst_plugin_get_license:
 900  * @plugin: plugin to get the license of
 901  *
 902  * get the license of the plugin
 903  *
 904  * Returns: the license of the plugin
 905  */
 906 G_CONST_RETURN gchar *
 907 gst_plugin_get_license (GstPlugin * plugin)
 908 {
 909   g_return_val_if_fail (plugin != NULL, NULL);
 910
 911   return plugin->desc.license;
 912 }
 913
 914 /**
 915  * gst_plugin_get_source:
 916  * @plugin: plugin to get the source of
 917  *
 918  * get the source module the plugin belongs to.
 919  *
 920  * Returns: the source of the plugin
 921  */
 922 G_CONST_RETURN gchar *
 923 gst_plugin_get_source (GstPlugin * plugin)
 924 {
 925   g_return_val_if_fail (plugin != NULL, NULL);
 926
 927   return plugin->desc.source;
 928 }
 929
 930 /**
 931  * gst_plugin_get_package:
 932  * @plugin: plugin to get the package of
 933  *
 934  * get the package the plugin belongs to.
 935  *
 936  * Returns: the package of the plugin
 937  */
 938 G_CONST_RETURN gchar *
 939 gst_plugin_get_package (GstPlugin * plugin)
 940 {
 941   g_return_val_if_fail (plugin != NULL, NULL);
 942
 943   return plugin->desc.package;
 944 }
 945
 946 /**
 947  * gst_plugin_get_origin:
 948  * @plugin: plugin to get the origin of
 949  *
 950  * get the URL where the plugin comes from
 951  *
 952  * Returns: the origin of the plugin
 953  */
 954 G_CONST_RETURN gchar *
 955 gst_plugin_get_origin (GstPlugin * plugin)
 956 {
 957   g_return_val_if_fail (plugin != NULL, NULL);
 958
 959   return plugin->desc.origin;
 960 }
 961
 962 /**
 963  * gst_plugin_get_module:
 964  * @plugin: plugin to query
 965  *
 966  * Gets the #GModule of the plugin. If the plugin isn't loaded yet, NULL is
 967  * returned.
 968  *
 969  * Returns: module belonging to the plugin or NULL if the plugin isn't
 970  *          loaded yet.
 971  */
 972 GModule *
 973 gst_plugin_get_module (GstPlugin * plugin)
 974 {
 975   g_return_val_if_fail (plugin != NULL, NULL);
 976
 977   return plugin->module;
 978 }
 979
 980 /**
 981  * gst_plugin_is_loaded:
 982  * @plugin: plugin to query
 983  *
 984  * queries if the plugin is loaded into memory
 985  *
 986  * Returns: TRUE is loaded, FALSE otherwise
 987  */
 988 gboolean
 989 gst_plugin_is_loaded (GstPlugin * plugin)
 990 {
 991   g_return_val_if_fail (plugin != NULL, FALSE);
 992
 993   return (plugin->module != NULL || plugin->filename == NULL);
 994 }
 995
 996 /**
 997  * gst_plugin_get_cache_data:
 998  * @plugin: a plugin
 999  *
1000  * Gets the plugin specific data cache. If it is %NULL there is no cached data
1001  * stored. This is the case when the registry is getting rebuilt.
1002  *
1003  * Returns: The cached data as a #GstStructure or %NULL.
1004  *
1005  * Since: 0.10.24
1006  */
1007 G_CONST_RETURN GstStructure *
1008 gst_plugin_get_cache_data (GstPlugin * plugin)
1009 {
1010   g_return_val_if_fail (GST_IS_PLUGIN (plugin), NULL);
1011
1012   return plugin->priv->cache_data;
1013 }
1014
1015 /**
1016  * gst_plugin_set_cache_data:
1017  * @plugin: a plugin
1018  * @cache_data: a structure containing the data to cache
1019  *
1020  * Adds plugin specific data to cache. Passes the ownership of the structure to
1021  * the @plugin.
1022  *
1023  * The cache is flushed every time the registry is rebuilt.
1024  *
1025  * Since: 0.10.24
1026  */
1027 void
1028 gst_plugin_set_cache_data (GstPlugin * plugin, GstStructure * cache_data)
1029 {
1030   g_return_if_fail (GST_IS_PLUGIN (plugin));
1031   g_return_if_fail (GST_IS_STRUCTURE (cache_data));
1032
1033   if (plugin->priv->cache_data) {
1034     gst_structure_free (plugin->priv->cache_data);
1035   }
1036   plugin->priv->cache_data = cache_data;
1037 }
1038
1039 #if 0
1040 /**
1041  * gst_plugin_feature_list:
1042  * @plugin: plugin to query
1043  * @filter: the filter to use
1044  * @first: only return first match
1045  * @user_data: user data passed to the filter function
1046  *
1047  * Runs a filter against all plugin features and returns a GList with
1048  * the results. If the first flag is set, only the first match is
1049  * returned (as a list with a single object).
1050  *
1051  * Returns: a GList of features, g_list_free after use.
1052  */
1053 GList *
1054 gst_plugin_feature_filter (GstPlugin * plugin,
1055     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
1056 {
1057   GList *list;
1058   GList *g;
1059
1060   list = gst_filter_run (plugin->features, (GstFilterFunc) filter, first,
1061       user_data);
1062   for (g = list; g; g = g->next) {
1063     gst_object_ref (plugin);
1064   }
1065
1066   return list;
1067 }
1068
1069 typedef struct
1070 {
1071   GstPluginFeatureFilter filter;
1072   gboolean first;
1073   gpointer user_data;
1074   GList *result;
1075 }
1076 FeatureFilterData;
1077
1078 static gboolean
1079 _feature_filter (GstPlugin * plugin, gpointer user_data)
1080 {
1081   GList *result;
1082   FeatureFilterData *data = (FeatureFilterData *) user_data;
1083
1084   result = gst_plugin_feature_filter (plugin, data->filter, data->first,
1085       data->user_data);
1086   if (result) {
1087     data->result = g_list_concat (data->result, result);
1088     return TRUE;
1089   }
1090   return FALSE;
1091 }
1092
1093 /**
1094  * gst_plugin_list_feature_filter:
1095  * @list: a #GList of plugins to query
1096  * @filter: the filter function to use
1097  * @first: only return first match
1098  * @user_data: user data passed to the filter function
1099  *
1100  * Runs a filter against all plugin features of the plugins in the given
1101  * list and returns a GList with the results.
1102  * If the first flag is set, only the first match is
1103  * returned (as a list with a single object).
1104  *
1105  * Returns: a GList of features, g_list_free after use.
1106  */
1107 GList *
1108 gst_plugin_list_feature_filter (GList * list,
1109     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
1110 {
1111   FeatureFilterData data;
1112   GList *result;
1113
1114   data.filter = filter;
1115   data.first = first;
1116   data.user_data = user_data;
1117   data.result = NULL;
1118
1119   result = gst_filter_run (list, (GstFilterFunc) _feature_filter, first, &data);
1120   g_list_free (result);
1121
1122   return data.result;
1123 }
1124 #endif
1125
1126 /**
1127  * gst_plugin_name_filter:
1128  * @plugin: the plugin to check
1129  * @name: the name of the plugin
1130  *
1131  * A standard filter that returns TRUE when the plugin is of the
1132  * given name.
1133  *
1134  * Returns: TRUE if the plugin is of the given name.
1135  */
1136 gboolean
1137 gst_plugin_name_filter (GstPlugin * plugin, const gchar * name)
1138 {
1139   return (plugin->desc.name && !strcmp (plugin->desc.name, name));
1140 }
1141
1142 #if 0
1143 /**
1144  * gst_plugin_find_feature:
1145  * @plugin: plugin to get the feature from
1146  * @name: The name of the feature to find
1147  * @type: The type of the feature to find
1148  *
1149  * Find a feature of the given name and type in the given plugin.
1150  *
1151  * Returns: a GstPluginFeature or NULL if the feature was not found.
1152  */
1153 GstPluginFeature *
1154 gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type)
1155 {
1156   GList *walk;
1157   GstPluginFeature *result = NULL;
1158   GstTypeNameData data;
1159
1160   g_return_val_if_fail (name != NULL, NULL);
1161
1162   data.type = type;
1163   data.name = name;
1164
1165   walk = gst_filter_run (plugin->features,
1166       (GstFilterFunc) gst_plugin_feature_type_name_filter, TRUE, &data);
1167
1168   if (walk) {
1169     result = GST_PLUGIN_FEATURE (walk->data);
1170
1171     gst_object_ref (result);
1172     gst_plugin_feature_list_free (walk);
1173   }
1174
1175   return result;
1176 }
1177 #endif
1178
1179 #if 0
1180 static gboolean
1181 gst_plugin_feature_name_filter (GstPluginFeature * feature, const gchar * name)
1182 {
1183   return !strcmp (name, GST_PLUGIN_FEATURE_NAME (feature));
1184 }
1185 #endif
1186
1187 #if 0
1188 /**
1189  * gst_plugin_find_feature_by_name:
1190  * @plugin: plugin to get the feature from
1191  * @name: The name of the feature to find
1192  *
1193  * Find a feature of the given name in the given plugin.
1194  *
1195  * Returns: a GstPluginFeature or NULL if the feature was not found.
1196  */
1197 GstPluginFeature *
1198 gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name)
1199 {
1200   GList *walk;
1201   GstPluginFeature *result = NULL;
1202
1203   g_return_val_if_fail (name != NULL, NULL);
1204
1205   walk = gst_filter_run (plugin->features,
1206       (GstFilterFunc) gst_plugin_feature_name_filter, TRUE, (void *) name);
1207
1208   if (walk) {
1209     result = GST_PLUGIN_FEATURE (walk->data);
1210
1211     gst_object_ref (result);
1212     gst_plugin_feature_list_free (walk);
1213   }
1214
1215   return result;
1216 }
1217 #endif
1218
1219 /**
1220  * gst_plugin_load_by_name:
1221  * @name: name of plugin to load
1222  *
1223  * Load the named plugin. Refs the plugin.
1224  *
1225  * Returns: A reference to a loaded plugin, or NULL on error.
1226  */
1227 GstPlugin *
1228 gst_plugin_load_by_name (const gchar * name)
1229 {
1230   GstPlugin *plugin, *newplugin;
1231   GError *error = NULL;
1232
1233   GST_DEBUG ("looking up plugin %s in default registry", name);
1234   plugin = gst_registry_find_plugin (gst_registry_get_default (), name);
1235   if (plugin) {
1236     GST_DEBUG ("loading plugin %s from file %s", name, plugin->filename);
1237     newplugin = gst_plugin_load_file (plugin->filename, &error);
1238     gst_object_unref (plugin);
1239
1240     if (!newplugin) {
1241       GST_WARNING ("load_plugin error: %s", error->message);
1242       g_error_free (error);
1243       return NULL;
1244     }
1245     /* newplugin was reffed by load_file */
1246     return newplugin;
1247   }
1248
1249   GST_DEBUG ("Could not find plugin %s in registry", name);
1250   return NULL;
1251 }
1252
1253 /**
1254  * gst_plugin_load:
1255  * @plugin: plugin to load
1256  *
1257  * Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is
1258  * untouched. The normal use pattern of this function goes like this:
1259  *
1260  * <programlisting>
1261  * GstPlugin *loaded_plugin;
1262  * loaded_plugin = gst_plugin_load (plugin);
1263  * // presumably, we're no longer interested in the potentially-unloaded plugin
1264  * gst_object_unref (plugin);
1265  * plugin = loaded_plugin;
1266  * </programlisting>
1267  *
1268  * Returns: A reference to a loaded plugin, or NULL on error.
1269  */
1270 GstPlugin *
1271 gst_plugin_load (GstPlugin * plugin)
1272 {
1273   GError *error = NULL;
1274   GstPlugin *newplugin;
1275
1276   if (gst_plugin_is_loaded (plugin)) {
1277     return plugin;
1278   }
1279
1280   if (!(newplugin = gst_plugin_load_file (plugin->filename, &error)))
1281     goto load_error;
1282
1283   return newplugin;
1284
1285 load_error:
1286   {
1287     GST_WARNING ("load_plugin error: %s", error->message);
1288     g_error_free (error);
1289     return NULL;
1290   }
1291 }
1292
1293 /**
1294  * gst_plugin_list_free:
1295  * @list: list of #GstPlugin
1296  *
1297  * Unrefs each member of @list, then frees the list.
1298  */
1299 void
1300 gst_plugin_list_free (GList * list)
1301 {
1302   GList *g;
1303
1304   for (g = list; g; g = g->next) {
1305     gst_object_unref (GST_PLUGIN_CAST (g->data));
1306   }
1307   g_list_free (list);
1308 }
1309
1310 /* ===== plugin dependencies ===== */
1311
1312 /* Scenarios:
1313  * ENV + xyz     where ENV can contain multiple values separated by SEPARATOR
1314  *               xyz may be "" (if ENV contains path to file rather than dir)
1315  * ENV + *xyz   same as above, but xyz acts as suffix filter
1316  * ENV + xyz*   same as above, but xyz acts as prefix filter (is this needed?)
1317  * ENV + *xyz*  same as above, but xyz acts as strstr filter (is this needed?)
1318  *
1319  * same as above, with additional paths hard-coded at compile-time:
1320  *   - only check paths + ... if ENV is not set or yields not paths
1321  *   - always check paths + ... in addition to ENV
1322  *
1323  * When user specifies set of environment variables, he/she may also use e.g.
1324  * "HOME/.mystuff/plugins", and we'll expand the content of $HOME with the
1325  * remainder
1326  */
1327
1328 /* we store in registry:
1329  *  sets of:
1330  *   {
1331  *     - environment variables (array of strings)
1332  *     - last hash of env variable contents (uint) (so we can avoid doing stats
1333  *       if one of the env vars has changed; premature optimisation galore)
1334  *     - hard-coded paths (array of strings)
1335  *     - xyz filename/suffix/prefix strings (array of strings)
1336  *     - flags (int)
1337  *     - last hash of file/dir stats (int)
1338  *   }
1339  *   (= struct GstPluginDep)
1340  */
1341
1342 static guint
1343 gst_plugin_ext_dep_get_env_vars_hash (GstPlugin * plugin, GstPluginDep * dep)
1344 {
1345   gchar **e;
1346   guint hash;
1347
1348   /* there's no deeper logic to what we do here; all we want to know (when
1349    * checking if the plugin needs to be rescanned) is whether the content of
1350    * one of the environment variables in the list is different from when it
1351    * was last scanned */
1352   hash = 0;
1353   for (e = dep->env_vars; e != NULL && *e != NULL; ++e) {
1354     const gchar *val;
1355     gchar env_var[256];
1356
1357     /* order matters: "val",NULL needs to yield a different hash than
1358      * NULL,"val", so do a shift here whether the var is set or not */
1359     hash = hash << 5;
1360
1361     /* want environment variable at beginning of string */
1362     if (!g_ascii_isalnum (**e)) {
1363       GST_WARNING_OBJECT (plugin, "string prefix is not a valid environment "
1364           "variable string: %s", *e);
1365       continue;
1366     }
1367
1368     /* user is allowed to specify e.g. "HOME/.pitivi/plugins" */
1369     g_strlcpy (env_var, *e, sizeof (env_var));
1370     g_strdelimit (env_var, "/\\", '\0');
1371
1372     if ((val = g_getenv (env_var)))
1373       hash += g_str_hash (val);
1374   }
1375
1376   return hash;
1377 }
1378
1379 gboolean
1380 _priv_plugin_deps_env_vars_changed (GstPlugin * plugin)
1381 {
1382   GList *l;
1383
1384   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1385     GstPluginDep *dep = l->data;
1386
1387     if (dep->env_hash != gst_plugin_ext_dep_get_env_vars_hash (plugin, dep))
1388       return TRUE;
1389   }
1390
1391   return FALSE;
1392 }
1393
1394 static GList *
1395 gst_plugin_ext_dep_extract_env_vars_paths (GstPlugin * plugin,
1396     GstPluginDep * dep)
1397 {
1398   gchar **evars;
1399   GList *paths = NULL;
1400
1401   for (evars = dep->env_vars; evars != NULL && *evars != NULL; ++evars) {
1402     const gchar *e;
1403     gchar **components;
1404
1405     /* want environment variable at beginning of string */
1406     if (!g_ascii_isalnum (**evars)) {
1407       GST_WARNING_OBJECT (plugin, "string prefix is not a valid environment "
1408           "variable string: %s", *evars);
1409       continue;
1410     }
1411
1412     /* user is allowed to specify e.g. "HOME/.pitivi/plugins", which we want to
1413      * split into the env_var name component and the path component */
1414     components = g_strsplit_set (*evars, "/\\", 2);
1415     g_assert (components != NULL);
1416
1417     e = g_getenv (components[0]);
1418     GST_LOG_OBJECT (plugin, "expanding %s = '%s' (path suffix: %s)",
1419         components[0], GST_STR_NULL (e), GST_STR_NULL (components[1]));
1420
1421     if (components[1] != NULL) {
1422       g_strdelimit (components[1], "/\\", G_DIR_SEPARATOR);
1423     }
1424
1425     if (e != NULL && *e != '\0') {
1426       gchar **arr;
1427       guint i;
1428
1429       arr = g_strsplit (e, G_SEARCHPATH_SEPARATOR_S, -1);
1430
1431       for (i = 0; arr != NULL && arr[i] != NULL; ++i) {
1432         gchar *full_path;
1433
1434         if (!g_path_is_absolute (arr[i])) {
1435           GST_INFO_OBJECT (plugin, "ignoring environment variable content '%s'"
1436               ": either not an absolute path or not a path at all", arr[i]);
1437           continue;
1438         }
1439
1440         if (components[1] != NULL) {
1441           full_path = g_build_filename (arr[i], components[1], NULL);
1442         } else {
1443           full_path = g_strdup (arr[i]);
1444         }
1445
1446         if (!g_list_find_custom (paths, full_path, (GCompareFunc) strcmp)) {
1447           GST_LOG_OBJECT (plugin, "path: '%s'", full_path);
1448           paths = g_list_prepend (paths, full_path);
1449           full_path = NULL;
1450         } else {
1451           GST_LOG_OBJECT (plugin, "path: '%s' (duplicate,ignoring)", full_path);
1452           g_free (full_path);
1453         }
1454       }
1455
1456       g_strfreev (arr);
1457     }
1458
1459     g_strfreev (components);
1460   }
1461
1462   GST_LOG_OBJECT (plugin, "Extracted %d paths from environment",
1463       g_list_length (paths));
1464
1465   return paths;
1466 }
1467
1468 static guint
1469 gst_plugin_ext_dep_get_hash_from_stat_entry (struct stat *s)
1470 {
1471   if (!(s->st_mode & (S_IFDIR | S_IFREG)))
1472     return (guint) - 1;
1473
1474   /* completely random formula */
1475   return ((s->st_size << 3) + (s->st_mtime << 5)) ^ s->st_ctime;
1476 }
1477
1478 static gboolean
1479 gst_plugin_ext_dep_direntry_matches (GstPlugin * plugin, const gchar * entry,
1480     const gchar ** filenames, GstPluginDependencyFlags flags)
1481 {
1482   /* no filenames specified, match all entries for now (could probably
1483    * optimise by just taking the dir stat hash or so) */
1484   if (filenames == NULL || *filenames == NULL || **filenames == '\0')
1485     return TRUE;
1486
1487   while (*filenames != NULL) {
1488     /* suffix match? */
1489     if (((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX)) &&
1490         g_str_has_suffix (entry, *filenames)) {
1491       return TRUE;
1492       /* else it's an exact match that's needed */
1493     } else if (strcmp (entry, *filenames) == 0) {
1494       return TRUE;
1495     }
1496     GST_LOG ("%s does not match %s, flags=0x%04x", entry, *filenames, flags);
1497     ++filenames;
1498   }
1499   return FALSE;
1500 }
1501
1502 static guint
1503 gst_plugin_ext_dep_scan_dir_and_match_names (GstPlugin * plugin,
1504     const gchar * path, const gchar ** filenames,
1505     GstPluginDependencyFlags flags, int depth)
1506 {
1507   const gchar *entry;
1508   gboolean recurse_dirs;
1509   GError *err = NULL;
1510   GDir *dir;
1511   guint hash = 0;
1512
1513   recurse_dirs = !!(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
1514
1515   dir = g_dir_open (path, 0, &err);
1516   if (dir == NULL) {
1517     GST_DEBUG_OBJECT (plugin, "g_dir_open(%s) failed: %s", path, err->message);
1518     g_error_free (err);
1519     return (guint) - 1;
1520   }
1521
1522   /* FIXME: we're assuming here that we always get the directory entries in
1523    * the same order, and not in a random order */
1524   while ((entry = g_dir_read_name (dir))) {
1525     gboolean have_match;
1526     struct stat s;
1527     gchar *full_path;
1528     guint fhash;
1529
1530     have_match =
1531         gst_plugin_ext_dep_direntry_matches (plugin, entry, filenames, flags);
1532
1533     /* avoid the stat if possible */
1534     if (!have_match && !recurse_dirs)
1535       continue;
1536
1537     full_path = g_build_filename (path, entry, NULL);
1538     if (g_stat (full_path, &s) < 0) {
1539       fhash = (guint) - 1;
1540       GST_LOG_OBJECT (plugin, "stat: %s (error: %s)", full_path,
1541           g_strerror (errno));
1542     } else if (have_match) {
1543       fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
1544       GST_LOG_OBJECT (plugin, "stat: %s (result: %u)", full_path, fhash);
1545     } else if ((s.st_mode & (S_IFDIR))) {
1546       fhash = gst_plugin_ext_dep_scan_dir_and_match_names (plugin, full_path,
1547           filenames, flags, depth + 1);
1548     } else {
1549       /* it's not a name match, we want to recurse, but it's not a directory */
1550       g_free (full_path);
1551       continue;
1552     }
1553
1554     hash = (hash + fhash) << 1;
1555     g_free (full_path);
1556   }
1557
1558   g_dir_close (dir);
1559   return hash;
1560 }
1561
1562 static guint
1563 gst_plugin_ext_dep_scan_path_with_filenames (GstPlugin * plugin,
1564     const gchar * path, const gchar ** filenames,
1565     GstPluginDependencyFlags flags)
1566 {
1567   const gchar *empty_filenames[] = { "", NULL };
1568   gboolean recurse_into_dirs, partial_names;
1569   guint i, hash = 0;
1570
1571   /* to avoid special-casing below (FIXME?) */
1572   if (filenames == NULL || *filenames == NULL)
1573     filenames = empty_filenames;
1574
1575   recurse_into_dirs = !!(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
1576   partial_names = !!(flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX);
1577
1578   /* if we can construct the exact paths to check with the data we have, just
1579    * stat them one by one; this is more efficient than opening the directory
1580    * and going through each entry to see if it matches one of our filenames. */
1581   if (!recurse_into_dirs && !partial_names) {
1582     for (i = 0; filenames[i] != NULL; ++i) {
1583       struct stat s;
1584       gchar *full_path;
1585       guint fhash;
1586
1587       full_path = g_build_filename (path, filenames[i], NULL);
1588       if (g_stat (full_path, &s) < 0) {
1589         fhash = (guint) - 1;
1590         GST_LOG_OBJECT (plugin, "stat: %s (error: %s)", full_path,
1591             g_strerror (errno));
1592       } else {
1593         fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
1594         GST_LOG_OBJECT (plugin, "stat: %s (result: %08x)", full_path, fhash);
1595       }
1596       hash = (hash + fhash) << 1;
1597       g_free (full_path);
1598     }
1599   } else {
1600     hash = gst_plugin_ext_dep_scan_dir_and_match_names (plugin, path,
1601         filenames, flags, 0);
1602   }
1603
1604   return hash;
1605 }
1606
1607 static guint
1608 gst_plugin_ext_dep_get_stat_hash (GstPlugin * plugin, GstPluginDep * dep)
1609 {
1610   gboolean paths_are_default_only;
1611   GList *scan_paths;
1612   guint scan_hash = 0;
1613
1614   GST_LOG_OBJECT (plugin, "start");
1615
1616   paths_are_default_only =
1617       dep->flags & GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY;
1618
1619   scan_paths = gst_plugin_ext_dep_extract_env_vars_paths (plugin, dep);
1620
1621   if (scan_paths == NULL || !paths_are_default_only) {
1622     gchar **paths;
1623
1624     for (paths = dep->paths; paths != NULL && *paths != NULL; ++paths) {
1625       const gchar *path = *paths;
1626
1627       if (!g_list_find_custom (scan_paths, path, (GCompareFunc) strcmp)) {
1628         GST_LOG_OBJECT (plugin, "path: '%s'", path);
1629         scan_paths = g_list_prepend (scan_paths, g_strdup (path));
1630       } else {
1631         GST_LOG_OBJECT (plugin, "path: '%s' (duplicate, ignoring)", path);
1632       }
1633     }
1634   }
1635
1636   /* not that the order really matters, but it makes debugging easier */
1637   scan_paths = g_list_reverse (scan_paths);
1638
1639   while (scan_paths != NULL) {
1640     const gchar *path = scan_paths->data;
1641
1642     scan_hash += gst_plugin_ext_dep_scan_path_with_filenames (plugin, path,
1643         (const gchar **) dep->names, dep->flags);
1644     scan_hash = scan_hash << 1;
1645
1646     g_free (scan_paths->data);
1647     scan_paths = g_list_delete_link (scan_paths, scan_paths);
1648   }
1649
1650   GST_LOG_OBJECT (plugin, "done, scan_hash: %08x", scan_hash);
1651   return scan_hash;
1652 }
1653
1654 gboolean
1655 _priv_plugin_deps_files_changed (GstPlugin * plugin)
1656 {
1657   GList *l;
1658
1659   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1660     GstPluginDep *dep = l->data;
1661
1662     if (dep->stat_hash != gst_plugin_ext_dep_get_stat_hash (plugin, dep))
1663       return TRUE;
1664   }
1665
1666   return FALSE;
1667 }
1668
1669 static void
1670 gst_plugin_ext_dep_free (GstPluginDep * dep)
1671 {
1672   g_strfreev (dep->env_vars);
1673   g_strfreev (dep->paths);
1674   g_strfreev (dep->names);
1675   g_slice_free (GstPluginDep, dep);
1676 }
1677
1678 static gboolean
1679 gst_plugin_ext_dep_strv_equal (gchar ** arr1, gchar ** arr2)
1680 {
1681   if (arr1 == arr2)
1682     return TRUE;
1683   if (arr1 == NULL || arr2 == NULL)
1684     return FALSE;
1685   for (; *arr1 != NULL && *arr2 != NULL; ++arr1, ++arr2) {
1686     if (strcmp (*arr1, *arr2) != 0)
1687       return FALSE;
1688   }
1689   return (*arr1 == *arr2);
1690 }
1691
1692 static gboolean
1693 gst_plugin_ext_dep_equals (GstPluginDep * dep, const gchar ** env_vars,
1694     const gchar ** paths, const gchar ** names, GstPluginDependencyFlags flags)
1695 {
1696   if (dep->flags != flags)
1697     return FALSE;
1698
1699   return gst_plugin_ext_dep_strv_equal (dep->env_vars, (gchar **) env_vars) &&
1700       gst_plugin_ext_dep_strv_equal (dep->paths, (gchar **) paths) &&
1701       gst_plugin_ext_dep_strv_equal (dep->names, (gchar **) names);
1702 }
1703
1704 /**
1705  * gst_plugin_add_dependency:
1706  * @plugin: a #GstPlugin
1707  * @env_vars: NULL-terminated array of environent variables affecting the
1708  *     feature set of the plugin (e.g. an environment variable containing
1709  *     paths where to look for additional modules/plugins of a library),
1710  *     or NULL. Environment variable names may be followed by a path component
1711  *      which will be added to the content of the environment variable, e.g.
1712  *      "HOME/.mystuff/plugins".
1713  * @paths: NULL-terminated array of directories/paths where dependent files
1714  *     may be.
1715  * @names: NULL-terminated array of file names (or file name suffixes,
1716  *     depending on @flags) to be used in combination with the paths from
1717  *     @paths and/or the paths extracted from the environment variables in
1718  *     @env_vars, or NULL.
1719  * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
1720  *
1721  * Make GStreamer aware of external dependencies which affect the feature
1722  * set of this plugin (ie. the elements or typefinders associated with it).
1723  *
1724  * GStreamer will re-inspect plugins with external dependencies whenever any
1725  * of the external dependencies change. This is useful for plugins which wrap
1726  * other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
1727  * library and makes visualisations available as GStreamer elements, or a
1728  * codec loader which exposes elements and/or caps dependent on what external
1729  * codec libraries are currently installed.
1730  *
1731  * Since: 0.10.22
1732  */
1733 void
1734 gst_plugin_add_dependency (GstPlugin * plugin, const gchar ** env_vars,
1735     const gchar ** paths, const gchar ** names, GstPluginDependencyFlags flags)
1736 {
1737   GstPluginDep *dep;
1738   GList *l;
1739
1740   g_return_if_fail (GST_IS_PLUGIN (plugin));
1741
1742   if ((env_vars == NULL || env_vars[0] == NULL) &&
1743       (paths == NULL || paths[0] == NULL)) {
1744     GST_DEBUG_OBJECT (plugin,
1745         "plugin registered empty dependency set. Ignoring");
1746     return;
1747   }
1748
1749   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1750     if (gst_plugin_ext_dep_equals (l->data, env_vars, paths, names, flags)) {
1751       GST_LOG_OBJECT (plugin, "dependency already registered");
1752       return;
1753     }
1754   }
1755
1756   dep = g_slice_new (GstPluginDep);
1757
1758   dep->env_vars = g_strdupv ((gchar **) env_vars);
1759   dep->paths = g_strdupv ((gchar **) paths);
1760   dep->names = g_strdupv ((gchar **) names);
1761   dep->flags = flags;
1762
1763   dep->env_hash = gst_plugin_ext_dep_get_env_vars_hash (plugin, dep);
1764   dep->stat_hash = gst_plugin_ext_dep_get_stat_hash (plugin, dep);
1765
1766   plugin->priv->deps = g_list_append (plugin->priv->deps, dep);
1767
1768   GST_DEBUG_OBJECT (plugin, "added dependency:");
1769   for (; env_vars != NULL && *env_vars != NULL; ++env_vars)
1770     GST_DEBUG_OBJECT (plugin, " evar: %s", *env_vars);
1771   for (; paths != NULL && *paths != NULL; ++paths)
1772     GST_DEBUG_OBJECT (plugin, " path: %s", *paths);
1773   for (; names != NULL && *names != NULL; ++names)
1774     GST_DEBUG_OBJECT (plugin, " name: %s", *names);
1775 }
1776
1777 /**
1778  * gst_plugin_add_dependency_simple:
1779  * @plugin: the #GstPlugin
1780  * @env_vars: one or more environent variables (separated by ':', ';' or ','),
1781  *      or NULL. Environment variable names may be followed by a path component
1782  *      which will be added to the content of the environment variable, e.g.
1783  *      "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"
1784  * @paths: one ore more directory paths (separated by ':' or ';' or ','),
1785  *      or NULL. Example: "/usr/lib/mystuff/plugins"
1786  * @names: one or more file names or file name suffixes (separated by commas),
1787  *   or NULL
1788  * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
1789  *
1790  * Make GStreamer aware of external dependencies which affect the feature
1791  * set of this plugin (ie. the elements or typefinders associated with it).
1792  *
1793  * GStreamer will re-inspect plugins with external dependencies whenever any
1794  * of the external dependencies change. This is useful for plugins which wrap
1795  * other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
1796  * library and makes visualisations available as GStreamer elements, or a
1797  * codec loader which exposes elements and/or caps dependent on what external
1798  * codec libraries are currently installed.
1799  *
1800  * Convenience wrapper function for gst_plugin_add_dependency() which
1801  * takes simple strings as arguments instead of string arrays, with multiple
1802  * arguments separated by predefined delimiters (see above).
1803  *
1804  * Since: 0.10.22
1805  */
1806 void
1807 gst_plugin_add_dependency_simple (GstPlugin * plugin,
1808     const gchar * env_vars, const gchar * paths, const gchar * names,
1809     GstPluginDependencyFlags flags)
1810 {
1811   gchar **a_evars = NULL;
1812   gchar **a_paths = NULL;
1813   gchar **a_names = NULL;
1814
1815   if (env_vars)
1816     a_evars = g_strsplit_set (env_vars, ":;,", -1);
1817   if (paths)
1818     a_paths = g_strsplit_set (paths, ":;,", -1);
1819   if (names)
1820     a_names = g_strsplit_set (names, ",", -1);
1821
1822   gst_plugin_add_dependency (plugin, (const gchar **) a_evars,
1823       (const gchar **) a_paths, (const gchar **) a_names, flags);
1824
1825   if (a_evars)
1826     g_strfreev (a_evars);
1827   if (a_paths)
1828     g_strfreev (a_paths);
1829   if (a_names)
1830     g_strfreev (a_names);
1831 }