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 #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[] = {
  94   "LGPL",                       /* GNU Lesser General Public License */
  95   "GPL",                        /* GNU General Public License */
  96   "QPL",                        /* Trolltech Qt Public License */
  97   "GPL/QPL",                    /* Combi-license of GPL + QPL */
  98   "MPL",                        /* MPL 1.1 license */
  99   "BSD",                        /* 3-clause BSD license */
 100   "MIT/X11",                    /* MIT/X11 license */
 101   "Proprietary",                /* Proprietary license */
 102   GST_LICENSE_UNKNOWN,          /* some other license */
 103   NULL
 104 };
 105
 106 static GstPlugin *gst_plugin_register_func (GstPlugin * plugin,
 107     const GstPluginDesc * desc, gpointer user_data);
 108 static void gst_plugin_desc_copy (GstPluginDesc * dest,
 109     const GstPluginDesc * src);
 110
 111 static void gst_plugin_ext_dep_free (GstPluginDep * dep);
 112
 113 G_DEFINE_TYPE (GstPlugin, gst_plugin, GST_TYPE_OBJECT);
 114
 115 static void
 116 gst_plugin_init (GstPlugin * plugin)
 117 {
 118   plugin->priv =
 119       G_TYPE_INSTANCE_GET_PRIVATE (plugin, GST_TYPE_PLUGIN, GstPluginPrivate);
 120 }
 121
 122 static void
 123 gst_plugin_finalize (GObject * object)
 124 {
 125   GstPlugin *plugin = GST_PLUGIN_CAST (object);
 126   GstRegistry *registry = gst_registry_get_default ();
 127   GList *g;
 128
 129   GST_DEBUG ("finalizing plugin %" GST_PTR_FORMAT, plugin);
 130   for (g = registry->plugins; g; g = g->next) {
 131     if (g->data == (gpointer) plugin) {
 132       g_warning ("removing plugin that is still in registry");
 133     }
 134   }
 135   g_free (plugin->filename);
 136   g_free (plugin->basename);
 137
 138   g_list_foreach (plugin->priv->deps, (GFunc) gst_plugin_ext_dep_free, NULL);
 139   g_list_free (plugin->priv->deps);
 140   plugin->priv->deps = NULL;
 141
 142   if (plugin->priv->cache_data) {
 143     gst_structure_free (plugin->priv->cache_data);
 144   }
 145
 146   G_OBJECT_CLASS (gst_plugin_parent_class)->finalize (object);
 147 }
 148
 149 static void
 150 gst_plugin_class_init (GstPluginClass * klass)
 151 {
 152   G_OBJECT_CLASS (klass)->finalize = gst_plugin_finalize;
 153
 154   g_type_class_add_private (klass, sizeof (GstPluginPrivate));
 155 }
 156
 157 GQuark
 158 gst_plugin_error_quark (void)
 159 {
 160   static GQuark quark = 0;
 161
 162   if (!quark)
 163     quark = g_quark_from_static_string ("gst_plugin_error");
 164   return quark;
 165 }
 166
 167 /**
 168  * gst_plugin_register_static:
 169  * @major_version: the major version number of the GStreamer core that the
 170  *     plugin was compiled for, you can just use GST_VERSION_MAJOR here
 171  * @minor_version: the minor version number of the GStreamer core that the
 172  *     plugin was compiled for, you can just use GST_VERSION_MINOR here
 173  * @name: a unique name of the plugin (ideally prefixed with an application- or
 174  *     library-specific namespace prefix in order to avoid name conflicts in
 175  *     case a similar plugin with the same name ever gets added to GStreamer)
 176  * @description: description of the plugin
 177  * @init_func: pointer to the init function of this plugin.
 178  * @version: version string of the plugin
 179  * @license: effective license of plugin. Must be one of the approved licenses
 180  *     (see #GstPluginDesc above) or the plugin will not be registered.
 181  * @source: source module plugin belongs to
 182  * @package: shipped package plugin belongs to
 183  * @origin: URL to provider of plugin
 184  *
 185  * Registers a static plugin, ie. a plugin which is private to an application
 186  * or library and contained within the application or library (as opposed to
 187  * being shipped as a separate module file).
 188  *
 189  * You must make sure that GStreamer has been initialised (with gst_init() or
 190  * via gst_init_get_option_group()) before calling this function.
 191  *
 192  * Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
 193  *
 194  * Since: 0.10.16
 195  */
 196 gboolean
 197 gst_plugin_register_static (gint major_version, gint minor_version,
 198     const gchar * name, const gchar * description, GstPluginInitFunc init_func,
 199     const gchar * version, const gchar * license, const gchar * source,
 200     const gchar * package, const gchar * origin)
 201 {
 202   GstPluginDesc desc = { major_version, minor_version, name, description,
 203     init_func, version, license, source, package, origin, NULL,
 204   };
 205   GstPlugin *plugin;
 206   gboolean res = FALSE;
 207
 208   g_return_val_if_fail (name != NULL, FALSE);
 209   g_return_val_if_fail (description != NULL, FALSE);
 210   g_return_val_if_fail (init_func != NULL, FALSE);
 211   g_return_val_if_fail (version != NULL, FALSE);
 212   g_return_val_if_fail (license != NULL, FALSE);
 213   g_return_val_if_fail (source != NULL, FALSE);
 214   g_return_val_if_fail (package != NULL, FALSE);
 215   g_return_val_if_fail (origin != NULL, FALSE);
 216
 217   /* make sure gst_init() has been called */
 218   g_return_val_if_fail (_gst_plugin_inited != FALSE, FALSE);
 219
 220   GST_LOG ("attempting to load static plugin \"%s\" now...", name);
 221   plugin = g_object_newv (GST_TYPE_PLUGIN, 0, NULL);
 222   if (gst_plugin_register_func (plugin, &desc, NULL) != NULL) {
 223     GST_INFO ("registered static plugin \"%s\"", name);
 224     res = gst_default_registry_add_plugin (plugin);
 225     GST_INFO ("added static plugin \"%s\", result: %d", name, res);
 226   }
 227   return res;
 228 }
 229
 230 /**
 231  * gst_plugin_register_static_full:
 232  * @major_version: the major version number of the GStreamer core that the
 233  *     plugin was compiled for, you can just use GST_VERSION_MAJOR here
 234  * @minor_version: the minor version number of the GStreamer core that the
 235  *     plugin was compiled for, you can just use GST_VERSION_MINOR here
 236  * @name: a unique name of the plugin (ideally prefixed with an application- or
 237  *     library-specific namespace prefix in order to avoid name conflicts in
 238  *     case a similar plugin with the same name ever gets added to GStreamer)
 239  * @description: description of the plugin
 240  * @init_full_func: pointer to the init function with user data of this plugin.
 241  * @version: version string of the plugin
 242  * @license: effective license of plugin. Must be one of the approved licenses
 243  *     (see #GstPluginDesc above) or the plugin will not be registered.
 244  * @source: source module plugin belongs to
 245  * @package: shipped package plugin belongs to
 246  * @origin: URL to provider of plugin
 247  * @user_data: gpointer to user data
 248  *
 249  * Registers a static plugin, ie. a plugin which is private to an application
 250  * or library and contained within the application or library (as opposed to
 251  * being shipped as a separate module file) with a #GstPluginInitFullFunc
 252  * which allows user data to be passed to the callback function (useful
 253  * for bindings).
 254  *
 255  * You must make sure that GStreamer has been initialised (with gst_init() or
 256  * via gst_init_get_option_group()) before calling this function.
 257  *
 258  * Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
 259  *
 260  * Since: 0.10.24
 261  *
 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_default_registry_add_plugin (plugin);
 294     GST_INFO ("added static plugin \"%s\", result: %d", name, res);
 295   }
 296   return res;
 297 }
 298
 299 void
 300 _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   const gchar **check_license = valid_licenses;
 458
 459   g_assert (check_license);
 460
 461   while (*check_license) {
 462     if (strcmp (license, *check_license) == 0)
 463       return TRUE;
 464     check_license++;
 465   }
 466   return FALSE;
 467 }
 468
 469 static gboolean
 470 gst_plugin_check_version (gint major, gint minor)
 471 {
 472   /* return NULL if the major and minor version numbers are not compatible */
 473   /* with ours. */
 474   if (major != GST_VERSION_MAJOR || minor != GST_VERSION_MINOR)
 475     return FALSE;
 476
 477   return TRUE;
 478 }
 479
 480 static GstPlugin *
 481 gst_plugin_register_func (GstPlugin * plugin, const GstPluginDesc * desc,
 482     gpointer user_data)
 483 {
 484   if (!gst_plugin_check_version (desc->major_version, desc->minor_version)) {
 485     if (GST_CAT_DEFAULT)
 486       GST_WARNING ("plugin \"%s\" has incompatible version, not loading",
 487           plugin->filename);
 488     return NULL;
 489   }
 490
 491   if (!desc->license || !desc->description || !desc->source ||
 492       !desc->package || !desc->origin) {
 493     if (GST_CAT_DEFAULT)
 494       GST_WARNING ("plugin \"%s\" has incorrect GstPluginDesc, not loading",
 495           plugin->filename);
 496     return NULL;
 497   }
 498
 499   if (!gst_plugin_check_license (desc->license)) {
 500     if (GST_CAT_DEFAULT)
 501       GST_WARNING ("plugin \"%s\" has invalid license \"%s\", not loading",
 502           plugin->filename, desc->license);
 503     return NULL;
 504   }
 505
 506   if (GST_CAT_DEFAULT)
 507     GST_LOG ("plugin \"%s\" looks good", GST_STR_NULL (plugin->filename));
 508
 509   gst_plugin_desc_copy (&plugin->desc, desc);
 510
 511   /* make resident so we're really sure it never gets unloaded again.
 512    * Theoretically this is not needed, but practically it doesn't hurt.
 513    * And we're rather safe than sorry. */
 514   if (plugin->module)
 515     g_module_make_resident (plugin->module);
 516
 517   if (user_data) {
 518     if (!(((GstPluginInitFullFunc) (desc->plugin_init)) (plugin, user_data))) {
 519       if (GST_CAT_DEFAULT)
 520         GST_WARNING ("plugin \"%s\" failed to initialise", plugin->filename);
 521       return NULL;
 522     }
 523   } else {
 524     if (!((desc->plugin_init) (plugin))) {
 525       if (GST_CAT_DEFAULT)
 526         GST_WARNING ("plugin \"%s\" failed to initialise", plugin->filename);
 527       return NULL;
 528     }
 529   }
 530
 531   if (GST_CAT_DEFAULT)
 532     GST_LOG ("plugin \"%s\" initialised", GST_STR_NULL (plugin->filename));
 533
 534   return plugin;
 535 }
 536
 537 #ifdef HAVE_SIGACTION
 538 static struct sigaction oldaction;
 539 static gboolean _gst_plugin_fault_handler_is_setup = FALSE;
 540
 541 /*
 542  * _gst_plugin_fault_handler_restore:
 543  * segfault handler restorer
 544  */
 545 static void
 546 _gst_plugin_fault_handler_restore (void)
 547 {
 548   if (!_gst_plugin_fault_handler_is_setup)
 549     return;
 550
 551   _gst_plugin_fault_handler_is_setup = FALSE;
 552
 553   sigaction (SIGSEGV, &oldaction, NULL);
 554 }
 555
 556 /*
 557  * _gst_plugin_fault_handler_sighandler:
 558  * segfault handler implementation
 559  */
 560 static void
 561 _gst_plugin_fault_handler_sighandler (int signum)
 562 {
 563   /* We need to restore the fault handler or we'll keep getting it */
 564   _gst_plugin_fault_handler_restore ();
 565
 566   switch (signum) {
 567     case SIGSEGV:
 568       g_print ("\nERROR: ");
 569       g_print ("Caught a segmentation fault while loading plugin file:\n");
 570       g_print ("%s\n\n", _gst_plugin_fault_handler_filename);
 571       g_print ("Please either:\n");
 572       g_print ("- remove it and restart.\n");
 573       g_print
 574           ("- run with --gst-disable-segtrap --gst-disable-registry-fork and debug.\n");
 575       exit (-1);
 576       break;
 577     default:
 578       g_print ("Caught unhandled signal on plugin loading\n");
 579       break;
 580   }
 581 }
 582
 583 /*
 584  * _gst_plugin_fault_handler_setup:
 585  * sets up the segfault handler
 586  */
 587 static void
 588 _gst_plugin_fault_handler_setup (void)
 589 {
 590   struct sigaction action;
 591
 592   /* if asked to leave segfaults alone, just return */
 593   if (!gst_segtrap_is_enabled ())
 594     return;
 595
 596   if (_gst_plugin_fault_handler_is_setup)
 597     return;
 598
 599   _gst_plugin_fault_handler_is_setup = TRUE;
 600
 601   memset (&action, 0, sizeof (action));
 602   action.sa_handler = _gst_plugin_fault_handler_sighandler;
 603
 604   sigaction (SIGSEGV, &action, &oldaction);
 605 }
 606 #else /* !HAVE_SIGACTION */
 607 static void
 608 _gst_plugin_fault_handler_restore (void)
 609 {
 610 }
 611
 612 static void
 613 _gst_plugin_fault_handler_setup (void)
 614 {
 615 }
 616 #endif /* HAVE_SIGACTION */
 617
 618 /* g_time_val_from_iso8601() doesn't do quite what we want */
 619 static gboolean
 620 check_release_datetime (const gchar * date_time)
 621 {
 622   guint64 val;
 623
 624   /* we require YYYY-MM-DD or YYYY-MM-DDTHH:MMZ format */
 625   if (!g_ascii_isdigit (*date_time))
 626     return FALSE;
 627
 628   val = g_ascii_strtoull (date_time, (gchar **) & date_time, 10);
 629   if (val < 2000 || val > 2100 || *date_time != '-')
 630     return FALSE;
 631
 632   val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 633   if (val == 0 || val > 12 || *date_time != '-')
 634     return FALSE;
 635
 636   val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 637   if (val == 0 || val > 32)
 638     return FALSE;
 639
 640   /* end of string or date/time separator + HH:MMZ */
 641   if (*date_time == 'T' || *date_time == ' ') {
 642     val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 643     if (val > 24 || *date_time != ':')
 644       return FALSE;
 645
 646     val = g_ascii_strtoull (date_time + 1, (gchar **) & date_time, 10);
 647     if (val > 59 || *date_time != 'Z')
 648       return FALSE;
 649
 650     ++date_time;
 651   }
 652
 653   return (*date_time == '\0');
 654 }
 655
 656 static GStaticMutex gst_plugin_loading_mutex = G_STATIC_MUTEX_INIT;
 657
 658 #define CHECK_PLUGIN_DESC_FIELD(desc,field,fn)                               \
 659   if (G_UNLIKELY ((desc)->field == NULL)) {                                  \
 660     GST_ERROR ("GstPluginDesc for '%s' has no %s", fn, G_STRINGIFY (field)); \
 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: a reference to the existing loaded GstPlugin, a reference to the
 671  * 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_default ();
 689   g_static_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_static_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 but accept them, to
 783      * maintain backwards compatibility (FIXME: 0.11) */
 784     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, name, filename);
 785     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, description, filename);
 786     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, version, filename);
 787     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, license, filename);
 788     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, source, filename);
 789     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, package, filename);
 790     CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, origin, filename);
 791
 792     if (plugin->orig_desc->release_datetime != NULL &&
 793         !check_release_datetime (plugin->orig_desc->release_datetime)) {
 794       GST_ERROR ("GstPluginDesc for '%s' has invalid datetime '%s'",
 795           filename, plugin->orig_desc->release_datetime);
 796       plugin->orig_desc->release_datetime = NULL;
 797     }
 798   }
 799
 800   GST_LOG ("Plugin %p for file \"%s\" prepared, calling entry function...",
 801       plugin, filename);
 802
 803   /* this is where we load the actual .so, so let's trap SIGSEGV */
 804   _gst_plugin_fault_handler_setup ();
 805   _gst_plugin_fault_handler_filename = plugin->filename;
 806
 807   GST_LOG ("Plugin %p for file \"%s\" prepared, registering...",
 808       plugin, filename);
 809
 810   if (!gst_plugin_register_func (plugin, plugin->orig_desc, NULL)) {
 811     /* remove signal handler */
 812     _gst_plugin_fault_handler_restore ();
 813     GST_DEBUG ("gst_plugin_register_func failed for plugin \"%s\"", filename);
 814     /* plugin == NULL */
 815     g_set_error (error,
 816         GST_PLUGIN_ERROR,
 817         GST_PLUGIN_ERROR_MODULE,
 818         "File \"%s\" appears to be a GStreamer plugin, but it failed to initialize",
 819         filename);
 820     goto return_error;
 821   }
 822
 823   /* remove signal handler */
 824   _gst_plugin_fault_handler_restore ();
 825   _gst_plugin_fault_handler_filename = NULL;
 826   GST_INFO ("plugin \"%s\" loaded", plugin->filename);
 827
 828   if (new_plugin) {
 829     gst_object_ref (plugin);
 830     gst_default_registry_add_plugin (plugin);
 831   }
 832
 833   g_static_mutex_unlock (&gst_plugin_loading_mutex);
 834   return plugin;
 835
 836 return_error:
 837   {
 838     if (plugin)
 839       gst_object_unref (plugin);
 840     g_static_mutex_unlock (&gst_plugin_loading_mutex);
 841     return NULL;
 842   }
 843 }
 844
 845 static void
 846 gst_plugin_desc_copy (GstPluginDesc * dest, const GstPluginDesc * src)
 847 {
 848   dest->major_version = src->major_version;
 849   dest->minor_version = src->minor_version;
 850   dest->name = g_intern_string (src->name);
 851   dest->description = g_intern_string (src->description);
 852   dest->plugin_init = src->plugin_init;
 853   dest->version = g_intern_string (src->version);
 854   dest->license = g_intern_string (src->license);
 855   dest->source = g_intern_string (src->source);
 856   dest->package = g_intern_string (src->package);
 857   dest->origin = g_intern_string (src->origin);
 858   dest->release_datetime = g_intern_string (src->release_datetime);
 859 }
 860
 861 /**
 862  * gst_plugin_get_name:
 863  * @plugin: plugin to get the name of
 864  *
 865  * Get the short name of the plugin
 866  *
 867  * Returns: the name of the plugin
 868  */
 869 const gchar *
 870 gst_plugin_get_name (GstPlugin * plugin)
 871 {
 872   g_return_val_if_fail (plugin != NULL, NULL);
 873
 874   return plugin->desc.name;
 875 }
 876
 877 /**
 878  * gst_plugin_get_description:
 879  * @plugin: plugin to get long name of
 880  *
 881  * Get the long descriptive name of the plugin
 882  *
 883  * Returns: the long name of the plugin
 884  */
 885 G_CONST_RETURN gchar *
 886 gst_plugin_get_description (GstPlugin * plugin)
 887 {
 888   g_return_val_if_fail (plugin != NULL, NULL);
 889
 890   return plugin->desc.description;
 891 }
 892
 893 /**
 894  * gst_plugin_get_filename:
 895  * @plugin: plugin to get the filename of
 896  *
 897  * get the filename of the plugin
 898  *
 899  * Returns: the filename of the plugin
 900  */
 901 G_CONST_RETURN gchar *
 902 gst_plugin_get_filename (GstPlugin * plugin)
 903 {
 904   g_return_val_if_fail (plugin != NULL, NULL);
 905
 906   return plugin->filename;
 907 }
 908
 909 /**
 910  * gst_plugin_get_version:
 911  * @plugin: plugin to get the version of
 912  *
 913  * get the version of the plugin
 914  *
 915  * Returns: the version of the plugin
 916  */
 917 G_CONST_RETURN gchar *
 918 gst_plugin_get_version (GstPlugin * plugin)
 919 {
 920   g_return_val_if_fail (plugin != NULL, NULL);
 921
 922   return plugin->desc.version;
 923 }
 924
 925 /**
 926  * gst_plugin_get_license:
 927  * @plugin: plugin to get the license of
 928  *
 929  * get the license of the plugin
 930  *
 931  * Returns: the license of the plugin
 932  */
 933 G_CONST_RETURN gchar *
 934 gst_plugin_get_license (GstPlugin * plugin)
 935 {
 936   g_return_val_if_fail (plugin != NULL, NULL);
 937
 938   return plugin->desc.license;
 939 }
 940
 941 /**
 942  * gst_plugin_get_source:
 943  * @plugin: plugin to get the source of
 944  *
 945  * get the source module the plugin belongs to.
 946  *
 947  * Returns: the source of the plugin
 948  */
 949 G_CONST_RETURN gchar *
 950 gst_plugin_get_source (GstPlugin * plugin)
 951 {
 952   g_return_val_if_fail (plugin != NULL, NULL);
 953
 954   return plugin->desc.source;
 955 }
 956
 957 /**
 958  * gst_plugin_get_package:
 959  * @plugin: plugin to get the package of
 960  *
 961  * get the package the plugin belongs to.
 962  *
 963  * Returns: the package of the plugin
 964  */
 965 G_CONST_RETURN gchar *
 966 gst_plugin_get_package (GstPlugin * plugin)
 967 {
 968   g_return_val_if_fail (plugin != NULL, NULL);
 969
 970   return plugin->desc.package;
 971 }
 972
 973 /**
 974  * gst_plugin_get_origin:
 975  * @plugin: plugin to get the origin of
 976  *
 977  * get the URL where the plugin comes from
 978  *
 979  * Returns: the origin of the plugin
 980  */
 981 G_CONST_RETURN gchar *
 982 gst_plugin_get_origin (GstPlugin * plugin)
 983 {
 984   g_return_val_if_fail (plugin != NULL, NULL);
 985
 986   return plugin->desc.origin;
 987 }
 988
 989 /**
 990  * gst_plugin_get_module:
 991  * @plugin: plugin to query
 992  *
 993  * Gets the #GModule of the plugin. If the plugin isn't loaded yet, NULL is
 994  * returned.
 995  *
 996  * Returns: module belonging to the plugin or NULL if the plugin isn't
 997  *          loaded yet.
 998  */
 999 GModule *
