module_GetHelp
[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 #include <vlc/vlc.h>
28 #include "../libvlc.h"
29
30 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
31  * is set to 64. Don't try to be cleverer. */
32 #ifdef _FILE_OFFSET_BITS
33 #undef _FILE_OFFSET_BITS
34 #endif
35
36 #include <stdlib.h>                                      /* free(), strtol() */
37 #include <stdio.h>                                              /* sprintf() */
38 #include <string.h>                                              /* strdup() */
39
40 #ifdef HAVE_DIRENT_H
41 #   include <dirent.h>
42 #endif
43
44 #ifdef HAVE_SYS_TYPES_H
45 #   include <sys/types.h>
46 #endif
47 #ifdef HAVE_SYS_STAT_H
48 #   include <sys/stat.h>
49 #endif
50 #ifdef HAVE_UNISTD_H
51 #   include <unistd.h>
52 #endif
53
54 #if !defined(HAVE_DYNAMIC_PLUGINS)
55     /* no support for plugins */
56 #elif defined(HAVE_DL_DYLD)
57 #   if defined(HAVE_MACH_O_DYLD_H)
58 #       include <mach-o/dyld.h>
59 #   endif
60 #elif defined(HAVE_DL_BEOS)
61 #   if defined(HAVE_IMAGE_H)
62 #       include <image.h>
63 #   endif
64 #elif defined(HAVE_DL_WINDOWS)
65 #   include <windows.h>
66 #elif defined(HAVE_DL_DLOPEN)
67 #   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
68 #       include <dlfcn.h>
69 #   endif
70 #   if defined(HAVE_SYS_DL_H)
71 #       include <sys/dl.h>
72 #   endif
73 #elif defined(HAVE_DL_SHL_LOAD)
74 #   if defined(HAVE_DL_H)
75 #       include <dl.h>
76 #   endif
77 #endif
78
79 #include "modules/configuration.h"
80 #include "libvlc.h"
81
82 #include "vlc_interface.h"
83 #include "vlc_playlist.h"
84
85 #include "vlc_stream.h"
86 #include "vlc_access.h"
87 #include "vlc_demux.h"
88 #include "vlc_codec.h"
89
90 #include "vlc_vout.h"
91 #include "vlc_vout_synchro.h"
92
93 #include "vlc_aout.h"
94
95 #include "vlc_sout.h"
96 #include "vlc_httpd.h"
97 #include "vlc_acl.h"
98 #include "vlc_tls.h"
99 #include "vlc_md5.h"
100 #include "vlc_xml.h"
101 #include "vlc_url.h"
102
103 #include "iso_lang.h"
104 #include "vlc_charset.h"
105
106 #include "vlc_block.h"
107
108 #include "vlc_vlm.h"
109
110 #include "vlc_image.h"
111 #include "vlc_osd.h"
112
113 #include "vlc_update.h"
114 #include "vlc_strings.h"
115 #include "vlc_streaming.h"
116
117 #include "modules/modules.h"
118 #include "modules/builtin.h"
119
120 #include "vlc_network.h"
121
122 #if defined( WIN32 ) || defined( UNDER_CE )
123     /* Avoid name collisions */
124 #   define LoadModule(a,b,c) LoadVlcModule(a,b,c)
125 #endif
126
127 /*****************************************************************************
128  * Local prototypes
129  *****************************************************************************/
130 #ifdef HAVE_DYNAMIC_PLUGINS
131 static void AllocateAllPlugins  ( vlc_object_t * );
132 static void AllocatePluginDir   ( vlc_object_t *, const char *, int );
133 static int  AllocatePluginFile  ( vlc_object_t *, char *, int64_t, int64_t );
134 static module_t * AllocatePlugin( vlc_object_t *, char * );
135 #endif
136 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
137 static int  DeleteModule ( module_t *, vlc_bool_t );
138 #ifdef HAVE_DYNAMIC_PLUGINS
139 static void   DupModule        ( module_t * );
140 static void   UndupModule      ( module_t * );
141 static int    CallEntry        ( module_t * );
142 static int    LoadModule       ( vlc_object_t *, char *, module_handle_t * );
143 static void   CloseModule      ( module_handle_t );
144 static void * GetSymbol        ( module_handle_t, const char * );
145 static void   CacheLoad        ( vlc_object_t * );
146 static int    CacheLoadConfig  ( module_t *, FILE * );
147 static void   CacheSave        ( vlc_object_t * );
148 static void   CacheSaveConfig  ( module_t *, FILE * );
149 static char * CacheName        ( void );
150 static void   CacheMerge       ( vlc_object_t *, module_t *, module_t * );
151 static module_cache_t * CacheFind( vlc_object_t *, char *, int64_t, int64_t );
152
153 #if defined(HAVE_DL_WINDOWS)
154 static char * GetWindowsError  ( void );
155 #endif
156 #endif
157
158 static void module_LoadMain( vlc_object_t *p_this );
159
160 /* Sub-version number
161  * (only used to avoid breakage in dev version when cache structure changes) */
162 #define CACHE_SUBVERSION_NUM 3
163
164 /*****************************************************************************
165  * module_InitBank: create the module bank.
166  *****************************************************************************
167  * This function creates a module bank structure which will be filled later
168  * on with all the modules found.
169  *****************************************************************************/
170 void __module_InitBank( vlc_object_t *p_this )
171 {
172     module_bank_t *p_bank = NULL;
173     vlc_value_t  lockval;
174     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
175
176     var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
177     var_Get( p_libvlc_global, "libvlc", &lockval );
178     vlc_mutex_lock( lockval.p_address );
179     if( p_libvlc_global->p_module_bank )
180     {
181         p_libvlc_global->p_module_bank->i_usage++;
182         vlc_mutex_unlock( lockval.p_address );
183         var_Destroy( p_libvlc_global, "libvlc" );
184         return;
185     }
186     vlc_mutex_unlock( lockval.p_address );
187     var_Destroy( p_libvlc_global, "libvlc" );
188
189     p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
190     if( !p_bank )
191         return;
192     p_bank->psz_object_name = "module bank";
193     p_bank->i_usage = 1;
194     p_bank->i_cache = p_bank->i_loaded_cache = 0;
195     p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
196     p_bank->b_cache = p_bank->b_cache_dirty =
197         p_bank->b_cache_delete = VLC_FALSE;
198
199     /* Everything worked, attach the object */
200     p_libvlc_global->p_module_bank = p_bank;
201     vlc_object_attach( p_bank, p_libvlc_global );
202
203     module_LoadMain( p_this );
204 }
205
206
207 /*****************************************************************************
208  * module_EndBank: empty the module bank.
209  *****************************************************************************
210  * This function unloads all unused plugin modules and empties the module
211  * bank in case of success.
212  *****************************************************************************/
213 void __module_EndBank( vlc_object_t *p_this )
214 {
215     module_t * p_next = NULL;
216     vlc_value_t lockval;
217     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
218
219     var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
220     var_Get( p_libvlc_global, "libvlc", &lockval );
221     vlc_mutex_lock( lockval.p_address );
222     if( !p_libvlc_global->p_module_bank )
223     {
224         vlc_mutex_unlock( lockval.p_address );
225         var_Destroy( p_libvlc_global, "libvlc" );
226         return;
227     }
228     if( --p_libvlc_global->p_module_bank->i_usage )
229     {
230         vlc_mutex_unlock( lockval.p_address );
231         var_Destroy( p_libvlc_global, "libvlc" );
232         return;
233     }
234     vlc_mutex_unlock( lockval.p_address );
235     var_Destroy( p_libvlc_global, "libvlc" );
236
237     config_AutoSaveConfigFile( p_this );
238
239 #ifdef HAVE_DYNAMIC_PLUGINS
240 # define p_bank p_libvlc_global->p_module_bank
241     if( p_bank->b_cache ) CacheSave( p_this );
242     while( p_bank->i_loaded_cache-- )
243     {
244         if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
245         {
246             DeleteModule( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module,
247                           p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->b_used );
248             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
249             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
250             p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
251         }
252     }
253     if( p_bank->pp_loaded_cache )
254     {
255         free( p_bank->pp_loaded_cache );
256         p_bank->pp_loaded_cache = NULL;
257     }
258     while( p_bank->i_cache-- )
259     {
260         free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
261         free( p_bank->pp_cache[p_bank->i_cache] );
262         p_bank->pp_cache[p_bank->i_cache] = NULL;
263     }
264     if( p_bank->pp_cache )
265     {
266         free( p_bank->pp_cache );
267         p_bank->pp_cache = NULL;
268     }
269 # undef p_bank
270 #endif
271
272     vlc_object_detach( p_libvlc_global->p_module_bank );
273
274     while( p_libvlc_global->p_module_bank->i_children )
275     {
276         p_next = (module_t *)p_libvlc_global->p_module_bank->pp_children[0];
277
278         if( DeleteModule( p_next, VLC_TRUE ) )
279         {
280             /* Module deletion failed */
281             msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
282                      p_next->psz_object_name );
283
284             /* We just free the module by hand. Niahahahahaha. */
285             vlc_object_detach( p_next );
286             vlc_object_destroy( p_next );
287         }
288     }
289
290     vlc_object_destroy( p_libvlc_global->p_module_bank );
291     p_libvlc_global->p_module_bank = NULL;
292 }
293
294 /*****************************************************************************
295  * module_LoadMain: load the main program info into the module bank.
296  *****************************************************************************
297  * This function fills the module bank structure with the main module infos.
298  * This is very useful as it will allow us to consider the main program just
299  * as another module, and for instance the configuration options of main will
300  * be available in the module bank structure just as for every other module.
301  *****************************************************************************/
302 static void module_LoadMain( vlc_object_t *p_this )
303 {
304     vlc_value_t lockval;
305     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
306
307     var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
308     var_Get( p_libvlc_global, "libvlc", &lockval );
309     vlc_mutex_lock( lockval.p_address );
310     if( p_libvlc_global->p_module_bank->b_main )
311     {
312         vlc_mutex_unlock( lockval.p_address );
313         var_Destroy( p_libvlc_global, "libvlc" );
314         return;
315     }
316     p_libvlc_global->p_module_bank->b_main = VLC_TRUE;
317     vlc_mutex_unlock( lockval.p_address );
318     var_Destroy( p_libvlc_global, "libvlc" );
319
320     AllocateBuiltinModule( p_this, vlc_entry__main );
321 }
322
323 /*****************************************************************************
324  * module_LoadBuiltins: load all modules which we built with.
325  *****************************************************************************
326  * This function fills the module bank structure with the builtin modules.
327  *****************************************************************************/
328 void __module_LoadBuiltins( vlc_object_t * p_this )
329 {
330     vlc_value_t lockval;
331     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
332
333     var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
334     var_Get( p_libvlc_global, "libvlc", &lockval );
335     vlc_mutex_lock( lockval.p_address );
336     if( p_libvlc_global->p_module_bank->b_builtins )
337     {
338         vlc_mutex_unlock( lockval.p_address );
339         var_Destroy( p_libvlc_global, "libvlc" );
340         return;
341     }
342     p_libvlc_global->p_module_bank->b_builtins = VLC_TRUE;
343     vlc_mutex_unlock( lockval.p_address );
344     var_Destroy( p_libvlc_global, "libvlc" );
345
346     msg_Dbg( p_this, "checking builtin modules" );
347     ALLOCATE_ALL_BUILTINS();
348 }
349
350 /*****************************************************************************
351  * module_LoadPlugins: load all plugin modules we can find.
352  *****************************************************************************
353  * This function fills the module bank structure with the plugin modules.
354  *****************************************************************************/
355 void __module_LoadPlugins( vlc_object_t * p_this )
356 {
357 #ifdef HAVE_DYNAMIC_PLUGINS
358     vlc_value_t lockval;
359     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
360
361     var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
362     var_Get( p_libvlc_global, "libvlc", &lockval );
363     vlc_mutex_lock( lockval.p_address );
364     if( p_libvlc_global->p_module_bank->b_plugins )
365     {
366         vlc_mutex_unlock( lockval.p_address );
367         var_Destroy( p_libvlc_global, "libvlc" );
368         return;
369     }
370     p_libvlc_global->p_module_bank->b_plugins = VLC_TRUE;
371     vlc_mutex_unlock( lockval.p_address );
372     var_Destroy( p_libvlc_global, "libvlc" );
373
374     msg_Dbg( p_this, "checking plugin modules" );
375
376     if( config_GetInt( p_this, "plugins-cache" ) )
377         p_libvlc_global->p_module_bank->b_cache = VLC_TRUE;
378
379     if( p_libvlc_global->p_module_bank->b_cache ||
380         p_libvlc_global->p_module_bank->b_cache_delete ) CacheLoad( p_this );
381
382     AllocateAllPlugins( p_this );
383 #endif
384 }
385
386 /*****************************************************************************
387  * module_IsCapable: checks whether a module implements a capability.
388  *****************************************************************************/
389 vlc_bool_t module_IsCapable( const module_t *m, const char *cap )
390 {
391     return !strcmp( m->psz_capability, cap );
392 }
393
394 /*****************************************************************************
395  * module_GetObjName: internal name of a module.
396  *****************************************************************************/
397 const char *module_GetObjName( const module_t *m )
398 {
399     return m->psz_object_name;
400 }
401
402 /*****************************************************************************
403  * module_GetName: human-friendly name of a module.
404  *****************************************************************************/
405 const char *module_GetName( const module_t *m, vlc_bool_t long_name )
406 {
407     if( long_name && ( m->psz_longname != NULL) )
408         return m->psz_longname;
409     
410     return m->psz_shortname ?: m->psz_object_name;
411 }
412
413 const char *module_GetHelp( const module_t *m )
414 {
415     return m->psz_help;
416 }
417
418 /*****************************************************************************
419  * module_Need: return the best module function, given a capability list.
420  *****************************************************************************
421  * This function returns the module that best fits the asked capabilities.
422  *****************************************************************************/
423 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
424                           const char *psz_name, vlc_bool_t b_strict )
425 {
426     typedef struct module_list_t module_list_t;
427
428     struct module_list_t
429     {
430         module_t *p_module;
431         int i_score;
432         vlc_bool_t b_force;
433         module_list_t *p_next;
434     };
435
436     module_list_t *p_list, *p_first, *p_tmp;
437     vlc_list_t *p_all;
438
439     int i_which_module, i_index = 0;
440     vlc_bool_t b_intf = VLC_FALSE;
441
442     module_t *p_module;
443
444     int   i_shortcuts = 0;
445     char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
446     vlc_bool_t b_force_backup = p_this->b_force;
447
448
449     /* Deal with variables */
450     if( psz_name && psz_name[0] == '$' )
451     {
452         vlc_value_t val;
453         var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
454         var_Get( p_this, psz_name + 1, &val );
455         psz_var = val.psz_string;
456         psz_name = psz_var;
457     }
458
459     /* Count how many different shortcuts were asked for */
460     if( psz_name && *psz_name )
461     {
462         char *psz_parser, *psz_last_shortcut;
463
464         /* If the user wants none, give him none. */
465         if( !strcmp( psz_name, "none" ) )
466         {
467             free( psz_var );
468             return NULL;
469         }
470
471         i_shortcuts++;
472         psz_shortcuts = psz_last_shortcut = strdup( psz_name );
473
474         for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
475         {
476             if( *psz_parser == ',' )
477             {
478                  *psz_parser = '\0';
479                  i_shortcuts++;
480                  psz_last_shortcut = psz_parser + 1;
481             }
482         }
483
484         /* Check if the user wants to override the "strict" mode */
485         if( psz_last_shortcut )
486         {
487             if( !strcmp(psz_last_shortcut, "none") )
488             {
489                 b_strict = VLC_TRUE;
490                 i_shortcuts--;
491             }
492             else if( !strcmp(psz_last_shortcut, "any") )
493             {
494                 b_strict = VLC_FALSE;
495                 i_shortcuts--;
496             }
497         }
498     }
499
500     /* Sort the modules and test them */
501     p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
502     p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
503     p_first = NULL;
504     unsigned i_cpu = vlc_CPU();
505
506     /* Parse the module list for capabilities and probe each of them */
507     for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
508     {
509         int i_shortcut_bonus = 0;
510
511         p_module = (module_t *)p_all->p_values[i_which_module].p_object;
512
513         /* Test that this module can do what we need */
514         if( !module_IsCapable( p_module, psz_capability ) )
515         {
516             /* Don't recurse through the sub-modules because vlc_list_find()
517              * will list them anyway. */
518             continue;
519         }
520
521         /* Test if we have the required CPU */
522         if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
523         {
524             continue;
525         }
526
527         /* If we required a shortcut, check this plugin provides it. */
528         if( i_shortcuts > 0 )
529         {
530             vlc_bool_t b_trash;
531             const char *psz_name = psz_shortcuts;
532
533             /* Let's drop modules with a <= 0 score (unless they are
534              * explicitly requested) */
535             b_trash = p_module->i_score <= 0;
536
537             for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
538             {
539                 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
540                 {
541                     char *c;
542                     if( ( c = strchr( psz_name, '@' ) )
543                         ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
544                                         c-psz_name )
545                         : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
546                     {
547                         /* Found it */
548                         if( c && c[1] )
549                             psz_alias = c+1;
550                         i_shortcut_bonus = i_short * 10000;
551                         goto found_shortcut;
552                     }
553                 }
554
555                 /* Go to the next shortcut... This is so lame! */
556                 psz_name += strlen( psz_name ) + 1;
557             }
558
559             /* If we are in "strict" mode and we couldn't
560              * find the module in the list of provided shortcuts,
561              * then kick the bastard out of here!!! */
562             if( b_strict )
563                 continue;
564         }
565         /* If we didn't require a shortcut, trash <= 0 scored plugins */
566         else if( p_module->i_score <= 0 )
567         {
568             continue;
569         }
570
571 found_shortcut:
572
573         /* Special case: test if we requested a particular intf plugin */
574         if( !i_shortcuts && p_module->psz_program
575              && !strcmp( psz_capability, "interface" )
576              && !strcmp( p_module->psz_program,
577                          p_this->p_libvlc->psz_object_name ) )
578         {
579             if( !b_intf )
580             {
581                 /* Remove previous non-matching plugins */
582                 i_index = 0;
583                 b_intf = VLC_TRUE;
584             }
585         }
586         else if( b_intf )
587         {
588             /* This one doesn't match */
589             continue;
590         }
591
592         /* Store this new module */
593         p_list[ i_index ].p_module = p_module;
594         p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
595         p_list[ i_index ].b_force = i_shortcut_bonus && b_strict;
596
597         /* Add it to the modules-to-probe list */
598         if( i_index == 0 )
599         {
600             p_list[ 0 ].p_next = NULL;
601             p_first = p_list;
602         }
603         else
604         {
605             /* Ok, so at school you learned that quicksort is quick, and
606              * bubble sort sucks raw eggs. But that's when dealing with
607              * thousands of items. Here we have barely 50. */
608             module_list_t *p_newlist = p_first;
609
610             if( p_first->i_score < p_list[ i_index ].i_score )
611             {
612                 p_list[ i_index ].p_next = p_first;
613                 p_first = &p_list[ i_index ];
614             }
615             else
616             {
617                 while( p_newlist->p_next != NULL &&
618                     p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
619                 {
620                     p_newlist = p_newlist->p_next;
621                 }
622
623                 p_list[ i_index ].p_next = p_newlist->p_next;
624                 p_newlist->p_next = &p_list[ i_index ];
625             }
626         }
627
628         i_index++;
629     }
630
631     msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
632                                             i_index, i_index == 1 ? "" : "s" );
633
634     /* Lock all candidate modules */
635     p_tmp = p_first;
636     while( p_tmp != NULL )
637     {
638         vlc_object_yield( p_tmp->p_module );
639         p_tmp = p_tmp->p_next;
640     }
641
642     /* We can release the list, interesting modules were yielded */
643     vlc_list_release( p_all );
644
645     /* Parse the linked list and use the first successful module */
646     p_tmp = p_first;
647     while( p_tmp != NULL )
648     {
649 #ifdef HAVE_DYNAMIC_PLUGINS
650         /* Make sure the module is loaded in mem */
651         module_t *p_module = p_tmp->p_module;
652         if( p_module->b_submodule )
653             p_module = (module_t *)p_module->p_parent;
654
655         if( !p_module->b_builtin && !p_module->b_loaded )
656         {
657             module_t *p_new_module =
658                 AllocatePlugin( p_this, p_module->psz_filename );
659             if( p_new_module )
660             {
661                 CacheMerge( p_this, p_module, p_new_module );
662                 vlc_object_attach( p_new_module, p_module );
663                 DeleteModule( p_new_module, VLC_TRUE );
664             }
665         }
666 #endif
667
668         p_this->b_force = p_tmp->b_force;
669         if( p_tmp->p_module->pf_activate
670              && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
671         {
672             break;
673         }
674
675         vlc_object_release( p_tmp->p_module );
676         p_tmp = p_tmp->p_next;
677     }
678
679     /* Store the locked module value */
680     if( p_tmp != NULL )
681     {
682         p_module = p_tmp->p_module;
683         p_tmp = p_tmp->p_next;
684     }
685     else
686     {
687         p_module = NULL;
688     }
689
690     /* Unlock the remaining modules */
691     while( p_tmp != NULL )
692     {
693         vlc_object_release( p_tmp->p_module );
694         p_tmp = p_tmp->p_next;
695     }
696
697     free( p_list );
698     p_this->b_force = b_force_backup;
699
700     if( p_module != NULL )
701     {
702         msg_Dbg( p_this, "using %s module \"%s\"",
703                  psz_capability, p_module->psz_object_name );
704     }
705     else if( p_first == NULL )
706     {
707         if( !strcmp( psz_capability, "access_demux" ) )
708         {
709             msg_Warn( p_this, "no %s module matched \"%s\"",
710                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
711         }
712         else
713         {
714             msg_Err( p_this, "no %s module matched \"%s\"",
715                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
716
717             msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
718                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
719         }
720     }
721     else if( psz_name != NULL && *psz_name )
722     {
723         msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
724                   psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
725     }
726     else
727         msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
728
729     if( p_module && !p_this->psz_object_name )
730     {
731         /* This assumes that p_this is the object which will be using the
732          * module. That's not always the case ... but it is in most cases.
733          */
734         if( psz_alias )
735             p_this->psz_object_name = strdup( psz_alias );
736         else
737             p_this->psz_object_name = strdup( p_module->psz_object_name );
738     }
739
740     free( psz_shortcuts );
741     free( psz_var );
742
743     /* Don't forget that the module is still locked */
744     return p_module;
745 }
746
747 /*****************************************************************************
748  * module_Unneed: decrease the usage count of a module.
749  *****************************************************************************
750  * This function must be called by the thread that called module_Need, to
751  * decrease the reference count and allow for hiding of modules.
752  *****************************************************************************/
753 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
754 {
755     /* Use the close method */
756     if( p_module->pf_deactivate )
757     {
758         p_module->pf_deactivate( p_this );
759     }
760
761     msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
762
763     vlc_object_release( p_module );
764
765     return;
766 }
767
768 /*****************************************************************************
769  * module_Exists: tell if a module exists.
770  *****************************************************************************
771  * This function is a boolean function that tells if a module exist or not.
772  *****************************************************************************/
773
774 vlc_bool_t __module_Exists(  vlc_object_t *p_this, const char * psz_name )
775 {
776     vlc_list_t *p_list;
777     int i;
778     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
779     for( i = 0 ; i < p_list->i_count; i++)
780     {
781         const char *psz_module_name =
782             ((module_t *) p_list->p_values[i].p_object)->psz_shortname;
783         if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
784         {
785             /* We can release the list, and return yes */
786             vlc_list_release( p_list ); return VLC_TRUE;
787         }
788     }
789     vlc_list_release( p_list ); return VLC_FALSE;
790 }
791
792
793 /*****************************************************************************
794  * Following functions are local.
795  *****************************************************************************/
796
797 /*****************************************************************************
798  * AllocateAllPlugins: load all plugin modules we can find.
799  *****************************************************************************/
800 #ifdef HAVE_DYNAMIC_PLUGINS
801 static void AllocateAllPlugins( vlc_object_t *p_this )
802 {
803     /* Yes, there are two NULLs because we replace one with "plugin-path". */
804 #if defined( WIN32 ) || defined( UNDER_CE )
805     const char *path[] = { "modules", "", "plugins", NULL, NULL };
806 #else
807     const char *path[] = { "modules", PLUGIN_PATH, "plugins", NULL, NULL };
808 #endif
809
810     const char *const *ppsz_path;
811
812     /* If the user provided a plugin path, we add it to the list */
813     char *userpath = config_GetPsz( p_this, "plugin-path" );
814     path[sizeof(path)/sizeof(path[0]) - 2] = userpath;
815
816     for (ppsz_path = path; *ppsz_path != NULL; ppsz_path++)
817     {
818         char *psz_fullpath;
819
820         if (!**ppsz_path) continue;
821
822 #if defined( SYS_BEOS ) || defined( __APPLE__ ) || defined( WIN32 )
823
824         /* Handle relative as well as absolute paths */
825 #ifdef WIN32
826         if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
827             (*ppsz_path)[1] != ':' )
828 #else
829         if( (*ppsz_path)[0] != '/' )
830 #endif
831         {
832             if( 0>= asprintf( &psz_fullpath, "%s"DIR_SEP"%s",
833                               vlc_global( p_this )->psz_vlcpath, *ppsz_path) )
834                 psz_fullpath = NULL;
835         }
836         else
837 #endif
838             psz_fullpath = strdup( *ppsz_path );
839
840         if( psz_fullpath == NULL )
841             continue;
842
843         msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
844
845         /* Don't go deeper than 5 subdirectories */
846         AllocatePluginDir( p_this, psz_fullpath, 5 );
847
848         free( psz_fullpath );
849     }
850
851     /* Free plugin-path */
852     free( userpath );
853 }
854
855 /*****************************************************************************
856  * AllocatePluginDir: recursively parse a directory to look for plugins
857  *****************************************************************************/
858 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
859                                int i_maxdepth )
860 {
861 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
862 #ifdef WIN32
863 # undef opendir
864 # undef closedir
865 # undef readdir
866 #endif
867 #if defined( UNDER_CE ) || defined( _MSC_VER )
868 #ifdef UNDER_CE
869     wchar_t psz_wpath[MAX_PATH + 256];
870     wchar_t psz_wdir[MAX_PATH];
871 #endif
872     char psz_path[MAX_PATH + 256];
873     WIN32_FIND_DATA finddata;
874     HANDLE handle;
875     int rc;
876 #else
877     int    i_dirlen;
878     DIR *  dir;
879     struct dirent * file;
880 #endif
881     char * psz_file;
882
883     if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
884     {
885         return;
886     }
887
888 #if defined( UNDER_CE ) || defined( _MSC_VER )
889 #ifdef UNDER_CE
890     MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
891
892     rc = GetFileAttributes( psz_wdir );
893     if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
894
895     /* Parse all files in the directory */
896     swprintf( psz_wpath, L"%ls\\*", psz_wdir );
897 #else
898     rc = GetFileAttributes( psz_dir );
899     if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
900 #endif
901
902     /* Parse all files in the directory */
903     sprintf( psz_path, "%s\\*", psz_dir );
904
905 #ifdef UNDER_CE
906     handle = FindFirstFile( psz_wpath, &finddata );
907 #else
908     handle = FindFirstFile( psz_path, &finddata );
909 #endif
910     if( handle == INVALID_HANDLE_VALUE )
911     {
912         /* Empty directory */
913         return;
914     }
915
916     /* Parse the directory and try to load all files it contains. */
917     do
918     {
919 #ifdef UNDER_CE
920         unsigned int i_len = wcslen( finddata.cFileName );
921         swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
922         sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
923 #else
924         unsigned int i_len = strlen( finddata.cFileName );
925         sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
926 #endif
927
928         /* Skip ".", ".." */
929         if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
930          || !strcmp( finddata.cFileName, ".." ) )
931         {
932             if( !FindNextFile( handle, &finddata ) ) break;
933             continue;
934         }
935
936 #ifdef UNDER_CE
937         if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
938 #else
939         if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
940 #endif
941         {
942             AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
943         }
944         else if( i_len > strlen( LIBEXT )
945                   /* We only load files ending with LIBEXT */
946                   && !strncasecmp( psz_path + strlen( psz_path)
947                                    - strlen( LIBEXT ),
948                                    LIBEXT, strlen( LIBEXT ) ) )
949         {
950             WIN32_FILE_ATTRIBUTE_DATA attrbuf;
951             int64_t i_time = 0, i_size = 0;
952
953 #ifdef UNDER_CE
954             if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
955                                      &attrbuf ) )
956 #else
957             if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
958                                      &attrbuf ) )
959 #endif
960             {
961                 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
962                 i_time <<= 32;
963                 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
964                 i_size = attrbuf.nFileSizeHigh;
965                 i_size <<= 32;
966                 i_size |= attrbuf.nFileSizeLow;
967             }
968             psz_file = psz_path;
969
970             AllocatePluginFile( p_this, psz_file, i_time, i_size );
971         }
972     }
973     while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
974
975     /* Close the directory */
976     FindClose( handle );
977
978 #else
979     dir = opendir( psz_dir );
980     if( !dir )
981     {
982         return;
983     }
984
985     i_dirlen = strlen( psz_dir );
986
987     /* Parse the directory and try to load all files it contains. */
988     while( !p_this->p_libvlc->b_die && (file = readdir( dir )) )
989     {
990         struct stat statbuf;
991         unsigned int i_len;
992         int i_stat;
993
994         /* Skip ".", ".." */
995         if( !*file->d_name || !strcmp( file->d_name, "." )
996          || !strcmp( file->d_name, ".." ) )
997         {
998             continue;
999         }
1000
1001         i_len = strlen( file->d_name );
1002         psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1003 #ifdef WIN32
1004         sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
1005 #else
1006         sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
1007 #endif
1008
1009         i_stat = stat( psz_file, &statbuf );
1010         if( !i_stat && statbuf.st_mode & S_IFDIR )
1011         {
1012             AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
1013         }
1014         else if( i_len > strlen( LIBEXT )
1015                   /* We only load files ending with LIBEXT */
1016                   && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1017                                    LIBEXT, strlen( LIBEXT ) ) )
1018         {
1019             int64_t i_time = 0, i_size = 0;
1020
1021             if( !i_stat )
1022             {
1023                 i_time = statbuf.st_mtime;
1024                 i_size = statbuf.st_size;
1025             }
1026
1027             AllocatePluginFile( p_this, psz_file, i_time, i_size );
1028         }
1029
1030         free( psz_file );
1031     }
1032
1033     /* Close the directory */
1034     closedir( dir );
1035
1036 #endif
1037 }
1038
1039 /*****************************************************************************
1040  * AllocatePluginFile: load a module into memory and initialize it.
1041  *****************************************************************************
1042  * This function loads a dynamically loadable module and allocates a structure
1043  * for its information data. The module can then be handled by module_Need
1044  * and module_Unneed. It can be removed by DeleteModule.
1045  *****************************************************************************/
1046 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
1047                                int64_t i_file_time, int64_t i_file_size )
1048 {
1049     module_t * p_module = NULL;
1050     module_cache_t *p_cache_entry = NULL;
1051
1052     /*
1053      * Check our plugins cache first then load plugin if needed
1054      */
1055     p_cache_entry =
1056         CacheFind( p_this, psz_file, i_file_time, i_file_size );
1057
1058     if( !p_cache_entry )
1059     {
1060         p_module = AllocatePlugin( p_this, psz_file );
1061     }
1062     else
1063     {
1064         /* If junk dll, don't try to load it */
1065         if( p_cache_entry->b_junk )
1066         {
1067             p_module = NULL;
1068         }
1069         else
1070         {
1071             module_config_t *p_item = NULL, *p_end = NULL;
1072
1073             p_module = p_cache_entry->p_module;
1074             p_module->b_loaded = VLC_FALSE;
1075
1076             /* For now we force loading if the module's config contains
1077              * callbacks or actions.
1078              * Could be optimized by adding an API call.*/
1079             for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1080                  p_item < p_end; p_item++ )
1081             {
1082                 if( p_item->pf_callback || p_item->i_action )
1083                 {
1084                     p_module = AllocatePlugin( p_this, psz_file );
1085                     break;
1086                 }
1087             }
1088             if( p_module == p_cache_entry->p_module )
1089                 p_cache_entry->b_used = VLC_TRUE;
1090         }
1091     }
1092
1093     if( p_module )
1094     {
1095         libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1096
1097         /* Everything worked fine !
1098          * The module is ready to be added to the list. */
1099         p_module->b_builtin = VLC_FALSE;
1100
1101         /* msg_Dbg( p_this, "plugin \"%s\", %s",
1102                     p_module->psz_object_name, p_module->psz_longname ); */
1103
1104         vlc_object_attach( p_module, p_libvlc_global->p_module_bank );
1105
1106         if( !p_libvlc_global->p_module_bank->b_cache )
1107             return 0;
1108
1109 #define p_bank p_libvlc_global->p_module_bank
1110         /* Add entry to cache */
1111         p_bank->pp_cache =
1112             realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1113         p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1114         if( !p_bank->pp_cache[p_bank->i_cache] )
1115             return -1;
1116         p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1117         p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1118         p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1119         p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1120         p_bank->pp_cache[p_bank->i_cache]->b_used = VLC_TRUE;
1121         p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1122         p_bank->i_cache++;
1123     }
1124
1125     return p_module ? 0 : -1;
1126 }
1127
1128 /*****************************************************************************
1129  * AllocatePlugin: load a module into memory and initialize it.
1130  *****************************************************************************
1131  * This function loads a dynamically loadable module and allocates a structure
1132  * for its information data. The module can then be handled by module_Need
1133  * and module_Unneed. It can be removed by DeleteModule.
1134  *****************************************************************************/
1135 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1136 {
1137     module_t * p_module = NULL;
1138     module_handle_t handle;
1139
1140     if( LoadModule( p_this, psz_file, &handle ) )
1141         return NULL;
1142
1143     /* Now that we have successfully loaded the module, we can
1144      * allocate a structure for it */
1145     p_module = vlc_module_create( p_this );
1146     if( p_module == NULL )
1147     {
1148         msg_Err( p_this, "out of memory" );
1149         CloseModule( handle );
1150         return NULL;
1151     }
1152
1153     /* We need to fill these since they may be needed by CallEntry() */
1154     p_module->psz_filename = psz_file;
1155     p_module->handle = handle;
1156     p_module->b_loaded = VLC_TRUE;
1157
1158     /* Initialize the module: fill p_module, default config */
1159     if( CallEntry( p_module ) != 0 )
1160     {
1161         /* We couldn't call module_init() */
1162         vlc_object_destroy( p_module );
1163         CloseModule( handle );
1164         return NULL;
1165     }
1166
1167     DupModule( p_module );
1168     p_module->psz_filename = strdup( p_module->psz_filename );
1169
1170     /* Everything worked fine ! The module is ready to be added to the list. */
1171     p_module->b_builtin = VLC_FALSE;
1172
1173     return p_module;
1174 }
1175
1176 /*****************************************************************************
1177  * DupModule: make a plugin module standalone.
1178  *****************************************************************************
1179  * This function duplicates all strings in the module, so that the dynamic
1180  * object can be unloaded. It acts recursively on submodules.
1181  *****************************************************************************/
1182 static void DupModule( module_t *p_module )
1183 {
1184     const char **pp_shortcut;
1185     int i_submodule;
1186
1187     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1188     {
1189         *pp_shortcut = strdup( *pp_shortcut );
1190     }
1191
1192     /* We strdup() these entries so that they are still valid when the
1193      * module is unloaded. */
1194     p_module->psz_object_name = strdup( p_module->psz_object_name );
1195     p_module->psz_capability = strdup( p_module->psz_capability );
1196     p_module->psz_shortname = p_module->psz_shortname ?
1197                                  strdup( p_module->psz_shortname ) : NULL;
1198     p_module->psz_longname = strdup( p_module->psz_longname );
1199     p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1200                                             : NULL;
1201
1202     if( p_module->psz_program != NULL )
1203     {
1204         p_module->psz_program = strdup( p_module->psz_program );
1205     }
1206
1207     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1208     {
1209         DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1210     }
1211 }
1212
1213 /*****************************************************************************
1214  * UndupModule: free a duplicated module.
1215  *****************************************************************************
1216  * This function frees the allocations done in DupModule().
1217  *****************************************************************************/
1218 static void UndupModule( module_t *p_module )
1219 {
1220     const char **pp_shortcut;
1221     int i_submodule;
1222
1223     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1224     {
1225         UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1226     }
1227
1228     for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1229     {
1230         free( (void*)*pp_shortcut );
1231     }
1232
1233     free( (void*)p_module->psz_object_name );
1234     free( p_module->psz_capability );
1235     free( (void*)p_module->psz_shortname );
1236     free( (void*)p_module->psz_longname );
1237     free( (void*)p_module->psz_help );
1238     free( (void*)p_module->psz_program );
1239 }
1240
1241 #endif /* HAVE_DYNAMIC_PLUGINS */
1242
1243 /*****************************************************************************
1244  * AllocateBuiltinModule: initialize a builtin module.
1245  *****************************************************************************
1246  * This function registers a builtin module and allocates a structure
1247  * for its information data. The module can then be handled by module_Need
1248  * and module_Unneed. It can be removed by DeleteModule.
1249  *****************************************************************************/
1250 static int AllocateBuiltinModule( vlc_object_t * p_this,
1251                                   int ( *pf_entry ) ( module_t * ) )
1252 {
1253     module_t * p_module;
1254
1255     /* Now that we have successfully loaded the module, we can
1256      * allocate a structure for it */
1257     p_module = vlc_module_create( p_this );
1258     if( p_module == NULL )
1259     {
1260         msg_Err( p_this, "out of memory" );
1261         return -1;
1262     }
1263
1264     /* Initialize the module : fill p_module->psz_object_name, etc. */
1265     if( pf_entry( p_module ) != 0 )
1266     {
1267         /* With a well-written module we shouldn't have to print an
1268          * additional error message here, but just make sure. */
1269         msg_Err( p_this, "failed calling entry point in builtin module" );
1270         vlc_object_destroy( p_module );
1271         return -1;
1272     }
1273
1274     /* Everything worked fine ! The module is ready to be added to the list. */
1275     p_module->b_builtin = VLC_TRUE;
1276
1277     /* msg_Dbg( p_this, "builtin \"%s\", %s",
1278                 p_module->psz_object_name, p_module->psz_longname ); */
1279
1280     vlc_object_attach( p_module, vlc_global( p_this )->p_module_bank );
1281
1282     return 0;
1283 }
1284
1285 /*****************************************************************************
1286  * DeleteModule: delete a module and its structure.
1287  *****************************************************************************
1288  * This function can only be called if the module isn't being used.
1289  *****************************************************************************/
1290 static int DeleteModule( module_t * p_module, vlc_bool_t b_detach )
1291 {
1292     if( !p_module ) return VLC_EGENERIC;
1293     if( b_detach )
1294         vlc_object_detach( p_module );
1295
1296     /* We free the structures that we strdup()ed in Allocate*Module(). */
1297 #ifdef HAVE_DYNAMIC_PLUGINS
1298     if( !p_module->b_builtin )
1299     {
1300         if( p_module->b_loaded && p_module->b_unloadable )
1301         {
1302             CloseModule( p_module->handle );
1303         }
1304         UndupModule( p_module );
1305         free( p_module->psz_filename );
1306     }
1307 #endif
1308
1309     /* Free and detach the object's children */
1310     while( p_module->i_children )
1311     {
1312         vlc_object_t *p_this = p_module->pp_children[0];
1313         vlc_object_detach( p_this );
1314         vlc_object_destroy( p_this );
1315     }
1316
1317     config_Free( p_module );
1318     vlc_object_destroy( p_module );
1319     p_module = NULL;
1320     return 0;
1321 }
1322
1323 #ifdef HAVE_DYNAMIC_PLUGINS
1324 /*****************************************************************************
1325  * CallEntry: call an entry point.
1326  *****************************************************************************
1327  * This function calls a symbol given its name and a module structure. The
1328  * symbol MUST refer to a function returning int and taking a module_t* as
1329  * an argument.
1330  *****************************************************************************/
1331 static int CallEntry( module_t * p_module )
1332 {
1333     static const char psz_name[] = "vlc_entry" MODULE_SUFFIX;
1334     int (* pf_symbol) ( module_t * p_module );
1335
1336     /* Try to resolve the symbol */
1337     pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1338
1339     if( pf_symbol == NULL )
1340     {
1341 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1342         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1343                             psz_name, p_module->psz_filename );
1344 #elif defined(HAVE_DL_WINDOWS)
1345         char *psz_error = GetWindowsError();
1346         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1347                             psz_name, p_module->psz_filename, psz_error );
1348         free( psz_error );
1349 #elif defined(HAVE_DL_DLOPEN)
1350         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1351                             psz_name, p_module->psz_filename, dlerror() );
1352 #elif defined(HAVE_DL_SHL_LOAD)
1353         msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1354                             psz_name, p_module->psz_filename, strerror(errno) );
1355 #else
1356 #   error "Something is wrong in modules.c"
1357 #endif
1358         return -1;
1359     }
1360
1361     /* We can now try to call the symbol */
1362     if( pf_symbol( p_module ) != 0 )
1363     {
1364         /* With a well-written module we shouldn't have to print an
1365          * additional error message here, but just make sure. */
1366         msg_Err( p_module, "Failed to call symbol \"%s\" in file `%s'",
1367                            psz_name, p_module->psz_filename );
1368         return -1;
1369     }
1370
1371     /* Everything worked fine, we can return */
1372     return 0;
1373 }
1374
1375 /*****************************************************************************
1376  * LoadModule: loads a dynamic library
1377  *****************************************************************************
1378  * This function loads a dynamically linked library using a system dependant
1379  * method. Will return 0 on success as well as the module handle.
1380  *****************************************************************************/
1381 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1382                        module_handle_t *p_handle )
1383 {
1384     module_handle_t handle;
1385
1386 #if defined(HAVE_DL_DYLD)
1387     NSObjectFileImage image;
1388     NSObjectFileImageReturnCode ret;
1389
1390     ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1391
1392     if( ret != NSObjectFileImageSuccess )
1393     {
1394         msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1395         return -1;
1396     }
1397
1398     /* Open the dynamic module */
1399     handle = NSLinkModule( image, psz_file,
1400                            NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1401
1402     if( !handle )
1403     {
1404         NSLinkEditErrors errors;
1405         const char *psz_file, *psz_err;
1406         int i_errnum;
1407         NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1408         msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1409         NSDestroyObjectFileImage( image );
1410         return -1;
1411     }
1412
1413     /* Destroy our image, we won't need it */
1414     NSDestroyObjectFileImage( image );
1415
1416 #elif defined(HAVE_DL_BEOS)
1417     handle = load_add_on( psz_file );
1418     if( handle < 0 )
1419     {
1420         msg_Warn( p_this, "cannot load module `%s'", psz_file );
1421         return -1;
1422     }
1423
1424 #elif defined(HAVE_DL_WINDOWS)
1425 #ifdef UNDER_CE
1426     {
1427         wchar_t psz_wfile[MAX_PATH];
1428         MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1429         handle = LoadLibrary( psz_wfile );
1430     }
1431 #else
1432     handle = LoadLibrary( psz_file );
1433 #endif
1434     if( handle == NULL )
1435     {
1436         char *psz_err = GetWindowsError();
1437         msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1438         free( psz_err );
1439         return -1;
1440     }
1441
1442 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1443     /* static is OK, we are called atomically */
1444
1445 #   if defined(SYS_LINUX)
1446     /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1447      * are going to get namespace collisions when two modules have common
1448      * public symbols, but ALSA is being a pest here. */
1449     if( strstr( psz_file, "alsa_plugin" ) )
1450     {
1451         handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1452         if( handle == NULL )
1453         {
1454             msg_Warn( p_this, "cannot load module `%s' (%s)",
1455                               psz_file, dlerror() );
1456             return -1;
1457         }
1458     }
1459 #   endif
1460
1461     handle = dlopen( psz_file, RTLD_NOW );
1462     if( handle == NULL )
1463     {
1464         msg_Warn( p_this, "cannot load module `%s' (%s)",
1465                           psz_file, dlerror() );
1466         return -1;
1467     }
1468
1469 #elif defined(HAVE_DL_DLOPEN)
1470 #   if defined(DL_LAZY)
1471     handle = dlopen( psz_file, DL_LAZY );
1472 #   else
1473     handle = dlopen( psz_file, 0 );
1474 #   endif
1475     if( handle == NULL )
1476     {
1477         msg_Warn( p_this, "cannot load module `%s' (%s)",
1478                           psz_file, dlerror() );
1479         return -1;
1480     }
1481
1482 #elif defined(HAVE_DL_SHL_LOAD)
1483     handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1484     if( handle == NULL )
1485     {
1486         msg_Warn( p_this, "cannot load module `%s' (%s)",
1487                           psz_file, strerror(errno) );
1488         return -1;
1489     }
1490
1491 #else
1492 #   error "Something is wrong in modules.c"
1493
1494 #endif
1495
1496     *p_handle = handle;
1497     return 0;
1498 }
1499
1500 /*****************************************************************************
1501  * CloseModule: unload a dynamic library
1502  *****************************************************************************
1503  * This function unloads a previously opened dynamically linked library
1504  * using a system dependant method. No return value is taken in consideration,
1505  * since some libraries sometimes refuse to close properly.
1506  *****************************************************************************/
1507 static void CloseModule( module_handle_t handle )
1508 {
1509 #if defined(HAVE_DL_DYLD)
1510     NSUnLinkModule( handle, FALSE );
1511
1512 #elif defined(HAVE_DL_BEOS)
1513     unload_add_on( handle );
1514
1515 #elif defined(HAVE_DL_WINDOWS)
1516     FreeLibrary( handle );
1517
1518 #elif defined(HAVE_DL_DLOPEN)
1519 # ifndef NDEBUG
1520     dlclose( handle );
1521 # endif
1522
1523 #elif defined(HAVE_DL_SHL_LOAD)
1524     shl_unload( handle );
1525
1526 #endif
1527     return;
1528 }
1529
1530 /*****************************************************************************
1531  * GetSymbol: get a symbol from a dynamic library
1532  *****************************************************************************
1533  * This function queries a loaded library for a symbol specified in a
1534  * string, and returns a pointer to it. We don't check for dlerror() or
1535  * similar functions, since we want a non-NULL symbol anyway.
1536  *****************************************************************************/
1537 static void * _module_getsymbol( module_handle_t, const char * );
1538
1539 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1540 {
1541     void * p_symbol = _module_getsymbol( handle, psz_function );
1542
1543     /* MacOS X dl library expects symbols to begin with "_". So do
1544      * some other operating systems. That's really lame, but hey, what
1545      * can we do ? */
1546     if( p_symbol == NULL )
1547     {
1548         char psz_call[strlen( psz_function ) + 2];
1549
1550         psz_call[ 0 ] = '_';
1551         memcpy( psz_call + 1, psz_function, sizeof (psz_call) - 1 );
1552         p_symbol = _module_getsymbol( handle, psz_call );
1553     }
1554
1555     return p_symbol;
1556 }
1557
1558 static void * _module_getsymbol( module_handle_t handle,
1559                                  const char * psz_function )
1560 {
1561 #if defined(HAVE_DL_DYLD)
1562     NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1563     return NSAddressOfSymbol( sym );
1564
1565 #elif defined(HAVE_DL_BEOS)
1566     void * p_symbol;
1567     if( B_OK == get_image_symbol( handle, psz_function,
1568                                   B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1569     {
1570         return p_symbol;
1571     }
1572     else
1573     {
1574         return NULL;
1575     }
1576
1577 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1578     wchar_t psz_real[256];
1579     MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1580
1581     return (void *)GetProcAddress( handle, psz_real );
1582
1583 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1584     return (void *)GetProcAddress( handle, (char *)psz_function );
1585
1586 #elif defined(HAVE_DL_DLOPEN)
1587     return dlsym( handle, psz_function );
1588
1589 #elif defined(HAVE_DL_SHL_LOAD)
1590     void *p_sym;
1591     shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1592     return p_sym;
1593
1594 #endif
1595 }
1596
1597 #if defined(HAVE_DL_WINDOWS)
1598 static char * GetWindowsError( void )
1599 {
1600 #if defined(UNDER_CE)
1601     wchar_t psz_tmp[MAX_PATH];
1602     char * psz_buffer = malloc( MAX_PATH );
1603 #else
1604     char * psz_tmp = malloc( MAX_PATH );
1605 #endif
1606     int i = 0, i_error = GetLastError();
1607
1608     FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1609                    NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1610                    (LPTSTR)psz_tmp, MAX_PATH, NULL );
1611
1612     /* Go to the end of the string */
1613     while( psz_tmp[i] && psz_tmp[i] != _T('\r') && psz_tmp[i] != _T('\n') )
1614     {
1615         i++;
1616     }
1617
1618     if( psz_tmp[i] )
1619     {
1620 #if defined(UNDER_CE)
1621         swprintf( psz_tmp + i, L" (error %i)", i_error );
1622         psz_tmp[ 255 ] = L'\0';
1623 #else
1624         snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1625         psz_tmp[ 255 ] = '\0';
1626 #endif
1627     }
1628
1629 #if defined(UNDER_CE)
1630     wcstombs( psz_buffer, psz_tmp, MAX_PATH );
1631     return psz_buffer;
1632 #else
1633     return psz_tmp;
1634 #endif
1635 }
1636 #endif /* HAVE_DL_WINDOWS */
1637
1638 /*****************************************************************************
1639  * LoadPluginsCache: loads the plugins cache file
1640  *****************************************************************************
1641  * This function will load the plugin cache if present and valid. This cache
1642  * will in turn be queried by AllocateAllPlugins() to see if it needs to
1643  * actually load the dynamically loadable module.
1644  * This allows us to only fully load plugins when they are actually used.
1645  *****************************************************************************/
1646 static void CacheLoad( vlc_object_t *p_this )
1647 {
1648     char *psz_filename, *psz_homedir;
1649     FILE *file;
1650     int i, j, i_size, i_read;
1651     char p_cachestring[sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE)];
1652     char p_cachelang[6], p_lang[6];
1653     int i_cache;
1654     module_cache_t **pp_cache = 0;
1655     int32_t i_file_size, i_marker;
1656     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1657
1658     psz_homedir = p_this->p_libvlc->psz_homedir;
1659     if( !psz_homedir )
1660     {
1661         msg_Err( p_this, "psz_homedir is null" );
1662         return;
1663     }
1664
1665     i_size = asprintf( &psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1666                        PLUGINSCACHE_DIR, CacheName() );
1667     if( i_size <= 0 )
1668     {
1669         msg_Err( p_this, "out of memory" );
1670         return;
1671     }
1672
1673     if( p_libvlc_global->p_module_bank->b_cache_delete )
1674     {
1675 #if !defined( UNDER_CE )
1676         unlink( psz_filename );
1677 #else
1678         wchar_t psz_wf[MAX_PATH];
1679         MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
1680         DeleteFile( psz_wf );
1681 #endif
1682         msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1683         free( psz_filename );
1684         return;
1685     }
1686
1687     msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1688
1689     file = utf8_fopen( psz_filename, "rb" );
1690     if( !file )
1691     {
1692         msg_Warn( p_this, "could not open plugins cache file %s for reading",
1693                   psz_filename );
1694         free( psz_filename );
1695         return;
1696     }
1697     free( psz_filename );
1698
1699     /* Check the file size */
1700     i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
1701     if( i_read != sizeof(i_file_size) )
1702     {
1703         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1704                   "(too short)" );
1705         fclose( file );
1706         return;
1707     }
1708
1709     fseek( file, 0, SEEK_END );
1710     if( ftell( file ) != i_file_size )
1711     {
1712         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1713                   "(corrupted size)" );
1714         fclose( file );
1715         return;
1716     }
1717     fseek( file, sizeof(i_file_size), SEEK_SET );
1718
1719     /* Check the file is a plugins cache */
1720     i_size = sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE) - 1;
1721     i_read = fread( p_cachestring, 1, i_size, file );
1722     if( i_read != i_size ||
1723         memcmp( p_cachestring, PLUGINSCACHE_DIR COPYRIGHT_MESSAGE, i_size ) )
1724     {
1725         msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1726         fclose( file );
1727         return;
1728     }
1729
1730     /* Check Sub-version number */
1731     i_read = fread( &i_marker, 1, sizeof(i_marker), file );
1732     if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
1733     {
1734         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1735                   "(corrupted header)" );
1736         fclose( file );
1737         return;
1738     }
1739
1740     /* Check the language hasn't changed */
1741     sprintf( p_lang, "%5.5s", _("C") ); i_size = 5;
1742     i_read = fread( p_cachelang, 1, i_size, file );
1743     if( i_read != i_size || memcmp( p_cachelang, p_lang, i_size ) )
1744     {
1745         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1746                   "(language changed)" );
1747         fclose( file );
1748         return;
1749     }
1750
1751     /* Check header marker */
1752     i_read = fread( &i_marker, 1, sizeof(i_marker), file );
1753     if( i_read != sizeof(i_marker) ||
1754         i_marker != ftell( file ) - (int)sizeof(i_marker) )
1755     {
1756         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1757                   "(corrupted header)" );
1758         fclose( file );
1759         return;
1760     }
1761
1762     p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1763     if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
1764     {
1765         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1766                   "(file too short)" );
1767         fclose( file );
1768         return;
1769     }
1770
1771     if( i_cache )
1772         pp_cache = p_libvlc_global->p_module_bank->pp_loaded_cache =
1773                    malloc( i_cache * sizeof(void *) );
1774
1775 #define LOAD_IMMEDIATE(a) \
1776     if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1777 #define LOAD_STRING(a) \
1778 { \
1779     a = NULL; \
1780     if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
1781      || ( i_size > 16384 ) ) \
1782         goto error; \
1783     if( i_size ) { \
1784         char *psz = malloc( i_size ); \
1785         if( fread( psz, i_size, 1, file ) != 1 ) { \
1786             free( psz ); \
1787             goto error; \
1788         } \
1789         if( psz[i_size-1] ) { \
1790             free( psz ); \
1791             goto error; \
1792         } \
1793         a = psz; \
1794     } \
1795 }
1796
1797     for( i = 0; i < i_cache; i++ )
1798     {
1799         uint16_t i_size;
1800         int i_submodules;
1801
1802         pp_cache[i] = malloc( sizeof(module_cache_t) );
1803         p_libvlc_global->p_module_bank->i_loaded_cache++;
1804
1805         /* Load common info */
1806         LOAD_STRING( pp_cache[i]->psz_file );
1807         LOAD_IMMEDIATE( pp_cache[i]->i_time );
1808         LOAD_IMMEDIATE( pp_cache[i]->i_size );
1809         LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1810         pp_cache[i]->b_used = VLC_FALSE;
1811
1812         if( pp_cache[i]->b_junk ) continue;
1813
1814         pp_cache[i]->p_module = vlc_module_create( p_this );
1815
1816         /* Load additional infos */
1817         LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1818         LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1819         LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1820         LOAD_STRING( pp_cache[i]->p_module->psz_help );
1821         LOAD_STRING( pp_cache[i]->p_module->psz_program );
1822         for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1823         {
1824             LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1825         }
1826         LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1827         LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1828         LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1829         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1830         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1831         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1832
1833         /* Config stuff */
1834         if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1835             goto error;
1836
1837         LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1838
1839         LOAD_IMMEDIATE( i_submodules );
1840
1841         while( i_submodules-- )
1842         {
1843             module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
1844             LOAD_STRING( p_module->psz_object_name );
1845             LOAD_STRING( p_module->psz_shortname );
1846             LOAD_STRING( p_module->psz_longname );
1847             LOAD_STRING( p_module->psz_help );
1848             LOAD_STRING( p_module->psz_program );
1849             for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1850             {
1851                 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1852             }
1853             LOAD_STRING( p_module->psz_capability );
1854             LOAD_IMMEDIATE( p_module->i_score );
1855             LOAD_IMMEDIATE( p_module->i_cpu );
1856             LOAD_IMMEDIATE( p_module->b_unloadable );
1857             LOAD_IMMEDIATE( p_module->b_reentrant );
1858         }
1859     }
1860
1861     fclose( file );
1862     return;
1863
1864  error:
1865
1866     msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1867
1868     /* TODO: cleanup */
1869     p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1870
1871     fclose( file );
1872     return;
1873 }
1874
1875
1876 int CacheLoadConfig( module_t *p_module, FILE *file )
1877 {
1878     uint32_t i_lines;
1879     uint16_t i_size;
1880
1881     /* Calculate the structure length */
1882     LOAD_IMMEDIATE( p_module->i_config_items );
1883     LOAD_IMMEDIATE( p_module->i_bool_items );
1884
1885     LOAD_IMMEDIATE( i_lines );
1886
1887     /* Allocate memory */
1888     if (i_lines)
1889     {
1890         p_module->p_config =
1891             (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
1892         if( p_module->p_config == NULL )
1893         {
1894             p_module->confsize = 0;
1895             msg_Err( p_module, "config error: can't duplicate p_config" );
1896             return VLC_ENOMEM;
1897         }
1898     }
1899     p_module->confsize = i_lines;
1900
1901     /* Do the duplication job */
1902     for (size_t i = 0; i < i_lines; i++ )
1903     {
1904         LOAD_IMMEDIATE( p_module->p_config[i] );
1905
1906         LOAD_STRING( p_module->p_config[i].psz_type );
1907         LOAD_STRING( p_module->p_config[i].psz_name );
1908         LOAD_STRING( p_module->p_config[i].psz_text );
1909         LOAD_STRING( p_module->p_config[i].psz_longtext );
1910         LOAD_STRING( p_module->p_config[i].psz_current );
1911
1912         if (IsConfigStringType (p_module->p_config[i].i_type))
1913         {
1914             LOAD_STRING (p_module->p_config[i].orig.psz);
1915             p_module->p_config[i].value.psz =
1916                     (p_module->p_config[i].orig.psz != NULL)
1917                         ? strdup (p_module->p_config[i].orig.psz) : NULL;
1918             p_module->p_config[i].saved.psz = NULL;
1919         }
1920         else
1921         {
1922             memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
1923                     sizeof (p_module->p_config[i].value));
1924             memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
1925                     sizeof (p_module->p_config[i].saved));
1926         }
1927
1928         p_module->p_config[i].b_dirty = VLC_FALSE;
1929
1930         p_module->p_config[i].p_lock = &p_module->object_lock;
1931
1932         if( p_module->p_config[i].i_list )
1933         {
1934             if( p_module->p_config[i].ppsz_list )
1935             {
1936                 int j;
1937                 p_module->p_config[i].ppsz_list =
1938                     malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1939                 if( p_module->p_config[i].ppsz_list )
1940                 {
1941                     for( j = 0; j < p_module->p_config[i].i_list; j++ )
1942                         LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1943                     p_module->p_config[i].ppsz_list[j] = NULL;
1944                 }
1945             }
1946             if( p_module->p_config[i].ppsz_list_text )
1947             {
1948                 int j;
1949                 p_module->p_config[i].ppsz_list_text =
1950                     malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1951                 if( p_module->p_config[i].ppsz_list_text )
1952                 {
1953                   for( j = 0; j < p_module->p_config[i].i_list; j++ )
1954                       LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1955                   p_module->p_config[i].ppsz_list_text[j] = NULL;
1956                 }
1957             }
1958             if( p_module->p_config[i].pi_list )
1959             {
1960                 p_module->p_config[i].pi_list =
1961                     malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1962                 if( p_module->p_config[i].pi_list )
1963                 {
1964                     for (int j = 0; j < p_module->p_config[i].i_list; j++)
1965                         LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1966                 }
1967             }
1968         }
1969
1970         if( p_module->p_config[i].i_action )
1971         {
1972             p_module->p_config[i].ppf_action =
1973                 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1974             p_module->p_config[i].ppsz_action_text =
1975                 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1976
1977             for (int j = 0; j < p_module->p_config[i].i_action; j++)
1978             {
1979                 p_module->p_config[i].ppf_action[j] = 0;
1980                 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1981             }
1982         }
1983
1984         LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1985     }
1986
1987     return VLC_SUCCESS;
1988
1989  error:
1990
1991     return VLC_EGENERIC;
1992 }
1993
1994 /*****************************************************************************
1995  * SavePluginsCache: saves the plugins cache to a file
1996  *****************************************************************************/
1997 static void CacheSave( vlc_object_t *p_this )
1998 {
1999     static char const psz_tag[] =
2000         "Signature: 8a477f597d28d172789f06886806bc55\r\n"
2001         "# This file is a cache directory tag created by VLC.\r\n"
2002         "# For information about cache directory tags, see:\r\n"
2003         "#   http://www.brynosaurus.com/cachedir/\r\n";
2004
2005     char *psz_filename, *psz_homedir;
2006     FILE *file;
2007     int i, j, i_cache;
2008     module_cache_t **pp_cache;
2009     int32_t i_file_size = 0;
2010     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
2011
2012     psz_homedir = p_this->p_libvlc->psz_homedir;
2013     if( !psz_homedir )
2014     {
2015         msg_Err( p_this, "psz_homedir is null" );
2016         return;
2017     }
2018     psz_filename =
2019        (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_DIR "/" ) +
2020                        strlen(psz_homedir) + strlen(CacheName()) );
2021
2022     if( !psz_filename )
2023     {
2024         msg_Err( p_this, "out of memory" );
2025         return;
2026     }
2027
2028     sprintf( psz_filename, "%s/%s", psz_homedir, CONFIG_DIR );
2029
2030     config_CreateDir( p_this, psz_filename );
2031
2032     strcat( psz_filename, "/" PLUGINSCACHE_DIR );
2033
2034     config_CreateDir( p_this, psz_filename );
2035
2036     strcat( psz_filename, "/CACHEDIR.TAG" );
2037
2038     file = utf8_fopen( psz_filename, "wb" );
2039     if( file )
2040     {
2041         fwrite( psz_tag, 1, strlen(psz_tag), file );
2042         fclose( file );
2043     }
2044
2045     sprintf( psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
2046              PLUGINSCACHE_DIR, CacheName() );
2047
2048     msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
2049
2050     file = utf8_fopen( psz_filename, "wb" );
2051     if( !file )
2052     {
2053         msg_Warn( p_this, "could not open plugins cache file %s for writing",
2054                   psz_filename );
2055         free( psz_filename );
2056         return;
2057     }
2058     free( psz_filename );
2059
2060     /* Empty space for file size */
2061     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2062
2063     /* Contains version number */
2064     fprintf( file, "%s", PLUGINSCACHE_DIR COPYRIGHT_MESSAGE );
2065
2066     /* Sub-version number (to avoid breakage in the dev version when cache
2067      * structure changes) */
2068     i_file_size = CACHE_SUBVERSION_NUM;
2069     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2070
2071     /* Language */
2072     fprintf( file, "%5.5s", _("C") );
2073
2074     /* Header marker */
2075     i_file_size = ftell( file );
2076     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2077
2078     i_cache = p_libvlc_global->p_module_bank->i_cache;
2079     pp_cache = p_libvlc_global->p_module_bank->pp_cache;
2080
2081     fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
2082
2083 #define SAVE_IMMEDIATE(a) \
2084     fwrite( &a, sizeof(char), sizeof(a), file )
2085 #define SAVE_STRING(a) \
2086     { i_size = a ? strlen( a ) + 1 : 0; \
2087       fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
2088       if( a ) fwrite( a, sizeof(char), i_size, file ); \
2089     } while(0)
2090
2091     for( i = 0; i < i_cache; i++ )
2092     {
2093         uint16_t i_size;
2094         uint32_t i_submodule;
2095
2096         /* Save common info */
2097         SAVE_STRING( pp_cache[i]->psz_file );
2098         SAVE_IMMEDIATE( pp_cache[i]->i_time );
2099         SAVE_IMMEDIATE( pp_cache[i]->i_size );
2100         SAVE_IMMEDIATE( pp_cache[i]->b_junk );
2101
2102         if( pp_cache[i]->b_junk ) continue;
2103
2104         /* Save additional infos */
2105         SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
2106         SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
2107         SAVE_STRING( pp_cache[i]->p_module->psz_longname );
2108         SAVE_STRING( pp_cache[i]->p_module->psz_help );
2109         SAVE_STRING( pp_cache[i]->p_module->psz_program );
2110         for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2111         {
2112             SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
2113         }
2114         SAVE_STRING( pp_cache[i]->p_module->psz_capability );
2115         SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
2116         SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
2117         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
2118         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
2119         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
2120
2121         /* Config stuff */
2122         CacheSaveConfig( pp_cache[i]->p_module, file );
2123
2124         SAVE_STRING( pp_cache[i]->p_module->psz_filename );
2125
2126         i_submodule = pp_cache[i]->p_module->i_children;
2127         SAVE_IMMEDIATE( i_submodule );
2128         for( i_submodule = 0;
2129              i_submodule < (unsigned)pp_cache[i]->p_module->i_children;
2130              i_submodule++ )
2131         {
2132             module_t *p_module =
2133                 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
2134
2135             SAVE_STRING( p_module->psz_object_name );
2136             SAVE_STRING( p_module->psz_shortname );
2137             SAVE_STRING( p_module->psz_longname );
2138             SAVE_STRING( p_module->psz_help );
2139             SAVE_STRING( p_module->psz_program );
2140             for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2141             {
2142                 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
2143             }
2144             SAVE_STRING( p_module->psz_capability );
2145             SAVE_IMMEDIATE( p_module->i_score );
2146             SAVE_IMMEDIATE( p_module->i_cpu );
2147             SAVE_IMMEDIATE( p_module->b_unloadable );
2148             SAVE_IMMEDIATE( p_module->b_reentrant );
2149         }
2150     }
2151
2152     /* Fill-up file size */
2153     i_file_size = ftell( file );
2154     fseek( file, 0, SEEK_SET );
2155     fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2156
2157     fclose( file );
2158
2159     return;
2160 }
2161
2162 void CacheSaveConfig( module_t *p_module, FILE *file )
2163 {
2164     uint32_t i_lines = p_module->confsize;
2165     uint16_t i_size;
2166
2167     SAVE_IMMEDIATE( p_module->i_config_items );
2168     SAVE_IMMEDIATE( p_module->i_bool_items );
2169     SAVE_IMMEDIATE( i_lines );
2170
2171     for (size_t i = 0; i < i_lines ; i++)
2172     {
2173         SAVE_IMMEDIATE( p_module->p_config[i] );
2174
2175         SAVE_STRING( p_module->p_config[i].psz_type );
2176         SAVE_STRING( p_module->p_config[i].psz_name );
2177         SAVE_STRING( p_module->p_config[i].psz_text );
2178         SAVE_STRING( p_module->p_config[i].psz_longtext );
2179         SAVE_STRING( p_module->p_config[i].psz_current );
2180         if (IsConfigStringType (p_module->p_config[i].i_type))
2181             SAVE_STRING( p_module->p_config[i].orig.psz );
2182
2183         if( p_module->p_config[i].i_list )
2184         {
2185             if( p_module->p_config[i].ppsz_list )
2186             {
2187                 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2188                     SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
2189             }
2190
2191             if( p_module->p_config[i].ppsz_list_text )
2192             {
2193                 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2194                     SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
2195             }
2196             if( p_module->p_config[i].pi_list )
2197             {
2198                 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2199                     SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
2200             }
2201         }
2202
2203         for (int j = 0; j < p_module->p_config[i].i_action; j++)
2204             SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
2205
2206         SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
2207     }
2208 }
2209
2210 /*****************************************************************************
2211  * CacheName: Return the cache file name for this platform.
2212  *****************************************************************************/
2213 static char *CacheName( void )
2214 {
2215     static char psz_cachename[32];
2216
2217     /* Code int size, pointer size and endianness in the filename */
2218     int32_t x = 0xbe00001e;
2219     sprintf( psz_cachename, "plugins-%.2x%.2x%.2x.dat", (int)sizeof(int),
2220              (int)sizeof(void *), (unsigned int)((unsigned char *)&x)[0] );
2221     return psz_cachename;
2222 }
2223
2224 /*****************************************************************************
2225  * CacheMerge: Merge a cache module descriptor with a full module descriptor.
2226  *****************************************************************************/
2227 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
2228                         module_t *p_module )
2229 {
2230     int i_submodule;
2231     (void)p_this;
2232
2233     p_cache->pf_activate = p_module->pf_activate;
2234     p_cache->pf_deactivate = p_module->pf_deactivate;
2235     p_cache->handle = p_module->handle;
2236
2237     for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
2238     {
2239         module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
2240         module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
2241         p_cchild->pf_activate = p_child->pf_activate;
2242         p_cchild->pf_deactivate = p_child->pf_deactivate;
2243     }
2244
2245     p_cache->b_loaded = VLC_TRUE;
2246     p_module->b_loaded = VLC_FALSE;
2247 }
2248
2249 /*****************************************************************************
2250  * CacheFind: finds the cache entry corresponding to a file
2251  *****************************************************************************/
2252 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2253                                   int64_t i_time, int64_t i_size )
2254 {
2255     module_cache_t **pp_cache;
2256     int i_cache, i;
2257     libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
2258
2259     pp_cache = p_libvlc_global->p_module_bank->pp_loaded_cache;
2260     i_cache = p_libvlc_global->p_module_bank->i_loaded_cache;
2261
2262     for( i = 0; i < i_cache; i++ )
2263     {
2264         if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2265             pp_cache[i]->i_time == i_time &&
2266             pp_cache[i]->i_size == i_size ) return pp_cache[i];
2267     }
2268
2269     return NULL;
2270 }
2271
2272 #endif /* HAVE_DYNAMIC_PLUGINS */