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;
200 * Store the symbols to be exported
202 #if defined (HAVE_DYNAMIC_PLUGINS) && !defined (HAVE_SHARED_LIBVLC)
203 STORE_SYMBOLS( &p_bank->symbols );
206 /* Everything worked, attach the object */
207 p_libvlc_global->p_module_bank = p_bank;
208 vlc_object_attach( p_bank, p_libvlc_global );
210 module_LoadMain( p_this );
214 /*****************************************************************************
215 * module_EndBank: empty the module bank.
216 *****************************************************************************
217 * This function unloads all unused plugin modules and empties the module
218 * bank in case of success.
219 *****************************************************************************/
220 void __module_EndBank( vlc_object_t *p_this )
222 module_t * p_next = NULL;
224 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
226 var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
227 var_Get( p_libvlc_global, "libvlc", &lockval );
228 vlc_mutex_lock( lockval.p_address );
229 if( !p_libvlc_global->p_module_bank )
231 vlc_mutex_unlock( lockval.p_address );
232 var_Destroy( p_libvlc_global, "libvlc" );
235 if( --p_libvlc_global->p_module_bank->i_usage )
237 vlc_mutex_unlock( lockval.p_address );
238 var_Destroy( p_libvlc_global, "libvlc" );
241 vlc_mutex_unlock( lockval.p_address );
242 var_Destroy( p_libvlc_global, "libvlc" );
244 config_AutoSaveConfigFile( p_this );
246 #ifdef HAVE_DYNAMIC_PLUGINS
247 # define p_bank p_libvlc_global->p_module_bank
248 if( p_bank->b_cache ) CacheSave( p_this );
249 while( p_bank->i_loaded_cache-- )
251 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
253 DeleteModule( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module,
254 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->b_used );
255 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
256 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
257 p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
260 if( p_bank->pp_loaded_cache )
262 free( p_bank->pp_loaded_cache );
263 p_bank->pp_loaded_cache = NULL;
265 while( p_bank->i_cache-- )
267 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
268 free( p_bank->pp_cache[p_bank->i_cache] );
269 p_bank->pp_cache[p_bank->i_cache] = NULL;
271 if( p_bank->pp_cache )
273 free( p_bank->pp_cache );
274 p_bank->pp_cache = NULL;
279 vlc_object_detach( p_libvlc_global->p_module_bank );
281 while( p_libvlc_global->p_module_bank->i_children )
283 p_next = (module_t *)p_libvlc_global->p_module_bank->pp_children[0];
285 if( DeleteModule( p_next, VLC_TRUE ) )
287 /* Module deletion failed */
288 msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
289 p_next->psz_object_name );
291 /* We just free the module by hand. Niahahahahaha. */
292 vlc_object_detach( p_next );
293 vlc_object_destroy( p_next );
297 vlc_object_destroy( p_libvlc_global->p_module_bank );
298 p_libvlc_global->p_module_bank = NULL;
301 /*****************************************************************************
302 * module_LoadMain: load the main program info into the module bank.
303 *****************************************************************************
304 * This function fills the module bank structure with the main module infos.
305 * This is very useful as it will allow us to consider the main program just
306 * as another module, and for instance the configuration options of main will
307 * be available in the module bank structure just as for every other module.
308 *****************************************************************************/
309 static void module_LoadMain( vlc_object_t *p_this )
312 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
314 var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
315 var_Get( p_libvlc_global, "libvlc", &lockval );
316 vlc_mutex_lock( lockval.p_address );
317 if( p_libvlc_global->p_module_bank->b_main )
319 vlc_mutex_unlock( lockval.p_address );
320 var_Destroy( p_libvlc_global, "libvlc" );
323 p_libvlc_global->p_module_bank->b_main = VLC_TRUE;
324 vlc_mutex_unlock( lockval.p_address );
325 var_Destroy( p_libvlc_global, "libvlc" );
327 AllocateBuiltinModule( p_this, vlc_entry__main );
330 /*****************************************************************************
331 * module_LoadBuiltins: load all modules which we built with.
332 *****************************************************************************
333 * This function fills the module bank structure with the builtin modules.
334 *****************************************************************************/
335 void __module_LoadBuiltins( vlc_object_t * p_this )
338 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
340 var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
341 var_Get( p_libvlc_global, "libvlc", &lockval );
342 vlc_mutex_lock( lockval.p_address );
343 if( p_libvlc_global->p_module_bank->b_builtins )
345 vlc_mutex_unlock( lockval.p_address );
346 var_Destroy( p_libvlc_global, "libvlc" );
349 p_libvlc_global->p_module_bank->b_builtins = VLC_TRUE;
350 vlc_mutex_unlock( lockval.p_address );
351 var_Destroy( p_libvlc_global, "libvlc" );
353 msg_Dbg( p_this, "checking builtin modules" );
354 ALLOCATE_ALL_BUILTINS();
357 /*****************************************************************************
358 * module_LoadPlugins: load all plugin modules we can find.
359 *****************************************************************************
360 * This function fills the module bank structure with the plugin modules.
361 *****************************************************************************/
362 void __module_LoadPlugins( vlc_object_t * p_this )
364 #ifdef HAVE_DYNAMIC_PLUGINS
366 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
368 var_Create( p_libvlc_global, "libvlc", VLC_VAR_MUTEX );
369 var_Get( p_libvlc_global, "libvlc", &lockval );
370 vlc_mutex_lock( lockval.p_address );
371 if( p_libvlc_global->p_module_bank->b_plugins )
373 vlc_mutex_unlock( lockval.p_address );
374 var_Destroy( p_libvlc_global, "libvlc" );
377 p_libvlc_global->p_module_bank->b_plugins = VLC_TRUE;
378 vlc_mutex_unlock( lockval.p_address );
379 var_Destroy( p_libvlc_global, "libvlc" );
381 msg_Dbg( p_this, "checking plugin modules" );
383 if( config_GetInt( p_this, "plugins-cache" ) )
384 p_libvlc_global->p_module_bank->b_cache = VLC_TRUE;
386 if( p_libvlc_global->p_module_bank->b_cache ||
387 p_libvlc_global->p_module_bank->b_cache_delete ) CacheLoad( p_this );
389 AllocateAllPlugins( p_this );
393 /*****************************************************************************
394 * module_Need: return the best module function, given a capability list.
395 *****************************************************************************
396 * This function returns the module that best fits the asked capabilities.
397 *****************************************************************************/
398 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
399 const char *psz_name, vlc_bool_t b_strict )
401 typedef struct module_list_t module_list_t;
408 module_list_t *p_next;
411 module_list_t *p_list, *p_first, *p_tmp;
414 int i_which_module, i_index = 0;
415 vlc_bool_t b_intf = VLC_FALSE;
420 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
421 vlc_bool_t b_force_backup = p_this->b_force;
424 /* Deal with variables */
425 if( psz_name && psz_name[0] == '$' )
428 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
429 var_Get( p_this, psz_name + 1, &val );
430 psz_var = val.psz_string;
434 /* Count how many different shortcuts were asked for */
435 if( psz_name && *psz_name )
437 char *psz_parser, *psz_last_shortcut;
439 /* If the user wants none, give him none. */
440 if( !strcmp( psz_name, "none" ) )
447 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
449 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
451 if( *psz_parser == ',' )
455 psz_last_shortcut = psz_parser + 1;
459 /* Check if the user wants to override the "strict" mode */
460 if( psz_last_shortcut )
462 if( !strcmp(psz_last_shortcut, "none") )
467 else if( !strcmp(psz_last_shortcut, "any") )
469 b_strict = VLC_FALSE;
475 /* Sort the modules and test them */
476 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
477 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
479 unsigned i_cpu = vlc_CPU();
481 /* Parse the module list for capabilities and probe each of them */
482 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
484 int i_shortcut_bonus = 0;
486 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
488 /* Test that this module can do what we need */
489 if( strcmp( p_module->psz_capability, psz_capability ) )
491 /* Don't recurse through the sub-modules because vlc_list_find()
492 * will list them anyway. */
496 /* Test if we have the required CPU */
497 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
502 /* If we required a shortcut, check this plugin provides it. */
503 if( i_shortcuts > 0 )
506 const char *psz_name = psz_shortcuts;
508 /* Let's drop modules with a <= 0 score (unless they are
509 * explicitly requested) */
510 b_trash = p_module->i_score <= 0;
512 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
514 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
517 if( ( c = strchr( psz_name, '@' ) )
518 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
520 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
525 i_shortcut_bonus = i_short * 10000;
530 /* Go to the next shortcut... This is so lame! */
531 psz_name += strlen( psz_name ) + 1;
534 /* If we are in "strict" mode and we couldn't
535 * find the module in the list of provided shortcuts,
536 * then kick the bastard out of here!!! */
540 /* If we didn't require a shortcut, trash <= 0 scored plugins */
541 else if( p_module->i_score <= 0 )
548 /* Special case: test if we requested a particular intf plugin */
549 if( !i_shortcuts && p_module->psz_program
550 && !strcmp( psz_capability, "interface" )
551 && !strcmp( p_module->psz_program,
552 p_this->p_libvlc->psz_object_name ) )
556 /* Remove previous non-matching plugins */
563 /* This one doesn't match */
567 /* Store this new module */
568 p_list[ i_index ].p_module = p_module;
569 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
570 p_list[ i_index ].b_force = i_shortcut_bonus && b_strict;
572 /* Add it to the modules-to-probe list */
575 p_list[ 0 ].p_next = NULL;
580 /* Ok, so at school you learned that quicksort is quick, and
581 * bubble sort sucks raw eggs. But that's when dealing with
582 * thousands of items. Here we have barely 50. */
583 module_list_t *p_newlist = p_first;
585 if( p_first->i_score < p_list[ i_index ].i_score )
587 p_list[ i_index ].p_next = p_first;
588 p_first = &p_list[ i_index ];
592 while( p_newlist->p_next != NULL &&
593 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
595 p_newlist = p_newlist->p_next;
598 p_list[ i_index ].p_next = p_newlist->p_next;
599 p_newlist->p_next = &p_list[ i_index ];
606 msg_Dbg( p_this, "looking for %s module: %i candidate%s", psz_capability,
607 i_index, i_index == 1 ? "" : "s" );
609 /* Lock all candidate modules */
611 while( p_tmp != NULL )
613 vlc_object_yield( p_tmp->p_module );
614 p_tmp = p_tmp->p_next;
617 /* We can release the list, interesting modules were yielded */
618 vlc_list_release( p_all );
620 /* Parse the linked list and use the first successful module */
622 while( p_tmp != NULL )
624 #ifdef HAVE_DYNAMIC_PLUGINS
625 /* Make sure the module is loaded in mem */
626 module_t *p_module = p_tmp->p_module;
627 if( p_module->b_submodule )
628 p_module = (module_t *)p_module->p_parent;
630 if( !p_module->b_builtin && !p_module->b_loaded )
632 module_t *p_new_module =
633 AllocatePlugin( p_this, p_module->psz_filename );
636 CacheMerge( p_this, p_module, p_new_module );
637 vlc_object_attach( p_new_module, p_module );
638 DeleteModule( p_new_module, VLC_TRUE );
643 p_this->b_force = p_tmp->b_force;
644 if( p_tmp->p_module->pf_activate
645 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
650 vlc_object_release( p_tmp->p_module );
651 p_tmp = p_tmp->p_next;
654 /* Store the locked module value */
657 p_module = p_tmp->p_module;
658 p_tmp = p_tmp->p_next;
665 /* Unlock the remaining modules */
666 while( p_tmp != NULL )
668 vlc_object_release( p_tmp->p_module );
669 p_tmp = p_tmp->p_next;
673 p_this->b_force = b_force_backup;
675 if( p_module != NULL )
677 msg_Dbg( p_this, "using %s module \"%s\"",
678 psz_capability, p_module->psz_object_name );
680 else if( p_first == NULL )
682 if( !strcmp( psz_capability, "access_demux" ) )
684 msg_Warn( p_this, "no %s module matched \"%s\"",
685 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
689 msg_Err( p_this, "no %s module matched \"%s\"",
690 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
692 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
693 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
696 else if( psz_name != NULL && *psz_name )
698 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
699 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
702 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
704 if( p_module && !p_this->psz_object_name )
706 /* This assumes that p_this is the object which will be using the
707 * module. That's not always the case ... but it is in most cases.
710 p_this->psz_object_name = strdup( psz_alias );
712 p_this->psz_object_name = strdup( p_module->psz_object_name );
715 free( psz_shortcuts );
718 /* Don't forget that the module is still locked */
722 /*****************************************************************************
723 * module_Unneed: decrease the usage count of a module.
724 *****************************************************************************
725 * This function must be called by the thread that called module_Need, to
726 * decrease the reference count and allow for hiding of modules.
727 *****************************************************************************/
728 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
730 /* Use the close method */
731 if( p_module->pf_deactivate )
733 p_module->pf_deactivate( p_this );
736 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
738 vlc_object_release( p_module );
743 /*****************************************************************************
744 * module_Exists: tell if a module exists.
745 *****************************************************************************
746 * This function is a boolean function that tells if a module exist or not.
747 *****************************************************************************/
749 vlc_bool_t __module_Exists( vlc_object_t *p_this, const char * psz_name )
753 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
754 for( i = 0 ; i < p_list->i_count; i++)
756 const char *psz_module_name =
757 ((module_t *) p_list->p_values[i].p_object)->psz_shortname;
758 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
760 /* We can release the list, and return yes */
761 vlc_list_release( p_list ); return VLC_TRUE;
764 vlc_list_release( p_list ); return VLC_FALSE;
768 /*****************************************************************************
769 * Following functions are local.
770 *****************************************************************************/
772 /*****************************************************************************
773 * AllocateAllPlugins: load all plugin modules we can find.
774 *****************************************************************************/
775 #ifdef HAVE_DYNAMIC_PLUGINS
776 static void AllocateAllPlugins( vlc_object_t *p_this )
778 /* Yes, there are two NULLs because we replace one with "plugin-path". */
779 #if defined( WIN32 ) || defined( UNDER_CE )
780 const char *path[] = { "modules", "", "plugins", NULL, NULL };
782 const char *path[] = { "modules", PLUGIN_PATH, "plugins", NULL, NULL };
785 const char *const *ppsz_path;
787 /* If the user provided a plugin path, we add it to the list */
788 char *userpath = config_GetPsz( p_this, "plugin-path" );
789 path[sizeof(path)/sizeof(path[0]) - 2] = userpath;
791 for (ppsz_path = path; *ppsz_path != NULL; ppsz_path++)
795 if (!**ppsz_path) continue;
797 #if defined( SYS_BEOS ) || defined( __APPLE__ ) || defined( WIN32 )
799 /* Handle relative as well as absolute paths */
801 if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
802 (*ppsz_path)[1] != ':' )
804 if( (*ppsz_path)[0] != '/' )
807 if( 0>= asprintf( &psz_fullpath, "%s"DIR_SEP"%s",
808 vlc_global( p_this )->psz_vlcpath, *ppsz_path) )
813 psz_fullpath = strdup( *ppsz_path );
815 if( psz_fullpath == NULL )
818 msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
820 /* Don't go deeper than 5 subdirectories */
821 AllocatePluginDir( p_this, psz_fullpath, 5 );
823 free( psz_fullpath );
826 /* Free plugin-path */
830 /*****************************************************************************
831 * AllocatePluginDir: recursively parse a directory to look for plugins
832 *****************************************************************************/
833 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
836 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
842 #if defined( UNDER_CE ) || defined( _MSC_VER )
844 wchar_t psz_wpath[MAX_PATH + 256];
845 wchar_t psz_wdir[MAX_PATH];
847 char psz_path[MAX_PATH + 256];
848 WIN32_FIND_DATA finddata;
854 struct dirent * file;
858 if( p_this->p_libvlc->b_die || i_maxdepth < 0 )
863 #if defined( UNDER_CE ) || defined( _MSC_VER )
865 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
867 rc = GetFileAttributes( psz_wdir );
868 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
870 /* Parse all files in the directory */
871 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
873 rc = GetFileAttributes( psz_dir );
874 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
877 /* Parse all files in the directory */
878 sprintf( psz_path, "%s\\*", psz_dir );
881 handle = FindFirstFile( psz_wpath, &finddata );
883 handle = FindFirstFile( psz_path, &finddata );
885 if( handle == INVALID_HANDLE_VALUE )
887 /* Empty directory */
891 /* Parse the directory and try to load all files it contains. */
895 unsigned int i_len = wcslen( finddata.cFileName );
896 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
897 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
899 unsigned int i_len = strlen( finddata.cFileName );
900 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
904 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
905 || !strcmp( finddata.cFileName, ".." ) )
907 if( !FindNextFile( handle, &finddata ) ) break;
912 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
914 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
917 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
919 else if( i_len > strlen( LIBEXT )
920 /* We only load files ending with LIBEXT */
921 && !strncasecmp( psz_path + strlen( psz_path)
923 LIBEXT, strlen( LIBEXT ) ) )
925 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
926 int64_t i_time = 0, i_size = 0;
929 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
932 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
936 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
938 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
939 i_size = attrbuf.nFileSizeHigh;
941 i_size |= attrbuf.nFileSizeLow;
945 AllocatePluginFile( p_this, psz_file, i_time, i_size );
948 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
950 /* Close the directory */
954 dir = opendir( psz_dir );
960 i_dirlen = strlen( psz_dir );
962 /* Parse the directory and try to load all files it contains. */
963 while( !p_this->p_libvlc->b_die && (file = readdir( dir )) )
970 if( !*file->d_name || !strcmp( file->d_name, "." )
971 || !strcmp( file->d_name, ".." ) )
976 i_len = strlen( file->d_name );
977 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
979 sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
981 sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
984 i_stat = stat( psz_file, &statbuf );
985 if( !i_stat && statbuf.st_mode & S_IFDIR )
987 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
989 else if( i_len > strlen( LIBEXT )
990 /* We only load files ending with LIBEXT */
991 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
992 LIBEXT, strlen( LIBEXT ) ) )
994 int64_t i_time = 0, i_size = 0;
998 i_time = statbuf.st_mtime;
999 i_size = statbuf.st_size;
1002 AllocatePluginFile( p_this, psz_file, i_time, i_size );
1008 /* Close the directory */
1014 /*****************************************************************************
1015 * AllocatePluginFile: load a module into memory and initialize it.
1016 *****************************************************************************
1017 * This function loads a dynamically loadable module and allocates a structure
1018 * for its information data. The module can then be handled by module_Need
1019 * and module_Unneed. It can be removed by DeleteModule.
1020 *****************************************************************************/
1021 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
1022 int64_t i_file_time, int64_t i_file_size )
1024 module_t * p_module = NULL;
1025 module_cache_t *p_cache_entry = NULL;
1028 * Check our plugins cache first then load plugin if needed
1031 CacheFind( p_this, psz_file, i_file_time, i_file_size );
1033 if( !p_cache_entry )
1035 p_module = AllocatePlugin( p_this, psz_file );
1039 /* If junk dll, don't try to load it */
1040 if( p_cache_entry->b_junk )
1046 module_config_t *p_item = NULL, *p_end = NULL;
1048 p_module = p_cache_entry->p_module;
1049 p_module->b_loaded = VLC_FALSE;
1051 /* For now we force loading if the module's config contains
1052 * callbacks or actions.
1053 * Could be optimized by adding an API call.*/
1054 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1055 p_item < p_end; p_item++ )
1057 if( p_item->pf_callback || p_item->i_action )
1059 p_module = AllocatePlugin( p_this, psz_file );
1063 if( p_module == p_cache_entry->p_module )
1064 p_cache_entry->b_used = VLC_TRUE;
1070 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1072 /* Everything worked fine !
1073 * The module is ready to be added to the list. */
1074 p_module->b_builtin = VLC_FALSE;
1076 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1077 p_module->psz_object_name, p_module->psz_longname ); */
1079 vlc_object_attach( p_module, p_libvlc_global->p_module_bank );
1081 if( !p_libvlc_global->p_module_bank->b_cache )
1084 #define p_bank p_libvlc_global->p_module_bank
1085 /* Add entry to cache */
1087 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1088 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1089 if( !p_bank->pp_cache[p_bank->i_cache] )
1091 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1092 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1093 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1094 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1095 p_bank->pp_cache[p_bank->i_cache]->b_used = VLC_TRUE;
1096 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1100 return p_module ? 0 : -1;
1103 /*****************************************************************************
1104 * AllocatePlugin: load a module into memory and initialize it.
1105 *****************************************************************************
1106 * This function loads a dynamically loadable module and allocates a structure
1107 * for its information data. The module can then be handled by module_Need
1108 * and module_Unneed. It can be removed by DeleteModule.
1109 *****************************************************************************/
1110 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
1112 module_t * p_module = NULL;
1113 module_handle_t handle;
1115 if( LoadModule( p_this, psz_file, &handle ) )
1118 /* Now that we have successfully loaded the module, we can
1119 * allocate a structure for it */
1120 p_module = vlc_module_create( p_this );
1121 if( p_module == NULL )
1123 msg_Err( p_this, "out of memory" );
1124 CloseModule( handle );
1128 /* We need to fill these since they may be needed by CallEntry() */
1129 p_module->psz_filename = psz_file;
1130 p_module->handle = handle;
1131 p_module->b_loaded = VLC_TRUE;
1133 /* Initialize the module: fill p_module, default config */
1134 if( CallEntry( p_module ) != 0 )
1136 /* We couldn't call module_init() */
1137 vlc_object_destroy( p_module );
1138 CloseModule( handle );
1142 DupModule( p_module );
1143 p_module->psz_filename = strdup( p_module->psz_filename );
1145 /* Everything worked fine ! The module is ready to be added to the list. */
1146 p_module->b_builtin = VLC_FALSE;
1151 /*****************************************************************************
1152 * DupModule: make a plugin module standalone.
1153 *****************************************************************************
1154 * This function duplicates all strings in the module, so that the dynamic
1155 * object can be unloaded. It acts recursively on submodules.
1156 *****************************************************************************/
1157 static void DupModule( module_t *p_module )
1159 const char **pp_shortcut;
1162 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1164 *pp_shortcut = strdup( *pp_shortcut );
1167 /* We strdup() these entries so that they are still valid when the
1168 * module is unloaded. */
1169 p_module->psz_object_name = strdup( p_module->psz_object_name );
1170 p_module->psz_capability = strdup( p_module->psz_capability );
1171 p_module->psz_shortname = p_module->psz_shortname ?
1172 strdup( p_module->psz_shortname ) : NULL;
1173 p_module->psz_longname = strdup( p_module->psz_longname );
1174 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1177 if( p_module->psz_program != NULL )
1179 p_module->psz_program = strdup( p_module->psz_program );
1182 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1184 DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1188 /*****************************************************************************
1189 * UndupModule: free a duplicated module.
1190 *****************************************************************************
1191 * This function frees the allocations done in DupModule().
1192 *****************************************************************************/
1193 static void UndupModule( module_t *p_module )
1195 const char **pp_shortcut;
1198 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1200 UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1203 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1205 free( (void*)*pp_shortcut );
1208 free( (void*)p_module->psz_object_name );
1209 free( (void*)p_module->psz_capability );
1210 free( (void*)p_module->psz_shortname );
1211 free( (void*)p_module->psz_longname );
1212 free( (void*)p_module->psz_help );
1213 free( (void*)p_module->psz_program );
1216 #endif /* HAVE_DYNAMIC_PLUGINS */
1218 /*****************************************************************************
1219 * AllocateBuiltinModule: initialize a builtin module.
1220 *****************************************************************************
1221 * This function registers a builtin module and allocates a structure
1222 * for its information data. The module can then be handled by module_Need
1223 * and module_Unneed. It can be removed by DeleteModule.
1224 *****************************************************************************/
1225 static int AllocateBuiltinModule( vlc_object_t * p_this,
1226 int ( *pf_entry ) ( module_t * ) )
1228 module_t * p_module;
1230 /* Now that we have successfully loaded the module, we can
1231 * allocate a structure for it */
1232 p_module = vlc_module_create( p_this );
1233 if( p_module == NULL )
1235 msg_Err( p_this, "out of memory" );
1239 /* Initialize the module : fill p_module->psz_object_name, etc. */
1240 if( pf_entry( p_module ) != 0 )
1242 /* With a well-written module we shouldn't have to print an
1243 * additional error message here, but just make sure. */
1244 msg_Err( p_this, "failed calling entry point in builtin module" );
1245 vlc_object_destroy( p_module );
1249 /* Everything worked fine ! The module is ready to be added to the list. */
1250 p_module->b_builtin = VLC_TRUE;
1252 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1253 p_module->psz_object_name, p_module->psz_longname ); */
1255 vlc_object_attach( p_module, vlc_global( p_this )->p_module_bank );
1260 /*****************************************************************************
1261 * DeleteModule: delete a module and its structure.
1262 *****************************************************************************
1263 * This function can only be called if the module isn't being used.
1264 *****************************************************************************/
1265 static int DeleteModule( module_t * p_module, vlc_bool_t b_detach )
1267 if( !p_module ) return VLC_EGENERIC;
1269 vlc_object_detach( p_module );
1271 /* We free the structures that we strdup()ed in Allocate*Module(). */
1272 #ifdef HAVE_DYNAMIC_PLUGINS
1273 if( !p_module->b_builtin )
1275 if( p_module->b_loaded && p_module->b_unloadable )
1277 CloseModule( p_module->handle );
1279 UndupModule( p_module );
1280 free( p_module->psz_filename );
1284 /* Free and detach the object's children */
1285 while( p_module->i_children )
1287 vlc_object_t *p_this = p_module->pp_children[0];
1288 vlc_object_detach( p_this );
1289 vlc_object_destroy( p_this );
1292 config_Free( p_module );
1293 vlc_object_destroy( p_module );
1298 #ifdef HAVE_DYNAMIC_PLUGINS
1299 /*****************************************************************************
1300 * CallEntry: call an entry point.
1301 *****************************************************************************
1302 * This function calls a symbol given its name and a module structure. The
1303 * symbol MUST refer to a function returning int and taking a module_t* as
1305 *****************************************************************************/
1306 static int CallEntry( module_t * p_module )
1308 static const char psz_name[] = "vlc_entry" MODULE_SUFFIX;
1309 int (* pf_symbol) ( module_t * p_module );
1311 /* Try to resolve the symbol */
1312 pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1314 if( pf_symbol == NULL )
1316 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1317 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1318 psz_name, p_module->psz_filename );
1319 #elif defined(HAVE_DL_WINDOWS)
1320 char *psz_error = GetWindowsError();
1321 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1322 psz_name, p_module->psz_filename, psz_error );
1324 #elif defined(HAVE_DL_DLOPEN)
1325 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1326 psz_name, p_module->psz_filename, dlerror() );
1327 #elif defined(HAVE_DL_SHL_LOAD)
1328 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1329 psz_name, p_module->psz_filename, strerror(errno) );
1331 # error "Something is wrong in modules.c"
1336 /* We can now try to call the symbol */
1337 if( pf_symbol( p_module ) != 0 )
1339 /* With a well-written module we shouldn't have to print an
1340 * additional error message here, but just make sure. */
1341 msg_Err( p_module, "Failed to call symbol \"%s\" in file `%s'",
1342 psz_name, p_module->psz_filename );
1346 /* Everything worked fine, we can return */
1350 /*****************************************************************************
1351 * LoadModule: loads a dynamic library
1352 *****************************************************************************
1353 * This function loads a dynamically linked library using a system dependant
1354 * method. Will return 0 on success as well as the module handle.
1355 *****************************************************************************/
1356 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1357 module_handle_t *p_handle )
1359 module_handle_t handle;
1361 #if defined(HAVE_DL_DYLD)
1362 NSObjectFileImage image;
1363 NSObjectFileImageReturnCode ret;
1365 ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1367 if( ret != NSObjectFileImageSuccess )
1369 msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1373 /* Open the dynamic module */
1374 handle = NSLinkModule( image, psz_file,
1375 NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1379 NSLinkEditErrors errors;
1380 const char *psz_file, *psz_err;
1382 NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1383 msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1384 NSDestroyObjectFileImage( image );
1388 /* Destroy our image, we won't need it */
1389 NSDestroyObjectFileImage( image );
1391 #elif defined(HAVE_DL_BEOS)
1392 handle = load_add_on( psz_file );
1395 msg_Warn( p_this, "cannot load module `%s'", psz_file );
1399 #elif defined(HAVE_DL_WINDOWS)
1402 wchar_t psz_wfile[MAX_PATH];
1403 MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1404 handle = LoadLibrary( psz_wfile );
1407 handle = LoadLibrary( psz_file );
1409 if( handle == NULL )
1411 char *psz_err = GetWindowsError();
1412 msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1417 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1418 /* static is OK, we are called atomically */
1420 # if defined(SYS_LINUX)
1421 /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1422 * are going to get namespace collisions when two modules have common
1423 * public symbols, but ALSA is being a pest here. */
1424 if( strstr( psz_file, "alsa_plugin" ) )
1426 handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1427 if( handle == NULL )
1429 msg_Warn( p_this, "cannot load module `%s' (%s)",
1430 psz_file, dlerror() );
1436 handle = dlopen( psz_file, RTLD_NOW );
1437 if( handle == NULL )
1439 msg_Warn( p_this, "cannot load module `%s' (%s)",
1440 psz_file, dlerror() );
1444 #elif defined(HAVE_DL_DLOPEN)
1445 # if defined(DL_LAZY)
1446 handle = dlopen( psz_file, DL_LAZY );
1448 handle = dlopen( psz_file, 0 );
1450 if( handle == NULL )
1452 msg_Warn( p_this, "cannot load module `%s' (%s)",
1453 psz_file, dlerror() );
1457 #elif defined(HAVE_DL_SHL_LOAD)
1458 handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1459 if( handle == NULL )
1461 msg_Warn( p_this, "cannot load module `%s' (%s)",
1462 psz_file, strerror(errno) );
1467 # error "Something is wrong in modules.c"
1475 /*****************************************************************************
1476 * CloseModule: unload a dynamic library
1477 *****************************************************************************
1478 * This function unloads a previously opened dynamically linked library
1479 * using a system dependant method. No return value is taken in consideration,
1480 * since some libraries sometimes refuse to close properly.
1481 *****************************************************************************/
1482 static void CloseModule( module_handle_t handle )
1484 #if defined(HAVE_DL_DYLD)
1485 NSUnLinkModule( handle, FALSE );
1487 #elif defined(HAVE_DL_BEOS)
1488 unload_add_on( handle );
1490 #elif defined(HAVE_DL_WINDOWS)
1491 FreeLibrary( handle );
1493 #elif defined(HAVE_DL_DLOPEN)
1498 #elif defined(HAVE_DL_SHL_LOAD)
1499 shl_unload( handle );
1505 /*****************************************************************************
1506 * GetSymbol: get a symbol from a dynamic library
1507 *****************************************************************************
1508 * This function queries a loaded library for a symbol specified in a
1509 * string, and returns a pointer to it. We don't check for dlerror() or
1510 * similar functions, since we want a non-NULL symbol anyway.
1511 *****************************************************************************/
1512 static void * _module_getsymbol( module_handle_t, const char * );
1514 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1516 void * p_symbol = _module_getsymbol( handle, psz_function );
1518 /* MacOS X dl library expects symbols to begin with "_". So do
1519 * some other operating systems. That's really lame, but hey, what
1521 if( p_symbol == NULL )
1523 char psz_call[strlen( psz_function ) + 2];
1525 psz_call[ 0 ] = '_';
1526 memcpy( psz_call + 1, psz_function, sizeof (psz_call) - 1 );
1527 p_symbol = _module_getsymbol( handle, psz_call );
1533 static void * _module_getsymbol( module_handle_t handle,
1534 const char * psz_function )
1536 #if defined(HAVE_DL_DYLD)
1537 NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1538 return NSAddressOfSymbol( sym );
1540 #elif defined(HAVE_DL_BEOS)
1542 if( B_OK == get_image_symbol( handle, psz_function,
1543 B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1552 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1553 wchar_t psz_real[256];
1554 MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1556 return (void *)GetProcAddress( handle, psz_real );
1558 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1559 return (void *)GetProcAddress( handle, (char *)psz_function );
1561 #elif defined(HAVE_DL_DLOPEN)
1562 return dlsym( handle, psz_function );
1564 #elif defined(HAVE_DL_SHL_LOAD)
1566 shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1572 #if defined(HAVE_DL_WINDOWS)
1573 static char * GetWindowsError( void )
1575 #if defined(UNDER_CE)
1576 wchar_t psz_tmp[MAX_PATH];
1577 char * psz_buffer = malloc( MAX_PATH );
1579 char * psz_tmp = malloc( MAX_PATH );
1581 int i = 0, i_error = GetLastError();
1583 FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1584 NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1585 (LPTSTR)psz_tmp, MAX_PATH, NULL );
1587 /* Go to the end of the string */
1588 while( psz_tmp[i] && psz_tmp[i] != _T('\r') && psz_tmp[i] != _T('\n') )
1595 #if defined(UNDER_CE)
1596 swprintf( psz_tmp + i, L" (error %i)", i_error );
1597 psz_tmp[ 255 ] = L'\0';
1599 snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1600 psz_tmp[ 255 ] = '\0';
1604 #if defined(UNDER_CE)
1605 wcstombs( psz_buffer, psz_tmp, MAX_PATH );
1611 #endif /* HAVE_DL_WINDOWS */
1613 /*****************************************************************************
1614 * LoadPluginsCache: loads the plugins cache file
1615 *****************************************************************************
1616 * This function will load the plugin cache if present and valid. This cache
1617 * will in turn be queried by AllocateAllPlugins() to see if it needs to
1618 * actually load the dynamically loadable module.
1619 * This allows us to only fully load plugins when they are actually used.
1620 *****************************************************************************/
1621 static void CacheLoad( vlc_object_t *p_this )
1623 char *psz_filename, *psz_homedir;
1625 int i, j, i_size, i_read;
1626 char p_cachestring[sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE)];
1627 char p_cachelang[6], p_lang[6];
1629 module_cache_t **pp_cache = 0;
1630 int32_t i_file_size, i_marker;
1631 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1633 psz_homedir = p_this->p_libvlc->psz_homedir;
1636 msg_Err( p_this, "psz_homedir is null" );
1640 i_size = asprintf( &psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
1641 PLUGINSCACHE_DIR, CacheName() );
1644 msg_Err( p_this, "out of memory" );
1648 if( p_libvlc_global->p_module_bank->b_cache_delete )
1650 #if !defined( UNDER_CE )
1651 unlink( psz_filename );
1653 wchar_t psz_wf[MAX_PATH];
1654 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
1655 DeleteFile( psz_wf );
1657 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1658 free( psz_filename );
1662 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1664 file = utf8_fopen( psz_filename, "rb" );
1667 msg_Warn( p_this, "could not open plugins cache file %s for reading",
1669 free( psz_filename );
1672 free( psz_filename );
1674 /* Check the file size */
1675 i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
1676 if( i_read != sizeof(i_file_size) )
1678 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1684 fseek( file, 0, SEEK_END );
1685 if( ftell( file ) != i_file_size )
1687 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1688 "(corrupted size)" );
1692 fseek( file, sizeof(i_file_size), SEEK_SET );
1694 /* Check the file is a plugins cache */
1695 i_size = sizeof(PLUGINSCACHE_DIR COPYRIGHT_MESSAGE) - 1;
1696 i_read = fread( p_cachestring, 1, i_size, file );
1697 if( i_read != i_size ||
1698 memcmp( p_cachestring, PLUGINSCACHE_DIR COPYRIGHT_MESSAGE, i_size ) )
1700 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1705 /* Check Sub-version number */
1706 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
1707 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
1709 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1710 "(corrupted header)" );
1715 /* Check the language hasn't changed */
1716 sprintf( p_lang, "%5.5s", _("C") ); i_size = 5;
1717 i_read = fread( p_cachelang, 1, i_size, file );
1718 if( i_read != i_size || memcmp( p_cachelang, p_lang, i_size ) )
1720 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1721 "(language changed)" );
1726 /* Check header marker */
1727 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
1728 if( i_read != sizeof(i_marker) ||
1729 i_marker != ftell( file ) - (int)sizeof(i_marker) )
1731 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1732 "(corrupted header)" );
1737 p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1738 if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
1740 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1741 "(file too short)" );
1747 pp_cache = p_libvlc_global->p_module_bank->pp_loaded_cache =
1748 malloc( i_cache * sizeof(void *) );
1750 #define LOAD_IMMEDIATE(a) \
1751 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1752 #define LOAD_STRING(a) \
1755 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
1756 || ( i_size > 16384 ) ) \
1759 char *psz = malloc( i_size ); \
1760 if( fread( psz, i_size, 1, file ) != 1 ) { \
1764 if( psz[i_size-1] ) { \
1772 for( i = 0; i < i_cache; i++ )
1777 pp_cache[i] = malloc( sizeof(module_cache_t) );
1778 p_libvlc_global->p_module_bank->i_loaded_cache++;
1780 /* Load common info */
1781 LOAD_STRING( pp_cache[i]->psz_file );
1782 LOAD_IMMEDIATE( pp_cache[i]->i_time );
1783 LOAD_IMMEDIATE( pp_cache[i]->i_size );
1784 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1785 pp_cache[i]->b_used = VLC_FALSE;
1787 if( pp_cache[i]->b_junk ) continue;
1789 pp_cache[i]->p_module = vlc_module_create( p_this );
1791 /* Load additional infos */
1792 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1793 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1794 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1795 LOAD_STRING( pp_cache[i]->p_module->psz_help );
1796 LOAD_STRING( pp_cache[i]->p_module->psz_program );
1797 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1799 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1801 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1802 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1803 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1804 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1805 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1806 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1809 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1812 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1814 LOAD_IMMEDIATE( i_submodules );
1816 while( i_submodules-- )
1818 module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
1819 LOAD_STRING( p_module->psz_object_name );
1820 LOAD_STRING( p_module->psz_shortname );
1821 LOAD_STRING( p_module->psz_longname );
1822 LOAD_STRING( p_module->psz_help );
1823 LOAD_STRING( p_module->psz_program );
1824 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1826 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1828 LOAD_STRING( p_module->psz_capability );
1829 LOAD_IMMEDIATE( p_module->i_score );
1830 LOAD_IMMEDIATE( p_module->i_cpu );
1831 LOAD_IMMEDIATE( p_module->b_unloadable );
1832 LOAD_IMMEDIATE( p_module->b_reentrant );
1841 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1844 p_libvlc_global->p_module_bank->i_loaded_cache = 0;
1851 int CacheLoadConfig( module_t *p_module, FILE *file )
1856 /* Calculate the structure length */
1857 LOAD_IMMEDIATE( p_module->i_config_items );
1858 LOAD_IMMEDIATE( p_module->i_bool_items );
1860 LOAD_IMMEDIATE( i_lines );
1862 /* Allocate memory */
1865 p_module->p_config =
1866 (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
1867 if( p_module->p_config == NULL )
1869 p_module->confsize = 0;
1870 msg_Err( p_module, "config error: can't duplicate p_config" );
1874 p_module->confsize = i_lines;
1876 /* Do the duplication job */
1877 for (size_t i = 0; i < i_lines; i++ )
1879 LOAD_IMMEDIATE( p_module->p_config[i] );
1881 LOAD_STRING( p_module->p_config[i].psz_type );
1882 LOAD_STRING( p_module->p_config[i].psz_name );
1883 LOAD_STRING( p_module->p_config[i].psz_text );
1884 LOAD_STRING( p_module->p_config[i].psz_longtext );
1885 LOAD_STRING( p_module->p_config[i].psz_current );
1887 if (IsConfigStringType (p_module->p_config[i].i_type))
1889 LOAD_STRING (p_module->p_config[i].orig.psz);
1890 p_module->p_config[i].value.psz =
1891 (p_module->p_config[i].orig.psz != NULL)
1892 ? strdup (p_module->p_config[i].orig.psz) : NULL;
1893 p_module->p_config[i].saved.psz = NULL;
1897 memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
1898 sizeof (p_module->p_config[i].value));
1899 memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
1900 sizeof (p_module->p_config[i].saved));
1903 p_module->p_config[i].b_dirty = VLC_FALSE;
1905 p_module->p_config[i].p_lock = &p_module->object_lock;
1907 if( p_module->p_config[i].i_list )
1909 if( p_module->p_config[i].ppsz_list )
1912 p_module->p_config[i].ppsz_list =
1913 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1914 if( p_module->p_config[i].ppsz_list )
1916 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1917 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1918 p_module->p_config[i].ppsz_list[j] = NULL;
1921 if( p_module->p_config[i].ppsz_list_text )
1924 p_module->p_config[i].ppsz_list_text =
1925 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1926 if( p_module->p_config[i].ppsz_list_text )
1928 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1929 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1930 p_module->p_config[i].ppsz_list_text[j] = NULL;
1933 if( p_module->p_config[i].pi_list )
1935 p_module->p_config[i].pi_list =
1936 malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1937 if( p_module->p_config[i].pi_list )
1939 for (int j = 0; j < p_module->p_config[i].i_list; j++)
1940 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1945 if( p_module->p_config[i].i_action )
1947 p_module->p_config[i].ppf_action =
1948 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1949 p_module->p_config[i].ppsz_action_text =
1950 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1952 for (int j = 0; j < p_module->p_config[i].i_action; j++)
1954 p_module->p_config[i].ppf_action[j] = 0;
1955 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1959 LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1966 return VLC_EGENERIC;
1969 /*****************************************************************************
1970 * SavePluginsCache: saves the plugins cache to a file
1971 *****************************************************************************/
1972 static void CacheSave( vlc_object_t *p_this )
1974 static char const psz_tag[] =
1975 "Signature: 8a477f597d28d172789f06886806bc55\r\n"
1976 "# This file is a cache directory tag created by VLC.\r\n"
1977 "# For information about cache directory tags, see:\r\n"
1978 "# http://www.brynosaurus.com/cachedir/\r\n";
1980 char *psz_filename, *psz_homedir;
1983 module_cache_t **pp_cache;
1984 int32_t i_file_size = 0;
1985 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
1987 psz_homedir = p_this->p_libvlc->psz_homedir;
1990 msg_Err( p_this, "psz_homedir is null" );
1994 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_DIR "/" ) +
1995 strlen(psz_homedir) + strlen(CacheName()) );
1999 msg_Err( p_this, "out of memory" );
2003 sprintf( psz_filename, "%s/%s", psz_homedir, CONFIG_DIR );
2005 config_CreateDir( p_this, psz_filename );
2007 strcat( psz_filename, "/" PLUGINSCACHE_DIR );
2009 config_CreateDir( p_this, psz_filename );
2011 strcat( psz_filename, "/CACHEDIR.TAG" );
2013 file = utf8_fopen( psz_filename, "wb" );
2016 fwrite( psz_tag, 1, strlen(psz_tag), file );
2020 sprintf( psz_filename, "%s/%s/%s/%s", psz_homedir, CONFIG_DIR,
2021 PLUGINSCACHE_DIR, CacheName() );
2023 msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
2025 file = utf8_fopen( psz_filename, "wb" );
2028 msg_Warn( p_this, "could not open plugins cache file %s for writing",
2030 free( psz_filename );
2033 free( psz_filename );
2035 /* Empty space for file size */
2036 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2038 /* Contains version number */
2039 fprintf( file, "%s", PLUGINSCACHE_DIR COPYRIGHT_MESSAGE );
2041 /* Sub-version number (to avoid breakage in the dev version when cache
2042 * structure changes) */
2043 i_file_size = CACHE_SUBVERSION_NUM;
2044 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2047 fprintf( file, "%5.5s", _("C") );
2050 i_file_size = ftell( file );
2051 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2053 i_cache = p_libvlc_global->p_module_bank->i_cache;
2054 pp_cache = p_libvlc_global->p_module_bank->pp_cache;
2056 fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
2058 #define SAVE_IMMEDIATE(a) \
2059 fwrite( &a, sizeof(char), sizeof(a), file )
2060 #define SAVE_STRING(a) \
2061 { i_size = a ? strlen( a ) + 1 : 0; \
2062 fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
2063 if( a ) fwrite( a, sizeof(char), i_size, file ); \
2066 for( i = 0; i < i_cache; i++ )
2069 uint32_t i_submodule;
2071 /* Save common info */
2072 SAVE_STRING( pp_cache[i]->psz_file );
2073 SAVE_IMMEDIATE( pp_cache[i]->i_time );
2074 SAVE_IMMEDIATE( pp_cache[i]->i_size );
2075 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
2077 if( pp_cache[i]->b_junk ) continue;
2079 /* Save additional infos */
2080 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
2081 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
2082 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
2083 SAVE_STRING( pp_cache[i]->p_module->psz_help );
2084 SAVE_STRING( pp_cache[i]->p_module->psz_program );
2085 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2087 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
2089 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
2090 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
2091 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
2092 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
2093 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
2094 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
2097 CacheSaveConfig( pp_cache[i]->p_module, file );
2099 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
2101 i_submodule = pp_cache[i]->p_module->i_children;
2102 SAVE_IMMEDIATE( i_submodule );
2103 for( i_submodule = 0;
2104 i_submodule < (unsigned)pp_cache[i]->p_module->i_children;
2107 module_t *p_module =
2108 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
2110 SAVE_STRING( p_module->psz_object_name );
2111 SAVE_STRING( p_module->psz_shortname );
2112 SAVE_STRING( p_module->psz_longname );
2113 SAVE_STRING( p_module->psz_help );
2114 SAVE_STRING( p_module->psz_program );
2115 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
2117 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
2119 SAVE_STRING( p_module->psz_capability );
2120 SAVE_IMMEDIATE( p_module->i_score );
2121 SAVE_IMMEDIATE( p_module->i_cpu );
2122 SAVE_IMMEDIATE( p_module->b_unloadable );
2123 SAVE_IMMEDIATE( p_module->b_reentrant );
2127 /* Fill-up file size */
2128 i_file_size = ftell( file );
2129 fseek( file, 0, SEEK_SET );
2130 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
2137 void CacheSaveConfig( module_t *p_module, FILE *file )
2139 uint32_t i_lines = p_module->confsize;
2142 SAVE_IMMEDIATE( p_module->i_config_items );
2143 SAVE_IMMEDIATE( p_module->i_bool_items );
2144 SAVE_IMMEDIATE( i_lines );
2146 for (size_t i = 0; i < i_lines ; i++)
2148 SAVE_IMMEDIATE( p_module->p_config[i] );
2150 SAVE_STRING( p_module->p_config[i].psz_type );
2151 SAVE_STRING( p_module->p_config[i].psz_name );
2152 SAVE_STRING( p_module->p_config[i].psz_text );
2153 SAVE_STRING( p_module->p_config[i].psz_longtext );
2154 SAVE_STRING( p_module->p_config[i].psz_current );
2155 if (IsConfigStringType (p_module->p_config[i].i_type))
2156 SAVE_STRING( p_module->p_config[i].orig.psz );
2158 if( p_module->p_config[i].i_list )
2160 if( p_module->p_config[i].ppsz_list )
2162 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2163 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
2166 if( p_module->p_config[i].ppsz_list_text )
2168 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2169 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
2171 if( p_module->p_config[i].pi_list )
2173 for (int j = 0; j < p_module->p_config[i].i_list; j++)
2174 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
2178 for (int j = 0; j < p_module->p_config[i].i_action; j++)
2179 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
2181 SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
2185 /*****************************************************************************
2186 * CacheName: Return the cache file name for this platform.
2187 *****************************************************************************/
2188 static char *CacheName( void )
2190 static char psz_cachename[32];
2192 /* Code int size, pointer size and endianness in the filename */
2193 int32_t x = 0xbe00001e;
2194 sprintf( psz_cachename, "plugins-%.2x%.2x%.2x.dat", (int)sizeof(int),
2195 (int)sizeof(void *), (unsigned int)((unsigned char *)&x)[0] );
2196 return psz_cachename;
2199 /*****************************************************************************
2200 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
2201 *****************************************************************************/
2202 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
2203 module_t *p_module )
2208 p_cache->pf_activate = p_module->pf_activate;
2209 p_cache->pf_deactivate = p_module->pf_deactivate;
2210 #ifndef HAVE_SHARED_LIBVLC
2211 p_cache->p_symbols = p_module->p_symbols;
2213 p_cache->handle = p_module->handle;
2215 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
2217 module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
2218 module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
2219 p_cchild->pf_activate = p_child->pf_activate;
2220 p_cchild->pf_deactivate = p_child->pf_deactivate;
2221 #ifndef HAVE_SHARED_LIBVLC
2222 p_cchild->p_symbols = p_child->p_symbols;
2226 p_cache->b_loaded = VLC_TRUE;
2227 p_module->b_loaded = VLC_FALSE;
2230 /*****************************************************************************
2231 * CacheFind: finds the cache entry corresponding to a file
2232 *****************************************************************************/
2233 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2234 int64_t i_time, int64_t i_size )
2236 module_cache_t **pp_cache;
2238 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
2240 pp_cache = p_libvlc_global->p_module_bank->pp_loaded_cache;
2241 i_cache = p_libvlc_global->p_module_bank->i_loaded_cache;
2243 for( i = 0; i < i_cache; i++ )
2245 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2246 pp_cache[i]->i_time == i_time &&
2247 pp_cache[i]->i_size == i_size ) return pp_cache[i];
2253 #endif /* HAVE_DYNAMIC_PLUGINS */