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             {
 469                 vlc_list_release( p_list );
 470                 return p_item;
 471             }
 472         }
 473     }
 474
 475     vlc_list_release( p_list );
 476
 477     return NULL;
 478 }
 479
 480 /*****************************************************************************
 481  * config_Duplicate: creates a duplicate of a module's configuration data.
 482  *****************************************************************************
 483  * Unfortunatly we cannot work directly with the module's config data as
 484  * this module might be unloaded from memory at any time (remember HideModule).
 485  * This is why we need to create an exact copy of the config data.
 486  *****************************************************************************/
 487 int config_Duplicate( module_t *p_module, const module_config_t *p_orig,
 488                       size_t n )
 489 {
 490     const module_config_t *p_item, *p_end = p_orig + n;
 491
 492     /* Calculate the structure length */
 493     p_module->i_config_items = 0;
 494     p_module->i_bool_items = 0;
 495
 496     for( p_item = p_orig; p_item < p_end; p_item++ )
 497     {
 498         if( p_item->i_type & CONFIG_ITEM )
 499         {
 500             p_module->i_config_items++;
 501         }
 502
 503         if( p_item->i_type == CONFIG_ITEM_BOOL )
 504         {
 505             p_module->i_bool_items++;
 506         }
 507     }
 508
 509     /* Allocate memory */
 510     p_module->p_config = (module_config_t *)calloc( n, sizeof(*p_orig) );
 511     if( p_module->p_config == NULL )
 512     {
 513         msg_Err( p_module, "config error: can't duplicate p_config" );
 514         return VLC_ENOMEM;
 515     }
 516     p_module->confsize = n;
 517
 518     /* Do the duplication job */
 519     for( size_t i = 0; i < n ; i++ )
 520     {
 521         p_module->p_config[i] = p_orig[i];
 522         p_module->p_config[i].p_lock = &p_module->object_lock;
 523
 524         /* duplicate the actions list */
 525         if( p_orig[i].i_action )
 526         {
 527             int j;
 528
 529             p_module->p_config[i].ppf_action =
 530                 malloc( p_orig[i].i_action * sizeof(void *) );
 531             p_module->p_config[i].ppsz_action_text =
 532                 malloc( p_orig[i].i_action * sizeof(char *) );
 533
 534             for( j = 0; j < p_orig[i].i_action; j++ )
 535             {
 536                 p_module->p_config[i].ppf_action[j] =
 537                     p_orig[i].ppf_action[j];
 538                 p_module->p_config[i].ppsz_action_text[j] =
 539                     strdupnull (p_orig[i].ppsz_action_text[j]);
 540             }
 541         }
 542
 543         p_module->p_config[i].pf_callback = p_orig[i].pf_callback;
 544     }
 545     return VLC_SUCCESS;
 546 }
 547
 548
 549 /*****************************************************************************
 550  * config_Free: frees a duplicated module's configuration data.
 551  *****************************************************************************
 552  * This function frees all the data duplicated by config_Duplicate.
 553  *****************************************************************************/
 554 void config_Free( module_t *p_module )
 555 {
 556     int i;
 557
 558     for (size_t j = 0; j < p_module->confsize; j++)
 559     {
 560         module_config_t *p_item = p_module->p_config + j;
 561
 562         free( p_item->psz_type );
 563         free( p_item->psz_name );
 564         free( p_item->psz_text );
 565         free( p_item->psz_longtext );
 566
 567         if (IsConfigStringType (p_item->i_type))
 568         {
 569             free (p_item->value.psz);
 570             free (p_item->orig.psz);
 571             free (p_item->saved.psz);
 572         }
 573
 574         if( p_item->i_list )
 575         {
 576             if( p_item->ppsz_list )
 577                 for( i = 0; i < p_item->i_list; i++ )
 578                     free( p_item->ppsz_list[i] );
 579             if( p_item->ppsz_list_text )
 580                 for( i = 0; i < p_item->i_list; i++ )
 581                     free( p_item->ppsz_list[i] );
 582             free( p_item->ppsz_list );
 583             free( p_item->ppsz_list_text );
 584             free( p_item->pi_list );
 585         }
 586
 587         if( p_item->i_action )
 588         {
 589             for( i = 0; i < p_item->i_action; i++ )
 590             {
 591                 free( p_item->ppsz_action_text[i] );
 592             }
 593             free( p_item->ppf_action );
 594             free( p_item->ppsz_action_text );
 595         }
 596     }
 597
 598     free (p_module->p_config);
 599     p_module->p_config = NULL;
 600 }
 601
 602 /*****************************************************************************
 603  * config_SetCallbacks: sets callback functions in the duplicate p_config.
 604  *****************************************************************************
 605  * Unfortunatly we cannot work directly with the module's config data as
 606  * this module might be unloaded from memory at any time (remember HideModule).
 607  * This is why we need to duplicate callbacks each time we reload the module.
 608  *****************************************************************************/
 609 void config_SetCallbacks( module_config_t *p_new, module_config_t *p_orig,
 610                           size_t n )
 611 {
 612     for (size_t i = 0; i < n; i++)
 613     {
 614         p_new->pf_callback = p_orig->pf_callback;
 615         p_new++;
 616         p_orig++;
 617     }
 618 }
 619
 620 /*****************************************************************************
 621  * config_UnsetCallbacks: unsets callback functions in the duplicate p_config.
 622  *****************************************************************************
 623  * We simply undo what we did in config_SetCallbacks.
 624  *****************************************************************************/
 625 void config_UnsetCallbacks( module_config_t *p_new, size_t n )
 626 {
 627     for (size_t i = 0; i < n; i++)
 628     {
 629         p_new->pf_callback = NULL;
 630         p_new++;
 631     }
 632 }
 633
 634 /*****************************************************************************
 635  * config_ResetAll: reset the configuration data for all the modules.
 636  *****************************************************************************/
 637 void __config_ResetAll( vlc_object_t *p_this )
 638 {
 639     int i_index;
 640     vlc_list_t *p_list;
 641     module_t *p_module;
 642
 643     /* Acquire config file lock */
 644     vlc_mutex_lock( &p_this->p_libvlc->config_lock );
 645
 646     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 647
 648     for( i_index = 0; i_index < p_list->i_count; i_index++ )
 649     {
 650         p_module = (module_t *)p_list->p_values[i_index].p_object ;
 651         if( p_module->b_submodule ) continue;
 652
 653         for (size_t i = 0; i < p_module->confsize; i++ )
 654         {
 655             if (IsConfigIntegerType (p_module->p_config[i].i_type))
 656                 p_module->p_config[i].value.i = p_module->p_config[i].orig.i;
 657             else
 658             if (IsConfigFloatType (p_module->p_config[i].i_type))
 659                 p_module->p_config[i].value.f = p_module->p_config[i].orig.f;
 660             else
 661             if (IsConfigStringType (p_module->p_config[i].i_type))
 662             {
 663                 free ((char *)p_module->p_config[i].value.psz);
 664                 p_module->p_config[i].value.psz =
 665                         strdupnull (p_module->p_config[i].orig.psz);
 666             }
 667         }
 668     }
 669
 670     vlc_list_release( p_list );
 671     vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
 672 }
 673
 674 /**
 675  * config_GetDataDir: find directory where shared data is installed
 676  *
 677  * @return a string (always succeeds).
 678  */
 679 const char *config_GetDataDir( void )
 680 {
 681 #if defined (WIN32) || defined (UNDER_CE)
 682     return vlc_global()->psz_vlcpath;
 683 #elif defined(__APPLE__) || defined (SYS_BEOS)
 684     static char path[PATH_MAX] = "";
 685
 686     if( *path == '\0' )
 687     {
 688         snprintf( path, sizeof( path ), "%s/share",
 689                   vlc_global()->psz_vlcpath );
 690         path[sizeof( path ) - 1] = '\0';
 691     }
 692     return path;
 693 #else
 694     return DATA_PATH;
 695 #endif
 696 }
 697
 698 /*****************************************************************************
 699  * config_GetHomeDir, config_GetUserDir: find the user's home directory.
 700  *****************************************************************************
 701  * This function will try by different ways to find the user's home path.
 702  * Note that this function is not reentrant, it should be called only once
 703  * at the beginning of main where the result will be stored for later use.
 704  *****************************************************************************/
 705 static char *GetDir( vlc_bool_t b_appdata )
 706 {
 707     const char *psz_localhome = NULL;
 708
 709 #if defined(WIN32) && !defined(UNDER_CE)
 710     typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
 711                                                LPWSTR );
 712 #ifndef CSIDL_FLAG_CREATE
 713 #   define CSIDL_FLAG_CREATE 0x8000
 714 #endif
 715 #ifndef CSIDL_APPDATA
 716 #   define CSIDL_APPDATA 0x1A
 717 #endif
 718 #ifndef CSIDL_PROFILE
 719 #   define CSIDL_PROFILE 0x28
 720 #endif
 721 #ifndef SHGFP_TYPE_CURRENT
 722 #   define SHGFP_TYPE_CURRENT 0
 723 #endif
 724
 725     HINSTANCE shfolder_dll;
 726     SHGETFOLDERPATH SHGetFolderPath ;
 727
 728     /* load the shfolder dll to retrieve SHGetFolderPath */
 729     if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
 730     {
 731         SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
 732                                                   _T("SHGetFolderPathW") );
 733         if ( SHGetFolderPath != NULL )
 734         {
 735             wchar_t whomedir[MAX_PATH];
 736
 737             /* get the "Application Data" folder for the current user */
 738             if( S_OK == SHGetFolderPath( NULL,
 739                                          (b_appdata ? CSIDL_APPDATA :
 740                                            CSIDL_PROFILE) | CSIDL_FLAG_CREATE,
 741                                          NULL, SHGFP_TYPE_CURRENT,
 742                                          whomedir ) )
 743             {
 744                 FreeLibrary( shfolder_dll );
 745                 return FromWide( whomedir );
 746             }
 747         }
 748         FreeLibrary( shfolder_dll );
 749     }
 750
 751 #elif defined(UNDER_CE)
 752
 753 #ifndef CSIDL_APPDATA
 754 #   define CSIDL_APPDATA 0x1A
 755 #endif
 756
 757     wchar_t whomedir[MAX_PATH];
 758
 759     /* get the "Application Data" folder for the current user */
 760     if( SHGetSpecialFolderPath( NULL, whomedir, CSIDL_APPDATA, 1 ) )
 761         return FromWide( whomedir );
 762 #endif
 763
 764     psz_localhome = getenv( "HOME" );
 765     if( psz_localhome == NULL )
 766     {
 767 #if defined(HAVE_GETPWUID)
 768         struct passwd *p_pw;
 769         (void)b_appdata;
 770
 771         if( ( p_pw = getpwuid( getuid() ) ) != NULL )
 772             psz_localhome = p_pw->pw_dir;
 773         else
 774 #endif
 775         {
 776             psz_localhome = getenv( "TMP" );
 777             if( psz_localhome == NULL )
 778                 psz_localhome = "/tmp";
 779         }
 780     }
 781
 782     return FromLocaleDup( psz_localhome );
 783 }
 784
 785 /**
 786  * Get the user's home directory
 787  */
 788 char *config_GetHomeDir( void )
 789 {
 790     return GetDir( VLC_FALSE );
 791 }
 792
 793 /**
 794  * Get the user's main data and config directory:
 795  *   - on windows that's the App Data directory;
 796  *   - on other OSes it's the same as the home directory.
 797  */
 798 char *config_GetUserDir( void );
 799 char *config_GetUserDir( void )
 800 {
 801     return GetDir( VLC_TRUE );
 802 }
 803
 804 /**
 805  * Get the user's VLC configuration directory
 806  */
 807 char *config_GetConfigDir( libvlc_int_t *p_libvlc )
 808 {
 809     char *psz_dir;
 810 #if defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS)
 811     char *psz_parent = config_GetUserDir();
 812     if( !psz_parent ) psz_parent = p_libvlc->psz_homedir;
 813     if( asprintf( &psz_dir, "%s" DIR_SEP CONFIG_DIR, psz_parent ) == -1 )
 814         return NULL;
 815     return psz_dir;
 816 #else
 817     /* XDG Base Directory Specification - Version 0.6 */
 818     char *psz_env = getenv( "XDG_CONFIG_HOME" );
 819     if( psz_env )
 820     {
 821         if( asprintf( &psz_dir, "%s/vlc", psz_env ) == -1 )
 822             return NULL;
 823         return psz_dir;
 824     }
 825     psz_env = getenv( "HOME" );
 826     if( !psz_env ) psz_env = p_libvlc->psz_homedir; /* not part of XDG spec but we want a sensible fallback */
 827     if( asprintf( &psz_dir, "%s/.config/vlc", psz_env ) == -1 )
 828         return NULL;
 829     return psz_dir;
 830 #endif
 831 }
 832
 833 /**
 834  * Get the user's VLC data directory
 835  * (used for stuff like the skins, custom lua modules, ...)
 836  */
 837 char *config_GetUserDataDir( libvlc_int_t *p_libvlc )
 838 {
 839     char *psz_dir;
 840 #if defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS)
 841     char *psz_parent = config_GetUserDir();
 842     if( !psz_parent ) psz_parent = p_libvlc->psz_homedir;
 843     if( asprintf( &psz_dir, "%s" DIR_SEP CONFIG_DIR, psz_parent ) == -1 )
 844         return NULL;
 845     return psz_dir;
 846 #else
 847     /* XDG Base Directory Specification - Version 0.6 */
 848     char *psz_env = getenv( "XDG_DATA_HOME" );
 849     if( psz_env )
 850     {
 851         if( asprintf( &psz_dir, "%s/vlc", psz_env ) == -1 )
 852             return NULL;
 853         return psz_dir;
 854     }
 855     psz_env = getenv( "HOME" );
 856     if( !psz_env ) psz_env = p_libvlc->psz_homedir; /* not part of XDG spec but we want a sensible fallback */
 857     if( asprintf( &psz_dir, "%s/.local/share/vlc", psz_env ) == -1 )
 858         return NULL;
 859     return psz_dir;
 860 #endif
 861 }
 862
 863 /**
 864  * Get the user's VLC cache directory
 865  * (used for stuff like the modules cache, the album art cache, ...)
 866  */
 867 char *config_GetCacheDir( libvlc_int_t *p_libvlc )
 868 {
 869     char *psz_dir;
 870 #if defined(WIN32) || defined(__APPLE__) || defined(SYS_BEOS)
 871     char *psz_parent = config_GetUserDir();
 872     if( !psz_parent ) psz_parent = p_libvlc->psz_homedir;
 873     if( asprintf( &psz_dir, "%s" DIR_SEP CONFIG_DIR, psz_parent ) == -1 )
 874         return NULL;
 875     return psz_dir;
 876 #else
 877     /* XDG Base Directory Specification - Version 0.6 */
 878     char *psz_env = getenv( "XDG_CACHE_HOME" );
 879     if( psz_env )
 880     {
 881         if( asprintf( &psz_dir, "%s/vlc", psz_env ) == -1 )
 882             return NULL;
 883         return psz_dir;
 884     }
 885     psz_env = getenv( "HOME" );
 886     if( !psz_env ) psz_env = p_libvlc->psz_homedir; /* not part of XDG spec but we want a sensible fallback */
 887     if( asprintf( &psz_dir, "%s/.cache/vlc", psz_env ) == -1 )
 888         return NULL;
 889     return psz_dir;
 890 #endif
 891 }
 892
 893 /* Adds an extra interface to the configuration */
 894 void __config_AddIntf( vlc_object_t *p_this, const char *psz_intf )
 895 {
 896     assert( psz_intf );
 897
 898     char *psz_config, *psz_parser;
 899     size_t i_len = strlen( psz_intf );
 900
 901     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
 902     while( psz_parser )
 903     {
 904         if( !strncmp( psz_intf, psz_parser, i_len ) )
 905         {
 906             free( psz_config );
 907             return;
 908         }
 909         psz_parser = strchr( psz_parser, ':' );
 910         if( psz_parser ) psz_parser++; /* skip the ':' */
 911     }
 912     free( psz_config );
 913
 914     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
 915     while( psz_parser )
 916     {
 917         if( !strncmp( psz_intf, psz_parser, i_len ) )
 918         {
 919             free( psz_config );
 920             return;
 921         }
 922         psz_parser = strchr( psz_parser, ':' );
 923         if( psz_parser ) psz_parser++; /* skip the ':' */
 924     }
 925
 926     /* interface not found in the config, let's add it */
 927     if( psz_config && strlen( psz_config ) > 0 )
 928     {
 929         char *psz_newconfig;
 930         if( asprintf( &psz_newconfig, "%s:%s", psz_config, psz_intf ) != -1 )
 931         {
 932             config_PutPsz( p_this->p_libvlc, "extraintf", psz_newconfig );
 933             free( psz_newconfig );
 934         }
 935     }
 936     else
 937         config_PutPsz( p_this->p_libvlc, "extraintf", psz_intf );
 938
 939     free( psz_config );
 940 }
 941
 942 /* Removes an extra interface from the configuration */
 943 void __config_RemoveIntf( vlc_object_t *p_this, const char *psz_intf )
 944 {
 945     assert( psz_intf );
 946
 947     char *psz_config, *psz_parser;
 948     size_t i_len = strlen( psz_intf );
 949
 950     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
 951     while( psz_parser )
 952     {
 953         if( !strncmp( psz_intf, psz_parser, i_len ) )
 954         {
 955             char *psz_newconfig;
 956             char *psz_end = psz_parser + i_len;
 957             if( *psz_end == ':' ) psz_end++;
 958             *psz_parser = '\0';
 959             if( asprintf( &psz_newconfig, "%s%s", psz_config, psz_end ) != -1 )
 960             {
 961                 config_PutPsz( p_this->p_libvlc, "extraintf", psz_newconfig );
 962                 free( psz_newconfig );
 963             }
 964             break;
 965         }
 966         psz_parser = strchr( psz_parser, ':' );
 967         if( psz_parser ) psz_parser++; /* skip the ':' */
 968     }
 969     free( psz_config );
 970
 971     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
 972     while( psz_parser )
 973     {
 974         if( !strncmp( psz_intf, psz_parser, i_len ) )
 975         {
 976             char *psz_newconfig;
 977             char *psz_end = psz_parser + i_len;
 978             if( *psz_end == ':' ) psz_end++;
 979             *psz_parser = '\0';
 980             if( asprintf( &psz_newconfig, "%s%s", psz_config, psz_end ) != -1 )
 981             {
 982                 config_PutPsz( p_this->p_libvlc, "control", psz_newconfig );
 983                 free( psz_newconfig );
 984             }
 985             break;
 986         }
 987         psz_parser = strchr( psz_parser, ':' );
 988         if( psz_parser ) psz_parser++; /* skip the ':' */
 989     }
 990     free( psz_config );
 991 }
 992
 993 /*
 994  * Returns VLC_TRUE if the specified extra interface is present in the
 995  * configuration, VLC_FALSE if not
 996  */
 997 vlc_bool_t __config_ExistIntf( vlc_object_t *p_this, const char *psz_intf )
 998 {
 999     assert( psz_intf );
1000
1001     char *psz_config, *psz_parser;
1002     size_t i_len = strlen( psz_intf );
1003
1004     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "extraintf" );
1005     while( psz_parser )
1006     {
1007         if( !strncmp( psz_parser, psz_intf, i_len ) )
1008         {
1009             free( psz_config );
1010             return VLC_TRUE;
1011         }
1012         psz_parser = strchr( psz_parser, ':' );
1013         if( psz_parser ) psz_parser++; /* skip the ':' */
1014     }
1015     free( psz_config );
1016
1017     psz_config = psz_parser = config_GetPsz( p_this->p_libvlc, "control" );
1018     while( psz_parser )
1019     {
1020         if( !strncmp( psz_parser, psz_intf, i_len ) )
1021         {
1022             free( psz_config );
1023             return VLC_TRUE;
1024         }
1025         psz_parser = strchr( psz_parser, ':' );
1026         if( psz_parser ) psz_parser++; /* skip the ':' */
1027     }
1028     free( psz_config );
1029
1030     return VLC_FALSE;
1031 }
1032