1000 gst_plugin_get_module (GstPlugin * plugin)
1001 {
1002   g_return_val_if_fail (plugin != NULL, NULL);
1003
1004   return plugin->module;
1005 }
1006
1007 /**
1008  * gst_plugin_is_loaded:
1009  * @plugin: plugin to query
1010  *
1011  * queries if the plugin is loaded into memory
1012  *
1013  * Returns: TRUE is loaded, FALSE otherwise
1014  */
1015 gboolean
1016 gst_plugin_is_loaded (GstPlugin * plugin)
1017 {
1018   g_return_val_if_fail (plugin != NULL, FALSE);
1019
1020   return (plugin->module != NULL || plugin->filename == NULL);
1021 }
1022
1023 /**
1024  * gst_plugin_get_cache_data:
1025  * @plugin: a plugin
1026  *
1027  * Gets the plugin specific data cache. If it is %NULL there is no cached data
1028  * stored. This is the case when the registry is getting rebuilt.
1029  *
1030  * Returns: The cached data as a #GstStructure or %NULL.
1031  *
1032  * Since: 0.10.24
1033  */
1034 G_CONST_RETURN GstStructure *
1035 gst_plugin_get_cache_data (GstPlugin * plugin)
1036 {
1037   g_return_val_if_fail (GST_IS_PLUGIN (plugin), NULL);
1038
1039   return plugin->priv->cache_data;
1040 }
1041
1042 /**
1043  * gst_plugin_set_cache_data:
1044  * @plugin: a plugin
1045  * @cache_data: a structure containing the data to cache
1046  *
1047  * Adds plugin specific data to cache. Passes the ownership of the structure to
1048  * the @plugin.
1049  *
1050  * The cache is flushed every time the registry is rebuilt.
1051  *
1052  * Since: 0.10.24
1053  */
1054 void
1055 gst_plugin_set_cache_data (GstPlugin * plugin, GstStructure * cache_data)
1056 {
1057   g_return_if_fail (GST_IS_PLUGIN (plugin));
1058   g_return_if_fail (GST_IS_STRUCTURE (cache_data));
1059
1060   if (plugin->priv->cache_data) {
1061     gst_structure_free (plugin->priv->cache_data);
1062   }
1063   plugin->priv->cache_data = cache_data;
1064 }
1065
1066 #if 0
1067 /**
1068  * gst_plugin_feature_list:
1069  * @plugin: plugin to query
1070  * @filter: the filter to use
1071  * @first: only return first match
1072  * @user_data: user data passed to the filter function
1073  *
1074  * Runs a filter against all plugin features and returns a GList with
1075  * the results. If the first flag is set, only the first match is
1076  * returned (as a list with a single object).
1077  *
1078  * Returns: a GList of features, g_list_free after use.
1079  */
1080 GList *
1081 gst_plugin_feature_filter (GstPlugin * plugin,
1082     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
1083 {
1084   GList *list;
1085   GList *g;
1086
1087   list = gst_filter_run (plugin->features, (GstFilterFunc) filter, first,
1088       user_data);
1089   for (g = list; g; g = g->next) {
1090     gst_object_ref (plugin);
1091   }
1092
1093   return list;
1094 }
1095
1096 typedef struct
1097 {
1098   GstPluginFeatureFilter filter;
1099   gboolean first;
1100   gpointer user_data;
1101   GList *result;
1102 }
1103 FeatureFilterData;
1104
1105 static gboolean
1106 _feature_filter (GstPlugin * plugin, gpointer user_data)
1107 {
1108   GList *result;
1109   FeatureFilterData *data = (FeatureFilterData *) user_data;
1110
1111   result = gst_plugin_feature_filter (plugin, data->filter, data->first,
1112       data->user_data);
1113   if (result) {
1114     data->result = g_list_concat (data->result, result);
1115     return TRUE;
1116   }
1117   return FALSE;
1118 }
1119
1120 /**
1121  * gst_plugin_list_feature_filter:
1122  * @list: a #GList of plugins to query
1123  * @filter: the filter function to use
1124  * @first: only return first match
1125  * @user_data: user data passed to the filter function
1126  *
1127  * Runs a filter against all plugin features of the plugins in the given
1128  * list and returns a GList with the results.
1129  * If the first flag is set, only the first match is
1130  * returned (as a list with a single object).
1131  *
1132  * Returns: a GList of features, g_list_free after use.
1133  */
1134 GList *
1135 gst_plugin_list_feature_filter (GList * list,
1136     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
1137 {
1138   FeatureFilterData data;
1139   GList *result;
1140
1141   data.filter = filter;
1142   data.first = first;
1143   data.user_data = user_data;
1144   data.result = NULL;
1145
1146   result = gst_filter_run (list, (GstFilterFunc) _feature_filter, first, &data);
1147   g_list_free (result);
1148
1149   return data.result;
1150 }
1151 #endif
1152
1153 /**
1154  * gst_plugin_name_filter:
1155  * @plugin: the plugin to check
1156  * @name: the name of the plugin
1157  *
1158  * A standard filter that returns TRUE when the plugin is of the
1159  * given name.
1160  *
1161  * Returns: TRUE if the plugin is of the given name.
1162  */
1163 gboolean
1164 gst_plugin_name_filter (GstPlugin * plugin, const gchar * name)
1165 {
1166   return (plugin->desc.name && !strcmp (plugin->desc.name, name));
1167 }
1168
1169 #if 0
1170 /**
1171  * gst_plugin_find_feature:
1172  * @plugin: plugin to get the feature from
1173  * @name: The name of the feature to find
1174  * @type: The type of the feature to find
1175  *
1176  * Find a feature of the given name and type in the given plugin.
1177  *
1178  * Returns: a GstPluginFeature or NULL if the feature was not found.
1179  */
1180 GstPluginFeature *
1181 gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type)
1182 {
1183   GList *walk;
1184   GstPluginFeature *result = NULL;
1185   GstTypeNameData data;
1186
1187   g_return_val_if_fail (name != NULL, NULL);
1188
1189   data.type = type;
1190   data.name = name;
1191
1192   walk = gst_filter_run (plugin->features,
1193       (GstFilterFunc) gst_plugin_feature_type_name_filter, TRUE, &data);
1194
1195   if (walk) {
1196     result = GST_PLUGIN_FEATURE (walk->data);
1197
1198     gst_object_ref (result);
1199     gst_plugin_feature_list_free (walk);
1200   }
1201
1202   return result;
1203 }
1204 #endif
1205
1206 #if 0
1207 static gboolean
1208 gst_plugin_feature_name_filter (GstPluginFeature * feature, const gchar * name)
1209 {
1210   return !strcmp (name, GST_PLUGIN_FEATURE_NAME (feature));
1211 }
1212 #endif
1213
1214 #if 0
1215 /**
1216  * gst_plugin_find_feature_by_name:
1217  * @plugin: plugin to get the feature from
1218  * @name: The name of the feature to find
1219  *
1220  * Find a feature of the given name in the given plugin.
1221  *
1222  * Returns: a GstPluginFeature or NULL if the feature was not found.
1223  */
1224 GstPluginFeature *
1225 gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name)
1226 {
1227   GList *walk;
1228   GstPluginFeature *result = NULL;
1229
1230   g_return_val_if_fail (name != NULL, NULL);
1231
1232   walk = gst_filter_run (plugin->features,
1233       (GstFilterFunc) gst_plugin_feature_name_filter, TRUE, (void *) name);
1234
1235   if (walk) {
1236     result = GST_PLUGIN_FEATURE (walk->data);
1237
1238     gst_object_ref (result);
1239     gst_plugin_feature_list_free (walk);
1240   }
1241
1242   return result;
1243 }
1244 #endif
1245
1246 /**
1247  * gst_plugin_load_by_name:
1248  * @name: name of plugin to load
1249  *
1250  * Load the named plugin. Refs the plugin.
1251  *
1252  * Returns: A reference to a loaded plugin, or NULL on error.
1253  */
1254 GstPlugin *
1255 gst_plugin_load_by_name (const gchar * name)
1256 {
1257   GstPlugin *plugin, *newplugin;
1258   GError *error = NULL;
1259
1260   GST_DEBUG ("looking up plugin %s in default registry", name);
1261   plugin = gst_registry_find_plugin (gst_registry_get_default (), name);
1262   if (plugin) {
1263     GST_DEBUG ("loading plugin %s from file %s", name, plugin->filename);
1264     newplugin = gst_plugin_load_file (plugin->filename, &error);
1265     gst_object_unref (plugin);
1266
1267     if (!newplugin) {
1268       GST_WARNING ("load_plugin error: %s", error->message);
1269       g_error_free (error);
1270       return NULL;
1271     }
1272     /* newplugin was reffed by load_file */
1273     return newplugin;
1274   }
1275
1276   GST_DEBUG ("Could not find plugin %s in registry", name);
1277   return NULL;
1278 }
1279
1280 /**
1281  * gst_plugin_load:
1282  * @plugin: plugin to load
1283  *
1284  * Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is
1285  * untouched. The normal use pattern of this function goes like this:
1286  *
1287  * <programlisting>
1288  * GstPlugin *loaded_plugin;
1289  * loaded_plugin = gst_plugin_load (plugin);
1290  * // presumably, we're no longer interested in the potentially-unloaded plugin
1291  * gst_object_unref (plugin);
1292  * plugin = loaded_plugin;
1293  * </programlisting>
1294  *
1295  * Returns: A reference to a loaded plugin, or NULL on error.
1296  */
1297 GstPlugin *
1298 gst_plugin_load (GstPlugin * plugin)
1299 {
1300   GError *error = NULL;
1301   GstPlugin *newplugin;
1302
1303   if (gst_plugin_is_loaded (plugin)) {
1304     return plugin;
1305   }
1306
1307   if (!(newplugin = gst_plugin_load_file (plugin->filename, &error)))
1308     goto load_error;
1309
1310   return newplugin;
1311
1312 load_error:
1313   {
1314     GST_WARNING ("load_plugin error: %s", error->message);
1315     g_error_free (error);
1316     return NULL;
1317   }
1318 }
1319
1320 /**
1321  * gst_plugin_list_free:
1322  * @list: list of #GstPlugin
1323  *
1324  * Unrefs each member of @list, then frees the list.
1325  */
1326 void
1327 gst_plugin_list_free (GList * list)
1328 {
1329   GList *g;
1330
1331   for (g = list; g; g = g->next) {
1332     gst_object_unref (GST_PLUGIN_CAST (g->data));
1333   }
1334   g_list_free (list);
1335 }
1336
1337 /* ===== plugin dependencies ===== */
1338
1339 /* Scenarios:
1340  * ENV + xyz     where ENV can contain multiple values separated by SEPARATOR
1341  *               xyz may be "" (if ENV contains path to file rather than dir)
1342  * ENV + *xyz   same as above, but xyz acts as suffix filter
1343  * ENV + xyz*   same as above, but xyz acts as prefix filter (is this needed?)
1344  * ENV + *xyz*  same as above, but xyz acts as strstr filter (is this needed?)
1345  *
1346  * same as above, with additional paths hard-coded at compile-time:
1347  *   - only check paths + ... if ENV is not set or yields not paths
1348  *   - always check paths + ... in addition to ENV
1349  *
1350  * When user specifies set of environment variables, he/she may also use e.g.
1351  * "HOME/.mystuff/plugins", and we'll expand the content of $HOME with the
1352  * remainder
1353  */
1354
1355 /* we store in registry:
1356  *  sets of:
1357  *   {
1358  *     - environment variables (array of strings)
1359  *     - last hash of env variable contents (uint) (so we can avoid doing stats
1360  *       if one of the env vars has changed; premature optimisation galore)
1361  *     - hard-coded paths (array of strings)
1362  *     - xyz filename/suffix/prefix strings (array of strings)
1363  *     - flags (int)
1364  *     - last hash of file/dir stats (int)
1365  *   }
1366  *   (= struct GstPluginDep)
1367  */
1368
1369 static guint
1370 gst_plugin_ext_dep_get_env_vars_hash (GstPlugin * plugin, GstPluginDep * dep)
1371 {
1372   gchar **e;
1373   guint hash;
1374
1375   /* there's no deeper logic to what we do here; all we want to know (when
1376    * checking if the plugin needs to be rescanned) is whether the content of
1377    * one of the environment variables in the list is different from when it
1378    * was last scanned */
1379   hash = 0;
1380   for (e = dep->env_vars; e != NULL && *e != NULL; ++e) {
1381     const gchar *val;
1382     gchar env_var[256];
1383
1384     /* order matters: "val",NULL needs to yield a different hash than
1385      * NULL,"val", so do a shift here whether the var is set or not */
1386     hash = hash << 5;
1387
1388     /* want environment variable at beginning of string */
1389     if (!g_ascii_isalnum (**e)) {
1390       GST_WARNING_OBJECT (plugin, "string prefix is not a valid environment "
1391           "variable string: %s", *e);
1392       continue;
1393     }
1394
1395     /* user is allowed to specify e.g. "HOME/.pitivi/plugins" */
1396     g_strlcpy (env_var, *e, sizeof (env_var));
1397     g_strdelimit (env_var, "/\\", '\0');
1398
1399     if ((val = g_getenv (env_var)))
1400       hash += g_str_hash (val);
1401   }
1402
1403   return hash;
1404 }
1405
1406 gboolean
1407 _priv_plugin_deps_env_vars_changed (GstPlugin * plugin)
1408 {
1409   GList *l;
1410
1411   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1412     GstPluginDep *dep = l->data;
1413
1414     if (dep->env_hash != gst_plugin_ext_dep_get_env_vars_hash (plugin, dep))
1415       return TRUE;
1416   }
1417
1418   return FALSE;
1419 }
1420
1421 static GList *
1422 gst_plugin_ext_dep_extract_env_vars_paths (GstPlugin * plugin,
1423     GstPluginDep * dep)
1424 {
1425   gchar **evars;
1426   GList *paths = NULL;
1427
1428   for (evars = dep->env_vars; evars != NULL && *evars != NULL; ++evars) {
1429     const gchar *e;
1430     gchar **components;
1431
1432     /* want environment variable at beginning of string */
1433     if (!g_ascii_isalnum (**evars)) {
1434       GST_WARNING_OBJECT (plugin, "string prefix is not a valid environment "
1435           "variable string: %s", *evars);
1436       continue;
1437     }
1438
1439     /* user is allowed to specify e.g. "HOME/.pitivi/plugins", which we want to
1440      * split into the env_var name component and the path component */
1441     components = g_strsplit_set (*evars, "/\\", 2);
1442     g_assert (components != NULL);
1443
1444     e = g_getenv (components[0]);
1445     GST_LOG_OBJECT (plugin, "expanding %s = '%s' (path suffix: %s)",
1446         components[0], GST_STR_NULL (e), GST_STR_NULL (components[1]));
1447
1448     if (components[1] != NULL) {
1449       g_strdelimit (components[1], "/\\", G_DIR_SEPARATOR);
1450     }
1451
1452     if (e != NULL && *e != '\0') {
1453       gchar **arr;
1454       guint i;
1455
1456       arr = g_strsplit (e, G_SEARCHPATH_SEPARATOR_S, -1);
1457
1458       for (i = 0; arr != NULL && arr[i] != NULL; ++i) {
1459         gchar *full_path;
1460
1461         if (!g_path_is_absolute (arr[i])) {
1462           GST_INFO_OBJECT (plugin, "ignoring environment variable content '%s'"
1463               ": either not an absolute path or not a path at all", arr[i]);
1464           continue;
1465         }
1466
1467         if (components[1] != NULL) {
1468           full_path = g_build_filename (arr[i], components[1], NULL);
1469         } else {
1470           full_path = g_strdup (arr[i]);
1471         }
1472
1473         if (!g_list_find_custom (paths, full_path, (GCompareFunc) strcmp)) {
1474           GST_LOG_OBJECT (plugin, "path: '%s'", full_path);
1475           paths = g_list_prepend (paths, full_path);
1476           full_path = NULL;
1477         } else {
1478           GST_LOG_OBJECT (plugin, "path: '%s' (duplicate,ignoring)", full_path);
1479           g_free (full_path);
1480         }
1481       }
1482
1483       g_strfreev (arr);
1484     }
1485
1486     g_strfreev (components);
1487   }
1488
1489   GST_LOG_OBJECT (plugin, "Extracted %d paths from environment",
1490       g_list_length (paths));
1491
1492   return paths;
1493 }
1494
1495 static guint
1496 gst_plugin_ext_dep_get_hash_from_stat_entry (GStatBuf * s)
1497 {
1498   if (!(s->st_mode & (S_IFDIR | S_IFREG)))
1499     return (guint) - 1;
1500
1501   /* completely random formula */
1502   return ((s->st_size << 3) + (s->st_mtime << 5)) ^ s->st_ctime;
1503 }
1504
1505 static gboolean
1506 gst_plugin_ext_dep_direntry_matches (GstPlugin * plugin, const gchar * entry,
1507     const gchar ** filenames, GstPluginDependencyFlags flags)
1508 {
1509   /* no filenames specified, match all entries for now (could probably
1510    * optimise by just taking the dir stat hash or so) */
1511   if (filenames == NULL || *filenames == NULL || **filenames == '\0')
1512     return TRUE;
1513
1514   while (*filenames != NULL) {
1515     /* suffix match? */
1516     if (((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX)) &&
1517         g_str_has_suffix (entry, *filenames)) {
1518       return TRUE;
1519       /* else it's an exact match that's needed */
1520     } else if (strcmp (entry, *filenames) == 0) {
1521       return TRUE;
1522     }
1523     GST_LOG ("%s does not match %s, flags=0x%04x", entry, *filenames, flags);
1524     ++filenames;
1525   }
1526   return FALSE;
1527 }
1528
1529 static guint
1530 gst_plugin_ext_dep_scan_dir_and_match_names (GstPlugin * plugin,
1531     const gchar * path, const gchar ** filenames,
1532     GstPluginDependencyFlags flags, int depth)
1533 {
1534   const gchar *entry;
1535   gboolean recurse_dirs;
1536   GError *err = NULL;
1537   GDir *dir;
1538   guint hash = 0;
1539
1540   recurse_dirs = !!(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
1541
1542   dir = g_dir_open (path, 0, &err);
1543   if (dir == NULL) {
1544     GST_DEBUG_OBJECT (plugin, "g_dir_open(%s) failed: %s", path, err->message);
1545     g_error_free (err);
1546     return (guint) - 1;
1547   }
1548
1549   /* FIXME: we're assuming here that we always get the directory entries in
1550    * the same order, and not in a random order */
1551   while ((entry = g_dir_read_name (dir))) {
1552     gboolean have_match;
1553     GStatBuf s;
1554     gchar *full_path;
1555     guint fhash;
1556
1557     have_match =
1558         gst_plugin_ext_dep_direntry_matches (plugin, entry, filenames, flags);
1559
1560     /* avoid the stat if possible */
1561     if (!have_match && !recurse_dirs)
1562       continue;
1563
1564     full_path = g_build_filename (path, entry, NULL);
1565     if (g_stat (full_path, &s) < 0) {
1566       fhash = (guint) - 1;
1567       GST_LOG_OBJECT (plugin, "stat: %s (error: %s)", full_path,
1568           g_strerror (errno));
1569     } else if (have_match) {
1570       fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
1571       GST_LOG_OBJECT (plugin, "stat: %s (result: %u)", full_path, fhash);
1572     } else if ((s.st_mode & (S_IFDIR))) {
1573       fhash = gst_plugin_ext_dep_scan_dir_and_match_names (plugin, full_path,
1574           filenames, flags, depth + 1);
1575     } else {
1576       /* it's not a name match, we want to recurse, but it's not a directory */
1577       g_free (full_path);
1578       continue;
1579     }
1580
1581     hash = (hash + fhash) << 1;
1582     g_free (full_path);
1583   }
1584
1585   g_dir_close (dir);
1586   return hash;
1587 }
1588
1589 static guint
1590 gst_plugin_ext_dep_scan_path_with_filenames (GstPlugin * plugin,
1591     const gchar * path, const gchar ** filenames,
1592     GstPluginDependencyFlags flags)
1593 {
1594   const gchar *empty_filenames[] = { "", NULL };
1595   gboolean recurse_into_dirs, partial_names;
1596   guint i, hash = 0;
1597
1598   /* to avoid special-casing below (FIXME?) */
1599   if (filenames == NULL || *filenames == NULL)
1600     filenames = empty_filenames;
1601
1602   recurse_into_dirs = !!(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
1603   partial_names = !!(flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX);
1604
1605   /* if we can construct the exact paths to check with the data we have, just
1606    * stat them one by one; this is more efficient than opening the directory
1607    * and going through each entry to see if it matches one of our filenames. */
1608   if (!recurse_into_dirs && !partial_names) {
1609     for (i = 0; filenames[i] != NULL; ++i) {
1610       GStatBuf s;
1611       gchar *full_path;
1612       guint fhash;
1613
1614       full_path = g_build_filename (path, filenames[i], NULL);
1615       if (g_stat (full_path, &s) < 0) {
1616         fhash = (guint) - 1;
1617         GST_LOG_OBJECT (plugin, "stat: %s (error: %s)", full_path,
1618             g_strerror (errno));
1619       } else {
1620         fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
1621         GST_LOG_OBJECT (plugin, "stat: %s (result: %08x)", full_path, fhash);
1622       }
1623       hash = (hash + fhash) << 1;
1624       g_free (full_path);
1625     }
1626   } else {
1627     hash = gst_plugin_ext_dep_scan_dir_and_match_names (plugin, path,
1628         filenames, flags, 0);
1629   }
1630
1631   return hash;
1632 }
1633
1634 static guint
1635 gst_plugin_ext_dep_get_stat_hash (GstPlugin * plugin, GstPluginDep * dep)
1636 {
1637   gboolean paths_are_default_only;
1638   GList *scan_paths;
1639   guint scan_hash = 0;
1640
1641   GST_LOG_OBJECT (plugin, "start");
1642
1643   paths_are_default_only =
1644       dep->flags & GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY;
1645
1646   scan_paths = gst_plugin_ext_dep_extract_env_vars_paths (plugin, dep);
1647
1648   if (scan_paths == NULL || !paths_are_default_only) {
1649     gchar **paths;
1650
1651     for (paths = dep->paths; paths != NULL && *paths != NULL; ++paths) {
1652       const gchar *path = *paths;
1653
1654       if (!g_list_find_custom (scan_paths, path, (GCompareFunc) strcmp)) {
1655         GST_LOG_OBJECT (plugin, "path: '%s'", path);
1656         scan_paths = g_list_prepend (scan_paths, g_strdup (path));
1657       } else {
1658         GST_LOG_OBJECT (plugin, "path: '%s' (duplicate, ignoring)", path);
1659       }
1660     }
1661   }
1662
1663   /* not that the order really matters, but it makes debugging easier */
1664   scan_paths = g_list_reverse (scan_paths);
1665
1666   while (scan_paths != NULL) {
1667     const gchar *path = scan_paths->data;
1668
1669     scan_hash += gst_plugin_ext_dep_scan_path_with_filenames (plugin, path,
1670         (const gchar **) dep->names, dep->flags);
1671     scan_hash = scan_hash << 1;
1672
1673     g_free (scan_paths->data);
1674     scan_paths = g_list_delete_link (scan_paths, scan_paths);
1675   }
1676
1677   GST_LOG_OBJECT (plugin, "done, scan_hash: %08x", scan_hash);
1678   return scan_hash;
1679 }
1680
1681 gboolean
1682 _priv_plugin_deps_files_changed (GstPlugin * plugin)
1683 {
1684   GList *l;
1685
1686   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1687     GstPluginDep *dep = l->data;
1688
1689     if (dep->stat_hash != gst_plugin_ext_dep_get_stat_hash (plugin, dep))
1690       return TRUE;
1691   }
1692
1693   return FALSE;
1694 }
1695
1696 static void
1697 gst_plugin_ext_dep_free (GstPluginDep * dep)
1698 {
1699   g_strfreev (dep->env_vars);
1700   g_strfreev (dep->paths);
1701   g_strfreev (dep->names);
1702   g_slice_free (GstPluginDep, dep);
1703 }
1704
1705 static gboolean
1706 gst_plugin_ext_dep_strv_equal (gchar ** arr1, gchar ** arr2)
1707 {
1708   if (arr1 == arr2)
1709     return TRUE;
1710   if (arr1 == NULL || arr2 == NULL)
1711     return FALSE;
1712   for (; *arr1 != NULL && *arr2 != NULL; ++arr1, ++arr2) {
1713     if (strcmp (*arr1, *arr2) != 0)
1714       return FALSE;
1715   }
1716   return (*arr1 == *arr2);
1717 }
1718
1719 static gboolean
1720 gst_plugin_ext_dep_equals (GstPluginDep * dep, const gchar ** env_vars,
1721     const gchar ** paths, const gchar ** names, GstPluginDependencyFlags flags)
1722 {
1723   if (dep->flags != flags)
1724     return FALSE;
1725
1726   return gst_plugin_ext_dep_strv_equal (dep->env_vars, (gchar **) env_vars) &&
1727       gst_plugin_ext_dep_strv_equal (dep->paths, (gchar **) paths) &&
1728       gst_plugin_ext_dep_strv_equal (dep->names, (gchar **) names);
1729 }
1730
1731 /**
1732  * gst_plugin_add_dependency:
1733  * @plugin: a #GstPlugin
1734  * @env_vars: NULL-terminated array of environent variables affecting the
1735  *     feature set of the plugin (e.g. an environment variable containing
1736  *     paths where to look for additional modules/plugins of a library),
1737  *     or NULL. Environment variable names may be followed by a path component
1738  *      which will be added to the content of the environment variable, e.g.
1739  *      "HOME/.mystuff/plugins".
1740  * @paths: NULL-terminated array of directories/paths where dependent files
1741  *     may be.
1742  * @names: NULL-terminated array of file names (or file name suffixes,
1743  *     depending on @flags) to be used in combination with the paths from
1744  *     @paths and/or the paths extracted from the environment variables in
1745  *     @env_vars, or NULL.
1746  * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
1747  *
1748  * Make GStreamer aware of external dependencies which affect the feature
1749  * set of this plugin (ie. the elements or typefinders associated with it).
1750  *
1751  * GStreamer will re-inspect plugins with external dependencies whenever any
1752  * of the external dependencies change. This is useful for plugins which wrap
1753  * other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
1754  * library and makes visualisations available as GStreamer elements, or a
1755  * codec loader which exposes elements and/or caps dependent on what external
1756  * codec libraries are currently installed.
1757  *
1758  * Since: 0.10.22
1759  */
1760 void
1761 gst_plugin_add_dependency (GstPlugin * plugin, const gchar ** env_vars,
1762     const gchar ** paths, const gchar ** names, GstPluginDependencyFlags flags)
1763 {
1764   GstPluginDep *dep;
1765   GList *l;
1766
1767   g_return_if_fail (GST_IS_PLUGIN (plugin));
1768
1769   if ((env_vars == NULL || env_vars[0] == NULL) &&
1770       (paths == NULL || paths[0] == NULL)) {
1771     GST_DEBUG_OBJECT (plugin,
1772         "plugin registered empty dependency set. Ignoring");
1773     return;
1774   }
1775
1776   for (l = plugin->priv->deps; l != NULL; l = l->next) {
1777     if (gst_plugin_ext_dep_equals (l->data, env_vars, paths, names, flags)) {
1778       GST_LOG_OBJECT (plugin, "dependency already registered");
1779       return;
1780     }
1781   }
1782
1783   dep = g_slice_new (GstPluginDep);
1784
1785   dep->env_vars = g_strdupv ((gchar **) env_vars);
1786   dep->paths = g_strdupv ((gchar **) paths);
1787   dep->names = g_strdupv ((gchar **) names);
1788   dep->flags = flags;
1789
1790   dep->env_hash = gst_plugin_ext_dep_get_env_vars_hash (plugin, dep);
1791   dep->stat_hash = gst_plugin_ext_dep_get_stat_hash (plugin, dep);
1792
1793   plugin->priv->deps = g_list_append (plugin->priv->deps, dep);
1794
1795   GST_DEBUG_OBJECT (plugin, "added dependency:");
1796   for (; env_vars != NULL && *env_vars != NULL; ++env_vars)
1797     GST_DEBUG_OBJECT (plugin, " evar: %s", *env_vars);
1798   for (; paths != NULL && *paths != NULL; ++paths)
1799     GST_DEBUG_OBJECT (plugin, " path: %s", *paths);
1800   for (; names != NULL && *names != NULL; ++names)
1801     GST_DEBUG_OBJECT (plugin, " name: %s", *names);
1802 }
1803
1804 /**
1805  * gst_plugin_add_dependency_simple:
1806  * @plugin: the #GstPlugin
1807  * @env_vars: one or more environent variables (separated by ':', ';' or ','),
1808  *      or NULL. Environment variable names may be followed by a path component
1809  *      which will be added to the content of the environment variable, e.g.
1810  *      "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"
1811  * @paths: one ore more directory paths (separated by ':' or ';' or ','),
1812  *      or NULL. Example: "/usr/lib/mystuff/plugins"
1813  * @names: one or more file names or file name suffixes (separated by commas),
1814  *   or NULL
1815  * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
1816  *
1817  * Make GStreamer aware of external dependencies which affect the feature
1818  * set of this plugin (ie. the elements or typefinders associated with it).
1819  *
1820  * GStreamer will re-inspect plugins with external dependencies whenever any
1821  * of the external dependencies change. This is useful for plugins which wrap
1822  * other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
1823  * library and makes visualisations available as GStreamer elements, or a
1824  * codec loader which exposes elements and/or caps dependent on what external
1825  * codec libraries are currently installed.
1826  *
1827  * Convenience wrapper function for gst_plugin_add_dependency() which
1828  * takes simple strings as arguments instead of string arrays, with multiple
1829  * arguments separated by predefined delimiters (see above).
1830  *
1831  * Since: 0.10.22
1832  */
1833 void
1834 gst_plugin_add_dependency_simple (GstPlugin * plugin,
1835     const gchar * env_vars, const gchar * paths, const gchar * names,
1836     GstPluginDependencyFlags flags)
1837 {
1838   gchar **a_evars = NULL;
1839   gchar **a_paths = NULL;
1840   gchar **a_names = NULL;
1841
1842   if (env_vars)
1843     a_evars = g_strsplit_set (env_vars, ":;,", -1);
1844   if (paths)
1845     a_paths = g_strsplit_set (paths, ":;,", -1);
1846   if (names)
1847     a_names = g_strsplit_set (names, ",", -1);
1848
1849   gst_plugin_add_dependency (plugin, (const gchar **) a_evars,
1850       (const gchar **) a_paths, (const gchar **) a_names, flags);
1851
1852   if (a_evars)
1853     g_strfreev (a_evars);
1854   if (a_paths)
1855     g_strfreev (a_paths);
1856   if (a_names)
1857     g_strfreev (a_names);
1858 }