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 *****************************************************************************/
32 #include <vlc_common.h>
34 #include <vlc_strings.h>
35 #include <vlc_memory.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 = malloc( 1025 ); /* +1 for \0 */
99 while( ( i_read = fread( &(*pp_data)[*pi_data], 1, 1024, f ) ) == 1024 )
102 *pp_data = realloc_or_free( *pp_data, *pi_data + 1025 );
109 (*pp_data)[*pi_data] = '\0';
114 /* Parse a directory and recursively add files */
115 int ParseDirectory( intf_thread_t *p_intf, char *psz_root,
118 intf_sys_t *p_sys = p_intf->p_sys;
119 char dir[MAX_DIR_SIZE];
125 char *password = NULL;
129 if( ( p_dir = utf8_opendir( psz_dir ) ) == NULL )
131 if( errno != ENOENT && errno != ENOTDIR )
132 msg_Err( p_intf, "cannot open directory (%s)", psz_dir );
136 i_dirlen = strlen( psz_dir );
137 if( i_dirlen + 10 > MAX_DIR_SIZE )
139 msg_Warn( p_intf, "skipping too deep directory (%s)", psz_dir );
144 msg_Dbg( p_intf, "dir=%s", psz_dir );
146 snprintf( dir, sizeof( dir ), "%s"DIR_SEP".access", psz_dir );
147 if( ( file = utf8_fopen( dir, "r" ) ) != NULL )
152 msg_Dbg( p_intf, "find .access in dir=%s", psz_dir );
154 i_size = fread( line, 1, 1023, file );
158 while( i_size > 0 && ( line[i_size-1] == '\n' ||
159 line[i_size-1] == '\r' ) )
166 p = strchr( line, ':' );
170 user = strdup( line );
171 password = strdup( p );
174 msg_Dbg( p_intf, "using user=%s (read=%d)", user, i_size );
179 snprintf( dir, sizeof( dir ), "%s"DIR_SEP".hosts", psz_dir );
180 p_acl = ACL_Create( p_intf, false );
181 if( ACL_LoadFile( p_acl, dir ) )
183 ACL_Destroy( p_acl );
186 if( utf8_stat( dir, &st ) == 0 )
199 /* parse psz_src dir */
200 if( ( psz_filename = utf8_readdir( p_dir ) ) == NULL )
205 if( ( psz_filename[0] == '.' )
206 || ( i_dirlen + strlen( psz_filename ) > MAX_DIR_SIZE ) )
208 free( psz_filename );
212 snprintf( dir, sizeof( dir ), "%s"DIR_SEP"%s", psz_dir, psz_filename );
213 free( psz_filename );
215 if( ParseDirectory( p_intf, psz_root, dir ) )
217 httpd_file_sys_t *f = NULL;
218 httpd_handler_sys_t *h = NULL;
220 char *psz_name, *psz_ext;
222 psz_name = FileToUrl( &dir[strlen( psz_root )], &b_index );
223 psz_ext = strrchr( dir, '.' );
224 if( psz_ext != NULL )
228 for( i = 0; i < p_sys->i_handlers; i++ )
229 if( !strcmp( p_sys->pp_handlers[i]->psz_ext, psz_ext ) )
231 if( i < p_sys->i_handlers )
233 f = malloc( sizeof( httpd_handler_sys_t ) );
234 h = (httpd_handler_sys_t *)f;
236 h->p_association = p_sys->pp_handlers[i];
241 f = malloc( sizeof( httpd_file_sys_t ) );
242 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 == p_node->p_input )
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 mvar_AppendNewVar( itm, "type", "Item" );
378 sprintf( value, "%d", i_depth );
379 mvar_AppendNewVar( itm, "depth", value );
381 if( p_node->i_flags & PLAYLIST_RO_FLAG )
382 mvar_AppendNewVar( itm, "ro", "ro" );
384 mvar_AppendNewVar( itm, "ro", "rw" );
386 sprintf( value, "%"PRId64, input_item_GetDuration( p_node->p_input ) );
387 mvar_AppendNewVar( itm, "duration", value );
389 //Adding extra meta-information to each playlist item
391 psz = input_item_GetTitle( p_node->p_input );
392 mvar_AppendNewVar( itm, "title", psz );
395 psz = input_item_GetArtist( p_node->p_input );
396 mvar_AppendNewVar( itm, "artist", psz );
399 psz = input_item_GetGenre( p_node->p_input );
400 mvar_AppendNewVar( itm, "genre", psz );
403 psz = input_item_GetCopyright( p_node->p_input );
404 mvar_AppendNewVar( itm, "copyright", psz );
407 psz = input_item_GetAlbum( p_node->p_input );
408 mvar_AppendNewVar( itm, "album", psz );
411 psz = input_item_GetTrackNum( p_node->p_input );
412 mvar_AppendNewVar( itm, "track", psz );
415 psz = input_item_GetDescription( p_node->p_input );
416 mvar_AppendNewVar( itm, "description", psz );
419 psz = input_item_GetRating( p_node->p_input );
420 mvar_AppendNewVar( itm, "rating", psz );
423 psz = input_item_GetDate( p_node->p_input );
424 mvar_AppendNewVar( itm, "date", psz );
427 psz = input_item_GetURL( p_node->p_input );
428 mvar_AppendNewVar( itm, "url", psz );
431 psz = input_item_GetLanguage( p_node->p_input );
432 mvar_AppendNewVar( itm, "language", psz );
435 psz = input_item_GetNowPlaying( p_node->p_input );
436 mvar_AppendNewVar( itm, "now_playing", psz );
439 psz = input_item_GetPublisher( p_node->p_input );
440 mvar_AppendNewVar( itm, "publisher", psz );
443 psz = input_item_GetEncodedBy( p_node->p_input );
444 mvar_AppendNewVar( itm, "encoded_by", psz );
447 psz = input_item_GetArtURL( p_node->p_input );
448 mvar_AppendNewVar( itm, "art_url", psz );
451 psz = input_item_GetTrackID( p_node->p_input );
452 mvar_AppendNewVar( itm, "track_id", psz );
455 mvar_AppendVar( s, itm );
461 mvar_t *itm = mvar_New( name, "set" );
463 mvar_AppendNewVar( itm, "name", p_node->p_input->psz_name );
464 mvar_AppendNewVar( itm, "uri", p_node->p_input->psz_name );
466 mvar_AppendNewVar( itm, "type", "Node" );
468 sprintf( value, "%d", p_node->i_id );
469 mvar_AppendNewVar( itm, "index", value );
471 sprintf( value, "%d", p_node->i_children);
472 mvar_AppendNewVar( itm, "i_children", value );
474 sprintf( value, "%d", i_depth );
475 mvar_AppendNewVar( itm, "depth", value );
477 if( p_node->i_flags & PLAYLIST_RO_FLAG )
478 mvar_AppendNewVar( itm, "ro", "ro" );
480 mvar_AppendNewVar( itm, "ro", "rw" );
482 mvar_AppendVar( s, itm );
484 for( i_child = 0 ; i_child < p_node->i_children ; i_child++ )
485 PlaylistListNode( p_intf, p_pl, p_node->pp_children[i_child],
486 name, s, i_depth + 1);
490 /****************************************************************************
491 * Seek command parsing handling
492 ****************************************************************************/
493 void HandleSeek( intf_thread_t *p_intf, char *p_value )
495 intf_sys_t *p_sys = p_intf->p_sys;
501 #define POSITION_ABSOLUTE 12
502 #define POSITION_REL_FOR 13
503 #define POSITION_REL_BACK 11
504 #define VL_TIME_ABSOLUTE 0
505 #define VL_TIME_REL_FOR 1
506 #define VL_TIME_REL_BACK -1
509 var_Get( p_sys->p_input, "length", &val );
510 i_length = val.i_time;
512 while( p_value[0] != '\0' )
518 i_relative = VL_TIME_REL_FOR;
524 i_relative = VL_TIME_REL_BACK;
528 case '0': case '1': case '2': case '3': case '4':
529 case '5': case '6': case '7': case '8': case '9':
531 i_stock = strtol( p_value , &p_value , 10 );
534 case '%': /* for percentage ie position */
536 i_relative += POSITION_ABSOLUTE;
544 i_value = 60 * (i_value + i_stock) ;
549 case 'h': case 'H': /* hours */
551 i_value += 3600 * i_stock;
553 /* other characters which are not numbers are not
555 while( ((p_value[0] < '0') || (p_value[0] > '9'))
556 && (p_value[0] != '\0') )
562 case 'm': case 'M': case '\'': /* minutes */
564 i_value += 60 * i_stock;
567 while( ((p_value[0] < '0') || (p_value[0] > '9'))
568 && (p_value[0] != '\0') )
574 case 's': case 'S': case '"': /* seconds */
578 while( ((p_value[0] < '0') || (p_value[0] > '9'))
579 && (p_value[0] != '\0') )
593 /* if there is no known symbol, I consider it as seconds.
594 * Otherwise, i_stock = 0 */
599 case VL_TIME_ABSOLUTE:
601 if( (uint64_t)( i_value ) * 1000000 <= i_length )
602 val.i_time = (uint64_t)( i_value ) * 1000000;
604 val.i_time = i_length;
606 var_Set( p_sys->p_input, "time", val );
607 msg_Dbg( p_intf, "requested seek position: %dsec", i_value );
610 case VL_TIME_REL_FOR:
612 var_Get( p_sys->p_input, "time", &val );
613 if( (uint64_t)( i_value ) * 1000000 + val.i_time <= i_length )
615 val.i_time = ((uint64_t)( i_value ) * 1000000) + val.i_time;
618 val.i_time = i_length;
620 var_Set( p_sys->p_input, "time", val );
621 msg_Dbg( p_intf, "requested seek position forward: %dsec", i_value );
624 case VL_TIME_REL_BACK:
626 var_Get( p_sys->p_input, "time", &val );
627 if( (int64_t)( i_value ) * 1000000 > val.i_time )
632 val.i_time = val.i_time - ((uint64_t)( i_value ) * 1000000);
634 var_Set( p_sys->p_input, "time", val );
635 msg_Dbg( p_intf, "requested seek position backward: %dsec", i_value );
638 case POSITION_ABSOLUTE:
640 val.f_float = __MIN( __MAX( ((float) i_value ) / 100.0 ,
642 var_Set( p_sys->p_input, "position", val );
643 msg_Dbg( p_intf, "requested seek percent: %d%%", i_value );
646 case POSITION_REL_FOR:
648 var_Get( p_sys->p_input, "position", &val );
649 val.f_float += __MIN( __MAX( ((float) i_value ) / 100.0,
651 var_Set( p_sys->p_input, "position", val );
652 msg_Dbg( p_intf, "requested seek percent forward: %d%%",
656 case POSITION_REL_BACK:
658 var_Get( p_sys->p_input, "position", &val );
659 val.f_float -= __MIN( __MAX( ((float) i_value ) / 100.0,
661 var_Set( p_sys->p_input, "position", val );
662 msg_Dbg( p_intf, "requested seek percent backward: %d%%",
668 msg_Dbg( p_intf, "invalid seek request" );
673 #undef POSITION_ABSOLUTE
674 #undef POSITION_REL_FOR
675 #undef POSITION_REL_BACK
676 #undef VL_TIME_ABSOLUTE
677 #undef VL_TIME_REL_FOR
678 #undef VL_TIME_REL_BACK
682 /****************************************************************************
683 * URI Parsing functions
684 ****************************************************************************/
685 int TestURIParam( char *psz_uri, const char *psz_name )
689 while( (p = strstr( p, psz_name )) )
691 /* Verify that we are dealing with a post/get argument */
692 if( (p == psz_uri || *(p - 1) == '&' || *(p - 1) == '\n')
693 && p[strlen(psz_name)] == '=' )
703 static const char *FindURIValue( const char *psz_uri, const char *restrict psz_name,
704 size_t *restrict p_len )
706 const char *p = psz_uri, *end;
709 while( (p = strstr( p, psz_name )) )
711 /* Verify that we are dealing with a post/get argument */
712 if( (p == psz_uri || *(p - 1) == '&' || *(p - 1) == '\n')
713 && p[strlen(psz_name)] == '=' )
724 p += strlen( psz_name );
727 if( ( end = strchr( p, '\n' ) ) != NULL )
730 if( ( end > p ) && ( end[-1] == '\r' ) )
738 if( ( end = strchr( p, '&' ) ) != NULL )
748 const char *ExtractURIValue( const char *restrict psz_uri,
749 const char *restrict psz_name,
750 char *restrict psz_buf, size_t bufsize )
753 const char *psz_value = FindURIValue( psz_uri, psz_name, &len );
754 const char *psz_next;
756 if( psz_value == NULL )
763 psz_next = psz_value + len;
769 strncpy( psz_buf, psz_value, len );
776 char *ExtractURIString( const char *restrict psz_uri,
777 const char *restrict psz_name )
780 const char *psz_value = FindURIValue( psz_uri, psz_name, &len );
782 if( psz_value == NULL )
785 char *res = malloc( len + 1 );
789 memcpy( res, psz_value, len );
795 /* Since the resulting string is smaller we can work in place, so it is
796 * permitted to have psz == new. new points to the first word of the
797 * string, the function returns the remaining string. */
798 char *FirstWord( char *psz, char *new )
805 while( *psz != '\0' && *psz != ' ' )
810 while( *psz != '\0' && *psz != c )
812 if( *psz == '\\' && psz[1] != '\0' )
821 if( *psz == '\\' && psz[1] != '\0' )
835 /**********************************************************************
836 * MRLParse: parse the MRL, find the MRL string and the options,
837 * create an item with all information in it, and return the item.
838 * return NULL if there is an error.
839 **********************************************************************/
841 /* Function analog to FirstWord except that it relies on colon instead
842 * of space to delimit option boundaries. */
843 static char *FirstOption( char *psz, char *new )
845 bool b_end, b_start = true;
850 while( *psz != '\0' && (*psz != ' ' || psz[1] != ':') )
855 while( *psz != '\0' && *psz != c )
857 if( *psz == '\\' && psz[1] != '\0' )
867 if( *psz == '\\' && psz[1] != '\0' )
876 while (new[-1] == ' ')
886 input_item_t *MRLParse( intf_thread_t *p_intf, const char *mrl,
889 char *psz = strdup( mrl ), *s_mrl = psz, *s_temp;
892 /* extract the mrl */
893 s_temp = FirstOption( s_mrl, s_mrl );
896 s_temp = s_mrl + strlen( s_mrl );
899 input_item_t *p_input = input_item_New( p_intf, s_mrl, psz_name );
900 if( p_input == NULL )
904 /* now we can take care of the options */
905 while ( *s_mrl != '\0' )
907 s_temp = FirstOption( s_mrl, s_mrl );
912 s_temp = s_mrl + strlen( s_mrl );
914 input_item_AddOption( p_input, s_mrl, VLC_INPUT_OPTION_TRUSTED );
921 /**********************************************************************
922 * RealPath: parse ../, ~ and path stuff
923 **********************************************************************/
924 char *RealPath( const char *psz_src )
928 int i_len = strlen(psz_src);
930 psz_dir = malloc( i_len + 2 );
932 strcpy( psz_dir, psz_src );
934 /* Add a trailing sep to ease the .. step */
935 psz_dir[i_len] = DIR_SEP_CHAR;
936 psz_dir[i_len + 1] = '\0';
938 #if (DIR_SEP_CHAR != '/')
939 /* Convert all / to native separator */
941 while( (p = strchr( p, '/' )) != NULL )
947 /* FIXME: this could be O(N) rather than O(N²)... */
948 /* Remove multiple separators and /./ */
950 while( (p = strchr( p, DIR_SEP_CHAR )) != NULL )
952 if( p[1] == DIR_SEP_CHAR )
953 memmove( &p[1], &p[2], strlen(&p[2]) + 1 );
954 else if( p[1] == '.' && p[2] == DIR_SEP_CHAR )
955 memmove( &p[1], &p[3], strlen(&p[3]) + 1 );
960 if( psz_dir[0] == '~' )
962 char *home = config_GetUserDir( VLC_HOME_DIR ), *dir;
963 asprintf( &dir, "%s%s", home, psz_dir + 1 );
969 if( strlen(psz_dir) > 2 )
973 while( (p = strchr( p, DIR_SEP_CHAR )) != NULL )
975 if( p[-1] == '.' && p[-2] == '.' && p[-3] == DIR_SEP_CHAR )
979 if( (q = strrchr( psz_dir, DIR_SEP_CHAR )) != NULL )
981 memmove( q + 1, p + 1, strlen(p + 1) + 1 );
986 memmove( psz_dir, p, strlen(p) + 1 );
995 /* Remove trailing sep if there are at least 2 sep in the string
996 * (handles the C:\ stuff) */
997 p = strrchr( psz_dir, DIR_SEP_CHAR );
998 if( p != NULL && p[1] == '\0' && p != strchr( psz_dir, DIR_SEP_CHAR ) )