1 /*****************************************************************************
2 * configuration.c management of the modules configuration
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: configuration.c,v 1.69 2003/11/05 18:59: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>
56 #if defined( WIN32 ) && !defined( UNDER_CE )
61 static int ConfigStringToKey( char * );
62 static char *ConfigKeyToString( int );
64 /*****************************************************************************
65 * config_GetType: get the type of a variable (bool, int, float, string)
66 *****************************************************************************
67 * This function is used to get the type of a variable from its name.
68 * Beware, this is quite slow.
69 *****************************************************************************/
70 int __config_GetType( vlc_object_t *p_this, const char *psz_name )
72 module_config_t *p_config;
75 p_config = config_FindConfig( p_this, psz_name );
83 switch( p_config->i_type )
85 case CONFIG_ITEM_BOOL:
86 i_type = VLC_VAR_BOOL;
89 case CONFIG_ITEM_INTEGER:
90 i_type = VLC_VAR_INTEGER;
93 case CONFIG_ITEM_FLOAT:
94 i_type = VLC_VAR_FLOAT;
97 case CONFIG_ITEM_MODULE:
98 i_type = VLC_VAR_MODULE;
101 case CONFIG_ITEM_STRING:
102 i_type = VLC_VAR_STRING;
105 case CONFIG_ITEM_FILE:
106 i_type = VLC_VAR_FILE;
109 case CONFIG_ITEM_DIRECTORY:
110 i_type = VLC_VAR_DIRECTORY;
121 /*****************************************************************************
122 * config_GetInt: get the value of an int variable
123 *****************************************************************************
124 * This function is used to get the value of variables which are internally
125 * represented by an integer (CONFIG_ITEM_INTEGER and
127 *****************************************************************************/
128 int __config_GetInt( vlc_object_t *p_this, const char *psz_name )
130 module_config_t *p_config;
132 p_config = config_FindConfig( p_this, psz_name );
137 msg_Err( p_this, "option %s does not exist", psz_name );
140 if( (p_config->i_type!=CONFIG_ITEM_INTEGER) &&
141 (p_config->i_type!=CONFIG_ITEM_KEY) &&
142 (p_config->i_type!=CONFIG_ITEM_BOOL) )
144 msg_Err( p_this, "option %s does not refer to an int", psz_name );
148 return p_config->i_value;
151 /*****************************************************************************
152 * config_GetFloat: get the value of a float variable
153 *****************************************************************************
154 * This function is used to get the value of variables which are internally
155 * represented by a float (CONFIG_ITEM_FLOAT).
156 *****************************************************************************/
157 float __config_GetFloat( vlc_object_t *p_this, const char *psz_name )
159 module_config_t *p_config;
161 p_config = config_FindConfig( p_this, psz_name );
166 msg_Err( p_this, "option %s does not exist", psz_name );
169 if( p_config->i_type != CONFIG_ITEM_FLOAT )
171 msg_Err( p_this, "option %s does not refer to a float", psz_name );
175 return p_config->f_value;
178 /*****************************************************************************
179 * config_GetPsz: get the string value of a string variable
180 *****************************************************************************
181 * This function is used to get the value of variables which are internally
182 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
183 * CONFIG_ITEM_DIRECTORY, and CONFIG_ITEM_MODULE).
185 * Important note: remember to free() the returned char* because it's a
186 * duplicate of the actual value. It isn't safe to return a pointer to the
187 * actual value as it can be modified at any time.
188 *****************************************************************************/
189 char * __config_GetPsz( vlc_object_t *p_this, const char *psz_name )
191 module_config_t *p_config;
192 char *psz_value = NULL;
194 p_config = config_FindConfig( p_this, psz_name );
199 msg_Err( p_this, "option %s does not exist", psz_name );
202 if( (p_config->i_type!=CONFIG_ITEM_STRING) &&
203 (p_config->i_type!=CONFIG_ITEM_FILE) &&
204 (p_config->i_type!=CONFIG_ITEM_DIRECTORY) &&
205 (p_config->i_type!=CONFIG_ITEM_MODULE) )
207 msg_Err( p_this, "option %s does not refer to a string", psz_name );
211 /* return a copy of the string */
212 vlc_mutex_lock( p_config->p_lock );
213 if( p_config->psz_value ) psz_value = strdup( p_config->psz_value );
214 vlc_mutex_unlock( p_config->p_lock );
219 /*****************************************************************************
220 * config_PutPsz: set the string value of a string variable
221 *****************************************************************************
222 * This function is used to set the value of variables which are internally
223 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
224 * CONFIG_ITEM_DIRECTORY, and CONFIG_ITEM_MODULE).
225 *****************************************************************************/
226 void __config_PutPsz( vlc_object_t *p_this,
227 const char *psz_name, const char *psz_value )
229 module_config_t *p_config;
230 vlc_value_t oldval, val;
232 p_config = config_FindConfig( p_this, psz_name );
237 msg_Warn( p_this, "option %s does not exist", psz_name );
240 if( (p_config->i_type!=CONFIG_ITEM_STRING) &&
241 (p_config->i_type!=CONFIG_ITEM_FILE) &&
242 (p_config->i_type!=CONFIG_ITEM_DIRECTORY) &&
243 (p_config->i_type!=CONFIG_ITEM_MODULE) )
245 msg_Err( p_this, "option %s does not refer to a string", psz_name );
249 vlc_mutex_lock( p_config->p_lock );
251 /* backup old value */
252 oldval.psz_string = p_config->psz_value;
254 if( psz_value && *psz_value ) p_config->psz_value = strdup( psz_value );
255 else p_config->psz_value = NULL;
257 val.psz_string = p_config->psz_value;
259 vlc_mutex_unlock( p_config->p_lock );
261 if( p_config->pf_callback )
263 p_config->pf_callback( p_this, psz_name, oldval, val,
264 p_config->p_callback_data );
267 /* free old string */
268 if( oldval.psz_string ) free( oldval.psz_string );
271 /*****************************************************************************
272 * config_PutInt: set the integer value of an int variable
273 *****************************************************************************
274 * This function is used to set the value of variables which are internally
275 * represented by an integer (CONFIG_ITEM_INTEGER and
277 *****************************************************************************/
278 void __config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
280 module_config_t *p_config;
281 vlc_value_t oldval, val;
283 p_config = config_FindConfig( p_this, psz_name );
288 msg_Warn( p_this, "option %s does not exist", psz_name );
291 if( (p_config->i_type!=CONFIG_ITEM_INTEGER) &&
292 (p_config->i_type!=CONFIG_ITEM_KEY) &&
293 (p_config->i_type!=CONFIG_ITEM_BOOL) )
295 msg_Err( p_this, "option %s does not refer to an int", psz_name );
299 /* backup old value */
300 oldval.i_int = p_config->i_value;
302 /* if i_min == i_max == 0, then do not use them */
303 if ((p_config->i_min == 0) && (p_config->i_max == 0))
305 p_config->i_value = i_value;
307 else if (i_value < p_config->i_min)
309 p_config->i_value = p_config->i_min;
311 else if (i_value > p_config->i_max)
313 p_config->i_value = p_config->i_max;
317 p_config->i_value = i_value;
320 val.i_int = p_config->i_value;
322 if( p_config->pf_callback )
324 p_config->pf_callback( p_this, psz_name, oldval, val,
325 p_config->p_callback_data );
329 /*****************************************************************************
330 * config_PutFloat: set the value of a float variable
331 *****************************************************************************
332 * This function is used to set the value of variables which are internally
333 * represented by a float (CONFIG_ITEM_FLOAT).
334 *****************************************************************************/
335 void __config_PutFloat( vlc_object_t *p_this,
336 const char *psz_name, float f_value )
338 module_config_t *p_config;
339 vlc_value_t oldval, val;
341 p_config = config_FindConfig( p_this, psz_name );
346 msg_Warn( p_this, "option %s does not exist", psz_name );
349 if( p_config->i_type != CONFIG_ITEM_FLOAT )
351 msg_Err( p_this, "option %s does not refer to a float", psz_name );
355 /* backup old value */
356 oldval.f_float = p_config->f_value;
358 /* if f_min == f_max == 0, then do not use them */
359 if ((p_config->f_min == 0) && (p_config->f_max == 0))
361 p_config->f_value = f_value;
363 else if (f_value < p_config->f_min)
365 p_config->f_value = p_config->f_min;
367 else if (f_value > p_config->f_max)
369 p_config->f_value = p_config->f_max;
373 p_config->f_value = f_value;
376 val.f_float = p_config->f_value;
378 if( p_config->pf_callback )
380 p_config->pf_callback( p_this, psz_name, oldval, val,
381 p_config->p_callback_data );
385 /*****************************************************************************
386 * config_FindConfig: find the config structure associated with an option.
387 *****************************************************************************
388 * FIXME: This function really needs to be optimized.
389 * FIXME: And now even more.
390 *****************************************************************************/
391 module_config_t *config_FindConfig( vlc_object_t *p_this, const char *psz_name )
395 module_config_t *p_item;
398 if( !psz_name ) return NULL;
400 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
402 for( i_index = 0; i_index < p_list->i_count; i_index++ )
404 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
406 if( !p_parser->i_config_items )
409 for( p_item = p_parser->p_config;
410 p_item->i_type != CONFIG_HINT_END;
413 if( p_item->i_type & CONFIG_HINT )
416 if( !strcmp( psz_name, p_item->psz_name ) )
418 vlc_list_release( p_list );
424 vlc_list_release( p_list );
429 /*****************************************************************************
430 * config_FindModule: find a specific module structure.
431 *****************************************************************************/
432 module_t *config_FindModule( vlc_object_t *p_this, const char *psz_name )
435 module_t *p_module, *p_result = NULL;
438 if( !psz_name ) return NULL;
440 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
442 for( i_index = 0; i_index < p_list->i_count; i_index++ )
444 p_module = (module_t *)p_list->p_values[i_index].p_object;
445 if( !strcmp( p_module->psz_object_name, psz_name ) )
452 vlc_list_release( p_list );
457 /*****************************************************************************
458 * config_Duplicate: creates a duplicate of a module's configuration data.
459 *****************************************************************************
460 * Unfortunatly we cannot work directly with the module's config data as
461 * this module might be unloaded from memory at any time (remember HideModule).
462 * This is why we need to create an exact copy of the config data.
463 *****************************************************************************/
464 void config_Duplicate( module_t *p_module, module_config_t *p_orig )
466 int i, j, i_lines = 1;
467 module_config_t *p_item;
469 /* Calculate the structure length */
470 p_module->i_config_items = 0;
471 p_module->i_bool_items = 0;
473 for( p_item = p_orig; p_item->i_type != CONFIG_HINT_END; p_item++ )
477 if( p_item->i_type & CONFIG_ITEM )
479 p_module->i_config_items++;
482 if( p_item->i_type == CONFIG_ITEM_BOOL )
484 p_module->i_bool_items++;
488 /* Allocate memory */
489 p_module->p_config = (module_config_t *)malloc( sizeof(module_config_t)
491 if( p_module->p_config == NULL )
493 msg_Err( p_module, "config error: can't duplicate p_config" );
497 /* Do the duplication job */
498 for( i = 0; i < i_lines ; i++ )
500 p_module->p_config[i] = p_orig[i];
502 p_module->p_config[i].psz_type = p_orig[i].psz_type ?
503 strdup( p_orig[i].psz_type ) : NULL;
504 p_module->p_config[i].psz_name = p_orig[i].psz_name ?
505 strdup( p_orig[i].psz_name ) : NULL;
506 p_module->p_config[i].psz_text = p_orig[i].psz_text ?
507 strdup( _(p_orig[i].psz_text) ) : NULL;
508 p_module->p_config[i].psz_longtext = p_orig[i].psz_longtext ?
509 strdup( _(p_orig[i].psz_longtext) ) : NULL;
510 p_module->p_config[i].psz_value = p_orig[i].psz_value ?
511 strdup( p_orig[i].psz_value ) : NULL;
512 p_module->p_config[i].psz_value_orig = p_orig[i].psz_value ?
513 strdup( p_orig[i].psz_value ) : NULL;
515 p_module->p_config[i].p_lock = &p_module->object_lock;
517 /* duplicate the string list */
518 if( p_orig[i].i_list )
520 if( p_orig[i].ppsz_list )
522 p_module->p_config[i].ppsz_list =
523 malloc( (p_orig[i].i_list + 1) * sizeof(char *) );
524 if( p_module->p_config[i].ppsz_list )
526 for( j = 0; j < p_orig[i].i_list; j++ )
527 p_module->p_config[i].ppsz_list[j] =
528 strdup( p_orig[i].ppsz_list[j] );
529 p_module->p_config[i].ppsz_list[j] = NULL;
532 if( p_orig[i].ppsz_list_text )
534 p_module->p_config[i].ppsz_list_text =
535 malloc( (p_orig[i].i_list + 1) * sizeof(char *) );
536 if( p_module->p_config[i].ppsz_list_text )
538 for( j = 0; j < p_orig[i].i_list; j++ )
539 p_module->p_config[i].ppsz_list_text[j] =
540 strdup( _(p_orig[i].ppsz_list_text[j]) );
541 p_module->p_config[i].ppsz_list_text[j] = NULL;
544 if( p_orig[i].pi_list )
546 p_module->p_config[i].pi_list =
547 malloc( (p_orig[i].i_list + 1) * sizeof(int) );
548 if( p_module->p_config[i].pi_list )
550 for( j = 0; j < p_orig[i].i_list; j++ )
551 p_module->p_config[i].pi_list[j] =
552 p_orig[i].pi_list[j];
557 p_module->p_config[i].pf_callback = p_orig[i].pf_callback;
561 /*****************************************************************************
562 * config_Free: frees a duplicated module's configuration data.
563 *****************************************************************************
564 * This function frees all the data duplicated by config_Duplicate.
565 *****************************************************************************/
566 void config_Free( module_t *p_module )
568 module_config_t *p_item = p_module->p_config;
576 for( ; p_item->i_type != CONFIG_HINT_END ; p_item++ )
578 if( p_item->psz_type )
579 free( p_item->psz_type );
581 if( p_item->psz_name )
582 free( p_item->psz_name );
584 if( p_item->psz_text )
585 free( p_item->psz_text );
587 if( p_item->psz_longtext )
588 free( p_item->psz_longtext );
590 if( p_item->psz_value )
591 free( p_item->psz_value );
593 if( p_item->psz_value_orig )
594 free( p_item->psz_value_orig );
598 for( i = 0; i < p_item->i_list; i++ )
600 if( p_item->ppsz_list && p_item->ppsz_list[i] )
601 free( p_item->ppsz_list[i] );
602 if( p_item->ppsz_list_text && p_item->ppsz_list_text[i] )
603 free( p_item->ppsz_list_text[i] );
605 if( p_item->ppsz_list ) free( p_item->ppsz_list );
606 if( p_item->ppsz_list_text ) free( p_item->ppsz_list_text );
607 if( p_item->pi_list ) free( p_item->pi_list );
611 free( p_module->p_config );
612 p_module->p_config = NULL;
615 /*****************************************************************************
616 * config_SetCallbacks: sets callback functions in the duplicate p_config.
617 *****************************************************************************
618 * Unfortunatly we cannot work directly with the module's config data as
619 * this module might be unloaded from memory at any time (remember HideModule).
620 * This is why we need to duplicate callbacks each time we reload the module.
621 *****************************************************************************/
622 void config_SetCallbacks( module_config_t *p_new, module_config_t *p_orig )
624 while( p_new->i_type != CONFIG_HINT_END )
626 p_new->pf_callback = p_orig->pf_callback;
632 /*****************************************************************************
633 * config_UnsetCallbacks: unsets callback functions in the duplicate p_config.
634 *****************************************************************************
635 * We simply undo what we did in config_SetCallbacks.
636 *****************************************************************************/
637 void config_UnsetCallbacks( module_config_t *p_new )
639 while( p_new->i_type != CONFIG_HINT_END )
641 p_new->pf_callback = NULL;
646 /*****************************************************************************
647 * config_ResetAll: reset the configuration data for all the modules.
648 *****************************************************************************/
649 void __config_ResetAll( vlc_object_t *p_this )
655 /* Acquire config file lock */
656 vlc_mutex_lock( &p_this->p_vlc->config_lock );
658 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
660 for( i_index = 0; i_index < p_list->i_count; i_index++ )
662 p_module = (module_t *)p_list->p_values[i_index].p_object ;
663 if( p_module->b_submodule ) continue;
665 for( i = 0; p_module->p_config[i].i_type != CONFIG_HINT_END; i++ )
667 p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
668 p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
669 if( p_module->p_config[i].psz_value )
670 free( p_module->p_config[i].psz_value );
671 p_module->p_config[i].psz_value =
672 p_module->p_config[i].psz_value_orig ?
673 strdup( p_module->p_config[i].psz_value_orig ) : NULL;
677 vlc_list_release( p_list );
678 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
681 /*****************************************************************************
682 * config_LoadConfigFile: loads the configuration file.
683 *****************************************************************************
684 * This function is called to load the config options stored in the config
686 *****************************************************************************/
687 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
691 module_config_t *p_item;
694 char *p_index, *psz_option_name, *psz_option_value;
695 char *psz_filename, *psz_homedir, *psz_configfile;
698 psz_configfile = p_this->p_vlc->psz_configfile;
699 if( !psz_configfile || !psz_configfile )
701 psz_homedir = p_this->p_vlc->psz_homedir;
704 msg_Err( p_this, "psz_homedir is null" );
707 psz_filename = (char *)malloc( sizeof("/" CONFIG_DIR "/" CONFIG_FILE) +
708 strlen(psz_homedir) );
710 sprintf( psz_filename, "%s/" CONFIG_DIR "/" CONFIG_FILE,
715 psz_filename = strdup( psz_configfile );
720 msg_Err( p_this, "out of memory" );
724 msg_Dbg( p_this, "opening config file %s", psz_filename );
726 /* Acquire config file lock */
727 vlc_mutex_lock( &p_this->p_vlc->config_lock );
729 file = fopen( psz_filename, "rt" );
732 msg_Warn( p_this, "config file %s does not exist yet", psz_filename );
733 free( psz_filename );
734 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
738 /* Look for the selected module, if NULL then save everything */
739 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
741 for( i_index = 0; i_index < p_list->i_count; i_index++ )
743 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
746 && strcmp( psz_module_name, p_parser->psz_object_name ) )
751 /* The config file is organized in sections, one per module. Look for
752 * the interesting section ( a section is of the form [foo] ) */
753 fseek( file, 0L, SEEK_SET );
754 while( fgets( line, 1024, file ) )
757 && (p_index = strchr(line,']'))
758 && (p_index - &line[1]
759 == (int)strlen(p_parser->psz_object_name))
760 && !memcmp( &line[1], p_parser->psz_object_name,
761 strlen(p_parser->psz_object_name) ) )
764 msg_Dbg( p_this, "loading config for module \"%s\"",
765 p_parser->psz_object_name );
771 /* either we found the section or we're at the EOF */
773 /* Now try to load the options in this section */
774 while( fgets( line, 1024, file ) )
776 if( line[0] == '[' ) break; /* end of section */
778 /* ignore comments or empty lines */
779 if( (line[0] == '#') || (line[0] == '\n') || (line[0] == (char)0) )
782 /* get rid of line feed */
783 if( line[strlen(line)-1] == '\n' )
784 line[strlen(line)-1] = (char)0;
786 /* look for option name */
787 psz_option_name = line;
788 psz_option_value = NULL;
789 p_index = strchr( line, '=' );
790 if( !p_index ) break; /* this ain't an option!!! */
793 psz_option_value = p_index + 1;
795 if( !p_parser->i_config_items )
800 /* try to match this option with one of the module's options */
801 for( p_item = p_parser->p_config;
802 p_item->i_type != CONFIG_HINT_END;
805 if( p_item->i_type & CONFIG_HINT )
809 if( !strcmp( p_item->psz_name, psz_option_name ) )
812 switch( p_item->i_type )
814 case CONFIG_ITEM_BOOL:
815 case CONFIG_ITEM_INTEGER:
816 if( !*psz_option_value )
817 break; /* ignore empty option */
818 p_item->i_value = strtol( psz_option_value, 0, 0 );
820 msg_Dbg( p_this, "option \"%s\", value %i",
821 p_item->psz_name, p_item->i_value );
825 case CONFIG_ITEM_FLOAT:
826 if( !*psz_option_value )
827 break; /* ignore empty option */
828 p_item->f_value = (float)atof( psz_option_value);
830 msg_Dbg( p_this, "option \"%s\", value %f",
831 p_item->psz_name, (double)p_item->f_value );
834 case CONFIG_ITEM_KEY:
835 if( !*psz_option_value )
836 break; /* ignore empty option */
837 p_item->i_value = ConfigStringToKey( psz_option_value );
841 vlc_mutex_lock( p_item->p_lock );
843 /* free old string */
844 if( p_item->psz_value )
845 free( p_item->psz_value );
847 p_item->psz_value = *psz_option_value ?
848 strdup( psz_option_value ) : NULL;
850 vlc_mutex_unlock( p_item->p_lock );
853 msg_Dbg( p_this, "option \"%s\", value \"%s\"",
855 p_item->psz_value ? p_item->psz_value : "" );
865 vlc_list_release( p_list );
868 free( psz_filename );
870 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
875 /*****************************************************************************
876 * config_SaveConfigFile: Save a module's config options.
877 *****************************************************************************
878 * This will save the specified module's config options to the config file.
879 * If psz_module_name is NULL then we save all the modules config options.
880 * It's no use to save the config options that kept their default values, so
881 * we'll try to be a bit clever here.
883 * When we save we mustn't delete the config options of the modules that
884 * haven't been loaded. So we cannot just create a new config file with the
885 * config structures we've got in memory.
886 * I don't really know how to deal with this nicely, so I will use a completly
888 * I will load the config file in memory, but skipping all the sections of the
889 * modules we want to save. Then I will create a brand new file, dump the file
890 * loaded in memory and then append the sections of the modules we want to
893 *****************************************************************************/
894 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
898 module_config_t *p_item;
900 char p_line[1024], *p_index2;
902 char *p_bigbuffer, *p_index;
904 char *psz_filename, *psz_homedir, *psz_configfile;
907 /* Acquire config file lock */
908 vlc_mutex_lock( &p_this->p_vlc->config_lock );
910 psz_configfile = p_this->p_vlc->psz_configfile;
911 if( !psz_configfile || !psz_configfile )
913 psz_homedir = p_this->p_vlc->psz_homedir;
916 msg_Err( p_this, "psz_homedir is null" );
917 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
920 psz_filename = (char *)malloc( sizeof("/" CONFIG_DIR "/" CONFIG_FILE) +
921 strlen(psz_homedir) );
924 sprintf( psz_filename, "%s/" CONFIG_DIR, psz_homedir );
928 msg_Err( p_this, "out of memory" );
929 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
933 #if defined( UNDER_CE )
935 wchar_t psz_new[ MAX_PATH ];
936 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_new,
938 if( CreateDirectory( psz_new, NULL ) )
940 msg_Err( p_this, "could not create %s", psz_filename );
944 #elif defined( HAVE_ERRNO_H )
945 # if defined( WIN32 )
946 if( mkdir( psz_filename ) && errno != EEXIST )
948 if( mkdir( psz_filename, 0755 ) && errno != EEXIST )
951 msg_Err( p_this, "could not create %s (%s)",
952 psz_filename, strerror(errno) );
956 if( mkdir( psz_filename ) )
958 msg_Err( p_this, "could not create %s", psz_filename );
963 strcat( psz_filename, "/" CONFIG_FILE );
967 psz_filename = strdup( psz_configfile );
970 msg_Err( p_this, "out of memory" );
971 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
976 msg_Dbg( p_this, "opening config file %s", psz_filename );
978 file = fopen( psz_filename, "rt" );
981 msg_Warn( p_this, "config file %s does not exist yet", psz_filename );
985 /* look for file size */
986 fseek( file, 0L, SEEK_END );
987 i_sizebuf = ftell( file );
988 fseek( file, 0L, SEEK_SET );
991 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
994 msg_Err( p_this, "out of memory" );
995 if( file ) fclose( file );
996 free( psz_filename );
997 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1002 /* List all available modules */
1003 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1005 /* backup file into memory, we only need to backup the sections we won't
1008 while( file && fgets( p_line, 1024, file ) )
1010 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
1013 /* we found a section, check if we need to do a backup */
1014 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1016 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1018 if( ((p_index2 - &p_line[1])
1019 == (int)strlen(p_parser->psz_object_name) )
1020 && !memcmp( &p_line[1], p_parser->psz_object_name,
1021 strlen(p_parser->psz_object_name) ) )
1023 if( !psz_module_name )
1025 else if( !strcmp( psz_module_name,
1026 p_parser->psz_object_name ) )
1031 if( i_index == p_list->i_count )
1033 /* we don't have this section in our list so we need to back
1036 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
1048 /* save line if requested and line is valid (doesn't begin with a
1049 * space, tab, or eol) */
1050 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
1051 && (p_line[0] != '\t') )
1053 strcpy( p_index, p_line );
1054 p_index += strlen( p_line );
1057 if( file ) fclose( file );
1061 * Save module config in file
1064 file = fopen( psz_filename, "wt" );
1067 msg_Warn( p_this, "could not open config file %s for writing",
1069 free( psz_filename );
1070 vlc_list_release( p_list );
1071 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1075 fprintf( file, "###\n### " COPYRIGHT_MESSAGE "\n###\n\n" );
1077 /* Look for the selected module, if NULL then save everything */
1078 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1080 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1082 if( psz_module_name && strcmp( psz_module_name,
1083 p_parser->psz_object_name ) )
1086 if( !p_parser->i_config_items )
1089 msg_Dbg( p_this, "saving config for module \"%s\"",
1090 p_parser->psz_object_name );
1092 fprintf( file, "[%s]", p_parser->psz_object_name );
1093 if( p_parser->psz_longname )
1094 fprintf( file, " # %s\n\n", p_parser->psz_longname );
1096 fprintf( file, "\n\n" );
1098 for( p_item = p_parser->p_config;
1099 p_item->i_type != CONFIG_HINT_END;
1103 if( p_item->i_type & CONFIG_HINT )
1107 switch( p_item->i_type )
1109 case CONFIG_ITEM_BOOL:
1110 case CONFIG_ITEM_INTEGER:
1111 if( p_item->psz_text )
1112 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1113 (p_item->i_type == CONFIG_ITEM_BOOL) ?
1114 _("boolean") : _("integer") );
1115 if( p_item->i_value == p_item->i_value_orig )
1116 fprintf( file, "#" );
1117 fprintf( file, "%s=%i\n", p_item->psz_name, p_item->i_value );
1119 case CONFIG_ITEM_KEY:
1120 if( p_item->psz_text )
1121 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1123 psz_key = ConfigKeyToString( p_item->i_value );
1124 fprintf( file, "%s=%s\n", p_item->psz_name,
1125 psz_key ? psz_key : "" );
1126 if ( psz_key ) free( psz_key );
1129 case CONFIG_ITEM_FLOAT:
1130 if( p_item->psz_text )
1131 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1133 if( p_item->f_value == p_item->f_value_orig )
1134 fprintf( file, "#" );
1135 fprintf( file, "%s=%f\n", p_item->psz_name,
1136 (double)p_item->f_value );
1140 if( p_item->psz_text )
1141 fprintf( file, "# %s (%s)\n", p_item->psz_text,
1143 if( (!p_item->psz_value && !p_item->psz_value_orig) ||
1144 (p_item->psz_value && p_item->psz_value_orig &&
1145 !strcmp( p_item->psz_value, p_item->psz_value_orig )) )
1146 fprintf( file, "#" );
1147 fprintf( file, "%s=%s\n", p_item->psz_name,
1148 p_item->psz_value ? p_item->psz_value : "" );
1152 fprintf( file, "\n" );
1155 vlc_list_release( p_list );
1158 * Restore old settings from the config in file
1160 fputs( p_bigbuffer, file );
1161 free( p_bigbuffer );
1164 free( psz_filename );
1165 vlc_mutex_unlock( &p_this->p_vlc->config_lock );
1170 /*****************************************************************************
1171 * config_LoadCmdLine: parse command line
1172 *****************************************************************************
1173 * Parse command line for configuration options.
1174 * Now that the module_bank has been initialized, we can dynamically
1175 * generate the longopts structure used by getops. We have to do it this way
1176 * because we don't know (and don't want to know) in advance the configuration
1177 * options used (ie. exported) by each module.
1178 *****************************************************************************/
1179 int __config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc, char *ppsz_argv[],
1180 vlc_bool_t b_ignore_errors )
1182 int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
1185 module_config_t *p_item;
1186 struct option *p_longopts;
1187 int i_modules_index;
1190 module_config_t *pp_shortopts[256];
1191 char *psz_shortopts;
1193 /* Set default configuration and copy arguments */
1194 p_this->p_vlc->i_argc = *pi_argc;
1195 p_this->p_vlc->ppsz_argv = ppsz_argv;
1198 /* When vlc.app is run by double clicking in Mac OS X, the 2nd arg
1199 * is the PSN - process serial number (a unique PID-ish thingie)
1200 * still ok for real Darwin & when run from command line */
1201 if ( (*pi_argc > 1) && (strncmp( ppsz_argv[ 1 ] , "-psn" , 4 ) == 0) )
1202 /* for example -psn_0_9306113 */
1204 /* GDMF!... I can't do this or else the MacOSX window server will
1205 * not pick up the PSN and not register the app and we crash...
1206 * hence the following kludge otherwise we'll get confused w/ argv[1]
1207 * being an input file name */
1209 ppsz_argv[ 1 ] = NULL;
1211 *pi_argc = *pi_argc - 1;
1217 /* List all modules */
1218 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1221 * Generate the longopts and shortopts structures used by getopt_long
1225 for( i_modules_index = 0; i_modules_index < p_list->i_count;
1228 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
1230 /* count the number of exported configuration options (to allocate
1231 * longopts). We also need to allocate space for too options when
1232 * dealing with boolean to allow for --foo and --no-foo */
1233 i_opts += p_parser->i_config_items
1234 + 2 * p_parser->i_bool_items;
1237 p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
1238 if( p_longopts == NULL )
1240 msg_Err( p_this, "out of memory" );
1241 vlc_list_release( p_list );
1245 psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
1246 if( psz_shortopts == NULL )
1248 msg_Err( p_this, "out of memory" );
1250 vlc_list_release( p_list );
1254 /* If we are requested to ignore errors, then we must work on a copy
1255 * of the ppsz_argv array, otherwise getopt_long will reorder it for
1256 * us, ignoring the arity of the options */
1257 if( b_ignore_errors )
1259 ppsz_argv = (char**)malloc( *pi_argc * sizeof(char *) );
1260 if( ppsz_argv == NULL )
1262 msg_Err( p_this, "out of memory" );
1263 free( psz_shortopts );
1265 vlc_list_release( p_list );
1268 memcpy( ppsz_argv, p_this->p_vlc->ppsz_argv,
1269 *pi_argc * sizeof(char *) );
1273 for( i_index = 0; i_index < 256; i_index++ )
1275 pp_shortopts[i_index] = NULL;
1278 /* Fill the p_longopts and psz_shortopts structures */
1280 for( i_modules_index = 0; i_modules_index < p_list->i_count;
1283 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
1285 if( !p_parser->i_config_items )
1288 for( p_item = p_parser->p_config;
1289 p_item->i_type != CONFIG_HINT_END;
1293 if( p_item->i_type & CONFIG_HINT )
1296 /* Add item to long options */
1297 p_longopts[i_index].name = strdup( p_item->psz_name );
1298 if( p_longopts[i_index].name == NULL ) continue;
1299 p_longopts[i_index].has_arg =
1300 (p_item->i_type == CONFIG_ITEM_BOOL)?
1301 no_argument : required_argument;
1302 p_longopts[i_index].flag = &flag;
1303 p_longopts[i_index].val = 0;
1306 /* When dealing with bools we also need to add the --no-foo
1308 if( p_item->i_type == CONFIG_ITEM_BOOL )
1310 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
1311 if( psz_name == NULL ) continue;
1312 strcpy( psz_name, "no" );
1313 strcat( psz_name, p_item->psz_name );
1315 p_longopts[i_index].name = psz_name;
1316 p_longopts[i_index].has_arg = no_argument;
1317 p_longopts[i_index].flag = &flag;
1318 p_longopts[i_index].val = 1;
1321 psz_name = malloc( strlen(p_item->psz_name) + 4 );
1322 if( psz_name == NULL ) continue;
1323 strcpy( psz_name, "no-" );
1324 strcat( psz_name, p_item->psz_name );
1326 p_longopts[i_index].name = psz_name;
1327 p_longopts[i_index].has_arg = no_argument;
1328 p_longopts[i_index].flag = &flag;
1329 p_longopts[i_index].val = 1;
1333 /* If item also has a short option, add it */
1334 if( p_item->i_short )
1336 pp_shortopts[(int)p_item->i_short] = p_item;
1337 psz_shortopts[i_shortopts] = p_item->i_short;
1339 if( p_item->i_type != CONFIG_ITEM_BOOL )
1341 psz_shortopts[i_shortopts] = ':';
1344 if( p_item->i_short == 'v' )
1346 psz_shortopts[i_shortopts] = ':';
1354 /* We don't need the module list anymore */
1355 vlc_list_release( p_list );
1357 /* Close the longopts and shortopts structures */
1358 memset( &p_longopts[i_index], 0, sizeof(struct option) );
1359 psz_shortopts[i_shortopts] = '\0';
1362 * Parse the command line options
1366 while( ( i_cmd = getopt_long( *pi_argc, ppsz_argv, psz_shortopts,
1367 p_longopts, &i_index ) ) != EOF )
1369 /* A long option has been recognized */
1372 module_config_t *p_conf;
1373 char *psz_name = (char *)p_longopts[i_index].name;
1375 /* Check if we deal with a --nofoo or --no-foo long option */
1376 if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
1378 /* Store the configuration option */
1379 p_conf = config_FindConfig( p_this, psz_name );
1381 if( p_conf ) switch( p_conf->i_type )
1383 case CONFIG_ITEM_STRING:
1384 case CONFIG_ITEM_FILE:
1385 case CONFIG_ITEM_DIRECTORY:
1386 case CONFIG_ITEM_MODULE:
1387 config_PutPsz( p_this, psz_name, optarg );
1389 case CONFIG_ITEM_INTEGER:
1390 config_PutInt( p_this, psz_name, strtol(optarg, 0, 0));
1392 case CONFIG_ITEM_FLOAT:
1393 config_PutFloat( p_this, psz_name, (float)atof(optarg) );
1395 case CONFIG_ITEM_KEY:
1396 config_PutInt( p_this, psz_name, ConfigStringToKey( optarg ) );
1398 case CONFIG_ITEM_BOOL:
1399 config_PutInt( p_this, psz_name, !flag );
1406 /* A short option has been recognized */
1407 if( pp_shortopts[i_cmd] != NULL )
1409 switch( pp_shortopts[i_cmd]->i_type )
1411 case CONFIG_ITEM_STRING:
1412 case CONFIG_ITEM_FILE:
1413 case CONFIG_ITEM_DIRECTORY:
1414 case CONFIG_ITEM_MODULE:
1415 config_PutPsz( p_this, pp_shortopts[i_cmd]->psz_name, optarg );
1417 case CONFIG_ITEM_INTEGER:
1422 if( *optarg == 'v' ) /* eg. -vvv */
1425 while( *optarg == 'v' )
1433 i_verbose += atoi( optarg ); /* eg. -v2 */
1438 i_verbose++; /* -v */
1440 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
1445 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
1446 strtol(optarg, 0, 0) );
1449 case CONFIG_ITEM_BOOL:
1450 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name, 1 );
1457 /* Internal error: unknown option */
1458 if( !b_ignore_errors )
1460 fprintf( stderr, "%s: unknown option ",
1461 p_this->p_vlc->psz_object_name );
1464 fprintf( stderr, "`-%c'\n", optopt );
1468 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
1470 fprintf( stderr, "Try `%s --help' for more information.\n",
1471 p_this->p_vlc->psz_object_name );
1474 free( psz_shortopts );
1479 /* Free allocated resources */
1480 for( i_index = 0; p_longopts[i_index].name; i_index++ )
1481 free( (char *)p_longopts[i_index].name );
1483 free( psz_shortopts );
1484 if( b_ignore_errors ) free( ppsz_argv );
1489 /*****************************************************************************
1490 * config_GetHomeDir: find the user's home directory.
1491 *****************************************************************************
1492 * This function will try by different ways to find the user's home path.
1493 * Note that this function is not reentrant, it should be called only once
1494 * at the beginning of main where the result will be stored for later use.
1495 *****************************************************************************/
1496 char *config_GetHomeDir( void )
1498 char *p_tmp, *p_homedir = NULL;
1500 #if defined(HAVE_GETPWUID)
1501 struct passwd *p_pw = NULL;
1504 #if defined(WIN32) || defined(UNDER_CE)
1505 typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
1507 # define CSIDL_FLAG_CREATE 0x8000
1508 # define CSIDL_APPDATA 0x1A
1509 # define SHGFP_TYPE_CURRENT 0
1511 HINSTANCE shfolder_dll;
1512 SHGETFOLDERPATH SHGetFolderPath ;
1514 /* load the shfolder dll to retrieve SHGetFolderPath */
1515 if( ( shfolder_dll = LoadLibrary("shfolder.dll") ) != NULL )
1517 SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
1518 "SHGetFolderPathA" );
1519 if ( SHGetFolderPath != NULL )
1521 p_homedir = (char *)malloc( MAX_PATH );
1527 /* get the "Application Data" folder for the current user */
1528 if( S_OK == SHGetFolderPath( NULL,
1529 CSIDL_APPDATA | CSIDL_FLAG_CREATE,
1530 NULL, SHGFP_TYPE_CURRENT,
1533 FreeLibrary( shfolder_dll );
1538 FreeLibrary( shfolder_dll );
1542 #if defined(HAVE_GETPWUID)
1543 if( ( p_pw = getpwuid( getuid() ) ) == NULL )
1546 if( ( p_tmp = getenv( "HOME" ) ) == NULL )
1548 if( ( p_tmp = getenv( "TMP" ) ) == NULL )
1554 p_homedir = strdup( p_tmp );
1556 #if defined(HAVE_GETPWUID)
1559 p_homedir = strdup( p_pw->pw_dir );
1567 static int ConfigStringToKey( char *psz_key )
1571 char *psz_parser = strchr( psz_key, '-' );
1572 while( psz_parser && psz_parser != psz_key )
1574 for( i = 0; i < sizeof(modifiers) / sizeof(key_descriptor_t); i++ )
1576 if( !strncasecmp( modifiers[i].psz_key_string, psz_key,
1577 strlen( modifiers[i].psz_key_string ) ) )
1579 i_key |= modifiers[i].i_key_code;
1582 psz_key = psz_parser + 1;
1583 psz_parser = strchr( psz_key, '-' );
1585 for( i = 0; i < sizeof(keys) / sizeof( key_descriptor_t ); i++ )
1587 if( !strcasecmp( keys[i].psz_key_string, psz_key ) )
1589 i_key |= keys[i].i_key_code;
1596 static char *ConfigKeyToString( int i_key )
1598 char *psz_key = malloc( 100 );
1608 for( index = 0; index < (sizeof(modifiers) / sizeof(key_descriptor_t));
1611 if( i_key & modifiers[index].i_key_code )
1613 p += sprintf( p, "%s-", modifiers[index].psz_key_string );
1616 for( index = 0; index < (sizeof(keys) / sizeof( key_descriptor_t));
1619 if( (int)( i_key & ~KEY_MODIFIER ) == keys[index].i_key_code )
1621 p += sprintf( p, "%s", keys[index].psz_key_string );