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 inline char *_strdupnull (const char *src)
50 return src ? strdup (_(src)) : NULL;
54 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
56 char *psz_filename = p_obj->p_libvlc->psz_configfile;
61 psz_filename = config_GetConfigFile( p_obj->p_libvlc );
64 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
66 p_stream = utf8_fopen( psz_filename, mode );
67 if( p_stream == NULL && errno != ENOENT )
69 msg_Err( p_obj, "cannot open config file (%s): %m",
73 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
74 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
76 /* This is the fallback for pre XDG Base Directory
77 * Specification configs */
79 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
80 p_obj->p_libvlc->psz_homedir ) != -1 )
82 p_stream = utf8_fopen( psz_old, mode );
85 /* Old config file found. We want to write it at the
86 * new location now. */
87 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
88 "VLC will now use %s.", psz_old, psz_filename );
90 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
91 p_obj->p_libvlc->psz_homedir ) != -1 )
93 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
96 fputs( "The VLC media player configuration folder has "
97 "moved to comply with the XDG Base "
98 "Directory Specification version 0.6. Your "
99 "configuration has been copied to the new "
100 "location (", p_readme );
101 fputs( p_obj->p_libvlc->psz_configdir, p_readme );
102 fputs( "). You can delete this directory and "
103 "all its contents.", p_readme );
113 else if( p_stream != NULL )
115 p_obj->p_libvlc->psz_configfile = psz_filename;
122 static int strtoi (const char *str)
128 l = strtol (str, &end, 0);
132 if ((l > INT_MAX) || (l < INT_MIN))
141 /*****************************************************************************
142 * config_LoadConfigFile: loads the configuration file.
143 *****************************************************************************
144 * This function is called to load the config options stored in the config
146 *****************************************************************************/
147 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
152 file = config_OpenConfigFile (p_this, "rt");
156 /* Acquire config file lock */
157 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
159 /* Look for the selected module, if NULL then save everything */
160 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
162 /* Look for UTF-8 Byte Order Mark */
163 char * (*convert) (const char *) = strdupnull;
166 if ((fread (bom, 1, 3, file) != 3)
167 || memcmp (bom, "\xEF\xBB\xBF", 3))
169 convert = FromLocaleDup;
170 rewind (file); /* no BOM, rewind */
173 module_t *module = NULL;
174 char line[1024], section[1022];
177 while (fgets (line, 1024, file) != NULL)
179 /* Ignore comments and empty lines */
190 char *ptr = strchr (line, ']');
192 continue; /* syntax error; */
195 /* New section ( = a given module) */
196 strcpy (section, line + 1);
199 if ((psz_module_name == NULL)
200 || (strcmp (psz_module_name, section) == 0))
202 for (int i = 0; i < p_list->i_count; i++)
204 module_t *m = (module_t *)p_list->p_values[i].p_object;
206 if ((strcmp (section, m->psz_object_name) == 0)
207 && (m->i_config_items > 0)) /* ignore config-less modules */
210 if (psz_module_name != NULL)
212 "loading config for module \"%s\"",
223 continue; /* no need to parse if there is no matching module */
225 char *ptr = strchr (line, '\n');
229 /* look for option name */
230 const char *psz_option_name = line;
232 ptr = strchr (line, '=');
234 continue; /* syntax error */
237 const char *psz_option_value = ptr + 1;
239 /* try to match this option with one of the module's options */
240 for (size_t i = 0; i < module->confsize; i++)
242 module_config_t *p_item = module->p_config + i;
244 if ((p_item->i_type & CONFIG_HINT)
245 || strcmp (p_item->psz_name, psz_option_name))
251 switch( p_item->i_type )
253 case CONFIG_ITEM_BOOL:
254 case CONFIG_ITEM_INTEGER:
256 long l = strtoi (psz_option_value);
258 msg_Warn (p_this, "Integer value (%s) for %s: %m",
259 psz_option_value, psz_option_name);
261 p_item->saved.i = p_item->value.i = (int)l;
265 case CONFIG_ITEM_FLOAT:
266 if( !*psz_option_value )
267 break; /* ignore empty option */
268 p_item->value.f = (float)i18n_atof( psz_option_value);
269 p_item->saved.f = p_item->value.f;
272 case CONFIG_ITEM_KEY:
273 if( !*psz_option_value )
274 break; /* ignore empty option */
275 p_item->value.i = ConfigStringToKey(psz_option_value);
276 p_item->saved.i = p_item->value.i;
280 vlc_mutex_lock( p_item->p_lock );
282 /* free old string */
283 free( (char*) p_item->value.psz );
284 free( (char*) p_item->saved.psz );
286 p_item->value.psz = convert (psz_option_value);
287 p_item->saved.psz = strdupnull (p_item->value.psz);
289 vlc_mutex_unlock( p_item->p_lock );
299 msg_Err (p_this, "error reading configuration: %m");
304 vlc_list_release( p_list );
306 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
310 /*****************************************************************************
311 * config_CreateDir: Create configuration directory if it doesn't exist.
312 *****************************************************************************/
313 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
315 if( !psz_dirname && !*psz_dirname ) return -1;
317 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
327 /* Let's try to create the parent directory */
328 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
329 strcpy( psz_parent, psz_dirname );
331 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
332 if( psz_end && psz_end != psz_parent )
335 if( config_CreateDir( p_this, psz_parent ) == 0 )
337 if( !utf8_mkdir( psz_dirname, 0700 ) )
344 msg_Err( p_this, "could not create %s: %m", psz_dirname );
349 config_Write (FILE *file, const char *type, const char *desc,
350 bool comment, const char *name, const char *fmt, ...)
358 if (fprintf (file, "# %s (%s)\n%s%s=", desc, _(type),
359 comment ? "#" : "", name) < 0)
363 ret = vfprintf (file, fmt, ap);
368 if (fputs ("\n\n", file) == EOF)
374 /*****************************************************************************
375 * config_SaveConfigFile: Save a module's config options.
376 *****************************************************************************
377 * This will save the specified module's config options to the config file.
378 * If psz_module_name is NULL then we save all the modules config options.
379 * It's no use to save the config options that kept their default values, so
380 * we'll try to be a bit clever here.
382 * When we save we mustn't delete the config options of the modules that
383 * haven't been loaded. So we cannot just create a new config file with the
384 * config structures we've got in memory.
385 * I don't really know how to deal with this nicely, so I will use a completly
387 * I will load the config file in memory, but skipping all the sections of the
388 * modules we want to save. Then I will create a brand new file, dump the file
389 * loaded in memory and then append the sections of the modules we want to
392 *****************************************************************************/
393 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
394 vlc_bool_t b_autosave )
399 char p_line[1024], *p_index2;
401 char *p_bigbuffer, *p_index;
405 /* Acquire config file lock */
406 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
408 if( p_this->p_libvlc->psz_configfile == NULL )
410 const char *psz_configdir = p_this->p_libvlc->psz_configdir;
411 if( !psz_configdir ) /* XXX: This should never happen */
413 msg_Err( p_this, "no configuration directory defined" );
414 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
418 config_CreateDir( p_this, psz_configdir );
421 file = config_OpenConfigFile( p_this, "rt" );
424 /* look for file size */
425 fseek( file, 0L, SEEK_END );
426 i_sizebuf = ftell( file );
427 fseek( file, 0L, SEEK_SET );
430 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
433 msg_Err( p_this, "out of memory" );
434 if( file ) fclose( file );
435 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
440 /* List all available modules */
441 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
443 /* backup file into memory, we only need to backup the sections we won't
446 while( file && fgets( p_line, 1024, file ) )
448 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
451 /* we found a section, check if we need to do a backup */
452 for( i_index = 0; i_index < p_list->i_count; i_index++ )
454 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
456 if( ((p_index2 - &p_line[1])
457 == (int)strlen(p_parser->psz_object_name) )
458 && !memcmp( &p_line[1], p_parser->psz_object_name,
459 strlen(p_parser->psz_object_name) ) )
461 if( !psz_module_name )
463 else if( !strcmp( psz_module_name,
464 p_parser->psz_object_name ) )
469 if( i_index == p_list->i_count )
471 /* we don't have this section in our list so we need to back
475 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
488 /* save line if requested and line is valid (doesn't begin with a
489 * space, tab, or eol) */
490 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
491 && (p_line[0] != '\t') )
493 strcpy( p_index, p_line );
494 p_index += strlen( p_line );
497 if( file ) fclose( file );
501 * Save module config in file
504 file = config_OpenConfigFile (p_this, "wt");
507 vlc_list_release( p_list );
509 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
513 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
514 "###\n### lines begining with a '#' character are comments\n###\n\n" );
516 /* Look for the selected module, if NULL then save everything */
517 for( i_index = 0; i_index < p_list->i_count; i_index++ )
519 module_config_t *p_item, *p_end;
520 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
522 if( psz_module_name && strcmp( psz_module_name,
523 p_parser->psz_object_name ) )
526 if( !p_parser->i_config_items )
529 if( psz_module_name )
530 msg_Dbg( p_this, "saving config for module \"%s\"",
531 p_parser->psz_object_name );
533 fprintf( file, "[%s]", p_parser->psz_object_name );
534 if( p_parser->psz_longname )
535 fprintf( file, " # %s\n\n", p_parser->psz_longname );
537 fprintf( file, "\n\n" );
539 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
543 /* Do not save the new value in the configuration file
544 * if doing an autosave, and the item is not an "autosaved" one. */
545 vlc_bool_t b_retain = b_autosave && !p_item->b_autosave;
547 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
548 || p_item->b_removed /* ignore deprecated option */
549 || p_item->b_unsaveable) /* ignore volatile option */
552 if (IsConfigIntegerType (p_item->i_type))
554 int val = b_retain ? p_item->saved.i : p_item->value.i;
555 if (p_item->i_type == CONFIG_ITEM_KEY)
557 char *psz_key = ConfigKeyToString (val);
558 config_Write (file, p_item->psz_text, N_("key"),
559 val == p_item->orig.i,
560 p_item->psz_name, "%s",
561 psz_key ? psz_key : "");
565 config_Write (file, p_item->psz_text,
566 (p_item->i_type == CONFIG_ITEM_BOOL)
567 ? N_("boolean") : N_("integer"),
568 val == p_item->orig.i,
569 p_item->psz_name, "%d", val);
570 p_item->saved.i = val;
573 if (IsConfigFloatType (p_item->i_type))
575 float val = b_retain ? p_item->saved.f : p_item->value.f;
576 config_Write (file, p_item->psz_text, N_("float"),
577 val == p_item->orig.f,
578 p_item->psz_name, "%f", val);
579 p_item->saved.f = val;
583 const char *psz_value = b_retain ? p_item->saved.psz
587 assert (IsConfigStringType (p_item->i_type));
589 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
590 psz_value = p_item->orig.psz;
594 ? ((p_item->orig.psz != NULL)
595 ? (strcmp (psz_value, p_item->orig.psz) != 0)
597 : (p_item->orig.psz != NULL);
599 config_Write (file, p_item->psz_text, N_("string"),
600 !modified, p_item->psz_name, "%s",
601 psz_value ? psz_value : "");
606 free ((char *)p_item->saved.psz);
607 if( (psz_value && p_item->orig.psz &&
608 strcmp( psz_value, p_item->orig.psz )) ||
609 !psz_value || !p_item->orig.psz)
610 p_item->saved.psz = strdupnull (psz_value);
612 p_item->saved.psz = NULL;
617 p_item->b_dirty = VLC_FALSE;
621 vlc_list_release( p_list );
624 * Restore old settings from the config in file
626 fputs( p_bigbuffer, file );
630 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
635 int config_AutoSaveConfigFile( vlc_object_t *p_this )
638 int i_index, i_count;
640 if( !p_this ) return -1;
642 /* Check if there's anything to save */
643 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
644 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
645 i_count = p_list->i_count;
646 for( i_index = 0; i_index < i_count; i_index++ )
648 module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object ;
649 module_config_t *p_item, *p_end;
651 if( !p_parser->i_config_items ) continue;
653 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
657 if( p_item->b_autosave && p_item->b_dirty ) break;
661 vlc_list_release( p_list );
662 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
664 if( i_index == i_count ) return VLC_SUCCESS;
665 return SaveConfigFile( p_this, 0, VLC_TRUE );
668 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
670 return SaveConfigFile( p_this, psz_module_name, VLC_FALSE );
674 * Get the user's configuration file
676 char *config_GetConfigFile( libvlc_int_t *p_libvlc )
678 char *psz_configfile;
679 if( asprintf( &psz_configfile, "%s" DIR_SEP CONFIG_FILE,
680 p_libvlc->psz_configdir ) == -1 )
682 return psz_configfile;
686 * Get the user's configuration file when given with the --config option
688 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
690 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
691 if( psz_configfile != NULL )
693 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
695 /* This is incomplete: we should also support the ~cmassiot/ syntax */
697 if( asprintf( &psz_buf, "%s/%s", p_libvlc->psz_homedir,
698 psz_configfile + 2 ) == -1 )
700 free( psz_configfile );
703 free( psz_configfile );
704 psz_configfile = psz_buf;
707 return psz_configfile;
710 int ConfigStringToKey( const char *psz_key )
714 const char *psz_parser = strchr( psz_key, '-' );
715 while( psz_parser && psz_parser != psz_key )
717 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
719 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
720 strlen( vlc_modifiers[i].psz_key_string ) ) )
722 i_key |= vlc_modifiers[i].i_key_code;
725 psz_key = psz_parser + 1;
726 psz_parser = strchr( psz_key, '-' );
728 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
730 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
732 i_key |= vlc_keys[i].i_key_code;
739 char *ConfigKeyToString( int i_key )
741 char *psz_key = malloc( 100 );
752 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
755 if( i_key & vlc_modifiers[index].i_key_code )
757 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
760 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
763 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
765 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );