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>
37 /****************************************************************************
38 * File and directory functions
39 ****************************************************************************/
41 /* ToUrl: create a good name for an url from filename */
42 char *FileToUrl( char *name, bool *pb_index )
46 url = p = malloc( strlen( name ) + 1 );
55 while( *name == '\\' || *name == '/' )
67 /* convert '\\' into '/' */
78 if( ( p = strrchr( url, '/' ) ) != NULL )
80 if( !strncmp( p, "/index.", 7 ) )
90 int FileLoad( FILE *f, char **pp_data, int *pi_data )
94 /* just load the file */
96 *pp_data = xmalloc( 1025 ); /* +1 for \0 */
98 while( ( i_read = fread( &(*pp_data)[*pi_data], 1, 1024, f ) ) == 1024 )
101 *pp_data = xrealloc( *pp_data, *pi_data + 1025 );
107 (*pp_data)[*pi_data] = '\0';
112 /* Parse a directory and recursively add files */
113 int ParseDirectory( intf_thread_t *p_intf, char *psz_root,
116 intf_sys_t *p_sys = p_intf->p_sys;
117 char dir[MAX_DIR_SIZE];
123 char *password = NULL;
127 if( ( p_dir = utf8_opendir( psz_dir ) ) == NULL )
129 if( errno != ENOENT && errno != ENOTDIR )
130 msg_Err( p_intf, "cannot open directory (%s)", psz_dir );
134 i_dirlen = strlen( psz_dir );
135 if( i_dirlen + 10 > MAX_DIR_SIZE )
137 msg_Warn( p_intf, "skipping too deep directory (%s)", psz_dir );
142 msg_Dbg( p_intf, "dir=%s", psz_dir );
144 snprintf( dir, sizeof( dir ), "%s"DIR_SEP".access", psz_dir );
145 if( ( file = utf8_fopen( dir, "r" ) ) != NULL )
150 msg_Dbg( p_intf, "find .access in dir=%s", psz_dir );
152 i_size = fread( line, 1, 1023, file );
156 while( i_size > 0 && ( line[i_size-1] == '\n' ||
157 line[i_size-1] == '\r' ) )
164 p = strchr( line, ':' );
168 user = strdup( line );
169 password = strdup( p );
172 msg_Dbg( p_intf, "using user=%s (read=%d)", user, i_size );
177 snprintf( dir, sizeof( dir ), "%s"DIR_SEP".hosts", psz_dir );
178 p_acl = ACL_Create( p_intf, false );
179 if( ACL_LoadFile( p_acl, dir ) )
181 ACL_Destroy( p_acl );
184 if( utf8_stat( dir, &st ) == 0 )
197 /* parse psz_src dir */
198 if( ( psz_filename = utf8_readdir( p_dir ) ) == NULL )
203 if( ( psz_filename[0] == '.' )
204 || ( i_dirlen + strlen( psz_filename ) > MAX_DIR_SIZE ) )
206 free( psz_filename );
210 snprintf( dir, sizeof( dir ), "%s"DIR_SEP"%s", psz_dir, psz_filename );
211 free( psz_filename );
213 if( ParseDirectory( p_intf, psz_root, dir ) )
215 httpd_file_sys_t *f = NULL;
216 httpd_handler_sys_t *h = NULL;
218 char *psz_name, *psz_ext;
220 psz_name = FileToUrl( &dir[strlen( psz_root )], &b_index );
221 psz_ext = strrchr( dir, '.' );
222 if( psz_ext != NULL )
226 for( i = 0; i < p_sys->i_handlers; i++ )
227 if( !strcmp( p_sys->pp_handlers[i]->psz_ext, psz_ext ) )
229 if( i < p_sys->i_handlers )
231 f = malloc( sizeof( httpd_handler_sys_t ) );
232 h = (httpd_handler_sys_t *)f;
234 h->p_association = p_sys->pp_handlers[i];
239 f = xmalloc( sizeof( httpd_file_sys_t ) );
240 f->b_handler = false;
247 f->file = strdup (dir);
249 f->b_html = strstr( &dir[strlen( psz_root )], ".htm" ) || strstr( &dir[strlen( psz_root )], ".xml" ) ? true : false;
253 msg_Err( p_intf , "unable to parse directory" );
256 return( VLC_ENOMEM );
258 msg_Dbg( p_intf, "file=%s (url=%s)",
263 char *psz_type = strdup( "text/html; charset=UTF-8" );
264 if( strstr( &dir[strlen( psz_root )], ".xml" ) )
266 char *psz = strstr( psz_type, "html;" );
276 f->p_file = httpd_FileNew( p_sys->p_httpd_host,
278 f->b_html ? psz_type : NULL,
279 user, password, p_acl,
282 if( f->p_file != NULL )
284 TAB_APPEND( p_sys->i_files, p_sys->pp_files, f );
289 h->p_handler = httpd_HandlerNew( p_sys->p_httpd_host,
291 user, password, p_acl,
292 HandlerCallback, h );
293 if( h->p_handler != NULL )
295 TAB_APPEND( p_sys->i_files, p_sys->pp_files,
296 (httpd_file_sys_t *)h );
300 /* for url that ends by / add
301 * - a redirect from rep to rep/
302 * - in case of index.* rep/index.html to rep/ */
303 if( f && f->name[strlen(f->name) - 1] == '/' )
305 char *psz_redir = strdup( f->name );
307 psz_redir[strlen( psz_redir ) - 1] = '\0';
309 msg_Dbg( p_intf, "redir=%s -> %s", psz_redir, f->name );
310 f->p_redir = httpd_RedirectNew( p_sys->p_httpd_host, f->name, psz_redir );
313 if( b_index && ( p = strstr( f->file, "index." ) ) )
315 if( asprintf( &psz_redir, "%s%s", f->name, p ) != -1 )
317 msg_Dbg( p_intf, "redir=%s -> %s", psz_redir, f->name );
318 f->p_redir2 = httpd_RedirectNew( p_sys->p_httpd_host,
319 f->name, psz_redir );
331 ACL_Destroy( p_acl );
338 /*************************************************************************
340 *************************************************************************/
341 void PlaylistListNode( intf_thread_t *p_intf, playlist_t *p_pl,
342 playlist_item_t *p_node, char *name, mvar_t *s,
345 if( !p_node || !p_node->p_input )
348 if( p_node->i_children == -1 )
352 playlist_item_t * p_item = playlist_CurrentPlayingItem( p_pl );
353 if( !p_item || !p_item->p_input )
356 mvar_t *itm = mvar_New( name, "set" );
357 if( p_item->p_input == p_node->p_input )
358 mvar_AppendNewVar( itm, "current", "1" );
360 mvar_AppendNewVar( itm, "current", "0" );
362 sprintf( value, "%d", p_node->i_id );
363 mvar_AppendNewVar( itm, "index", value );
365 psz = input_item_GetName( p_node->p_input );
366 mvar_AppendNewVar( itm, "name", psz );
369 psz = input_item_GetURI( p_node->p_input );
370 mvar_AppendNewVar( itm, "uri", psz );
373 mvar_AppendNewVar( itm, "type", "Item" );
375 sprintf( value, "%d", i_depth );
376 mvar_AppendNewVar( itm, "depth", value );
378 if( p_node->i_flags & PLAYLIST_RO_FLAG )
379 mvar_AppendNewVar( itm, "ro", "ro" );
381 mvar_AppendNewVar( itm, "ro", "rw" );
383 sprintf( value, "%"PRId64, input_item_GetDuration( p_node->p_input ) );
384 mvar_AppendNewVar( itm, "duration", value );
386 //Adding extra meta-information to each playlist item
388 psz = input_item_GetTitle( p_node->p_input );
389 mvar_AppendNewVar( itm, "title", psz );
392 psz = input_item_GetArtist( p_node->p_input );
393 mvar_AppendNewVar( itm, "artist", psz );
396 psz = input_item_GetGenre( p_node->p_input );
397 mvar_AppendNewVar( itm, "genre", psz );
400 psz = input_item_GetCopyright( p_node->p_input );
401 mvar_AppendNewVar( itm, "copyright", psz );
404 psz = input_item_GetAlbum( p_node->p_input );
405 mvar_AppendNewVar( itm, "album", psz );
408 psz = input_item_GetTrackNum( p_node->p_input );
409 mvar_AppendNewVar( itm, "track", psz );
412 psz = input_item_GetDescription( p_node->p_input );
413 mvar_AppendNewVar( itm, "description", psz );
416 psz = input_item_GetRating( p_node->p_input );
417 mvar_AppendNewVar( itm, "rating", psz );
420 psz = input_item_GetDate( p_node->p_input );
421 mvar_AppendNewVar( itm, "date", psz );
424 psz = input_item_GetURL( p_node->p_input );
425 mvar_AppendNewVar( itm, "url", psz );
428 psz = input_item_GetLanguage( p_node->p_input );
429 mvar_AppendNewVar( itm, "language", psz );
432 psz = input_item_GetNowPlaying( p_node->p_input );
433 mvar_AppendNewVar( itm, "now_playing", psz );
436 psz = input_item_GetPublisher( p_node->p_input );
437 mvar_AppendNewVar( itm, "publisher", psz );
440 psz = input_item_GetEncodedBy( p_node->p_input );
441 mvar_AppendNewVar( itm, "encoded_by", psz );
444 psz = input_item_GetArtURL( p_node->p_input );
445 mvar_AppendNewVar( itm, "art_url", psz );
448 psz = input_item_GetTrackID( p_node->p_input );
449 mvar_AppendNewVar( itm, "track_id", psz );
452 mvar_AppendVar( s, itm );
458 mvar_t *itm = mvar_New( name, "set" );
460 mvar_AppendNewVar( itm, "name", p_node->p_input->psz_name );
461 mvar_AppendNewVar( itm, "uri", p_node->p_input->psz_name );
463 mvar_AppendNewVar( itm, "type", "Node" );
465 sprintf( value, "%d", p_node->i_id );
466 mvar_AppendNewVar( itm, "index", value );
468 sprintf( value, "%d", p_node->i_children);
469 mvar_AppendNewVar( itm, "i_children", value );
471 sprintf( value, "%d", i_depth );
472 mvar_AppendNewVar( itm, "depth", value );
474 if( p_node->i_flags & PLAYLIST_RO_FLAG )
475 mvar_AppendNewVar( itm, "ro", "ro" );
477 mvar_AppendNewVar( itm, "ro", "rw" );
479 mvar_AppendVar( s, itm );
481 for( i_child = 0 ; i_child < p_node->i_children ; i_child++ )
482 PlaylistListNode( p_intf, p_pl, p_node->pp_children[i_child],
483 name, s, i_depth + 1);
487 /****************************************************************************
488 * Seek command parsing handling
489 ****************************************************************************/
490 void HandleSeek( intf_thread_t *p_intf, char *p_value )
492 intf_sys_t *p_sys = p_intf->p_sys;
498 #define POSITION_ABSOLUTE 12
499 #define POSITION_REL_FOR 13
500 #define POSITION_REL_BACK 11
501 #define VL_TIME_ABSOLUTE 0
502 #define VL_TIME_REL_FOR 1
503 #define VL_TIME_REL_BACK -1
506 var_Get( p_sys->p_input, "length", &val );
507 i_length = val.i_time;
509 while( p_value[0] != '\0' )
515 i_relative = VL_TIME_REL_FOR;
521 i_relative = VL_TIME_REL_BACK;
525 case '0': case '1': case '2': case '3': case '4':
526 case '5': case '6': case '7': case '8': case '9':
528 i_stock = strtol( p_value , &p_value , 10 );
531 case '%': /* for percentage ie position */
533 i_relative += POSITION_ABSOLUTE;
541 i_value = 60 * (i_value + i_stock) ;
546 case 'h': case 'H': /* hours */
548 i_value += 3600 * i_stock;
550 /* other characters which are not numbers are not
552 while( ((p_value[0] < '0') || (p_value[0] > '9'))
553 && (p_value[0] != '\0') )
559 case 'm': case 'M': case '\'': /* minutes */
561 i_value += 60 * i_stock;
564 while( ((p_value[0] < '0') || (p_value[0] > '9'))
565 && (p_value[0] != '\0') )
571 case 's': case 'S': case '"': /* seconds */
575 while( ((p_value[0] < '0') || (p_value[0] > '9'))
576 && (p_value[0] != '\0') )
590 /* if there is no known symbol, I consider it as seconds.
591 * Otherwise, i_stock = 0 */
596 case VL_TIME_ABSOLUTE:
598 if( (uint64_t)( i_value ) * 1000000 <= i_length )
599 val.i_time = (uint64_t)( i_value ) * 1000000;
601 val.i_time = i_length;
603 var_Set( p_sys->p_input, "time", val );
604 msg_Dbg( p_intf, "requested seek position: %dsec", i_value );
607 case VL_TIME_REL_FOR:
609 var_Get( p_sys->p_input, "time", &val );
610 if( (uint64_t)( i_value ) * 1000000 + val.i_time <= i_length )
612 val.i_time = ((uint64_t)( i_value ) * 1000000) + val.i_time;
615 val.i_time = i_length;
617 var_Set( p_sys->p_input, "time", val );
618 msg_Dbg( p_intf, "requested seek position forward: %dsec", i_value );
621 case VL_TIME_REL_BACK:
623 var_Get( p_sys->p_input, "time", &val );
624 if( (int64_t)( i_value ) * 1000000 > val.i_time )
629 val.i_time = val.i_time - ((uint64_t)( i_value ) * 1000000);
631 var_Set( p_sys->p_input, "time", val );
632 msg_Dbg( p_intf, "requested seek position backward: %dsec", i_value );
635 case POSITION_ABSOLUTE:
637 val.f_float = __MIN( __MAX( ((float) i_value ) / 100.0 ,
639 var_Set( p_sys->p_input, "position", val );
640 msg_Dbg( p_intf, "requested seek percent: %d%%", i_value );
643 case POSITION_REL_FOR:
645 var_Get( p_sys->p_input, "position", &val );
646 val.f_float += __MIN( __MAX( ((float) i_value ) / 100.0,
648 var_Set( p_sys->p_input, "position", val );
649 msg_Dbg( p_intf, "requested seek percent forward: %d%%",
653 case POSITION_REL_BACK:
655 var_Get( p_sys->p_input, "position", &val );
656 val.f_float -= __MIN( __MAX( ((float) i_value ) / 100.0,
658 var_Set( p_sys->p_input, "position", val );
659 msg_Dbg( p_intf, "requested seek percent backward: %d%%",
665 msg_Dbg( p_intf, "invalid seek request" );
670 #undef POSITION_ABSOLUTE
671 #undef POSITION_REL_FOR
672 #undef POSITION_REL_BACK
673 #undef VL_TIME_ABSOLUTE
674 #undef VL_TIME_REL_FOR
675 #undef VL_TIME_REL_BACK
679 /****************************************************************************
680 * URI Parsing functions
681 ****************************************************************************/
682 int TestURIParam( char *psz_uri, const char *psz_name )
686 while( (p = strstr( p, psz_name )) )
688 /* Verify that we are dealing with a post/get argument */
689 if( (p == psz_uri || *(p - 1) == '&' || *(p - 1) == '\n')
690 && p[strlen(psz_name)] == '=' )
700 static const char *FindURIValue( const char *psz_uri, const char *restrict psz_name,
701 size_t *restrict p_len )
703 const char *p = psz_uri, *end;
706 while( (p = strstr( p, psz_name )) )
708 /* Verify that we are dealing with a post/get argument */
709 if( (p == psz_uri || *(p - 1) == '&' || *(p - 1) == '\n')
710 && p[strlen(psz_name)] == '=' )
721 p += strlen( psz_name );
724 if( ( end = strchr( p, '\n' ) ) != NULL )
727 if( ( end > p ) && ( end[-1] == '\r' ) )
735 if( ( end = strchr( p, '&' ) ) != NULL )
745 const char *ExtractURIValue( const char *restrict psz_uri,
746 const char *restrict psz_name,
747 char *restrict psz_buf, size_t bufsize )
750 const char *psz_value = FindURIValue( psz_uri, psz_name, &len );
751 const char *psz_next;
753 if( psz_value == NULL )
760 psz_next = psz_value + len;
766 strncpy( psz_buf, psz_value, len );
773 char *ExtractURIString( const char *restrict psz_uri,
774 const char *restrict psz_name )
777 const char *psz_value = FindURIValue( psz_uri, psz_name, &len );
779 if( psz_value == NULL )
782 char *res = malloc( len + 1 );
786 memcpy( res, psz_value, len );
792 /* Since the resulting string is smaller we can work in place, so it is
793 * permitted to have psz == new. new points to the first word of the
794 * string, the function returns the remaining string. */
795 char *FirstWord( char *psz, char *new )
802 while( *psz != '\0' && *psz != ' ' )
807 while( *psz != '\0' && *psz != c )
809 if( *psz == '\\' && psz[1] != '\0' )
818 if( *psz == '\\' && psz[1] != '\0' )
832 /**********************************************************************
833 * MRLParse: parse the MRL, find the MRL string and the options,
834 * create an item with all information in it, and return the item.
835 * return NULL if there is an error.
836 **********************************************************************/
838 /* Function analog to FirstWord except that it relies on colon instead
839 * of space to delimit option boundaries. */
840 static char *FirstOption( char *psz, char *new )
842 bool b_end, b_start = true;
847 while( *psz != '\0' && (*psz != ' ' || psz[1] != ':') )
852 while( *psz != '\0' && *psz != c )
854 if( *psz == '\\' && psz[1] != '\0' )
864 if( *psz == '\\' && psz[1] != '\0' )
873 while (new[-1] == ' ')
883 input_item_t *MRLParse( intf_thread_t *p_intf, const char *mrl,
886 char *psz = strdup( mrl ), *s_mrl = psz, *s_temp;
889 /* extract the mrl */
890 s_temp = FirstOption( s_mrl, s_mrl );
893 s_temp = s_mrl + strlen( s_mrl );
896 input_item_t *p_input = input_item_New( p_intf, s_mrl, psz_name );
897 if( p_input == NULL )
901 /* now we can take care of the options */
902 while ( *s_mrl != '\0' )
904 s_temp = FirstOption( s_mrl, s_mrl );
909 s_temp = s_mrl + strlen( s_mrl );
911 input_item_AddOption( p_input, s_mrl, VLC_INPUT_OPTION_TRUSTED );
918 /**********************************************************************
919 * RealPath: parse ../, ~ and path stuff
920 **********************************************************************/
921 char *RealPath( const char *psz_src )
925 int i_len = strlen(psz_src);
927 psz_dir = xmalloc( i_len + 2 );
928 strcpy( psz_dir, psz_src );
930 /* Add a trailing sep to ease the .. step */
931 psz_dir[i_len] = DIR_SEP_CHAR;
932 psz_dir[i_len + 1] = '\0';
934 #if (DIR_SEP_CHAR != '/')
935 /* Convert all / to native separator */
937 while( (p = strchr( p, '/' )) != NULL )
943 /* FIXME: this could be O(N) rather than O(N²)... */
944 /* Remove multiple separators and /./ */
946 while( (p = strchr( p, DIR_SEP_CHAR )) != NULL )
948 if( p[1] == DIR_SEP_CHAR )
949 memmove( &p[1], &p[2], strlen(&p[2]) + 1 );
950 else if( p[1] == '.' && p[2] == DIR_SEP_CHAR )
951 memmove( &p[1], &p[3], strlen(&p[3]) + 1 );
956 if( psz_dir[0] == '~' )
958 char *home = config_GetUserDir( VLC_HOME_DIR ), *dir;
959 if( asprintf( &dir, "%s%s", home, psz_dir + 1 ) != -1 )
967 if( strlen(psz_dir) > 2 )
971 while( (p = strchr( p, DIR_SEP_CHAR )) != NULL )
973 if( p[-1] == '.' && p[-2] == '.' && p[-3] == DIR_SEP_CHAR )
977 if( (q = strrchr( psz_dir, DIR_SEP_CHAR )) != NULL )
979 memmove( q + 1, p + 1, strlen(p + 1) + 1 );
984 memmove( psz_dir, p, strlen(p) + 1 );
993 /* Remove trailing sep if there are at least 2 sep in the string
994 * (handles the C:\ stuff) */
995 p = strrchr( psz_dir, DIR_SEP_CHAR );
996 if( p != NULL && p[1] == '\0' && p != strchr( psz_dir, DIR_SEP_CHAR ) )