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 */
37 #include "modules/modules.h"
39 static char *ConfigKeyToString( int );
41 static inline char *strdupnull (const char *src)
43 return src ? strdup (src) : NULL;
46 static inline char *_strdupnull (const char *src)
48 return src ? strdup (_(src)) : NULL;
52 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
54 char *psz_filename = p_obj->p_libvlc->psz_configfile;
59 psz_filename = config_GetConfigFile( p_obj->p_libvlc );
62 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
64 p_stream = utf8_fopen( psz_filename, mode );
65 if( p_stream == NULL && errno != ENOENT )
67 msg_Err( p_obj, "cannot open config file (%s): %m",
71 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
72 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
74 /* This is the fallback for pre XDG Base Directory
75 * Specification configs */
77 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
78 p_obj->p_libvlc->psz_homedir ) != -1 )
80 p_stream = utf8_fopen( psz_old, mode );
83 /* Old config file found. We want to write it at the
84 * new location now. */
85 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
86 "VLC will now use %s.", psz_old, psz_filename );
88 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
89 p_obj->p_libvlc->psz_homedir ) != -1 )
91 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
94 fputs( "The VLC media player configuration folder has "
95 "moved to comply with the XDG Base "
96 "Directory Specification version 0.6. Your "
97 "configuration has been copied to the new "
98 "location (", p_readme );
99 fputs( p_obj->p_libvlc->psz_configdir, p_readme );
100 fputs( "). You can delete this directory and "
101 "all its contents.", p_readme );
111 else if( p_stream != NULL )
113 p_obj->p_libvlc->psz_configfile = psz_filename;
120 static int strtoi (const char *str)
126 l = strtol (str, &end, 0);
130 if ((l > INT_MAX) || (l < INT_MIN))
139 /*****************************************************************************
140 * config_LoadConfigFile: loads the configuration file.
141 *****************************************************************************
142 * This function is called to load the config options stored in the config
144 *****************************************************************************/
145 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
150 file = config_OpenConfigFile (p_this, "rt");
154 /* Acquire config file lock */
155 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
157 /* Look for the selected module, if NULL then save everything */
158 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
160 /* Look for UTF-8 Byte Order Mark */
161 char * (*convert) (const char *) = strdupnull;
164 if ((fread (bom, 1, 3, file) != 3)
165 || memcmp (bom, "\xEF\xBB\xBF", 3))
167 convert = FromLocaleDup;
168 rewind (file); /* no BOM, rewind */
171 module_t *module = NULL;
172 char line[1024], section[1022];
175 while (fgets (line, 1024, file) != NULL)
177 /* Ignore comments and empty lines */
188 char *ptr = strchr (line, ']');
190 continue; /* syntax error; */
193 /* New section ( = a given module) */
194 strcpy (section, line + 1);
197 if ((psz_module_name == NULL)
198 || (strcmp (psz_module_name, section) == 0))
200 for (int i = 0; i < p_list->i_count; i++)
202 module_t *m = (module_t *)p_list->p_values[i].p_object;
204 if ((strcmp (section, m->psz_object_name) == 0)
205 && (m->i_config_items > 0)) /* ignore config-less modules */
208 if (psz_module_name != NULL)
210 "loading config for module \"%s\"",
221 continue; /* no need to parse if there is no matching module */
223 char *ptr = strchr (line, '\n');
227 /* look for option name */
228 const char *psz_option_name = line;
230 ptr = strchr (line, '=');
232 continue; /* syntax error */
235 const char *psz_option_value = ptr + 1;
237 /* try to match this option with one of the module's options */
238 for (size_t i = 0; i < module->confsize; i++)
240 module_config_t *p_item = module->p_config + i;
242 if ((p_item->i_type & CONFIG_HINT)
243 || strcmp (p_item->psz_name, psz_option_name))
249 switch( p_item->i_type )
251 case CONFIG_ITEM_BOOL:
252 case CONFIG_ITEM_INTEGER:
254 long l = strtoi (psz_option_value);
256 msg_Warn (p_this, "Integer value (%s) for %s: %m",
257 psz_option_value, psz_option_name);
259 p_item->saved.i = p_item->value.i = (int)l;
263 case CONFIG_ITEM_FLOAT:
264 if( !*psz_option_value )
265 break; /* ignore empty option */
266 p_item->value.f = (float)i18n_atof( psz_option_value);
267 p_item->saved.f = p_item->value.f;
270 case CONFIG_ITEM_KEY:
271 if( !*psz_option_value )
272 break; /* ignore empty option */
273 p_item->value.i = ConfigStringToKey(psz_option_value);
274 p_item->saved.i = p_item->value.i;
278 vlc_mutex_lock( p_item->p_lock );
280 /* free old string */
281 free( (char*) p_item->value.psz );
282 free( (char*) p_item->saved.psz );
284 p_item->value.psz = convert (psz_option_value);
285 p_item->saved.psz = strdupnull (p_item->value.psz);
287 vlc_mutex_unlock( p_item->p_lock );
297 msg_Err (p_this, "error reading configuration: %m");
302 vlc_list_release( p_list );
304 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
308 /*****************************************************************************
309 * config_CreateDir: Create configuration directory if it doesn't exist.
310 *****************************************************************************/
311 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
313 if( !psz_dirname && !*psz_dirname ) return -1;
315 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
325 /* Let's try to create the parent directory */
326 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
327 strcpy( psz_parent, psz_dirname );
329 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
330 if( psz_end && psz_end != psz_parent )
333 if( config_CreateDir( p_this, psz_parent ) == 0 )
335 if( !utf8_mkdir( psz_dirname, 0700 ) )
342 msg_Err( p_this, "could not create %s: %m", psz_dirname );
347 config_Write (FILE *file, const char *type, const char *desc,
348 bool comment, const char *name, const char *fmt, ...)
356 if (fprintf (file, "# %s (%s)\n%s%s=", desc, gettext (type),
357 comment ? "#" : "", name) < 0)
361 ret = vfprintf (file, fmt, ap);
366 if (fputs ("\n\n", file) == EOF)
372 /*****************************************************************************
373 * config_SaveConfigFile: Save a module's config options.
374 *****************************************************************************
375 * This will save the specified module's config options to the config file.
376 * If psz_module_name is NULL then we save all the modules config options.
377 * It's no use to save the config options that kept their default values, so
378 * we'll try to be a bit clever here.
380 * When we save we mustn't delete the config options of the modules that
381 * haven't been loaded. So we cannot just create a new config file with the
382 * config structures we've got in memory.
383 * I don't really know how to deal with this nicely, so I will use a completly
385 * I will load the config file in memory, but skipping all the sections of the
386 * modules we want to save. Then I will create a brand new file, dump the file
387 * loaded in memory and then append the sections of the modules we want to
390 *****************************************************************************/
391 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
392 vlc_bool_t b_autosave )
397 char p_line[1024], *p_index2;
399 char *p_bigbuffer, *p_index;
403 /* Acquire config file lock */
404 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
406 if( p_this->p_libvlc->psz_configfile == NULL )
408 const char *psz_configdir = p_this->p_libvlc->psz_configdir;
409 if( !psz_configdir ) /* XXX: This should never happen */
411 msg_Err( p_this, "no configuration directory defined" );
412 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
416 config_CreateDir( p_this, psz_configdir );
419 file = config_OpenConfigFile( p_this, "rt" );
422 /* look for file size */
423 fseek( file, 0L, SEEK_END );
424 i_sizebuf = ftell( file );
425 fseek( file, 0L, SEEK_SET );
428 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
431 msg_Err( p_this, "out of memory" );
432 if( file ) fclose( file );
433 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
438 /* List all available modules */
439 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
441 /* backup file into memory, we only need to backup the sections we won't
444 while( file && fgets( p_line, 1024, file ) )
446 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
449 /* we found a section, check if we need to do a backup */
450 for( i_index = 0; i_index < p_list->i_count; i_index++ )
452 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
454 if( ((p_index2 - &p_line[1])
455 == (int)strlen(p_parser->psz_object_name) )
456 && !memcmp( &p_line[1], p_parser->psz_object_name,
457 strlen(p_parser->psz_object_name) ) )
459 if( !psz_module_name )
461 else if( !strcmp( psz_module_name,
462 p_parser->psz_object_name ) )
467 if( i_index == p_list->i_count )
469 /* we don't have this section in our list so we need to back
473 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
486 /* save line if requested and line is valid (doesn't begin with a
487 * space, tab, or eol) */
488 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
489 && (p_line[0] != '\t') )
491 strcpy( p_index, p_line );
492 p_index += strlen( p_line );
495 if( file ) fclose( file );
499 * Save module config in file
502 file = config_OpenConfigFile (p_this, "wt");
505 vlc_list_release( p_list );
507 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
511 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
512 "###\n### lines begining with a '#' character are comments\n###\n\n" );
514 /* Look for the selected module, if NULL then save everything */
515 for( i_index = 0; i_index < p_list->i_count; i_index++ )
517 module_config_t *p_item, *p_end;
518 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
520 if( psz_module_name && strcmp( psz_module_name,
521 p_parser->psz_object_name ) )
524 if( !p_parser->i_config_items )
527 if( psz_module_name )
528 msg_Dbg( p_this, "saving config for module \"%s\"",
529 p_parser->psz_object_name );
531 fprintf( file, "[%s]", p_parser->psz_object_name );
532 if( p_parser->psz_longname )
533 fprintf( file, " # %s\n\n", p_parser->psz_longname );
535 fprintf( file, "\n\n" );
537 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
541 /* Do not save the new value in the configuration file
542 * if doing an autosave, and the item is not an "autosaved" one. */
543 vlc_bool_t b_retain = b_autosave && !p_item->b_autosave;
545 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
546 || p_item->psz_current /* ignore deprecated option */
547 || p_item->b_unsaveable) /* ignore volatile option */
550 if (IsConfigIntegerType (p_item->i_type))
552 int val = b_retain ? p_item->saved.i : p_item->value.i;
553 if (p_item->i_type == CONFIG_ITEM_KEY)
555 char *psz_key = ConfigKeyToString (val);
556 config_Write (file, p_item->psz_text, N_("key"),
557 val == p_item->orig.i,
558 p_item->psz_name, "%s",
559 psz_key ? psz_key : "");
563 config_Write (file, p_item->psz_text,
564 (p_item->i_type == CONFIG_ITEM_BOOL)
565 ? N_("boolean") : N_("integer"),
566 val == p_item->orig.i,
567 p_item->psz_name, "%d", val);
568 p_item->saved.i = val;
571 if (IsConfigFloatType (p_item->i_type))
573 float val = b_retain ? p_item->saved.f : p_item->value.f;
574 config_Write (file, p_item->psz_text, N_("float"),
575 val == p_item->orig.f,
576 p_item->psz_name, "%f", val);
577 p_item->saved.f = val;
581 const char *psz_value = b_retain ? p_item->saved.psz
585 assert (IsConfigStringType (p_item->i_type));
587 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
588 psz_value = p_item->orig.psz;
592 ? ((p_item->orig.psz != NULL)
593 ? (strcmp (psz_value, p_item->orig.psz) != 0)
595 : (p_item->orig.psz != NULL);
597 config_Write (file, p_item->psz_text, N_("string"),
598 modified, p_item->psz_name, "%s",
599 psz_value ? psz_value : "");
604 free ((char *)p_item->saved.psz);
605 if( (psz_value && p_item->orig.psz &&
606 strcmp( psz_value, p_item->orig.psz )) ||
607 !psz_value || !p_item->orig.psz)
608 p_item->saved.psz = strdupnull (psz_value);
610 p_item->saved.psz = NULL;
614 p_item->b_dirty = VLC_FALSE;
618 vlc_list_release( p_list );
621 * Restore old settings from the config in file
623 fputs( p_bigbuffer, file );
627 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
632 int config_AutoSaveConfigFile( vlc_object_t *p_this )
635 int i_index, i_count;
637 if( !p_this ) return -1;
639 /* Check if there's anything to save */
640 vlc_mutex_lock( &p_this->p_libvlc->config_lock );
641 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
642 i_count = p_list->i_count;
643 for( i_index = 0; i_index < i_count; i_index++ )
645 module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object ;
646 module_config_t *p_item, *p_end;
648 if( !p_parser->i_config_items ) continue;
650 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
654 if( p_item->b_autosave && p_item->b_dirty ) break;
658 vlc_list_release( p_list );
659 vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
661 if( i_index == i_count ) return VLC_SUCCESS;
662 return SaveConfigFile( p_this, 0, VLC_TRUE );
665 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
667 return SaveConfigFile( p_this, psz_module_name, VLC_FALSE );
671 * Get the user's configuration file
673 char *config_GetConfigFile( libvlc_int_t *p_libvlc )
675 char *psz_configfile;
676 if( asprintf( &psz_configfile, "%s" DIR_SEP CONFIG_FILE,
677 p_libvlc->psz_configdir ) == -1 )
679 return psz_configfile;
683 * Get the user's configuration file when given with the --config option
685 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
687 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
688 if( psz_configfile != NULL )
690 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
692 /* This is incomplete: we should also support the ~cmassiot/ syntax */
694 if( asprintf( &psz_buf, "%s/%s", p_libvlc->psz_homedir,
695 psz_configfile + 2 ) == -1 )
697 free( psz_configfile );
700 free( psz_configfile );
701 psz_configfile = psz_buf;
704 return psz_configfile;
707 int ConfigStringToKey( const char *psz_key )
711 const char *psz_parser = strchr( psz_key, '-' );
712 while( psz_parser && psz_parser != psz_key )
714 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
716 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
717 strlen( vlc_modifiers[i].psz_key_string ) ) )
719 i_key |= vlc_modifiers[i].i_key_code;
722 psz_key = psz_parser + 1;
723 psz_parser = strchr( psz_key, '-' );
725 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
727 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
729 i_key |= vlc_keys[i].i_key_code;
736 char *ConfigKeyToString( int i_key )
738 char *psz_key = malloc( 100 );
749 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
752 if( i_key & vlc_modifiers[index].i_key_code )
754 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
757 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
760 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
762 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );