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 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
35 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
36 * is set to 64. Don't try to be cleverer. */
37 #ifdef _FILE_OFFSET_BITS
38 #undef _FILE_OFFSET_BITS
41 #include <stdlib.h> /* free(), strtol() */
42 #include <stdio.h> /* sprintf() */
43 #include <string.h> /* strdup() */
50 #ifdef HAVE_SYS_TYPES_H
51 # include <sys/types.h>
53 #ifdef HAVE_SYS_STAT_H
54 # include <sys/stat.h>
60 #if !defined(HAVE_DYNAMIC_PLUGINS)
61 /* no support for plugins */
62 #elif defined(HAVE_DL_DYLD)
63 # if defined(HAVE_MACH_O_DYLD_H)
64 # include <mach-o/dyld.h>
66 #elif defined(HAVE_DL_BEOS)
67 # if defined(HAVE_IMAGE_H)
70 #elif defined(HAVE_DL_WINDOWS)
72 #elif defined(HAVE_DL_DLOPEN)
73 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
76 # if defined(HAVE_SYS_DL_H)
79 #elif defined(HAVE_DL_SHL_LOAD)
80 # if defined(HAVE_DL_H)
85 #include "config/configuration.h"
87 #include "vlc_charset.h"
88 #include "vlc_arrays.h"
90 #include "modules/modules.h"
92 static module_bank_t *p_module_bank = NULL;
93 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
95 int vlc_entry__main( module_t * );
97 /*****************************************************************************
99 *****************************************************************************/
100 #ifdef HAVE_DYNAMIC_PLUGINS
101 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
102 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
104 static int AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
106 static module_t * AllocatePlugin( vlc_object_t *, const char * );
108 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
109 static void DeleteModule ( module_bank_t *, module_t * );
110 #ifdef HAVE_DYNAMIC_PLUGINS
111 static void DupModule ( module_t * );
112 static void UndupModule ( module_t * );
118 * Creates a module bank structure which will be filled later
119 * on with all the modules found.
120 * \param p_this vlc object structure
123 void __module_InitBank( vlc_object_t *p_this )
125 module_bank_t *p_bank = NULL;
127 vlc_mutex_lock( &module_lock );
129 if( p_module_bank == NULL )
131 p_bank = calloc (1, sizeof(*p_bank));
133 p_bank->i_cache = p_bank->i_loaded_cache = 0;
134 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
135 p_bank->b_cache = p_bank->b_cache_dirty = false;
138 /* Everything worked, attach the object */
139 p_module_bank = p_bank;
141 /* Fills the module bank structure with the main module infos.
142 * This is very useful as it will allow us to consider the main
143 * library just as another module, and for instance the configuration
144 * options of main will be available in the module bank structure just
145 * as for every other module. */
146 AllocateBuiltinModule( p_this, vlc_entry__main );
149 p_module_bank->i_usage++;
151 /* We do retain the module bank lock until the plugins are loaded as well.
152 * This is ugly, this staged loading approach is needed: LibVLC gets
153 * some configuration parameters relevant to loading the plugins from
154 * the main (builtin) module. The module bank becomes shared read-only data
155 * once it is ready, so we need to fully serialize initialization.
156 * DO NOT UNCOMMENT the following line unless you managed to squeeze
157 * module_LoadPlugins() before you unlock the mutex. */
158 /*vlc_mutex_unlock( &module_lock );*/
161 #undef module_EndBank
163 * Unloads all unused plugin modules and empties the module
164 * bank in case of success.
165 * \param p_this vlc object structure
168 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
170 module_bank_t *p_bank = p_module_bank;
172 assert (p_bank != NULL);
174 /* Save the configuration */
175 config_AutoSaveConfigFile( p_this );
177 /* If plugins were _not_ loaded, then the caller still has the bank lock
178 * from module_InitBank(). */
180 vlc_mutex_lock( &module_lock );
182 vlc_assert_locked( &module_lock ); not for static mutexes :( */
184 if( --p_bank->i_usage > 0 )
186 vlc_mutex_unlock( &module_lock );
189 p_module_bank = NULL;
190 vlc_mutex_unlock( &module_lock );
192 #ifdef HAVE_DYNAMIC_PLUGINS
193 if( p_bank->b_cache )
194 CacheSave( p_this, p_bank );
195 while( p_bank->i_loaded_cache-- )
197 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
199 DeleteModule( p_bank,
200 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
201 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
202 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
203 p_bank->pp_loaded_cache[p_bank->i_loaded_cache] = NULL;
206 if( p_bank->pp_loaded_cache )
208 free( p_bank->pp_loaded_cache );
209 p_bank->pp_loaded_cache = NULL;
211 while( p_bank->i_cache-- )
213 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
214 free( p_bank->pp_cache[p_bank->i_cache] );
215 p_bank->pp_cache[p_bank->i_cache] = NULL;
217 if( p_bank->pp_cache )
219 free( p_bank->pp_cache );
220 p_bank->pp_cache = NULL;
224 while( p_bank->head != NULL )
225 DeleteModule( p_bank, p_bank->head );
230 #undef module_LoadPlugins
232 * Loads module descriptions for all available plugins.
233 * Fills the module bank structure with the plugin modules.
235 * \param p_this vlc object structure
238 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
240 module_bank_t *p_bank = p_module_bank;
243 /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
245 #ifdef HAVE_DYNAMIC_PLUGINS
246 if( p_bank->i_usage == 1 )
248 msg_Dbg( p_this, "checking plugin modules" );
249 p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
251 if( p_module_bank->b_cache || b_cache_delete )
252 CacheLoad( p_this, p_module_bank, b_cache_delete );
253 AllocateAllPlugins( p_this, p_module_bank );
256 p_module_bank->b_plugins = true;
257 vlc_mutex_unlock( &module_lock );
261 * Checks whether a module implements a capability.
263 * \param m the module
264 * \param cap the capability to check
265 * \return TRUE if the module have the capability
267 bool module_provides( const module_t *m, const char *cap )
269 return !strcmp( m->psz_capability, cap );
273 * Get the internal name of a module
275 * \param m the module
276 * \return the module name
278 const char *module_get_object( const module_t *m )
280 return m->psz_object_name;
284 * Get the human-friendly name of a module.
286 * \param m the module
287 * \param long_name TRUE to have the long name of the module
288 * \return the short or long name of the module
290 const char *module_get_name( const module_t *m, bool long_name )
292 if( long_name && ( m->psz_longname != NULL) )
293 return m->psz_longname;
295 return m->psz_shortname ?: m->psz_object_name;
299 * Get the help for a module
301 * \param m the module
304 const char *module_get_help( const module_t *m )
310 * Get the capability for a module
312 * \param m the module
313 * return the capability
315 const char *module_get_capability( const module_t *m )
317 return m->psz_capability;
321 * Get the score for a module
323 * \param m the module
324 * return the score for the capability
326 int module_get_score( const module_t *m )
331 module_t *module_hold (module_t *m)
333 vlc_hold (&m->vlc_gc_data);
337 void module_release (module_t *m)
339 vlc_release (&m->vlc_gc_data);
343 * Frees the flat list of VLC modules.
344 * @param list list obtained by module_list_get()
345 * @param length number of items on the list
348 void module_list_free (module_t **list)
353 for (size_t i = 0; list[i] != NULL; i++)
354 module_release (list[i]);
359 * Gets the flat list of VLC modules.
360 * @param n [OUT] pointer to the number of modules or NULL
361 * @return NULL-terminated table of module pointers
362 * (release with module_list_free()), or NULL in case of error.
364 module_t **module_list_get (size_t *n)
366 /* TODO: this whole module lookup is quite inefficient */
367 /* Remove this and improve module_need */
368 module_t **tab = NULL;
371 assert (p_module_bank);
372 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
375 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
378 module_list_free (tab);
383 tab[i++] = module_hold (mod);
384 for (module_t *subm = mod->submodule; subm; subm = subm->next)
385 tab[i++] = module_hold (subm);
393 typedef struct module_list_t
400 static int modulecmp (const void *a, const void *b)
402 const module_list_t *la = a, *lb = b;
403 /* Note that qsort() uses _ascending_ order,
404 * so the smallest module is the one with the biggest score. */
405 return lb->i_score - la->i_score;
411 * Return the best module function, given a capability list.
413 * If the p_this object doesn't have it's psz_object_name set, then
414 * psz_object_name will be set to the module's name, unless the user
415 * provided an alias using the "module name@alias" syntax in which case
416 * psz_object_name will be set to the alias.
418 * \param p_this the vlc object
419 * \param psz_capability list of capabilities needed
420 * \param psz_name name of the module asked
421 * \param b_strict TRUE yto use the strict mode
422 * \return the module or NULL in case of a failure
424 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
425 const char *psz_name, bool b_strict )
427 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
429 module_list_t *p_list;
432 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
433 bool b_force_backup = p_this->b_force;
435 /* Deal with variables */
436 if( psz_name && psz_name[0] == '$' )
438 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
441 /* Count how many different shortcuts were asked for */
442 if( psz_name && *psz_name )
444 char *psz_parser, *psz_last_shortcut;
446 /* If the user wants none, give him none. */
447 if( !strcmp( psz_name, "none" ) )
450 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
451 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
452 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
457 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
459 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
461 if( *psz_parser == ',' )
465 psz_last_shortcut = psz_parser + 1;
469 /* Check if the user wants to override the "strict" mode */
470 if( psz_last_shortcut )
472 if( !strcmp(psz_last_shortcut, "none") )
477 else if( !strcmp(psz_last_shortcut, "any") )
485 /* Sort the modules and test them */
487 module_t **p_all = module_list_get (&count);
488 p_list = malloc( count * sizeof( module_list_t ) );
489 unsigned i_cpu = vlc_CPU();
491 /* Parse the module list for capabilities and probe each of them */
493 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
495 bool b_shortcut_bonus = false;
497 /* Test that this module can do what we need */
498 if( !module_provides( p_module, psz_capability ) )
500 /* Test if we have the required CPU */
501 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
504 /* If we required a shortcut, check this plugin provides it. */
505 if( i_shortcuts > 0 )
507 const char *psz_name = psz_shortcuts;
509 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
511 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
514 if( ( c = strchr( psz_name, '@' ) )
515 ? !strncasecmp( psz_name, p_module->pp_shortcuts[i],
517 : !strcasecmp( psz_name, p_module->pp_shortcuts[i] ) )
522 b_shortcut_bonus = true;
527 /* Go to the next shortcut... This is so lame! */
528 psz_name += strlen( psz_name ) + 1;
531 /* If we are in "strict" mode and we couldn't
532 * find the module in the list of provided shortcuts,
533 * then kick the bastard out of here!!! */
538 /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
539 if( p_module->i_score <= 0 )
543 /* Store this new module */
544 p_list[count].p_module = module_hold (p_module);
545 p_list[count].i_score = p_module->i_score;
546 if( b_shortcut_bonus )
547 p_list[count].i_score += 10000;
548 p_list[count].b_force = b_shortcut_bonus && b_strict;
552 /* We can release the list, interesting modules are held */
553 module_list_free (p_all);
555 /* Sort candidates by descending score */
556 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
557 msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
558 count, count == 1 ? "" : "s" );
560 /* Parse the linked list and use the first successful module */
562 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
564 module_t *p_cand = p_list[i].p_module;
565 #ifdef HAVE_DYNAMIC_PLUGINS
566 /* Make sure the module is loaded in mem */
567 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
569 if( !p_real->b_builtin && !p_real->b_loaded )
571 module_t *p_new_module =
572 AllocatePlugin( p_this, p_real->psz_filename );
575 CacheMerge( p_this, p_real, p_new_module );
576 DeleteModule( p_module_bank, p_new_module );
581 p_this->b_force = p_list[i].b_force;
582 if( p_cand->pf_activate
583 && p_cand->pf_activate( p_this ) == VLC_SUCCESS )
586 /* Release the remaining modules */
588 module_release (p_list[i].p_module);
591 module_release( p_cand );
595 p_this->b_force = b_force_backup;
597 if( p_module != NULL )
599 msg_Dbg( p_this, "using %s module \"%s\"",
600 psz_capability, p_module->psz_object_name );
601 if( !p_this->psz_object_name )
603 /* This assumes that p_this is the object which will be using the
604 * module. That's not always the case ... but it is in most cases.
607 p_this->psz_object_name = strdup( psz_alias );
609 p_this->psz_object_name = strdup( p_module->psz_object_name );
612 else if( count == 0 )
614 if( !strcmp( psz_capability, "access_demux" )
615 || !strcmp( psz_capability, "stream_filter" )
616 || !strcmp( psz_capability, "vout_window" ) )
618 msg_Dbg( p_this, "no %s module matched \"%s\"",
619 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
623 msg_Err( p_this, "no %s module matched \"%s\"",
624 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
626 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
627 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
630 else if( psz_name != NULL && *psz_name )
632 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
633 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
636 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
638 free( psz_shortcuts );
641 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
642 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
643 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
645 /* Don't forget that the module is still locked */
652 * This function must be called by the thread that called module_need, to
653 * decrease the reference count and allow for hiding of modules.
654 * \param p_this vlc object structure
655 * \param p_module the module structure
658 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
660 /* Use the close method */
661 if( p_module->pf_deactivate )
663 p_module->pf_deactivate( p_this );
666 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
668 module_release( p_module );
672 * Get a pointer to a module_t given it's name.
674 * \param psz_name the name of the module
675 * \return a pointer to the module or NULL in case of a failure
677 module_t *module_find( const char * psz_name )
679 module_t **list, *module;
681 list = module_list_get (NULL);
685 for (size_t i = 0; (module = list[i]) != NULL; i++)
687 const char *psz_module_name = module->psz_object_name;
689 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
691 module_hold (module);
695 module_list_free (list);
700 * Tell if a module exists and release it in thic case
702 * \param psz_name th name of the module
703 * \return TRUE if the module exists
705 bool module_exists (const char * psz_name)
707 module_t *p_module = module_find (psz_name);
709 module_release (p_module);
710 return p_module != NULL;
714 * Get a pointer to a module_t that matches a shortcut.
715 * This is a temporary hack for SD. Do not re-use (generally multiple modules
716 * can have the same shortcut, so this is *broken* - use module_need()!).
718 * \param psz_shortcut shortcut of the module
719 * \param psz_cap capability of the module
720 * \return a pointer to the module or NULL in case of a failure
722 module_t *module_find_by_shortcut (const char *psz_shortcut)
724 module_t **list, *module;
726 list = module_list_get (NULL);
730 for (size_t i = 0; (module = list[i]) != NULL; i++)
733 (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
736 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
738 module_hold (module);
744 module_list_free (list);
749 * GetModuleNamesForCapability
751 * Return a NULL terminated array with the names of the modules
752 * that have a certain capability.
753 * Free after uses both the string and the table.
754 * \param psz_capability the capability asked
755 * \param pppsz_longname an pointer to an array of string to contain
756 the long names of the modules. If set to NULL the function don't use it.
757 * \return the NULL terminated array
759 char ** module_GetModulesNamesForCapability( const char *psz_capability,
760 char ***pppsz_longname )
765 module_t **list = module_list_get (NULL);
767 /* Proceed in two passes: count the number of modules first */
768 for (size_t i = 0; list[i]; i++)
770 module_t *p_module = list[i];
771 const char *psz_module_capability = p_module->psz_capability;
773 if( psz_module_capability
774 && !strcmp( psz_module_capability, psz_capability ) )
778 /* Then get the names */
779 psz_ret = malloc( sizeof(char*) * (count+1) );
781 *pppsz_longname = malloc( sizeof(char*) * (count+1) );
782 if( !psz_ret || ( pppsz_longname && *pppsz_longname == NULL ) )
787 free( *pppsz_longname );
788 *pppsz_longname = NULL;
790 module_list_free (list);
794 for (size_t i = 0, j = 0; list[i]; i++)
796 module_t *p_module = list[i];
797 const char *psz_module_capability = p_module->psz_capability;
799 if( psz_module_capability
800 && !strcmp( psz_module_capability, psz_capability ) )
802 /* Explicit hack: Use the last shortcut. It _should_ be
803 * different from the object name, at least if the object
804 * contains multiple submodules with the same capability. */
806 while( p_module->pp_shortcuts[k] != NULL )
808 assert( k > 0); /* pp_shortcuts[0] is always set */
809 psz_ret[j] = strdup( p_module->pp_shortcuts[k - 1] );
811 (*pppsz_longname)[j] = strdup( module_get_name( p_module, true ) );
815 psz_ret[count] = NULL;
817 module_list_free (list);
823 * Get the configuration of a module
825 * \param module the module
826 * \param psize the size of the configuration returned
827 * \return the configuration as an array
829 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
832 unsigned size = module->confsize;
833 module_config_t *config = malloc( size * sizeof( *config ) );
835 assert( psize != NULL );
841 for( i = 0, j = 0; i < size; i++ )
843 const module_config_t *item = module->p_config + i;
844 if( item->b_internal /* internal option */
845 || item->b_unsaveable /* non-modifiable option */
846 || item->b_removed /* removed option */ )
849 memcpy( config + j, item, sizeof( *config ) );
858 * Release the configuration
860 * \param the configuration
863 void module_config_free( module_config_t *config )
868 /*****************************************************************************
869 * Following functions are local.
870 *****************************************************************************/
872 /*****************************************************************************
873 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
875 *****************************************************************************/
876 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
880 bool escaped = false;
884 /* Alloc a buffer to store the path */
885 path = malloc( strlen( paths ) + 1 );
886 if( !path ) return NULL;
888 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
889 for( i = 0, done = 0 ; paths[i]; i++ )
891 /* Take care of \\ and \: or \; escapement */
895 path[done++] = paths[i];
898 else if( paths[i] == '/' )
901 else if( paths[i] == '\\' )
904 else if( paths[i] == PATH_SEP_CHAR )
907 path[done++] = paths[i];
911 /* Return the remaining paths */
912 if( remaining_paths ) {
913 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
919 char *psz_vlcpath = NULL;
921 /*****************************************************************************
922 * AllocateAllPlugins: load all plugin modules we can find.
923 *****************************************************************************/
924 #ifdef HAVE_DYNAMIC_PLUGINS
925 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
927 const char *vlcpath = psz_vlcpath;
930 vlc_array_t *arraypaths = vlc_array_new();
932 /* Contruct the special search path for system that have a relocatable
933 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
935 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
936 vlc_array_append( arraypaths, path );
937 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
938 vlc_array_append( arraypaths, path );
940 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
943 /* If the user provided a plugin path, we add it to the list */
944 char *userpaths = config_GetPsz( p_this, "plugin-path" );
947 for( paths_iter = userpaths; paths_iter; )
949 path = copy_next_paths_token( paths_iter, &paths_iter );
951 vlc_array_append( arraypaths, path );
954 count = vlc_array_count( arraypaths );
955 for( i = 0 ; i < count ; i++ )
957 path = vlc_array_item_at_index( arraypaths, i );
961 msg_Dbg( p_this, "recursively browsing `%s'", path );
963 /* Don't go deeper than 5 subdirectories */
964 AllocatePluginDir( p_this, p_bank, path, 5 );
969 vlc_array_destroy( arraypaths );
973 /*****************************************************************************
974 * AllocatePluginDir: recursively parse a directory to look for plugins
975 *****************************************************************************/
976 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
977 const char *psz_dir, unsigned i_maxdepth )
979 /* FIXME: Needs to be ported to wide char on ALL Windows builds */
985 #if defined( UNDER_CE ) || defined( _MSC_VER )
987 wchar_t psz_wpath[MAX_PATH + 256];
988 wchar_t psz_wdir[MAX_PATH];
990 char psz_path[MAX_PATH + 256];
991 WIN32_FIND_DATA finddata;
997 struct dirent * file;
1001 if( i_maxdepth == 0 )
1004 #if defined( UNDER_CE ) || defined( _MSC_VER )
1006 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
1008 rc = GetFileAttributes( psz_wdir );
1009 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
1011 /* Parse all files in the directory */
1012 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
1014 rc = GetFileAttributes( psz_dir );
1015 if( rc<0 || !(rc&FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
1018 /* Parse all files in the directory */
1019 sprintf( psz_path, "%s\\*", psz_dir );
1022 handle = FindFirstFile( psz_wpath, &finddata );
1024 handle = FindFirstFile( psz_path, &finddata );
1026 if( handle == INVALID_HANDLE_VALUE )
1028 /* Empty directory */
1032 /* Parse the directory and try to load all files it contains. */
1036 unsigned int i_len = wcslen( finddata.cFileName );
1037 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
1038 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
1040 unsigned int i_len = strlen( finddata.cFileName );
1041 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
1044 /* Skip ".", ".." */
1045 if( !*finddata.cFileName || !strcmp( finddata.cFileName, "." )
1046 || !strcmp( finddata.cFileName, ".." ) )
1048 if( !FindNextFile( handle, &finddata ) ) break;
1053 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
1055 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
1058 AllocatePluginDir( p_this, p_bank, psz_path, i_maxdepth - 1 );
1060 else if( i_len > strlen( LIBEXT )
1061 /* We only load files ending with LIBEXT */
1062 && !strncasecmp( psz_path + strlen( psz_path)
1064 LIBEXT, strlen( LIBEXT ) ) )
1066 WIN32_FILE_ATTRIBUTE_DATA attrbuf;
1067 int64_t i_time = 0, i_size = 0;
1070 if( GetFileAttributesEx( psz_wpath, GetFileExInfoStandard,
1073 if( GetFileAttributesEx( psz_path, GetFileExInfoStandard,
1077 i_time = attrbuf.ftLastWriteTime.dwHighDateTime;
1079 i_time |= attrbuf.ftLastWriteTime.dwLowDateTime;
1080 i_size = attrbuf.nFileSizeHigh;
1082 i_size |= attrbuf.nFileSizeLow;
1084 psz_file = psz_path;
1086 AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
1089 while( !p_this->p_libvlc->b_die && FindNextFile( handle, &finddata ) );
1091 /* Close the directory */
1092 FindClose( handle );
1095 dir = opendir( psz_dir );
1101 i_dirlen = strlen( psz_dir );
1103 /* Parse the directory and try to load all files it contains. */
1104 while( !p_this->p_libvlc->b_die && ( file = readdir( dir ) ) )
1106 struct stat statbuf;
1110 /* Skip ".", ".." */
1111 if( !*file->d_name || !strcmp( file->d_name, "." )
1112 || !strcmp( file->d_name, ".." ) )
1117 i_len = strlen( file->d_name );
1118 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
1119 sprintf( psz_file, "%s"DIR_SEP"%s", psz_dir, file->d_name );
1121 i_stat = stat( psz_file, &statbuf );
1122 if( !i_stat && statbuf.st_mode & S_IFDIR )
1124 AllocatePluginDir( p_this, p_bank, psz_file, i_maxdepth - 1 );
1126 else if( i_len > strlen( LIBEXT )
1127 /* We only load files ending with LIBEXT */
1128 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
1129 LIBEXT, strlen( LIBEXT ) ) )
1131 int64_t i_time = 0, i_size = 0;
1135 i_time = statbuf.st_mtime;
1136 i_size = statbuf.st_size;
1139 AllocatePluginFile( p_this, p_bank, psz_file, i_time, i_size );
1145 /* Close the directory */
1151 /*****************************************************************************
1152 * AllocatePluginFile: load a module into memory and initialize it.
1153 *****************************************************************************
1154 * This function loads a dynamically loadable module and allocates a structure
1155 * for its information data. The module can then be handled by module_need
1156 * and module_unneed. It can be removed by DeleteModule.
1157 *****************************************************************************/
1158 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
1159 const char *psz_file,
1160 int64_t i_file_time, int64_t i_file_size )
1162 module_t * p_module = NULL;
1163 module_cache_t *p_cache_entry = NULL;
1166 * Check our plugins cache first then load plugin if needed
1168 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
1169 if( !p_cache_entry )
1171 p_module = AllocatePlugin( p_this, psz_file );
1175 /* If junk dll, don't try to load it */
1176 if( p_cache_entry->b_junk )
1182 module_config_t *p_item = NULL, *p_end = NULL;
1184 p_module = p_cache_entry->p_module;
1185 p_module->b_loaded = false;
1187 /* For now we force loading if the module's config contains
1188 * callbacks or actions.
1189 * Could be optimized by adding an API call.*/
1190 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
1191 p_item < p_end; p_item++ )
1193 if( p_item->pf_callback || p_item->i_action )
1195 p_module = AllocatePlugin( p_this, psz_file );
1199 if( p_module == p_cache_entry->p_module )
1200 p_cache_entry->b_used = true;
1206 /* Everything worked fine !
1207 * The module is ready to be added to the list. */
1208 p_module->b_builtin = false;
1210 /* msg_Dbg( p_this, "plugin \"%s\", %s",
1211 p_module->psz_object_name, p_module->psz_longname ); */
1212 p_module->next = p_bank->head;
1213 p_bank->head = p_module;
1215 if( !p_module_bank->b_cache )
1218 /* Add entry to cache */
1220 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1221 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1222 if( !p_bank->pp_cache[p_bank->i_cache] )
1224 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1225 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
1226 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
1227 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1228 p_bank->pp_cache[p_bank->i_cache]->b_used = true;
1229 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
1233 return p_module ? 0 : -1;
1236 /*****************************************************************************
1237 * AllocatePlugin: load a module into memory and initialize it.
1238 *****************************************************************************
1239 * This function loads a dynamically loadable module and allocates a structure
1240 * for its information data. The module can then be handled by module_need
1241 * and module_unneed. It can be removed by DeleteModule.
1242 *****************************************************************************/
1243 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1245 module_t * p_module = NULL;
1246 module_handle_t handle;
1248 if( module_Load( p_this, psz_file, &handle ) )
1251 /* Now that we have successfully loaded the module, we can
1252 * allocate a structure for it */
1253 p_module = vlc_module_create( p_this );
1254 if( p_module == NULL )
1256 module_Unload( handle );
1260 p_module->psz_filename = strdup( psz_file );
1261 p_module->handle = handle;
1262 p_module->b_loaded = true;
1264 /* Initialize the module: fill p_module, default config */
1265 if( module_Call( p_this, p_module ) != 0 )
1267 /* We couldn't call module_init() */
1268 free( p_module->psz_filename );
1269 module_release( p_module );
1270 module_Unload( handle );
1274 DupModule( p_module );
1276 /* Everything worked fine ! The module is ready to be added to the list. */
1277 p_module->b_builtin = false;
1282 /*****************************************************************************
1283 * DupModule: make a plugin module standalone.
1284 *****************************************************************************
1285 * This function duplicates all strings in the module, so that the dynamic
1286 * object can be unloaded. It acts recursively on submodules.
1287 *****************************************************************************/
1288 static void DupModule( module_t *p_module )
1292 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1294 *pp_shortcut = strdup( *pp_shortcut );
1297 /* We strdup() these entries so that they are still valid when the
1298 * module is unloaded. */
1299 p_module->psz_capability = strdup( p_module->psz_capability );
1300 p_module->psz_shortname = p_module->psz_shortname ?
1301 strdup( p_module->psz_shortname ) : NULL;
1302 p_module->psz_longname = strdup( p_module->psz_longname );
1303 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1306 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1310 /*****************************************************************************
1311 * UndupModule: free a duplicated module.
1312 *****************************************************************************
1313 * This function frees the allocations done in DupModule().
1314 *****************************************************************************/
1315 static void UndupModule( module_t *p_module )
1319 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1322 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1324 free( *pp_shortcut );
1327 free( p_module->psz_capability );
1328 FREENULL( p_module->psz_shortname );
1329 free( p_module->psz_longname );
1330 FREENULL( p_module->psz_help );
1333 #endif /* HAVE_DYNAMIC_PLUGINS */
1335 /*****************************************************************************
1336 * AllocateBuiltinModule: initialize a builtin module.
1337 *****************************************************************************
1338 * This function registers a builtin module and allocates a structure
1339 * for its information data. The module can then be handled by module_need
1340 * and module_unneed. It can be removed by DeleteModule.
1341 *****************************************************************************/
1342 static int AllocateBuiltinModule( vlc_object_t * p_this,
1343 int ( *pf_entry ) ( module_t * ) )
1345 module_t * p_module;
1347 /* Now that we have successfully loaded the module, we can
1348 * allocate a structure for it */
1349 p_module = vlc_module_create( p_this );
1350 if( p_module == NULL )
1353 /* Initialize the module : fill p_module->psz_object_name, etc. */
1354 if( pf_entry( p_module ) != 0 )
1356 /* With a well-written module we shouldn't have to print an
1357 * additional error message here, but just make sure. */
1358 msg_Err( p_this, "failed calling entry point in builtin module" );
1359 module_release( p_module );
1363 /* Everything worked fine ! The module is ready to be added to the list. */
1364 p_module->b_builtin = true;
1366 p_module->next = p_module_bank->head;
1367 p_module_bank->head = p_module;
1370 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1371 p_module->psz_object_name, p_module->psz_longname ); */
1376 /*****************************************************************************
1377 * DeleteModule: delete a module and its structure.
1378 *****************************************************************************
1379 * This function can only be called if the module isn't being used.
1380 *****************************************************************************/
1381 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1385 /* Unlist the module (if it is in the list) */
1386 module_t **pp_self = &p_bank->head;
1387 while (*pp_self != NULL && *pp_self != p_module)
1388 pp_self = &((*pp_self)->next);
1390 *pp_self = p_module->next;
1392 /* We free the structures that we strdup()ed in Allocate*Module(). */
1393 #ifdef HAVE_DYNAMIC_PLUGINS
1394 if( !p_module->b_builtin )
1396 if( p_module->b_loaded && p_module->b_unloadable )
1398 module_Unload( p_module->handle );
1400 UndupModule( p_module );
1401 free( p_module->psz_filename );
1405 /* Free and detach the object's children */
1406 while (p_module->submodule)
1408 module_t *submodule = p_module->submodule;
1409 p_module->submodule = submodule->next;
1410 module_release (submodule);
1413 config_Free( p_module );
1414 module_release( p_module );