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 );
356 int i_item, *p_items = NULL, i_nb_items = 0;
358 const char *p_parser = p_request;
360 /* Get the list of items to delete */
362 ExtractURIValue( p_parser, "item", item, 512 )) )
364 if( !*item ) continue;
366 i_item = atoi( item );
367 p_items = realloc( p_items, (i_nb_items + 1) *
369 p_items[i_nb_items] = i_item;
376 for( i = 0; i < i_nb_items; i++ )
378 playlist_DeleteFromInput( p_sys->p_playlist,
380 msg_Dbg( p_intf, "requested playlist delete: %d",
391 int i_item, *p_items = NULL, i_nb_items = 0;
393 const char *p_parser = p_request;
396 /* Get the list of items to keep */
398 ExtractURIValue( p_parser, "item", item, 512 )) )
400 if( !*item ) continue;
402 i_item = atoi( item );
403 p_items = realloc( p_items, (i_nb_items + 1) *
405 p_items[i_nb_items] = i_item;
409 for( i = p_sys->p_playlist->items.i_size - 1 ; i >= 0; i-- )
411 /* Check if the item is in the keep list */
412 for( j = 0 ; j < i_nb_items ; j++ )
415 ARRAY_VAL(p_sys->p_playlist->items,i)
419 if( j == i_nb_items )
421 playlist_DeleteFromInput( p_sys->p_playlist,
422 p_sys->p_playlist->items.p_elems[i]->i_id,
424 msg_Dbg( p_intf, "requested playlist delete: %d",
434 playlist_Clear( p_sys->p_playlist, false );
435 msg_Dbg( p_intf, "requested playlist empty" );
446 ExtractURIValue( p_request, "type", type, 12 );
447 ExtractURIValue( p_request, "order", order, 2 );
448 ExtractURIValue( p_request, "item", item, 512 );
449 i_item = atoi( item );
451 if( order[0] == '0' ) i_order = ORDER_NORMAL;
452 else i_order = ORDER_REVERSE;
454 if( !strcmp( type , "title" ) )
456 playlist_RecursiveNodeSort( p_sys->p_playlist,
457 /* Ugly hack,but not worse than before ... */
458 p_sys->p_playlist->p_root_onelevel,
459 SORT_TITLE_NODES_FIRST,
460 ( i_order == 0 ) ? ORDER_NORMAL : ORDER_REVERSE );
461 msg_Dbg( p_intf, "requested playlist sort by title (%d)" , i_order );
463 else if( !strcmp( type , "author" ) )
465 playlist_RecursiveNodeSort( p_sys->p_playlist, /*playlist_ItemGetById( p_sys->p_playlist, i_item ),*/
466 p_sys->p_playlist->p_root_onelevel,
468 ( i_order == 0 ) ? ORDER_NORMAL : ORDER_REVERSE );
469 msg_Dbg( p_intf, "requested playlist sort by author (%d)" , i_order );
471 else if( !strcmp( type , "shuffle" ) )
473 playlist_RecursiveNodeSort( p_sys->p_playlist, /*playlist_ItemGetById( p_sys->p_playlist, i_item ),*/
474 p_sys->p_playlist->p_root_onelevel,
476 ( i_order == 0 ) ? ORDER_NORMAL : ORDER_REVERSE );
477 msg_Dbg( p_intf, "requested playlist shuffle");
488 ExtractURIValue( p_request, "psz_pos", psz_pos, 6 );
489 ExtractURIValue( p_request, "psz_newpos", psz_newpos, 6 );
490 i_pos = atoi( psz_pos );
491 i_newpos = atoi( psz_newpos );
492 /* FIXME FIXME TODO TODO XXX XXX
493 ( duplicate from rpn.c )
494 if ( i_pos < i_newpos )
496 playlist_Move( p_sys->p_playlist, i_pos, i_newpos + 1 );
500 playlist_Move( p_sys->p_playlist, i_pos, i_newpos );
502 msg_Dbg( p_intf, "requested move playlist item %d to %d", i_pos, i_newpos);
503 FIXME FIXME TODO TODO XXX XXX */
511 ExtractURIValue( p_request, "id", id, 512 );
512 msg_Dbg( p_intf, "requested close id=%s", id );
514 if( p_sys->p_httpd->pf_control( p_sys->p_httpd, HTTPD_SET_CLOSE, id, NULL ) )
516 msg_Warn( p_intf, "close failed for id=%s", id );
523 msg_Dbg( p_intf, "requested shutdown" );
524 libvlc_Quit( p_intf->p_libvlc );
532 static const char vlm_properties[][9] =
535 "enabled", "disabled", "loop", "unloop",
537 "input", "output", "option", "date", "period",
538 "repeat", "append", "",
540 vlm_message_t *vlm_answer;
542 char *psz = malloc( strlen( p_request ) + 1000 );
547 if( p_intf->p_sys->p_vlm == NULL )
548 p_intf->p_sys->p_vlm = vlm_New( p_intf );
550 if( p_intf->p_sys->p_vlm == NULL )
556 ExtractURIValue( p_request, "name", name, 512 );
557 if( StrToMacroType( control ) == MVLC_VLM_NEW )
560 ExtractURIValue( p_request, "type", type, 20 );
561 p += sprintf( psz, "new %s %s", name, type );
565 p += sprintf( psz, "setup %s", name );
567 /* Parse the request */
568 for( i = 0; vlm_properties[i][0]; i++ )
571 ExtractURIValue( p_request,
572 vlm_properties[i], val, 512 );
574 if( strlen( val ) > 0 && i >= 4 )
576 p += sprintf( p, " %s %s", vlm_properties[i], val );
578 else if( TestURIParam( p_request, vlm_properties[i] ) && i < 4 )
580 p += sprintf( p, " %s", vlm_properties[i] );
583 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
584 if( vlm_answer->psz_value == NULL ) /* there is no error */
586 vlm_error = strdup( "" );
590 if( asprintf( &vlm_error , "%s : %s" ,
591 vlm_answer->psz_name,
592 vlm_answer->psz_value ) == -1 )
596 mvar_AppendNewVar( p_args->vars, "vlm_error", vlm_error );
598 vlm_MessageDelete( vlm_answer );
606 vlm_message_t *vlm_answer;
609 if( p_intf->p_sys->p_vlm == NULL )
610 p_intf->p_sys->p_vlm = vlm_New( p_intf );
612 if( p_intf->p_sys->p_vlm == NULL ) break;
614 ExtractURIValue( p_request, "name", name, 512 );
615 sprintf( psz, "del %s", name );
617 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
618 /* FIXME do a vlm_answer -> var stack conversion */
619 vlm_MessageDelete( vlm_answer );
628 vlm_message_t *vlm_answer;
631 if( p_intf->p_sys->p_vlm == NULL )
632 p_intf->p_sys->p_vlm = vlm_New( p_intf );
634 if( p_intf->p_sys->p_vlm == NULL ) break;
636 ExtractURIValue( p_request, "name", name, 512 );
637 if( StrToMacroType( control ) == MVLC_VLM_PLAY )
638 sprintf( psz, "control %s play", name );
639 else if( StrToMacroType( control ) == MVLC_VLM_PAUSE )
640 sprintf( psz, "control %s pause", name );
641 else if( StrToMacroType( control ) == MVLC_VLM_STOP )
642 sprintf( psz, "control %s stop", name );
643 else if( StrToMacroType( control ) == MVLC_VLM_SEEK )
646 ExtractURIValue( p_request, "percent", percent, 512 );
647 sprintf( psz, "control %s seek %s", name, percent );
650 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
651 /* FIXME do a vlm_answer -> var stack conversion */
652 vlm_MessageDelete( vlm_answer );
658 vlm_message_t *vlm_answer;
662 if( p_intf->p_sys->p_vlm == NULL )
663 p_intf->p_sys->p_vlm = vlm_New( p_intf );
665 if( p_intf->p_sys->p_vlm == NULL ) break;
667 ExtractURIValue( p_request, "file", file, 512 );
670 if( StrToMacroType( control ) == MVLC_VLM_LOAD )
671 sprintf( psz, "load %s", file );
673 sprintf( psz, "save %s", file );
675 vlm_ExecuteCommand( p_intf->p_sys->p_vlm, psz, &vlm_answer );
676 /* FIXME do a vlm_answer -> var stack conversion */
677 vlm_MessageDelete( vlm_answer );
680 #endif /* ENABLE_VLM */
684 PRINTS( "<!-- control param(%s) unsupported -->", control );
696 if( i_request <= 0 ||
697 *m->param1 == '\0' ||
698 strstr( p_request, m->param1 ) == NULL )
702 ExtractURIValue( p_request, m->param1, value, 512 );
705 switch( StrToMacroType( m->param2 ) )
709 config_PutInt( p_intf, m->param1, i );
713 config_PutFloat( p_intf, m->param1, f );
716 config_PutPsz( p_intf, m->param1, value );
719 PRINTS( "<!-- invalid type(%s) in set -->", m->param2 )
731 if( *m->param1 == '\0' )
736 switch( StrToMacroType( m->param2 ) )
739 i = config_GetInt( p_intf, m->param1 );
740 sprintf( value, "%d", i );
743 f = config_GetFloat( p_intf, m->param1 );
744 div = lldiv( f * 1000000 , 1000000 );
745 sprintf( value, "%lld.%06u", div.quot,
746 (unsigned int)div.rem );
749 psz = config_GetPsz( p_intf, m->param1 );
752 strlcpy( value, psz,sizeof( value ) );
757 msg_Dbg( p_intf, "%d: value = \"%s\"", __LINE__, value );
760 snprintf( value, sizeof( value ),
761 "invalid type(%s) in set", m->param2 );
764 PRINTS( "%s", value );
774 EvaluateRPN( p_intf, p_args->vars, &p_args->stack, m->param1 );
775 s = SSPop( &p_args->stack );
776 v = mvar_GetValue( p_args->vars, s );
780 v = s = SSPop( &p_args->stack );
788 EvaluateRPN( p_intf, p_args->vars, &p_args->stack, m->param1 );
791 /* Useful to learn stack management */
795 msg_Dbg( p_intf, "stack" );
796 for (i=0;i<(&p_args->stack)->i_stack;i++)
797 msg_Dbg( p_intf, "%d -> %s", i, (&p_args->stack)->stack[i] );
803 PRINTS( "<!-- invalid macro id=`%s' -->", m->id );
804 msg_Dbg( p_intf, "invalid macro id=`%s'", m->id );
813 char *MacroSearch( char *src, char *end, int i_mvlc, bool b_after )
820 if( src + 4 < end && !strncmp( (char *)src, "<vlc", 4 ) )
825 i_skip = MacroParse( &m, src );
827 i_id = StrToMacroType( m.id );
844 if( ( i_mvlc == MVLC_END && i_level == -1 ) ||
845 ( i_mvlc != MVLC_END && i_level == 0 && i_mvlc == i_id ) )
847 return src + ( b_after ? i_skip : 0 );
849 else if( i_level < 0 )
865 void Execute( httpd_file_sys_t *p_args,
866 char *p_request, int i_request,
867 char **pp_data, int *pi_data,
869 char *_src, char *_end )
871 intf_thread_t *p_intf = p_args->p_intf;
873 char *src, *dup, *end;
876 src = dup = malloc( _end - _src + 1 );
877 end = src +( _end - _src );
879 memcpy( src, _src, _end - _src );
882 /* we parse searching <vlc */
888 p = (char *)strstr( (char *)src, "<vlc" );
889 if( p < end && p == src )
893 src += MacroParse( &m, src );
895 //msg_Dbg( p_intf, "macro_id=%s", m.id );
897 switch( StrToMacroType( m.id ) )
904 char psz_file[MAX_DIR_SIZE];
914 if( m.param1[0] != sep )
916 strcpy( psz_file, p_args->file );
917 p = strrchr( psz_file, sep );
919 strcpy( p + 1, m.param1 );
921 strcpy( psz_file, m.param1 );
925 strcpy( psz_file, m.param1 );
928 /* We hereby assume that psz_file is in the
929 * local character encoding */
930 if( ( f = fopen( psz_file, "r" ) ) == NULL )
932 msg_Warn( p_args->p_intf,
933 "unable to include file %s (%m)",
938 /* first we load in a temporary buffer */
939 FileLoad( f, &p_buffer, &i_buffer );
941 /* we parse executing all <vlc /> macros */
942 Execute( p_args, p_request, i_request, pp_data, pi_data,
943 &dst, &p_buffer[0], &p_buffer[i_buffer] );
953 EvaluateRPN( p_intf, p_args->vars, &p_args->stack, m.param1 );
954 if( SSPopN( &p_args->stack, p_args->vars ) )
962 endif = MacroSearch( src, end, MVLC_END, true );
966 char *start = MacroSearch( src, endif, MVLC_ELSE, true );
970 char *stop = MacroSearch( start, endif, MVLC_END, false );
973 Execute( p_args, p_request, i_request,
974 pp_data, pi_data, &dst, start, stop );
978 else if( i_test == 1 )
981 if( ( stop = MacroSearch( src, endif, MVLC_ELSE, false ) ) == NULL )
983 stop = MacroSearch( src, endif, MVLC_END, false );
987 Execute( p_args, p_request, i_request,
988 pp_data, pi_data, &dst, src, stop );
997 char *endfor = MacroSearch( src, end, MVLC_END, true );
999 char *stop = MacroSearch( src, end, MVLC_END, false );
1006 if( !strcmp( m.param2, "integer" ) )
1008 char *arg = SSPop( &p_args->stack );
1009 index = mvar_IntegerSetNew( m.param1, arg );
1012 else if( !strcmp( m.param2, "directory" ) )
1014 char *arg = SSPop( &p_args->stack );
1015 index = mvar_FileSetNew( p_intf, m.param1, arg );
1018 else if( !strcmp( m.param2, "object" ) )
1020 char *arg = SSPop( &p_args->stack );
1021 index = mvar_ObjectSetNew( p_intf, m.param1, arg );
1024 else if( !strcmp( m.param2, "playlist" ) )
1026 index = mvar_PlaylistSetNew( p_intf, m.param1,
1027 p_intf->p_sys->p_playlist );
1029 else if( !strcmp( m.param2, "information" ) )
1031 index = mvar_InfoSetNew( m.param1,
1032 p_intf->p_sys->p_input );
1034 else if( !strcmp( m.param2, "program" )
1035 || !strcmp( m.param2, "title" )
1036 || !strcmp( m.param2, "chapter" )
1037 || !strcmp( m.param2, "audio-es" )
1038 || !strcmp( m.param2, "video-es" )
1039 || !strcmp( m.param2, "spu-es" ) )
1041 index = mvar_InputVarSetNew( p_intf, m.param1,
1042 p_intf->p_sys->p_input,
1046 else if( !strcmp( m.param2, "vlm" ) )
1048 if( p_intf->p_sys->p_vlm == NULL )
1049 p_intf->p_sys->p_vlm = vlm_New( p_intf );
1050 index = mvar_VlmSetNew( m.param1, p_intf->p_sys->p_vlm );
1054 else if( !strcmp( m.param2, "hosts" ) )
1056 index = mvar_HttpdInfoSetNew( m.param1, p_intf->p_sys->p_httpd, HTTPD_GET_HOSTS );
1058 else if( !strcmp( m.param2, "urls" ) )
1060 index = mvar_HttpdInfoSetNew( m.param1, p_intf->p_sys->p_httpd, HTTPD_GET_URLS );
1062 else if( !strcmp( m.param2, "connections" ) )
1064 index = mvar_HttpdInfoSetNew(m.param1, p_intf->p_sys->p_httpd, HTTPD_GET_CONNECTIONS);
1067 else if( ( v = mvar_GetVar( p_args->vars, m.param2 ) ) )
1069 index = mvar_Duplicate( v );
1073 msg_Dbg( p_intf, "invalid index constructor (%s)", m.param2 );
1078 for( i_idx = 0; i_idx < index->i_field; i_idx++ )
1080 mvar_t *f = mvar_Duplicate( index->field[i_idx] );
1082 //msg_Dbg( p_intf, "foreach field[%d] name=%s value=%s", i_idx, f->name, f->value );
1085 f->name = strdup( m.param1 );
1088 mvar_PushVar( p_args->vars, f );
1089 Execute( p_args, p_request, i_request,
1090 pp_data, pi_data, &dst, start, stop );
1091 mvar_RemoveVar( p_args->vars, f );
1095 mvar_Delete( index );
1102 MacroDo( p_args, &m, p_request, i_request,
1103 pp_data, pi_data, &dst );
1111 i_copy = ( (p == NULL || p > end ) ? end : p ) - src;
1114 int i_index = dst - *pp_data;
1117 *pp_data = realloc( *pp_data, *pi_data );
1118 dst = (*pp_data) + i_index;
1120 memcpy( dst, src, i_copy );