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