core.c 15.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*****************************************************************************
 * core.c management of the modules configuration
 *****************************************************************************
 * Copyright (C) 2001-2007 the VideoLAN team
 * $Id$
 *
 * Authors: Gildas Bazin <gbazin@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

24 25 26 27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28
#include <vlc_common.h>
29 30 31
#include <vlc_keys.h>
#include <vlc_modules.h>

32
#include "vlc_configuration.h"
33

34
#include <assert.h>
35

36
#include "configuration.h"
37 38
#include "modules/modules.h"

39 40
vlc_rwlock_t config_lock;

41 42 43 44 45 46 47 48 49 50
static inline char *strdupnull (const char *src)
{
    return src ? strdup (src) : NULL;
}

/* Item types that use a string value (i.e. serialized in the module cache) */
int IsConfigStringType (int type)
{
    static const unsigned char config_types[] =
    {
51 52
        CONFIG_ITEM_STRING, CONFIG_ITEM_MODULE, CONFIG_ITEM_DIRECTORY,
        CONFIG_ITEM_KEY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
53 54
        CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT,
        CONFIG_ITEM_FONT, CONFIG_ITEM_LOADFILE, CONFIG_ITEM_SAVEFILE,
55 56 57 58 59 60 61
    };

    /* NOTE: this needs to be changed if we ever get more than 255 types */
    return memchr (config_types, type, sizeof (config_types)) != NULL;
}


62
int IsConfigIntegerType (int type)
63 64 65
{
    static const unsigned char config_types[] =
    {
66
        CONFIG_ITEM_INTEGER, CONFIG_ITEM_BOOL,
67 68 69 70 71 72
        CONFIG_CATEGORY, CONFIG_SUBCATEGORY
    };

    return memchr (config_types, type, sizeof (config_types)) != NULL;
}

73
#undef config_GetType
74 75 76 77 78 79
/*****************************************************************************
 * config_GetType: get the type of a variable (bool, int, float, string)
 *****************************************************************************
 * This function is used to get the type of a variable from its name.
 * Beware, this is quite slow.
 *****************************************************************************/
80
int config_GetType( vlc_object_t *p_this, const char *psz_name )
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
{
    module_config_t *p_config;
    int i_type;

    p_config = config_FindConfig( p_this, psz_name );

    /* sanity checks */
    if( !p_config )
    {
        return 0;
    }

    switch( p_config->i_type )
    {
    case CONFIG_ITEM_BOOL:
        i_type = VLC_VAR_BOOL;
        break;

    case CONFIG_ITEM_INTEGER:
        i_type = VLC_VAR_INTEGER;
        break;

    case CONFIG_ITEM_FLOAT:
        i_type = VLC_VAR_FLOAT;
        break;

    case CONFIG_ITEM_MODULE:
    case CONFIG_ITEM_MODULE_CAT:
    case CONFIG_ITEM_MODULE_LIST:
    case CONFIG_ITEM_MODULE_LIST_CAT:
    case CONFIG_ITEM_STRING:
    case CONFIG_ITEM_PASSWORD:
113 114
    case CONFIG_ITEM_LOADFILE:
    case CONFIG_ITEM_SAVEFILE:
115
    case CONFIG_ITEM_DIRECTORY:
116
    case CONFIG_ITEM_KEY:
117
        i_type = VLC_VAR_STRING;
118 119 120 121 122 123 124 125 126 127
        break;

    default:
        i_type = 0;
        break;
    }

    return i_type;
}

128
#undef config_GetInt
129 130 131 132 133 134 135
/*****************************************************************************
 * config_GetInt: get the value of an int variable
 *****************************************************************************
 * This function is used to get the value of variables which are internally
 * represented by an integer (CONFIG_ITEM_INTEGER and
 * CONFIG_ITEM_BOOL).
 *****************************************************************************/
