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 *****************************************************************************/
29 #include "../libvlc.h"
30 #include "vlc_charset.h"
33 #include <errno.h> /* errno */
38 #include "configuration.h"
39 #include "modules/modules.h"
41 static char *ConfigKeyToString( int );
43 static inline char *strdupnull (const char *src)
45 return src ? strdup (src) : NULL;
48 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
50 char *psz_filename = p_obj->p_libvlc->psz_configfile;
55 psz_filename = config_GetConfigFile( p_obj->p_libvlc );
58 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
60 p_stream = utf8_fopen( psz_filename, mode );
61 if( p_stream == NULL && errno != ENOENT )
63 msg_Err( p_obj, "cannot open config file (%s): %m",
67 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
68 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
70 /* This is the fallback for pre XDG Base Directory
71 * Specification configs */
73 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
74 p_obj->p_libvlc->psz_homedir ) != -1 )
76 p_stream = utf8_fopen( psz_old, mode );
79 /* Old config file found. We want to write it at the
80 * new location now. */
81 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
82 "VLC will now use %s.", psz_old, psz_filename );
84 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
85 p_obj->p_libvlc->psz_homedir ) != -1 )
87 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
90 fputs( "The VLC media player configuration folder has "
91 "moved to comply with the XDG Base "
92 "Directory Specification version 0.6. Your "
93 "configuration has been copied to the new "
94 "location (", p_readme );
95 fputs( p_obj->p_libvlc->psz_configdir, p_readme );
96 fputs( "). You can delete this directory and "
97 "all its contents.", p_readme );
107 else if( p_stream != NULL )
109 p_obj->p_libvlc->psz_configfile = psz_filename;
116 static int strtoi (const char *str)
122 l = strtol (str, &end, 0);
126 if ((l > INT_MAX) || (l < INT_MIN))
135 /*****************************************************************************
136 * config_LoadConfigFile: loads the configuration file.
137 *****************************************************************************
138 * This function is called to load the config options stored in the config
140 *****************************************************************************/
141 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
146 file = config_OpenConfigFile (p_this, "rt");
150 /* Acquire config file lock */
151 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
153 /* Look for the selected module, if NULL then save everything */
154 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
156 /* Look for UTF-8 Byte Order Mark */
157 char * (*convert) (const char *) = strdupnull;
160 if ((fread (bom, 1, 3, file) != 3)
161 || memcmp (bom, "\xEF\xBB\xBF", 3))
163 convert = FromLocaleDup;
164 rewind (file); /* no BOM, rewind */
167 module_t *module = NULL;
168 char line[1024], section[1022];
171 while (fgets (line, 1024, file) != NULL)
173 /* Ignore comments and empty lines */
184 char *ptr = strchr (line, ']');
186 continue; /* syntax error; */
189 /* New section ( = a given module) */
190 strcpy (section, line + 1);
193 if ((psz_module_name == NULL)
194 || (strcmp (psz_module_name, section) == 0))
196 for (int i = 0; i < p_list->i_count; i++)
198 module_t *m = (module_t *)p_list->p_values[i].p_object;
200 if ((strcmp (section, m->psz_object_name) == 0)
201 && (m->i_config_items > 0)) /* ignore config-less modules */
204 if (psz_module_name != NULL)
206 "loading config for module \"%s\"",
217 continue; /* no need to parse if there is no matching module */
219 char *ptr = strchr (line, '\n');
223 /* look for option name */
224 const char *psz_option_name = line;
226 ptr = strchr (line, '=');
228 continue; /* syntax error */
231 const char *psz_option_value = ptr + 1;
233 /* try to match this option with one of the module's options */
234 for (size_t i = 0; i < module->confsize; i++)
236 module_config_t *p_item = module->p_config + i;
238 if ((p_item->i_type & CONFIG_HINT)
239 || strcmp (p_item->psz_name, psz_option_name))
245 switch( p_item->i_type )
247 case CONFIG_ITEM_BOOL:
248 case CONFIG_ITEM_INTEGER:
250 long l = strtoi (psz_option_value);
252 msg_Warn (p_this, "Integer value (%s) for %s: %m",
253 psz_option_value, psz_option_name);
255 p_item->saved.i = p_item->value.i = (int)l;
259 case CONFIG_ITEM_FLOAT:
260 if( !*psz_option_value )
261 break; /* ignore empty option */
262 p_item->value.f = (float)i18n_atof( psz_option_value);
263 p_item->saved.f = p_item->value.f;
266 case CONFIG_ITEM_KEY:
267 if( !*psz_option_value )
268 break; /* ignore empty option */
269 p_item->value.i = ConfigStringToKey(psz_option_value);
270 p_item->saved.i = p_item->value.i;
274 vlc_mutex_lock( p_item->p_lock );
276 /* free old string */
277 free( (char*) p_item->value.psz );
278 free( (char*) p_item->saved.psz );
280 p_item->value.psz = convert (psz_option_value);
281 p_item->saved.psz = strdupnull (p_item->value.psz);
283 vlc_mutex_unlock( p_item->p_lock );
293 msg_Err (p_this, "error reading configuration: %m");
298 vlc_list_release( p_list );
300 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
304 /*****************************************************************************
305 * config_CreateDir: Create configuration directory if it doesn't exist.
306 *****************************************************************************/
307 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
309 if( !psz_dirname && !*psz_dirname ) return -1;
311 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
321 /* Let's try to create the parent directory */
322 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
323 strcpy( psz_parent, psz_dirname );
325 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
326 if( psz_end && psz_end != psz_parent )
329 if( config_CreateDir( p_this, psz_parent ) == 0 )
331 if( !utf8_mkdir( psz_dirname, 0700 ) )
338 msg_Err( p_this, "could not create %s: %m", psz_dirname );
343 config_Write (FILE *file, const char *type, const char *desc,
344 bool comment, const char *name, const char *fmt, ...)
352 if (fprintf (file, "# %s (%s)\n%s%s=", desc, _(type),
353 comment ? "#" : "", name) < 0)
357 ret = vfprintf (file, fmt, ap);
362 if (fputs ("\n\n", file) == EOF)
368 /*****************************************************************************
369 * config_SaveConfigFile: Save a module's config options.
370 *****************************************************************************
371 * This will save the specified module's config options to the config file.
372 * If psz_module_name is NULL then we save all the modules config options.
373 * It's no use to save the config options that kept their default values, so
374 * we'll try to be a bit clever here.
376 * When we save we mustn't delete the config options of the modules that
377 * haven't been loaded. So we cannot just create a new config file with the
378 * config structures we've got in memory.
379 * I don't really know how to deal with this nicely, so I will use a completly
381 * I will load the config file in memory, but skipping all the sections of the
382 * modules we want to save. Then I will create a brand new file, dump the file
383 * loaded in memory and then append the sections of the modules we want to
386 *****************************************************************************/
387 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
388 vlc_bool_t b_autosave )
393 char p_line[1024], *p_index2;
395 char *p_bigbuffer, *p_index;
399 /* Acquire config file lock */
400 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
402 if( p_this->p_libvlc->psz_configfile == NULL )
404 const char *psz_configdir = p_this->p_libvlc->psz_configdir;
405 if( !psz_configdir ) /* XXX: This should never happen */
407 msg_Err( p_this, "no configuration directory defined" );
408 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
412 config_CreateDir( p_this, psz_configdir );
415 file = config_OpenConfigFile( p_this, "rt" );
418 /* look for file size */
419 fseek( file, 0L, SEEK_END );
420 i_sizebuf = ftell( file );
421 fseek( file, 0L, SEEK_SET );
424 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
427 if( file ) fclose( file );
428 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
433 /* List all available modules */
434 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
436 /* backup file into memory, we only need to backup the sections we won't
439 while( file && fgets( p_line, 1024, file ) )
441 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
444 /* we found a section, check if we need to do a backup */
445 for( i_index = 0; i_index < p_list->i_count; i_index++ )
447 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
449 if( ((p_index2 - &p_line[1])
450 == (int)strlen(p_parser->psz_object_name) )
451 && !memcmp( &p_line[1], p_parser->psz_object_name,
452 strlen(p_parser->psz_object_name) ) )
454 if( !psz_module_name )
456 else if( !strcmp( psz_module_name,
457 p_parser->psz_object_name ) )
462 if( i_index == p_list->i_count )
464 /* we don't have this section in our list so we need to back
468 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
481 /* save line if requested and line is valid (doesn't begin with a
482 * space, tab, or eol) */
483 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
484 && (p_line[0] != '\t') )
486 strcpy( p_index, p_line );
487 p_index += strlen( p_line );
490 if( file ) fclose( file );
494 * Save module config in file
497 file = config_OpenConfigFile (p_this, "wt");
500 vlc_list_release( p_list );
502 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
506 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
507 "###\n### lines begining with a '#' character are comments\n###\n\n" );
509 /* Look for the selected module, if NULL then save everything */
510 for( i_index = 0; i_index < p_list->i_count; i_index++ )
512 module_config_t *p_item, *p_end;
513 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
515 if( psz_module_name && strcmp( psz_module_name,
516 p_parser->psz_object_name ) )
519 if( !p_parser->i_config_items )
522 if( psz_module_name )
523 msg_Dbg( p_this, "saving config for module \"%s\"",
524 p_parser->psz_object_name );
526 fprintf( file, "[%s]", p_parser->psz_object_name );
527 if( p_parser->psz_longname )
528 fprintf( file, " # %s\n\n", p_parser->psz_longname );
530 fprintf( file, "\n\n" );
532 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
536 /* Do not save the new value in the configuration file
537 * if doing an autosave, and the item is not an "autosaved" one. */
538 vlc_bool_t b_retain = b_autosave && !p_item->b_autosave;
540 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
541 || p_item->b_removed /* ignore deprecated option */
542 || p_item->b_unsaveable) /* ignore volatile option */
545 if (IsConfigIntegerType (p_item->i_type))
547 int val = b_retain ? p_item->saved.i : p_item->value.i;
548 if (p_item->i_type == CONFIG_ITEM_KEY)
550 char *psz_key = ConfigKeyToString (val);
551 config_Write (file, p_item->psz_text, N_("key"),
552 val == p_item->orig.i,
553 p_item->psz_name, "%s",
554 psz_key ? psz_key : "");
558 config_Write (file, p_item->psz_text,
559 (p_item->i_type == CONFIG_ITEM_BOOL)
560 ? N_("boolean") : N_("integer"),
561 val == p_item->orig.i,
562 p_item->psz_name, "%d", val);
563 p_item->saved.i = val;
566 if (IsConfigFloatType (p_item->i_type))
568 float val = b_retain ? p_item->saved.f : p_item->value.f;
569 config_Write (file, p_item->psz_text, N_("float"),
570 val == p_item->orig.f,
571 p_item->psz_name, "%f", val);
572 p_item->saved.f = val;
576 const char *psz_value = b_retain ? p_item->saved.psz
580 assert (IsConfigStringType (p_item->i_type));
582 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
583 psz_value = p_item->orig.psz;
587 ? ((p_item->orig.psz != NULL)
588 ? (strcmp (psz_value, p_item->orig.psz) != 0)
590 : (p_item->orig.psz != NULL);
592 config_Write (file, p_item->psz_text, N_("string"),
593 !modified, p_item->psz_name, "%s",
594 psz_value ? psz_value : "");
599 free ((char *)p_item->saved.psz);
600 if( (psz_value && p_item->orig.psz &&
601 strcmp( psz_value, p_item->orig.psz )) ||
602 !psz_value || !p_item->orig.psz)
603 p_item->saved.psz = strdupnull (psz_value);
605 p_item->saved.psz = NULL;
610 p_item->b_dirty = VLC_FALSE;
614 vlc_list_release( p_list );
617 * Restore old settings from the config in file
619 fputs( p_bigbuffer, file );
623 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
628 int config_AutoSaveConfigFile( vlc_object_t *p_this )
631 int i_index, i_count;
635 /* Check if there's anything to save */
636 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
637 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
638 i_count = p_list->i_count;
639 for( i_index = 0; i_index < i_count; i_index++ )
641 module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object ;
642 module_config_t *p_item, *p_end;
644 if( !p_parser->i_config_items ) continue;
646 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
650 if( p_item->b_autosave && p_item->b_dirty ) break;
652 if( p_item < p_end ) break;
654 vlc_list_release( p_list );
655 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
657 if( i_index == i_count ) return VLC_SUCCESS;
658 return SaveConfigFile( p_this, 0, VLC_TRUE );
661 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
663 return SaveConfigFile( p_this, psz_module_name, VLC_FALSE );
667 * Get the user's configuration file
669 char *config_GetConfigFile( libvlc_int_t *p_libvlc )
671 char *psz_configfile;
672 if( asprintf( &psz_configfile, "%s" DIR_SEP CONFIG_FILE,
673 p_libvlc->psz_configdir ) == -1 )
675 return psz_configfile;
679 * Get the user's configuration file when given with the --config option
681 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
683 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
684 if( psz_configfile != NULL )
686 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
688 /* This is incomplete: we should also support the ~cmassiot/ syntax */
690 if( asprintf( &psz_buf, "%s/%s", p_libvlc->psz_homedir,
691 psz_configfile + 2 ) == -1 )
693 free( psz_configfile );
696 free( psz_configfile );
697 psz_configfile = psz_buf;
700 return psz_configfile;
703 int ConfigStringToKey( const char *psz_key )
707 const char *psz_parser = strchr( psz_key, '-' );
708 while( psz_parser && psz_parser != psz_key )
710 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
712 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
713 strlen( vlc_modifiers[i].psz_key_string ) ) )
715 i_key |= vlc_modifiers[i].i_key_code;
718 psz_key = psz_parser + 1;
719 psz_parser = strchr( psz_key, '-' );
721 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
723 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
725 i_key |= vlc_keys[i].i_key_code;
732 char *ConfigKeyToString( int i_key )
734 char *psz_key = malloc( 100 );
745 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
748 if( i_key & vlc_modifiers[index].i_key_code )
750 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
753 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
756 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
758 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );