1 /*****************************************************************************
2 * util.c : Utility functions for HTTP interface
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 *****************************************************************************/
30 #include <vlc_common.h>
32 #include "vlc_strings.h"
34 /****************************************************************************
35 * File and directory functions
36 ****************************************************************************/
38 /* ToUrl: create a good name for an url from filename */
39 char *FileToUrl( char *name, bool *pb_index )
43 url = p = malloc( strlen( name ) + 1 );
52 while( *name == '\\' || *name == '/' )
64 /* convert '\\' into '/' */
75 if( ( p = strrchr( url, '/' ) ) != NULL )
77 if( !strncmp( p, "/index.", 7 ) )
87 int FileLoad( FILE *f, char **pp_data, int *pi_data )
91 /* just load the file */
93 *pp_data = malloc( 1025 ); /* +1 for \0 */
94 while( ( i_read = fread( &(*pp_data)[*pi_data], 1, 1024, f ) ) == 1024 )
97 *pp_data = realloc( *pp_data, *pi_data + 1025 );
103 (*pp_data)[*pi_data] = '\0';
108 /* Parse a directory and recursively add files */
109 int ParseDirectory( intf_thread_t *p_intf, char *psz_root,
112 intf_sys_t *p_sys = p_intf->p_sys;
113 char dir[MAX_DIR_SIZE];
119 char *password = NULL;
131 if( ( p_dir = utf8_opendir( psz_dir ) ) == NULL )
133 if( errno != ENOENT && errno != ENOTDIR )
134 msg_Err( p_intf, "cannot open directory (%s)", psz_dir );
138 i_dirlen = strlen( psz_dir );
139 if( i_dirlen + 10 > MAX_DIR_SIZE )
141 msg_Warn( p_intf, "skipping too deep directory (%s)", psz_dir );
146 msg_Dbg( p_intf, "dir=%s", psz_dir );
148 snprintf( dir, sizeof( dir ), "%s%c.access", psz_dir, sep );
149 if( ( file = utf8_fopen( dir, "r" ) ) != NULL )
154 msg_Dbg( p_intf, "find .access in dir=%s", psz_dir );
156 i_size = fread( line, 1, 1023, file );
160 while( i_size > 0 && ( line[i_size-1] == '\n' ||
161 line[i_size-1] == '\r' ) )
168 p = strchr( line, ':' );
172 user = strdup( line );
173 password = strdup( p );
176 msg_Dbg( p_intf, "using user=%s password=%s (read=%d)",
177 user, password, i_size );
182 snprintf( dir, sizeof( dir ), "%s%c.hosts", psz_dir, sep );
183 p_acl = ACL_Create( p_intf, false );
184 if( ACL_LoadFile( p_acl, dir ) )
186 ACL_Destroy( p_acl );
189 if( stat( dir, &st ) == 0 )
200 /* parse psz_src dir */
201 if( ( psz_filename = utf8_readdir( p_dir ) ) == NULL )
206 if( ( psz_filename[0] == '.' )
207 || ( i_dirlen + strlen( psz_filename ) > MAX_DIR_SIZE ) )
209 free( psz_filename );
213 snprintf( dir, sizeof( dir ), "%s%c%s", psz_dir, sep, psz_filename );
214 free( psz_filename );
216 if( ParseDirectory( p_intf, psz_root, dir ) )
218 httpd_file_sys_t *f = NULL;
219 httpd_handler_sys_t *h = NULL;
221 char *psz_name, *psz_ext;
223 psz_name = FileToUrl( &dir[strlen( psz_root )], &b_index );
224 psz_ext = strrchr( dir, '.' );
225 if( psz_ext != NULL )
229 for( i = 0; i < p_sys->i_handlers; i++ )
230 if( !strcmp( p_sys->pp_handlers[i]->psz_ext, psz_ext ) )
232 if( i < p_sys->i_handlers )
234 f = malloc( sizeof( httpd_handler_sys_t ) );
235 h = (httpd_handler_sys_t *)f;
237 h->p_association = p_sys->pp_handlers[i];
242 f = malloc( sizeof( httpd_file_sys_t ) );
243 f->b_handler = false;
250 f->file = strdup (dir);
252 f->b_html = strstr( &dir[strlen( psz_root )], ".htm" ) || strstr( &dir[strlen( psz_root )], ".xml" ) ? true : false;
256 msg_Err( p_intf , "unable to parse directory" );
259 return( VLC_ENOMEM );
261 msg_Dbg( p_intf, "file=%s (url=%s)",
266 char *psz_type = strdup( "text/html; charset=UTF-8" );
267 if( strstr( &dir[strlen( psz_root )], ".xml" ) )
269 char *psz = strstr( psz_type, "html;" );
279 f->p_file = httpd_FileNew( p_sys->p_httpd_host,
281 f->b_html ? psz_type : NULL,
282 user, password, p_acl,
285 if( f->p_file != NULL )
287 TAB_APPEND( p_sys->i_files, p_sys->pp_files, f );
292 h->p_handler = httpd_HandlerNew( p_sys->p_httpd_host,
294 user, password, p_acl,
295 HandlerCallback, h );
296 if( h->p_handler != NULL )
298 TAB_APPEND( p_sys->i_files, p_sys->pp_files,
299 (httpd_file_sys_t *)h );
303 /* for url that ends by / add
304 * - a redirect from rep to rep/
305 * - in case of index.* rep/index.html to rep/ */
306 if( f && f->name[strlen(f->name) - 1] == '/' )
308 char *psz_redir = strdup( f->name );
310 psz_redir[strlen( psz_redir ) - 1] = '\0';
312 msg_Dbg( p_intf, "redir=%s -> %s", psz_redir, f->name );
313 f->p_redir = httpd_RedirectNew( p_sys->p_httpd_host, f->name, psz_redir );
316 if( b_index && ( p = strstr( f->file, "index." ) ) )
318 if( asprintf( &psz_redir, "%s%s", f->name, p ) != -1 )
320 msg_Dbg( p_intf, "redir=%s -> %s", psz_redir, f->name );
321 f->p_redir2 = httpd_RedirectNew( p_sys->p_httpd_host,
322 f->name, psz_redir );
334 ACL_Destroy( p_acl );
341 /*************************************************************************
343 *************************************************************************/
344 void PlaylistListNode( intf_thread_t *p_intf, playlist_t *p_pl,
345 playlist_item_t *p_node, char *name, mvar_t *s,
348 if( !p_node || !p_node->p_input )
351 if( p_node->i_children == -1 )
355 playlist_item_t * p_item = playlist_CurrentPlayingItem( p_pl );
356 if( !p_item || !p_item->p_input )
359 mvar_t *itm = mvar_New( name, "set" );
360 if( p_item->p_input->i_id == p_node->p_input->i_id )
361 mvar_AppendNewVar( itm, "current", "1" );
363 mvar_AppendNewVar( itm, "current", "0" );
365 sprintf( value, "%d", p_node->i_id );
366 mvar_AppendNewVar( itm, "index", value );
368 psz = input_item_GetName( p_node->p_input );
369 mvar_AppendNewVar( itm, "name", psz );
372 psz = input_item_GetURI( p_node->p_input );
373 mvar_AppendNewVar( itm, "uri", psz );
376 sprintf( value, "Item");
377 mvar_AppendNewVar( itm, "type", value );
379 sprintf( value, "%d", i_depth );
380 mvar_AppendNewVar( itm, "depth", value );
382 if( p_node->i_flags & PLAYLIST_RO_FLAG )
383 mvar_AppendNewVar( itm, "ro", "ro" );
385 mvar_AppendNewVar( itm, "ro", "rw" );
387 sprintf( value, "%"PRId64, input_item_GetDuration( p_node->p_input ) );
388 mvar_AppendNewVar( itm, "duration", value );
390 //Adding extra meta-information to each playlist item
392 psz = input_item_GetTitle( p_node->p_input );
393 mvar_AppendNewVar( itm, "title", psz );
395 psz = input_item_GetArtist( p_node->p_input );
396 mvar_AppendNewVar( itm, "artist", psz );
398 psz = input_item_GetGenre( p_node->p_input );
399 mvar_AppendNewVar( itm, "genre", psz );
401 psz = input_item_GetCopyright( p_node->p_input );
402 mvar_AppendNewVar( itm, "copyright", psz );
404 psz = input_item_GetAlbum( p_node->p_input );
405 mvar_AppendNewVar( itm, "album", psz );
407 psz = input_item_GetTrackNum( p_node->p_input );
408 mvar_AppendNewVar( itm, "track", psz );
410 psz = input_item_GetDescription( p_node->p_input );
411 mvar_AppendNewVar( itm, "description", psz );
413 psz = input_item_GetRating( p_node->p_input );
414 mvar_AppendNewVar( itm, "rating", psz );
416 psz = input_item_GetDate( p_node->p_input );
417 mvar_AppendNewVar( itm, "date", psz );
419 psz = input_item_GetURL( p_node->p_input );
420 mvar_AppendNewVar( itm, "url", psz );
422 psz = input_item_GetLanguage( p_node->p_input );
423 mvar_AppendNewVar( itm, "language", psz );
425 psz = input_item_GetNowPlaying( p_node->p_input );
426 mvar_AppendNewVar( itm, "now_playing", psz );
428 psz = input_item_GetPublisher( p_node->p_input );
429 mvar_AppendNewVar( itm, "publisher", psz );
431 psz = input_item_GetEncodedBy( p_node->p_input );
432 mvar_AppendNewVar( itm, "encoded_by", psz );
434 psz = input_item_GetArtURL( p_node->p_input );
435 mvar_AppendNewVar( itm, "art_url", psz );
437 psz = input_item_GetTrackID( p_node->p_input );
438 mvar_AppendNewVar( itm, "track_id", psz );
440 mvar_AppendVar( s, itm );
446 mvar_t *itm = mvar_New( name, "set" );
448 mvar_AppendNewVar( itm, "name", p_node->p_input->psz_name );
449 mvar_AppendNewVar( itm, "uri", p_node->p_input->psz_name );
451 sprintf( value, "Node" );
452 mvar_AppendNewVar( itm, "type", value );
454 sprintf( value, "%d", p_node->i_id );
455 mvar_AppendNewVar( itm, "index", value );
457 sprintf( value, "%d", p_node->i_children);
458 mvar_AppendNewVar( itm, "i_children", value );
460 sprintf( value, "%d", i_depth );
461 mvar_AppendNewVar( itm, "depth", value );
463 if( p_node->i_flags & PLAYLIST_RO_FLAG )
464 mvar_AppendNewVar( itm, "ro", "ro" );
466 mvar_AppendNewVar( itm, "ro", "rw" );
468 mvar_AppendVar( s, itm );
470 for( i_child = 0 ; i_child < p_node->i_children ; i_child++ )
471 PlaylistListNode( p_intf, p_pl, p_node->pp_children[i_child],
472 name, s, i_depth + 1);
476 /****************************************************************************
477 * Seek command parsing handling
478 ****************************************************************************/
479 void HandleSeek( intf_thread_t *p_intf, char *p_value )
481 intf_sys_t *p_sys = p_intf->p_sys;
487 #define POSITION_ABSOLUTE 12
488 #define POSITION_REL_FOR 13
489 #define POSITION_REL_BACK 11
490 #define VL_TIME_ABSOLUTE 0
491 #define VL_TIME_REL_FOR 1
492 #define VL_TIME_REL_BACK -1
495 var_Get( p_sys->p_input, "length", &val );
496 i_length = val.i_time;
498 while( p_value[0] != '\0' )
504 i_relative = VL_TIME_REL_FOR;
510 i_relative = VL_TIME_REL_BACK;
514 case '0': case '1': case '2': case '3': case '4':
515 case '5': case '6': case '7': case '8': case '9':
517 i_stock = strtol( p_value , &p_value , 10 );
520 case '%': /* for percentage ie position */
522 i_relative += POSITION_ABSOLUTE;
530 i_value = 60 * (i_value + i_stock) ;
535 case 'h': case 'H': /* hours */
537 i_value += 3600 * i_stock;
539 /* other characters which are not numbers are not
541 while( ((p_value[0] < '0') || (p_value[0] > '9'))
542 && (p_value[0] != '\0') )
548 case 'm': case 'M': case '\'': /* minutes */
550 i_value += 60 * i_stock;
553 while( ((p_value[0] < '0') || (p_value[0] > '9'))
554 && (p_value[0] != '\0') )
560 case 's': case 'S': case '"': /* seconds */
564 while( ((p_value[0] < '0') || (p_value[0] > '9'))
565 && (p_value[0] != '\0') )
579 /* if there is no known symbol, I consider it as seconds.
580 * Otherwise, i_stock = 0 */
585 case VL_TIME_ABSOLUTE:
587 if( (uint64_t)( i_value ) * 1000000 <= i_length )
588 val.i_time = (uint64_t)( i_value ) * 1000000;
590 val.i_time = i_length;
592 var_Set( p_sys->p_input, "time", val );
593 msg_Dbg( p_intf, "requested seek position: %dsec", i_value );
596 case VL_TIME_REL_FOR:
598 var_Get( p_sys->p_input, "time", &val );
599 if( (uint64_t)( i_value ) * 1000000 + val.i_time <= i_length )
601 val.i_time = ((uint64_t)( i_value ) * 1000000) + val.i_time;
604 val.i_time = i_length;
606 var_Set( p_sys->p_input, "time", val );
607 msg_Dbg( p_intf, "requested seek position forward: %dsec", i_value );
610 case VL_TIME_REL_BACK:
612 var_Get( p_sys->p_input, "time", &val );
613 if( (int64_t)( i_value ) * 1000000 > val.i_time )
618 val.i_time = val.i_time - ((uint64_t)( i_value ) * 1000000);
620 var_Set( p_sys->p_input, "time", val );
621 msg_Dbg( p_intf, "requested seek position backward: %dsec", i_value );
624 case POSITION_ABSOLUTE:
626 val.f_float = __MIN( __MAX( ((float) i_value ) / 100.0 ,
628 var_Set( p_sys->p_input, "position", val );
629 msg_Dbg( p_intf, "requested seek percent: %d%%", i_value );
632 case POSITION_REL_FOR:
634 var_Get( p_sys->p_input, "position", &val );
635 val.f_float += __MIN( __MAX( ((float) i_value ) / 100.0,
637 var_Set( p_sys->p_input, "position", val );
638 msg_Dbg( p_intf, "requested seek percent forward: %d%%",
642 case POSITION_REL_BACK:
644 var_Get( p_sys->p_input, "position", &val );
645 val.f_float -= __MIN( __MAX( ((float) i_value ) / 100.0,
647 var_Set( p_sys->p_input, "position", val );
648 msg_Dbg( p_intf, "requested seek percent backward: %d%%",
654 msg_Dbg( p_intf, "invalid seek request" );
659 #undef POSITION_ABSOLUTE
660 #undef POSITION_REL_FOR
661 #undef POSITION_REL_BACK
662 #undef VL_TIME_ABSOLUTE
663 #undef VL_TIME_REL_FOR
664 #undef VL_TIME_REL_BACK
668 /****************************************************************************
669 * URI Parsing functions
670 ****************************************************************************/
671 int TestURIParam( char *psz_uri, const char *psz_name )
675 while( (p = strstr( p, psz_name )) )
677 /* Verify that we are dealing with a post/get argument */
678 if( (p == psz_uri || *(p - 1) == '&' || *(p - 1) == '\n')
679 && p[strlen(psz_name)] == '=' )
689 static const char *FindURIValue( const char *psz_uri, const char *restrict psz_name,
690 size_t *restrict p_len )
692 const char *p = psz_uri, *end;
695 while( (p = strstr( p, psz_name )) )
697 /* Verify that we are dealing with a post/get argument */
698 if( (p == psz_uri || *(p - 1) == '&' || *(p - 1) == '\n')
699 && p[strlen(psz_name)] == '=' )
710 p += strlen( psz_name );
713 if( ( end = strchr( p, '\n' ) ) != NULL )
716 if( ( end > p ) && ( end[-1] == '\r' ) )
724 if( ( end = strchr( p, '&' ) ) != NULL )
734 const char *ExtractURIValue( const char *restrict psz_uri,
735 const char *restrict psz_name,
736 char *restrict psz_buf, size_t bufsize )
739 const char *psz_value = FindURIValue( psz_uri, psz_name, &len );
740 const char *psz_next;
742 if( psz_value == NULL )
749 psz_next = psz_value + len;
755 strncpy( psz_buf, psz_value, len );
762 char *ExtractURIString( const char *restrict psz_uri,
763 const char *restrict psz_name )
766 const char *psz_value = FindURIValue( psz_uri, psz_name, &len );
768 if( psz_value == NULL )
771 char *res = malloc( len + 1 );
775 memcpy( res, psz_value, len );
781 /* Since the resulting string is smaller we can work in place, so it is
782 * permitted to have psz == new. new points to the first word of the
783 * string, the function returns the remaining string. */
784 char *FirstWord( char *psz, char *new )
791 while( *psz != '\0' && *psz != ' ' )
796 while( *psz != '\0' && *psz != c )
798 if( *psz == '\\' && psz[1] != '\0' )
807 if( *psz == '\\' && psz[1] != '\0' )
821 /**********************************************************************
822 * MRLParse: parse the MRL, find the MRL string and the options,
823 * create an item with all information in it, and return the item.
824 * return NULL if there is an error.
825 **********************************************************************/
827 /* Function analog to FirstWord except that it relies on colon instead
828 * of space to delimit option boundaries. */
829 static char *FirstOption( char *psz, char *new )
831 bool b_end, b_start = true;
836 while( *psz != '\0' && (*psz != ' ' || psz[1] != ':') )
841 while( *psz != '\0' && *psz != c )
843 if( *psz == '\\' && psz[1] != '\0' )
853 if( *psz == '\\' && psz[1] != '\0' )
862 while (new[-1] == ' ')
872 input_item_t *MRLParse( intf_thread_t *p_intf, const char *mrl,
875 char *psz = strdup( mrl ), *s_mrl = psz, *s_temp;
878 /* extract the mrl */
879 s_temp = FirstOption( s_mrl, s_mrl );
882 s_temp = s_mrl + strlen( s_mrl );
885 input_item_t *p_input = input_item_New( p_intf, s_mrl, psz_name );
886 if( p_input == NULL )
890 /* now we can take care of the options */
891 while ( *s_mrl != '\0' )
893 s_temp = FirstOption( s_mrl, s_mrl );
898 s_temp = s_mrl + strlen( s_mrl );
900 input_item_AddOption( p_input, s_mrl, VLC_INPUT_OPTION_TRUSTED );
907 /**********************************************************************
908 * RealPath: parse ../, ~ and path stuff
909 **********************************************************************/
910 char *RealPath( const char *psz_src )
914 int i_len = strlen(psz_src);
915 const char sep = DIR_SEP_CHAR;
917 psz_dir = malloc( i_len + 2 );
918 strcpy( psz_dir, psz_src );
920 /* Add a trailing sep to ease the .. step */
921 psz_dir[i_len] = sep;
922 psz_dir[i_len + 1] = '\0';
924 #if (DIR_SEP_CHAR != '/')
925 /* Convert all / to native separator */
927 while( (p = strchr( p, '/' )) != NULL )
933 /* FIXME: this could be O(N) rather than O(N²)... */
934 /* Remove multiple separators and /./ */
936 while( (p = strchr( p, sep )) != NULL )
939 memmove( &p[1], &p[2], strlen(&p[2]) + 1 );
940 else if( p[1] == '.' && p[2] == sep )
941 memmove( &p[1], &p[3], strlen(&p[3]) + 1 );
946 if( psz_dir[0] == '~' )
949 asprintf( &dir, "%s%s", config_GetHomeDir(), psz_dir + 1 );
954 if( strlen(psz_dir) > 2 )
958 while( (p = strchr( p, sep )) != NULL )
960 if( p[-1] == '.' && p[-2] == '.' && p[-3] == sep )
964 if( (q = strrchr( psz_dir, sep )) != NULL )
966 memmove( q + 1, p + 1, strlen(p + 1) + 1 );
971 memmove( psz_dir, p, strlen(p) + 1 );
980 /* Remove trailing sep if there are at least 2 sep in the string
981 * (handles the C:\ stuff) */
982 p = strrchr( psz_dir, sep );
983 if( p != NULL && p[1] == '\0' && p != strchr( psz_dir, sep ) )