1 /*****************************************************************************
2 * zipstream.c: stream_filter that creates a XSPF playlist from a Zip archive
3 *****************************************************************************
4 * Copyright (C) 2009 the VideoLAN team
7 * Authors: Jean-Philippe André <jpeg@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /** **************************************************************************
26 *****************************************************************************/
36 #include <vlc_input.h>
38 #define FILENAME_TEXT N_( "Media in Zip" )
39 #define FILENAME_LONGTEXT N_( "Path to the media in the Zip archive" )
41 /** **************************************************************************
43 *****************************************************************************/
45 set_shortname( "Zip" )
46 set_category( CAT_INPUT )
47 set_subcategory( SUBCAT_INPUT_STREAM_FILTER )
48 set_description( N_( "Zip files filter" ) )
49 set_capability( "stream_filter", 1 )
50 set_callbacks( StreamOpen, StreamClose )
52 set_subcategory( SUBCAT_INPUT_ACCESS )
53 set_description( N_( "Zip access" ) )
54 set_capability( "access", 0 )
55 add_shortcut( "unzip" )
57 set_callbacks( AccessOpen, AccessClose )
60 /** *************************************************************************
62 ****************************************************************************/
63 static int Read ( stream_t *, void *p_read, unsigned int i_read );
64 static int Peek ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
65 static int Control( stream_t *, int i_query, va_list );
67 typedef struct node node;
68 typedef struct item item;
70 static int CreatePlaylist( stream_t *s, char **pp_buffer );
71 static int GetFilesInZip( stream_t*, unzFile, vlc_array_t*, vlc_array_t* );
72 static node* findOrCreateParentNode( node *root, const char *fullpath );
73 static int WriteXSPF( char **pp_buffer, vlc_array_t *p_filenames,
74 const char *psz_zippath );
75 static int nodeToXSPF( char **pp_buffer, node *n, bool b_root );
76 static node* findOrCreateParentNode( node *root, const char *fullpath );
78 /** **************************************************************************
80 *****************************************************************************/
83 /* zlib / unzip members */
85 zlib_filefunc_def *fileFunctions;
106 /** **************************************************************************
108 *****************************************************************************/
110 inline static node* new_node( char *name )
112 node *n = (node*) calloc( 1, sizeof(node) );
113 n->name = convert_xml_special_chars( name );
117 inline static item* new_item( int id )
119 item *media = (item*) calloc( 1, sizeof(item) );
124 inline static void free_all_node( node *root )
128 free_all_node( root->child );
130 node *tmp = root->next;
136 /* Allocate strcat and format */
137 static int astrcatf( char **ppsz_dest, const char *psz_fmt_src, ... )
140 va_start( args, psz_fmt_src );
143 int i_ret = vasprintf( &psz_tmp, psz_fmt_src, args );
144 if( i_ret == -1 ) return -1;
148 int i_len = strlen( *ppsz_dest ) + strlen( psz_tmp ) + 1;
149 char *psz_out = realloc( *ppsz_dest, i_len );
150 if( !psz_out ) return -1;
152 strcat( psz_out, psz_tmp );
155 *ppsz_dest = psz_out;
159 /** **************************************************************************
160 * Zip file identifier
161 *****************************************************************************/
162 static const uint8_t p_zip_marker[] = { 0x50, 0x4b, 0x03, 0x04 }; // "PK^C^D"
163 static const int i_zip_marker = 4;
166 /** **************************************************************************
168 *****************************************************************************/
169 int StreamOpen( vlc_object_t *p_this )
171 stream_t *s = (stream_t*) p_this;
174 /* Verify file format */
175 const uint8_t *p_peek;
176 if( stream_Peek( s->p_source, &p_peek, i_zip_marker ) < i_zip_marker )
178 if( memcmp( p_peek, p_zip_marker, i_zip_marker ) )
181 s->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
187 s->pf_control = Control;
189 p_sys->fileFunctions = ( zlib_filefunc_def * )
190 calloc( 1, sizeof( zlib_filefunc_def ) );
191 if( !p_sys->fileFunctions )
196 p_sys->fileFunctions->zopen_file = ZipIO_Open;
197 p_sys->fileFunctions->zread_file = ZipIO_Read;
198 p_sys->fileFunctions->zwrite_file = ZipIO_Write;
199 p_sys->fileFunctions->ztell_file = ZipIO_Tell;
200 p_sys->fileFunctions->zseek_file = ZipIO_Seek;
201 p_sys->fileFunctions->zclose_file = ZipIO_Close;
202 p_sys->fileFunctions->zerror_file = ZipIO_Error;
203 p_sys->fileFunctions->opaque = ( void * ) s;
204 p_sys->zipFile = unzOpen2( NULL /* path */, p_sys->fileFunctions );
205 if( !p_sys->zipFile )
207 msg_Warn( s, "unable to open file" );
209 free( p_sys->fileFunctions );
213 /* Find the stream uri */
215 if( asprintf( &psz_tmp, "%s.xspf", s->psz_path ) == -1 )
218 free( p_sys->fileFunctions );
221 p_sys->psz_path = s->psz_path;
222 s->psz_path = psz_tmp;
227 /** *************************************************************************
229 ****************************************************************************/
230 void StreamClose( vlc_object_t *p_this )
232 stream_t *s = (stream_t*)p_this;
233 stream_sys_t *p_sys = s->p_sys;
235 free( p_sys->fileFunctions );
236 free( p_sys->psz_xspf );
237 free( p_sys->psz_path );
241 /** *************************************************************************
242 * Stream filters functions
243 ****************************************************************************/
245 /** *************************************************************************
247 ****************************************************************************/
248 static int Read( stream_t *s, void *p_read, unsigned int i_read )
250 stream_sys_t *p_sys = s->p_sys;
252 if( !p_read ) return 0;
254 /* Fill the buffer */
255 if( p_sys->psz_xspf == NULL )
257 int i_ret = CreatePlaylist( s, &p_sys->psz_xspf );
260 p_sys->i_len = strlen( p_sys->psz_xspf );
264 /* Read the buffer */
265 int i_len = __MIN( i_read, p_sys->i_len - p_sys->i_pos );
266 memcpy( p_read, p_sys->psz_xspf + p_sys->i_pos, i_len );
267 p_sys->i_pos += i_len;
272 /** *************************************************************************
274 ****************************************************************************/
275 static int Peek( stream_t *s, const uint8_t **pp_peek, unsigned int i_peek )
277 stream_sys_t *p_sys = s->p_sys;
279 /* Fill the buffer */
280 if( p_sys->psz_xspf == NULL )
282 int i_ret = CreatePlaylist( s, &p_sys->psz_xspf );
285 p_sys->i_len = strlen( p_sys->psz_xspf );
290 /* Point to the buffer */
291 int i_len = __MIN( i_peek, p_sys->i_len - p_sys->i_pos );
292 *pp_peek = (uint8_t*) p_sys->psz_xspf + p_sys->i_pos;
297 /** *************************************************************************
299 ****************************************************************************/
300 static int Control( stream_t *s, int i_query, va_list args )
302 stream_sys_t *p_sys = s->p_sys;
306 case STREAM_SET_POSITION:
308 int64_t i_position = (int64_t)va_arg( args, int64_t );
309 if( i_position >= p_sys->i_len )
313 p_sys->i_len = (size_t) i_position;
318 case STREAM_GET_POSITION:
320 int64_t *pi_position = (int64_t*)va_arg( args, int64_t* );
321 *pi_position = p_sys->i_pos;
325 case STREAM_GET_SIZE:
327 int64_t *pi_size = (int64_t*)va_arg( args, int64_t* );
328 *pi_size = (int64_t) p_sys->i_len;
332 case STREAM_GET_CONTENT_TYPE:
335 case STREAM_UPDATE_SIZE:
336 case STREAM_CONTROL_ACCESS:
337 case STREAM_CAN_SEEK:
338 case STREAM_CAN_FASTSEEK:
339 case STREAM_SET_RECORD_STATE:
340 return stream_vaControl( s->p_source, i_query, args );
347 static int CreatePlaylist( stream_t *s, char **pp_buffer )
349 /* Get some infos about zip archive */
351 unzFile file = s->p_sys->zipFile;
352 vlc_array_t *p_filenames = vlc_array_new(); /* Will contain char* */
354 /* List all file names in Zip archive */
355 i_ret = GetFilesInZip( s, file, p_filenames, NULL );
363 // msg_Dbg( s, "%d files in Zip", vlc_array_count( p_filenames ) );
367 s->p_sys->zipFile = NULL;
369 /* Construct the xspf playlist */
370 i_ret = WriteXSPF( pp_buffer, p_filenames, s->p_sys->psz_path );
377 for( int i = 0; i < vlc_array_count( p_filenames ); i++ )
379 free( vlc_array_item_at_index( p_filenames, i ) );
381 vlc_array_destroy( p_filenames );
386 /** **************************************************************************
387 * Zip utility functions
388 *****************************************************************************/
390 /** **************************************************************************
391 * \brief List files in zip and append their names to p_array
393 * \param file Opened zip file
394 * \param p_array vlc_array_t which will receive all filenames
396 * In case of error, returns VLC_EGENERIC.
397 * In case of success, returns number of files found, and goes back to first file.
398 *****************************************************************************/
399 static int GetFilesInZip( stream_t *p_this, unzFile file,
400 vlc_array_t *p_filenames, vlc_array_t *p_fileinfos )
402 if( !p_filenames || !p_this )
407 /* Get global info */
408 unz_global_info info;
410 if( unzGetGlobalInfo( file, &info ) != UNZ_OK )
412 msg_Warn( p_this, "this is not a valid zip archive" );
416 /* Go to first file in archive */
417 unzGoToFirstFile( file );
419 /* Get info about each file */
420 for( unsigned long i = 0; i < info.number_entry; i++ )
422 char *psz_fileName = calloc( ZIP_FILENAME_LEN, 1 );
423 unz_file_info *p_fileInfo = calloc( 1, sizeof( unz_file_info ) );
425 if( !p_fileInfo || !psz_fileName )
427 free( psz_fileName );
432 if( unzGetCurrentFileInfo( file, p_fileInfo, psz_fileName,
433 ZIP_FILENAME_LEN, NULL, 0, NULL, 0 )
436 msg_Warn( p_this, "can't get info about file in zip" );
441 vlc_array_append( p_filenames, strdup( psz_fileName ) );
442 free( psz_fileName );
445 vlc_array_append( p_fileinfos, p_fileInfo );
449 if( i < ( info.number_entry - 1 ) )
451 /* Go the next file in the archive */
452 if( unzGoToNextFile( file ) != UNZ_OK )
454 msg_Warn( p_this, "can't go to next file in zip" );
462 /* i_ret should be equal to info.number_entry */
463 unzGoToFirstFile( file );
468 /** **************************************************************************
469 * XSPF generation functions
470 *****************************************************************************/
472 /** **************************************************************************
473 * \brief Write the XSPF playlist given the list of files
474 *****************************************************************************/
475 static int WriteXSPF( char **pp_buffer, vlc_array_t *p_filenames,
476 const char *psz_zippath )
478 char *psz_zip = strrchr( psz_zippath, DIR_SEP_CHAR );
479 psz_zip = convert_xml_special_chars( psz_zip ? (psz_zip+1) : psz_zippath );
481 if( asprintf( pp_buffer, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
482 "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\" "
483 "xmlns:vlc=\"http://www.videolan.org/vlc/playlist/ns/0/\">\n"
484 " <title>%s</title>\n"
485 " <trackList>\n", psz_zip ) == -1)
489 node *playlist = new_node( psz_zip );
491 /* Web-Encode the URI and append '!' */
492 char *psz_pathtozip = vlc_UrlEncode( psz_zippath );
493 if( astrcatf( &psz_pathtozip, ZIP_SEP ) < 0 ) return -1;
496 for( int i = 0; i < vlc_array_count( p_filenames ); ++i )
498 char *psz_name = (char*) vlc_array_item_at_index( p_filenames, i );
499 int i_len = strlen( psz_name );
501 if( !i_len ) continue;
503 /* Is it a folder ? */
504 if( psz_name[i_len-1] == '/' )
510 /* Extract file name */
511 char *psz_file = strrchr( psz_name, '/' );
512 psz_file = convert_xml_special_chars( psz_file ?
513 (psz_file+1) : psz_name );
516 char *psz_path = strdup( psz_pathtozip );
517 if( astrcatf( &psz_path, psz_name ) < 0 ) return -1;
519 /* Double url-encode */
520 char *psz_tmp = psz_path;
521 psz_path = vlc_UrlEncode( psz_tmp );
524 /* Track information */
525 if( astrcatf( pp_buffer,
527 " <location>zip://%s</location>\n"
528 " <title>%s</title>\n"
529 " <extension application=\"http://www.videolan.org/vlc/playlist/0\">\n"
530 " <vlc:id>%d</vlc:id>\n"
533 psz_path, psz_file, i_track ) < 0 ) return -1;
538 /* Find the parent node */
539 node *parent = findOrCreateParentNode( playlist, psz_name );
542 /* Add the item to this node */
543 item *tmp = parent->media;
546 parent->media = new_item( i_track );
554 tmp->next = new_item( i_track );
561 free( psz_pathtozip );
563 /* Close tracklist, open the extension */
564 if( astrcatf( pp_buffer,
566 " <extension application=\"http://www.videolan.org/vlc/playlist/0\">\n"
570 if( nodeToXSPF( pp_buffer, playlist, true ) < 0 ) return -1;
572 /* Close extension and playlist */
573 if( astrcatf( pp_buffer, " </extension>\n</playlist>\n" ) < 0 ) return -1;
575 /* printf( "%s", *pp_buffer ); */
577 free_all_node( playlist );
582 /** **************************************************************************
583 * \brief Recursively convert a node to its XSPF representation
584 *****************************************************************************/
585 static int nodeToXSPF( char **pp_buffer, node *n, bool b_root )
589 if( astrcatf( pp_buffer, " <vlc:node title=\"%s\">\n", n->name ) < 0 )
593 nodeToXSPF( pp_buffer, n->child, false );
597 if( astrcatf( pp_buffer, " <vlc:item tid=\"%d\" />\n", i->id ) < 0 )
603 if( astrcatf( pp_buffer, " </vlc:node>\n" ) < 0 )
609 /** **************************************************************************
610 * \brief Either create or find the parent node of the item
611 *****************************************************************************/
612 static node* findOrCreateParentNode( node *root, const char *fullpath )
615 char *path = strdup( fullpath );
620 char *sep = strchr( folder, '/' );
630 node *current = root->child;
634 if( !strcmp( current->name, folder ) )
636 /* We found the folder, go recursively deeper */
637 return findOrCreateParentNode( current, sep );
639 current = current->next;
642 /* If we are here, then it means that we did not find the parent */
643 node *ret = new_node( folder );
648 current = root->child;
649 while( current->next )
651 current = current->next;
656 /* And now, create the subfolders */
657 ret = findOrCreateParentNode( ret, sep );
664 /** **************************************************************************
665 * ZipIO function definitions : how to use vlc_stream to read the zip
666 *****************************************************************************/
668 /** **************************************************************************
669 * \brief interface for unzip module to open a file using a vlc_stream
672 * \param mode how to open the file (read/write ?). We support only read
674 *****************************************************************************/
675 static void ZCALLBACK *ZipIO_Open( void *opaque, const char *file, int mode )
678 stream_t *s = (stream_t*) opaque;
679 if( mode & ( ZLIB_FILEFUNC_MODE_CREATE | ZLIB_FILEFUNC_MODE_WRITE ) )
681 msg_Dbg( s, "ZipIO_Open: we cannot write into zip files" );
687 /** **************************************************************************
688 * \brief read something from stream into buffer
689 * \param opaque should be the stream
690 * \param stream stream created by ZipIO_Open
691 * \param buf buffer to read the file
692 * \param size length of this buffer
693 * \return return the number of bytes read (<= size)
694 *****************************************************************************/
695 static unsigned long ZCALLBACK ZipIO_Read( void *opaque, void *stream,
696 void *buf, unsigned long size )
699 stream_t *s = (stream_t*) opaque;
700 return (unsigned long) stream_Read( s->p_source, buf, (int) size );
703 /** **************************************************************************
704 * \brief tell size of stream
705 * \param opaque should be the stream
706 * \param stream stream created by ZipIO_Open
707 * \return size of the file / stream
708 * ATTENTION: this is not stream_Tell, but stream_Size !
709 *****************************************************************************/
710 static long ZCALLBACK ZipIO_Tell( void *opaque, void *stream )
713 stream_t *s = (stream_t*) opaque;
714 return (long) stream_Size( s->p_source ); /* /!\ not stream_Tell /!\ */
717 /** **************************************************************************
718 * \brief seek in the stream
719 * \param opaque should be the stream
720 * \param stream stream created by ZipIO_Open
721 * \param offset positive offset to seek
722 * \param origin current position in stream
723 * \return ¿ VLC_SUCCESS or an error code ?
724 *****************************************************************************/
725 static long ZCALLBACK ZipIO_Seek ( void *opaque, void *stream,
726 unsigned long offset, int origin )
729 stream_t *s = (stream_t*) opaque;
732 uint64_t pos = offset + origin;
733 l_ret = (long) stream_Seek( s->p_source, pos );
737 /** **************************************************************************
738 * \brief close the stream
739 * \param opaque should be the stream
740 * \param stream stream created by ZipIO_Open
741 * \return always VLC_SUCCESS
742 * This closes zip archive
743 *****************************************************************************/
744 static int ZCALLBACK ZipIO_Close ( void *opaque, void *stream )
748 // stream_t *s = (stream_t*) opaque;
749 // if( p_demux->p_sys && p_demux->p_sys->zipFile )
750 // p_demux->p_sys->zipFile = NULL;
751 // stream_Seek( s->p_source, 0 );
755 /** **************************************************************************
756 * \brief I/O functions for the ioapi: write (assert insteadof segfault)
757 *****************************************************************************/
758 static uLong ZCALLBACK ZipIO_Write( void* opaque, void* stream,
759 const void* buf, uLong size )
761 (void)opaque; (void)stream; (void)buf; (void)size;
762 int ERROR_zip_cannot_write_this_should_not_happen = 0;
763 assert( ERROR_zip_cannot_write_this_should_not_happen );
767 /** **************************************************************************
768 * \brief I/O functions for the ioapi: test error (man 3 ferror)
769 *****************************************************************************/
770 static int ZCALLBACK ZipIO_Error( void* opaque, void* stream )
774 //msg_Dbg( p_access, "error" );