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 */
43 #include "configuration.h"
44 #include "modules/modules.h"
46 static char *ConfigKeyToString( int );
48 static inline char *strdupnull (const char *src)
50 return src ? strdup (src) : NULL;
54 * Get the user's configuration file
56 static char *config_GetConfigFile( vlc_object_t *obj )
58 char *psz_file = config_GetPsz( obj, "config" );
59 if( psz_file == NULL )
61 char *psz_dir = config_GetUserConfDir();
63 if( asprintf( &psz_file, "%s" DIR_SEP CONFIG_FILE, psz_dir ) == -1 )
70 static FILE *config_OpenConfigFile( vlc_object_t *p_obj, const char *mode )
72 char *psz_filename = config_GetConfigFile( p_obj );
73 if( psz_filename == NULL )
76 msg_Dbg( p_obj, "opening config file (%s)", psz_filename );
78 FILE *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.",
128 static int strtoi (const char *str)
134 l = strtol (str, &end, 0);
138 if ((l > INT_MAX) || (l < INT_MIN))
147 /*****************************************************************************
148 * config_LoadConfigFile: loads the configuration file.
149 *****************************************************************************
150 * This function is called to load the config options stored in the config
152 *****************************************************************************/
153 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
155 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
158 file = config_OpenConfigFile (p_this, "rt");
162 /* Acquire config file lock */
163 vlc_mutex_lock( &priv->config_lock );
165 /* Look for the selected module, if NULL then save everything */
166 module_t **list = module_list_get (NULL);
168 /* Look for UTF-8 Byte Order Mark */
169 char * (*convert) (const char *) = strdupnull;
172 if ((fread (bom, 1, 3, file) != 3)
173 || memcmp (bom, "\xEF\xBB\xBF", 3))
175 convert = FromLocaleDup;
176 rewind (file); /* no BOM, rewind */
179 module_t *module = NULL;
180 char line[1024], section[1022];
183 /* Ensure consistent number formatting... */
184 locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
185 locale_t baseloc = uselocale (loc);
187 while (fgets (line, 1024, file) != NULL)
189 /* Ignore comments and empty lines */
200 char *ptr = strchr (line, ']');
202 continue; /* syntax error; */
205 /* New section ( = a given module) */
206 strcpy (section, line + 1);
209 if ((psz_module_name == NULL)
210 || (strcmp (psz_module_name, section) == 0))
212 for (int i = 0; list[i]; i++)
214 module_t *m = list[i];
216 if ((strcmp (section, m->psz_object_name) == 0)
217 && (m->i_config_items > 0)) /* ignore config-less modules */
220 if (psz_module_name != NULL)
222 "loading config for module \"%s\"",
233 continue; /* no need to parse if there is no matching module */
235 char *ptr = strchr (line, '\n');
239 /* look for option name */
240 const char *psz_option_name = line;
242 ptr = strchr (line, '=');
244 continue; /* syntax error */
247 const char *psz_option_value = ptr + 1;
249 /* try to match this option with one of the module's options */
250 for (size_t i = 0; i < module->confsize; i++)
252 module_config_t *p_item = module->p_config + i;
254 if ((p_item->i_type & CONFIG_HINT)
255 || strcmp (p_item->psz_name, psz_option_name))
261 vlc_mutex_lock( p_item->p_lock );
262 switch( p_item->i_type )
264 case CONFIG_ITEM_BOOL:
265 case CONFIG_ITEM_INTEGER:
267 long l = strtoi (psz_option_value);
269 msg_Warn (p_this, "Integer value (%s) for %s: %m",
270 psz_option_value, psz_option_name);
272 p_item->saved.i = p_item->value.i = (int)l;
276 case CONFIG_ITEM_FLOAT:
277 if( !*psz_option_value )
278 break; /* ignore empty option */
279 p_item->value.f = (float)atof (psz_option_value);
280 p_item->saved.f = p_item->value.f;
283 case CONFIG_ITEM_KEY:
284 if( !*psz_option_value )
285 break; /* ignore empty option */
286 p_item->value.i = ConfigStringToKey(psz_option_value);
287 p_item->saved.i = p_item->value.i;
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);
299 vlc_mutex_unlock( p_item->p_lock );
306 msg_Err (p_this, "error reading configuration: %m");
311 module_list_free (list);
312 if (loc != (locale_t)0)
318 vlc_mutex_unlock( &priv->config_lock );
322 /*****************************************************************************
323 * config_CreateDir: Create configuration directory if it doesn't exist.
324 *****************************************************************************/
325 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
327 if( !psz_dirname || !*psz_dirname ) return -1;
329 if( utf8_mkdir( psz_dirname, 0700 ) == 0 )
339 /* Let's try to create the parent directory */
340 char psz_parent[strlen( psz_dirname ) + 1], *psz_end;
341 strcpy( psz_parent, psz_dirname );
343 psz_end = strrchr( psz_parent, DIR_SEP_CHAR );
344 if( psz_end && psz_end != psz_parent )
347 if( config_CreateDir( p_this, psz_parent ) == 0 )
349 if( !utf8_mkdir( psz_dirname, 0700 ) )
356 msg_Err( p_this, "could not create %s: %m", psz_dirname );
361 config_Write (FILE *file, const char *type, const char *desc,
362 bool comment, const char *name, const char *fmt, ...)
370 if (fprintf (file, "# %s (%s)\n%s%s=", desc, vlc_gettext (type),
371 comment ? "#" : "", name) < 0)
375 ret = vfprintf (file, fmt, ap);
380 if (fputs ("\n\n", file) == EOF)
386 static int config_PrepareDir (vlc_object_t *obj)
388 char *psz_configdir = config_GetUserConfDir ();
389 if (psz_configdir == NULL) /* XXX: This should never happen */
392 int ret = config_CreateDir (obj, psz_configdir);
393 free (psz_configdir);
397 /*****************************************************************************
398 * config_SaveConfigFile: Save a module's config options.
399 *****************************************************************************
400 * This will save the specified module's config options to the config file.
401 * If psz_module_name is NULL then we save all the modules config options.
402 * It's no use to save the config options that kept their default values, so
403 * we'll try to be a bit clever here.
405 * When we save we mustn't delete the config options of the modules that
406 * haven't been loaded. So we cannot just create a new config file with the
407 * config structures we've got in memory.
408 * I don't really know how to deal with this nicely, so I will use a completly
410 * I will load the config file in memory, but skipping all the sections of the
411 * modules we want to save. Then I will create a brand new file, dump the file
412 * loaded in memory and then append the sections of the modules we want to
415 *****************************************************************************/
416 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
419 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
422 char *permanent = NULL, *temporary = NULL;
423 char p_line[1024], *p_index2;
424 unsigned long i_sizebuf = 0;
425 char *p_bigbuffer = NULL, *p_index;
429 /* Acquire config file lock */
430 vlc_mutex_lock( &priv->config_lock );
432 if( config_PrepareDir( p_this ) )
434 msg_Err( p_this, "no configuration directory" );
438 file = config_OpenConfigFile( p_this, "rt" );
441 /* look for file size */
442 fseek( file, 0L, SEEK_END );
443 i_sizebuf = ftell( file );
444 fseek( file, 0L, SEEK_SET );
445 if( i_sizebuf >= LONG_MAX )
449 p_bigbuffer = p_index = malloc( i_sizebuf+1 );
454 /* List all available modules */
455 module_t **list = module_list_get (NULL);
457 /* backup file into memory, we only need to backup the sections we won't
460 while( file && fgets( p_line, 1024, file ) )
462 if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
465 /* we found a section, check if we need to do a backup */
466 for( i_index = 0; (p_parser = list[i_index]) != NULL; i_index++ )
468 if( ((p_index2 - &p_line[1])
469 == (int)strlen(p_parser->psz_object_name) )
470 && !memcmp( &p_line[1], p_parser->psz_object_name,
471 strlen(p_parser->psz_object_name) ) )
473 if( !psz_module_name )
475 else if( !strcmp( psz_module_name,
476 p_parser->psz_object_name ) )
481 if( list[i_index] == NULL )
483 /* we don't have this section in our list so we need to back
487 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
500 /* save line if requested and line is valid (doesn't begin with a
501 * space, tab, or eol) */
502 if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
503 && (p_line[0] != '\t') )
505 strcpy( p_index, p_line );
506 p_index += strlen( p_line );
514 * Save module config in file
516 permanent = config_GetConfigFile (p_this);
519 module_list_free (list);
523 if (asprintf (&temporary, "%s.%u", permanent, getpid ()) == -1)
526 module_list_free (list);
530 int fd = utf8_open (temporary, O_CREAT|O_WRONLY|O_TRUNC, S_IRUSR|S_IWUSR);
533 module_list_free (list);
536 file = fdopen (fd, "wt");
540 module_list_free (list);
544 fprintf( file, "\xEF\xBB\xBF###\n### " COPYRIGHT_MESSAGE "\n###\n\n"
545 "###\n### lines beginning with a '#' character are comments\n###\n\n" );
547 /* Ensure consistent number formatting... */
548 locale_t loc = newlocale (LC_NUMERIC_MASK, "C", NULL);
549 locale_t baseloc = uselocale (loc);
551 /* Look for the selected module, if NULL then save everything */
552 for( i_index = 0; (p_parser = list[i_index]) != NULL; i_index++ )
554 module_config_t *p_item, *p_end;
556 if( psz_module_name && strcmp( psz_module_name,
557 p_parser->psz_object_name ) )
560 if( !p_parser->i_config_items )
563 if( psz_module_name )
564 msg_Dbg( p_this, "saving config for module \"%s\"",
565 p_parser->psz_object_name );
567 fprintf( file, "[%s]", p_parser->psz_object_name );
568 if( p_parser->psz_longname )
569 fprintf( file, " # %s\n\n", p_parser->psz_longname );
571 fprintf( file, "\n\n" );
573 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
577 if ((p_item->i_type & CONFIG_HINT) /* ignore hint */
578 || p_item->b_removed /* ignore deprecated option */
579 || p_item->b_unsaveable) /* ignore volatile option */
582 vlc_mutex_lock (p_item->p_lock);
584 /* Do not save the new value in the configuration file
585 * if doing an autosave, and the item is not an "autosaved" one. */
586 bool b_retain = b_autosave && !p_item->b_autosave;
588 if (IsConfigIntegerType (p_item->i_type))
590 int val = b_retain ? p_item->saved.i : p_item->value.i;
591 if (p_item->i_type == CONFIG_ITEM_KEY)
593 char *psz_key = ConfigKeyToString (val);
594 config_Write (file, p_item->psz_text, N_("key"),
595 val == p_item->orig.i,
596 p_item->psz_name, "%s",
597 psz_key ? psz_key : "");
601 config_Write (file, p_item->psz_text,
602 (p_item->i_type == CONFIG_ITEM_BOOL)
603 ? N_("boolean") : N_("integer"),
604 val == p_item->orig.i,
605 p_item->psz_name, "%d", val);
606 p_item->saved.i = val;
609 if (IsConfigFloatType (p_item->i_type))
611 float val = b_retain ? p_item->saved.f : p_item->value.f;
612 config_Write (file, p_item->psz_text, N_("float"),
613 val == p_item->orig.f,
614 p_item->psz_name, "%f", val);
615 p_item->saved.f = val;
619 const char *psz_value = b_retain ? p_item->saved.psz
623 assert (IsConfigStringType (p_item->i_type));
625 if (b_retain && (psz_value == NULL)) /* FIXME: hack */
626 psz_value = p_item->orig.psz;
630 ? ((p_item->orig.psz != NULL)
631 ? (strcmp (psz_value, p_item->orig.psz) != 0)
633 : (p_item->orig.psz != NULL);
635 config_Write (file, p_item->psz_text, N_("string"),
636 !modified, p_item->psz_name, "%s",
637 psz_value ? psz_value : "");
642 free ((char *)p_item->saved.psz);
643 if( (psz_value && p_item->orig.psz &&
644 strcmp( psz_value, p_item->orig.psz )) ||
645 !psz_value || !p_item->orig.psz)
646 p_item->saved.psz = strdupnull (psz_value);
648 p_item->saved.psz = NULL;
653 p_item->b_dirty = false;
654 vlc_mutex_unlock (p_item->p_lock);
658 module_list_free (list);
659 if (loc != (locale_t)0)
666 * Restore old settings from the config in file
668 fputs( p_bigbuffer, file );
672 * Flush to disk and replace atomically
674 fflush (file); /* Flush from run-time */
676 fdatasync (fd); /* Flush from OS */
677 /* Atomically replace the file... */
678 rename (temporary, permanent);
679 /* (...then synchronize the directory, err, TODO...) */
680 /* ...and finally close the file */
682 vlc_mutex_unlock (&priv->config_lock);
685 /* Windows cannot remove open files nor overwrite existing ones */
687 rename (temporary, permanent);
697 vlc_mutex_unlock( &priv->config_lock );
704 int config_AutoSaveConfigFile( vlc_object_t *p_this )
706 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
712 /* Check if there's anything to save */
713 vlc_mutex_lock( &priv->config_lock );
714 module_t **list = module_list_get (NULL);
715 for( i_index = 0; list[i_index] && !save; i_index++ )
717 module_t *p_parser = list[i_index];
718 module_config_t *p_item, *p_end;
720 if( !p_parser->i_config_items ) continue;
722 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
723 p_item < p_end && !save;
726 vlc_mutex_lock (p_item->p_lock);
727 save = p_item->b_autosave && p_item->b_dirty;
728 vlc_mutex_unlock (p_item->p_lock);
731 module_list_free (list);
732 vlc_mutex_unlock( &priv->config_lock );
734 return save ? VLC_SUCCESS : SaveConfigFile( p_this, NULL, true );
737 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
739 return SaveConfigFile( p_this, psz_module_name, false );
742 int ConfigStringToKey( const char *psz_key )
746 const char *psz_parser = strchr( psz_key, '-' );
747 while( psz_parser && psz_parser != psz_key )
749 for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
751 if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
752 strlen( vlc_modifiers[i].psz_key_string ) ) )
754 i_key |= vlc_modifiers[i].i_key_code;
757 psz_key = psz_parser + 1;
758 psz_parser = strchr( psz_key, '-' );
760 for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
762 if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
764 i_key |= vlc_keys[i].i_key_code;
771 char *ConfigKeyToString( int i_key )
773 char *psz_key = malloc( 100 );
784 for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
787 if( i_key & vlc_modifiers[index].i_key_code )
789 p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
792 for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
795 if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
797 p += sprintf( p, "%s", vlc_keys[index].psz_key_string );