git.sesse.net Git - vlc/blob - src/config/core.c

   1 /*****************************************************************************
   2  * core.c management of the modules configuration
   3  *****************************************************************************
   4  * Copyright (C) 2001-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 #include <vlc/vlc.h>
  25 #include "../libvlc.h"
  26 #include "vlc_keys.h"
  27 #include "vlc_charset.h"
  28
  29 #include <errno.h>                                                  /* errno */
  30
  31 #ifdef HAVE_LIMITS_H
  32 #   include <limits.h>
  33 #endif
  34
  35 #ifdef HAVE_UNISTD_H
  36 #    include <unistd.h>                                          /* getuid() */
  37 #endif
  38
  39 #ifdef HAVE_GETOPT_LONG
  40 #   ifdef HAVE_GETOPT_H
  41 #       include <getopt.h>                                       /* getopt() */
  42 #   endif
  43 #else
  44 #   include "../extras/getopt.h"
  45 #endif
  46
  47 #if defined(HAVE_GETPWUID)
  48 #   include <pwd.h>                                            /* getpwuid() */
  49 #endif
  50
  51 #if defined( HAVE_SYS_STAT_H )
  52 #   include <sys/stat.h>
  53 #endif
  54 #if defined( HAVE_SYS_TYPES_H )
  55 #   include <sys/types.h>
  56 #endif
  57 #if defined( WIN32 )
  58 #   if !defined( UNDER_CE )
  59 #       include <direct.h>
  60 #   endif
  61 #include <tchar.h>
  62 #endif
  63
  64 #include "config.h"
  65 #include "modules/modules.h"
  66
  67 static inline char *strdupnull (const char *src)
  68 {
  69     return src ? strdup (src) : NULL;
  70 }
  71
  72 static inline char *_strdupnull (const char *src)
  73 {
  74     return src ? strdup (_(src)) : NULL;
  75 }
  76
  77 /* Item types that use a string value (i.e. serialized in the module cache) */
  78 int IsConfigStringType (int type)
  79 {
  80     static const unsigned char config_types[] =
  81     {
  82         CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE,
  83         CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
  84         CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT
  85     };
  86
  87     /* NOTE: this needs to be changed if we ever get more than 255 types */
  88     return memchr (config_types, type, sizeof (config_types)) != NULL;
  89 }
  90
  91
  92 int IsConfigIntegerType (int type)
  93 {
  94     static const unsigned char config_types[] =
  95     {
  96         CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
  97         CONFIG_CATEGORY, CONFIG_SUBCATEGORY
  98     };
  99
 100     return memchr (config_types, type, sizeof (config_types)) != NULL;
 101 }
 102
 103
 104 /*****************************************************************************
 105  * config_GetType: get the type of a variable (bool, int, float, string)
 106  *****************************************************************************
 107  * This function is used to get the type of a variable from its name.
 108  * Beware, this is quite slow.
 109  *****************************************************************************/
 110 int __config_GetType( vlc_object_t *p_this, const char *psz_name )
 111 {
 112     module_config_t *p_config;
 113     int i_type;
 114
 115     p_config = config_FindConfig( p_this, psz_name );
 116
 117     /* sanity checks */
 118     if( !p_config )
 119     {
 120         return 0;
 121     }
 122
 123     switch( p_config->i_type )
 124     {
 125     case CONFIG_ITEM_BOOL:
 126         i_type = VLC_VAR_BOOL;
 127         break;
 128
 129     case CONFIG_ITEM_INTEGER:
 130     case CONFIG_ITEM_KEY:
 131         i_type = VLC_VAR_INTEGER;
 132         break;
 133
 134     case CONFIG_ITEM_FLOAT:
 135         i_type = VLC_VAR_FLOAT;
 136         break;
 137
 138     case CONFIG_ITEM_MODULE:
 139     case CONFIG_ITEM_MODULE_CAT:
 140     case CONFIG_ITEM_MODULE_LIST:
 141     case CONFIG_ITEM_MODULE_LIST_CAT:
 142         i_type = VLC_VAR_MODULE;
 143         break;
 144
 145     case CONFIG_ITEM_STRING:
 146         i_type = VLC_VAR_STRING;
 147         break;
 148
 149     case CONFIG_ITEM_PASSWORD:
 150         i_type = VLC_VAR_STRING;
 151         break;
 152
 153     case CONFIG_ITEM_FILE:
 154         i_type = VLC_VAR_FILE;
 155         break;
 156
 157     case CONFIG_ITEM_DIRECTORY:
 158         i_type = VLC_VAR_DIRECTORY;
 159         break;
 160
 161     default:
 162         i_type = 0;
 163         break;
 164     }
 165
 166     return i_type;
 167 }
 168
 169 /*****************************************************************************
 170  * config_GetInt: get the value of an int variable
 171  *****************************************************************************
 172  * This function is used to get the value of variables which are internally
 173  * represented by an integer (CONFIG_ITEM_INTEGER and
 174  * CONFIG_ITEM_BOOL).
 175  *****************************************************************************/
 176 int __config_GetInt( vlc_object_t *p_this, const char *psz_name )
 177 {
 178     module_config_t *p_config;
 179
 180     p_config = config_FindConfig( p_this, psz_name );
 181
 182     /* sanity checks */
 183     if( !p_config )
 184     {
 185         msg_Err( p_this, "option %s does not exist", psz_name );
 186         return -1;
 187     }
 188
 189     if (!IsConfigIntegerType (p_config->i_type))
 190     {
 191         msg_Err( p_this, "option %s does not refer to an int", psz_name );
 192         return -1;
 193     }
 194
 195     return p_config->value.i;
 196 }
 197
 198 /*****************************************************************************
 199  * config_GetFloat: get the value of a float variable
 200  *****************************************************************************
 201  * This function is used to get the value of variables which are internally
 202  * represented by a float (CONFIG_ITEM_FLOAT).
 203  *****************************************************************************/
 204 float __config_GetFloat( vlc_object_t *p_this, const char *psz_name )
 205 {
 206     module_config_t *p_config;
 207
 208     p_config = config_FindConfig( p_this, psz_name );
 209
 210     /* sanity checks */
 211     if( !p_config )
 212     {
 213         msg_Err( p_this, "option %s does not exist", psz_name );
 214         return -1;
 215     }
 216
 217     if (!IsConfigFloatType (p_config->i_type))
 218     {
 219         msg_Err( p_this, "option %s does not refer to a float", psz_name );
 220         return -1;
 221     }
 222
 223     return p_config->value.f;
 224 }
 225
 226 /*****************************************************************************
 227  * config_GetPsz: get the string value of a string variable
 228  *****************************************************************************
 229  * This function is used to get the value of variables which are internally
 230  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
 231  * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
 232  *
 233  * Important note: remember to free() the returned char* because it's a
 234  *   duplicate of the actual value. It isn't safe to return a pointer to the
 235  *   actual value as it can be modified at any time.
 236  *****************************************************************************/
 237 char * __config_GetPsz( vlc_object_t *p_this, const char *psz_name )
 238 {
 239     module_config_t *p_config;
 240
 241     p_config = config_FindConfig( p_this, psz_name );
 242
 243     /* sanity checks */
 244     if( !p_config )
 245     {
 246         msg_Err( p_this, "option %s does not exist", psz_name );
 247         return NULL;
 248     }
 249
 250     if (!IsConfigStringType (p_config->i_type))
 251     {
 252         msg_Err( p_this, "option %s does not refer to a string", psz_name );
 253         return NULL;
 254     }
 255
 256     /* return a copy of the string */
 257     vlc_mutex_lock( p_config->p_lock );
 258     char *psz_value = strdupnull (p_config->value.psz);
 259     vlc_mutex_unlock( p_config->p_lock );
 260
 261     return psz_value;
 262 }
 263
 264 /*****************************************************************************
 265  * config_PutPsz: set the string value of a string variable
 266  *****************************************************************************
 267  * This function is used to set the value of variables which are internally
 268  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
 269  * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
 270  *****************************************************************************/
 271 void __config_PutPsz( vlc_object_t *p_this,
 272                       const char *psz_name, const char *psz_value )
 273 {
 274     module_config_t *p_config;
 275     vlc_value_t oldval, val;
 276
 277     p_config = config_FindConfig( p_this, psz_name );
 278
 279
 280     /* sanity checks */
 281     if( !p_config )
 282     {
 283         msg_Warn( p_this, "option %s does not exist", psz_name );
 284         return;
 285     }
 286
 287     if (!IsConfigStringType (p_config->i_type))
 288     {
 289         msg_Err( p_this, "option %s does not refer to a string", psz_name );
 290         return;
 291     }
 292
 293     vlc_mutex_lock( p_config->p_lock );
 294
 295     /* backup old value */
 296     oldval.psz_string = (char *)p_config->value.psz;
 297
 298     if ((psz_value != NULL) && *psz_value)
 299         p_config->value.psz = strdup (psz_value);
 300     else
 301         p_config->value.psz = NULL;
 302
 303     p_config->b_dirty = VLC_TRUE;
 304
 305     val.psz_string = (char *)p_config->value.psz;
 306
 307     vlc_mutex_unlock( p_config->p_lock );
 308
 309     if( p_config->pf_callback )
 310     {
 311         p_config->pf_callback( p_this, psz_name, oldval, val,
 312                                p_config->p_callback_data );
 313     }
 314
 315     /* free old string */
 316     if( oldval.psz_string ) free( oldval.psz_string );
 317 }
 318
 319 /*****************************************************************************
 320  * config_PutInt: set the integer value of an int variable
 321  *****************************************************************************
 322  * This function is used to set the value of variables which are internally
 323  * represented by an integer (CONFIG_ITEM_INTEGER and
 324  * CONFIG_ITEM_BOOL).
 325  *****************************************************************************/
 326 void __config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
 327 {
 328     module_config_t *p_config;
 329     vlc_value_t oldval, val;
 330
 331     p_config = config_FindConfig( p_this, psz_name );
 332
 333     /* sanity checks */
 334     if( !p_config )
 335     {
 336         msg_Warn( p_this, "option %s does not exist", psz_name );
 337         return;
 338     }
 339
 340     if (!IsConfigIntegerType (p_config->i_type))
 341     {
 342         msg_Err( p_this, "option %s does not refer to an int", psz_name );
 343         return;
 344     }
 345
 346     /* backup old value */
 347     oldval.i_int = p_config->value.i;
 348
 349     /* if i_min == i_max == 0, then do not use them */
 350     if ((p_config->min.i == 0) && (p_config->max.i == 0))
 351     {
 352         p_config->value.i = i_value;
 353     }
 354     else if (i_value < p_config->min.i)
 355     {
 356         p_config->value.i = p_config->min.i;
 357     }
 358     else if (i_value > p_config->max.i)
 359     {
 360         p_config->value.i = p_config->max.i;
 361     }
 362     else
 363     {
 364         p_config->value.i = i_value;
 365     }
 366
 367     p_config->b_dirty = VLC_TRUE;
 368
 369     val.i_int = p_config->value.i;
 370
 371     if( p_config->pf_callback )
 372     {
 373         p_config->pf_callback( p_this, psz_name, oldval, val,
 374                                p_config->p_callback_data );
 375     }
 376 }
 377
 378 /*****************************************************************************
 379  * config_PutFloat: set the value of a float variable
 380  *****************************************************************************
 381  * This function is used to set the value of variables which are internally
 382  * represented by a float (CONFIG_ITEM_FLOAT).
 383  *****************************************************************************/
 384 void __config_PutFloat( vlc_object_t *p_this,
 385                         const char *psz_name, float f_value )
 386 {
 387     module_config_t *p_config;
 388     vlc_value_t oldval, val;
 389
 390     p_config = config_FindConfig( p_this, psz_name );
 391
 392     /* sanity checks */
 393     if( !p_config )
 394     {
 395         msg_Warn( p_this, "option %s does not exist", psz_name );
 396         return;
 397     }
 398
 399     if (!IsConfigFloatType (p_config->i_type))
 400     {
 401         msg_Err( p_this, "option %s does not refer to a float", psz_name );
 402         return;
 403     }
 404
 405     /* backup old value */
 406     oldval.f_float = p_config->value.f;
 407
 408     /* if f_min == f_max == 0, then do not use them */
 409     if ((p_config->min.f == 0) && (p_config->max.f == 0))
 410     {
 411         p_config->value.f = f_value;
 412     }
 413     else if (f_value < p_config->min.f)
 414     {
 415         p_config->value.f = p_config->min.f;
 416     }
 417     else if (f_value > p_config->max.f)
 418     {
 419         p_config->value.f = p_config->max.f;
 420     }
 421     else
 422     {
 423         p_config->value.f = f_value;
 424     }
 425
 426     p_config->b_dirty = VLC_TRUE;
 427
 428     val.f_float = p_config->value.f;
 429
 430     if( p_config->pf_callback )
 431     {
 432         p_config->pf_callback( p_this, psz_name, oldval, val,
 433                                p_config->p_callback_data );
 434     }
 435 }
 436
 437 /*****************************************************************************
 438  * config_FindConfig: find the config structure associated with an option.
 439  *****************************************************************************
 440  * FIXME: This function really needs to be optimized.
 441  * FIXME: And now even more.
 442  *****************************************************************************/
 443 module_config_t *config_FindConfig( vlc_object_t *p_this, const char *psz_name )
 444 {
 445     vlc_list_t *p_list;
 446     int i_index;
 447
 448     if( !psz_name ) return NULL;
 449
 450     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 451
 452     for( i_index = 0; i_index < p_list->i_count; i_index++ )
 453     {
 454         module_config_t *p_item, *p_end;
 455         module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object;
 456
 457         if( !p_parser->i_config_items )
 458             continue;
 459
 460         for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
 461              p_item < p_end;
 462              p_item++ )
 463         {
 464             if( p_item->i_type & CONFIG_HINT )
 465                 /* ignore hints */
 466                 continue;
 467             if( !strcmp( psz_name, p_item->psz_name )
 468              || ( p_item->psz_oldname
 469               && !strcmp( psz_name, p_item->psz_oldname ) ) )
 470             {
 471                 vlc_list_release( p_list );
 472                 return p_item;
 473             }
 474         }
 475     }
 476
 477     vlc_list_release( p_list );
 478
 479     return NULL;
 480 }
 481
 482 /*****************************************************************************
 483  * config_Free: frees a duplicated module's configuration data.
 484  *****************************************************************************
 485  * This function frees all the data duplicated by config_Duplicate.
 486  *****************************************************************************/
 487 void config_Free( module_t *p_module )
 488 {
 489     int i;
 490
 491     for (size_t j = 0; j < p_module->confsize; j++)
 492     {
 493         module_config_t *p_item = p_module->p_config + j;
 494
 495         free( p_item->psz_type );
 496         free( p_item->psz_name );
 497         free( p_item->psz_text );
 498         free( p_item->psz_longtext );
 499         free( p_item->psz_oldname );
 500
 501         if (IsConfigStringType (p_item->i_type))
 502         {
 503             free (p_item->value.psz);
 504             free (p_item->orig.psz);
 505             free (p_item->saved.psz);
 506         }
 507
 508         if( p_item->ppsz_list )
 509             for( i = 0; i < p_item->i_list; i++ )
 510                 free( p_item->ppsz_list[i] );
 511         if( p_item->ppsz_list_text )
 512             for( i = 0; i < p_item->i_list; i++ )
 513                 free( p_item->ppsz_list_text[i] );
 514         free( p_item->ppsz_list );
 515         free( p_item->ppsz_list_text );
 516         free( p_item->pi_list );
 517
 518         if( p_item->i_action )
 519         {
 520             for( i = 0; i < p_item->i_action; i++ )
 521             {
 522                 free( p_item->ppsz_action_text[i] );
 523             }
 524             free( p_item->ppf_action );
 525             free( p_item->ppsz_action_text );
 526         }
 527     }
 528
 529     free (p_module->p_config);
 530     p_module->p_config = NULL;
 531 }
 532
 533 /*****************************************************************************
 534  * config_SetCallbacks: sets callback functions in the duplicate p_config.
 535  *****************************************************************************
 536  * Unfortunatly we cannot work directly with the module's config data as
 537  * this module might be unloaded from memory at any time (remember HideModule).
 538  * This is why we need to duplicate callbacks each time we reload the module.
 539  *****************************************************************************/
 540 void config_SetCallbacks( module_config_t *p_new, module_config_t *p_orig,
 541                           size_t n )
 542 {
 543     for (size_t i = 0; i < n; i++)
 544     {
 545         p_new->pf_callback = p_orig->pf_callback;
 546         p_new++;
 547         p_orig++;
 548     }
 549 }
 550
 551 /*****************************************************************************
 552  * config_UnsetCallbacks: unsets callback functions in the duplicate p_config.
 553  *****************************************************************************
 554  * We simply undo what we did in config_SetCallbacks.
 555  *****************************************************************************/
 556 void config_UnsetCallbacks( module_config_t *p_new, size_t n )
 557 {
 558     for (size_t i = 0; i < n; i++)
 559     {
 560         p_new->pf_callback = NULL;
 561         p_new++;
 562     }
 563 }
 564
 565 /*****************************************************************************
 566  * config_ResetAll: reset the configuration data for all the modules.
 567  *****************************************************************************/
 568 void __config_ResetAll( vlc_object_t *p_this )
 569 {
 570     int i_index;
 571     vlc_list_t *p_list;
 572     module_t *p_module;
 573
 574     /* Acquire config file lock */
 575     vlc_mutex_lock( &p_this->p_libvlc->config_lock );
 576
 577     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 578
 579     for( i_index = 0; i_index < p_list->i_count; i_index++ )
 580     {
 581         p_module = (module_t *)p_list->p_values[i_index].p_object ;
 582         if( p_module->b_submodule ) continue;
 583
 584         for (size_t i = 0; i < p_module->confsize; i++ )
 585         {
 586             if (IsConfigIntegerType (p_module->p_config[i].i_type))
 587                 p_module->p_config[i].value.i = p_module->p_config[i].orig.i;
 588             else
 589             if (IsConfigFloatType (p_module->p_config[i].i_type))
 590                 p_module->p_config[i].value.f = p_module->p_config[i].orig.f;
 591             else
 592             if (IsConfigStringType (p_module->p_config[i].i_type))
 593             {
 594                 free ((char *)p_module->p_config[i].value.psz);
 595                 p_module->p_config[i].value.psz =
 596                         strdupnull (p_module->p_config[i].orig.psz);
 597             }
 598         }
 599     }
 600
 601     vlc_list_release( p_list );
 602     vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
 603 }
 604
 605 /**
 606  * config_GetDataDir: find directory where shared data is installed
 607  *
 608  * @return a string (always succeeds).
 609  */
 610 const char *config_GetDataDir( void )
 611 {
 612 #if defined (WIN32) || defined (UNDER_CE)
 613     return vlc_global()->psz_vlcpath;
 614 #elif defined(__APPLE__) || defined (SYS_BEOS)
 615     static char path[PATH_MAX] = "";
 616
 617     if( *path == '\0' )
 618     {
 619         snprintf( path, sizeof( path ), "%s/share",
 620                   vlc_global()->psz_vlcpath );
 621         path[sizeof( path ) - 1] = '\0';
 622     }
 623     return path;
 624 #else
 625     return DATA_PATH;
 626 #endif
 627 }
 628
 629 /*****************************************************************************
 630  * config_GetHomeDir, config_GetUserDir: find the user's home directory.
 631  *****************************************************************************
 632  * This function will try by different ways to find the user's home path.
 633  * Note that this function is not reentrant, it should be called only once
 634  * at the beginning of main where the result will be stored for later use.
 635  *****************************************************************************/
 636 static char *GetDir( vlc_bool_t b_appdata )
 637 {
 638     const char *psz_localhome = NULL;
 639
 640 #if defined(WIN32) && !defined(UNDER_CE)
 641     typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
 642                                                LPWSTR );
 643 #ifndef CSIDL_FLAG_CREATE
 644 #   define CSIDL_FLAG_CREATE 0x8000
 645 #endif
 646 #ifndef CSIDL_APPDATA
 647 #   define CSIDL_APPDATA 0x1A
 648 #endif
 649 #ifndef CSIDL_PROFILE
 650 #   define CSIDL_PROFILE 0x28
 651 #endif
 652 #ifndef SHGFP_TYPE_CURRENT
 653 #   define SHGFP_TYPE_CURRENT 0
 654 #endif
 655
 656     HINSTANCE shfolder_dll;
 657     SHGETFOLDERPATH SHGetFolderPath ;
 658
 659     /* load the shfolder dll to retrieve SHGetFolderPath */
 660     if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
 661     {
 662         SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
 663                                                   _T("SHGetFolderPathW") );
 664         if ( SHGetFolderPath != NULL )
 665         {
 666             wchar_t whomedir[MAX_PATH];
 667
 668             /* get the "Application Data" folder for the current user */
 669             if( S_OK == SHGetFolderPath( NULL,
 670                                          (b_appdata ? CSIDL_APPDATA :
 671                                            CSIDL_PROFILE) | CSIDL_FLAG_CREATE,
 672                                          NULL, SHGFP_TYPE_CURRENT,
 673                                          whomedir ) )
 674             {
 675                 FreeLibrary( shfolder_dll );
 676                 return FromWide( whomedir );
 677             }
 678         }
 679         FreeLibrary( shfolder_dll );
 680     }
 681
 682 #elif defined(UNDER_CE)
 683
 684 #ifndef CSIDL_APPDATA
 685 #   define CSIDL_APPDATA 0x1A
 686 #endif
 687
 688     wchar_t whomedir[MAX_PATH];
 689
 690     /* get the "Application Data" folder for the current user */
 691     if( SHGetSpecialFolderPath( NULL, whomedir, CSIDL_APPDATA, 1 ) )
 692         return FromWide( whomedir );
 693 #endif
 694
 695     psz_localhome = getenv( "HOME" );
 696     if( psz_localhome == NULL )
 697     {
 698 #if defined(HAVE_GETPWUID)
 699         struct passwd *p_pw;
 700         (void)b_appdata;
 701
 702         if( ( p_pw = getpwuid( getuid() ) ) != NULL )
 703             psz_localhome = p_pw->pw_dir;
 704         else
 705 #endif
 706         {
 707             psz_localhome = getenv( "TMP" );
 708             if( psz_localhome == NULL )
 709                 psz_localhome = "/tmp";
 710         }
 711     }
 712
 713     return FromLocaleDup( psz_localhome );
 714 }
 715
 716 /**
 717  * Get the user's home directory
 718  */
 719 char *config_GetHomeDir( void )
 720 {
 721     return GetDir( VLC_FALSE );
 722 }
 723
 724 /**
 725  * Get the user's main data and config directory:
 726  *   - on windows that's the App Data directory;
 727  *   - on other OSes it's the same as the home directory.
 728  */
 729 char *config_GetUserDir( void );
 730 char *config_GetUserDir( void )
 731 {
 732     return GetDir( VLC_TRUE );
 733 }
 734
 735 /**
 736  * Get the user's VLC configuration directory
 737  */
 738 char *config_GetConfigDir( libvlc_int_t *p_libvlc )
 739 {
 740     char *psz_dir;
 741 #if defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS)
 742     char *psz_parent = config_GetUserDir();
 743     if( !psz_parent ) psz_parent = p_libvlc->psz_homedir;
 744     if( asprintf( &psz_dir, "%s" DIR_SEP CONFIG_DIR, psz_parent ) == -1 )
 745         return NULL;
 746     return psz_dir;
 747 #else
 748     /* XDG Base Directory Specification - Version 0.6 */
 749     char *psz_env = getenv( "XDG_CONFIG_HOME" );
 750     if( psz_env )
 751     {
 752         if( asprintf( &psz_dir, "%s/vlc", psz_env ) == -1 )
 753             return NULL;
 754         return psz_dir;
 755     }
 756     psz_env = getenv( "HOME" );
 757     if( !psz_env ) psz_env = p_libvlc->psz_homedir; /* not part of XDG spec but we want a sensible fallback */
 758     if( asprintf( &psz_dir, "%s/.config/vlc", psz_env ) == -1 )
 759         return NULL;
 760     return psz_dir;
 761 #endif
 762 }
 763
 764 /**
 765  * Get the user's VLC data directory
 766  * (used for stuff like the skins, custom lua modules, ...)
 767  */
 768 char *config_GetUserDataDir( libvlc_int_t *p_libvlc )
 769 {
 770     char *psz_dir;
 771 #if defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS)
 772     char *psz_parent = config_GetUserDir();
 773     if( !psz_parent ) psz_parent = p_libvlc->psz_homedir;
 774     if( asprintf( &psz_dir, "%s" DIR_SEP CONFIG_DIR, psz_parent ) == -1 )
 775         return NULL;
 776     return psz_dir;
 777 #else
 778     /* XDG Base Directory Specification - Version 0.6 */
 779     char *psz_env = getenv( "XDG_DATA_HOME" );
 780     if( psz_env )
 781     {
 782         if( asprintf( &psz_dir, "%s/vlc", psz_env ) == -1 )
 783             return NULL;
 784         return psz_dir;
 785     }
 786     psz_env = getenv( "HOME" );
 787     if( !psz_env ) psz_env = p_libvlc->psz_homedir; /* not part of XDG spec but we want a sensible fallback */
 788     if( asprintf( &psz_dir, "%s/.local/share/vlc", psz_env ) == -1 )
 789         return NULL;
 790     return psz_dir;
 791 #endif
 792 }
 793
 794 /**
 795  * Get the user's VLC cache directory
 796  * (used for stuff like the modules cache, the album art cache, ...)
 797  */
 798 char *config_GetCacheDir( libvlc_int_t *p_libvlc )
 799 {
 800     char *psz_dir;
 801 #if defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS)
 802     char *psz_parent = config_GetUserDir();
 803     if( !psz_parent ) psz_parent = p_libvlc->psz_homedir;
 804     if( asprintf( &psz_dir, "%s" DIR_SEP CONFIG_DIR, psz_parent ) == -1 )
 805         return NULL;
 806     return psz_dir;
 807 #else
 808     /* XDG Base Directory Specification - Version 0.6 */
 809     char *psz_env = getenv( "XDG_CACHE_HOME" );
 810     if( psz_env )
 811     {
 812         if( asprintf( &psz_dir, "%s/vlc", psz_env ) == -1 )
 813             return NULL;
 814         return psz_dir;
 815     }
 816     psz_env = getenv( "HOME" );
 817     if( !psz_env ) psz_env = p_libvlc->psz_homedir; /* not part of XDG spec but we want a sensible fallback */
 818     if( asprintf( &psz_dir, "%s/.cache/vlc", psz_env ) == -1 )
 819         return NULL;
 820     return psz_dir;
 821 #endif
 822 }
 823
 824 /* Adds an extra interface to the configuration */
 825 void __config_AddIntf( vlc_object_t *p_this, const char *psz_intf )
 826 {
 827     assert( psz_intf );
 828
 829     char *psz_config, *psz_parser;
 830     size_t i_len = strlen( psz_intf );
 831
 832     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
 833     while( psz_parser )
 834     {
 835         if( !strncmp( psz_intf, psz_parser, i_len ) )
 836         {
 837             free( psz_config );
 838             return;
 839         }
 840         psz_parser = strchr( psz_parser, ':' );
 841         if( psz_parser ) psz_parser++; /* skip the ':' */
 842     }
 843     free( psz_config );
 844
 845     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
 846     while( psz_parser )
 847     {
 848         if( !strncmp( psz_intf, psz_parser, i_len ) )
 849         {
 850             free( psz_config );
 851             return;
 852         }
 853         psz_parser = strchr( psz_parser, ':' );
 854         if( psz_parser ) psz_parser++; /* skip the ':' */
 855     }
 856
 857     /* interface not found in the config, let's add it */
 858     if( psz_config && strlen( psz_config ) > 0 )
 859     {
 860         char *psz_newconfig;
 861         if( asprintf( &psz_newconfig, "%s:%s", psz_config, psz_intf ) != -1 )
 862         {
 863             config_PutPsz( p_this->p_libvlc, "extraintf", psz_newconfig );
 864             free( psz_newconfig );
 865         }
 866     }
 867     else
 868         config_PutPsz( p_this->p_libvlc, "extraintf", psz_intf );
 869
 870     free( psz_config );
 871 }
 872
 873 /* Removes an extra interface from the configuration */
 874 void __config_RemoveIntf( vlc_object_t *p_this, const char *psz_intf )
 875 {
 876     assert( psz_intf );
 877
 878     char *psz_config, *psz_parser;
 879     size_t i_len = strlen( psz_intf );
 880
 881     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
 882     while( psz_parser )
 883     {
 884         if( !strncmp( psz_intf, psz_parser, i_len ) )
 885         {
 886             char *psz_newconfig;
 887             char *psz_end = psz_parser + i_len;
 888             if( *psz_end == ':' ) psz_end++;
 889             *psz_parser = '\0';
 890             if( asprintf( &psz_newconfig, "%s%s", psz_config, psz_end ) != -1 )
 891             {
 892                 config_PutPsz( p_this->p_libvlc, "extraintf", psz_newconfig );
 893                 free( psz_newconfig );
 894             }
 895             break;
 896         }
 897         psz_parser = strchr( psz_parser, ':' );
 898         if( psz_parser ) psz_parser++; /* skip the ':' */
 899     }
 900     free( psz_config );
 901
 902     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
 903     while( psz_parser )
 904     {
 905         if( !strncmp( psz_intf, psz_parser, i_len ) )
 906         {
 907             char *psz_newconfig;
 908             char *psz_end = psz_parser + i_len;
 909             if( *psz_end == ':' ) psz_end++;
 910             *psz_parser = '\0';
 911             if( asprintf( &psz_newconfig, "%s%s", psz_config, psz_end ) != -1 )
 912             {
 913                 config_PutPsz( p_this->p_libvlc, "control", psz_newconfig );
 914                 free( psz_newconfig );
 915             }
 916             break;
 917         }
 918         psz_parser = strchr( psz_parser, ':' );
 919         if( psz_parser ) psz_parser++; /* skip the ':' */
 920     }
 921     free( psz_config );
 922 }
 923
 924 /*
 925  * Returns VLC_TRUE if the specified extra interface is present in the
 926  * configuration, VLC_FALSE if not
 927  */
 928 vlc_bool_t __config_ExistIntf( vlc_object_t *p_this, const char *psz_intf )
 929 {
 930     assert( psz_intf );
 931
 932     char *psz_config, *psz_parser;
 933     size_t i_len = strlen( psz_intf );
 934
 935     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
 936     while( psz_parser )
 937     {
 938         if( !strncmp( psz_parser, psz_intf, i_len ) )
 939         {
 940             free( psz_config );
 941             return VLC_TRUE;
 942         }
 943         psz_parser = strchr( psz_parser, ':' );
 944         if( psz_parser ) psz_parser++; /* skip the ':' */
 945     }
 946     free( psz_config );
 947
 948     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
 949     while( psz_parser )
 950     {
 951         if( !strncmp( psz_parser, psz_intf, i_len ) )
 952         {
 953             free( psz_config );
 954             return VLC_TRUE;
 955         }
 956         psz_parser = strchr( psz_parser, ':' );
 957         if( psz_parser ) psz_parser++; /* skip the ':' */
 958     }
 959     free( psz_config );
 960
 961     return VLC_FALSE;
 962 }
 963