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