136
int64_t config_GetInt( vlc_object_t *p_this, const char *psz_name )
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
{
    module_config_t *p_config;

    p_config = config_FindConfig( p_this, psz_name );

    /* sanity checks */
    if( !p_config )
    {
        msg_Err( p_this, "option %s does not exist", psz_name );
        return -1;
    }

    if (!IsConfigIntegerType (p_config->i_type))
    {
        msg_Err( p_this, "option %s does not refer to an int", psz_name );
        return -1;
    }

155
    int64_t val;
156 157 158 159 160

    vlc_rwlock_rdlock (&config_lock);
    val = p_config->value.i;
    vlc_rwlock_unlock (&config_lock);
    return val;
161 162
}

163
#undef config_GetFloat
164 165 166 167 168 169
/*****************************************************************************
 * config_GetFloat: get the value of a float variable
 *****************************************************************************
 * This function is used to get the value of variables which are internally
 * represented by a float (CONFIG_ITEM_FLOAT).
 *****************************************************************************/
170
float config_GetFloat( vlc_object_t *p_this, const char *psz_name )
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
{
    module_config_t *p_config;

    p_config = config_FindConfig( p_this, psz_name );

    /* sanity checks */
    if( !p_config )
    {
        msg_Err( p_this, "option %s does not exist", psz_name );
        return -1;
    }

    if (!IsConfigFloatType (p_config->i_type))
    {
        msg_Err( p_this, "option %s does not refer to a float", psz_name );
        return -1;
    }

189 190 191 192 193 194
    float val;

    vlc_rwlock_rdlock (&config_lock);
    val = p_config->value.f;
    vlc_rwlock_unlock (&config_lock);
    return val;
195 196
}

197
#undef config_GetPsz
198 199 200 201
/*****************************************************************************
 * config_GetPsz: get the string value of a string variable
 *****************************************************************************
 * This function is used to get the value of variables which are internally
202
 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_*FILE,
203 204 205 206 207 208
 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
 *
 * Important note: remember to free() the returned char* because it's a
 *   duplicate of the actual value. It isn't safe to return a pointer to the
 *   actual value as it can be modified at any time.
 *****************************************************************************/
209
char * config_GetPsz( vlc_object_t *p_this, const char *psz_name )
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
{
    module_config_t *p_config;

    p_config = config_FindConfig( p_this, psz_name );

    /* sanity checks */
    if( !p_config )
    {
        msg_Err( p_this, "option %s does not exist", psz_name );
        return NULL;
    }

    if (!IsConfigStringType (p_config->i_type))
    {
        msg_Err( p_this, "option %s does not refer to a string", psz_name );
        return NULL;
    }

    /* return a copy of the string */
229
    vlc_rwlock_rdlock (&config_lock);
230
    char *psz_value = strdupnull (p_config->value.psz);
231
    vlc_rwlock_unlock (&config_lock);
232 233 234 235

    return psz_value;
}

236
#undef config_PutPsz
237 238 239 240
/*****************************************************************************
 * config_PutPsz: set the string value of a string variable
 *****************************************************************************
 * This function is used to set the value of variables which are internally
241
 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_*FILE,
242 243
 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
 *****************************************************************************/
244
void config_PutPsz( vlc_object_t *p_this,
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
                      const char *psz_name, const char *psz_value )
{
    module_config_t *p_config;

    p_config = config_FindConfig( p_this, psz_name );


    /* sanity checks */
    if( !p_config )
    {
        msg_Warn( p_this, "option %s does not exist", psz_name );
        return;
    }

    if (!IsConfigStringType (p_config->i_type))
    {
        msg_Err( p_this, "option %s does not refer to a string", psz_name );
        return;
    }

265
    char *str, *oldstr;
266 267 268 269
    if ((psz_value != NULL) && *psz_value)
        str = strdup (psz_value);
    else
        str = NULL;
270

271
    vlc_rwlock_wrlock (&config_lock);
272
    oldstr = (char *)p_config->value.psz;
273
    p_config->value.psz = str;
274
    p_config->b_dirty = true;
275
    vlc_rwlock_unlock (&config_lock);
276

277
    free (oldstr);
278 279
}

