control/http:
[vlc.git] / modules / control / http / mvar.c
1 /*****************************************************************************
2  * mvar.c : Variables handling for the HTTP Interface
3  *****************************************************************************
4  * Copyright (C) 2001-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
8  *          Laurent Aimar <fenrir@via.ecp.fr>
9  *          Christophe Massiot <massiot@via.ecp.fr>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include "http.h"
30 #include <limits.h>
31
32 /* Utility function for scandir */
33 static int Filter( const char *foo )
34 {
35     return strcmp( foo, "." );
36 };
37
38 static int InsensitiveAlphasort( const char **foo1,
39                                  const char **foo2 )
40 {
41     return strcasecmp( *foo1, *foo2 );
42 };
43
44
45
46 mvar_t *E_(mvar_New)( const char *name, const char *value )
47 {
48     mvar_t *v = malloc( sizeof( mvar_t ) );
49
50     if( !v ) return NULL;
51     v->name = strdup( name );
52     v->value = strdup( value ? value : "" );
53
54     v->i_field = 0;
55     v->field = malloc( sizeof( mvar_t * ) );
56     v->field[0] = NULL;
57
58     return v;
59 }
60
61 void E_(mvar_Delete)( mvar_t *v )
62 {
63     int i;
64
65     free( v->name );
66     free( v->value );
67
68     for( i = 0; i < v->i_field; i++ )
69     {
70         E_(mvar_Delete)( v->field[i] );
71     }
72     free( v->field );
73     free( v );
74 }
75
76 void E_(mvar_AppendVar)( mvar_t *v, mvar_t *f )
77 {
78     v->field = realloc( v->field, sizeof( mvar_t * ) * ( v->i_field + 2 ) );
79     v->field[v->i_field] = f;
80     v->i_field++;
81 }
82
83 mvar_t *E_(mvar_Duplicate)( const mvar_t *v )
84 {
85     int i;
86     mvar_t *n;
87
88     n = E_(mvar_New)( v->name, v->value );
89     for( i = 0; i < v->i_field; i++ )
90     {
91         E_(mvar_AppendVar)( n, E_(mvar_Duplicate)( v->field[i] ) );
92     }
93
94     return n;
95 }
96
97 void E_(mvar_PushVar)( mvar_t *v, mvar_t *f )
98 {
99     v->field = realloc( v->field, sizeof( mvar_t * ) * ( v->i_field + 2 ) );
100     if( v->i_field > 0 )
101     {
102         memmove( &v->field[1], &v->field[0], sizeof( mvar_t * ) * v->i_field );
103     }
104     v->field[0] = f;
105     v->i_field++;
106 }
107
108 void E_(mvar_RemoveVar)( mvar_t *v, mvar_t *f )
109 {
110     int i;
111     for( i = 0; i < v->i_field; i++ )
112     {
113         if( v->field[i] == f )
114         {
115             break;
116         }
117     }
118     if( i >= v->i_field )
119     {
120         return;
121     }
122
123     if( i + 1 < v->i_field )
124     {
125         memmove( &v->field[i], &v->field[i+1], sizeof( mvar_t * ) * ( v->i_field - i - 1 ) );
126     }
127     v->i_field--;
128     /* FIXME should do a realloc */
129 }
130
131 mvar_t *E_(mvar_GetVar)( mvar_t *s, const char *name )
132 {
133     /* format: name[index].field */
134     const char *field = strchr( name, '.' );
135     char base[1 + (field ? (size_t)(field - name) : strlen( name ))];
136     char *p;
137     int i_index, i;
138
139     strlcpy( base, name, sizeof (base) );
140     if( field != NULL )
141         field++;
142
143     if( ( p = strchr( base, '[' ) ) != NULL )
144     {
145         char *end;
146         unsigned long l = strtoul( p, &end, 0 );
147
148         if( ( l > INT_MAX ) || strcmp( "]", end ) )
149             return NULL;
150
151         *p++ = '\0';
152         i_index = (int)l;
153     }
154     else
155     {
156         i_index = 0;
157     }
158
159     for( i = 0; i < s->i_field; i++ )
160     {
161         if( !strcmp( s->field[i]->name, base ) )
162         {
163             if( i_index > 0 )
164             {
165                 i_index--;
166             }
167             else
168             {
169                 if( field )
170                 {
171                     return E_(mvar_GetVar)( s->field[i], field );
172                 }
173                 else
174                 {
175                     return s->field[i];
176                 }
177             }
178         }
179     }
180     return NULL;
181 }
182
183 char *E_(mvar_GetValue)( mvar_t *v, char *field )
184 {
185     if( *field == '\0' )
186     {
187         return v->value;
188     }
189     else
190     {
191         mvar_t *f = E_(mvar_GetVar)( v, field );
192         if( f )
193         {
194             return f->value;
195         }
196         else
197         {
198             return field;
199         }
200     }
201 }
202
203 void E_(mvar_PushNewVar)( mvar_t *vars, const char *name,
204                           const char *value )
205 {
206     mvar_t *f = E_(mvar_New)( name, value );
207     E_(mvar_PushVar)( vars, f );
208 }
209
210 void E_(mvar_AppendNewVar)( mvar_t *vars, const char *name,
211                             const char *value )
212 {
213     mvar_t *f = E_(mvar_New)( name, value );
214     E_(mvar_AppendVar)( vars, f );
215 }
216
217
218 /* arg= start[:stop[:step]],.. */
219 mvar_t *E_(mvar_IntegerSetNew)( const char *name, const char *arg )
220 {
221     char *dup = strdup( arg );
222     char *str = dup;
223     mvar_t *s = E_(mvar_New)( name, "set" );
224
225     while( str )
226     {
227         char *p;
228         int  i_start,i_stop,i_step;
229         int  i_match;
230
231         p = strchr( str, ',' );
232         if( p )
233         {
234             *p++ = '\0';
235         }
236
237         i_step = 0;
238         i_match = sscanf( str, "%d:%d:%d", &i_start, &i_stop, &i_step );
239
240         if( i_match == 1 )
241         {
242             i_stop = i_start;
243             i_step = 1;
244         }
245         else if( i_match == 2 )
246         {
247             i_step = i_start < i_stop ? 1 : -1;
248         }
249
250         if( i_match >= 1 )
251         {
252             int i;
253
254             if( ( i_start <= i_stop && i_step > 0 ) ||
255                 ( i_start >= i_stop && i_step < 0 ) )
256             {
257                 for( i = i_start; ; i += i_step )
258                 {
259                     char   value[79];
260
261                     if( ( i_step > 0 && i > i_stop ) ||
262                         ( i_step < 0 && i < i_stop ) )
263                     {
264                         break;
265                     }
266
267                     sprintf( value, "%d", i );
268
269                     E_(mvar_PushNewVar)( s, name, value );
270                 }
271             }
272         }
273         str = p;
274     }
275
276     free( dup );
277     return s;
278 }
279
280 /********************************************************************
281  * Special sets handling
282  ********************************************************************/
283
284 mvar_t *E_(mvar_PlaylistSetNew)( intf_thread_t *p_intf, char *name,
285                                  playlist_t *p_pl )
286 {
287     mvar_t *s = E_(mvar_New)( name, "set" );
288     vlc_mutex_lock( &p_pl->object_lock );
289     E_(PlaylistListNode)( p_intf, p_pl, p_pl->p_root_category , name, s, 0 );
290     vlc_mutex_unlock( &p_pl->object_lock );
291     return s;
292 }
293
294 mvar_t *E_(mvar_InfoSetNew)( char *name, input_thread_t *p_input )
295 {
296     mvar_t *s = E_(mvar_New)( name, "set" );
297     int i, j;
298
299     if( p_input == NULL || p_input->p == NULL /* workarround assert in input_GetItem */ )
300     {
301         return s;
302     }
303
304     vlc_mutex_lock( &input_GetItem(p_input)->lock );
305     for ( i = 0; i < input_GetItem(p_input)->i_categories; i++ )
306     {
307         info_category_t *p_category = input_GetItem(p_input)->pp_categories[i];
308
309         mvar_t *cat  = E_(mvar_New)( name, "set" );
310         mvar_t *iset = E_(mvar_New)( "info", "set" );
311
312         E_(mvar_AppendNewVar)( cat, "name", p_category->psz_name );
313         E_(mvar_AppendVar)( cat, iset );
314
315         for ( j = 0; j < p_category->i_infos; j++ )
316         {
317             info_t *p_info = p_category->pp_infos[j];
318             mvar_t *info = E_(mvar_New)( "info", "" );
319
320             /* msg_Dbg( p_input, "adding info name=%s value=%s",
321                      psz_name, psz_value ); */
322             E_(mvar_AppendNewVar)( info, "name",  p_info->psz_name );
323             E_(mvar_AppendNewVar)( info, "value", p_info->psz_value );
324             E_(mvar_AppendVar)( iset, info );
325         }
326         E_(mvar_AppendVar)( s, cat );
327     }
328     vlc_mutex_unlock( &input_GetItem(p_input)->lock );
329
330     return s;
331 }
332
333 mvar_t *E_(mvar_ObjectSetNew)( intf_thread_t *p_intf, char *psz_name,
334                                const char *psz_capability )
335 {
336     mvar_t *s = E_(mvar_New)( psz_name, "set" );
337     int i;
338
339     vlc_list_t *p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE,
340                                         FIND_ANYWHERE );
341
342     for( i = 0; i < p_list->i_count; i++ )
343     {
344         module_t *p_parser = (module_t *)p_list->p_values[i].p_object;
345         if( module_IsCapable( p_parser, psz_capability ) )
346         {
347             mvar_t *sd = E_(mvar_New)( "sd", module_GetObjName( p_parser ) );
348             E_(mvar_AppendNewVar)( sd, "name",
349                                    module_GetName( p_parser, VLC_TRUE ) );
350             E_(mvar_AppendVar)( s, sd );
351         }
352     }
353
354     vlc_list_release( p_list );
355
356     return s;
357 }
358
359 mvar_t *E_(mvar_InputVarSetNew)( intf_thread_t *p_intf, char *name,
360                                  input_thread_t *p_input,
361                                  const char *psz_variable )
362 {
363     intf_sys_t     *p_sys = p_intf->p_sys;
364     mvar_t *s = E_(mvar_New)( name, "set" );
365     vlc_value_t val, val_list, text_list;
366     int i_type, i;
367
368     if( p_input == NULL )
369     {
370         return s;
371     }
372
373     /* Check the type of the object variable */
374     i_type = var_Type( p_sys->p_input, psz_variable );
375
376     /* Make sure we want to display the variable */
377     if( i_type & VLC_VAR_HASCHOICE )
378     {
379         var_Change( p_sys->p_input, psz_variable, VLC_VAR_CHOICESCOUNT, &val, NULL );
380         if( val.i_int == 0 ) return s;
381         if( (i_type & VLC_VAR_TYPE) != VLC_VAR_VARIABLE && val.i_int == 1 )
382             return s;
383     }
384     else
385     {
386         return s;
387     }
388
389     switch( i_type & VLC_VAR_TYPE )
390     {
391     case VLC_VAR_VOID:
392     case VLC_VAR_BOOL:
393     case VLC_VAR_VARIABLE:
394     case VLC_VAR_STRING:
395     case VLC_VAR_INTEGER:
396         break;
397     default:
398         /* Variable doesn't exist or isn't handled */
399         return s;
400     }
401
402     if( var_Get( p_sys->p_input, psz_variable, &val ) < 0 )
403     {
404         return s;
405     }
406
407     if( var_Change( p_sys->p_input, psz_variable, VLC_VAR_GETLIST,
408                     &val_list, &text_list ) < 0 )
409     {
410         if( (i_type & VLC_VAR_TYPE) == VLC_VAR_STRING ) free( val.psz_string );
411         return s;
412     }
413
414     for( i = 0; i < val_list.p_list->i_count; i++ )
415     {
416         char *psz, psz_int[16];
417         mvar_t *itm;
418
419         switch( i_type & VLC_VAR_TYPE )
420         {
421         case VLC_VAR_STRING:
422             itm = E_(mvar_New)( name, "set" );
423             /* FIXME: Memory leak here?? (remove strdup?) */
424             psz = strdup( text_list.p_list->p_values[i].psz_string );
425             E_(mvar_AppendNewVar)( itm, "name", psz );
426             E_(mvar_AppendNewVar)( itm, "id", val_list.p_list->p_values[i].psz_string );
427             snprintf( psz_int, sizeof(psz_int), "%d",
428                       ( !strcmp( val.psz_string,
429                                    val_list.p_list->p_values[i].psz_string )
430                            && !( i_type & VLC_VAR_ISCOMMAND ) ) );
431             E_(mvar_AppendNewVar)( itm, "selected", psz_int );
432             E_(mvar_AppendVar)( s, itm );
433             break;
434
435         case VLC_VAR_INTEGER:
436             itm = E_(mvar_New)( name, "set" );
437             psz = strdup( text_list.p_list->p_values[i].psz_string );
438             E_(mvar_AppendNewVar)( itm, "name", psz );
439             snprintf( psz_int, sizeof(psz_int), "%d",
440                       val_list.p_list->p_values[i].i_int );
441             E_(mvar_AppendNewVar)( itm, "id", psz_int );
442             snprintf( psz_int, sizeof(psz_int), "%d",
443                       ( val.i_int == val_list.p_list->p_values[i].i_int )
444                          && !( i_type & VLC_VAR_ISCOMMAND ) );
445             E_(mvar_AppendNewVar)( itm, "selected", psz_int );
446             E_(mvar_AppendVar)( s, itm );
447             break;
448
449         default:
450             break;
451         }
452     }
453     /* clean up everything */
454     if( (i_type & VLC_VAR_TYPE) == VLC_VAR_STRING ) free( val.psz_string );
455     var_Change( p_sys->p_input, psz_variable, VLC_VAR_FREELIST, &val_list,
456                 &text_list );
457     return s;
458 }
459
460 #if 0
461 mvar_t *E_(mvar_HttpdInfoSetNew)( char *name, httpd_t *p_httpd, int i_type )
462 {
463     mvar_t       *s = E_(mvar_New)( name, "set" );
464     httpd_info_t info;
465     int          i;
466
467     if( !p_httpd->pf_control( p_httpd, i_type, &info, NULL ) )
468     {
469         for( i= 0; i < info.i_count; )
470         {
471             mvar_t *inf;
472
473             inf = E_(mvar_New)( name, "set" );
474             do
475             {
476                 /* fprintf( stderr," mvar_HttpdInfoSetNew: append name=`%s' value=`%s'\n",
477                             info.info[i].psz_name, info.info[i].psz_value ); */
478                 E_(mvar_AppendNewVar)( inf,
479                                    info.info[i].psz_name,
480                                    info.info[i].psz_value );
481                 i++;
482             } while( i < info.i_count && strcmp( info.info[i].psz_name, "id" ) );
483             E_(mvar_AppendVar)( s, inf );
484         }
485     }
486
487     /* free mem */
488     for( i = 0; i < info.i_count; i++ )
489     {
490         free( info.info[i].psz_name );
491         free( info.info[i].psz_value );
492     }
493     if( info.i_count > 0 )
494     {
495         free( info.info );
496     }
497
498     return s;
499 }
500 #endif
501
502 mvar_t *E_(mvar_FileSetNew)( intf_thread_t *p_intf, char *name,
503                              char *psz_dir )
504 {
505     mvar_t *s = E_(mvar_New)( name, "set" );
506 #ifdef HAVE_SYS_STAT_H
507     struct stat   stat_info;
508 #endif
509     char        **ppsz_dir_content;
510     int           i_dir_content, i;
511     psz_dir = E_(RealPath)( p_intf, psz_dir );
512
513 #ifdef HAVE_SYS_STAT_H
514     if( (utf8_stat( psz_dir, &stat_info ) == -1 )
515      || !S_ISDIR( stat_info.st_mode )
516 #   if defined( WIN32 )
517           && psz_dir[0] != '\0' && (psz_dir[0] != '\\' || psz_dir[1] != '\0')
518 #   endif
519       )
520     {
521         free( psz_dir );
522         return s;
523     }
524 #endif
525
526     /* parse psz_src dir */
527     if( ( i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content, Filter,
528                                         InsensitiveAlphasort ) ) == -1 )
529     {
530         msg_Warn( p_intf, "error while scanning dir %s (%m)", psz_dir );
531         free( psz_dir );
532         return s;
533     }
534
535     for( i = 0; i < i_dir_content; i++ )
536     {
537         char *psz_name = ppsz_dir_content[i], *psz_ext, *psz_dummy;
538         char psz_tmp[strlen( psz_dir ) + 1 + strlen( psz_name ) + 1];
539         mvar_t *f;
540
541 #if defined( WIN32 )
542         if( psz_dir[0] == '\0' || (psz_dir[0] == '\\' && psz_dir[1] == '\0') )
543         {
544             strcpy( psz_tmp, psz_name );
545         }
546         else
547 #endif
548         {
549             sprintf( psz_tmp, "%s"DIR_SEP"%s", psz_dir, psz_name );
550
551 #ifdef HAVE_SYS_STAT_H
552             if( utf8_stat( psz_tmp, &stat_info ) == -1 )
553             {
554                 free( psz_name );
555                 continue;
556             }
557 #endif
558         }
559         f = E_(mvar_New)( name, "set" );
560
561         /* put lower-case file extension in 'ext' */
562         psz_ext = strrchr( psz_name, '.' );
563         psz_ext = strdup( psz_ext != NULL ? psz_ext + 1 : "" );
564         for( psz_dummy = psz_ext; *psz_dummy != '\0'; psz_dummy++ )
565             *psz_dummy = tolower( *psz_dummy );
566
567         E_(mvar_AppendNewVar)( f, "ext", psz_ext );
568         free( psz_ext );
569
570 #if defined( WIN32 )
571         if( psz_dir[0] == '\0' || (psz_dir[0] == '\\' && psz_dir[1] == '\0') )
572         {
573             char psz_tmp[3];
574             sprintf( psz_tmp, "%c:", psz_name[0] );
575             E_(mvar_AppendNewVar)( f, "name", psz_name );
576             E_(mvar_AppendNewVar)( f, "basename", psz_tmp );
577             E_(mvar_AppendNewVar)( f, "type", "directory" );
578             E_(mvar_AppendNewVar)( f, "size", "unknown" );
579             E_(mvar_AppendNewVar)( f, "date", "unknown" );
580         }
581         else
582 #endif
583         {
584             char psz_ctime[26];
585             char psz_tmp[strlen( psz_dir ) + 1 + strlen( psz_name ) + 1];
586
587             sprintf( psz_tmp, "%s"DIR_SEP"%s", psz_dir, psz_name );
588             E_(mvar_AppendNewVar)( f, "name", psz_tmp );
589             E_(mvar_AppendNewVar)( f, "basename", psz_name );
590
591 #ifdef HAVE_SYS_STAT_H
592             if( S_ISDIR( stat_info.st_mode ) )
593             {
594                 E_(mvar_AppendNewVar)( f, "type", "directory" );
595             }
596             else if( S_ISREG( stat_info.st_mode ) )
597             {
598                 E_(mvar_AppendNewVar)( f, "type", "file" );
599             }
600             else
601             {
602                 E_(mvar_AppendNewVar)( f, "type", "unknown" );
603             }
604
605             sprintf( psz_ctime, I64Fd, (int64_t)stat_info.st_size );
606             E_(mvar_AppendNewVar)( f, "size", psz_ctime );
607
608             /* FIXME memory leak FIXME */
609 #   ifdef HAVE_CTIME_R
610             ctime_r( &stat_info.st_mtime, psz_ctime );
611             E_(mvar_AppendNewVar)( f, "date", psz_ctime );
612 #   else
613             E_(mvar_AppendNewVar)( f, "date", ctime( &stat_info.st_mtime ) );
614 #   endif
615
616 #else
617             E_(mvar_AppendNewVar)( f, "type", "unknown" );
618             E_(mvar_AppendNewVar)( f, "size", "unknown" );
619             E_(mvar_AppendNewVar)( f, "date", "unknown" );
620 #endif
621         }
622
623         E_(mvar_AppendVar)( s, f );
624
625         free( psz_name );
626     }
627
628     free( psz_dir );
629     if( ppsz_dir_content != NULL )
630         free( ppsz_dir_content );
631     return s;
632 }
633
634 void E_(mvar_VlmSetNewLoop)( char *name, vlm_t *vlm, mvar_t *s, vlm_message_t *el, vlc_bool_t b_name );
635 void E_(mvar_VlmSetNewLoop)( char *name, vlm_t *vlm, mvar_t *s, vlm_message_t *el, vlc_bool_t b_name )
636 {
637     /* Over name */
638     mvar_t        *set;
639     int k;
640
641     /* Add a node with name and info */
642     set = E_(mvar_New)( name, "set" );
643     if( b_name == VLC_TRUE )
644     {
645         E_(mvar_AppendNewVar)( set, "name", el->psz_name );
646     }
647
648     for( k = 0; k < el->i_child; k++ )
649     {
650         vlm_message_t *ch = el->child[k];
651         if( ch->i_child > 0 )
652         {
653             E_(mvar_VlmSetNewLoop)( ch->psz_name, vlm, set, ch, VLC_FALSE );
654         }
655         else
656         {
657             if( ch->psz_value )
658             {
659                 E_(mvar_AppendNewVar)( set, ch->psz_name, ch->psz_value );
660             }
661             else
662             {
663                 E_(mvar_AppendNewVar)( set, el->psz_name, ch->psz_name );
664             }
665         }
666     }
667
668     E_(mvar_AppendVar)( s, set );
669 }
670
671 mvar_t *E_(mvar_VlmSetNew)( char *name, vlm_t *vlm )
672 {
673     mvar_t        *s = E_(mvar_New)( name, "set" );
674     vlm_message_t *msg;
675     int    i;
676
677     if( vlm == NULL ) return s;
678
679     if( vlm_ExecuteCommand( vlm, "show", &msg ) )
680     {
681         return s;
682     }
683
684     for( i = 0; i < msg->i_child; i++ )
685     {
686         /* Over media, schedule */
687         vlm_message_t *ch = msg->child[i];
688         int j;
689
690         for( j = 0; j < ch->i_child; j++ )
691         {
692             /* Over name */
693             vlm_message_t *el = ch->child[j];
694             vlm_message_t *inf, *desc;
695             char          psz[6 + strlen(el->psz_name)];
696
697             sprintf( psz, "show %s", el->psz_name );
698             if( vlm_ExecuteCommand( vlm, psz, &inf ) )
699                 continue;
700             desc = inf->child[0];
701
702             E_(mvar_VlmSetNewLoop)( el->psz_name, vlm, s, desc, VLC_TRUE );
703
704             vlm_MessageDelete( inf );
705         }
706     }
707     vlm_MessageDelete( msg );
708
709     return s;
710 }