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