1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2007 the VideoLAN team
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>
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.
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.
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 *****************************************************************************/
28 #include "../libvlc.h"
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
36 #include <stdlib.h> /* free(), strtol() */
37 #include <stdio.h> /* sprintf() */
38 #include <string.h> /* strdup() */
44 #ifdef HAVE_SYS_TYPES_H
45 # include <sys/types.h>
47 #ifdef HAVE_SYS_STAT_H
48 # include <sys/stat.h>
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>
60 #elif defined(HAVE_DL_BEOS)
61 # if defined(HAVE_IMAGE_H)
64 #elif defined(HAVE_DL_WINDOWS)
66 #elif defined(HAVE_DL_DLOPEN)
67 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
70 # if defined(HAVE_SYS_DL_H)
73 #elif defined(HAVE_DL_SHL_LOAD)
74 # if defined(HAVE_DL_H)
79 #include "modules/configuration.h"
82 #include "vlc_interface.h"
83 #include "vlc_playlist.h"
85 #include "vlc_stream.h"
86 #include "vlc_access.h"
87 #include "vlc_demux.h"
88 #include "vlc_codec.h"
91 #include "vlc_vout_synchro.h"
96 #include "vlc_httpd.h"
103 #include "iso_lang.h"
104 #include "vlc_charset.h"
106 #include "vlc_block.h"
110 #include "vlc_image.h"
113 #include "vlc_update.h"
114 #include "vlc_strings.h"
115 #include "vlc_streaming.h"
117 #include "modules/modules.h"
118 #include "modules/builtin.h"
120 #include "vlc_network.h"
122 #if defined( WIN32 ) || defined( UNDER_CE )
123 /* Avoid name collisions */
124 # define LoadModule(a,b,c) LoadVlcModule(a,b,c)
127 /*****************************************************************************
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 * );
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 );
153 #if defined(HAVE_DL_WINDOWS)
154 static char * GetWindowsError ( void );
158 static void module_LoadMain( vlc_object_t *p_this );
160 /* Sub-version number
161 * (only used to avoid breakage in dev version when cache structure changes) */
162 #define CACHE_SUBVERSION_NUM 3
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 )
172 module_bank_t *p_bank = NULL;
174 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
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 )
181 p_libvlc_global->p_module_bank->i_usage++;
182 vlc_mutex_unlock( lockval.p_address );
183 var_Destroy( p_libvlc_global, "libvlc" );
186 vlc_mutex_unlock( lockval.p_address );
187 var_Destroy( p_libvlc_global, "libvlc" );
189 p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
192 p_bank->psz_object_name = "module bank";
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;
199 /* Everything worked, attach the object */
200 p_libvlc_global->p_module_bank = p_bank;
201 vlc_object_attach( p_bank, p_libvlc_global );
203 module_LoadMain( p_this );
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 )
215 module_t * p_next = NULL;
217 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
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 )
224 vlc_mutex_unlock( lockval.p_address );
225 var_Destroy( p_libvlc_global, "libvlc" );
228 if( --p_libvlc_global->p_module_bank->i_usage )
230 vlc_mutex_unlock( lockval.p_address );
231 var_Destroy( p_libvlc_global, "libvlc" );
234 vlc_mutex_unlock( lockval.p_address );
235 var_Destroy( p_libvlc_global, "libvlc" );
237 config_AutoSaveConfigFile( p_this );
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-- )
244 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
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;
253 if( p_bank->pp_loaded_cache )
255 free( p_bank->pp_loaded_cache );
256 p_bank->pp_loaded_cache = NULL;
258 while( p_bank->i_cache-- )
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;
264 if( p_bank->pp_cache )
266 free( p_bank->pp_cache );
267 p_bank->pp_cache = NULL;
272 vlc_object_detach( p_libvlc_global->p_module_bank );
274 while( p_libvlc_global->p_module_bank->i_children )
276 p_next = (module_t *)p_libvlc_global->p_module_bank->pp_children[0];
278 if( DeleteModule( p_next, VLC_TRUE ) )
280 /* Module deletion failed */
281 msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
282 p_next->psz_object_name );
284 /* We just free the module by hand. Niahahahahaha. */
285 vlc_object_detach( p_next );
286 vlc_object_destroy( p_next );
290 vlc_object_destroy( p_libvlc_global->p_module_bank );
291 p_libvlc_global->p_module_bank = NULL;
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 )
305 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
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 )
312 vlc_mutex_unlock( lockval.p_address );
313 var_Destroy( p_libvlc_global, "libvlc" );
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" );
320 AllocateBuiltinModule( p_this, vlc_entry__main );
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 )
331 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
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 )
338 vlc_mutex_unlock( lockval.p_address );
339 var_Destroy( p_libvlc_global, "libvlc" );
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" );
346 msg_Dbg( p_this, "checking builtin modules" );
347 ALLOCATE_ALL_BUILTINS();
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 )
357 #ifdef HAVE_DYNAMIC_PLUGINS
359 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
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 )
366 vlc_mutex_unlock( lockval.p_address );
367 var_Destroy( p_libvlc_global, "libvlc" );
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" );
374 msg_Dbg( p_this, "checking plugin modules" );
376 if( config_GetInt( p_this, "plugins-cache" ) )
377 p_libvlc_global->p_module_bank->b_cache = VLC_TRUE;
379 if( p_libvlc_global->p_module_bank->b_cache ||
380 p_libvlc_global->p_module_bank->b_cache_delete ) CacheLoad( p_this );
382 AllocateAllPlugins( p_this );
386 /*****************************************************************************
387 * module_Need: return the best module function, given a capability list.
388 *****************************************************************************
389 * This function returns the module that best fits the asked capabilities.
390 *****************************************************************************/
391 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
392 const char *psz_name, vlc_bool_t b_strict )
394 typedef struct module_list_t module_list_t;
401 module_list_t *p_next;
404 module_list_t *p_list, *p_first, *p_tmp;
407 int i_which_module, i_index = 0;
408 vlc_bool_t b_intf = VLC_FALSE;
413 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
414 vlc_bool_t b_force_backup = p_this->b_force;
417 /* Deal with variables */
418 if( psz_name && psz_name[0] == '$' )
421 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
422 var_Get( p_this, psz_name + 1, &val );
423 psz_var = val.psz_string;
427 /* Count how many different shortcuts were asked for */
428 if( psz_name && *psz_name )
430 char *psz_parser, *psz_last_shortcut;
432 /* If the user wants none, give him none. */
433 if( !strcmp( psz_name, "none" ) )
440 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
442 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
444 if( *psz_parser == ',' )
448 psz_last_shortcut = psz_parser + 1;
452 /* Check if the user wants to override the "strict" mode */
453 if( psz_last_shortcut )
455 if( !strcmp(psz_last_shortcut, "none") )
460 else if( !strcmp(psz_last_shortcut, "any") )
462 b_strict = VLC_FALSE;
468 /* Sort the modules and test them */
469 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
470 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
472 unsigned i_cpu = vlc_CPU();
474 /* Parse the module list for capabilities and probe each of them */
475 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
477 int i_shortcut_bonus = 0;
479 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
481 /* Test that this module can do what we need */
482 if( strcmp( p_module->psz_capability, psz_capability ) )
484 /* Don't recurse through the sub-modules because vlc_list_find()
485 * will list them anyway. */
489 /* Test if we have the required CPU */
490 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
495 /* If we required a shortcut, check this plugin provides it. */
496 if( i_shortcuts > 0 )
499 const char *psz_name = psz_shortcuts;
501 /* Let's drop modules with a <= 0 score (unless they are
502 * explicitly requested) */
503 b_trash = p_module->i_score <= 0;
505 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
507 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
510 if( ( c = strchr( psz_name, '@' ) )
511 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
513 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
518 i_shortcut_bonus = i_short * 10000;
523 /* Go to the next shortcut... This is so lame! */
524 psz_name += strlen( psz_name ) + 1;
527 /* If we are in "strict" mode and we couldn't
528 * find the module in the list of provided shortcuts,
529 * then kick the bastard out of here!!! */
533 /* If we didn't require a shortcut, trash <= 0 scored plugins */
534 else if( p_module->i_score <= 0 )
541 /* Special case: test if we requested a particular intf plugin */
542 if( !i_shortcuts && p_module->psz_program
543 && !strcmp( psz_capability, "interface" )
544 && !strcmp( p_module->psz_program,
545 p_this->p_libvlc->psz_object_name ) )
549 /* Remove previous non-matching plugins */
556 /* This one doesn't match */
560 /* Store this new module */
561 p_list[ i_index ].p_module = p_module;
562 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
563 p_list[ i_index ].b_force = i_shortcut_bonus && b_strict;
565 /* Add it to the modules-to-probe list */
568 p_list[ 0 ].p_next = NULL;
573 /* Ok, so at school you learned that quicksort is quick, and
574 * bubble sort sucks raw eggs. But that's when dealing with
575 * thousands of items. Here we have barely 50. */
576 module_list_t *p_newlist = p_first;
578 if( p_first->i_score < p_list[ i_index ].i_score )
580 p_list[ i_index ].p_next = p_first;
581 p_first = &p_list[ i_index ];
585 while( p_newlist->p_next != NULL &&
586 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
588 p_newlist = p_newlist->p_next;
591 p_list[ i_index ].p_next = p_newlist->p_next;
592 p_newlist->p_next = &p_list[ i_index ];
599 msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
600 i_index, i_index == 1 ? "" : "s" );
602 /* Lock all candidate modules */
604 while( p_tmp != NULL )
606 vlc_object_yield( p_tmp->p_module );
607 p_tmp = p_tmp->p_next;
610 /* We can release the list, interesting modules were yielded */
611 vlc_list_release( p_all );
613 /* Parse the linked list and use the first successful module */
615 while( p_tmp != NULL )
617 #ifdef HAVE_DYNAMIC_PLUGINS
618 /* Make sure the module is loaded in mem */
619 module_t *p_module = p_tmp->p_module;
620 if( p_module->b_submodule )
621 p_module = (module_t *)p_module->p_parent;
623 if( !p_module->b_builtin && !p_module->b_loaded )
625 module_t *p_new_module =
626 AllocatePlugin( p_this, p_module->psz_filename );
629 CacheMerge( p_this, p_module, p_new_module );
630 vlc_object_attach( p_new_module, p_module );
631 DeleteModule( p_new_module, VLC_TRUE );
636 p_this->b_force = p_tmp->b_force;
637 if( p_tmp->p_module->pf_activate
638 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
643 vlc_object_release( p_tmp->p_module );
644 p_tmp = p_tmp->p_next;
647 /* Store the locked module value */
650 p_module = p_tmp->p_module;
651 p_tmp = p_tmp->p_next;
658 /* Unlock the remaining modules */
659 while( p_tmp != NULL )
661 vlc_object_release( p_tmp->p_module );
662 p_tmp = p_tmp->p_next;
666 p_this->b_force = b_force_backup;
668 if( p_module != NULL )
670 msg_Dbg( p_this, "using %s module \"%s\"",
671 psz_capability, p_module->psz_object_name );
673 else if( p_first == NULL )
675 if( !strcmp( psz_capability, "access_demux" ) )
677 msg_Warn( p_this, "no %s module matched \"%s\"",
678 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
682 msg_Err( p_this, "no %s module matched \"%s\"",
683 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
685 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
686 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
689 else if( psz_name != NULL && *psz_name )
691 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
692 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
695 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
697 if( p_module && !p_this->psz_object_name )
699 /* This assumes that p_this is the object which will be using the
700 * module. That's not always the case ... but it is in most cases.
703 p_this->psz_object_name = strdup( psz_alias );
705 p_this->psz_object_name = strdup( p_module->psz_object_name );
708 free( psz_shortcuts );
711 /* Don't forget that the module is still locked */
715 /*****************************************************************************
716 * module_Unneed: decrease the usage count of a module.
717 *****************************************************************************
718 * This function must be called by the thread that called module_Need, to
719 * decrease the reference count and allow for hiding of modules.
720 *****************************************************************************/
721 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
723 /* Use the close method */
724 if( p_module->pf_deactivate )
726 p_module->pf_deactivate( p_this );
729 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
731 vlc_object_release( p_module );
736 /*****************************************************************************
737 * module_Exists: tell if a module exists.
738 *****************************************************************************
739 * This function is a boolean function that tells if a module exist or not.
740 *****************************************************************************/
742 vlc_bool_t __module_Exists( vlc_object_t *p_this, const char * psz_name )
746 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
747 for( i = 0 ; i < p_list->i_count; i++)
749 const char *psz_module_name =
750 ((module_t *) p_list->p_values[i].p_object)->psz_shortname;
751 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
753 /* We can release the list, and return yes */
754 vlc_list_release( p_list ); return VLC_TRUE;
757 vlc_list_release( p_list ); return VLC_FALSE;
761 /*****************************************************************************
762 * Following functions are local.
763 *****************************************************************************/
765 /*****************************************************************************
766 * AllocateAllPlugins: load all plugin modules we can find.
767 *****************************************************************************/
768 #ifdef HAVE_DYNAMIC_PLUGINS
769 static void AllocateAllPlugins( vlc_object_t *p_this )
771 /* Yes, there are two NULLs because we replace one with "plugin-path". */
772 #if defined( WIN32 ) || defined( UNDER_CE )
773 const char *path[] = { "modules", "", "plugins", NULL, NULL };
775 const char *path[] = { "modules", PLUGIN_PATH, "plugins", NULL, NULL };
778 const char *const *ppsz_path;
780 /* If the user provided a plugin path, we add it to the list */
781 char *userpath = config_GetPsz( p_this, "plugin-path" );
782 path[sizeof(path)/sizeof(path[0]) - 2] = userpath;
784 for (ppsz_path = path; *ppsz_path != NULL; ppsz_path++)
788 if (!**ppsz_path) continue;
790 #if defined( SYS_BEOS ) || defined( __APPLE__ ) || defined( WIN32 )
792 /* Handle relative as well as absolute paths */
794 if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
795 (*ppsz_path)[1] != ':' )
797 if( (*ppsz_path)[0] != '/' )
800 if( 0>= asprintf( &psz_fullpath, "%s"DIR_SEP"%s",
801 vlc_global( p_this )->psz_vlcpath, *ppsz_path) )
806 psz_fullpath = strdup( *ppsz_path );
808 if( psz_fullpath == NULL )
811 msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
813 /* Don't go deeper than 5 subdirectories */
814 AllocatePluginDir( p_this, psz_fullpath, 5 );
816 free( psz_fullpath );
819 /* Free plugin-path */
823 /*****************************************************************************
824 * AllocatePluginDir: recursively parse a directory to look for plugins
825 *****************************************************************************/
826 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
829 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
835 #if defined( UNDER_CE ) || defined( _MSC_VER )
837 wchar_t psz_wpath[MAX_PATH + 256];
838 wchar_t psz_wdir[MAX_PATH];
840 char psz_path[MAX_PATH + 256];
841 WIN32_FIND_DATA finddata;
847 struct dirent * file;
851 if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
856 #if defined( UNDER_CE ) || defined( _MSC_VER )
858 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
860 rc = GetFileAttributes( psz_wdir );
861 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
863 /* Parse all files in the directory */
864 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
866 rc = GetFileAttributes( psz_dir );
867 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
870 /* Parse all files in the directory */
871 sprintf( psz_path, "%s\\*", psz_dir );
874 handle = FindFirstFile( psz_wpath, &finddata );
876 handle = FindFirstFile( psz_path, &finddata );
878 if( handle == INVALID_HANDLE_VALUE )
880 /* Empty directory */
884 /* Parse the directory and try to load all files it contains. */
888 unsigned int i_len = wcslen( finddata.cFileName );
889 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
890 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
892 unsigned int i_len = strlen( finddata.cFileName );
893 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
897 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
898 || !strcmp( finddata.cFileName, ".." ) )
900 if( !FindNextFile( handle, &finddata ) ) break;
905 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
907 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
910 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
912 else if( i_len > strlen( LIBEXT )
913 /* We only load files ending with LIBEXT */
914 && !strncasecmp( psz_path + strlen( psz_path)
916 LIBEXT, strlen( LIBEXT ) ) )
918 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
919 int64_t i_time = 0, i_size = 0;
922 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
925 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
929 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
931 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
932 i_size = attrbuf.nFileSizeHigh;
934 i_size |= attrbuf.nFileSizeLow;
938 AllocatePluginFile( p_this, psz_file, i_time, i_size );
941 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
943 /* Close the directory */
947 dir = opendir( psz_dir );
953 i_dirlen = strlen( psz_dir );
955 /* Parse the directory and try to load all files it contains. */
956 while( !p_this->p_libvlc->b_die && (file = readdir( dir )) )
963 if( !*file->d_name || !strcmp( file->d_name, "." )
964 || !strcmp( file->d_name, ".." ) )
969 i_len = strlen( file->d_name );
970 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
972 sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
974 sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
977 i_stat = stat( psz_file, &statbuf );
978 if( !i_stat && statbuf.st_mode & S_IFDIR )
980 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
982 else if( i_len > strlen( LIBEXT )
983 /* We only load files ending with LIBEXT */
984 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
985 LIBEXT, strlen( LIBEXT ) ) )
987 int64_t i_time = 0, i_size = 0;
991 i_time = statbuf.st_mtime;
992 i_size = statbuf.st_size;
995 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1001 /* Close the directory */
1007 /*****************************************************************************
1008 * AllocatePluginFile: load a module into memory and initialize it.
1009 *****************************************************************************
1010 * This function loads a dynamically loadable module and allocates a structure
1011 * for its information data. The module can then be handled by module_Need
1012 * and module_Unneed. It can be removed by DeleteModule.
1013 *****************************************************************************/
1014 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
1015 int64_t i_file_time, int64_t i_file_size )
1017 module_t * p_module = NULL;
1018 module_cache_t *p_cache_entry = NULL;
1021 * Check our plugins cache first then load plugin if needed
1024 CacheFind( p_this, psz_file, i_file_time, i_file_size );
1026 if( !p_cache_entry )
1028 p_module = AllocatePlugin( p_this, psz_file );
1032 /* If junk dll, don't try to load it */
1033 if( p_cache_entry->b_junk )
1039 module_config_t *p_item = NULL, *p_end = NULL;
1041 p_module = p_cache_entry->p_module;
1042 p_module->b_loaded = VLC_FALSE;
1044 /* For now we force loading if the module's config contains
1045 * callbacks or actions.
1046 * Could be optimized by adding an API call.*/
1047 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1048 p_item < p_end; p_item++ )
1050 if( p_item->pf_callback || p_item->i_action )
1052 p_module = AllocatePlugin( p_this, psz_file );
1056 if( p_module == p_cache_entry->p_module )
1057 p_cache_entry->b_used = VLC_TRUE;
1063 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1065 /* Everything worked fine !
1066 * The module is ready to be added to the list. */
1067 p_module->b_builtin = VLC_FALSE;
1069 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1070 p_module->psz_object_name, p_module->psz_longname ); */
1072 vlc_object_attach( p_module, p_libvlc_global->p_module_bank );
1074 if( !p_libvlc_global->p_module_bank->b_cache )
1077 #define p_bank p_libvlc_global->p_module_bank
1078 /* Add entry to cache */
1080 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1081 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1082 if( !p_bank->pp_cache[p_bank->i_cache] )
1084 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1085 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1086 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1087 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1088 p_bank->pp_cache[p_bank->i_cache]->b_used = VLC_TRUE;
1089 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1093 return p_module ? 0 : -1;
1096 /*****************************************************************************
1097 * AllocatePlugin: load a module into memory and initialize it.
1098 *****************************************************************************
1099 * This function loads a dynamically loadable module and allocates a structure
1100 * for its information data. The module can then be handled by module_Need
1101 * and module_Unneed. It can be removed by DeleteModule.
1102 *****************************************************************************/
1103 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1105 module_t * p_module = NULL;
1106 module_handle_t handle;
1108 if( LoadModule( p_this, psz_file, &handle ) )
1111 /* Now that we have successfully loaded the module, we can
1112 * allocate a structure for it */
1113 p_module = vlc_module_create( p_this );
1114 if( p_module == NULL )
1116 msg_Err( p_this, "out of memory" );
1117 CloseModule( handle );
1121 /* We need to fill these since they may be needed by CallEntry() */
1122 p_module->psz_filename = psz_file;
1123 p_module->handle = handle;
1124 p_module->b_loaded = VLC_TRUE;
1126 /* Initialize the module: fill p_module, default config */
1127 if( CallEntry( p_module ) != 0 )
1129 /* We couldn't call module_init() */
1130 vlc_object_destroy( p_module );
1131 CloseModule( handle );
1135 DupModule( p_module );
1136 p_module->psz_filename = strdup( p_module->psz_filename );
1138 /* Everything worked fine ! The module is ready to be added to the list. */
1139 p_module->b_builtin = VLC_FALSE;
1144 /*****************************************************************************
1145 * DupModule: make a plugin module standalone.
1146 *****************************************************************************
1147 * This function duplicates all strings in the module, so that the dynamic
1148 * object can be unloaded. It acts recursively on submodules.
1149 *****************************************************************************/
1150 static void DupModule( module_t *p_module )
1152 const char **pp_shortcut;
1155 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1157 *pp_shortcut = strdup( *pp_shortcut );
1160 /* We strdup() these entries so that they are still valid when the
1161 * module is unloaded. */
1162 p_module->psz_object_name = strdup( p_module->psz_object_name );
1163 p_module->psz_capability = strdup( p_module->psz_capability );
1164 p_module->psz_shortname = p_module->psz_shortname ?
1165 strdup( p_module->psz_shortname ) : NULL;
1166 p_module->psz_longname = strdup( p_module->psz_longname );
1167 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1170 if( p_module->psz_program != NULL )
1172 p_module->psz_program = strdup( p_module->psz_program );
1175 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1177 DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1181 /*****************************************************************************
1182 * UndupModule: free a duplicated module.
1183 *****************************************************************************
1184 * This function frees the allocations done in DupModule().
1185 *****************************************************************************/
1186 static void UndupModule( module_t *p_module )
1188 const char **pp_shortcut;
1191 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1193 UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1196 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1198 free( (void*)*pp_shortcut );
1201 free( (void*)p_module->psz_object_name );
1202 free( (void*)p_module->psz_capability );
1203 free( (void*)p_module->psz_shortname );
1204 free( (void*)p_module->psz_longname );
1205 free( (void*)p_module->psz_help );
1206 free( (void*)p_module->psz_program );
1209 #endif /* HAVE_DYNAMIC_PLUGINS */
1211 /*****************************************************************************
1212 * AllocateBuiltinModule: initialize a builtin module.
1213 *****************************************************************************
1214 * This function registers a builtin module and allocates a structure
1215 * for its information data. The module can then be handled by module_Need
1216 * and module_Unneed. It can be removed by DeleteModule.
1217 *****************************************************************************/
1218 static int AllocateBuiltinModule( vlc_object_t * p_this,
1219 int ( *pf_entry ) ( module_t * ) )
1221 module_t * p_module;
1223 /* Now that we have successfully loaded the module, we can
1224 * allocate a structure for it */
1225 p_module = vlc_module_create( p_this );
1226 if( p_module == NULL )
1228 msg_Err( p_this, "out of memory" );
1232 /* Initialize the module : fill p_module->psz_object_name, etc. */
1233 if( pf_entry( p_module ) != 0 )
1235 /* With a well-written module we shouldn't have to print an
1236 * additional error message here, but just make sure. */
1237 msg_Err( p_this, "failed calling entry point in builtin module" );
1238 vlc_object_destroy( p_module );
1242 /* Everything worked fine ! The module is ready to be added to the list. */
1243 p_module->b_builtin = VLC_TRUE;
1245 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1246 p_module->psz_object_name, p_module->psz_longname ); */
1248 vlc_object_attach( p_module, vlc_global( p_this )->p_module_bank );
1253 /*****************************************************************************
1254 * DeleteModule: delete a module and its structure.
1255 *****************************************************************************
1256 * This function can only be called if the module isn't being used.
1257 *****************************************************************************/
1258 static int DeleteModule( module_t * p_module, vlc_bool_t b_detach )
1260 if( !p_module ) return VLC_EGENERIC;
1262 vlc_object_detach( p_module );
1264 /* We free the structures that we strdup()ed in Allocate*Module(). */
1265 #ifdef HAVE_DYNAMIC_PLUGINS
1266 if( !p_module->b_builtin )
1268 if( p_module->b_loaded && p_module->b_unloadable )
1270 CloseModule( p_module->handle );
1272 UndupModule( p_module );
1273 free( p_module->psz_filename );
1277 /* Free and detach the object's children */
1278 while( p_module->i_children )
1280 vlc_object_t *p_this = p_module->pp_children[0];
1281 vlc_object_detach( p_this );
1282 vlc_object_destroy( p_this );
1285 config_Free( p_module );
1286 vlc_object_destroy( p_module );
1291 #ifdef HAVE_DYNAMIC_PLUGINS
1292 /*****************************************************************************
1293 * CallEntry: call an entry point.
1294 *****************************************************************************
1295 * This function calls a symbol given its name and a module structure. The
1296 * symbol MUST refer to a function returning int and taking a module_t* as
1298 *****************************************************************************/
1299 static int CallEntry( module_t * p_module )
1301 static const char psz_name[] = "vlc_entry" MODULE_SUFFIX;
1302 int (* pf_symbol) ( module_t * p_module );
1304 /* Try to resolve the symbol */
1305 pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1307 if( pf_symbol == NULL )
1309 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1310 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1311 psz_name, p_module->psz_filename );
1312 #elif defined(HAVE_DL_WINDOWS)
1313 char *psz_error = GetWindowsError();
1314 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1315 psz_name, p_module->psz_filename, psz_error );
1317 #elif defined(HAVE_DL_DLOPEN)
1318 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1319 psz_name, p_module->psz_filename, dlerror() );
1320 #elif defined(HAVE_DL_SHL_LOAD)
1321 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1322 psz_name, p_module->psz_filename, strerror(errno) );
1324 # error "Something is wrong in modules.c"
1329 /* We can now try to call the symbol */
1330 if( pf_symbol( p_module ) != 0 )
1332 /* With a well-written module we shouldn't have to print an
1333 * additional error message here, but just make sure. */
1334 msg_Err( p_module, "Failed to call symbol \"%s\" in file `%s'",
1335 psz_name, p_module->psz_filename );
1339 /* Everything worked fine, we can return */
1343 /*****************************************************************************
1344 * LoadModule: loads a dynamic library
1345 *****************************************************************************
1346 * This function loads a dynamically linked library using a system dependant
1347 * method. Will return 0 on success as well as the module handle.
1348 *****************************************************************************/
1349 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1350 module_handle_t *p_handle )
1352 module_handle_t handle;
1354 #if defined(HAVE_DL_DYLD)
1355 NSObjectFileImage image;
1356 NSObjectFileImageReturnCode ret;
1358 ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1360 if( ret != NSObjectFileImageSuccess )
1362 msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1366 /* Open the dynamic module */
1367 handle = NSLinkModule( image, psz_file,
1368 NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1372 NSLinkEditErrors errors;
1373 const char *psz_file, *psz_err;
1375 NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1376 msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1377 NSDestroyObjectFileImage( image );
1381 /* Destroy our image, we won't need it */
1382 NSDestroyObjectFileImage( image );
1384 #elif defined(HAVE_DL_BEOS)
1385 handle = load_add_on( psz_file );
1388 msg_Warn( p_this, "cannot load module `%s'", psz_file );
1392 #elif defined(HAVE_DL_WINDOWS)
1395 wchar_t psz_wfile[MAX_PATH];
1396 MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1397 handle = LoadLibrary( psz_wfile );
1400 handle = LoadLibrary( psz_file );
1402 if( handle == NULL )
1404 char *psz_err = GetWindowsError();
1405 msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1410 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1411 /* static is OK, we are called atomically */
1413 # if defined(SYS_LINUX)
1414 /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1415 * are going to get namespace collisions when two modules have common
1416 * public symbols, but ALSA is being a pest here. */
1417 if( strstr( psz_file, "alsa_plugin" ) )
1419 handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1420 if( handle == NULL )
1422 msg_Warn( p_this, "cannot load module `%s' (%s)",
1423 psz_file, dlerror() );
1429 handle = dlopen( psz_file, RTLD_NOW );
1430 if( handle == NULL )
1432 msg_Warn( p_this, "cannot load module `%s' (%s)",
1433 psz_file, dlerror() );
1437 #elif defined(HAVE_DL_DLOPEN)
1438 # if defined(DL_LAZY)
1439 handle = dlopen( psz_file, DL_LAZY );
1441 handle = dlopen( psz_file, 0 );
1443 if( handle == NULL )
1445 msg_Warn( p_this, "cannot load module `%s' (%s)",
1446 psz_file, dlerror() );
1450 #elif defined(HAVE_DL_SHL_LOAD)
1451 handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1452 if( handle == NULL )
1454 msg_Warn( p_this, "cannot load module `%s' (%s)",
1455 psz_file, strerror(errno) );
1460 # error "Something is wrong in modules.c"
1468 /*****************************************************************************
1469 * CloseModule: unload a dynamic library
1470 *****************************************************************************
1471 * This function unloads a previously opened dynamically linked library
1472 * using a system dependant method. No return value is taken in consideration,
1473 * since some libraries sometimes refuse to close properly.
1474 *****************************************************************************/
1475 static void CloseModule( module_handle_t handle )
1477 #if defined(HAVE_DL_DYLD)
1478 NSUnLinkModule( handle, FALSE );
1480 #elif defined(HAVE_DL_BEOS)
1481 unload_add_on( handle );
1483 #elif defined(HAVE_DL_WINDOWS)
1484 FreeLibrary( handle );
1486 #elif defined(HAVE_DL_DLOPEN)
1491 #elif defined(HAVE_DL_SHL_LOAD)
1492 shl_unload( handle );
1498 /*****************************************************************************
1499 * GetSymbol: get a symbol from a dynamic library
1500 *****************************************************************************
1501 * This function queries a loaded library for a symbol specified in a
1502 * string, and returns a pointer to it. We don't check for dlerror() or
1503 * similar functions, since we want a non-NULL symbol anyway.
1504 *****************************************************************************/
1505 static void * _module_getsymbol( module_handle_t, const char * );
1507 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1509 void * p_symbol = _module_getsymbol( handle, psz_function );
1511 /* MacOS X dl library expects symbols to begin with "_". So do
1512 * some other operating systems. That's really lame, but hey, what
1514 if( p_symbol == NULL )
1516 char psz_call[strlen( psz_function ) + 2];
1518 psz_call[ 0 ] = '_';
1519 memcpy( psz_call + 1, psz_function, sizeof (psz_call) - 1 );
1520 p_symbol = _module_getsymbol( handle, psz_call );
1526 static void * _module_getsymbol( module_handle_t handle,
1527 const char * psz_function )
1529 #if defined(HAVE_DL_DYLD)
1530 NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1531 return NSAddressOfSymbol( sym );
1533 #elif defined(HAVE_DL_BEOS)
1535 if( B_OK == get_image_symbol( handle, psz_function,
1536 B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1545 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1546 wchar_t psz_real[256];
1547 MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1549 return (void *)GetProcAddress( handle, psz_real );
1551 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1552 return (void *)GetProcAddress( handle, (char *)psz_function );
1554 #elif defined(HAVE_DL_DLOPEN)
1555 return dlsym( handle, psz_function );
1557 #elif defined(HAVE_DL_SHL_LOAD)
1559 shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1565 #if defined(HAVE_DL_WINDOWS)
1566 static char * GetWindowsError( void )
1568 #if defined(UNDER_CE)
1569 wchar_t psz_tmp[MAX_PATH];
1570 char * psz_buffer = malloc( MAX_PATH );
1572 char * psz_tmp = malloc( MAX_PATH );
1574 int i = 0, i_error = GetLastError();
1576 FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1577 NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1578 (LPTSTR)psz_tmp, MAX_PATH, NULL );
1580 /* Go to the end of the string */
1581 while( psz_tmp[i] && psz_tmp[i] != _T('\r') && psz_tmp[i] != _T('\n') )
1588 #if defined(UNDER_CE)
1589 swprintf( psz_tmp + i, L" (error %i)", i_error );
1590 psz_tmp[ 255 ] = L'\0';
1592 snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1593 psz_tmp[ 255 ] = '\0';
1597 #if defined(UNDER_CE)
1598 wcstombs( psz_buffer, psz_tmp, MAX_PATH );
1604 #endif /* HAVE_DL_WINDOWS */
1606 /*****************************************************************************
1607 * LoadPluginsCache: loads the plugins cache file
1608 *****************************************************************************
1609 * This function will load the plugin cache if present and valid. This cache
1610 * will in turn be queried by AllocateAllPlugins() to see if it needs to
1611 * actually load the dynamically loadable module.
1612 * This allows us to only fully load plugins when they are actually used.
1613 *****************************************************************************/
1614 static void CacheLoad( vlc_object_t *p_this )
1616 char *psz_filename, *psz_homedir;
1618 int i, j, i_size, i_read;
1619 char p_cachestring[sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE)];
1620 char p_cachelang[6], p_lang[6];
1622 module_cache_t **pp_cache = 0;
1623 int32_t i_file_size, i_marker;
1624 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1626 psz_homedir = p_this->p_libvlc->psz_homedir;
1629 msg_Err( p_this, "psz_homedir is null" );
1633 i_size = asprintf( &psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1634 PLUGINSCACHE_DIR, CacheName() );
1637 msg_Err( p_this, "out of memory" );
1641 if( p_libvlc_global->p_module_bank->b_cache_delete )
1643 #if !defined( UNDER_CE )
1644 unlink( psz_filename );
1646 wchar_t psz_wf[MAX_PATH];
1647 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
1648 DeleteFile( psz_wf );
1650 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1651 free( psz_filename );
1655 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1657 file = utf8_fopen( psz_filename, "rb" );
1660 msg_Warn( p_this, "could not open plugins cache file %s for reading",
1662 free( psz_filename );
1665 free( psz_filename );
1667 /* Check the file size */
1668 i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
1669 if( i_read != sizeof(i_file_size) )
1671 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1677 fseek( file, 0, SEEK_END );
1678 if( ftell( file ) != i_file_size )
1680 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1681 "(corrupted size)" );
1685 fseek( file, sizeof(i_file_size), SEEK_SET );
1687 /* Check the file is a plugins cache */
1688 i_size = sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE) - 1;
1689 i_read = fread( p_cachestring, 1, i_size, file );
1690 if( i_read != i_size ||
1691 memcmp( p_cachestring, PLUGINSCACHE_DIR COPYRIGHT_MESSAGE, i_size ) )
1693 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1698 /* Check Sub-version number */
1699 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
1700 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
1702 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1703 "(corrupted header)" );
1708 /* Check the language hasn't changed */
1709 sprintf( p_lang, "%5.5s", _("C") ); i_size = 5;
1710 i_read = fread( p_cachelang, 1, i_size, file );
1711 if( i_read != i_size || memcmp( p_cachelang, p_lang, i_size ) )
1713 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1714 "(language changed)" );
1719 /* Check header marker */
1720 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
1721 if( i_read != sizeof(i_marker) ||
1722 i_marker != ftell( file ) - (int)sizeof(i_marker) )
1724 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1725 "(corrupted header)" );
1730 p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1731 if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
1733 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1734 "(file too short)" );
1740 pp_cache = p_libvlc_global->p_module_bank->pp_loaded_cache =
1741 malloc( i_cache * sizeof(void *) );
1743 #define LOAD_IMMEDIATE(a) \
1744 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1745 #define LOAD_STRING(a) \
1748 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
1749 || ( i_size > 16384 ) ) \
1752 char *psz = malloc( i_size ); \
1753 if( fread( psz, i_size, 1, file ) != 1 ) { \
1757 if( psz[i_size-1] ) { \
1765 for( i = 0; i < i_cache; i++ )
1770 pp_cache[i] = malloc( sizeof(module_cache_t) );
1771 p_libvlc_global->p_module_bank->i_loaded_cache++;
1773 /* Load common info */
1774 LOAD_STRING( pp_cache[i]->psz_file );
1775 LOAD_IMMEDIATE( pp_cache[i]->i_time );
1776 LOAD_IMMEDIATE( pp_cache[i]->i_size );
1777 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1778 pp_cache[i]->b_used = VLC_FALSE;
1780 if( pp_cache[i]->b_junk ) continue;
1782 pp_cache[i]->p_module = vlc_module_create( p_this );
1784 /* Load additional infos */
1785 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1786 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1787 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1788 LOAD_STRING( pp_cache[i]->p_module->psz_help );
1789 LOAD_STRING( pp_cache[i]->p_module->psz_program );
1790 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1792 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1794 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1795 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1796 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1797 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1798 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1799 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1802 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1805 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1807 LOAD_IMMEDIATE( i_submodules );
1809 while( i_submodules-- )
1811 module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
1812 LOAD_STRING( p_module->psz_object_name );
1813 LOAD_STRING( p_module->psz_shortname );
1814 LOAD_STRING( p_module->psz_longname );
1815 LOAD_STRING( p_module->psz_help );
1816 LOAD_STRING( p_module->psz_program );
1817 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1819 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1821 LOAD_STRING( p_module->psz_capability );
1822 LOAD_IMMEDIATE( p_module->i_score );
1823 LOAD_IMMEDIATE( p_module->i_cpu );
1824 LOAD_IMMEDIATE( p_module->b_unloadable );
1825 LOAD_IMMEDIATE( p_module->b_reentrant );
1834 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1837 p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1844 int CacheLoadConfig( module_t *p_module, FILE *file )
1849 /* Calculate the structure length */
1850 LOAD_IMMEDIATE( p_module->i_config_items );
1851 LOAD_IMMEDIATE( p_module->i_bool_items );
1853 LOAD_IMMEDIATE( i_lines );
1855 /* Allocate memory */
1858 p_module->p_config =
1859 (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
1860 if( p_module->p_config == NULL )
1862 p_module->confsize = 0;
1863 msg_Err( p_module, "config error: can't duplicate p_config" );
1867 p_module->confsize = i_lines;
1869 /* Do the duplication job */
1870 for (size_t i = 0; i < i_lines; i++ )
1872 LOAD_IMMEDIATE( p_module->p_config[i] );
1874 LOAD_STRING( p_module->p_config[i].psz_type );
1875 LOAD_STRING( p_module->p_config[i].psz_name );
1876 LOAD_STRING( p_module->p_config[i].psz_text );
1877 LOAD_STRING( p_module->p_config[i].psz_longtext );
1878 LOAD_STRING( p_module->p_config[i].psz_current );
1880 if (IsConfigStringType (p_module->p_config[i].i_type))
1882 LOAD_STRING (p_module->p_config[i].orig.psz);
1883 p_module->p_config[i].value.psz =
1884 (p_module->p_config[i].orig.psz != NULL)
1885 ? strdup (p_module->p_config[i].orig.psz) : NULL;
1886 p_module->p_config[i].saved.psz = NULL;
1890 memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
1891 sizeof (p_module->p_config[i].value));
1892 memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
1893 sizeof (p_module->p_config[i].saved));
1896 p_module->p_config[i].b_dirty = VLC_FALSE;
1898 p_module->p_config[i].p_lock = &p_module->object_lock;
1900 if( p_module->p_config[i].i_list )
1902 if( p_module->p_config[i].ppsz_list )
1905 p_module->p_config[i].ppsz_list =
1906 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1907 if( p_module->p_config[i].ppsz_list )
1909 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1910 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1911 p_module->p_config[i].ppsz_list[j] = NULL;
1914 if( p_module->p_config[i].ppsz_list_text )
1917 p_module->p_config[i].ppsz_list_text =
1918 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1919 if( p_module->p_config[i].ppsz_list_text )
1921 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1922 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1923 p_module->p_config[i].ppsz_list_text[j] = NULL;
1926 if( p_module->p_config[i].pi_list )
1928 p_module->p_config[i].pi_list =
1929 malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1930 if( p_module->p_config[i].pi_list )
1932 for (int j = 0; j < p_module->p_config[i].i_list; j++)
1933 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1938 if( p_module->p_config[i].i_action )
1940 p_module->p_config[i].ppf_action =
1941 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1942 p_module->p_config[i].ppsz_action_text =
1943 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1945 for (int j = 0; j < p_module->p_config[i].i_action; j++)
1947 p_module->p_config[i].ppf_action[j] = 0;
1948 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1952 LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1959 return VLC_EGENERIC;
1962 /*****************************************************************************
1963 * SavePluginsCache: saves the plugins cache to a file
1964 *****************************************************************************/
1965 static void CacheSave( vlc_object_t *p_this )
1967 static char const psz_tag[] =
1968 "Signature: 8a477f597d28d172789f06886806bc55\r\n"
1969 "# This file is a cache directory tag created by VLC.\r\n"
1970 "# For information about cache directory tags, see:\r\n"
1971 "# http://www.brynosaurus.com/cachedir/\r\n";
1973 char *psz_filename, *psz_homedir;
1976 module_cache_t **pp_cache;
1977 int32_t i_file_size = 0;
1978 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1980 psz_homedir = p_this->p_libvlc->psz_homedir;
1983 msg_Err( p_this, "psz_homedir is null" );
1987 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_DIR "/" ) +
1988 strlen(psz_homedir) + strlen(CacheName()) );
1992 msg_Err( p_this, "out of memory" );
1996 sprintf( psz_filename, "%s/%s", psz_homedir, CONFIG_DIR );
1998 config_CreateDir( p_this, psz_filename );
2000 strcat( psz_filename, "/" PLUGINSCACHE_DIR );
2002 config_CreateDir( p_this, psz_filename );
2004 strcat( psz_filename, "/CACHEDIR.TAG" );
2006 file = utf8_fopen( psz_filename, "wb" );
2009 fwrite( psz_tag, 1, strlen(psz_tag), file );
2013 sprintf( psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
2014 PLUGINSCACHE_DIR, CacheName() );
2016 msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
2018 file = utf8_fopen( psz_filename, "wb" );
2021 msg_Warn( p_this, "could not open plugins cache file %s for writing",
2023 free( psz_filename );
2026 free( psz_filename );
2028 /* Empty space for file size */
2029 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2031 /* Contains version number */
2032 fprintf( file, "%s", PLUGINSCACHE_DIR COPYRIGHT_MESSAGE );
2034 /* Sub-version number (to avoid breakage in the dev version when cache
2035 * structure changes) */
2036 i_file_size = CACHE_SUBVERSION_NUM;
2037 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2040 fprintf( file, "%5.5s", _("C") );
2043 i_file_size = ftell( file );
2044 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2046 i_cache = p_libvlc_global->p_module_bank->i_cache;
2047 pp_cache = p_libvlc_global->p_module_bank->pp_cache;
2049 fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
2051 #define SAVE_IMMEDIATE(a) \
2052 fwrite( &a, sizeof(char), sizeof(a), file )
2053 #define SAVE_STRING(a) \
2054 { i_size = a ? strlen( a ) + 1 : 0; \
2055 fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
2056 if( a ) fwrite( a, sizeof(char), i_size, file ); \
2059 for( i = 0; i < i_cache; i++ )
2062 uint32_t i_submodule;
2064 /* Save common info */
2065 SAVE_STRING( pp_cache[i]->psz_file );
2066 SAVE_IMMEDIATE( pp_cache[i]->i_time );
2067 SAVE_IMMEDIATE( pp_cache[i]->i_size );
2068 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
2070 if( pp_cache[i]->b_junk ) continue;
2072 /* Save additional infos */
2073 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
2074 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
2075 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
2076 SAVE_STRING( pp_cache[i]->p_module->psz_help );
2077 SAVE_STRING( pp_cache[i]->p_module->psz_program );
2078 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2080 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
2082 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
2083 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
2084 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
2085 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
2086 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
2087 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
2090 CacheSaveConfig( pp_cache[i]->p_module, file );
2092 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
2094 i_submodule = pp_cache[i]->p_module->i_children;
2095 SAVE_IMMEDIATE( i_submodule );
2096 for( i_submodule = 0;
2097 i_submodule < (unsigned)pp_cache[i]->p_module->i_children;
2100 module_t *p_module =
2101 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
2103 SAVE_STRING( p_module->psz_object_name );
2104 SAVE_STRING( p_module->psz_shortname );
2105 SAVE_STRING( p_module->psz_longname );
2106 SAVE_STRING( p_module->psz_help );
2107 SAVE_STRING( p_module->psz_program );
2108 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2110 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
2112 SAVE_STRING( p_module->psz_capability );
2113 SAVE_IMMEDIATE( p_module->i_score );
2114 SAVE_IMMEDIATE( p_module->i_cpu );
2115 SAVE_IMMEDIATE( p_module->b_unloadable );
2116 SAVE_IMMEDIATE( p_module->b_reentrant );
2120 /* Fill-up file size */
2121 i_file_size = ftell( file );
2122 fseek( file, 0, SEEK_SET );
2123 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2130 void CacheSaveConfig( module_t *p_module, FILE *file )
2132 uint32_t i_lines = p_module->confsize;
2135 SAVE_IMMEDIATE( p_module->i_config_items );
2136 SAVE_IMMEDIATE( p_module->i_bool_items );
2137 SAVE_IMMEDIATE( i_lines );
2139 for (size_t i = 0; i < i_lines ; i++)
2141 SAVE_IMMEDIATE( p_module->p_config[i] );
2143 SAVE_STRING( p_module->p_config[i].psz_type );
2144 SAVE_STRING( p_module->p_config[i].psz_name );
2145 SAVE_STRING( p_module->p_config[i].psz_text );
2146 SAVE_STRING( p_module->p_config[i].psz_longtext );
2147 SAVE_STRING( p_module->p_config[i].psz_current );
2148 if (IsConfigStringType (p_module->p_config[i].i_type))
2149 SAVE_STRING( p_module->p_config[i].orig.psz );
2151 if( p_module->p_config[i].i_list )
2153 if( p_module->p_config[i].ppsz_list )
2155 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2156 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
2159 if( p_module->p_config[i].ppsz_list_text )
2161 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2162 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
2164 if( p_module->p_config[i].pi_list )
2166 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2167 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
2171 for (int j = 0; j < p_module->p_config[i].i_action; j++)
2172 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
2174 SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
2178 /*****************************************************************************
2179 * CacheName: Return the cache file name for this platform.
2180 *****************************************************************************/
2181 static char *CacheName( void )
2183 static char psz_cachename[32];
2185 /* Code int size, pointer size and endianness in the filename */
2186 int32_t x = 0xbe00001e;
2187 sprintf( psz_cachename, "plugins-%.2x%.2x%.2x.dat", (int)sizeof(int),
2188 (int)sizeof(void *), (unsigned int)((unsigned char *)&x)[0] );
2189 return psz_cachename;
2192 /*****************************************************************************
2193 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
2194 *****************************************************************************/
2195 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
2196 module_t *p_module )
2201 p_cache->pf_activate = p_module->pf_activate;
2202 p_cache->pf_deactivate = p_module->pf_deactivate;
2203 p_cache->handle = p_module->handle;
2205 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
2207 module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
2208 module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
2209 p_cchild->pf_activate = p_child->pf_activate;
2210 p_cchild->pf_deactivate = p_child->pf_deactivate;
2213 p_cache->b_loaded = VLC_TRUE;
2214 p_module->b_loaded = VLC_FALSE;
2217 /*****************************************************************************
2218 * CacheFind: finds the cache entry corresponding to a file
2219 *****************************************************************************/
2220 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2221 int64_t i_time, int64_t i_size )
2223 module_cache_t **pp_cache;
2225 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
2227 pp_cache = p_libvlc_global->p_module_bank->pp_loaded_cache;
2228 i_cache = p_libvlc_global->p_module_bank->i_loaded_cache;
2230 for( i = 0; i < i_cache; i++ )
2232 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2233 pp_cache[i]->i_time == i_time &&
2234 pp_cache[i]->i_size == i_size ) return pp_cache[i];
2240 #endif /* HAVE_DYNAMIC_PLUGINS */