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 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include "vlc_keys.h"
  30 #include "vlc_charset.h"
  31 #include "vlc_configuration.h"
  32
  33 #include <assert.h>
  34
  35 #include "configuration.h"
  36 #include "modules/modules.h"
  37
  38 vlc_rwlock_t config_lock;
  39
  40 static inline char *strdupnull (const char *src)
  41 {
  42     return src ? strdup (src) : NULL;
  43 }
  44
  45 /* Item types that use a string value (i.e. serialized in the module cache) */
  46 int IsConfigStringType (int type)
  47 {
  48     static const unsigned char config_types[] =
  49     {
  50         CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE,
  51         CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
  52         CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT, CONFIG_ITEM_FONT
  53     };
  54
  55     /* NOTE: this needs to be changed if we ever get more than 255 types */
  56     return memchr (config_types, type, sizeof (config_types)) != NULL;
  57 }
  58
  59
  60 int IsConfigIntegerType (int type)
  61 {
  62     static const unsigned char config_types[] =
  63     {
  64         CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
  65         CONFIG_CATEGORY, CONFIG_SUBCATEGORY
  66     };
  67
  68     return memchr (config_types, type, sizeof (config_types)) != NULL;
  69 }
  70
  71 #undef config_GetType
  72 /*****************************************************************************
  73  * config_GetType: get the type of a variable (bool, int, float, string)
  74  *****************************************************************************
  75  * This function is used to get the type of a variable from its name.
  76  * Beware, this is quite slow.
  77  *****************************************************************************/
  78 int config_GetType( vlc_object_t *p_this, const char *psz_name )
  79 {
  80     module_config_t *p_config;
  81     int i_type;
  82
  83     p_config = config_FindConfig( p_this, psz_name );
  84
  85     /* sanity checks */
  86     if( !p_config )
  87     {
  88         return 0;
  89     }
  90
  91     switch( p_config->i_type )
  92     {
  93     case CONFIG_ITEM_BOOL:
  94         i_type = VLC_VAR_BOOL;
  95         break;
  96
  97     case CONFIG_ITEM_INTEGER:
  98     case CONFIG_ITEM_KEY:
  99         i_type = VLC_VAR_INTEGER;
 100         break;
 101
 102     case CONFIG_ITEM_FLOAT:
 103         i_type = VLC_VAR_FLOAT;
 104         break;
 105
 106     case CONFIG_ITEM_MODULE:
 107     case CONFIG_ITEM_MODULE_CAT:
 108     case CONFIG_ITEM_MODULE_LIST:
 109     case CONFIG_ITEM_MODULE_LIST_CAT:
 110         i_type = VLC_VAR_MODULE;
 111         break;
 112
 113     case CONFIG_ITEM_STRING:
 114         i_type = VLC_VAR_STRING;
 115         break;
 116
 117     case CONFIG_ITEM_PASSWORD:
 118         i_type = VLC_VAR_STRING;
 119         break;
 120
 121     case CONFIG_ITEM_FILE:
 122         i_type = VLC_VAR_FILE;
 123         break;
 124
 125     case CONFIG_ITEM_DIRECTORY:
 126         i_type = VLC_VAR_DIRECTORY;
 127         break;
 128
 129     default:
 130         i_type = 0;
 131         break;
 132     }
 133
 134     return i_type;
 135 }
 136
 137 #undef config_GetInt
 138 /*****************************************************************************
 139  * config_GetInt: get the value of an int variable
 140  *****************************************************************************
 141  * This function is used to get the value of variables which are internally
 142  * represented by an integer (CONFIG_ITEM_INTEGER and
 143  * CONFIG_ITEM_BOOL).
 144  *****************************************************************************/
 145 int config_GetInt( vlc_object_t *p_this, const char *psz_name )
 146 {
 147     module_config_t *p_config;
 148
 149     p_config = config_FindConfig( p_this, psz_name );
 150
 151     /* sanity checks */
 152     if( !p_config )
 153     {
 154         msg_Err( p_this, "option %s does not exist", psz_name );
 155         return -1;
 156     }
 157
 158     if (!IsConfigIntegerType (p_config->i_type))
 159     {
 160         msg_Err( p_this, "option %s does not refer to an int", psz_name );
 161         return -1;
 162     }
 163
 164     int val;
 165
 166     vlc_rwlock_rdlock (&config_lock);
 167     val = p_config->value.i;
 168     vlc_rwlock_unlock (&config_lock);
 169     return val;
 170 }
 171
 172 #undef config_GetFloat
 173 /*****************************************************************************
 174  * config_GetFloat: get the value of a float variable
 175  *****************************************************************************
 176  * This function is used to get the value of variables which are internally
 177  * represented by a float (CONFIG_ITEM_FLOAT).
 178  *****************************************************************************/
 179 float config_GetFloat( vlc_object_t *p_this, const char *psz_name )
 180 {
 181     module_config_t *p_config;
 182
 183     p_config = config_FindConfig( p_this, psz_name );
 184
 185     /* sanity checks */
 186     if( !p_config )
 187     {
 188         msg_Err( p_this, "option %s does not exist", psz_name );
 189         return -1;
 190     }
 191
 192     if (!IsConfigFloatType (p_config->i_type))
 193     {
 194         msg_Err( p_this, "option %s does not refer to a float", psz_name );
 195         return -1;
 196     }
 197
 198     float val;
 199
 200     vlc_rwlock_rdlock (&config_lock);
 201     val = p_config->value.f;
 202     vlc_rwlock_unlock (&config_lock);
 203     return val;
 204 }
 205
 206 #undef config_GetPsz
 207 /*****************************************************************************
 208  * config_GetPsz: get the string value of a string variable
 209  *****************************************************************************
 210  * This function is used to get the value of variables which are internally
 211  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
 212  * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
 213  *
 214  * Important note: remember to free() the returned char* because it's a
 215  *   duplicate of the actual value. It isn't safe to return a pointer to the
 216  *   actual value as it can be modified at any time.
 217  *****************************************************************************/
 218 char * config_GetPsz( vlc_object_t *p_this, const char *psz_name )
 219 {
 220     module_config_t *p_config;
 221
 222     p_config = config_FindConfig( p_this, psz_name );
 223
 224     /* sanity checks */
 225     if( !p_config )
 226     {
 227         msg_Err( p_this, "option %s does not exist", psz_name );
 228         return NULL;
 229     }
 230
 231     if (!IsConfigStringType (p_config->i_type))
 232     {
 233         msg_Err( p_this, "option %s does not refer to a string", psz_name );
 234         return NULL;
 235     }
 236
 237     /* return a copy of the string */
 238     vlc_rwlock_rdlock (&config_lock);
 239     char *psz_value = strdupnull (p_config->value.psz);
 240     vlc_rwlock_unlock (&config_lock);
 241
 242     return psz_value;
 243 }
 244
 245 #undef config_PutPsz
 246 /*****************************************************************************
 247  * config_PutPsz: set the string value of a string variable
 248  *****************************************************************************
 249  * This function is used to set the value of variables which are internally
 250  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
 251  * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
 252  *****************************************************************************/
 253 void config_PutPsz( vlc_object_t *p_this,
 254                       const char *psz_name, const char *psz_value )
 255 {
 256     module_config_t *p_config;
 257     vlc_value_t oldval, val;
 258
 259     p_config = config_FindConfig( p_this, psz_name );
 260
 261
 262     /* sanity checks */
 263     if( !p_config )
 264     {
 265         msg_Warn( p_this, "option %s does not exist", psz_name );
 266         return;
 267     }
 268
 269     if (!IsConfigStringType (p_config->i_type))
 270     {
 271         msg_Err( p_this, "option %s does not refer to a string", psz_name );
 272         return;
 273     }
 274
 275     vlc_rwlock_wrlock (&config_lock);
 276
 277     /* backup old value */
 278     oldval.psz_string = (char *)p_config->value.psz;
 279
 280     if ((psz_value != NULL) && *psz_value)
 281         p_config->value.psz = strdup (psz_value);
 282     else
 283         p_config->value.psz = NULL;
 284
 285     p_config->b_dirty = true;
 286
 287     val.psz_string = (char *)p_config->value.psz;
 288
 289     vlc_rwlock_unlock (&config_lock);
 290
 291     if( p_config->pf_callback )
 292     {
 293         p_config->pf_callback( p_this, psz_name, oldval, val,
 294                                p_config->p_callback_data );
 295     }
 296
 297     /* free old string */
 298     free( oldval.psz_string );
 299 }
 300
 301 #undef config_PutInt
 302 /*****************************************************************************
 303  * config_PutInt: set the integer value of an int variable
 304  *****************************************************************************
 305  * This function is used to set the value of variables which are internally
 306  * represented by an integer (CONFIG_ITEM_INTEGER and
 307  * CONFIG_ITEM_BOOL).
 308  *****************************************************************************/
 309 void config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
 310 {
 311     module_config_t *p_config;
 312     vlc_value_t oldval;
 313
 314     p_config = config_FindConfig( p_this, psz_name );
 315
 316     /* sanity checks */
 317     if( !p_config )
 318     {
 319         msg_Warn( p_this, "option %s does not exist", psz_name );
 320         return;
 321     }
 322
 323     if (!IsConfigIntegerType (p_config->i_type))
 324     {
 325         msg_Err( p_this, "option %s does not refer to an int", psz_name );
 326         return;
 327     }
 328
 329     /* if i_min == i_max == 0, then do not use them */
 330     if ((p_config->min.i == 0) && (p_config->max.i == 0))
 331         ;
 332     else if (i_value < p_config->min.i)
 333         i_value = p_config->min.i;
 334     else if (i_value > p_config->max.i)
 335         i_value = p_config->max.i;
 336
 337     vlc_rwlock_wrlock (&config_lock);
 338     /* backup old value */
 339     oldval.i_int = p_config->value.i;
 340
 341     p_config->value.i = i_value;
 342     p_config->b_dirty = true;
 343     vlc_rwlock_unlock (&config_lock);
 344
 345     if( p_config->pf_callback )
 346     {
 347         vlc_value_t val;
 348
 349         val.i_int = i_value;
 350         p_config->pf_callback( p_this, psz_name, oldval, val,
 351                                p_config->p_callback_data );
 352     }
 353 }
 354
 355 #undef config_PutFloat
 356 /*****************************************************************************
 357  * config_PutFloat: set the value of a float variable
 358  *****************************************************************************
 359  * This function is used to set the value of variables which are internally
 360  * represented by a float (CONFIG_ITEM_FLOAT).
 361  *****************************************************************************/
 362 void config_PutFloat( vlc_object_t *p_this,
 363                       const char *psz_name, float f_value )
 364 {
 365     module_config_t *p_config;
 366     vlc_value_t oldval;
 367
 368     p_config = config_FindConfig( p_this, psz_name );
 369
 370     /* sanity checks */
 371     if( !p_config )
 372     {
 373         msg_Warn( p_this, "option %s does not exist", psz_name );
 374         return;
 375     }
 376
 377     if (!IsConfigFloatType (p_config->i_type))
 378     {
 379         msg_Err( p_this, "option %s does not refer to a float", psz_name );
 380         return;
 381     }
 382
 383     /* if f_min == f_max == 0, then do not use them */
 384     if ((p_config->min.f == 0) && (p_config->max.f == 0))
 385         ;
 386     else if (f_value < p_config->min.f)
 387         f_value = p_config->min.f;
 388     else if (f_value > p_config->max.f)
 389         f_value = p_config->max.f;
 390
 391     vlc_rwlock_wrlock (&config_lock);
 392     /* backup old value */
 393     oldval.f_float = p_config->value.f;
 394
 395     p_config->value.f = f_value;
 396     p_config->b_dirty = true;
 397     vlc_rwlock_unlock (&config_lock);
 398
 399     if( p_config->pf_callback )
 400     {
 401         vlc_value_t val;
 402
 403         val.f_float = f_value;
 404         p_config->pf_callback( p_this, psz_name, oldval, val,
 405                                p_config->p_callback_data );
 406     }
 407 }
 408
 409 static int confcmp (const void *a, const void *b)
 410 {
 411     const module_config_t *const *ca = a, *const *cb = b;
 412
 413     return strcmp ((*ca)->psz_name, (*cb)->psz_name);
 414 }
 415
 416 static int confnamecmp (const void *key, const void *elem)
 417 {
 418     const module_config_t *const *conf = elem;
 419
 420     return strcmp (key, (*conf)->psz_name);
 421 }
 422
 423 static struct
 424 {
 425     module_config_t **list;
 426     size_t count;
 427 } config = { NULL, 0 };
 428
 429 /**
 430  * Index the configuration items by name for faster lookups.
 431  */
 432 int config_SortConfig (void)
 433 {
 434     size_t nmod;
 435     module_t **mlist = module_list_get (&nmod);
 436     if (unlikely(mlist == NULL))
 437         return VLC_ENOMEM;
 438
 439     size_t nconf = 0;
 440     for (size_t i = 0; i < nmod; i++)
 441          nconf  += mlist[i]->confsize;
 442
 443     module_config_t **clist = malloc (sizeof (*clist) * nconf);
 444     if (unlikely(clist == NULL))
 445     {
 446         module_list_free (mlist);
 447         return VLC_ENOMEM;
 448     }
 449
 450     nconf = 0;
 451     for (size_t i = 0; i < nmod; i++)
 452     {
 453         module_t *parser = mlist[i];
 454         module_config_t *item, *end;
 455
 456         for (item = parser->p_config, end = item + parser->confsize;
 457              item < end;
 458              item++)
 459         {
 460             if (item->i_type & CONFIG_HINT)
 461                 continue; /* ignore hints */
 462             clist[nconf++] = item;
 463         }
 464     }
 465     module_list_free (mlist);
 466
 467     qsort (clist, nconf, sizeof (*clist), confcmp);
 468
 469     config.list = clist;
 470     config.count = nconf;
 471     return VLC_SUCCESS;
 472 }
 473
 474 void config_UnsortConfig (void)
 475 {
 476     module_config_t **clist;
 477
 478     clist = config.list;
 479     config.list = NULL;
 480     config.count = 0;
 481
 482     free (clist);
 483 }
 484
 485 /*****************************************************************************
 486  * config_FindConfig: find the config structure associated with an option.
 487  *****************************************************************************
 488  * FIXME: remove p_this pointer parameter (or use it)
 489  *****************************************************************************/
 490 module_config_t *config_FindConfig (vlc_object_t *p_this, const char *name)
 491 {
 492     VLC_UNUSED(p_this);
 493
 494     if (unlikely(name == NULL))
 495         return NULL;
 496
 497     module_config_t *const *p;
 498     p = bsearch (name, config.list, config.count, sizeof (*p), confnamecmp);
 499     return p ? *p : NULL;
 500 }
 501
 502 /*****************************************************************************
 503  * config_Free: frees a duplicated module's configuration data.
 504  *****************************************************************************
 505  * This function frees all the data duplicated by config_Duplicate.
 506  *****************************************************************************/
 507 void config_Free( module_t *p_module )
 508 {
 509     int i;
 510
 511     for (size_t j = 0; j < p_module->confsize; j++)
 512     {
 513         module_config_t *p_item = p_module->p_config + j;
 514
 515         free( p_item->psz_type );
 516         free( p_item->psz_name );
 517         free( p_item->psz_text );
 518         free( p_item->psz_longtext );
 519         free( p_item->psz_oldname );
 520
 521         if (IsConfigStringType (p_item->i_type))
 522         {
 523             free (p_item->value.psz);
 524             free (p_item->orig.psz);
 525             free (p_item->saved.psz);
 526         }
 527
 528         if( p_item->ppsz_list )
 529             for( i = 0; i < p_item->i_list; i++ )
 530                 free( p_item->ppsz_list[i] );
 531         if( p_item->ppsz_list_text )
 532             for( i = 0; i < p_item->i_list; i++ )
 533                 free( p_item->ppsz_list_text[i] );
 534         free( p_item->ppsz_list );
 535         free( p_item->ppsz_list_text );
 536         free( p_item->pi_list );
 537
 538         if( p_item->i_action )
 539         {
 540             for( i = 0; i < p_item->i_action; i++ )
 541             {
 542                 free( p_item->ppsz_action_text[i] );
 543             }
 544             free( p_item->ppf_action );
 545             free( p_item->ppsz_action_text );
 546         }
 547     }
 548
 549     free (p_module->p_config);
 550     p_module->p_config = NULL;
 551 }
 552
 553 #undef config_ResetAll
 554 /*****************************************************************************
 555  * config_ResetAll: reset the configuration data for all the modules.
 556  *****************************************************************************/
 557 void config_ResetAll( vlc_object_t *p_this )
 558 {
 559     VLC_UNUSED(p_this);
 560     module_t *p_module;
 561     module_t **list = module_list_get (NULL);
 562
 563     vlc_rwlock_wrlock (&config_lock);
 564     for (size_t j = 0; (p_module = list[j]) != NULL; j++)
 565     {
 566         if( p_module->b_submodule ) continue;
 567
 568         for (size_t i = 0; i < p_module->confsize; i++ )
 569         {
 570             module_config_t *p_config = p_module->p_config + i;
 571
 572             if (IsConfigIntegerType (p_config->i_type))
 573                 p_config->value.i = p_config->orig.i;
 574             else
 575             if (IsConfigFloatType (p_config->i_type))
 576                 p_config->value.f = p_config->orig.f;
 577             else
 578             if (IsConfigStringType (p_config->i_type))
 579             {
 580                 free ((char *)p_config->value.psz);
 581                 p_config->value.psz =
 582                         strdupnull (p_config->orig.psz);
 583             }
 584         }
 585     }
 586     vlc_rwlock_unlock (&config_lock);
 587
 588     module_list_free (list);
 589 }