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 if true, do not fallback to plugin with a different name
 404  *                 but the same capability
 405  * \return the module or NULL in case of a failure
 406  */
 407 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
 408                           const char *psz_name, bool b_strict )
 409 {
 410     stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
 411
 412     module_list_t *p_list;
 413     module_t *p_module;
 414     int i_shortcuts = 0;
 415     char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
 416     bool b_force_backup = p_this->b_force;
 417
 418     /* Deal with variables */
 419     if( psz_name && psz_name[0] == '$' )
 420     {
 421         psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
 422     }
 423
 424     /* Count how many different shortcuts were asked for */
 425     if( psz_name && *psz_name )
 426     {
 427         char *psz_parser, *psz_last_shortcut;
 428
 429         /* If the user wants none, give him none. */
 430         if( !strcmp( psz_name, "none" ) )
 431         {
 432             free( psz_var );
 433             stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
 434             stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
 435             stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
 436             return NULL;
 437         }
 438
 439         i_shortcuts++;
 440         psz_shortcuts = psz_last_shortcut = strdup( psz_name );
 441
 442         for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
 443         {
 444             if( *psz_parser == ',' )
 445             {
 446                  *psz_parser = '\0';
 447                  i_shortcuts++;
 448                  psz_last_shortcut = psz_parser + 1;
 449             }
 450         }
 451
 452         /* Check if the user wants to override the "strict" mode */
 453         if( psz_last_shortcut )
 454         {
 455             if( !strcmp(psz_last_shortcut, "none") )
 456             {
 457                 b_strict = true;
 458                 i_shortcuts--;
 459             }
 460             else if( !strcmp(psz_last_shortcut, "any") )
 461             {
 462                 b_strict = false;
 463                 i_shortcuts--;
 464             }
 465         }
 466     }
 467
 468     /* Sort the modules and test them */
 469     size_t count;
 470     module_t **p_all = module_list_get (&count);
 471     p_list = malloc( count * sizeof( module_list_t ) );
 472     unsigned i_cpu = vlc_CPU();
 473
 474     /* Parse the module list for capabilities and probe each of them */
 475     count = 0;
 476     for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
 477     {
 478         int i_shortcut_bonus = 0;
 479
 480         /* Test that this module can do what we need */
 481         if( !module_provides( p_module, psz_capability ) )
 482             continue;
 483         /* Test if we have the required CPU */
 484         if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
 485             continue;
 486
 487         /* If we required a shortcut, check this plugin provides it. */
 488         if( i_shortcuts > 0 )
 489         {
 490             const char *name = psz_shortcuts;
 491
 492             for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
 493             {
 494                 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
 495                 {
 496                     char *c;
 497                     if( ( c = strchr( name, '@' ) )
 498                         ? !strncasecmp( name, p_module->pp_shortcuts[i],
 499                                         c-name )
 500                         : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
 501                     {
 502                         /* Found it */
 503                         if( c && c[1] )
 504                             psz_alias = c+1;
 505                         i_shortcut_bonus = i_short * 10000;
 506                         goto found_shortcut;
 507                     }
 508                 }
 509
 510                 /* Go to the next shortcut... This is so lame! */
 511                 name += strlen( name ) + 1;
 512             }
 513
 514             /* If we are in "strict" mode and we couldn't
 515              * find the module in the list of provided shortcuts,
 516              * then kick the bastard out of here!!! */
 517             if( b_strict )
 518                 continue;
 519         }
 520
 521         /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
 522         if( p_module->i_score <= 0 )
 523             continue;
 524
 525 found_shortcut:
 526         /* Store this new module */
 527         p_list[count].p_module = module_hold (p_module);
 528         p_list[count].i_score = p_module->i_score + i_shortcut_bonus;
 529         p_list[count].b_force = i_shortcut_bonus && b_strict;
 530         count++;
 531     }
 532
 533     /* We can release the list, interesting modules are held */
 534     module_list_free (p_all);
 535
 536     /* Sort candidates by descending score */
 537     qsort (p_list, count, sizeof (p_list[0]), modulecmp);
 538     msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
 539              count, count == 1 ? "" : "s" );
 540
 541     /* Parse the linked list and use the first successful module */
 542     p_module = NULL;
 543     for (size_t i = 0; (i < count) && (p_module == NULL); i++)
 544     {
 545         module_t *p_cand = p_list[i].p_module;
 546 #ifdef HAVE_DYNAMIC_PLUGINS
 547         /* Make sure the module is loaded in mem */
 548         module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
 549
 550         if( !p_real->b_builtin && !p_real->b_loaded )
 551         {
 552             module_t *p_new_module =
 553                 AllocatePlugin( p_this, p_real->psz_filename );
 554             if( p_new_module == NULL )
 555             {   /* Corrupted module */
 556                 msg_Err( p_this, "possibly corrupt module cache" );
 557                 module_release( p_cand );
 558                 continue;
 559             }
 560             CacheMerge( p_this, p_real, p_new_module );
 561             DeleteModule( p_module_bank, p_new_module );
 562         }
 563 #endif
 564
 565         p_this->b_force = p_list[i].b_force;
 566
 567         int ret = VLC_SUCCESS;
 568         if( p_cand->pf_activate )
 569             ret = p_cand->pf_activate( p_this );
 570         switch( ret )
 571         {
 572         case VLC_SUCCESS:
 573             /* good module! */
 574             p_module = p_cand;
 575             break;
 576
 577         case VLC_ETIMEOUT:
 578             /* good module, but aborted */
 579             module_release( p_cand );
 580             break;
 581
 582         default: /* bad module */
 583             module_release( p_cand );
 584             continue;
 585         }
 586
 587         /* Release the remaining modules */
 588         while (++i < count)
 589             module_release (p_list[i].p_module);
 590     }
 591
 592     free( p_list );
 593     p_this->b_force = b_force_backup;
 594
 595     if( p_module != NULL )
 596     {
 597         msg_Dbg( p_this, "using %s module \"%s\"",
 598                  psz_capability, p_module->psz_object_name );
 599         vlc_object_set_name( p_this, psz_alias ? psz_alias
 600                                                : p_module->psz_object_name );
 601     }
 602     else if( count == 0 )
 603     {
 604         if( !strcmp( psz_capability, "access_demux" )
 605          || !strcmp( psz_capability, "stream_filter" )
 606          || !strcmp( psz_capability, "vout_window" ) )
 607         {
 608             msg_Dbg( p_this, "no %s module matched \"%s\"",
 609                 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 610         }
 611         else
 612         {
 613             msg_Err( p_this, "no %s module matched \"%s\"",
 614                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 615
 616             msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
 617                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 618         }
 619     }
 620     else if( psz_name != NULL && *psz_name )
 621     {
 622         msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
 623                   psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 624     }
 625     else
 626         msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
 627
 628     free( psz_shortcuts );
 629     free( psz_var );
 630
 631     stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
 632     stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
 633     stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
 634
 635     /* Don't forget that the module is still locked */
 636     return p_module;
 637 }
 638
 639 /**
 640  * Module unneed
 641  *
 642  * This function must be called by the thread that called module_need, to
 643  * decrease the reference count and allow for hiding of modules.
 644  * \param p_this vlc object structure
 645  * \param p_module the module structure
 646  * \return nothing
 647  */
 648 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
 649 {
 650     /* Use the close method */
 651     if( p_module->pf_deactivate )
 652     {
 653         p_module->pf_deactivate( p_this );
 654     }
 655
 656     msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
 657
 658     module_release( p_module );
 659 }
 660
 661 /**
 662  * Get a pointer to a module_t given it's name.
 663  *
 664  * \param psz_name the name of the module
 665  * \return a pointer to the module or NULL in case of a failure
 666  */
 667 module_t *module_find( const char * psz_name )
 668 {
 669     module_t **list, *module;
 670
 671     list = module_list_get (NULL);
 672     if (!list)
 673         return NULL;
 674
 675     for (size_t i = 0; (module = list[i]) != NULL; i++)
 676     {
 677         const char *psz_module_name = module->psz_object_name;
 678
 679         if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
 680         {
 681             module_hold (module);
 682             break;
 683         }
 684     }
 685     module_list_free (list);
 686     return module;
 687 }
 688
 689 /**
 690  * Tell if a module exists and release it in thic case
 691  *
 692  * \param psz_name th name of the module
 693  * \return TRUE if the module exists
 694  */
 695 bool module_exists (const char * psz_name)
 696 {
 697     module_t *p_module = module_find (psz_name);
 698     if( p_module )
 699         module_release (p_module);
 700     return p_module != NULL;
 701 }
 702
 703 /**
 704  * Get a pointer to a module_t that matches a shortcut.
 705  * This is a temporary hack for SD. Do not re-use (generally multiple modules
 706  * can have the same shortcut, so this is *broken* - use module_need()!).
 707  *
 708  * \param psz_shortcut shortcut of the module
 709  * \param psz_cap capability of the module
 710  * \return a pointer to the module or NULL in case of a failure
 711  */
 712 module_t *module_find_by_shortcut (const char *psz_shortcut)
 713 {
 714     module_t **list, *module;
 715
 716     list = module_list_get (NULL);
 717     if (!list)
 718         return NULL;
 719
 720     for (size_t i = 0; (module = list[i]) != NULL; i++)
 721     {
 722         for (size_t j = 0;
 723              (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
 724              j++)
 725         {
 726             if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
 727             {
 728                 module_hold (module);
 729                 goto out;
 730              }
 731         }
 732     }
 733 out:
 734     module_list_free (list);
 735     return module;
 736 }
 737
 738 /**
 739  * Get the configuration of a module
 740  *
 741  * \param module the module
 742  * \param psize the size of the configuration returned
 743  * \return the configuration as an array
 744  */
 745 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
 746 {
 747     unsigned i,j;
 748     unsigned size = module->confsize;
 749     module_config_t *config = malloc( size * sizeof( *config ) );
 750
 751     assert( psize != NULL );
 752     *psize = 0;
 753
 754     if( !config )
 755         return NULL;
 756
 757     for( i = 0, j = 0; i < size; i++ )
 758     {
 759         const module_config_t *item = module->p_config + i;
 760         if( item->b_internal /* internal option */
 761          || item->b_unsaveable /* non-modifiable option */
 762          || item->b_removed /* removed option */ )
 763             continue;
 764
 765         memcpy( config + j, item, sizeof( *config ) );
 766         j++;
 767     }
 768     *psize = j;
 769
 770     return config;
 771 }
 772
 773 /**
 774  * Release the configuration
 775  *
 776  * \param the configuration
 777  * \return nothing
 778  */
 779 void module_config_free( module_config_t *config )
 780 {
 781     free( config );
 782 }
 783
 784 /*****************************************************************************
 785  * Following functions are local.
 786  *****************************************************************************/
 787
 788  /*****************************************************************************
 789  * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
 790  * return first path.
 791  *****************************************************************************/
 792 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
 793 {
 794     char * path;
 795     int i, done;
 796     bool escaped = false;
 797
 798     assert( paths );
 799
 800     /* Alloc a buffer to store the path */
 801     path = malloc( strlen( paths ) + 1 );
 802     if( !path ) return NULL;
 803
 804     /* Look for PATH_SEP_CHAR (a ':' or a ';') */
 805     for( i = 0, done = 0 ; paths[i]; i++ )
 806     {
 807         /* Take care of \\ and \: or \; escapement */
 808         if( escaped )
 809         {
 810             escaped = false;
 811             path[done++] = paths[i];
 812         }
 813 #ifdef WIN32
 814         else if( paths[i] == '/' )
 815             escaped = true;
 816 #else
 817         else if( paths[i] == '\\' )
 818             escaped = true;
 819 #endif
 820         else if( paths[i] == PATH_SEP_CHAR )
 821             break;
 822         else
 823             path[done++] = paths[i];
 824     }
 825     path[done] = 0;
 826
 827     /* Return the remaining paths */
 828     if( remaining_paths ) {
 829         *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
 830     }
 831
 832     return path;
 833 }
 834
 835 char *psz_vlcpath = NULL;
 836
 837 /*****************************************************************************
 838  * AllocateAllPlugins: load all plugin modules we can find.
 839  *****************************************************************************/
 840 #ifdef HAVE_DYNAMIC_PLUGINS
 841 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
 842 {
 843     const char *vlcpath = psz_vlcpath;
 844     int count,i;
 845     char * path;
 846     vlc_array_t *arraypaths = vlc_array_new();
 847
 848     /* Contruct the special search path for system that have a relocatable
 849      * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
 850
 851     if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
 852         vlc_array_append( arraypaths, path );
 853     if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
 854         vlc_array_append( arraypaths, path );
 855 #ifndef WIN32
 856     vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
 857 #endif
 858
 859     /* If the user provided a plugin path, we add it to the list */
 860     char *userpaths = config_GetPsz( p_this, "plugin-path" );
 861     char *paths_iter;
 862
 863     for( paths_iter = userpaths; paths_iter; )
 864     {
 865         path = copy_next_paths_token( paths_iter, &paths_iter );
 866         if( path )
 867             vlc_array_append( arraypaths, path );
 868     }
 869
 870     count = vlc_array_count( arraypaths );
 871     for( i = 0 ; i < count ; i++ )
 872     {
 873         path = vlc_array_item_at_index( arraypaths, i );
 874         if( !path )
 875             continue;
 876
 877         msg_Dbg( p_this, "recursively browsing `%s'", path );
 878
 879         /* Don't go deeper than 5 subdirectories */
 880         AllocatePluginDir( p_this, p_bank, path, 5 );
 881
 882         free( path );
 883     }
 884
 885     vlc_array_destroy( arraypaths );
 886     free( userpaths );
 887 }
 888
 889 /*****************************************************************************
 890  * AllocatePluginDir: recursively parse a directory to look for plugins
 891  *****************************************************************************/
 892 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
 893                                const char *psz_dir, unsigned i_maxdepth )
 894 {
 895     if( i_maxdepth == 0 )
 896         return;
 897
 898     DIR *dh = utf8_opendir (psz_dir);
 899     if (dh == NULL)
 900         return;
 901
 902     /* Parse the directory and try to load all files it contains. */
 903     for (;;)
 904     {
 905         char *file = utf8_readdir (dh), *path;
 906         struct stat st;
 907
 908         if (file == NULL)
 909             break;
 910
 911         /* Skip ".", ".." */
 912         if (!strcmp (file, ".") || !strcmp (file, ".."))
 913         {
 914             free (file);
 915             continue;
 916         }
 917
 918         const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
 919         free (file);
 920         if (pathlen == -1 || utf8_stat (path, &st))
 921             continue;
 922
 923         if (S_ISDIR (st.st_mode))
 924             /* Recurse into another directory */
 925             AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
 926         else
 927         if (S_ISREG (st.st_mode)
 928          && ((size_t)pathlen >= strlen (LIBEXT))
 929          && !strncasecmp (path + pathlen - strlen (LIBEXT), LIBEXT,
 930                           strlen (LIBEXT)))
 931             /* ^^ We only load files ending with LIBEXT */
 932             AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
 933
 934         free (path);
 935     }
 936     closedir (dh);
 937 }
 938
 939 /*****************************************************************************
 940  * AllocatePluginFile: load a module into memory and initialize it.
 941  *****************************************************************************
 942  * This function loads a dynamically loadable module and allocates a structure
 943  * for its information data. The module can then be handled by module_need
 944  * and module_unneed. It can be removed by DeleteModule.
 945  *****************************************************************************/
 946 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
 947                                const char *psz_file,
 948                                int64_t i_file_time, int64_t i_file_size )
 949 {
 950     module_t * p_module = NULL;
 951     module_cache_t *p_cache_entry = NULL;
 952
 953     /*
 954      * Check our plugins cache first then load plugin if needed
 955      */
 956     p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
 957     if( !p_cache_entry )
 958     {
 959         p_module = AllocatePlugin( p_this, psz_file );
 960     }
 961     else
 962     /* If junk dll, don't try to load it */
 963     if( p_cache_entry->b_junk )
 964         return -1;
 965     else
 966     {
 967         module_config_t *p_item = NULL, *p_end = NULL;
 968
 969         p_module = p_cache_entry->p_module;
 970         p_module->b_loaded = false;
 971
 972         /* For now we force loading if the module's config contains
 973          * callbacks or actions.
 974          * Could be optimized by adding an API call.*/
 975         for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
 976              p_item < p_end; p_item++ )
 977         {
 978             if( p_item->pf_callback || p_item->i_action )
 979             {
 980                 p_module = AllocatePlugin( p_this, psz_file );
 981                 break;
 982             }
 983         }
 984         if( p_module == p_cache_entry->p_module )
 985             p_cache_entry->b_used = true;
 986     }
 987
 988     if( p_module == NULL )
 989         return -1;
 990
 991     /* Everything worked fine !
 992      * The module is ready to be added to the list. */
 993     p_module->b_builtin = false;
 994
 995     /* msg_Dbg( p_this, "plugin \"%s\", %s",
 996                 p_module->psz_object_name, p_module->psz_longname ); */
 997     p_module->next = p_bank->head;
 998     p_bank->head = p_module;
 999
1000     if( !p_module_bank->b_cache )
1001         return 0;
1002
1003     /* Add entry to cache */
1004     module_cache_t **pp_cache = p_bank->pp_cache;
1005
1006     pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1007     if( pp_cache == NULL )
1008         return -1;
1009     pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1010     if( pp_cache[p_bank->i_cache] == NULL )
1011         return -1;
1012     pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1013     pp_cache[p_bank->i_cache]->i_time = i_file_time;
1014     pp_cache[p_bank->i_cache]->i_size = i_file_size;
1015     pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1016     pp_cache[p_bank->i_cache]->b_used = true;
1017     pp_cache[p_bank->i_cache]->p_module = p_module;
1018     p_bank->pp_cache = pp_cache;
1019     p_bank->i_cache++;
1020     return  0;
1021 }
1022
1023 /*****************************************************************************
1024  * AllocatePlugin: load a module into memory and initialize it.
1025  *****************************************************************************
1026  * This function loads a dynamically loadable module and allocates a structure
1027  * for its information data. The module can then be handled by module_need
1028  * and module_unneed. It can be removed by DeleteModule.
1029  *****************************************************************************/
1030 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1031 {
1032     module_t * p_module = NULL;
1033     module_handle_t handle;
1034
1035     if( module_Load( p_this, psz_file, &handle ) )
1036         return NULL;
1037
1038     /* Now that we have successfully loaded the module, we can
1039      * allocate a structure for it */
1040     p_module = vlc_module_create( p_this );
1041     if( p_module == NULL )
1042     {
1043         module_Unload( handle );
1044         return NULL;
1045     }
1046
1047     p_module->psz_filename = strdup( psz_file );
1048     p_module->handle = handle;
1049     p_module->b_loaded = true;
1050
1051     /* Initialize the module: fill p_module, default config */
1052     if( module_Call( p_this, p_module ) != 0 )
1053     {
1054         /* We couldn't call module_init() */
1055         free( p_module->psz_filename );
1056         module_release( p_module );
1057         module_Unload( handle );
1058         return NULL;
1059     }
1060
1061     DupModule( p_module );
1062
1063     /* Everything worked fine ! The module is ready to be added to the list. */
1064     p_module->b_builtin = false;
1065
1066     return p_module;
1067 }
1068
1069 /*****************************************************************************
1070  * DupModule: make a plugin module standalone.
1071  *****************************************************************************
1072  * This function duplicates all strings in the module, so that the dynamic
1073  * object can be unloaded. It acts recursively on submodules.
1074  *****************************************************************************/
1075 static void DupModule( module_t *p_module )
1076 {
1077     char **pp_shortcut;
1078
1079     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1080     {
1081         *pp_shortcut = strdup( *pp_shortcut );
1082     }
1083
1084     /* We strdup() these entries so that they are still valid when the
1085      * module is unloaded. */
1086     p_module->psz_capability = strdup( p_module->psz_capability );
1087     p_module->psz_shortname = p_module->psz_shortname ?
1088                                  strdup( p_module->psz_shortname ) : NULL;
1089     p_module->psz_longname = strdup( p_module->psz_longname );
1090     p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1091                                             : NULL;
1092
1093     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1094         DupModule (subm);
1095 }
1096
1097 /*****************************************************************************
1098  * UndupModule: free a duplicated module.
1099  *****************************************************************************
1100  * This function frees the allocations done in DupModule().
1101  *****************************************************************************/
1102 static void UndupModule( module_t *p_module )
1103 {
1104     char **pp_shortcut;
1105
1106     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1107         UndupModule (subm);
1108
1109     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1110     {
1111         free( *pp_shortcut );
1112     }
1113
1114     free( p_module->psz_capability );
1115     FREENULL( p_module->psz_shortname );
1116     free( p_module->psz_longname );
1117     FREENULL( p_module->psz_help );
1118 }
1119
1120 #endif /* HAVE_DYNAMIC_PLUGINS */
1121
1122 /*****************************************************************************
1123  * AllocateBuiltinModule: initialize a builtin module.
1124  *****************************************************************************
1125  * This function registers a builtin module and allocates a structure
1126  * for its information data. The module can then be handled by module_need
1127  * and module_unneed. It can be removed by DeleteModule.
1128  *****************************************************************************/
1129 static int AllocateBuiltinModule( vlc_object_t * p_this,
1130                                   int ( *pf_entry ) ( module_t * ) )
1131 {
1132     module_t * p_module;
1133
1134     /* Now that we have successfully loaded the module, we can
1135      * allocate a structure for it */
1136     p_module = vlc_module_create( p_this );
1137     if( p_module == NULL )
1138         return -1;
1139
1140     /* Initialize the module : fill p_module->psz_object_name, etc. */
1141     if( pf_entry( p_module ) != 0 )
1142     {
1143         /* With a well-written module we shouldn't have to print an
1144          * additional error message here, but just make sure. */
1145         msg_Err( p_this, "failed calling entry point in builtin module" );
1146         module_release( p_module );
1147         return -1;
1148     }
1149
1150     /* Everything worked fine ! The module is ready to be added to the list. */
1151     p_module->b_builtin = true;
1152     /* LOCK */
1153     p_module->next = p_module_bank->head;
1154     p_module_bank->head = p_module;
1155     /* UNLOCK */
1156
1157     /* msg_Dbg( p_this, "builtin \"%s\", %s",
1158                 p_module->psz_object_name, p_module->psz_longname ); */
1159
1160     return 0;
1161 }
1162
1163 /*****************************************************************************
1164  * DeleteModule: delete a module and its structure.
1165  *****************************************************************************
1166  * This function can only be called if the module isn't being used.
1167  *****************************************************************************/
1168 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1169 {
1170     assert( p_module );
1171
1172     /* Unlist the module (if it is in the list) */
1173     module_t **pp_self = &p_bank->head;
1174     while (*pp_self != NULL && *pp_self != p_module)
1175         pp_self = &((*pp_self)->next);
1176     if (*pp_self)
1177         *pp_self = p_module->next;
1178
1179     /* We free the structures that we strdup()ed in Allocate*Module(). */
1180 #ifdef HAVE_DYNAMIC_PLUGINS
1181     if( !p_module->b_builtin )
1182     {
1183         if( p_module->b_loaded && p_module->b_unloadable )
1184         {
1185             module_Unload( p_module->handle );
1186         }
1187         UndupModule( p_module );
1188         free( p_module->psz_filename );
1189     }
1190 #endif
1191
1192     /* Free and detach the object's children */
1193     while (p_module->submodule)
1194     {
1195         module_t *submodule = p_module->submodule;
1196         p_module->submodule = submodule->next;
1197         module_release (submodule);
1198     }
1199
1200     config_Free( p_module );
1201     module_release( p_module );
1202 }