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