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