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 )
71 psz_filename = config_GetCustomConfigFile( p_obj->p_libvlc );
73 psz_filename = config_GetConfigFile();
75 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
77 p_stream = utf8_fopen( psz_filename, mode );
78 if( p_stream == NULL && errno != ENOENT )
80 msg_Err( p_obj, "cannot open config file (%s): %m",
84 #if !( defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS) )
85 else if( p_stream == NULL && errno == ENOENT && mode[0] == 'r' )
87 /* This is the fallback for pre XDG Base Directory
88 * Specification configs */
90 if( asprintf( &psz_old, "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
91 config_GetHomeDir() ) != -1 )
93 p_stream = utf8_fopen( psz_old, mode );
96 /* Old config file found. We want to write it at the
97 * new location now. */
98 msg_Info( p_obj->p_libvlc, "Found old config file at %s. "
99 "VLC will now use %s.", psz_old, psz_filename );
101 if( asprintf(&psz_readme,"%s"DIR_SEP CONFIG_DIR DIR_SEP"README",
102 config_GetHomeDir() ) != -1 )
104 FILE *p_readme = utf8_fopen( psz_readme, "wt" );
107 fprintf( p_readme, "The VLC media player "
108 "configuration folder has moved to comply\n"
109 "with the XDG Base Directory Specification "
110 "version 0.6. Your\nconfiguration has been "
111 "copied to the new location:\n%s\nYou can "
112 "delete this directory and all its contents.",
127 static int strtoi (const char *str)
133 l = strtol (str, &end, 0);
137 if ((l > INT_MAX) || (l < INT_MIN))
146 /*****************************************************************************
147 * config_LoadConfigFile: loads the configuration file.
148 *****************************************************************************
149 * This function is called to load the config options stored in the config
151 *****************************************************************************/
152 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
154 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
157 file = config_OpenConfigFile (p_this, "rt");
161 /* Acquire config file lock */
162 vlc_mutex_lock( &priv->config_lock );
164 /* Look for the selected module, if NULL then save everything */
165 module_t **list = module_list_get (NULL);
167 /* Look for UTF-8 Byte Order Mark */
168 char * (*convert) (const char *) = strdupnull;
171 if ((fread (bom, 1, 3, file) != 3)
172 || memcmp (bom, "\xEF\xBB\xBF", 3))
174 convert = FromLocaleDup;
175 rewind (file); /* no BOM, rewind */
178 module_t *module = NULL;
179 char line[1024], section[1022];
182 /* Ensure consistent number formatting... */
183 locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
184 locale_t baseloc = uselocale (loc);
186 while (fgets (line, 1024, file) != NULL)
188 /* Ignore comments and empty lines */
199 char *ptr = strchr (line, ']');
201 continue; /* syntax error; */
204 /* New section ( = a given module) */
205 strcpy (section, line + 1);
208 if ((psz_module_name == NULL)
209 || (strcmp (psz_module_name, section) == 0))
211 for (int i = 0; list[i]; i++)
213 module_t *m = list[i];
215 if ((strcmp (section, m->psz_object_name) == 0)
216 && (m->i_config_items > 0)) /* ignore config-less modules */
219 if (psz_module_name != NULL)
221 "loading config for module \"%s\"",
232 continue; /* no need to parse if there is no matching module */
234 char *ptr = strchr (line, '\n');
238 /* look for option name */
239 const char *psz_option_name = line;
241 ptr = strchr (line, '=');
243 continue; /* syntax error */
246 const char *psz_option_value = ptr + 1;
248 /* try to match this option with one of the module's options */
249 for (size_t i = 0; i < module->confsize; i++)
251 module_config_t *p_item = module->p_config + i;
253 if ((p_item->i_type & CONFIG_HINT)
254 || strcmp (p_item->psz_name, psz_option_name))
260 switch( p_item->i_type )
262 case CONFIG_ITEM_BOOL:
263 case CONFIG_ITEM_INTEGER:
265 long l = strtoi (psz_option_value);
267 msg_Warn (p_this, "Integer value (%s) for %s: %m",
268 psz_option_value, psz_option_name);
270 p_item->saved.i = p_item->value.i = (int)l;
274 case CONFIG_ITEM_FLOAT:
275 if( !*psz_option_value )
276 break; /* ignore empty option */
277 p_item->value.f = (float)atof (psz_option_value);
278 p_item->saved.f = p_item->value.f;
281 case CONFIG_ITEM_KEY:
282 if( !*psz_option_value )
283 break; /* ignore empty option */
284 p_item->value.i = ConfigStringToKey(psz_option_value);
285 p_item->saved.i = p_item->value.i;
289 vlc_mutex_lock( p_item->p_lock );
291 /* free old string */
292 free( (char*) p_item->value.psz );
293 free( (char*) p_item->saved.psz );
295 p_item->value.psz = convert (psz_option_value);
296 p_item->saved.psz = strdupnull (p_item->value.psz);
298 vlc_mutex_unlock( p_item->p_lock );
308 msg_Err (p_this, "error reading configuration: %m");
313 module_list_free (list);
314 if (loc != (locale_t)0)
320 vlc_mutex_unlock( &priv->config_lock );
324 /*****************************************************************************
325 * config_CreateDir: Create configuration directory if it doesn't exist.
326 *****************************************************************************/
327 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
329 if( !psz_dirname || !*psz_dirname ) return -1;
331 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
341 /* Let's try to create the parent directory */
342 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
343 strcpy( psz_parent, psz_dirname );
345 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
346 if( psz_end && psz_end != psz_parent )
349 if( config_CreateDir( p_this, psz_parent ) == 0 )
351 if( !utf8_mkdir( psz_dirname, 0700 ) )
358 msg_Err( p_this, "could not create %s: %m", psz_dirname );
363 config_Write (FILE *file, const char *type, const char *desc,
364 bool comment, const char *name, const char *fmt, ...)
372 if (fprintf (file, "# %s (%s)\n%s%s=", desc, vlc_gettext (type),
373 comment ? "#" : "", name) < 0)
377 ret = vfprintf (file, fmt, ap);
382 if (fputs ("\n\n", file) == EOF)
388 static int config_PrepareDir (vlc_object_t *obj)
390 char *psz_configdir = config_GetUserConfDir ();
391 if (psz_configdir == NULL) /* XXX: This should never happen */
394 int ret = config_CreateDir (obj, psz_configdir);
395 free (psz_configdir);
399 /*****************************************************************************
400 * config_SaveConfigFile: Save a module's config options.
401 *****************************************************************************
402 * This will save the specified module's config options to the config file.
403 * If psz_module_name is NULL then we save all the modules config options.
404 * It's no use to save the config options that kept their default values, so
405 * we'll try to be a bit clever here.
407 * When we save we mustn't delete the config options of the modules that
408 * haven't been loaded. So we cannot just create a new config file with the
409 * config structures we've got in memory.
410 * I don't really know how to deal with this nicely, so I will use a completly
412 * I will load the config file in memory, but skipping all the sections of the
413 * modules we want to save. Then I will create a brand new file, dump the file
414 * loaded in memory and then append the sections of the modules we want to
417 *****************************************************************************/
418 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
421 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
424 char p_line[1024], *p_index2;
426 char *p_bigbuffer, *p_index;
430 /* Acquire config file lock */
431 vlc_mutex_lock( &priv->config_lock );
433 if( config_PrepareDir( p_this ) )
435 msg_Err( p_this, "no configuration directory" );
436 vlc_mutex_unlock( &priv->config_lock );
440 file = config_OpenConfigFile( p_this, "rt" );
443 /* look for file size */
444 fseek( file, 0L, SEEK_END );
445 i_sizebuf = ftell( file );
446 fseek( file, 0L, SEEK_SET );
449 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
452 if( file ) fclose( file );
453 vlc_mutex_unlock( &priv->config_lock );
458 /* List all available modules */
459 module_t **list = module_list_get (NULL);
461 /* backup file into memory, we only need to backup the sections we won't
464 while( file && fgets( p_line, 1024, file ) )
466 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
469 /* we found a section, check if we need to do a backup */
470 for( i_index = 0; (p_parser = list[i_index]) != NULL; i_index++ )
472 if( ((p_index2 - &p_line[1])
473 == (int)strlen(p_parser->psz_object_name) )
474 && !memcmp( &p_line[1], p_parser->psz_object_name,
475 strlen(p_parser->psz_object_name) ) )
477 if( !psz_module_name )
479 else if( !strcmp( psz_module_name,
480 p_parser->psz_object_name ) )
485 if( list[i_index] == NULL )
487 /* we don't have this section in our list so we need to back
491 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
504 /* save line if requested and line is valid (doesn't begin with a
505 * space, tab, or eol) */
506 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
507 && (p_line[0] != '\t') )
509 strcpy( p_index, p_line );
510 p_index += strlen( p_line );
513 if( file ) fclose( file );
517 * Save module config in file
520 file = config_OpenConfigFile (p_this, "wt");
523 module_list_free (list);
525 vlc_mutex_unlock( &priv->config_lock );
529 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
530 "###\n### lines beginning with a '#' character are comments\n###\n\n" );
532 /* Ensure consistent number formatting... */
533 locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
534 locale_t baseloc = uselocale (loc);
536 /* Look for the selected module, if NULL then save everything */
537 for( i_index = 0; (p_parser = list[i_index]) != NULL; i_index++ )
539 module_config_t *p_item, *p_end;
541 if( psz_module_name && strcmp( psz_module_name,
542 p_parser->psz_object_name ) )
545 if( !p_parser->i_config_items )
548 if( psz_module_name )
549 msg_Dbg( p_this, "saving config for module \"%s\"",
550 p_parser->psz_object_name );
552 fprintf( file, "[%s]", p_parser->psz_object_name );
553 if( p_parser->psz_longname )
554 fprintf( file, " # %s\n\n", p_parser->psz_longname );
556 fprintf( file, "\n\n" );
558 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
562 /* Do not save the new value in the configuration file
563 * if doing an autosave, and the item is not an "autosaved" one. */
564 bool b_retain = b_autosave && !p_item->b_autosave;
566 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
567 || p_item->b_removed /* ignore deprecated option */
568 || p_item->b_unsaveable) /* ignore volatile option */
571 if (IsConfigIntegerType (p_item->i_type))
573 int val = b_retain ? p_item->saved.i : p_item->value.i;
574 if (p_item->i_type == CONFIG_ITEM_KEY)
576 char *psz_key = ConfigKeyToString (val);
577 config_Write (file, p_item->psz_text, N_("key"),
578 val == p_item->orig.i,
579 p_item->psz_name, "%s",
580 psz_key ? psz_key : "");
584 config_Write (file, p_item->psz_text,
585 (p_item->i_type == CONFIG_ITEM_BOOL)
586 ? N_("boolean") : N_("integer"),
587 val == p_item->orig.i,
588 p_item->psz_name, "%d", val);
589 p_item->saved.i = val;
592 if (IsConfigFloatType (p_item->i_type))
594 float val = b_retain ? p_item->saved.f : p_item->value.f;
595 config_Write (file, p_item->psz_text, N_("float"),
596 val == p_item->orig.f,
597 p_item->psz_name, "%f", val);
598 p_item->saved.f = val;
602 const char *psz_value = b_retain ? p_item->saved.psz
606 assert (IsConfigStringType (p_item->i_type));
608 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
609 psz_value = p_item->orig.psz;
613 ? ((p_item->orig.psz != NULL)
614 ? (strcmp (psz_value, p_item->orig.psz) != 0)
616 : (p_item->orig.psz != NULL);
618 config_Write (file, p_item->psz_text, N_("string"),
619 !modified, p_item->psz_name, "%s",
620 psz_value ? psz_value : "");
625 free ((char *)p_item->saved.psz);
626 if( (psz_value && p_item->orig.psz &&
627 strcmp( psz_value, p_item->orig.psz )) ||
628 !psz_value || !p_item->orig.psz)
629 p_item->saved.psz = strdupnull (psz_value);
631 p_item->saved.psz = NULL;
636 p_item->b_dirty = false;
640 module_list_free (list);
641 if (loc != (locale_t)0)
648 * Restore old settings from the config in file
650 fputs( p_bigbuffer, file );
654 vlc_mutex_unlock( &priv->config_lock );
659 int config_AutoSaveConfigFile( vlc_object_t *p_this )
661 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
667 /* Check if there's anything to save */
668 vlc_mutex_lock( &priv->config_lock );
669 module_t **list = module_list_get (NULL);
670 for( i_index = 0; list[i_index]; i_index++ )
672 module_t *p_parser = list[i_index];
673 module_config_t *p_item, *p_end;
675 if( !p_parser->i_config_items ) continue;
677 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
681 if( p_item->b_autosave && p_item->b_dirty ) break;
683 if( p_item < p_end ) break;
685 done = list[i_index] == NULL;
686 module_list_free (list);
687 vlc_mutex_unlock( &priv->config_lock );
689 return done ? VLC_SUCCESS : SaveConfigFile( p_this, NULL, true );
692 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
694 return SaveConfigFile( p_this, psz_module_name, false );
698 * Get the user's configuration file when given with the --config option
700 char *config_GetCustomConfigFile( libvlc_int_t *p_libvlc )
702 char *psz_configfile = config_GetPsz( p_libvlc, "config" );
703 if( psz_configfile != NULL )
705 if( psz_configfile[0] == '~' && psz_configfile[1] == '/' )
707 /* This is incomplete: we should also support the ~cmassiot/ syntax */
709 if( asprintf( &psz_buf, "%s/%s", config_GetHomeDir(),
710 psz_configfile + 2 ) == -1 )
712 free( psz_configfile );
715 free( psz_configfile );
716 psz_configfile = psz_buf;
719 return psz_configfile;
722 int ConfigStringToKey( const char *psz_key )
726 const char *psz_parser = strchr( psz_key, '-' );
727 while( psz_parser && psz_parser != psz_key )
729 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
731 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
732 strlen( vlc_modifiers[i].psz_key_string ) ) )
734 i_key |= vlc_modifiers[i].i_key_code;
737 psz_key = psz_parser + 1;
738 psz_parser = strchr( psz_key, '-' );
740 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
742 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
744 i_key |= vlc_keys[i].i_key_code;
751 char *ConfigKeyToString( int i_key )
753 char *psz_key = malloc( 100 );
764 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
767 if( i_key & vlc_modifiers[index].i_key_code )
769 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
772 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
775 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
777 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );