1 /*****************************************************************************
2 * file.c: configuration file handling
3 *****************************************************************************
4 * Copyright (C) 2001-2007 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 #include "../libvlc.h"
26 #include "vlc_charset.h"
29 #include <errno.h> /* errno */
36 #include "modules/modules.h"
38 static char *ConfigKeyToString( int );
40 static inline char *strdupnull (const char *src)
42 return src ? strdup (src) : NULL;
45 static inline char *_strdupnull (const char *src)
47 return src ? strdup (_(src)) : NULL;
51 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
53 char *psz_filename = p_obj->p_libvlc->psz_configfile;
58 psz_filename = config_GetConfigFile( p_obj->p_libvlc );
61 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
63 p_stream = utf8_fopen( psz_filename, mode );
64 if( p_stream == NULL && errno != ENOENT )
66 msg_Err( p_obj, "cannot open config file (%s): %m",
70 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
71 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
73 /* This is the fallback for pre XDG Base Directory
74 * Specification configs */
76 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
77 p_obj->p_libvlc->psz_homedir ) != -1 )
79 p_stream = utf8_fopen( psz_old, mode );
82 /* Old config file found. We want to write it at the
83 * new location now. */
84 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
85 "VLC will now use %s.", psz_old, psz_filename );
87 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
88 p_obj->p_libvlc->psz_homedir ) != -1 )
90 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
93 fputs( "The VLC media player configuration folder has "
94 "moved to comply with the XDG Base "
95 "Directory Specification version 0.6. Your "
96 "configuration has been copied to the new "
97 "location (", p_readme );
98 fputs( p_obj->p_libvlc->psz_configdir, p_readme );
99 fputs( "). You can delete this directory and "
100 "all its contents.", p_readme );
110 else if( p_stream != NULL )
112 p_obj->p_libvlc->psz_configfile = psz_filename;
119 static int strtoi (const char *str)
125 l = strtol (str, &end, 0);
129 if ((l > INT_MAX) || (l < INT_MIN))
138 /*****************************************************************************
139 * config_LoadConfigFile: loads the configuration file.
140 *****************************************************************************
141 * This function is called to load the config options stored in the config
143 *****************************************************************************/
144 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
149 file = config_OpenConfigFile (p_this, "rt");
153 /* Acquire config file lock */
154 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
156 /* Look for the selected module, if NULL then save everything */
157 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
159 /* Look for UTF-8 Byte Order Mark */
160 char * (*convert) (const char *) = strdupnull;
163 if ((fread (bom, 1, 3, file) != 3)
164 || memcmp (bom, "\xEF\xBB\xBF", 3))
166 convert = FromLocaleDup;
167 rewind (file); /* no BOM, rewind */
170 module_t *module = NULL;
171 char line[1024], section[1022];
174 while (fgets (line, 1024, file) != NULL)
176 /* Ignore comments and empty lines */
187 char *ptr = strchr (line, ']');
189 continue; /* syntax error; */
192 /* New section ( = a given module) */
193 strcpy (section, line + 1);
196 if ((psz_module_name == NULL)
197 || (strcmp (psz_module_name, section) == 0))
199 for (int i = 0; i < p_list->i_count; i++)
201 module_t *m = (module_t *)p_list->p_values[i].p_object;
203 if ((strcmp (section, m->psz_object_name) == 0)
204 && (m->i_config_items > 0)) /* ignore config-less modules */
207 if (psz_module_name != NULL)
209 "loading config for module \"%s\"",
220 continue; /* no need to parse if there is no matching module */
222 char *ptr = strchr (line, '\n');
226 /* look for option name */
227 const char *psz_option_name = line;
229 ptr = strchr (line, '=');
231 continue; /* syntax error */
234 const char *psz_option_value = ptr + 1;
236 /* try to match this option with one of the module's options */
237 for (size_t i = 0; i < module->confsize; i++)
239 module_config_t *p_item = module->p_config + i;
241 if ((p_item->i_type & CONFIG_HINT)
242 || strcmp (p_item->psz_name, psz_option_name))
248 switch( p_item->i_type )
250 case CONFIG_ITEM_BOOL:
251 case CONFIG_ITEM_INTEGER:
253 long l = strtoi (psz_option_value);
255 msg_Warn (p_this, "Integer value (%s) for %s: %m",
256 psz_option_value, psz_option_name);
258 p_item->saved.i = p_item->value.i = (int)l;
262 case CONFIG_ITEM_FLOAT:
263 if( !*psz_option_value )
264 break; /* ignore empty option */
265 p_item->value.f = (float)i18n_atof( psz_option_value);
266 p_item->saved.f = p_item->value.f;
269 case CONFIG_ITEM_KEY:
270 if( !*psz_option_value )
271 break; /* ignore empty option */
272 p_item->value.i = ConfigStringToKey(psz_option_value);
273 p_item->saved.i = p_item->value.i;
277 vlc_mutex_lock( p_item->p_lock );
279 /* free old string */
280 free( (char*) p_item->value.psz );
281 free( (char*) p_item->saved.psz );
283 p_item->value.psz = convert (psz_option_value);
284 p_item->saved.psz = strdupnull (p_item->value.psz);
286 vlc_mutex_unlock( p_item->p_lock );
296 msg_Err (p_this, "error reading configuration: %m");
301 vlc_list_release( p_list );
303 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
307 /*****************************************************************************
308 * config_CreateDir: Create configuration directory if it doesn't exist.
309 *****************************************************************************/
310 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
312 if( !psz_dirname && !*psz_dirname ) return -1;
314 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
324 /* Let's try to create the parent directory */
325 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
326 strcpy( psz_parent, psz_dirname );
328 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
329 if( psz_end && psz_end != psz_parent )
332 if( config_CreateDir( p_this, psz_parent ) == 0 )
334 if( !utf8_mkdir( psz_dirname, 0700 ) )
341 msg_Err( p_this, "could not create %s: %m", psz_dirname );
345 /*****************************************************************************
346 * config_SaveConfigFile: Save a module's config options.
347 *****************************************************************************
348 * This will save the specified module's config options to the config file.
349 * If psz_module_name is NULL then we save all the modules config options.
350 * It's no use to save the config options that kept their default values, so
351 * we'll try to be a bit clever here.
353 * When we save we mustn't delete the config options of the modules that
354 * haven't been loaded. So we cannot just create a new config file with the
355 * config structures we've got in memory.
356 * I don't really know how to deal with this nicely, so I will use a completly
358 * I will load the config file in memory, but skipping all the sections of the
359 * modules we want to save. Then I will create a brand new file, dump the file
360 * loaded in memory and then append the sections of the modules we want to
363 *****************************************************************************/
364 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
365 vlc_bool_t b_autosave )
370 char p_line[1024], *p_index2;
372 char *p_bigbuffer, *p_index;
376 /* Acquire config file lock */
377 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
379 if( p_this->p_libvlc->psz_configfile == NULL )
381 const char *psz_configdir = p_this->p_libvlc->psz_configdir;
382 if( !psz_configdir ) /* XXX: This should never happen */
384 msg_Err( p_this, "no configuration directory defined" );
385 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
389 config_CreateDir( p_this, psz_configdir );
392 file = config_OpenConfigFile( p_this, "rt" );
395 /* look for file size */
396 fseek( file, 0L, SEEK_END );
397 i_sizebuf = ftell( file );
398 fseek( file, 0L, SEEK_SET );
401 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
404 msg_Err( p_this, "out of memory" );
405 if( file ) fclose( file );
406 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
411 /* List all available modules */
412 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
414 /* backup file into memory, we only need to backup the sections we won't
417 while( file && fgets( p_line, 1024, file ) )
419 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
422 /* we found a section, check if we need to do a backup */
423 for( i_index = 0; i_index < p_list->i_count; i_index++ )
425 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
427 if( ((p_index2 - &p_line[1])
428 == (int)strlen(p_parser->psz_object_name) )
429 && !memcmp( &p_line[1], p_parser->psz_object_name,
430 strlen(p_parser->psz_object_name) ) )
432 if( !psz_module_name )
434 else if( !strcmp( psz_module_name,
435 p_parser->psz_object_name ) )
440 if( i_index == p_list->i_count )
442 /* we don't have this section in our list so we need to back
446 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
459 /* save line if requested and line is valid (doesn't begin with a
460 * space, tab, or eol) */
461 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
462 && (p_line[0] != '\t') )
464 strcpy( p_index, p_line );
465 p_index += strlen( p_line );
468 if( file ) fclose( file );
472 * Save module config in file
475 file = config_OpenConfigFile (p_this, "wt");
478 vlc_list_release( p_list );
480 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
484 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
485 "###\n### lines begining with a '#' character are comments\n###\n\n" );
487 /* Look for the selected module, if NULL then save everything */
488 for( i_index = 0; i_index < p_list->i_count; i_index++ )
490 module_config_t *p_item, *p_end;
491 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
493 if( psz_module_name && strcmp( psz_module_name,
494 p_parser->psz_object_name ) )
497 if( !p_parser->i_config_items )
500 if( psz_module_name )
501 msg_Dbg( p_this, "saving config for module \"%s\"",
502 p_parser->psz_object_name );
504 fprintf( file, "[%s]", p_parser->psz_object_name );
505 if( p_parser->psz_longname )
506 fprintf( file, " # %s\n\n", p_parser->psz_longname );
508 fprintf( file, "\n\n" );
510 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
515 int i_value = p_item->value.i;
516 float f_value = p_item->value.f;
517 const char *psz_value = p_item->value.psz;
519 if( p_item->i_type & CONFIG_HINT )
522 /* Ignore deprecated options */
523 if( p_item->psz_current )
525 if( p_item->b_unsaveable )
529 if( b_autosave && !p_item->b_autosave )
531 i_value = p_item->saved.i;
532 f_value = p_item->saved.f;
533 psz_value = p_item->saved.psz;
534 if( !psz_value ) psz_value = p_item->orig.psz;
538 p_item->b_dirty = VLC_FALSE;
541 switch( p_item->i_type )
543 case CONFIG_ITEM_BOOL:
544 case CONFIG_ITEM_INTEGER:
545 if( p_item->psz_text )
546 fprintf( file, "# %s (%s)\n", p_item->psz_text,
547 (p_item->i_type == CONFIG_ITEM_BOOL) ?
548 _("boolean") : _("integer") );
549 if( i_value == p_item->orig.i )
551 fprintf( file, "%s=%i\n", p_item->psz_name, i_value );
553 p_item->saved.i = i_value;
556 case CONFIG_ITEM_KEY:
557 if( p_item->psz_text )
558 fprintf( file, "# %s (%s)\n", p_item->psz_text,
560 if( i_value == p_item->orig.i )
562 psz_key = ConfigKeyToString( i_value );
563 fprintf( file, "%s=%s\n", p_item->psz_name,
564 psz_key ? psz_key : "" );
567 p_item->saved.i = i_value;
570 case CONFIG_ITEM_FLOAT:
571 if( p_item->psz_text )
572 fprintf( file, "# %s (%s)\n", p_item->psz_text,
574 if( f_value == p_item->orig.f )
576 fprintf( file, "%s=%f\n", p_item->psz_name, (double)f_value );
578 p_item->saved.f = f_value;
582 if( p_item->psz_text )
583 fprintf( file, "# %s (%s)\n", p_item->psz_text,
585 if( (!psz_value && !p_item->orig.psz) ||
586 (psz_value && p_item->orig.psz &&
587 !strcmp( psz_value, p_item->orig.psz )) )
589 fprintf( file, "%s=%s\n", p_item->psz_name,
592 if( b_autosave && !p_item->b_autosave ) break;
594 free ((char *)p_item->saved.psz);
595 if( (psz_value && p_item->orig.psz &&
596 strcmp( psz_value, p_item->orig.psz )) ||
597 !psz_value || !p_item->orig.psz)
598 p_item->saved.psz = strdupnull (psz_value);
600 p_item->saved.psz = NULL;
607 vlc_list_release( p_list );
610 * Restore old settings from the config in file
612 fputs( p_bigbuffer, file );
616 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
621 int config_AutoSaveConfigFile( vlc_object_t *p_this )
624 int i_index, i_count;
626 if( !p_this ) return -1;
628 /* Check if there's anything to save */
629 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
630 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
631 i_count = p_list->i_count;
632 for( i_index = 0; i_index < i_count; i_index++ )
634 module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object ;
635 module_config_t *p_item, *p_end;
637 if( !p_parser->i_config_items ) continue;
639 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
643 if( p_item->b_autosave && p_item->b_dirty ) break;
647 vlc_list_release( p_list );
648 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
650 if( i_index == i_count ) return VLC_SUCCESS;
651 return SaveConfigFile( p_this, 0, VLC_TRUE );
654 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
656 return SaveConfigFile( p_this, psz_module_name, VLC_FALSE );
660 * Get the user's configuration file
662 char *config_GetConfigFile( libvlc_int_t *p_libvlc )
664 char *psz_configfile;
665 if( asprintf( &psz_configfile, "%s" DIR_SEP CONFIG_FILE,
666 p_libvlc->psz_configdir ) == -1 )
668 return psz_configfile;
672 * Get the user's configuration file when given with the --config option
674 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
676 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
677 if( psz_configfile != NULL )
679 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
681 /* This is incomplete: we should also support the ~cmassiot/ syntax */
683 if( asprintf( &psz_buf, "%s/%s", p_libvlc->psz_homedir,
684 psz_configfile + 2 ) == -1 )
686 free( psz_configfile );
689 free( psz_configfile );
690 psz_configfile = psz_buf;
693 return psz_configfile;
696 int ConfigStringToKey( const char *psz_key )
700 const char *psz_parser = strchr( psz_key, '-' );
701 while( psz_parser && psz_parser != psz_key )
703 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
705 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
706 strlen( vlc_modifiers[i].psz_key_string ) ) )
708 i_key |= vlc_modifiers[i].i_key_code;
711 psz_key = psz_parser + 1;
712 psz_parser = strchr( psz_key, '-' );
714 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
716 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
718 i_key |= vlc_keys[i].i_key_code;
725 char *ConfigKeyToString( int i_key )
727 char *psz_key = malloc( 100 );
738 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
741 if( i_key & vlc_modifiers[index].i_key_code )
743 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
746 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
749 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
751 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );