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