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