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