280
#undef config_PutInt
281 282 283 284 285 286 287
/*****************************************************************************
 * config_PutInt: set the integer value of an int variable
 *****************************************************************************
 * This function is used to set the value of variables which are internally
 * represented by an integer (CONFIG_ITEM_INTEGER and
 * CONFIG_ITEM_BOOL).
 *****************************************************************************/
288 289
void config_PutInt( vlc_object_t *p_this, const char *psz_name,
                    int64_t i_value )
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
{
    module_config_t *p_config;

    p_config = config_FindConfig( p_this, psz_name );

    /* sanity checks */
    if( !p_config )
    {
        msg_Warn( p_this, "option %s does not exist", psz_name );
        return;
    }

    if (!IsConfigIntegerType (p_config->i_type))
    {
        msg_Err( p_this, "option %s does not refer to an int", psz_name );
        return;
    }

308
    if (i_value < p_config->min.i)
309
        i_value = p_config->min.i;
310
    if (i_value > p_config->max.i)
311
        i_value = p_config->max.i;
312

313 314 315 316
    vlc_rwlock_wrlock (&config_lock);
    p_config->value.i = i_value;
    p_config->b_dirty = true;
    vlc_rwlock_unlock (&config_lock);
317 318
}

319
#undef config_PutFloat
320 321 322 323 324 325
/*****************************************************************************
 * config_PutFloat: set the value of a float variable
 *****************************************************************************
 * This function is used to set the value of variables which are internally
 * represented by a float (CONFIG_ITEM_FLOAT).
 *****************************************************************************/
326 327
void config_PutFloat( vlc_object_t *p_this,
                      const char *psz_name, float f_value )
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
{
    module_config_t *p_config;

    p_config = config_FindConfig( p_this, psz_name );

    /* sanity checks */
    if( !p_config )
    {
        msg_Warn( p_this, "option %s does not exist", psz_name );
        return;
    }

    if (!IsConfigFloatType (p_config->i_type))
    {
        msg_Err( p_this, "option %s does not refer to a float", psz_name );
        return;
    }

    /* if f_min == f_max == 0, then do not use them */
    if ((p_config->min.f == 0) && (p_config->max.f == 0))
348
        ;
349
    else if (f_value < p_config->min.f)
350
        f_value = p_config->min.f;
351
    else if (f_value > p_config->max.f)
352
        f_value = p_config->max.f;
353

354 355 356 357
    vlc_rwlock_wrlock (&config_lock);
    p_config->value.f = f_value;
    p_config->b_dirty = true;
    vlc_rwlock_unlock (&config_lock);
358 359
}

360
static int confcmp (const void *a, const void *b)
361
{
362
    const module_config_t *const *ca = a, *const *cb = b;
363

364 365
    return strcmp ((*ca)->psz_name, (*cb)->psz_name);
}
366

367 368 369
static int confnamecmp (const void *key, const void *elem)
{
    const module_config_t *const *conf = elem;
370

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
    return strcmp (key, (*conf)->psz_name);
}

static struct
{
    module_config_t **list;
    size_t count;
} config = { NULL, 0 };

/**
 * Index the configuration items by name for faster lookups.
 */
int config_SortConfig (void)
{
    size_t nmod;
    module_t **mlist = module_list_get (&nmod);
    if (unlikely(mlist == NULL))
        return VLC_ENOMEM;

    size_t nconf = 0;
    for (size_t i = 0; i < nmod; i++)
         nconf  += mlist[i]->confsize;

    module_config_t **clist = malloc (sizeof (*clist) * nconf);
    if (unlikely(clist == NULL))
396
    {
397 398 399
        module_list_free (mlist);
        return VLC_ENOMEM;
    }
400

401 402 403 404 405
    nconf = 0;
    for (size_t i = 0; i < nmod; i++)
    {
        module_t *parser = mlist[i];
        module_config_t *item, *end;
406

407 408 409
        for (item = parser->p_config, end = item + parser->confsize;
             item < end;
             item++)
410
        {
411 412 413
            if (item->i_type & CONFIG_HINT)
                continue; /* ignore hints */
            clist[nconf++] = item;
414 415
        }
    }
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    module_list_free (mlist);

    qsort (clist, nconf, sizeof (*clist), confcmp);

    config.list = clist;
    config.count = nconf;
    return VLC_SUCCESS;
}

