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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include "../libvlc.h"
30 #include "vlc_charset.h"
33 #include <errno.h> /* errno */
42 #include "configuration.h"
43 #include "modules/modules.h"
45 static char *ConfigKeyToString( int );
47 static inline char *strdupnull (const char *src)
49 return src ? strdup (src) : NULL;
53 * Get the user's configuration file
55 static char *config_GetConfigFile( void )
57 char *psz_dir = config_GetUserConfDir();
60 if( asprintf( &psz_configfile, "%s" DIR_SEP CONFIG_FILE, psz_dir ) == -1 )
61 psz_configfile = NULL;
63 return psz_configfile;
66 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
68 char *psz_filename = libvlc_priv (p_obj->p_libvlc)->psz_configfile;
73 psz_filename = config_GetConfigFile();
76 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
78 p_stream = utf8_fopen( psz_filename, mode );
79 if( p_stream == NULL && errno != ENOENT )
81 msg_Err( p_obj, "cannot open config file (%s): %m",
85 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
86 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
88 /* This is the fallback for pre XDG Base Directory
89 * Specification configs */
91 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
92 config_GetHomeDir() ) != -1 )
94 p_stream = utf8_fopen( psz_old, mode );
97 /* Old config file found. We want to write it at the
98 * new location now. */
99 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
100 "VLC will now use %s.", psz_old, psz_filename );
102 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
103 config_GetHomeDir() ) != -1 )
105 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
108 fprintf( p_readme, "The VLC media player "
109 "configuration folder has moved to comply\n"
110 "with the XDG Base Directory Specification "
111 "version 0.6. Your\nconfiguration has been "
112 "copied to the new location:\n%s\nYou can "
113 "delete this directory and all its contents.",
124 else if( p_stream != NULL )
126 libvlc_priv (p_obj->p_libvlc)->psz_configfile = psz_filename;
133 static int strtoi (const char *str)
139 l = strtol (str, &end, 0);
143 if ((l > INT_MAX) || (l < INT_MIN))
152 /*****************************************************************************
153 * config_LoadConfigFile: loads the configuration file.
154 *****************************************************************************
155 * This function is called to load the config options stored in the config
157 *****************************************************************************/
158 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
160 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
164 file = config_OpenConfigFile (p_this, "rt");
168 /* Acquire config file lock */
169 vlc_mutex_lock( &priv->config_lock );
171 /* Look for the selected module, if NULL then save everything */
172 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
174 /* Look for UTF-8 Byte Order Mark */
175 char * (*convert) (const char *) = strdupnull;
178 if ((fread (bom, 1, 3, file) != 3)
179 || memcmp (bom, "\xEF\xBB\xBF", 3))
181 convert = FromLocaleDup;
182 rewind (file); /* no BOM, rewind */
185 module_t *module = NULL;
186 char line[1024], section[1022];
189 /* Ensure consistent number formatting... */
190 locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
191 locale_t baseloc = uselocale (loc);
193 while (fgets (line, 1024, file) != NULL)
195 /* Ignore comments and empty lines */
206 char *ptr = strchr (line, ']');
208 continue; /* syntax error; */
211 /* New section ( = a given module) */
212 strcpy (section, line + 1);
215 if ((psz_module_name == NULL)
216 || (strcmp (psz_module_name, section) == 0))
218 for (int i = 0; i < p_list->i_count; i++)
220 module_t *m = (module_t *)p_list->p_values[i].p_object;
222 if ((strcmp (section, m->psz_object_name) == 0)
223 && (m->i_config_items > 0)) /* ignore config-less modules */
226 if (psz_module_name != NULL)
228 "loading config for module \"%s\"",
239 continue; /* no need to parse if there is no matching module */
241 char *ptr = strchr (line, '\n');
245 /* look for option name */
246 const char *psz_option_name = line;
248 ptr = strchr (line, '=');
250 continue; /* syntax error */
253 const char *psz_option_value = ptr + 1;
255 /* try to match this option with one of the module's options */
256 for (size_t i = 0; i < module->confsize; i++)
258 module_config_t *p_item = module->p_config + i;
260 if ((p_item->i_type & CONFIG_HINT)
261 || strcmp (p_item->psz_name, psz_option_name))
267 switch( p_item->i_type )
269 case CONFIG_ITEM_BOOL:
270 case CONFIG_ITEM_INTEGER:
272 long l = strtoi (psz_option_value);
274 msg_Warn (p_this, "Integer value (%s) for %s: %m",
275 psz_option_value, psz_option_name);
277 p_item->saved.i = p_item->value.i = (int)l;
281 case CONFIG_ITEM_FLOAT:
282 if( !*psz_option_value )
283 break; /* ignore empty option */
284 p_item->value.f = (float)atof (psz_option_value);
285 p_item->saved.f = p_item->value.f;
288 case CONFIG_ITEM_KEY:
289 if( !*psz_option_value )
290 break; /* ignore empty option */
291 p_item->value.i = ConfigStringToKey(psz_option_value);
292 p_item->saved.i = p_item->value.i;
296 vlc_mutex_lock( p_item->p_lock );
298 /* free old string */
299 free( (char*) p_item->value.psz );
300 free( (char*) p_item->saved.psz );
302 p_item->value.psz = convert (psz_option_value);
303 p_item->saved.psz = strdupnull (p_item->value.psz);
305 vlc_mutex_unlock( p_item->p_lock );
315 msg_Err (p_this, "error reading configuration: %m");
320 vlc_list_release( p_list );
321 if (loc != (locale_t)0)
327 vlc_mutex_unlock( &priv->config_lock );
331 /*****************************************************************************
332 * config_CreateDir: Create configuration directory if it doesn't exist.
333 *****************************************************************************/
334 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
336 if( !psz_dirname || !*psz_dirname ) return -1;
338 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
348 /* Let's try to create the parent directory */
349 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
350 strcpy( psz_parent, psz_dirname );
352 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
353 if( psz_end && psz_end != psz_parent )
356 if( config_CreateDir( p_this, psz_parent ) == 0 )
358 if( !utf8_mkdir( psz_dirname, 0700 ) )
365 msg_Err( p_this, "could not create %s: %m", psz_dirname );
370 config_Write (FILE *file, const char *type, const char *desc,
371 bool comment, const char *name, const char *fmt, ...)
379 if (fprintf (file, "# %s (%s)\n%s%s=", desc, _(type),
380 comment ? "#" : "", name) < 0)
384 ret = vfprintf (file, fmt, ap);
389 if (fputs ("\n\n", file) == EOF)
395 /*****************************************************************************
396 * config_SaveConfigFile: Save a module's config options.
397 *****************************************************************************
398 * This will save the specified module's config options to the config file.
399 * If psz_module_name is NULL then we save all the modules config options.
400 * It's no use to save the config options that kept their default values, so
401 * we'll try to be a bit clever here.
403 * When we save we mustn't delete the config options of the modules that
404 * haven't been loaded. So we cannot just create a new config file with the
405 * config structures we've got in memory.
406 * I don't really know how to deal with this nicely, so I will use a completly
408 * I will load the config file in memory, but skipping all the sections of the
409 * modules we want to save. Then I will create a brand new file, dump the file
410 * loaded in memory and then append the sections of the modules we want to
413 *****************************************************************************/
414 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
417 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
421 char p_line[1024], *p_index2;
423 char *p_bigbuffer, *p_index;
427 /* Acquire config file lock */
428 vlc_mutex_lock( &priv->config_lock );
430 if( libvlc_priv (p_this->p_libvlc)->psz_configfile == NULL )
432 char *psz_configdir = config_GetUserConfDir();
433 if( !psz_configdir ) /* XXX: This should never happen */
435 msg_Err( p_this, "no configuration directory defined" );
436 vlc_mutex_unlock( &priv->config_lock );
440 config_CreateDir( p_this, psz_configdir );
441 free( psz_configdir );
444 file = config_OpenConfigFile( p_this, "rt" );
447 /* look for file size */
448 fseek( file, 0L, SEEK_END );
449 i_sizebuf = ftell( file );
450 fseek( file, 0L, SEEK_SET );
453 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
456 if( file ) fclose( file );
457 vlc_mutex_unlock( &priv->config_lock );
462 /* List all available modules */
463 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
465 /* backup file into memory, we only need to backup the sections we won't
468 while( file && fgets( p_line, 1024, file ) )
470 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
473 /* we found a section, check if we need to do a backup */
474 for( i_index = 0; i_index < p_list->i_count; i_index++ )
476 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
478 if( ((p_index2 - &p_line[1])
479 == (int)strlen(p_parser->psz_object_name) )
480 && !memcmp( &p_line[1], p_parser->psz_object_name,
481 strlen(p_parser->psz_object_name) ) )
483 if( !psz_module_name )
485 else if( !strcmp( psz_module_name,
486 p_parser->psz_object_name ) )
491 if( i_index == p_list->i_count )
493 /* we don't have this section in our list so we need to back
497 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
510 /* save line if requested and line is valid (doesn't begin with a
511 * space, tab, or eol) */
512 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
513 && (p_line[0] != '\t') )
515 strcpy( p_index, p_line );
516 p_index += strlen( p_line );
519 if( file ) fclose( file );
523 * Save module config in file
526 file = config_OpenConfigFile (p_this, "wt");
529 vlc_list_release( p_list );
531 vlc_mutex_unlock( &priv->config_lock );
535 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
536 "###\n### lines beginning with a '#' character are comments\n###\n\n" );
538 /* Ensure consistent number formatting... */
539 locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
540 locale_t baseloc = uselocale (loc);
542 /* Look for the selected module, if NULL then save everything */
543 for( i_index = 0; i_index < p_list->i_count; i_index++ )
545 module_config_t *p_item, *p_end;
546 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
548 if( psz_module_name && strcmp( psz_module_name,
549 p_parser->psz_object_name ) )
552 if( !p_parser->i_config_items )
555 if( psz_module_name )
556 msg_Dbg( p_this, "saving config for module \"%s\"",
557 p_parser->psz_object_name );
559 fprintf( file, "[%s]", p_parser->psz_object_name );
560 if( p_parser->psz_longname )
561 fprintf( file, " # %s\n\n", p_parser->psz_longname );
563 fprintf( file, "\n\n" );
565 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
569 /* Do not save the new value in the configuration file
570 * if doing an autosave, and the item is not an "autosaved" one. */
571 bool b_retain = b_autosave && !p_item->b_autosave;
573 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
574 || p_item->b_removed /* ignore deprecated option */
575 || p_item->b_unsaveable) /* ignore volatile option */
578 if (IsConfigIntegerType (p_item->i_type))
580 int val = b_retain ? p_item->saved.i : p_item->value.i;
581 if (p_item->i_type == CONFIG_ITEM_KEY)
583 char *psz_key = ConfigKeyToString (val);
584 config_Write (file, p_item->psz_text, N_("key"),
585 val == p_item->orig.i,
586 p_item->psz_name, "%s",
587 psz_key ? psz_key : "");
591 config_Write (file, p_item->psz_text,
592 (p_item->i_type == CONFIG_ITEM_BOOL)
593 ? N_("boolean") : N_("integer"),
594 val == p_item->orig.i,
595 p_item->psz_name, "%d", val);
596 p_item->saved.i = val;
599 if (IsConfigFloatType (p_item->i_type))
601 float val = b_retain ? p_item->saved.f : p_item->value.f;
602 config_Write (file, p_item->psz_text, N_("float"),
603 val == p_item->orig.f,
604 p_item->psz_name, "%f", val);
605 p_item->saved.f = val;
609 const char *psz_value = b_retain ? p_item->saved.psz
613 assert (IsConfigStringType (p_item->i_type));
615 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
616 psz_value = p_item->orig.psz;
620 ? ((p_item->orig.psz != NULL)
621 ? (strcmp (psz_value, p_item->orig.psz) != 0)
623 : (p_item->orig.psz != NULL);
625 config_Write (file, p_item->psz_text, N_("string"),
626 !modified, p_item->psz_name, "%s",
627 psz_value ? psz_value : "");
632 free ((char *)p_item->saved.psz);
633 if( (psz_value && p_item->orig.psz &&
634 strcmp( psz_value, p_item->orig.psz )) ||
635 !psz_value || !p_item->orig.psz)
636 p_item->saved.psz = strdupnull (psz_value);
638 p_item->saved.psz = NULL;
643 p_item->b_dirty = false;
647 vlc_list_release( p_list );
648 if (loc != (locale_t)0)
655 * Restore old settings from the config in file
657 fputs( p_bigbuffer, file );
661 vlc_mutex_unlock( &priv->config_lock );
666 int config_AutoSaveConfigFile( vlc_object_t *p_this )
668 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
670 int i_index, i_count;
674 /* Check if there's anything to save */
675 vlc_mutex_lock( &priv->config_lock );
676 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
677 i_count = p_list->i_count;
678 for( i_index = 0; i_index < i_count; i_index++ )
680 module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object ;
681 module_config_t *p_item, *p_end;
683 if( !p_parser->i_config_items ) continue;
685 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
689 if( p_item->b_autosave && p_item->b_dirty ) break;
691 if( p_item < p_end ) break;
693 vlc_list_release( p_list );
694 vlc_mutex_unlock( &priv->config_lock );
696 if( i_index == i_count ) return VLC_SUCCESS;
697 return SaveConfigFile( p_this, 0, true );
700 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
702 return SaveConfigFile( p_this, psz_module_name, false );
706 * Get the user's configuration file when given with the --config option
708 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
710 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
711 if( psz_configfile != NULL )
713 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
715 /* This is incomplete: we should also support the ~cmassiot/ syntax */
717 if( asprintf( &psz_buf, "%s/%s", config_GetHomeDir(),
718 psz_configfile + 2 ) == -1 )
720 free( psz_configfile );
723 free( psz_configfile );
724 psz_configfile = psz_buf;
727 return psz_configfile;
730 int ConfigStringToKey( const char *psz_key )
734 const char *psz_parser = strchr( psz_key, '-' );
735 while( psz_parser && psz_parser != psz_key )
737 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
739 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
740 strlen( vlc_modifiers[i].psz_key_string ) ) )
742 i_key |= vlc_modifiers[i].i_key_code;
745 psz_key = psz_parser + 1;
746 psz_parser = strchr( psz_key, '-' );
748 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
750 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
752 i_key |= vlc_keys[i].i_key_code;
759 char *ConfigKeyToString( int i_key )
761 char *psz_key = malloc( 100 );
772 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
775 if( i_key & vlc_modifiers[index].i_key_code )
777 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
780 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
783 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
785 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );