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