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 */
37 #include "configuration.h"
38 #include "modules/modules.h"
40 static char *ConfigKeyToString( int );
42 static inline char *strdupnull (const char *src)
44 return src ? strdup (src) : NULL;
47 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
49 char *psz_filename = p_obj->p_libvlc->psz_configfile;
54 psz_filename = config_GetConfigFile( p_obj->p_libvlc );
57 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
59 p_stream = utf8_fopen( psz_filename, mode );
60 if( p_stream == NULL && errno != ENOENT )
62 msg_Err( p_obj, "cannot open config file (%s): %m",
66 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
67 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
69 /* This is the fallback for pre XDG Base Directory
70 * Specification configs */
72 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
73 p_obj->p_libvlc->psz_homedir ) != -1 )
75 p_stream = utf8_fopen( psz_old, mode );
78 /* Old config file found. We want to write it at the
79 * new location now. */
80 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
81 "VLC will now use %s.", psz_old, psz_filename );
83 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
84 p_obj->p_libvlc->psz_homedir ) != -1 )
86 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
89 fputs( "The VLC media player configuration folder has "
90 "moved to comply with the XDG Base "
91 "Directory Specification version 0.6. Your "
92 "configuration has been copied to the new "
93 "location (", p_readme );
94 fputs( p_obj->p_libvlc->psz_configdir, p_readme );
95 fputs( "). You can delete this directory and "
96 "all its contents.", p_readme );
106 else if( p_stream != NULL )
108 p_obj->p_libvlc->psz_configfile = psz_filename;
115 static int strtoi (const char *str)
121 l = strtol (str, &end, 0);
125 if ((l > INT_MAX) || (l < INT_MIN))
134 /*****************************************************************************
135 * config_LoadConfigFile: loads the configuration file.
136 *****************************************************************************
137 * This function is called to load the config options stored in the config
139 *****************************************************************************/
140 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
145 file = config_OpenConfigFile (p_this, "rt");
149 /* Acquire config file lock */
150 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
152 /* Look for the selected module, if NULL then save everything */
153 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
155 /* Look for UTF-8 Byte Order Mark */
156 char * (*convert) (const char *) = strdupnull;
159 if ((fread (bom, 1, 3, file) != 3)
160 || memcmp (bom, "\xEF\xBB\xBF", 3))
162 convert = FromLocaleDup;
163 rewind (file); /* no BOM, rewind */
166 module_t *module = NULL;
167 char line[1024], section[1022];
170 while (fgets (line, 1024, file) != NULL)
172 /* Ignore comments and empty lines */
183 char *ptr = strchr (line, ']');
185 continue; /* syntax error; */
188 /* New section ( = a given module) */
189 strcpy (section, line + 1);
192 if ((psz_module_name == NULL)
193 || (strcmp (psz_module_name, section) == 0))
195 for (int i = 0; i < p_list->i_count; i++)
197 module_t *m = (module_t *)p_list->p_values[i].p_object;
199 if ((strcmp (section, m->psz_object_name) == 0)
200 && (m->i_config_items > 0)) /* ignore config-less modules */
203 if (psz_module_name != NULL)
205 "loading config for module \"%s\"",
216 continue; /* no need to parse if there is no matching module */
218 char *ptr = strchr (line, '\n');
222 /* look for option name */
223 const char *psz_option_name = line;
225 ptr = strchr (line, '=');
227 continue; /* syntax error */
230 const char *psz_option_value = ptr + 1;
232 /* try to match this option with one of the module's options */
233 for (size_t i = 0; i < module->confsize; i++)
235 module_config_t *p_item = module->p_config + i;
237 if ((p_item->i_type & CONFIG_HINT)
238 || strcmp (p_item->psz_name, psz_option_name))
244 switch( p_item->i_type )
246 case CONFIG_ITEM_BOOL:
247 case CONFIG_ITEM_INTEGER:
249 long l = strtoi (psz_option_value);
251 msg_Warn (p_this, "Integer value (%s) for %s: %m",
252 psz_option_value, psz_option_name);
254 p_item->saved.i = p_item->value.i = (int)l;
258 case CONFIG_ITEM_FLOAT:
259 if( !*psz_option_value )
260 break; /* ignore empty option */
261 p_item->value.f = (float)i18n_atof( psz_option_value);
262 p_item->saved.f = p_item->value.f;
265 case CONFIG_ITEM_KEY:
266 if( !*psz_option_value )
267 break; /* ignore empty option */
268 p_item->value.i = ConfigStringToKey(psz_option_value);
269 p_item->saved.i = p_item->value.i;
273 vlc_mutex_lock( p_item->p_lock );
275 /* free old string */
276 free( (char*) p_item->value.psz );
277 free( (char*) p_item->saved.psz );
279 p_item->value.psz = convert (psz_option_value);
280 p_item->saved.psz = strdupnull (p_item->value.psz);
282 vlc_mutex_unlock( p_item->p_lock );
292 msg_Err (p_this, "error reading configuration: %m");
297 vlc_list_release( p_list );
299 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
303 /*****************************************************************************
304 * config_CreateDir: Create configuration directory if it doesn't exist.
305 *****************************************************************************/
306 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
308 if( !psz_dirname && !*psz_dirname ) return -1;
310 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
320 /* Let's try to create the parent directory */
321 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
322 strcpy( psz_parent, psz_dirname );
324 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
325 if( psz_end && psz_end != psz_parent )
328 if( config_CreateDir( p_this, psz_parent ) == 0 )
330 if( !utf8_mkdir( psz_dirname, 0700 ) )
337 msg_Err( p_this, "could not create %s: %m", psz_dirname );
342 config_Write (FILE *file, const char *type, const char *desc,
343 bool comment, const char *name, const char *fmt, ...)
351 if (fprintf (file, "# %s (%s)\n%s%s=", desc, _(type),
352 comment ? "#" : "", name) < 0)
356 ret = vfprintf (file, fmt, ap);
361 if (fputs ("\n\n", file) == EOF)
367 /*****************************************************************************
368 * config_SaveConfigFile: Save a module's config options.
369 *****************************************************************************
370 * This will save the specified module's config options to the config file.
371 * If psz_module_name is NULL then we save all the modules config options.
372 * It's no use to save the config options that kept their default values, so
373 * we'll try to be a bit clever here.
375 * When we save we mustn't delete the config options of the modules that
376 * haven't been loaded. So we cannot just create a new config file with the
377 * config structures we've got in memory.
378 * I don't really know how to deal with this nicely, so I will use a completly
380 * I will load the config file in memory, but skipping all the sections of the
381 * modules we want to save. Then I will create a brand new file, dump the file
382 * loaded in memory and then append the sections of the modules we want to
385 *****************************************************************************/
386 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
387 vlc_bool_t b_autosave )
392 char p_line[1024], *p_index2;
394 char *p_bigbuffer, *p_index;
398 /* Acquire config file lock */
399 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
401 if( p_this->p_libvlc->psz_configfile == NULL )
403 const char *psz_configdir = p_this->p_libvlc->psz_configdir;
404 if( !psz_configdir ) /* XXX: This should never happen */
406 msg_Err( p_this, "no configuration directory defined" );
407 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
411 config_CreateDir( p_this, psz_configdir );
414 file = config_OpenConfigFile( p_this, "rt" );
417 /* look for file size */
418 fseek( file, 0L, SEEK_END );
419 i_sizebuf = ftell( file );
420 fseek( file, 0L, SEEK_SET );
423 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
426 if( file ) fclose( file );
427 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
432 /* List all available modules */
433 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
435 /* backup file into memory, we only need to backup the sections we won't
438 while( file && fgets( p_line, 1024, file ) )
440 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
443 /* we found a section, check if we need to do a backup */
444 for( i_index = 0; i_index < p_list->i_count; i_index++ )
446 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
448 if( ((p_index2 - &p_line[1])
449 == (int)strlen(p_parser->psz_object_name) )
450 && !memcmp( &p_line[1], p_parser->psz_object_name,
451 strlen(p_parser->psz_object_name) ) )
453 if( !psz_module_name )
455 else if( !strcmp( psz_module_name,
456 p_parser->psz_object_name ) )
461 if( i_index == p_list->i_count )
463 /* we don't have this section in our list so we need to back
467 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
480 /* save line if requested and line is valid (doesn't begin with a
481 * space, tab, or eol) */
482 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
483 && (p_line[0] != '\t') )
485 strcpy( p_index, p_line );
486 p_index += strlen( p_line );
489 if( file ) fclose( file );
493 * Save module config in file
496 file = config_OpenConfigFile (p_this, "wt");
499 vlc_list_release( p_list );
501 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
505 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
506 "###\n### lines begining with a '#' character are comments\n###\n\n" );
508 /* Look for the selected module, if NULL then save everything */
509 for( i_index = 0; i_index < p_list->i_count; i_index++ )
511 module_config_t *p_item, *p_end;
512 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
514 if( psz_module_name && strcmp( psz_module_name,
515 p_parser->psz_object_name ) )
518 if( !p_parser->i_config_items )
521 if( psz_module_name )
522 msg_Dbg( p_this, "saving config for module \"%s\"",
523 p_parser->psz_object_name );
525 fprintf( file, "[%s]", p_parser->psz_object_name );
526 if( p_parser->psz_longname )
527 fprintf( file, " # %s\n\n", p_parser->psz_longname );
529 fprintf( file, "\n\n" );
531 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
535 /* Do not save the new value in the configuration file
536 * if doing an autosave, and the item is not an "autosaved" one. */
537 vlc_bool_t b_retain = b_autosave && !p_item->b_autosave;
539 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
540 || p_item->b_removed /* ignore deprecated option */
541 || p_item->b_unsaveable) /* ignore volatile option */
544 if (IsConfigIntegerType (p_item->i_type))
546 int val = b_retain ? p_item->saved.i : p_item->value.i;
547 if (p_item->i_type == CONFIG_ITEM_KEY)
549 char *psz_key = ConfigKeyToString (val);
550 config_Write (file, p_item->psz_text, N_("key"),
551 val == p_item->orig.i,
552 p_item->psz_name, "%s",
553 psz_key ? psz_key : "");
557 config_Write (file, p_item->psz_text,
558 (p_item->i_type == CONFIG_ITEM_BOOL)
559 ? N_("boolean") : N_("integer"),
560 val == p_item->orig.i,
561 p_item->psz_name, "%d", val);
562 p_item->saved.i = val;
565 if (IsConfigFloatType (p_item->i_type))
567 float val = b_retain ? p_item->saved.f : p_item->value.f;
568 config_Write (file, p_item->psz_text, N_("float"),
569 val == p_item->orig.f,
570 p_item->psz_name, "%f", val);
571 p_item->saved.f = val;
575 const char *psz_value = b_retain ? p_item->saved.psz
579 assert (IsConfigStringType (p_item->i_type));
581 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
582 psz_value = p_item->orig.psz;
586 ? ((p_item->orig.psz != NULL)
587 ? (strcmp (psz_value, p_item->orig.psz) != 0)
589 : (p_item->orig.psz != NULL);
591 config_Write (file, p_item->psz_text, N_("string"),
592 !modified, p_item->psz_name, "%s",
593 psz_value ? psz_value : "");
598 free ((char *)p_item->saved.psz);
599 if( (psz_value && p_item->orig.psz &&
600 strcmp( psz_value, p_item->orig.psz )) ||
601 !psz_value || !p_item->orig.psz)
602 p_item->saved.psz = strdupnull (psz_value);
604 p_item->saved.psz = NULL;
609 p_item->b_dirty = VLC_FALSE;
613 vlc_list_release( p_list );
616 * Restore old settings from the config in file
618 fputs( p_bigbuffer, file );
622 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
627 int config_AutoSaveConfigFile( vlc_object_t *p_this )
630 int i_index, i_count;
634 /* Check if there's anything to save */
635 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
636 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
637 i_count = p_list->i_count;
638 for( i_index = 0; i_index < i_count; i_index++ )
640 module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object ;
641 module_config_t *p_item, *p_end;
643 if( !p_parser->i_config_items ) continue;
645 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
649 if( p_item->b_autosave && p_item->b_dirty ) break;
651 if( p_item < p_end ) break;
653 vlc_list_release( p_list );
654 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
656 if( i_index == i_count ) return VLC_SUCCESS;
657 return SaveConfigFile( p_this, 0, VLC_TRUE );
660 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
662 return SaveConfigFile( p_this, psz_module_name, VLC_FALSE );
666 * Get the user's configuration file
668 char *config_GetConfigFile( libvlc_int_t *p_libvlc )
670 char *psz_configfile;
671 if( asprintf( &psz_configfile, "%s" DIR_SEP CONFIG_FILE,
672 p_libvlc->psz_configdir ) == -1 )
674 return psz_configfile;
678 * Get the user's configuration file when given with the --config option
680 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
682 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
683 if( psz_configfile != NULL )
685 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
687 /* This is incomplete: we should also support the ~cmassiot/ syntax */
689 if( asprintf( &psz_buf, "%s/%s", p_libvlc->psz_homedir,
690 psz_configfile + 2 ) == -1 )
692 free( psz_configfile );
695 free( psz_configfile );
696 psz_configfile = psz_buf;
699 return psz_configfile;
702 int ConfigStringToKey( const char *psz_key )
706 const char *psz_parser = strchr( psz_key, '-' );
707 while( psz_parser && psz_parser != psz_key )
709 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
711 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
712 strlen( vlc_modifiers[i].psz_key_string ) ) )
714 i_key |= vlc_modifiers[i].i_key_code;
717 psz_key = psz_parser + 1;
718 psz_parser = strchr( psz_key, '-' );
720 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
722 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
724 i_key |= vlc_keys[i].i_key_code;
731 char *ConfigKeyToString( int i_key )
733 char *psz_key = malloc( 100 );
744 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
747 if( i_key & vlc_modifiers[index].i_key_code )
749 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
752 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
755 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
757 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );