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