1 /*****************************************************************************
2 * zipaccess.c: Module (access) to extract different archives, based on zlib
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 *****************************************************************************/
25 * - implement crypto (using url zip://user:password@path-to-archive|file
26 * - read files in zip with long name (use unz_file_info.size_filename)
27 * - multi-volume archive support ?
35 #include <vlc_access.h>
37 /** **************************************************************************
38 * This is our own access_sys_t for zip files
39 *****************************************************************************/
42 /* zlib / unzip members */
44 zlib_filefunc_def *fileFunctions;
46 /* file in zip information */
50 static int AccessControl( access_t *p_access, int i_query, va_list args );
51 static ssize_t AccessRead( access_t *, uint8_t *, size_t );
52 static int AccessSeek( access_t *, int64_t );
53 static int OpenFileInZip( access_t *p_access, int i_pos );
54 static char *unescapeXml( const char *psz_text );
56 /** **************************************************************************
57 * \brief Unescape valid XML string
58 * The exact reverse of escapeToXml (zipstream.c)
59 *****************************************************************************/
60 static char *unescapeXml( const char *psz_text )
62 char *psz_ret = malloc( strlen( psz_text ) + 1 );
63 if( !psz_ret ) return NULL;
65 char *psz_tmp = psz_ret;
66 for( char *psz_iter = (char*) psz_text; *psz_iter; ++psz_iter, ++psz_tmp )
68 if( *psz_iter == '?' )
71 if( !sscanf( ++psz_iter, "%02x", &i_value ) )
73 /* Invalid number: URL incorrectly encoded */
77 *psz_tmp = (char) i_value;
80 else if( isAllowedChar( *psz_iter ) )
86 /* Invalid character encoding for the URL */
96 /** **************************************************************************
98 *****************************************************************************/
99 int AccessOpen( vlc_object_t *p_this )
101 access_t *p_access = (access_t*)p_this;
103 int i_ret = VLC_EGENERIC;
106 char *psz_pathToZip = NULL, *psz_path = NULL, *psz_sep = NULL;
108 p_access->p_sys = p_sys = (access_sys_t*)
109 calloc( 1, sizeof( access_sys_t ) );
114 psz_path = strdup( p_access->psz_path );
115 psz_sep = strchr( psz_path, ZIP_SEP_CHAR );
120 psz_pathToZip = unescapeXml( psz_path );
123 /* Maybe this was not an encoded string */
124 msg_Dbg( p_access, "this is not an encoded url. Trying file '%s'",
126 psz_pathToZip = strdup( psz_path );
128 p_sys->psz_fileInzip = unescapeXml( psz_sep + 1 );
129 if( !p_sys->psz_fileInzip )
131 p_sys->psz_fileInzip = strdup( psz_sep + 1 );
134 /* Define IO functions */
135 zlib_filefunc_def *p_func = (zlib_filefunc_def*)
136 calloc( 1, sizeof( zlib_filefunc_def ) );
137 p_func->zopen_file = ZipIO_Open;
138 p_func->zread_file = ZipIO_Read;
139 p_func->zwrite_file = ZipIO_Write; // see comment
140 p_func->ztell_file = ZipIO_Tell;
141 p_func->zseek_file = ZipIO_Seek;
142 p_func->zclose_file = ZipIO_Close;
143 p_func->zerror_file = ZipIO_Error;
144 p_func->opaque = p_access;
146 /* Open zip archive */
147 file = p_access->p_sys->zipFile = unzOpen2( psz_pathToZip, p_func );
150 msg_Err( p_access, "not a valid zip archive: '%s'", psz_pathToZip );
154 /* Open file in zip */
155 OpenFileInZip( p_access, 0 );
158 ACCESS_SET_CALLBACKS( AccessRead, NULL, AccessControl, AccessSeek );
160 /* Get some infos about current file. Maybe we could want some more ? */
161 unz_file_info z_info;
162 unzGetCurrentFileInfo( file, &z_info, NULL, 0, NULL, 0, NULL, 0 );
164 /* Set access informations: size is needed for AccessSeek */
165 p_access->info.i_size = z_info.uncompressed_size;
166 p_access->info.i_pos = 0;
167 p_access->info.b_eof = false;
172 if( i_ret != VLC_SUCCESS )
176 unzCloseCurrentFile( file );
179 free( p_sys->psz_fileInzip );
180 free( p_sys->fileFunctions );
184 free( psz_pathToZip );
189 /** **************************************************************************
190 * \brief Close access: free structures
191 *****************************************************************************/
192 void AccessClose( vlc_object_t *p_this )
194 access_t *p_access = (access_t*)p_this;
195 access_sys_t *p_sys = p_access->p_sys;
198 unzFile file = p_sys->zipFile;
201 unzCloseCurrentFile( file );
204 free( p_sys->psz_fileInzip );
205 free( p_sys->fileFunctions );
210 /** **************************************************************************
211 * \brief Control access
212 *****************************************************************************/
213 static int AccessControl( access_t *p_access, int i_query, va_list args )
221 case ACCESS_CAN_SEEK:
222 case ACCESS_CAN_PAUSE:
223 case ACCESS_CAN_CONTROL_PACE:
224 pb_bool = (bool*)va_arg( args, bool* );
228 case ACCESS_CAN_FASTSEEK:
229 pb_bool = (bool*)va_arg( args, bool* );
233 case ACCESS_GET_PTS_DELAY:
234 pi_64 = (int64_t*)va_arg( args, int64_t * );
235 *pi_64 = DEFAULT_PTS_DELAY;
239 case ACCESS_SET_PAUSE_STATE:
243 case ACCESS_GET_TITLE_INFO:
244 case ACCESS_SET_TITLE:
245 case ACCESS_SET_SEEKPOINT:
246 case ACCESS_SET_PRIVATE_ID_STATE:
247 case ACCESS_GET_META:
248 case ACCESS_GET_PRIVATE_ID_STATE:
249 case ACCESS_GET_CONTENT_TYPE:
253 msg_Warn( p_access, "unimplemented query %d in control", i_query );
260 /** **************************************************************************
262 * Reads current opened file in zip. This does not open the file in zip.
263 * Return -1 if no data yet, 0 if no more data, else real data read
264 *****************************************************************************/
265 static ssize_t AccessRead( access_t *p_access, uint8_t *p_buffer, size_t sz )
267 access_sys_t *p_sys = p_access->p_sys;
269 unzFile file = p_sys->zipFile;
272 msg_Err( p_access, "archive not opened !" );
277 i_read = unzReadCurrentFile( file, p_buffer, sz );
279 p_access->info.i_pos = unztell( file );
280 return ( i_read >= 0 ? i_read : VLC_EGENERIC );
283 /** **************************************************************************
284 * \brief Seek inside zip file
285 *****************************************************************************/
286 static int AccessSeek( access_t *p_access, int64_t seek_len )
288 access_sys_t *p_sys = p_access->p_sys;
290 unzFile file = p_sys->zipFile;
293 msg_Err( p_access, "archive not opened !" );
297 /* Reopen file in zip if needed */
298 if( p_access->info.i_pos != 0 )
300 OpenFileInZip( p_access, p_access->info.i_pos + seek_len );
303 /* Read seek_len data and drop it */
306 char *p_buffer = ( char* ) calloc( 1, ZIP_BUFFER_LEN );
307 while( ( i_seek < seek_len ) && ( i_read > 0 ) )
309 i_read = ( seek_len - i_seek < ZIP_BUFFER_LEN )
310 ? ( seek_len - i_seek ) : ZIP_BUFFER_LEN;
311 i_read = unzReadCurrentFile( file, p_buffer, i_read );
314 msg_Warn( p_access, "could not seek in file" );
325 p_access->info.i_pos = unztell( file );
329 /** **************************************************************************
330 * \brief Open file in zip
331 *****************************************************************************/
332 static int OpenFileInZip( access_t *p_access, int i_pos )
334 access_sys_t *p_sys = p_access->p_sys;
335 unzFile file = p_sys->zipFile;
336 if( !p_sys->psz_fileInzip )
341 i_pos = __MIN( i_pos, 0 );
342 p_access->info.i_pos = 0;
344 unzCloseCurrentFile( file ); /* returns UNZ_PARAMERROR if file not opened */
345 if( unzLocateFile( file, p_sys->psz_fileInzip, 0 ) != UNZ_OK )
347 msg_Err( p_access, "could not [re]locate file in zip: '%s'",
348 p_sys->psz_fileInzip );
351 if( unzOpenCurrentFile( file ) != UNZ_OK )
353 msg_Err( p_access, "could not [re]open file in zip: '%s'",
354 p_sys->psz_fileInzip );
358 return AccessSeek( p_access, i_pos );
363 /** **************************************************************************
364 * \brief I/O functions for the ioapi: open (read only)
365 *****************************************************************************/
366 static void* ZCALLBACK ZipIO_Open( void* opaque, const char* file, int mode )
368 assert(opaque != NULL);
369 assert(mode == (ZLIB_FILEFUNC_MODE_READ | ZLIB_FILEFUNC_MODE_EXISTING));
371 access_t *p_access = (access_t*) opaque;
373 return stream_UrlNew( p_access, file );
376 /** **************************************************************************
377 * \brief I/O functions for the ioapi: read
378 *****************************************************************************/
379 static uLong ZCALLBACK ZipIO_Read( void* opaque, void* stream,
380 void* buf, uLong size )
383 //access_t *p_access = (access_t*) opaque;
384 //msg_Dbg(p_access, "read %d", size);
385 return stream_Read( (stream_t*) stream, buf, size );
388 /** **************************************************************************
389 * \brief I/O functions for the ioapi: write (assert insteadof segfault)
390 *****************************************************************************/
391 static uLong ZCALLBACK ZipIO_Write( void* opaque, void* stream,
392 const void* buf, uLong size )
394 (void)opaque; (void)stream; (void)buf; (void)size;
395 int zip_access_cannot_write_this_should_not_happen = 0;
396 assert(zip_access_cannot_write_this_should_not_happen);
400 /** **************************************************************************
401 * \brief I/O functions for the ioapi: tell
402 *****************************************************************************/
403 static long ZCALLBACK ZipIO_Tell( void* opaque, void* stream )
406 int64_t i64_tell = stream_Tell( (stream_t*) stream );
407 //access_t *p_access = (access_t*) opaque;
408 //msg_Dbg(p_access, "tell %" PRIu64, i64_tell);
409 return (long)i64_tell;
412 /** **************************************************************************
413 * \brief I/O functions for the ioapi: seek
414 *****************************************************************************/
415 static long ZCALLBACK ZipIO_Seek( void* opaque, void* stream,
416 uLong offset, int origin )
419 //access_t *p_access = (access_t*) opaque;
420 int64_t pos = offset;
424 pos += stream_Tell( (stream_t*) stream );
429 pos += stream_Size( (stream_t*) stream );
434 //msg_Dbg( p_access, "seek (%d,%d): %" PRIu64, offset, origin, pos );
435 stream_Seek( (stream_t*) stream, pos );
436 /* Note: in unzip.c, unzlocal_SearchCentralDir seeks to the end of
437 the stream, which is doable but returns an error in VLC.
438 That's why we always assume this was OK. FIXME */
442 /** **************************************************************************
443 * \brief I/O functions for the ioapi: close
444 *****************************************************************************/
445 static int ZCALLBACK ZipIO_Close( void* opaque, void* stream )
448 stream_Delete( (stream_t*) stream );
452 /** **************************************************************************
453 * \brief I/O functions for the ioapi: test error (man 3 ferror)
454 *****************************************************************************/
455 static int ZCALLBACK ZipIO_Error( void* opaque, void* stream )
459 //msg_Dbg( p_access, "error" );