1 /*****************************************************************************
2 * configuration.c management of the modules configuration
3 *****************************************************************************
4 * Copyright (C) 2001-2004 VideoLAN
5 * $Id: configuration.c,v 1.76 2004/01/29 17:04:01 gbazin Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
27 #include <stdio.h> /* sprintf() */
28 #include <stdlib.h> /* free(), strtol() */
29 #include <string.h> /* strdup() */
31 # include <errno.h> /* errno */
35 # include <unistd.h> /* getuid() */
38 #ifdef HAVE_GETOPT_LONG
40 # include <getopt.h> /* getopt() */
43 # include "../extras/getopt.h"
46 #if defined(HAVE_GETPWUID)
47 # include <pwd.h> /* getpwuid() */
50 #if defined( HAVE_SYS_STAT_H )
51 # include <sys/stat.h>
53 #if defined( HAVE_SYS_TYPES_H )
54 # include <sys/types.h>
57 # if !defined( UNDER_CE )
64 static int ConfigStringToKey( char * );
65 static char *ConfigKeyToString( int );
67 /*****************************************************************************
68 * config_GetType: get the type of a variable (bool, int, float, string)
69 *****************************************************************************
70 * This function is used to get the type of a variable from its name.
71 * Beware, this is quite slow.
72 *****************************************************************************/
73 int __config_GetType( vlc_object_t *p_this, const char *psz_name )
75 module_config_t *p_config;
78 p_config = config_FindConfig( p_this, psz_name );
86 switch( p_config->i_type )
88 case CONFIG_ITEM_BOOL:
89 i_type = VLC_VAR_BOOL;
92 case CONFIG_ITEM_INTEGER:
93 i_type = VLC_VAR_INTEGER;
96 case CONFIG_ITEM_FLOAT:
97 i_type = VLC_VAR_FLOAT;
100 case CONFIG_ITEM_MODULE:
101 i_type = VLC_VAR_MODULE;
104 case CONFIG_ITEM_STRING:
105 i_type = VLC_VAR_STRING;
108 case CONFIG_ITEM_FILE:
109 i_type = VLC_VAR_FILE;
112 case CONFIG_ITEM_DIRECTORY:
113 i_type = VLC_VAR_DIRECTORY;
124 /*****************************************************************************
125 * config_GetInt: get the value of an int variable
126 *****************************************************************************
127 * This function is used to get the value of variables which are internally
128 * represented by an integer (CONFIG_ITEM_INTEGER and
130 *****************************************************************************/
131 int __config_GetInt( vlc_object_t *p_this, const char *psz_name )
133 module_config_t *p_config;
135 p_config = config_FindConfig( p_this, psz_name );
140 msg_Err( p_this, "option %s does not exist", psz_name );
143 if( (p_config->i_type!=CONFIG_ITEM_INTEGER) &&
144 (p_config->i_type!=CONFIG_ITEM_KEY) &&
145 (p_config->i_type!=CONFIG_ITEM_BOOL) )
147 msg_Err( p_this, "option %s does not refer to an int", psz_name );
151 return p_config->i_value;
154 /*****************************************************************************
155 * config_GetFloat: get the value of a float variable
156 *****************************************************************************
157 * This function is used to get the value of variables which are internally
158 * represented by a float (CONFIG_ITEM_FLOAT).
159 *****************************************************************************/
160 float __config_GetFloat( vlc_object_t *p_this, const char *psz_name )
162 module_config_t *p_config;
164 p_config = config_FindConfig( p_this, psz_name );
169 msg_Err( p_this, "option %s does not exist", psz_name );
172 if( p_config->i_type != CONFIG_ITEM_FLOAT )
174 msg_Err( p_this, "option %s does not refer to a float", psz_name );
178 return p_config->f_value;
181 /*****************************************************************************
182 * config_GetPsz: get the string value of a string variable
183 *****************************************************************************
184 * This function is used to get the value of variables which are internally
185 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
186 * CONFIG_ITEM_DIRECTORY, and CONFIG_ITEM_MODULE).
188 * Important note: remember to free() the returned char* because it's a
189 * duplicate of the actual value. It isn't safe to return a pointer to the
190 * actual value as it can be modified at any time.
191 *****************************************************************************/
192 char * __config_GetPsz( vlc_object_t *p_this, const char *psz_name )
194 module_config_t *p_config;
195 char *psz_value = NULL;
197 p_config = config_FindConfig( p_this, psz_name );
202 msg_Err( p_this, "option %s does not exist", psz_name );
205 if( (p_config->i_type!=CONFIG_ITEM_STRING) &&
206 (p_config->i_type!=CONFIG_ITEM_FILE) &&
207 (p_config->i_type!=CONFIG_ITEM_DIRECTORY) &&
208 (p_config->i_type!=CONFIG_ITEM_MODULE) )
210 msg_Err( p_this, "option %s does not refer to a string", psz_name );
214 /* return a copy of the string */
215 vlc_mutex_lock( p_config->p_lock );
216 if( p_config->psz_value ) psz_value = strdup( p_config->psz_value );
217 vlc_mutex_unlock( p_config->p_lock );
222 /*****************************************************************************
223 * config_PutPsz: set the string value of a string variable
224 *****************************************************************************
225 * This function is used to set the value of variables which are internally
226 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
227 * CONFIG_ITEM_DIRECTORY, and CONFIG_ITEM_MODULE).
228 *****************************************************************************/
229 void __config_PutPsz( vlc_object_t *p_this,
230 const char *psz_name, const char *psz_value )
232 module_config_t *p_config;
233 vlc_value_t oldval, val;
235 p_config = config_FindConfig( p_this, psz_name );
240 msg_Warn( p_this, "option %s does not exist", psz_name );
243 if( (p_config->i_type!=CONFIG_ITEM_STRING) &&
244 (p_config->i_type!=CONFIG_ITEM_FILE) &&
245 (p_config->i_type!=CONFIG_ITEM_DIRECTORY) &&
246 (p_config->i_type!=CONFIG_ITEM_MODULE) )
248 msg_Err( p_this, "option %s does not refer to a string", psz_name );
252 vlc_mutex_lock( p_config->p_lock );
254 /* backup old value */
255 oldval.psz_string = p_config->psz_value;
257 if( psz_value && *psz_value ) p_config->psz_value = strdup( psz_value );
258 else p_config->psz_value = NULL;
260 val.psz_string = p_config->psz_value;
262 vlc_mutex_unlock( p_config->p_lock );
264 if( p_config->pf_callback )
266 p_config->pf_callback( p_this, psz_name, oldval, val,
267 p_config->p_callback_data );
270 /* free old string */
271 if( oldval.psz_string ) free( oldval.psz_string );
274 /*****************************************************************************
275 * config_PutInt: set the integer value of an int variable
276 *****************************************************************************
277 * This function is used to set the value of variables which are internally
278 * represented by an integer (CONFIG_ITEM_INTEGER and
280 *****************************************************************************/
281 void __config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
283 module_config_t *p_config;
284 vlc_value_t oldval, val;
286 p_config = config_FindConfig( p_this, psz_name );
291 msg_Warn( p_this, "option %s does not exist", psz_name );
294 if( (p_config->i_type!=CONFIG_ITEM_INTEGER) &&
295 (p_config->i_type!=CONFIG_ITEM_KEY) &&
296 (p_config->i_type!=CONFIG_ITEM_BOOL) )
298 msg_Err( p_this, "option %s does not refer to an int", psz_name );
302 /* backup old value */
303 oldval.i_int = p_config->i_value;
305 /* if i_min == i_max == 0, then do not use them */
306 if ((p_config->i_min == 0) && (p_config->i_max == 0))
308 p_config->i_value = i_value;
310 else if (i_value < p_config->i_min)
312 p_config->i_value = p_config->i_min;
314 else if (i_value > p_config->i_max)
316 p_config->i_value = p_config->i_max;
320 p_config->i_value = i_value;
323 val.i_int = p_config->i_value;
325 if( p_config->pf_callback )
327 p_config->pf_callback( p_this, psz_name, oldval, val,
328 p_config->p_callback_data );
332 /*****************************************************************************
333 * config_PutFloat: set the value of a float variable
334 *****************************************************************************
335 * This function is used to set the value of variables which are internally
336 * represented by a float (CONFIG_ITEM_FLOAT).
337 *****************************************************************************/
338 void __config_PutFloat( vlc_object_t *p_this,
339 const char *psz_name, float f_value )
341 module_config_t *p_config;
342 vlc_value_t oldval, val;
344 p_config = config_FindConfig( p_this, psz_name );
349 msg_Warn( p_this, "option %s does not exist", psz_name );
352 if( p_config->i_type != CONFIG_ITEM_FLOAT )
354 msg_Err( p_this, "option %s does not refer to a float", psz_name );
358 /* backup old value */
359 oldval.f_float = p_config->f_value;
361 /* if f_min == f_max == 0, then do not use them */
362 if ((p_config->f_min == 0) && (p_config->f_max == 0))
364 p_config->f_value = f_value;
366 else if (f_value < p_config->f_min)
368 p_config->f_value = p_config->f_min;
370 else if (f_value > p_config->f_max)
372 p_config->f_value = p_config->f_max;
376 p_config->f_value = f_value;
379 val.f_float = p_config->f_value;
381 if( p_config->pf_callback )
383 p_config->pf_callback( p_this, psz_name, oldval, val,
384 p_config->p_callback_data );
388 /*****************************************************************************
389 * config_FindConfig: find the config structure associated with an option.
390 *****************************************************************************
391 * FIXME: This function really needs to be optimized.
392 * FIXME: And now even more.
393 *****************************************************************************/
394 module_config_t *config_FindConfig( vlc_object_t *p_this, const char *psz_name )
398 module_config_t *p_item;
401 if( !psz_name ) return NULL;
403 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
405 for( i_index = 0; i_index < p_list->i_count; i_index++ )
407 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
409 if( !p_parser->i_config_items )
412 for( p_item = p_parser->p_config;
413 p_item->i_type != CONFIG_HINT_END;
416 if( p_item->i_type & CONFIG_HINT )
419 if( !strcmp( psz_name, p_item->psz_name ) )
421 vlc_list_release( p_list );
427 vlc_list_release( p_list );
432 /*****************************************************************************
433 * config_FindModule: find a specific module structure.
434 *****************************************************************************/
435 module_t *config_FindModule( vlc_object_t *p_this, const char *psz_name )
438 module_t *p_module, *p_result = NULL;
441 if( !psz_name ) return NULL;
443 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
445 for( i_index = 0; i_index < p_list->i_count; i_index++ )
447 p_module = (module_t *)p_list->p_values[i_index].p_object;
448 if( !strcmp( p_module->psz_object_name, psz_name ) )
455 vlc_list_release( p_list );
460 /*****************************************************************************
461 * config_Duplicate: creates a duplicate of a module's configuration data.
462 *****************************************************************************
463 * Unfortunatly we cannot work directly with the module's config data as
464 * this module might be unloaded from memory at any time (remember HideModule).
465 * This is why we need to create an exact copy of the config data.
466 *****************************************************************************/
467 void config_Duplicate( module_t *p_module, module_config_t *p_orig )
469 int i, j, i_lines = 1;
470 module_config_t *p_item;
472 /* Calculate the structure length */
473 p_module->i_config_items = 0;
474 p_module->i_bool_items = 0;
476 for( p_item = p_orig; p_item->i_type != CONFIG_HINT_END; p_item++ )
480 if( p_item->i_type & CONFIG_ITEM )
482 p_module->i_config_items++;
485 if( p_item->i_type == CONFIG_ITEM_BOOL )
487 p_module->i_bool_items++;
491 /* Allocate memory */
492 p_module->p_config = (module_config_t *)malloc( sizeof(module_config_t)
494 if( p_module->p_config == NULL )
496 msg_Err( p_module, "config error: can't duplicate p_config" );
500 /* Do the duplication job */
501 for( i = 0; i < i_lines ; i++ )
503 p_module->p_config[i] = p_orig[i];
505 p_module->p_config[i].i_value_orig = p_orig[i].i_value;
506 p_module->p_config[i].f_value_orig = p_orig[i].f_value;
508 p_module->p_config[i].psz_type = p_orig[i].psz_type ?
509 strdup( p_orig[i].psz_type ) : NULL;
510 p_module->p_config[i].psz_name = p_orig[i].psz_name ?
511 strdup( p_orig[i].psz_name ) : NULL;
512 p_module->p_config[i].psz_text = p_orig[i].psz_text ?
513 strdup( _(p_orig[i].psz_text) ) : NULL;
514 p_module->p_config[i].psz_longtext = p_orig[i].psz_longtext ?
515 strdup( _(p_orig[i].psz_longtext) ) : NULL;
516 p_module->p_config[i].psz_value = p_orig[i].psz_value ?
517 strdup( p_orig[i].psz_value ) : NULL;
518 p_module->p_config[i].psz_value_orig = p_orig[i].psz_value ?
519 strdup( p_orig[i].psz_value ) : NULL;
521 p_module->p_config[i].p_lock = &p_module->object_lock;
523 /* duplicate the string list */
524 if( p_orig[i].i_list )
526 if( p_orig[i].ppsz_list )
528 p_module->p_config[i].ppsz_list =
529 malloc( (p_orig[i].i_list + 1) * sizeof(char *) );
530 if( p_module->p_config[i].ppsz_list )
532 for( j = 0; j < p_orig[i].i_list; j++ )
533 p_module->p_config[i].ppsz_list[j] =
534 strdup( p_orig[i].ppsz_list[j] );
535 p_module->p_config[i].ppsz_list[j] = NULL;
538 if( p_orig[i].ppsz_list_text )
540 p_module->p_config[i].ppsz_list_text =
541 malloc( (p_orig[i].i_list + 1) * sizeof(char *) );
542 if( p_module->p_config[i].ppsz_list_text )
544 for( j = 0; j < p_orig[i].i_list; j++ )
545 p_module->p_config[i].ppsz_list_text[j] =
546 strdup( _(p_orig[i].ppsz_list_text[j]) );
547 p_module->p_config[i].ppsz_list_text[j] = NULL;
550 if( p_orig[i].pi_list )
552 p_module->p_config[i].pi_list =
553 malloc( (p_orig[i].i_list + 1) * sizeof(int) );
554 if( p_module->p_config[i].pi_list )
556 for( j = 0; j < p_orig[i].i_list; j++ )
557 p_module->p_config[i].pi_list[j] =
558 p_orig[i].pi_list[j];
563 /* duplicate the actions list */
564 if( p_orig[i].i_action )
568 p_module->p_config[i].ppf_action =
569 malloc( p_orig[i].i_action * sizeof(void *) );
570 p_module->p_config[i].ppsz_action_text =
571 malloc( p_orig[i].i_action * sizeof(char *) );
573 for( j = 0; j < p_orig[i].i_action; j++ )
575 p_module->p_config[i].ppf_action[j] =
576 p_orig[i].ppf_action[j];
577 p_module->p_config[i].ppsz_action_text[j] =
578 p_orig[i].ppsz_action_text[j] ?
579 strdup( p_orig[i].ppsz_action_text[j] ) : NULL;
583 p_module->p_config[i].pf_callback = p_orig[i].pf_callback;
587 /*****************************************************************************
588 * config_Free: frees a duplicated module's configuration data.
589 *****************************************************************************
590 * This function frees all the data duplicated by config_Duplicate.
591 *****************************************************************************/
592 void config_Free( module_t *p_module )
594 module_config_t *p_item = p_module->p_config;
602 for( ; p_item->i_type != CONFIG_HINT_END ; p_item++ )
604 if( p_item->psz_type )
605 free( p_item->psz_type );
607 if( p_item->psz_name )
608 free( p_item->psz_name );
610 if( p_item->psz_text )
611 free( p_item->psz_text );
613 if( p_item->psz_longtext )
614 free( p_item->psz_longtext );
616 if( p_item->psz_value )
617 free( p_item->psz_value );
619 if( p_item->psz_value_orig )
620 free( p_item->psz_value_orig );
624 for( i = 0; i < p_item->i_list; i++ )
626 if( p_item->ppsz_list && p_item->ppsz_list[i] )
627 free( p_item->ppsz_list[i] );
628 if( p_item->ppsz_list_text && p_item->ppsz_list_text[i] )
629 free( p_item->ppsz_list_text[i] );
631 if( p_item->ppsz_list ) free( p_item->ppsz_list );
632 if( p_item->ppsz_list_text ) free( p_item->ppsz_list_text );
633 if( p_item->pi_list ) free( p_item->pi_list );
636 if( p_item->i_action )
638 for( i = 0; i < p_item->i_action; i++ )
640 if( p_item->ppsz_action_text[i] )
641 free( p_item->ppsz_action_text[i] );
643 if( p_item->ppf_action ) free( p_item->ppf_action );
644 if( p_item->ppsz_action_text ) free( p_item->ppsz_action_text );
648 free( p_module->p_config );
649 p_module->p_config = NULL;
652 /*****************************************************************************
653 * config_SetCallbacks: sets callback functions in the duplicate p_config.
654 *****************************************************************************
655 * Unfortunatly we cannot work directly with the module's config data as
656 * this module might be unloaded from memory at any time (remember HideModule).
657 * This is why we need to duplicate callbacks each time we reload the module.
658 *****************************************************************************/
659 void config_SetCallbacks( module_config_t *p_new, module_config_t *p_orig )
661 while( p_new->i_type != CONFIG_HINT_END )
663 p_new->pf_callback = p_orig->pf_callback;
669 /*****************************************************************************
670 * config_UnsetCallbacks: unsets callback functions in the duplicate p_config.
671 *****************************************************************************
672 * We simply undo what we did in config_SetCallbacks.
673 *****************************************************************************/
674 void config_UnsetCallbacks( module_config_t *p_new )
676 while( p_new->i_type != CONFIG_HINT_END )
678 p_new->pf_callback = NULL;
683 /*****************************************************************************
684 * config_ResetAll: reset the configuration data for all the modules.
685 *****************************************************************************/
686 void __config_ResetAll( vlc_object_t *p_this )
692 /* Acquire config file lock */
693 vlc_mutex_lock( &p_this->p_vlc->config_lock );
695 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
697 for( i_index = 0; i_index < p_list->i_count; i_index++ )
699 p_module = (module_t *)p_list->p_values[i_index].p_object ;
700 if( p_module->b_submodule ) continue;
702 for( i = 0; p_module->p_config[i].i_type != CONFIG_HINT_END; i++ )
704 p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
705 p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
706 if( p_module->p_config[i].psz_value )
707 free( p_module->p_config[i].psz_value );
708 p_module->p_config[i].psz_value =
709 p_module->p_config[i].psz_value_orig ?
710 strdup( p_module->p_config[i].psz_value_orig ) : NULL;
714 vlc_list_release( p_list );
715 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
718 /*****************************************************************************
719 * config_LoadConfigFile: loads the configuration file.
720 *****************************************************************************
721 * This function is called to load the config options stored in the config
723 *****************************************************************************/
724 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
728 module_config_t *p_item;
731 char *p_index, *psz_option_name, *psz_option_value;
732 char *psz_filename, *psz_homedir, *psz_configfile;
735 psz_configfile = p_this->p_vlc->psz_configfile;
736 if( !psz_configfile || !psz_configfile )
738 psz_homedir = p_this->p_vlc->psz_homedir;
741 msg_Err( p_this, "psz_homedir is null" );
744 psz_filename = (char *)malloc( sizeof("/" CONFIG_DIR "/" CONFIG_FILE) +
745 strlen(psz_homedir) );
747 sprintf( psz_filename, "%s/" CONFIG_DIR "/" CONFIG_FILE,
752 psz_filename = strdup( psz_configfile );
757 msg_Err( p_this, "out of memory" );
761 msg_Dbg( p_this, "opening config file %s", psz_filename );
763 /* Acquire config file lock */
764 vlc_mutex_lock( &p_this->p_vlc->config_lock );
766 file = fopen( psz_filename, "rt" );
769 msg_Warn( p_this, "config file %s does not exist yet", psz_filename );
770 free( psz_filename );
771 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
775 /* Look for the selected module, if NULL then save everything */
776 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
778 for( i_index = 0; i_index < p_list->i_count; i_index++ )
780 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
783 && strcmp( psz_module_name, p_parser->psz_object_name ) )
788 /* The config file is organized in sections, one per module. Look for
789 * the interesting section ( a section is of the form [foo] ) */
790 fseek( file, 0L, SEEK_SET );
791 while( fgets( line, 1024, file ) )
794 && (p_index = strchr(line,']'))
795 && (p_index - &line[1]
796 == (int)strlen(p_parser->psz_object_name))
797 && !memcmp( &line[1], p_parser->psz_object_name,
798 strlen(p_parser->psz_object_name) ) )
801 msg_Dbg( p_this, "loading config for module \"%s\"",
802 p_parser->psz_object_name );
808 /* either we found the section or we're at the EOF */
810 /* Now try to load the options in this section */
811 while( fgets( line, 1024, file ) )
813 if( line[0] == '[' ) break; /* end of section */
815 /* ignore comments or empty lines */
816 if( (line[0] == '#') || (line[0] == '\n') || (line[0] == (char)0) )
819 /* get rid of line feed */
820 if( line[strlen(line)-1] == '\n' )
821 line[strlen(line)-1] = (char)0;
823 /* look for option name */
824 psz_option_name = line;
825 psz_option_value = NULL;
826 p_index = strchr( line, '=' );
827 if( !p_index ) break; /* this ain't an option!!! */
830 psz_option_value = p_index + 1;
832 if( !p_parser->i_config_items )
837 /* try to match this option with one of the module's options */
838 for( p_item = p_parser->p_config;
839 p_item->i_type != CONFIG_HINT_END;
842 if( p_item->i_type & CONFIG_HINT )
846 if( !strcmp( p_item->psz_name, psz_option_name ) )
849 switch( p_item->i_type )
851 case CONFIG_ITEM_BOOL:
852 case CONFIG_ITEM_INTEGER:
853 if( !*psz_option_value )
854 break; /* ignore empty option */
855 p_item->i_value = strtol( psz_option_value, 0, 0 );
857 msg_Dbg( p_this, "option \"%s\", value %i",
858 p_item->psz_name, p_item->i_value );
862 case CONFIG_ITEM_FLOAT:
863 if( !*psz_option_value )
864 break; /* ignore empty option */
865 p_item->f_value = (float)atof( psz_option_value);
867 msg_Dbg( p_this, "option \"%s\", value %f",
868 p_item->psz_name, (double)p_item->f_value );
871 case CONFIG_ITEM_KEY:
872 if( !*psz_option_value )
873 break; /* ignore empty option */
874 p_item->i_value = ConfigStringToKey( psz_option_value );
878 vlc_mutex_lock( p_item->p_lock );
880 /* free old string */
881 if( p_item->psz_value )
882 free( p_item->psz_value );
884 p_item->psz_value = *psz_option_value ?
885 strdup( psz_option_value ) : NULL;
887 vlc_mutex_unlock( p_item->p_lock );
890 msg_Dbg( p_this, "option \"%s\", value \"%s\"",
892 p_item->psz_value ? p_item->psz_value : "" );
902 vlc_list_release( p_list );
905 free( psz_filename );
907 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
912 /*****************************************************************************
913 * config_SaveConfigFile: Save a module's config options.
914 *****************************************************************************
915 * This will save the specified module's config options to the config file.
916 * If psz_module_name is NULL then we save all the modules config options.
917 * It's no use to save the config options that kept their default values, so
918 * we'll try to be a bit clever here.
920 * When we save we mustn't delete the config options of the modules that
921 * haven't been loaded. So we cannot just create a new config file with the
922 * config structures we've got in memory.
923 * I don't really know how to deal with this nicely, so I will use a completly
925 * I will load the config file in memory, but skipping all the sections of the
926 * modules we want to save. Then I will create a brand new file, dump the file
927 * loaded in memory and then append the sections of the modules we want to
930 *****************************************************************************/
931 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
935 module_config_t *p_item;
937 char p_line[1024], *p_index2;
939 char *p_bigbuffer, *p_index;
941 char *psz_filename, *psz_homedir, *psz_configfile;
944 /* Acquire config file lock */
945 vlc_mutex_lock( &p_this->p_vlc->config_lock );
947 psz_configfile = p_this->p_vlc->psz_configfile;
948 if( !psz_configfile || !psz_configfile )
950 psz_homedir = p_this->p_vlc->psz_homedir;
953 msg_Err( p_this, "psz_homedir is null" );
954 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
957 psz_filename = (char *)malloc( sizeof("/" CONFIG_DIR "/" CONFIG_FILE) +
958 strlen(psz_homedir) );
961 sprintf( psz_filename, "%s/" CONFIG_DIR, psz_homedir );
965 msg_Err( p_this, "out of memory" );
966 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
970 #if defined( UNDER_CE )
972 wchar_t psz_new[ MAX_PATH ];
973 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_new,
975 if( CreateDirectory( psz_new, NULL ) )
977 msg_Err( p_this, "could not create %s", psz_filename );
981 #elif defined( HAVE_ERRNO_H )
982 # if defined( WIN32 )
983 if( mkdir( psz_filename ) && errno != EEXIST )
985 if( mkdir( psz_filename, 0755 ) && errno != EEXIST )
988 msg_Err( p_this, "could not create %s (%s)",
989 psz_filename, strerror(errno) );
993 if( mkdir( psz_filename ) )
995 msg_Err( p_this, "could not create %s", psz_filename );
1000 strcat( psz_filename, "/" CONFIG_FILE );
1004 psz_filename = strdup( psz_configfile );
1007 msg_Err( p_this, "out of memory" );
1008 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1013 msg_Dbg( p_this, "opening config file %s", psz_filename );
1015 file = fopen( psz_filename, "rt" );
1018 msg_Warn( p_this, "config file %s does not exist yet", psz_filename );
1022 /* look for file size */
1023 fseek( file, 0L, SEEK_END );
1024 i_sizebuf = ftell( file );
1025 fseek( file, 0L, SEEK_SET );
1028 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
1031 msg_Err( p_this, "out of memory" );
1032 if( file ) fclose( file );
1033 free( psz_filename );
1034 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1039 /* List all available modules */
1040 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1042 /* backup file into memory, we only need to backup the sections we won't
1045 while( file && fgets( p_line, 1024, file ) )
1047 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
1050 /* we found a section, check if we need to do a backup */
1051 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1053 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1055 if( ((p_index2 - &p_line[1])
1056 == (int)strlen(p_parser->psz_object_name) )
1057 && !memcmp( &p_line[1], p_parser->psz_object_name,
1058 strlen(p_parser->psz_object_name) ) )
1060 if( !psz_module_name )
1062 else if( !strcmp( psz_module_name,
1063 p_parser->psz_object_name ) )
1068 if( i_index == p_list->i_count )
1070 /* we don't have this section in our list so we need to back
1073 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
1085 /* save line if requested and line is valid (doesn't begin with a
1086 * space, tab, or eol) */
1087 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
1088 && (p_line[0] != '\t') )
1090 strcpy( p_index, p_line );
1091 p_index += strlen( p_line );
1094 if( file ) fclose( file );
1098 * Save module config in file
1101 file = fopen( psz_filename, "wt" );
1104 msg_Warn( p_this, "could not open config file %s for writing",
1106 free( psz_filename );
1107 vlc_list_release( p_list );
1108 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1112 fprintf( file, "###\n### " COPYRIGHT_MESSAGE "\n###\n\n" );
1114 /* Look for the selected module, if NULL then save everything */
1115 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1117 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1119 if( psz_module_name && strcmp( psz_module_name,
1120 p_parser->psz_object_name ) )
1123 if( !p_parser->i_config_items )
1126 msg_Dbg( p_this, "saving config for module \"%s\"",
1127 p_parser->psz_object_name );
1129 fprintf( file, "[%s]", p_parser->psz_object_name );
1130 if( p_parser->psz_longname )
1131 fprintf( file, " # %s\n\n", p_parser->psz_longname );
1133 fprintf( file, "\n\n" );
1135 for( p_item = p_parser->p_config;
1136 p_item->i_type != CONFIG_HINT_END;
1140 if( p_item->i_type & CONFIG_HINT )
1144 switch( p_item->i_type )
1146 case CONFIG_ITEM_BOOL:
1147 case CONFIG_ITEM_INTEGER:
1148 if( p_item->psz_text )
1149 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1150 (p_item->i_type == CONFIG_ITEM_BOOL) ?
1151 _("boolean") : _("integer") );
1152 if( p_item->i_value == p_item->i_value_orig )
1153 fprintf( file, "#" );
1154 fprintf( file, "%s=%i\n", p_item->psz_name, p_item->i_value );
1156 case CONFIG_ITEM_KEY:
1157 if( p_item->psz_text )
1158 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1160 if( p_item->i_value == p_item->i_value_orig )
1161 fprintf( file, "#" );
1162 psz_key = ConfigKeyToString( p_item->i_value );
1163 fprintf( file, "%s=%s\n", p_item->psz_name,
1164 psz_key ? psz_key : "" );
1165 if ( psz_key ) free( psz_key );
1168 case CONFIG_ITEM_FLOAT:
1169 if( p_item->psz_text )
1170 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1172 if( p_item->f_value == p_item->f_value_orig )
1173 fprintf( file, "#" );
1174 fprintf( file, "%s=%f\n", p_item->psz_name,
1175 (double)p_item->f_value );
1179 if( p_item->psz_text )
1180 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1182 if( (!p_item->psz_value && !p_item->psz_value_orig) ||
1183 (p_item->psz_value && p_item->psz_value_orig &&
1184 !strcmp( p_item->psz_value, p_item->psz_value_orig )) )
1185 fprintf( file, "#" );
1186 fprintf( file, "%s=%s\n", p_item->psz_name,
1187 p_item->psz_value ? p_item->psz_value : "" );
1191 fprintf( file, "\n" );
1194 vlc_list_release( p_list );
1197 * Restore old settings from the config in file
1199 fputs( p_bigbuffer, file );
1200 free( p_bigbuffer );
1203 free( psz_filename );
1204 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1209 /*****************************************************************************
1210 * config_LoadCmdLine: parse command line
1211 *****************************************************************************
1212 * Parse command line for configuration options.
1213 * Now that the module_bank has been initialized, we can dynamically
1214 * generate the longopts structure used by getops. We have to do it this way
1215 * because we don't know (and don't want to know) in advance the configuration
1216 * options used (ie. exported) by each module.
1217 *****************************************************************************/
1218 int __config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc, char *ppsz_argv[],
1219 vlc_bool_t b_ignore_errors )
1221 int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
1224 module_config_t *p_item;
1225 struct option *p_longopts;
1226 int i_modules_index;
1229 module_config_t *pp_shortopts[256];
1230 char *psz_shortopts;
1232 /* Set default configuration and copy arguments */
1233 p_this->p_vlc->i_argc = *pi_argc;
1234 p_this->p_vlc->ppsz_argv = ppsz_argv;
1237 /* When vlc.app is run by double clicking in Mac OS X, the 2nd arg
1238 * is the PSN - process serial number (a unique PID-ish thingie)
1239 * still ok for real Darwin & when run from command line */
1240 if ( (*pi_argc > 1) && (strncmp( ppsz_argv[ 1 ] , "-psn" , 4 ) == 0) )
1241 /* for example -psn_0_9306113 */
1243 /* GDMF!... I can't do this or else the MacOSX window server will
1244 * not pick up the PSN and not register the app and we crash...
1245 * hence the following kludge otherwise we'll get confused w/ argv[1]
1246 * being an input file name */
1248 ppsz_argv[ 1 ] = NULL;
1250 *pi_argc = *pi_argc - 1;
1256 /* List all modules */
1257 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1260 * Generate the longopts and shortopts structures used by getopt_long
1264 for( i_modules_index = 0; i_modules_index < p_list->i_count;
1267 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
1269 /* count the number of exported configuration options (to allocate
1270 * longopts). We also need to allocate space for too options when
1271 * dealing with boolean to allow for --foo and --no-foo */
1272 i_opts += p_parser->i_config_items
1273 + 2 * p_parser->i_bool_items;
1276 p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
1277 if( p_longopts == NULL )
1279 msg_Err( p_this, "out of memory" );
1280 vlc_list_release( p_list );
1284 psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
1285 if( psz_shortopts == NULL )
1287 msg_Err( p_this, "out of memory" );
1289 vlc_list_release( p_list );
1293 /* If we are requested to ignore errors, then we must work on a copy
1294 * of the ppsz_argv array, otherwise getopt_long will reorder it for
1295 * us, ignoring the arity of the options */
1296 if( b_ignore_errors )
1298 ppsz_argv = (char**)malloc( *pi_argc * sizeof(char *) );
1299 if( ppsz_argv == NULL )
1301 msg_Err( p_this, "out of memory" );
1302 free( psz_shortopts );
1304 vlc_list_release( p_list );
1307 memcpy( ppsz_argv, p_this->p_vlc->ppsz_argv,
1308 *pi_argc * sizeof(char *) );
1312 for( i_index = 0; i_index < 256; i_index++ )
1314 pp_shortopts[i_index] = NULL;
1317 /* Fill the p_longopts and psz_shortopts structures */
1319 for( i_modules_index = 0; i_modules_index < p_list->i_count;
1322 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
1324 if( !p_parser->i_config_items )
1327 for( p_item = p_parser->p_config;
1328 p_item->i_type != CONFIG_HINT_END;
1332 if( p_item->i_type & CONFIG_HINT )
1335 /* Add item to long options */
1336 p_longopts[i_index].name = strdup( p_item->psz_name );
1337 if( p_longopts[i_index].name == NULL ) continue;
1338 p_longopts[i_index].has_arg =
1339 (p_item->i_type == CONFIG_ITEM_BOOL)?
1340 no_argument : required_argument;
1341 p_longopts[i_index].flag = &flag;
1342 p_longopts[i_index].val = 0;
1345 /* When dealing with bools we also need to add the --no-foo
1347 if( p_item->i_type == CONFIG_ITEM_BOOL )
1349 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
1350 if( psz_name == NULL ) continue;
1351 strcpy( psz_name, "no" );
1352 strcat( psz_name, p_item->psz_name );
1354 p_longopts[i_index].name = psz_name;
1355 p_longopts[i_index].has_arg = no_argument;
1356 p_longopts[i_index].flag = &flag;
1357 p_longopts[i_index].val = 1;
1360 psz_name = malloc( strlen(p_item->psz_name) + 4 );
1361 if( psz_name == NULL ) continue;
1362 strcpy( psz_name, "no-" );
1363 strcat( psz_name, p_item->psz_name );
1365 p_longopts[i_index].name = psz_name;
1366 p_longopts[i_index].has_arg = no_argument;
1367 p_longopts[i_index].flag = &flag;
1368 p_longopts[i_index].val = 1;
1372 /* If item also has a short option, add it */
1373 if( p_item->i_short )
1375 pp_shortopts[(int)p_item->i_short] = p_item;
1376 psz_shortopts[i_shortopts] = p_item->i_short;
1378 if( p_item->i_type != CONFIG_ITEM_BOOL )
1380 psz_shortopts[i_shortopts] = ':';
1383 if( p_item->i_short == 'v' )
1385 psz_shortopts[i_shortopts] = ':';
1393 /* We don't need the module list anymore */
1394 vlc_list_release( p_list );
1396 /* Close the longopts and shortopts structures */
1397 memset( &p_longopts[i_index], 0, sizeof(struct option) );
1398 psz_shortopts[i_shortopts] = '\0';
1401 * Parse the command line options
1405 while( ( i_cmd = getopt_long( *pi_argc, ppsz_argv, psz_shortopts,
1406 p_longopts, &i_index ) ) != EOF )
1408 /* A long option has been recognized */
1411 module_config_t *p_conf;
1412 char *psz_name = (char *)p_longopts[i_index].name;
1414 /* Check if we deal with a --nofoo or --no-foo long option */
1415 if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
1417 /* Store the configuration option */
1418 p_conf = config_FindConfig( p_this, psz_name );
1420 if( p_conf ) switch( p_conf->i_type )
1422 case CONFIG_ITEM_STRING:
1423 case CONFIG_ITEM_FILE:
1424 case CONFIG_ITEM_DIRECTORY:
1425 case CONFIG_ITEM_MODULE:
1426 config_PutPsz( p_this, psz_name, optarg );
1428 case CONFIG_ITEM_INTEGER:
1429 config_PutInt( p_this, psz_name, strtol(optarg, 0, 0));
1431 case CONFIG_ITEM_FLOAT:
1432 config_PutFloat( p_this, psz_name, (float)atof(optarg) );
1434 case CONFIG_ITEM_KEY:
1435 config_PutInt( p_this, psz_name, ConfigStringToKey( optarg ) );
1437 case CONFIG_ITEM_BOOL:
1438 config_PutInt( p_this, psz_name, !flag );
1445 /* A short option has been recognized */
1446 if( pp_shortopts[i_cmd] != NULL )
1448 switch( pp_shortopts[i_cmd]->i_type )
1450 case CONFIG_ITEM_STRING:
1451 case CONFIG_ITEM_FILE:
1452 case CONFIG_ITEM_DIRECTORY:
1453 case CONFIG_ITEM_MODULE:
1454 config_PutPsz( p_this, pp_shortopts[i_cmd]->psz_name, optarg );
1456 case CONFIG_ITEM_INTEGER:
1461 if( *optarg == 'v' ) /* eg. -vvv */
1464 while( *optarg == 'v' )
1472 i_verbose += atoi( optarg ); /* eg. -v2 */
1477 i_verbose++; /* -v */
1479 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
1484 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
1485 strtol(optarg, 0, 0) );
1488 case CONFIG_ITEM_BOOL:
1489 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name, 1 );
1496 /* Internal error: unknown option */
1497 if( !b_ignore_errors )
1499 fprintf( stderr, "%s: unknown option ",
1500 p_this->p_vlc->psz_object_name );
1503 fprintf( stderr, "`-%c'\n", optopt );
1507 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
1509 fprintf( stderr, "Try `%s --help' for more information.\n",
1510 p_this->p_vlc->psz_object_name );
1513 free( psz_shortopts );
1518 /* Free allocated resources */
1519 for( i_index = 0; p_longopts[i_index].name; i_index++ )
1520 free( (char *)p_longopts[i_index].name );
1522 free( psz_shortopts );
1523 if( b_ignore_errors ) free( ppsz_argv );
1528 /*****************************************************************************
1529 * config_GetHomeDir: find the user's home directory.
1530 *****************************************************************************
1531 * This function will try by different ways to find the user's home path.
1532 * Note that this function is not reentrant, it should be called only once
1533 * at the beginning of main where the result will be stored for later use.
1534 *****************************************************************************/
1535 char *config_GetHomeDir( void )
1537 char *p_tmp, *p_homedir = NULL;
1539 #if defined(HAVE_GETPWUID)
1540 struct passwd *p_pw = NULL;
1543 #if defined(WIN32) || defined(UNDER_CE)
1544 typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
1546 # define CSIDL_FLAG_CREATE 0x8000
1547 # define CSIDL_APPDATA 0x1A
1548 # define SHGFP_TYPE_CURRENT 0
1550 HINSTANCE shfolder_dll;
1551 SHGETFOLDERPATH SHGetFolderPath ;
1553 /* load the shfolder dll to retrieve SHGetFolderPath */
1554 if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
1556 SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
1557 _T("SHGetFolderPathA") );
1558 if ( SHGetFolderPath != NULL )
1560 p_homedir = (char *)malloc( MAX_PATH );
1566 /* get the "Application Data" folder for the current user */
1567 if( S_OK == SHGetFolderPath( NULL,
1568 CSIDL_APPDATA | CSIDL_FLAG_CREATE,
1569 NULL, SHGFP_TYPE_CURRENT,
1572 FreeLibrary( shfolder_dll );
1577 FreeLibrary( shfolder_dll );
1581 #if defined(HAVE_GETPWUID)
1582 if( ( p_pw = getpwuid( getuid() ) ) == NULL )
1585 if( ( p_tmp = getenv( "HOME" ) ) == NULL )
1587 if( ( p_tmp = getenv( "TMP" ) ) == NULL )
1593 p_homedir = strdup( p_tmp );
1595 #if defined(HAVE_GETPWUID)
1598 p_homedir = strdup( p_pw->pw_dir );
1606 static int ConfigStringToKey( char *psz_key )
1610 char *psz_parser = strchr( psz_key, '-' );
1611 while( psz_parser && psz_parser != psz_key )
1613 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
1615 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
1616 strlen( vlc_modifiers[i].psz_key_string ) ) )
1618 i_key |= vlc_modifiers[i].i_key_code;
1621 psz_key = psz_parser + 1;
1622 psz_parser = strchr( psz_key, '-' );
1624 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
1626 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
1628 i_key |= vlc_keys[i].i_key_code;
1635 static char *ConfigKeyToString( int i_key )
1637 char *psz_key = malloc( 100 );
1647 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
1650 if( i_key & vlc_modifiers[index].i_key_code )
1652 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
1655 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
1658 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
1660 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );