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