1 /*****************************************************************************
2 * macro.c : Custom <vlc> macro handling
3 *****************************************************************************
4 * Copyright (C) 2001-2005 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * Christophe Massiot <massiot@via.ecp.fr>
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.
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.
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 *****************************************************************************/
33 static int MacroParse( macro_t *m, char *psz_src )
35 char *dup = strdup( (char *)psz_src );
40 #define EXTRACT( name, l ) \
42 p = strchr( src, '"' ); \
47 m->name = strdup( src ); \
68 if( !strncmp( src, "id=\"", 4 ) )
72 else if( !strncmp( src, "param1=\"", 8 ) )
76 else if( !strncmp( src, "param2=\"", 8 ) )
85 if( strstr( src, "/>" ) )
87 src = strstr( src, "/>" ) + 2;
98 if( m->param1 == NULL )
100 m->param1 = strdup( "" );
102 if( m->param2 == NULL )
104 m->param2 = strdup( "" );
113 static void MacroClean( macro_t *m )
120 static int StrToMacroType( const char *name )
124 if( !name || *name == '\0')
128 for( i = 0; StrToMacroTypeTab[i].psz_name != NULL; i++ )
130 if( !strcmp( name, StrToMacroTypeTab[i].psz_name ) )
132 return StrToMacroTypeTab[i].i_type;
138 static void MacroDo( httpd_file_sys_t *p_args,
140 char *p_request, int i_request,
141 char **pp_data, int *pi_data,
144 intf_thread_t *p_intf = p_args->p_intf;
145 intf_sys_t *p_sys = p_args->p_intf->p_sys;
150 int __i__ = *pp_dst - *pp_data; \
152 *pp_data = realloc( *pp_data, *pi_data ); \
153 *pp_dst = (*pp_data) + __i__; \
155 #define PRINT( str ) \
156 ALLOC( strlen( str ) + 1 ); \
157 *pp_dst += sprintf( *pp_dst, "%s", str );
159 #define PRINTS( str, s ) \
160 ALLOC( strlen( str ) + strlen( s ) + 1 ); \
162 char * psz_cur = *pp_dst; \
163 *pp_dst += sprintf( *pp_dst, str, s ); \
164 while( psz_cur && *psz_cur ) \
166 /* Prevent script injection */ \
167 if( *psz_cur == '<' ) *psz_cur = '*'; \
168 if( *psz_cur == '>' ) *psz_cur = '*'; \
173 switch( StrToMacroType( m->id ) )
180 ExtractURIValue( p_request, "control", control, 512 );
181 if( *m->param1 && !strstr( m->param1, control ) )
183 msg_Warn( p_intf, "unauthorized control=%s", control );
186 switch( StrToMacroType( control ) )
193 ExtractURIValue( p_request, "item", item, 512 );
194 i_item = atoi( item );
195 /* id = 0 : simply ask playlist to play */
198 playlist_Play( p_sys->p_playlist );
199 msg_Dbg( p_intf, "requested playlist play" );
202 //TODO: really locked here ?
203 playlist_Control( p_sys->p_playlist, PLAYLIST_VIEWPLAY,
205 playlist_ItemGetById( p_sys->p_playlist,
207 msg_Dbg( p_intf, "requested playlist item: %i", i_item );
211 playlist_Control( p_sys->p_playlist, PLAYLIST_STOP,
213 msg_Dbg( p_intf, "requested playlist stop" );
216 playlist_Control( p_sys->p_playlist, PLAYLIST_PAUSE,
218 msg_Dbg( p_intf, "requested playlist pause" );
221 playlist_Control( p_sys->p_playlist, PLAYLIST_SKIP,
223 msg_Dbg( p_intf, "requested playlist next" );
226 playlist_Control( p_sys->p_playlist, PLAYLIST_SKIP,
228 msg_Dbg( p_intf, "requested playlist previous" );
230 case MVLC_FULLSCREEN:
233 vout_thread_t *p_vout;
235 p_vout = input_GetVout( p_sys->p_input );
238 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
239 vlc_object_release( p_vout );
240 msg_Dbg( p_intf, "requested fullscreen toggle" );
247 ExtractURIValue( p_request, "seek_value", value, 30 );
249 HandleSeek( p_intf, value );
255 audio_volume_t i_volume;
258 ExtractURIValue( p_request, "value", vol, 8 );
259 aout_VolumeGet( p_intf, &i_volume );
264 i_value = atoi( vol + 1 );
265 if( (i_volume + i_value) > AOUT_VOLUME_MAX )
267 aout_VolumeSet( p_intf , AOUT_VOLUME_MAX );
268 msg_Dbg( p_intf, "requested volume set: max" );
272 aout_VolumeSet( p_intf , (i_volume + i_value) );
273 msg_Dbg( p_intf, "requested volume set: +%i", (i_volume + i_value) );
276 else if( vol[0] == '-' )
278 i_value = atoi( vol + 1 );
279 if( (i_volume - i_value) < AOUT_VOLUME_MIN )
281 aout_VolumeSet( p_intf , AOUT_VOLUME_MIN );
282 msg_Dbg( p_intf, "requested volume set: min" );
286 aout_VolumeSet( p_intf , (i_volume - i_value) );
287 msg_Dbg( p_intf, "requested volume set: -%i", (i_volume - i_value) );
290 else if( strstr(vol, "%") != NULL )
292 i_value = atoi( vol );
293 if( (i_value <= 400) && (i_value>=0) ){
294 aout_VolumeSet( p_intf, (i_value * (AOUT_VOLUME_MAX - AOUT_VOLUME_MIN))/400+AOUT_VOLUME_MIN);
295 msg_Dbg( p_intf, "requested volume set: %i%%", atoi( vol ));
300 i_value = atoi( vol );
301 if( ( i_value <= AOUT_VOLUME_MAX ) && ( i_value >= AOUT_VOLUME_MIN ) )
303 aout_VolumeSet( p_intf , atoi( vol ) );
304 msg_Dbg( p_intf, "requested volume set: %i", atoi( vol ) );
310 /* playlist management */
313 char mrl[1024], psz_name[1024], tmp[1024];
315 input_item_t *p_input;
317 ExtractURIValue( p_request, "mrl", tmp, 1024 );
319 ExtractURIValue( p_request, "name", psz_name, 1024 );
320 decode_URI( psz_name );
323 memcpy( psz_name, tmp, 1024 );
325 /* addslashes for backward compatibility with the old
328 while( *str != '\0' )
330 if( *str == '"' || *str == '\'' || *str == '\\' )
339 p_input = MRLParse( p_intf, mrl, psz_name );
341 char *psz_uri = p_input ? input_item_GetURI( p_input ) : NULL;
342 if( psz_uri && *psz_uri &&
343 playlist_AddInput( p_sys->p_playlist, p_input,
344 PLAYLIST_APPEND, PLAYLIST_END,
345 true, false) == VLC_SUCCESS )
346 msg_Dbg( p_intf, "requested mrl add: %s", mrl );
348 msg_Warn( p_intf, "adding mrl failed: %s", mrl );
351 vlc_gc_decref( p_input );
357 size_t i_nb_items = 0;
359 const char *p_parser = p_request;
361 /* Get the list of items to delete */
363 ExtractURIValue( p_parser, "item", item, 512 )) )
365 if( !*item ) continue;
367 int i_item = atoi( item );
368 p_items = realloc( p_items, (i_nb_items + 1) *
370 p_items[i_nb_items] = i_item;
374 for( size_t i = 0; i < i_nb_items; i++ )
376 playlist_item_t *p_item;
378 msg_Dbg( p_intf, "requested playlist delete: %d",
380 p_item = playlist_ItemGetById( p_sys->p_playlist,
383 playlist_DeleteFromInput( p_sys->p_playlist,
394 size_t i_nb_items = 0, i;
396 const char *p_parser = p_request;
398 /* Get the list of items to keep */
400 ExtractURIValue( p_parser, "item", item, 512 )) )
402 if( !*item ) continue;
404 int i_item = atoi( item );
405 p_items = realloc( p_items, (i_nb_items + 1) *
407 p_items[i_nb_items] = i_item;
411 for( i = 0; i < p_sys->p_playlist->items.i_size; i++ )
415 /* Check if the item is in the keep list */
416 for( j = 0 ; j < i_nb_items ; j++ )
419 ARRAY_VAL(p_sys->p_playlist->items,i)->i_id)
422 if( j == i_nb_items )
424 msg_Dbg( p_intf, "requested playlist delete: %d",
425 p_sys->p_playlist->items.p_elems[i]->i_id );
426 playlist_DeleteFromInput( p_sys->p_playlist,
427 p_sys->p_playlist->items.p_elems[i]->p_input,
437 playlist_Clear( p_sys->p_playlist, false );
438 msg_Dbg( p_intf, "requested playlist empty" );
449 ExtractURIValue( p_request, "type", type, 12 );
450 ExtractURIValue( p_request, "order", order, 2 );
451 ExtractURIValue( p_request, "item", item, 512 );
452 i_item = atoi( item );
454 if( order[0] == '0' ) i_order = ORDER_NORMAL;
455 else i_order = ORDER_REVERSE;
457 if( !strcmp( type , "title" ) )
459 playlist_RecursiveNodeSort( p_sys->p_playlist,
460 /* Ugly hack,but not worse than before ... */
461 p_sys->p_playlist->p_root_onelevel,
462 SORT_TITLE_NODES_FIRST,
463 ( i_order == 0 ) ? ORDER_NORMAL : ORDER_REVERSE );
464 msg_Dbg( p_intf, "requested playlist sort by title (%d)" , i_order );
466 else if( !strcmp( type , "author" ) )
468 playlist_RecursiveNodeSort( p_sys->p_playlist, /*playlist_ItemGetById( p_sys->p_playlist, i_item ),*/
469 p_sys->p_playlist->p_root_onelevel,
471 ( i_order == 0 ) ? ORDER_NORMAL : ORDER_REVERSE );
472 msg_Dbg( p_intf, "requested playlist sort by author (%d)" , i_order );
474 else if( !strcmp( type , "shuffle" ) )
476 playlist_RecursiveNodeSort( p_sys->p_playlist, /*playlist_ItemGetById( p_sys->p_playlist, i_item ),*/
477 p_sys->p_playlist->p_root_onelevel,
479 ( i_order == 0 ) ? ORDER_NORMAL : ORDER_REVERSE );
480 msg_Dbg( p_intf, "requested playlist shuffle");
491 ExtractURIValue( p_request, "psz_pos", psz_pos, 6 );
492 ExtractURIValue( p_request, "psz_newpos", psz_newpos, 6 );
493 i_pos = atoi( psz_pos );
494 i_newpos = atoi( psz_newpos );
495 /* FIXME FIXME TODO TODO XXX XXX
496 ( duplicate from rpn.c )
497 if ( i_pos < i_newpos )
499 playlist_Move( p_sys->p_playlist, i_pos, i_newpos + 1 );
503 playlist_Move( p_sys->p_playlist, i_pos, i_newpos );
505 msg_Dbg( p_intf, "requested move playlist item %d to %d", i_pos, i_newpos);
506 FIXME FIXME TODO TODO XXX XXX */
514 ExtractURIValue( p_request, "id", id, 512 );
515 msg_Dbg( p_intf, "requested close id=%s", id );
517 if( p_sys->p_httpd->pf_control( p_sys->p_httpd, HTTPD_SET_CLOSE, id, NULL ) )
519 msg_Warn( p_intf, "close failed for id=%s", id );
526 msg_Dbg( p_intf, "requested shutdown" );
527 libvlc_Quit( p_intf->p_libvlc );
535 static const char vlm_properties[][9] =
538 "enabled", "disabled", "loop", "unloop",
540 "input", "output", "option", "date", "period",
541 "repeat", "append", "",
543 vlm_message_t *vlm_answer;
545 char *psz = malloc( strlen( p_request ) + 1000 );
550 if( p_intf->p_sys->p_vlm == NULL )
551 p_intf->p_sys->p_vlm = vlm_New( p_intf );
553 if( p_intf->p_sys->p_vlm == NULL )
559 ExtractURIValue( p_request, "name", name, 512 );
560 if( StrToMacroType( control ) == MVLC_VLM_NEW )
563 ExtractURIValue( p_request, "type", type, 20 );
564 p += sprintf( psz, "new %s %s", name, type );
568 p += sprintf( psz, "setup %s", name );
570 /* Parse the request */
571 for( i = 0; vlm_properties[i][0]; i++ )
574 ExtractURIValue( p_request,
575 vlm_properties[i], val, 512 );
577 if( strlen( val ) > 0 && i >= 4 )
579 p += sprintf( p, " %s %s", vlm_properties[i], val );
581 else if( TestURIParam( p_request, vlm_properties[i] ) && i < 4 )
583 p += sprintf( p, " %s", vlm_properties[i] );
586 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
587 if( vlm_answer->psz_value == NULL ) /* there is no error */
589 vlm_error = strdup( "" );
593 if( asprintf( &vlm_error , "%s : %s" ,
594 vlm_answer->psz_name,
595 vlm_answer->psz_value ) == -1 )
599 mvar_AppendNewVar( p_args->vars, "vlm_error", vlm_error );
601 vlm_MessageDelete( vlm_answer );
609 vlm_message_t *vlm_answer;
612 if( p_intf->p_sys->p_vlm == NULL )
613 p_intf->p_sys->p_vlm = vlm_New( p_intf );
615 if( p_intf->p_sys->p_vlm == NULL ) break;
617 ExtractURIValue( p_request, "name", name, 512 );
618 sprintf( psz, "del %s", name );
620 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
621 /* FIXME do a vlm_answer -> var stack conversion */
622 vlm_MessageDelete( vlm_answer );
631 vlm_message_t *vlm_answer;
634 if( p_intf->p_sys->p_vlm == NULL )
635 p_intf->p_sys->p_vlm = vlm_New( p_intf );
637 if( p_intf->p_sys->p_vlm == NULL ) break;
639 ExtractURIValue( p_request, "name", name, 512 );
640 if( StrToMacroType( control ) == MVLC_VLM_PLAY )
641 sprintf( psz, "control %s play", name );
642 else if( StrToMacroType( control ) == MVLC_VLM_PAUSE )
643 sprintf( psz, "control %s pause", name );
644 else if( StrToMacroType( control ) == MVLC_VLM_STOP )
645 sprintf( psz, "control %s stop", name );
646 else if( StrToMacroType( control ) == MVLC_VLM_SEEK )
649 ExtractURIValue( p_request, "percent", percent, 512 );
650 sprintf( psz, "control %s seek %s", name, percent );
653 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
654 /* FIXME do a vlm_answer -> var stack conversion */
655 vlm_MessageDelete( vlm_answer );
661 vlm_message_t *vlm_answer;
665 if( p_intf->p_sys->p_vlm == NULL )
666 p_intf->p_sys->p_vlm = vlm_New( p_intf );
668 if( p_intf->p_sys->p_vlm == NULL ) break;
670 ExtractURIValue( p_request, "file", file, 512 );
673 if( StrToMacroType( control ) == MVLC_VLM_LOAD )
674 sprintf( psz, "load %s", file );
676 sprintf( psz, "save %s", file );
678 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
679 /* FIXME do a vlm_answer -> var stack conversion */
680 vlm_MessageDelete( vlm_answer );
683 #endif /* ENABLE_VLM */
687 PRINTS( "<!-- control param(%s) unsupported -->", control );
699 if( i_request <= 0 ||
700 *m->param1 == '\0' ||
701 strstr( p_request, m->param1 ) == NULL )
705 ExtractURIValue( p_request, m->param1, value, 512 );
708 switch( StrToMacroType( m->param2 ) )
712 config_PutInt( p_intf, m->param1, i );
716 config_PutFloat( p_intf, m->param1, f );
719 config_PutPsz( p_intf, m->param1, value );
722 PRINTS( "<!-- invalid type(%s) in set -->", m->param2 )
734 if( *m->param1 == '\0' )
739 switch( StrToMacroType( m->param2 ) )
742 i = config_GetInt( p_intf, m->param1 );
743 sprintf( value, "%d", i );
746 f = config_GetFloat( p_intf, m->param1 );
747 div = lldiv( f * 1000000 , 1000000 );
748 sprintf( value, "%lld.%06u", div.quot,
749 (unsigned int)div.rem );
752 psz = config_GetPsz( p_intf, m->param1 );
755 strlcpy( value, psz,sizeof( value ) );
760 msg_Dbg( p_intf, "%d: value = \"%s\"", __LINE__, value );
763 snprintf( value, sizeof( value ),
764 "invalid type(%s) in set", m->param2 );
767 PRINTS( "%s", value );
777 EvaluateRPN( p_intf, p_args->vars, &p_args->stack, m->param1 );
778 s = SSPop( &p_args->stack );
779 v = mvar_GetValue( p_args->vars, s );
783 v = s = SSPop( &p_args->stack );
791 EvaluateRPN( p_intf, p_args->vars, &p_args->stack, m->param1 );
794 /* Useful to learn stack management */
798 msg_Dbg( p_intf, "stack" );
799 for (i=0;i<(&p_args->stack)->i_stack;i++)
800 msg_Dbg( p_intf, "%d -> %s", i, (&p_args->stack)->stack[i] );
806 PRINTS( "<!-- invalid macro id=`%s' -->", m->id );
807 msg_Dbg( p_intf, "invalid macro id=`%s'", m->id );
816 char *MacroSearch( char *src, char *end, int i_mvlc, bool b_after )
823 if( src + 4 < end && !strncmp( (char *)src, "<vlc", 4 ) )
828 i_skip = MacroParse( &m, src );
830 i_id = StrToMacroType( m.id );
847 if( ( i_mvlc == MVLC_END && i_level == -1 ) ||
848 ( i_mvlc != MVLC_END && i_level == 0 && i_mvlc == i_id ) )
850 return src + ( b_after ? i_skip : 0 );
852 else if( i_level < 0 )
868 void Execute( httpd_file_sys_t *p_args,
869 char *p_request, int i_request,
870 char **pp_data, int *pi_data,
872 char *_src, char *_end )
874 intf_thread_t *p_intf = p_args->p_intf;
876 char *src, *dup, *end;
879 src = dup = malloc( _end - _src + 1 );
880 end = src +( _end - _src );
882 memcpy( src, _src, _end - _src );
885 /* we parse searching <vlc */
891 p = (char *)strstr( (char *)src, "<vlc" );
892 if( p < end && p == src )
896 src += MacroParse( &m, src );
898 //msg_Dbg( p_intf, "macro_id=%s", m.id );
900 switch( StrToMacroType( m.id ) )
907 char psz_file[MAX_DIR_SIZE];
917 if( m.param1[0] != sep )
919 strcpy( psz_file, p_args->file );
920 p = strrchr( psz_file, sep );
922 strcpy( p + 1, m.param1 );
924 strcpy( psz_file, m.param1 );
928 strcpy( psz_file, m.param1 );
931 /* We hereby assume that psz_file is in the
932 * local character encoding */
933 if( ( f = fopen( psz_file, "r" ) ) == NULL )
935 msg_Warn( p_args->p_intf,
936 "unable to include file %s (%m)",
941 /* first we load in a temporary buffer */
942 FileLoad( f, &p_buffer, &i_buffer );
944 /* we parse executing all <vlc /> macros */
945 Execute( p_args, p_request, i_request, pp_data, pi_data,
946 &dst, &p_buffer[0], &p_buffer[i_buffer] );
956 EvaluateRPN( p_intf, p_args->vars, &p_args->stack, m.param1 );
957 if( SSPopN( &p_args->stack, p_args->vars ) )
965 endif = MacroSearch( src, end, MVLC_END, true );
969 char *start = MacroSearch( src, endif, MVLC_ELSE, true );
973 char *stop = MacroSearch( start, endif, MVLC_END, false );
976 Execute( p_args, p_request, i_request,
977 pp_data, pi_data, &dst, start, stop );
981 else if( i_test == 1 )
984 if( ( stop = MacroSearch( src, endif, MVLC_ELSE, false ) ) == NULL )
986 stop = MacroSearch( src, endif, MVLC_END, false );
990 Execute( p_args, p_request, i_request,
991 pp_data, pi_data, &dst, src, stop );
1000 char *endfor = MacroSearch( src, end, MVLC_END, true );
1002 char *stop = MacroSearch( src, end, MVLC_END, false );
1009 if( !strcmp( m.param2, "integer" ) )
1011 char *arg = SSPop( &p_args->stack );
1012 index = mvar_IntegerSetNew( m.param1, arg );
1015 else if( !strcmp( m.param2, "directory" ) )
1017 char *arg = SSPop( &p_args->stack );
1018 index = mvar_FileSetNew( p_intf, m.param1, arg );
1021 else if( !strcmp( m.param2, "object" ) )
1023 char *arg = SSPop( &p_args->stack );
1024 index = mvar_ObjectSetNew( p_intf, m.param1, arg );
1027 else if( !strcmp( m.param2, "playlist" ) )
1029 index = mvar_PlaylistSetNew( p_intf, m.param1,
1030 p_intf->p_sys->p_playlist );
1032 else if( !strcmp( m.param2, "information" ) )
1034 index = mvar_InfoSetNew( m.param1,
1035 p_intf->p_sys->p_input );
1037 else if( !strcmp( m.param2, "program" )
1038 || !strcmp( m.param2, "title" )
1039 || !strcmp( m.param2, "chapter" )
1040 || !strcmp( m.param2, "audio-es" )
1041 || !strcmp( m.param2, "video-es" )
1042 || !strcmp( m.param2, "spu-es" ) )
1044 index = mvar_InputVarSetNew( p_intf, m.param1,
1045 p_intf->p_sys->p_input,
1049 else if( !strcmp( m.param2, "vlm" ) )
1051 if( p_intf->p_sys->p_vlm == NULL )
1052 p_intf->p_sys->p_vlm = vlm_New( p_intf );
1053 index = mvar_VlmSetNew( m.param1, p_intf->p_sys->p_vlm );
1057 else if( !strcmp( m.param2, "hosts" ) )
1059 index = mvar_HttpdInfoSetNew( m.param1, p_intf->p_sys->p_httpd, HTTPD_GET_HOSTS );
1061 else if( !strcmp( m.param2, "urls" ) )
1063 index = mvar_HttpdInfoSetNew( m.param1, p_intf->p_sys->p_httpd, HTTPD_GET_URLS );
1065 else if( !strcmp( m.param2, "connections" ) )
1067 index = mvar_HttpdInfoSetNew(m.param1, p_intf->p_sys->p_httpd, HTTPD_GET_CONNECTIONS);
1070 else if( ( v = mvar_GetVar( p_args->vars, m.param2 ) ) )
1072 index = mvar_Duplicate( v );
1076 msg_Dbg( p_intf, "invalid index constructor (%s)", m.param2 );
1081 for( i_idx = 0; i_idx < index->i_field; i_idx++ )
1083 mvar_t *f = mvar_Duplicate( index->field[i_idx] );
1085 //msg_Dbg( p_intf, "foreach field[%d] name=%s value=%s", i_idx, f->name, f->value );
1088 f->name = strdup( m.param1 );
1091 mvar_PushVar( p_args->vars, f );
1092 Execute( p_args, p_request, i_request,
1093 pp_data, pi_data, &dst, start, stop );
1094 mvar_RemoveVar( p_args->vars, f );
1098 mvar_Delete( index );
1105 MacroDo( p_args, &m, p_request, i_request,
1106 pp_data, pi_data, &dst );
1114 i_copy = ( (p == NULL || p > end ) ? end : p ) - src;
1117 int i_index = dst - *pp_data;
1120 *pp_data = realloc( *pp_data, *pi_data );
1121 dst = (*pp_data) + i_index;
1123 memcpy( dst, src, i_copy );