void config_UnsortConfig (void)
{
    module_config_t **clist;

    clist = config.list;
    config.list = NULL;
    config.count = 0;

Rémi Duraffort's avatar
Rémi Duraffort committed
433
    free (clist);
434 435 436 437 438 439 440 441 442 443 444 445 446
}

/*****************************************************************************
 * config_FindConfig: find the config structure associated with an option.
 *****************************************************************************
 * FIXME: remove p_this pointer parameter (or use it)
 *****************************************************************************/
module_config_t *config_FindConfig (vlc_object_t *p_this, const char *name)
{
    VLC_UNUSED(p_this);

    if (unlikely(name == NULL))
        return NULL;
447

448 449 450
    module_config_t *const *p;
    p = bsearch (name, config.list, config.count, sizeof (*p), confnamecmp);
    return p ? *p : NULL;
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
}

/*****************************************************************************
 * config_Free: frees a duplicated module's configuration data.
 *****************************************************************************
 * This function frees all the data duplicated by config_Duplicate.
 *****************************************************************************/
void config_Free( module_t *p_module )
{
    int i;

    for (size_t j = 0; j < p_module->confsize; j++)
    {
        module_config_t *p_item = p_module->p_config + j;

466 467 468 469
        free( p_item->psz_type );
        free( p_item->psz_name );
        free( p_item->psz_text );
        free( p_item->psz_longtext );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
470
        free( p_item->psz_oldname );
471 472 473

        if (IsConfigStringType (p_item->i_type))
        {
474 475
            free (p_item->value.psz);
            free (p_item->orig.psz);
476 477
        }

478 479 480 481 482 483 484 485 486
        if( p_item->ppsz_list )
            for( i = 0; i < p_item->i_list; i++ )
                free( p_item->ppsz_list[i] );
        if( p_item->ppsz_list_text )
            for( i = 0; i < p_item->i_list; i++ )
                free( p_item->ppsz_list_text[i] );
        free( p_item->ppsz_list );
        free( p_item->ppsz_list_text );
        free( p_item->pi_list );
487 488 489 490 491

        if( p_item->i_action )
        {
            for( i = 0; i < p_item->i_action; i++ )
            {
492
                free( p_item->ppsz_action_text[i] );
493
            }
494 495
            free( p_item->ppf_action );
            free( p_item->ppsz_action_text );
496 497 498
        }
    }

499 500
    free (p_module->p_config);
    p_module->p_config = NULL;
501 502
}

503
#undef config_ResetAll
504 505 506
/*****************************************************************************
 * config_ResetAll: reset the configuration data for all the modules.
 *****************************************************************************/
507
void config_ResetAll( vlc_object_t *p_this )
508
{
Pierre's avatar
Pierre committed
509
    VLC_UNUSED(p_this);
510
    module_t *p_module;
511
    module_t **list = module_list_get (NULL);
512

513
    vlc_rwlock_wrlock (&config_lock);
514
    for (size_t j = 0; (p_module = list[j]) != NULL; j++)
515 516 517 518 519
    {
        if( p_module->b_submodule ) continue;

        for (size_t i = 0; i < p_module->confsize; i++ )
        {
520 521 522 523
            module_config_t *p_config = p_module->p_config + i;

            if (IsConfigIntegerType (p_config->i_type))
                p_config->value.i = p_config->orig.i;
524
            else
525 526
            if (IsConfigFloatType (p_config->i_type))
                p_config->value.f = p_config->orig.f;
527
            else
528
            if (IsConfigStringType (p_config->i_type))
529
            {
530 531 532
                free ((char *)p_config->value.psz);
                p_config->value.psz =
                        strdupnull (p_config->orig.psz);
533 534 535
            }
        }
    }
536
    vlc_rwlock_unlock (&config_lock);
537

538
    module_list_free (list);
539
}