git.sesse.net Git - vlc/blob - src/modules/modules.c

   1 /*****************************************************************************
   2  * modules.c : Builtin and plugin modules management functions
   3  *****************************************************************************
   4  * Copyright (C) 2001-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   8  *          Ethan C. Baldridge <BaldridgeE@cadmus.com>
   9  *          Hans-Peter Jansen <hpj@urpla.net>
  10  *          Gildas Bazin <gbazin@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include "libvlc.h"
  34
  35 #include <stdlib.h>                                      /* free(), strtol() */
  36 #include <stdio.h>                                              /* sprintf() */
  37 #include <string.h>                                              /* strdup() */
  38 #include <assert.h>
  39
  40 #ifdef HAVE_DIRENT_H
  41 #   include <dirent.h>
  42 #endif
  43
  44 #ifdef HAVE_SYS_TYPES_H
  45 #   include <sys/types.h>
  46 #endif
  47 #ifdef HAVE_SYS_STAT_H
  48 #   include <sys/stat.h>
  49 #endif
  50 #ifdef HAVE_UNISTD_H
  51 #   include <unistd.h>
  52 #endif
  53
  54 #if !defined(HAVE_DYNAMIC_PLUGINS)
  55     /* no support for plugins */
  56 #elif defined(HAVE_DL_DYLD)
  57 #   if defined(HAVE_MACH_O_DYLD_H)
  58 #       include <mach-o/dyld.h>
  59 #   endif
  60 #elif defined(HAVE_DL_BEOS)
  61 #   if defined(HAVE_IMAGE_H)
  62 #       include <image.h>
  63 #   endif
  64 #elif defined(HAVE_DL_WINDOWS)
  65 #   include <windows.h>
  66 #elif defined(HAVE_DL_DLOPEN)
  67 #   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
  68 #       include <dlfcn.h>
  69 #   endif
  70 #   if defined(HAVE_SYS_DL_H)
  71 #       include <sys/dl.h>
  72 #   endif
  73 #elif defined(HAVE_DL_SHL_LOAD)
  74 #   if defined(HAVE_DL_H)
  75 #       include <dl.h>
  76 #   endif
  77 #endif
  78
  79 #include "config/configuration.h"
  80
  81 #include "vlc_charset.h"
  82 #include "vlc_arrays.h"
  83
  84 #include "modules/modules.h"
  85
  86 static module_bank_t *p_module_bank = NULL;
  87 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
  88
  89 int vlc_entry__main( module_t * );
  90
  91 /*****************************************************************************
  92  * Local prototypes
  93  *****************************************************************************/
  94 #ifdef HAVE_DYNAMIC_PLUGINS
  95 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
  96 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
  97                                unsigned );
  98 static int  AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
  99                                 int64_t, int64_t );
 100 static module_t * AllocatePlugin( vlc_object_t *, const char * );
 101 #endif
 102 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
 103 static void DeleteModule ( module_bank_t *, module_t * );
 104 #ifdef HAVE_DYNAMIC_PLUGINS
 105 static void   DupModule        ( module_t * );
 106 static void   UndupModule      ( module_t * );
 107 #endif
 108
 109 /**
 110  * Init bank
 111  *
 112  * Creates a module bank structure which will be filled later
 113  * on with all the modules found.
 114  * \param p_this vlc object structure
 115  * \return nothing
 116  */
 117 void __module_InitBank( vlc_object_t *p_this )
 118 {
 119     module_bank_t *p_bank = NULL;
 120
 121     vlc_mutex_lock( &module_lock );
 122
 123     if( p_module_bank == NULL )
 124     {
 125         p_bank = calloc (1, sizeof(*p_bank));
 126         p_bank->i_usage = 1;
 127         p_bank->i_cache = p_bank->i_loaded_cache = 0;
 128         p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
 129         p_bank->b_cache = p_bank->b_cache_dirty = false;
 130         p_bank->head = NULL;
 131
 132         /* Everything worked, attach the object */
 133         p_module_bank = p_bank;
 134
 135         /* Fills the module bank structure with the main module infos.
 136          * This is very useful as it will allow us to consider the main
 137          * library just as another module, and for instance the configuration
 138          * options of main will be available in the module bank structure just
 139          * as for every other module. */
 140         AllocateBuiltinModule( p_this, vlc_entry__main );
 141     }
 142     else
 143         p_module_bank->i_usage++;
 144
 145     /* We do retain the module bank lock until the plugins are loaded as well.
 146      * This is ugly, this staged loading approach is needed: LibVLC gets
 147      * some configuration parameters relevant to loading the plugins from
 148      * the main (builtin) module. The module bank becomes shared read-only data
 149      * once it is ready, so we need to fully serialize initialization.
 150      * DO NOT UNCOMMENT the following line unless you managed to squeeze
 151      * module_LoadPlugins() before you unlock the mutex. */
 152     /*vlc_mutex_unlock( &module_lock );*/
 153 }
 154
 155 #undef module_EndBank
 156 /**
 157  * Unloads all unused plugin modules and empties the module
 158  * bank in case of success.
 159  * \param p_this vlc object structure
 160  * \return nothing
 161  */
 162 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
 163 {
 164     module_bank_t *p_bank = p_module_bank;
 165
 166     assert (p_bank != NULL);
 167
 168     /* Save the configuration */
 169     if( !config_GetInt( p_this, "ignore-config" ) )
 170         config_AutoSaveConfigFile( p_this );
 171
 172     /* If plugins were _not_ loaded, then the caller still has the bank lock
 173      * from module_InitBank(). */
 174     if( b_plugins )
 175         vlc_mutex_lock( &module_lock );
 176     /*else
 177         vlc_assert_locked( &module_lock ); not for static mutexes :( */
 178
 179     if( --p_bank->i_usage > 0 )
 180     {
 181         vlc_mutex_unlock( &module_lock );
 182         return;
 183     }
 184     p_module_bank = NULL;
 185     vlc_mutex_unlock( &module_lock );
 186
 187 #ifdef HAVE_DYNAMIC_PLUGINS
 188     if( p_bank->b_cache )
 189         CacheSave( p_this, p_bank );
 190     while( p_bank->i_loaded_cache-- )
 191     {
 192         if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
 193         {
 194             DeleteModule( p_bank,
 195                     p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
 196             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
 197             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
 198             p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
 199         }
 200     }
 201     if( p_bank->pp_loaded_cache )
 202     {
 203         free( p_bank->pp_loaded_cache );
 204         p_bank->pp_loaded_cache = NULL;
 205     }
 206     while( p_bank->i_cache-- )
 207     {
 208         free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
 209         free( p_bank->pp_cache[p_bank->i_cache] );
 210         p_bank->pp_cache[p_bank->i_cache] = NULL;
 211     }
 212     if( p_bank->pp_cache )
 213     {
 214         free( p_bank->pp_cache );
 215         p_bank->pp_cache = NULL;
 216     }
 217 #endif
 218
 219     while( p_bank->head != NULL )
 220         DeleteModule( p_bank, p_bank->head );
 221
 222     free( p_bank );
 223 }
 224
 225 #undef module_LoadPlugins
 226 /**
 227  * Loads module descriptions for all available plugins.
 228  * Fills the module bank structure with the plugin modules.
 229  *
 230  * \param p_this vlc object structure
 231  * \return nothing
 232  */
 233 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
 234 {
 235     module_bank_t *p_bank = p_module_bank;
 236
 237     assert( p_bank );
 238     /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
 239
 240 #ifdef HAVE_DYNAMIC_PLUGINS
 241     if( p_bank->i_usage == 1 )
 242     {
 243         msg_Dbg( p_this, "checking plugin modules" );
 244         p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
 245
 246         if( p_module_bank->b_cache || b_cache_delete )
 247             CacheLoad( p_this, p_module_bank, b_cache_delete );
 248         AllocateAllPlugins( p_this, p_module_bank );
 249     }
 250 #endif
 251     p_module_bank->b_plugins = true;
 252     vlc_mutex_unlock( &module_lock );
 253 }
 254
 255 /**
 256  * Checks whether a module implements a capability.
 257  *
 258  * \param m the module
 259  * \param cap the capability to check
 260  * \return TRUE if the module have the capability
 261  */
 262 bool module_provides( const module_t *m, const char *cap )
 263 {
 264     return !strcmp( m->psz_capability, cap );
 265 }
 266
 267 /**
 268  * Get the internal name of a module
 269  *
 270  * \param m the module
 271  * \return the module name
 272  */
 273 const char *module_get_object( const module_t *m )
 274 {
 275     return m->psz_object_name;
 276 }
 277
 278 /**
 279  * Get the human-friendly name of a module.
 280  *
 281  * \param m the module
 282  * \param long_name TRUE to have the long name of the module
 283  * \return the short or long name of the module
 284  */
 285 const char *module_get_name( const module_t *m, bool long_name )
 286 {
 287     if( long_name && ( m->psz_longname != NULL) )
 288         return m->psz_longname;
 289
 290     return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
 291 }
 292
 293 /**
 294  * Get the help for a module
 295  *
 296  * \param m the module
 297  * \return the help
 298  */
 299 const char *module_get_help( const module_t *m )
 300 {
 301     return m->psz_help;
 302 }
 303
 304 /**
 305  * Get the capability for a module
 306  *
 307  * \param m the module
 308  * return the capability
 309  */
 310 const char *module_get_capability( const module_t *m )
 311 {
 312     return m->psz_capability;
 313 }
 314
 315 /**
 316  * Get the score for a module
 317  *
 318  * \param m the module
 319  * return the score for the capability
 320  */
 321 int module_get_score( const module_t *m )
 322 {
 323     return m->i_score;
 324 }
 325
 326 module_t *module_hold (module_t *m)
 327 {
 328     vlc_hold (&m->vlc_gc_data);
 329     return m;
 330 }
 331
 332 void module_release (module_t *m)
 333 {
 334     vlc_release (&m->vlc_gc_data);
 335 }
 336
 337 /**
 338  * Frees the flat list of VLC modules.
 339  * @param list list obtained by module_list_get()
 340  * @param length number of items on the list
 341  * @return nothing.
 342  */
 343 void module_list_free (module_t **list)
 344 {
 345     if (list == NULL)
 346         return;
 347
 348     for (size_t i = 0; list[i] != NULL; i++)
 349          module_release (list[i]);
 350     free (list);
 351 }
 352
 353 /**
 354  * Gets the flat list of VLC modules.
 355  * @param n [OUT] pointer to the number of modules or NULL
 356  * @return NULL-terminated table of module pointers
 357  *         (release with module_list_free()), or NULL in case of error.
 358  */
 359 module_t **module_list_get (size_t *n)
 360 {
 361     /* TODO: this whole module lookup is quite inefficient */
 362     /* Remove this and improve module_need */
 363     module_t **tab = NULL;
 364     size_t i = 0;
 365
 366     assert (p_module_bank);
 367     for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
 368     {
 369          module_t **nt;
 370          nt  = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
 371          if (nt == NULL)
 372          {
 373              module_list_free (tab);
 374              return NULL;
 375          }
 376
 377          tab = nt;
 378          tab[i++] = module_hold (mod);
 379          for (module_t *subm = mod->submodule; subm; subm = subm->next)
 380              tab[i++] = module_hold (subm);
 381          tab[i] = NULL;
 382     }
 383     if (n != NULL)
 384         *n = i;
 385     return tab;
 386 }
 387
 388 typedef struct module_list_t
 389 {
 390     module_t *p_module;
 391     int16_t  i_score;
 392     bool     b_force;
 393 } module_list_t;
 394
 395 static int modulecmp (const void *a, const void *b)
 396 {
 397     const module_list_t *la = a, *lb = b;
 398     /* Note that qsort() uses _ascending_ order,
 399      * so the smallest module is the one with the biggest score. */
 400     return lb->i_score - la->i_score;
 401 }
 402
 403 /**
 404  * module Need
 405  *
 406  * Return the best module function, given a capability list.
 407  *
 408  * \param p_this the vlc object
 409  * \param psz_capability list of capabilities needed
 410  * \param psz_name name of the module asked
 411  * \param b_strict TRUE yto use the strict mode
 412  * \return the module or NULL in case of a failure
 413  */
 414 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
 415                           const char *psz_name, bool b_strict )
 416 {
 417     stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
 418
 419     module_list_t *p_list;
 420     module_t *p_module;
 421     int i_shortcuts = 0;
 422     char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
 423     bool b_force_backup = p_this->b_force;
 424
 425     /* Deal with variables */
 426     if( psz_name && psz_name[0] == '$' )
 427     {
 428         psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
 429     }
 430
 431     /* Count how many different shortcuts were asked for */
 432     if( psz_name && *psz_name )
 433     {
 434         char *psz_parser, *psz_last_shortcut;
 435
 436         /* If the user wants none, give him none. */
 437         if( !strcmp( psz_name, "none" ) )
 438         {
 439             free( psz_var );
 440             stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
 441             stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
 442             stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
 443             return NULL;
 444         }
 445
 446         i_shortcuts++;
 447         psz_shortcuts = psz_last_shortcut = strdup( psz_name );
 448
 449         for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
 450         {
 451             if( *psz_parser == ',' )
 452             {
 453                  *psz_parser = '\0';
 454                  i_shortcuts++;
 455                  psz_last_shortcut = psz_parser + 1;
 456             }
 457         }
 458
 459         /* Check if the user wants to override the "strict" mode */
 460         if( psz_last_shortcut )
 461         {
 462             if( !strcmp(psz_last_shortcut, "none") )
 463             {
 464                 b_strict = true;
 465                 i_shortcuts--;
 466             }
 467             else if( !strcmp(psz_last_shortcut, "any") )
 468             {
 469                 b_strict = false;
 470                 i_shortcuts--;
 471             }
 472         }
 473     }
 474
 475     /* Sort the modules and test them */
 476     size_t count;
 477     module_t **p_all = module_list_get (&count);
 478     p_list = malloc( count * sizeof( module_list_t ) );
 479     unsigned i_cpu = vlc_CPU();
 480
 481     /* Parse the module list for capabilities and probe each of them */
 482     count = 0;
 483     for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
 484     {
 485         bool b_shortcut_bonus = false;
 486
 487         /* Test that this module can do what we need */
 488         if( !module_provides( p_module, psz_capability ) )
 489             continue;
 490         /* Test if we have the required CPU */
 491         if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
 492             continue;
 493
 494         /* If we required a shortcut, check this plugin provides it. */
 495         if( i_shortcuts > 0 )
 496         {
 497             const char *name = psz_shortcuts;
 498
 499             for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
 500             {
 501                 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
 502                 {
 503                     char *c;
 504                     if( ( c = strchr( name, '@' ) )
 505                         ? !strncasecmp( name, p_module->pp_shortcuts[i],
 506                                         c-name )
 507                         : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
 508                     {
 509                         /* Found it */
 510                         if( c && c[1] )
 511                             psz_alias = c+1;
 512                         b_shortcut_bonus = true;
 513                         goto found_shortcut;
 514                     }
 515                 }
 516
 517                 /* Go to the next shortcut... This is so lame! */
 518                 name += strlen( name ) + 1;
 519             }
 520
 521             /* If we are in "strict" mode and we couldn't
 522              * find the module in the list of provided shortcuts,
 523              * then kick the bastard out of here!!! */
 524             if( b_strict )
 525                 continue;
 526         }
 527
 528         /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
 529         if( p_module->i_score <= 0 )
 530             continue;
 531
 532 found_shortcut:
 533         /* Store this new module */
 534         p_list[count].p_module = module_hold (p_module);
 535         p_list[count].i_score = p_module->i_score;
 536         if( b_shortcut_bonus )
 537             p_list[count].i_score += 10000;
 538         p_list[count].b_force = b_shortcut_bonus && b_strict;
 539         count++;
 540     }
 541
 542     /* We can release the list, interesting modules are held */
 543     module_list_free (p_all);
 544
 545     /* Sort candidates by descending score */
 546     qsort (p_list, count, sizeof (p_list[0]), modulecmp);
 547     msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
 548              count, count == 1 ? "" : "s" );
 549
 550     /* Parse the linked list and use the first successful module */
 551     p_module = NULL;
 552     for (size_t i = 0; (i < count) && (p_module == NULL); i++)
 553     {
 554         module_t *p_cand = p_list[i].p_module;
 555 #ifdef HAVE_DYNAMIC_PLUGINS
 556         /* Make sure the module is loaded in mem */
 557         module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
 558
 559         if( !p_real->b_builtin && !p_real->b_loaded )
 560         {
 561             module_t *p_new_module =
 562                 AllocatePlugin( p_this, p_real->psz_filename );
 563             if( p_new_module )
 564             {
 565                 CacheMerge( p_this, p_real, p_new_module );
 566                 DeleteModule( p_module_bank, p_new_module );
 567             }
 568         }
 569 #endif
 570
 571         p_this->b_force = p_list[i].b_force;
 572
 573         int ret = VLC_SUCCESS;
 574         if( p_cand->pf_activate )
 575             ret = p_cand->pf_activate( p_this );
 576         switch( ret )
 577         {
 578         case VLC_SUCCESS:
 579             /* good module! */
 580             p_module = p_cand;
 581             break;
 582
 583         case VLC_ETIMEOUT:
 584             /* good module, but aborted */
 585             module_release( p_cand );
 586             break;
 587
 588         default: /* bad module */
 589             module_release( p_cand );
 590             continue;
 591         }
 592
 593         /* Release the remaining modules */
 594         while (++i < count)
 595             module_release (p_list[i].p_module);
 596     }
 597
 598     free( p_list );
 599     p_this->b_force = b_force_backup;
 600
 601     if( p_module != NULL )
 602     {
 603         msg_Dbg( p_this, "using %s module \"%s\"",
 604                  psz_capability, p_module->psz_object_name );
 605     }
 606     else if( count == 0 )
 607     {
 608         if( !strcmp( psz_capability, "access_demux" )
 609          || !strcmp( psz_capability, "stream_filter" )
 610          || !strcmp( psz_capability, "vout_window" ) )
 611         {
 612             msg_Dbg( p_this, "no %s module matched \"%s\"",
 613                 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 614         }
 615         else
 616         {
 617             msg_Err( p_this, "no %s module matched \"%s\"",
 618                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 619
 620             msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
 621                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 622         }
 623     }
 624     else if( psz_name != NULL && *psz_name )
 625     {
 626         msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
 627                   psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 628     }
 629     else
 630         msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
 631
 632     free( psz_shortcuts );
 633     free( psz_var );
 634
 635     stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
 636     stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
 637     stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
 638
 639     /* Don't forget that the module is still locked */
 640     return p_module;
 641 }
 642
 643 /**
 644  * Module unneed
 645  *
 646  * This function must be called by the thread that called module_need, to
 647  * decrease the reference count and allow for hiding of modules.
 648  * \param p_this vlc object structure
 649  * \param p_module the module structure
 650  * \return nothing
 651  */
 652 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
 653 {
 654     /* Use the close method */
 655     if( p_module->pf_deactivate )
 656     {
 657         p_module->pf_deactivate( p_this );
 658     }
 659
 660     msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
 661
 662     module_release( p_module );
 663 }
 664
 665 /**
 666  * Get a pointer to a module_t given it's name.
 667  *
 668  * \param psz_name the name of the module
 669  * \return a pointer to the module or NULL in case of a failure
 670  */
 671 module_t *module_find( const char * psz_name )
 672 {
 673     module_t **list, *module;
 674
 675     list = module_list_get (NULL);
 676     if (!list)
 677         return NULL;
 678
 679     for (size_t i = 0; (module = list[i]) != NULL; i++)
 680     {
 681         const char *psz_module_name = module->psz_object_name;
 682
 683         if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
 684         {
 685             module_hold (module);
 686             break;
 687         }
 688     }
 689     module_list_free (list);
 690     return module;
 691 }
 692
 693 /**
 694  * Tell if a module exists and release it in thic case
 695  *
 696  * \param psz_name th name of the module
 697  * \return TRUE if the module exists
 698  */
 699 bool module_exists (const char * psz_name)
 700 {
 701     module_t *p_module = module_find (psz_name);
 702     if( p_module )
 703         module_release (p_module);
 704     return p_module != NULL;
 705 }
 706
 707 /**
 708  * Get a pointer to a module_t that matches a shortcut.
 709  * This is a temporary hack for SD. Do not re-use (generally multiple modules
 710  * can have the same shortcut, so this is *broken* - use module_need()!).
 711  *
 712  * \param psz_shortcut shortcut of the module
 713  * \param psz_cap capability of the module
 714  * \return a pointer to the module or NULL in case of a failure
 715  */
 716 module_t *module_find_by_shortcut (const char *psz_shortcut)
 717 {
 718     module_t **list, *module;
 719
 720     list = module_list_get (NULL);
 721     if (!list)
 722         return NULL;
 723
 724     for (size_t i = 0; (module = list[i]) != NULL; i++)
 725     {
 726         for (size_t j = 0;
 727              (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
 728              j++)
 729         {
 730             if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
 731             {
 732                 module_hold (module);
 733                 goto out;
 734              }
 735         }
 736     }
 737 out:
 738     module_list_free (list);
 739     return module;
 740 }
 741
 742 /**
 743  * GetModuleNamesForCapability
 744  *
 745  * Return a NULL terminated array with the names of the modules
 746  * that have a certain capability.
 747  * Free after uses both the string and the table.
 748  * \param psz_capability the capability asked
 749  * \param pppsz_longname an pointer to an array of string to contain
 750     the long names of the modules. If set to NULL the function don't use it.
 751  * \return the NULL terminated array
 752  */
 753 char ** module_GetModulesNamesForCapability( const char *psz_capability,
 754                                              char ***pppsz_longname )
 755 {
 756     size_t count = 0;
 757     char **psz_ret;
 758
 759     module_t **list = module_list_get (NULL);
 760
 761     /* Proceed in two passes: count the number of modules first */
 762     for (size_t i = 0; list[i]; i++)
 763     {
 764         module_t *p_module = list[i];
 765         const char *psz_module_capability = p_module->psz_capability;
 766
 767         if( psz_module_capability
 768          && !strcmp( psz_module_capability, psz_capability ) )
 769             count++;
 770     }
 771
 772     /* Then get the names */
 773     psz_ret = malloc( sizeof(char*) * (count+1) );
 774     if( pppsz_longname )
 775         *pppsz_longname = malloc( sizeof(char*) * (count+1) );
 776     if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
 777     {
 778         free( psz_ret );
 779         if( pppsz_longname )
 780         {
 781             free( *pppsz_longname );
 782             *pppsz_longname = NULL;
 783         }
 784         module_list_free (list);
 785         return NULL;
 786     }
 787
 788     for (size_t i = 0, j = 0; list[i]; i++)
 789     {
 790         module_t *p_module = list[i];
 791         const char *psz_module_capability = p_module->psz_capability;
 792
 793         if( psz_module_capability
 794          && !strcmp( psz_module_capability, psz_capability ) )
 795         {
 796             /* Explicit hack: Use the last shortcut. It _should_ be
 797              * different from the object name, at least if the object
 798              * contains multiple submodules with the same capability. */
 799             unsigned k = 0;
 800             while( p_module->pp_shortcuts[k] != NULL )
 801                 k++;
 802             assert( k > 0); /* pp_shortcuts[0] is always set */
 803             psz_ret[j] = strdup( p_module->pp_shortcuts[k - 1] );
 804             if( pppsz_longname )
 805                 (*pppsz_longname)[j] = strdup( module_get_name( p_module, true ) );
 806             j++;
 807         }
 808     }
 809     psz_ret[count] = NULL;
 810
 811     module_list_free (list);
 812
 813     return psz_ret;
 814 }
 815
 816 /**
 817  * Get the configuration of a module
 818  *
 819  * \param module the module
 820  * \param psize the size of the configuration returned
 821  * \return the configuration as an array
 822  */
 823 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
 824 {
 825     unsigned i,j;
 826     unsigned size = module->confsize;
 827     module_config_t *config = malloc( size * sizeof( *config ) );
 828
 829     assert( psize != NULL );
 830     *psize = 0;
 831
 832     if( !config )
 833         return NULL;
 834
 835     for( i = 0, j = 0; i < size; i++ )
 836     {
 837         const module_config_t *item = module->p_config + i;
 838         if( item->b_internal /* internal option */
 839          || item->b_unsaveable /* non-modifiable option */
 840          || item->b_removed /* removed option */ )
 841             continue;
 842
 843         memcpy( config + j, item, sizeof( *config ) );
 844         j++;
 845     }
 846     *psize = j;
 847
 848     return config;
 849 }
 850
 851 /**
 852  * Release the configuration
 853  *
 854  * \param the configuration
 855  * \return nothing
 856  */
 857 void module_config_free( module_config_t *config )
 858 {
 859     free( config );
 860 }
 861
 862 /*****************************************************************************
 863  * Following functions are local.
 864  *****************************************************************************/
 865
 866  /*****************************************************************************
 867  * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
 868  * return first path.
 869  *****************************************************************************/
 870 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
 871 {
 872     char * path;
 873     int i, done;
 874     bool escaped = false;
 875
 876     assert( paths );
 877
 878     /* Alloc a buffer to store the path */
 879     path = malloc( strlen( paths ) + 1 );
 880     if( !path ) return NULL;
 881
 882     /* Look for PATH_SEP_CHAR (a ':' or a ';') */
 883     for( i = 0, done = 0 ; paths[i]; i++ )
 884     {
 885         /* Take care of \\ and \: or \; escapement */
 886         if( escaped )
 887         {
 888             escaped = false;
 889             path[done++] = paths[i];
 890         }
 891 #ifdef WIN32
 892         else if( paths[i] == '/' )
 893             escaped = true;
 894 #else
 895         else if( paths[i] == '\\' )
 896             escaped = true;
 897 #endif
 898         else if( paths[i] == PATH_SEP_CHAR )
 899             break;
 900         else
 901             path[done++] = paths[i];
 902     }
 903     path[done] = 0;
 904
 905     /* Return the remaining paths */
 906     if( remaining_paths ) {
 907         *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
 908     }
 909
 910     return path;
 911 }
 912
 913 char *psz_vlcpath = NULL;
 914
 915 /*****************************************************************************
 916  * AllocateAllPlugins: load all plugin modules we can find.
 917  *****************************************************************************/
 918 #ifdef HAVE_DYNAMIC_PLUGINS
 919 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
 920 {
 921     const char *vlcpath = psz_vlcpath;
 922     int count,i;
 923     char * path;
 924     vlc_array_t *arraypaths = vlc_array_new();
 925
 926     /* Contruct the special search path for system that have a relocatable
 927      * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
 928
 929     if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
 930         vlc_array_append( arraypaths, path );
 931     if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
 932         vlc_array_append( arraypaths, path );
 933 #ifndef WIN32
 934     vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
 935 #endif
 936
 937     /* If the user provided a plugin path, we add it to the list */
 938     char *userpaths = config_GetPsz( p_this, "plugin-path" );
 939     char *paths_iter;
 940
 941     for( paths_iter = userpaths; paths_iter; )
 942     {
 943         path = copy_next_paths_token( paths_iter, &paths_iter );
 944         if( path )
 945             vlc_array_append( arraypaths, path );
 946     }
 947
 948     count = vlc_array_count( arraypaths );
 949     for( i = 0 ; i < count ; i++ )
 950     {
 951         path = vlc_array_item_at_index( arraypaths, i );
 952         if( !path )
 953             continue;
 954
 955         msg_Dbg( p_this, "recursively browsing `%s'", path );
 956
 957         /* Don't go deeper than 5 subdirectories */
 958         AllocatePluginDir( p_this, p_bank, path, 5 );
 959
 960         free( path );
 961     }
 962
 963     vlc_array_destroy( arraypaths );
 964     free( userpaths );
 965 }
 966
 967 /*****************************************************************************
 968  * AllocatePluginDir: recursively parse a directory to look for plugins
 969  *****************************************************************************/
 970 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
 971                                const char *psz_dir, unsigned i_maxdepth )
 972 {
 973     if( i_maxdepth == 0 )
 974         return;
 975
 976     DIR *dh = utf8_opendir (psz_dir);
 977     if (dh == NULL)
 978         return;
 979
 980     /* Parse the directory and try to load all files it contains. */
 981     for (;;)
 982     {
 983         char *file = utf8_readdir (dh), *path;
 984         struct stat st;
 985
 986         if (file == NULL)
 987             break;
 988
 989         /* Skip ".", ".." */
 990         if (!strcmp (file, ".") || !strcmp (file, ".."))
 991         {
 992             free (file);
 993             continue;
 994         }
 995
 996         const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
 997         free (file);
 998         if (pathlen == -1 || utf8_stat (path, &st))
 999             continue;
1000
1001         if (S_ISDIR (st.st_mode))
1002             /* Recurse into another directory */
1003             AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
1004         else
1005         if (S_ISREG (st.st_mode)
1006          && ((size_t)pathlen >= strlen (LIBEXT))
1007          && !strncasecmp (path + pathlen - strlen (LIBEXT), LIBEXT,
1008                           strlen (LIBEXT)))
1009             /* ^^ We only load files ending with LIBEXT */
1010             AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
1011
1012         free (path);
1013     }
1014     closedir (dh);
1015 }
1016
1017 /*****************************************************************************
1018  * AllocatePluginFile: load a module into memory and initialize it.
1019  *****************************************************************************
1020  * This function loads a dynamically loadable module and allocates a structure
1021  * for its information data. The module can then be handled by module_need
1022  * and module_unneed. It can be removed by DeleteModule.
1023  *****************************************************************************/
1024 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
1025                                const char *psz_file,
1026                                int64_t i_file_time, int64_t i_file_size )
1027 {
1028     module_t * p_module = NULL;
1029     module_cache_t *p_cache_entry = NULL;
1030
1031     /*
1032      * Check our plugins cache first then load plugin if needed
1033      */
1034     p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
1035     if( !p_cache_entry )
1036     {
1037         p_module = AllocatePlugin( p_this, psz_file );
1038     }
1039     else
1040     /* If junk dll, don't try to load it */
1041     if( p_cache_entry->b_junk )
1042         return -1;
1043     else
1044     {
1045         module_config_t *p_item = NULL, *p_end = NULL;
1046
1047         p_module = p_cache_entry->p_module;
1048         p_module->b_loaded = false;
1049
1050         /* For now we force loading if the module's config contains
1051          * callbacks or actions.
1052          * Could be optimized by adding an API call.*/
1053         for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1054              p_item < p_end; p_item++ )
1055         {
1056             if( p_item->pf_callback || p_item->i_action )
1057             {
1058                 p_module = AllocatePlugin( p_this, psz_file );
1059                 break;
1060             }
1061         }
1062         if( p_module == p_cache_entry->p_module )
1063             p_cache_entry->b_used = true;
1064     }
1065
1066     if( p_module == NULL )
1067         return -1;
1068
1069     /* Everything worked fine !
1070      * The module is ready to be added to the list. */
1071     p_module->b_builtin = false;
1072
1073     /* msg_Dbg( p_this, "plugin \"%s\", %s",
1074                 p_module->psz_object_name, p_module->psz_longname ); */
1075     p_module->next = p_bank->head;
1076     p_bank->head = p_module;
1077
1078     if( !p_module_bank->b_cache )
1079         return 0;
1080
1081     /* Add entry to cache */
1082     module_cache_t **pp_cache = p_bank->pp_cache;
1083
1084     pp_cache = realloc( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1085     if( pp_cache == NULL )
1086         return -1;
1087     pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1088     if( pp_cache[p_bank->i_cache] == NULL )
1089         return -1;
1090     pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1091     pp_cache[p_bank->i_cache]->i_time = i_file_time;
1092     pp_cache[p_bank->i_cache]->i_size = i_file_size;
1093     pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1094     pp_cache[p_bank->i_cache]->b_used = true;
1095     pp_cache[p_bank->i_cache]->p_module = p_module;
1096     p_bank->pp_cache = pp_cache;
1097     p_bank->i_cache++;
1098     return  0;
1099 }
1100
1101 /*****************************************************************************
1102  * AllocatePlugin: load a module into memory and initialize it.
1103  *****************************************************************************
1104  * This function loads a dynamically loadable module and allocates a structure
1105  * for its information data. The module can then be handled by module_need
1106  * and module_unneed. It can be removed by DeleteModule.
1107  *****************************************************************************/
1108 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1109 {
1110     module_t * p_module = NULL;
1111     module_handle_t handle;
1112
1113     if( module_Load( p_this, psz_file, &handle ) )
1114         return NULL;
1115
1116     /* Now that we have successfully loaded the module, we can
1117      * allocate a structure for it */
1118     p_module = vlc_module_create( p_this );
1119     if( p_module == NULL )
1120     {
1121         module_Unload( handle );
1122         return NULL;
1123     }
1124
1125     p_module->psz_filename = strdup( psz_file );
1126     p_module->handle = handle;
1127     p_module->b_loaded = true;
1128
1129     /* Initialize the module: fill p_module, default config */
1130     if( module_Call( p_this, p_module ) != 0 )
1131     {
1132         /* We couldn't call module_init() */
1133         free( p_module->psz_filename );
1134         module_release( p_module );
1135         module_Unload( handle );
1136         return NULL;
1137     }
1138
1139     DupModule( p_module );
1140
1141     /* Everything worked fine ! The module is ready to be added to the list. */
1142     p_module->b_builtin = false;
1143
1144     return p_module;
1145 }
1146
1147 /*****************************************************************************
1148  * DupModule: make a plugin module standalone.
1149  *****************************************************************************
1150  * This function duplicates all strings in the module, so that the dynamic
1151  * object can be unloaded. It acts recursively on submodules.
1152  *****************************************************************************/
1153 static void DupModule( module_t *p_module )
1154 {
1155     char **pp_shortcut;
1156
1157     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1158     {
1159         *pp_shortcut = strdup( *pp_shortcut );
1160     }
1161
1162     /* We strdup() these entries so that they are still valid when the
1163      * module is unloaded. */
1164     p_module->psz_capability = strdup( p_module->psz_capability );
1165     p_module->psz_shortname = p_module->psz_shortname ?
1166                                  strdup( p_module->psz_shortname ) : NULL;
1167     p_module->psz_longname = strdup( p_module->psz_longname );
1168     p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1169                                             : NULL;
1170
1171     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1172         DupModule (subm);
1173 }
1174
1175 /*****************************************************************************
1176  * UndupModule: free a duplicated module.
1177  *****************************************************************************
1178  * This function frees the allocations done in DupModule().
1179  *****************************************************************************/
1180 static void UndupModule( module_t *p_module )
1181 {
1182     char **pp_shortcut;
1183
1184     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1185         UndupModule (subm);
1186
1187     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1188     {
1189         free( *pp_shortcut );
1190     }
1191
1192     free( p_module->psz_capability );
1193     FREENULL( p_module->psz_shortname );
1194     free( p_module->psz_longname );
1195     FREENULL( p_module->psz_help );
1196 }
1197
1198 #endif /* HAVE_DYNAMIC_PLUGINS */
1199
1200 /*****************************************************************************
1201  * AllocateBuiltinModule: initialize a builtin module.
1202  *****************************************************************************
1203  * This function registers a builtin module and allocates a structure
1204  * for its information data. The module can then be handled by module_need
1205  * and module_unneed. It can be removed by DeleteModule.
1206  *****************************************************************************/
1207 static int AllocateBuiltinModule( vlc_object_t * p_this,
1208                                   int ( *pf_entry ) ( module_t * ) )
1209 {
1210     module_t * p_module;
1211
1212     /* Now that we have successfully loaded the module, we can
1213      * allocate a structure for it */
1214     p_module = vlc_module_create( p_this );
1215     if( p_module == NULL )
1216         return -1;
1217
1218     /* Initialize the module : fill p_module->psz_object_name, etc. */
1219     if( pf_entry( p_module ) != 0 )
1220     {
1221         /* With a well-written module we shouldn't have to print an
1222          * additional error message here, but just make sure. */
1223         msg_Err( p_this, "failed calling entry point in builtin module" );
1224         module_release( p_module );
1225         return -1;
1226     }
1227
1228     /* Everything worked fine ! The module is ready to be added to the list. */
1229     p_module->b_builtin = true;
1230     /* LOCK */
1231     p_module->next = p_module_bank->head;
1232     p_module_bank->head = p_module;
1233     /* UNLOCK */
1234
1235     /* msg_Dbg( p_this, "builtin \"%s\", %s",
1236                 p_module->psz_object_name, p_module->psz_longname ); */
1237
1238     return 0;
1239 }
1240
1241 /*****************************************************************************
1242  * DeleteModule: delete a module and its structure.
1243  *****************************************************************************
1244  * This function can only be called if the module isn't being used.
1245  *****************************************************************************/
1246 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1247 {
1248     assert( p_module );
1249
1250     /* Unlist the module (if it is in the list) */
1251     module_t **pp_self = &p_bank->head;
1252     while (*pp_self != NULL && *pp_self != p_module)
1253         pp_self = &((*pp_self)->next);
1254     if (*pp_self)
1255         *pp_self = p_module->next;
1256
1257     /* We free the structures that we strdup()ed in Allocate*Module(). */
1258 #ifdef HAVE_DYNAMIC_PLUGINS
1259     if( !p_module->b_builtin )
1260     {
1261         if( p_module->b_loaded && p_module->b_unloadable )
1262         {
1263             module_Unload( p_module->handle );
1264         }
1265         UndupModule( p_module );
1266         free( p_module->psz_filename );
1267     }
1268 #endif
1269
1270     /* Free and detach the object's children */
1271     while (p_module->submodule)
1272     {
1273         module_t *submodule = p_module->submodule;
1274         p_module->submodule = submodule->next;
1275         module_release (submodule);
1276     }
1277
1278     config_Free( p_module );
1279     module_release( p_module );
1280 }