zipaccess.c
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:15k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * zipaccess.c: Module (access) to extract different archives, based on zlib
  3.  *****************************************************************************
  4.  * Copyright (C) 2009 the VideoLAN team
  5.  * $Id: 63dcd22e43f69d602d98934893aac8b7dde1aa96 $
  6.  *
  7.  * Authors: Jean-Philippe André <jpeg@videolan.org>
  8.  *
  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.
  13.  *
  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.
  18.  *
  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.  *****************************************************************************/
  23. /** @todo:
  24.  * - implement crypto (using url zip://user:password@path-to-archive!/file)
  25.  * - read files in zip with long name (use unz_file_info.size_filename)
  26.  * - multi-volume archive support ?
  27.  */
  28. #ifdef HAVE_CONFIG_H
  29. # include "config.h"
  30. #endif
  31. #include "zip.h"
  32. #include <vlc_access.h>
  33. /** **************************************************************************
  34.  * This is our own access_sys_t for zip files
  35.  *****************************************************************************/
  36. struct access_sys_t
  37. {
  38.     /* zlib / unzip members */
  39.     unzFile            zipFile;
  40.     zlib_filefunc_def *fileFunctions;
  41.     /* file in zip information */
  42.     char              *psz_fileInzip;
  43. };
  44. static int AccessControl( access_t *p_access, int i_query, va_list args );
  45. static ssize_t AccessRead( access_t *, uint8_t *, size_t );
  46. static int AccessSeek( access_t *, int64_t );
  47. static int OpenFileInZip( access_t *p_access, int i_pos );
  48. static char *unescapeXml( const char *psz_text );
  49. /** **************************************************************************
  50.  * brief Unescape valid XML string
  51.  * The exact reverse of escapeToXml (zipstream.c)
  52.  *****************************************************************************/
  53. static char *unescapeXml( const char *psz_text )
  54. {
  55.     char *psz_ret = malloc( strlen( psz_text ) + 1 );
  56.     if( !psz_ret ) return NULL;
  57.     char *psz_tmp = psz_ret;
  58.     for( char *psz_iter = (char*) psz_text; *psz_iter; ++psz_iter, ++psz_tmp )
  59.     {
  60.         if( *psz_iter == '?' )
  61.         {
  62.             int i_value;
  63.             if( !sscanf( ++psz_iter, "%02x", &i_value ) )
  64.             {
  65.                 /* Invalid number: URL incorrectly encoded */
  66.                 free( psz_ret );
  67.                 return NULL;
  68.             }
  69.             *psz_tmp = (char) i_value;
  70.             psz_iter++;
  71.         }
  72.         else if( isAllowedChar( *psz_iter ) )
  73.         {
  74.             *psz_tmp = *psz_iter;
  75.         }
  76.         else
  77.         {
  78.             /* Invalid character encoding for the URL */
  79.             free( psz_ret );
  80.             return NULL;
  81.         }
  82.     }
  83.     *psz_tmp = '';
  84.     return psz_ret;
  85. }
  86. /** **************************************************************************
  87.  * brief Open access
  88.  *****************************************************************************/
  89. int AccessOpen( vlc_object_t *p_this )
  90. {
  91.     access_t     *p_access = (access_t*)p_this;
  92.     access_sys_t *p_sys;
  93.     int i_ret              = VLC_EGENERIC;
  94.     unzFile file           = 0;
  95.     char *psz_pathToZip = NULL, *psz_path = NULL, *psz_sep = NULL;
  96.     if( !strstr( p_access->psz_path, ZIP_SEP ) )
  97.     {
  98.         msg_Dbg( p_access, "path does not contain separator " ZIP_SEP );
  99.         return VLC_EGENERIC;
  100.     }
  101.     p_access->p_sys = p_sys = (access_sys_t*)
  102.             calloc( 1, sizeof( access_sys_t ) );
  103.     if( !p_sys )
  104.         return VLC_ENOMEM;
  105.     /* Split the MRL */
  106.     psz_path = strdup( p_access->psz_path );
  107.     psz_sep = strstr( psz_path, ZIP_SEP );
  108.     *psz_sep = '';
  109.     psz_pathToZip = unescapeXml( psz_path );
  110.     if( !psz_pathToZip )
  111.     {
  112.         /* Maybe this was not an encoded string */
  113.         msg_Dbg( p_access, "this is not an encoded url. Trying file '%s'",
  114.                  psz_path );
  115.         psz_pathToZip = strdup( psz_path );
  116.     }
  117.     p_sys->psz_fileInzip = unescapeXml( psz_sep + ZIP_SEP_LEN );
  118.     if( !p_sys->psz_fileInzip )
  119.     {
  120.         p_sys->psz_fileInzip = strdup( psz_sep + ZIP_SEP_LEN );
  121.     }
  122.     /* Define IO functions */
  123.     zlib_filefunc_def *p_func = (zlib_filefunc_def*)
  124.                                     calloc( 1, sizeof( zlib_filefunc_def ) );
  125.     p_func->zopen_file   = ZipIO_Open;
  126.     p_func->zread_file   = ZipIO_Read;
  127.     p_func->zwrite_file  = ZipIO_Write; // see comment
  128.     p_func->ztell_file   = ZipIO_Tell;
  129.     p_func->zseek_file   = ZipIO_Seek;
  130.     p_func->zclose_file  = ZipIO_Close;
  131.     p_func->zerror_file  = ZipIO_Error;
  132.     p_func->opaque       = p_access;
  133.     /* Open zip archive */
  134.     file = p_access->p_sys->zipFile = unzOpen2( psz_pathToZip, p_func );
  135.     if( !file )
  136.     {
  137.         msg_Err( p_access, "not a valid zip archive: '%s'", psz_pathToZip );
  138.         goto exit;
  139.     }
  140.     /* Open file in zip */
  141.     OpenFileInZip( p_access, 0 );
  142.     /* Set callback */
  143.     ACCESS_SET_CALLBACKS( AccessRead, NULL, AccessControl, AccessSeek );
  144.     /* Get some infos about current file. Maybe we could want some more ? */
  145.     unz_file_info z_info;
  146.     unzGetCurrentFileInfo( file, &z_info, NULL, 0, NULL, 0, NULL, 0 );
  147.     /* Set access informations: size is needed for AccessSeek */
  148.     p_access->info.i_size = z_info.uncompressed_size;
  149.     p_access->info.i_pos  = 0;
  150.     p_access->info.b_eof  = false;
  151.     i_ret = VLC_SUCCESS;
  152. exit:
  153.     if( i_ret != VLC_SUCCESS )
  154.     {
  155.         if( file )
  156.         {
  157.             unzCloseCurrentFile( file );
  158.             unzClose( file );
  159.         }
  160.         free( p_sys->psz_fileInzip );
  161.         free( p_sys->fileFunctions );
  162.         free( p_sys );
  163.     }
  164.     free( psz_pathToZip );
  165.     free( psz_path );
  166.     return i_ret;
  167. }
  168. /** **************************************************************************
  169.  * brief Close access: free structures
  170.  *****************************************************************************/
  171. void AccessClose( vlc_object_t *p_this )
  172. {
  173.     access_t     *p_access = (access_t*)p_this;
  174.     access_sys_t *p_sys = p_access->p_sys;
  175.     if( p_sys )
  176.     {
  177.         unzFile file = p_sys->zipFile;
  178.         if( file )
  179.         {
  180.             unzCloseCurrentFile( file );
  181.             unzClose( file );
  182.         }
  183.         free( p_sys->psz_fileInzip );
  184.         free( p_sys->fileFunctions );
  185.         free( p_sys );
  186.     }
  187. }
  188. /** **************************************************************************
  189.  * brief Control access
  190.  *****************************************************************************/
  191. static int AccessControl( access_t *p_access, int i_query, va_list args )
  192. {
  193.     bool         *pb_bool;
  194.     int64_t      *pi_64;
  195.     switch( i_query )
  196.     {
  197.         /* */
  198.         case ACCESS_CAN_SEEK:
  199.         case ACCESS_CAN_PAUSE:
  200.         case ACCESS_CAN_CONTROL_PACE:
  201.             pb_bool = (bool*)va_arg( args, bool* );
  202.             *pb_bool = true;
  203.             break;
  204.         case ACCESS_CAN_FASTSEEK:
  205.             pb_bool = (bool*)va_arg( args, bool* );
  206.             *pb_bool = false;
  207.             break;
  208.         case ACCESS_GET_PTS_DELAY:
  209.             pi_64 = (int64_t*)va_arg( args, int64_t * );
  210.             *pi_64 = DEFAULT_PTS_DELAY;
  211.             break;
  212.         /* */
  213.         case ACCESS_SET_PAUSE_STATE:
  214.             /* Nothing to do */
  215.             break;
  216.         case ACCESS_GET_TITLE_INFO:
  217.         case ACCESS_SET_TITLE:
  218.         case ACCESS_SET_SEEKPOINT:
  219.         case ACCESS_SET_PRIVATE_ID_STATE:
  220.         case ACCESS_GET_META:
  221.         case ACCESS_GET_PRIVATE_ID_STATE:
  222.         case ACCESS_GET_CONTENT_TYPE:
  223.             return VLC_EGENERIC;
  224.         default:
  225.             msg_Warn( p_access, "unimplemented query %d in control", i_query );
  226.             return VLC_EGENERIC;
  227.     }
  228.     return VLC_SUCCESS;
  229. }
  230. /** **************************************************************************
  231.  * brief Read access
  232.  * Reads current opened file in zip. This does not open the file in zip.
  233.  * Return -1 if no data yet, 0 if no more data, else real data read
  234.  *****************************************************************************/
  235. static ssize_t AccessRead( access_t *p_access, uint8_t *p_buffer, size_t sz )
  236. {
  237.     access_sys_t *p_sys = p_access->p_sys;
  238.     assert( p_sys );
  239.     unzFile file = p_sys->zipFile;
  240.     if( !file )
  241.     {
  242.         msg_Err( p_access, "archive not opened !" );
  243.         return VLC_EGENERIC;
  244.     }
  245.     int i_read = 0;
  246.     i_read = unzReadCurrentFile( file, p_buffer, sz );
  247.     p_access->info.i_pos = unztell( file );
  248.     return ( i_read >= 0 ? i_read : VLC_EGENERIC );
  249. }
  250. /** **************************************************************************
  251.  * brief Seek inside zip file
  252.  *****************************************************************************/
  253. static int AccessSeek( access_t *p_access, int64_t seek_len )
  254. {
  255.     access_sys_t *p_sys = p_access->p_sys;
  256.     assert( p_sys );
  257.     unzFile file = p_sys->zipFile;
  258.     if( !file )
  259.     {
  260.         msg_Err( p_access, "archive not opened !" );
  261.         return VLC_EGENERIC;
  262.     }
  263.     /* Reopen file in zip if needed */
  264.     if( p_access->info.i_pos != 0 )
  265.     {
  266.         OpenFileInZip( p_access, p_access->info.i_pos + seek_len );
  267.     }
  268.     /* Read seek_len data and drop it */
  269.     int i_seek = 0;
  270.     int i_read = 1;
  271.     char *p_buffer = ( char* ) calloc( 1, ZIP_BUFFER_LEN );
  272.     while( ( i_seek < seek_len ) && ( i_read > 0 ) )
  273.     {
  274.         i_read = ( seek_len - i_seek < ZIP_BUFFER_LEN )
  275.                ? ( seek_len - i_seek ) : ZIP_BUFFER_LEN;
  276.         i_read = unzReadCurrentFile( file, p_buffer, i_read );
  277.         if( i_read < 0 )
  278.         {
  279.             msg_Warn( p_access, "could not seek in file" );
  280.             free( p_buffer );
  281.             return VLC_EGENERIC;
  282.         }
  283.         else
  284.         {
  285.             i_seek += i_read;
  286.         }
  287.     }
  288.     free( p_buffer );
  289.     p_access->info.i_pos = unztell( file );
  290.     return VLC_SUCCESS;
  291. }
  292. /** **************************************************************************
  293.  * brief Open file in zip
  294.  *****************************************************************************/
  295. static int OpenFileInZip( access_t *p_access, int i_pos )
  296. {
  297.     access_sys_t *p_sys = p_access->p_sys;
  298.     unzFile file = p_sys->zipFile;
  299.     if( !p_sys->psz_fileInzip )
  300.     {
  301.         return VLC_EGENERIC;
  302.     }
  303.     i_pos = __MIN( i_pos, 0 );
  304.     p_access->info.i_pos = 0;
  305.     unzCloseCurrentFile( file ); /* returns UNZ_PARAMERROR if file not opened */
  306.     if( unzLocateFile( file, p_sys->psz_fileInzip, 0 ) != UNZ_OK )
  307.     {
  308.         msg_Err( p_access, "could not [re]locate file in zip: '%s'",
  309.                  p_sys->psz_fileInzip );
  310.         return VLC_EGENERIC;
  311.     }
  312.     if( unzOpenCurrentFile( file ) != UNZ_OK )
  313.     {
  314.         msg_Err( p_access, "could not [re]open file in zip: '%s'",
  315.                  p_sys->psz_fileInzip );
  316.         return VLC_EGENERIC;
  317.     }
  318.     if( i_pos > 0 )
  319.         return AccessSeek( p_access, i_pos );
  320.     else
  321.         return VLC_SUCCESS;
  322. }
  323. /** **************************************************************************
  324.  * brief I/O functions for the ioapi: open (read only)
  325.  *****************************************************************************/
  326. static void* ZCALLBACK ZipIO_Open( void* opaque, const char* file, int mode )
  327. {
  328.     assert(opaque != NULL);
  329.     assert(mode == (ZLIB_FILEFUNC_MODE_READ | ZLIB_FILEFUNC_MODE_EXISTING));
  330.     access_t *p_access = (access_t*) opaque;
  331.     return stream_UrlNew( p_access, file );
  332. }
  333. /** **************************************************************************
  334.  * brief I/O functions for the ioapi: read
  335.  *****************************************************************************/
  336. static uLong ZCALLBACK ZipIO_Read( void* opaque, void* stream,
  337.                                    void* buf, uLong size )
  338. {
  339.     (void)opaque;
  340.     //access_t *p_access = (access_t*) opaque;
  341.     //msg_Dbg(p_access, "read %d", size);
  342.     return stream_Read( (stream_t*) stream, buf, size );
  343. }
  344. /** **************************************************************************
  345.  * brief I/O functions for the ioapi: write (assert insteadof segfault)
  346.  *****************************************************************************/
  347. static uLong ZCALLBACK ZipIO_Write( void* opaque, void* stream,
  348.                                     const void* buf, uLong size )
  349. {
  350.     (void)opaque; (void)stream; (void)buf; (void)size;
  351.     int zip_access_cannot_write_this_should_not_happen = 0;
  352.     assert(zip_access_cannot_write_this_should_not_happen);
  353.     return 0;
  354. }
  355. /** **************************************************************************
  356.  * brief I/O functions for the ioapi: tell
  357.  *****************************************************************************/
  358. static long ZCALLBACK ZipIO_Tell( void* opaque, void* stream )
  359. {
  360.     (void)opaque;
  361.     int64_t i64_tell = stream_Tell( (stream_t*) stream );
  362.     //access_t *p_access = (access_t*) opaque;
  363.     //msg_Dbg(p_access, "tell %" PRIu64, i64_tell);
  364.     return (long)i64_tell;
  365. }
  366. /** **************************************************************************
  367.  * brief I/O functions for the ioapi: seek
  368.  *****************************************************************************/
  369. static long ZCALLBACK ZipIO_Seek( void* opaque, void* stream,
  370.                                   uLong offset, int origin )
  371. {
  372.     (void)opaque;
  373.     //access_t *p_access = (access_t*) opaque;
  374.     int64_t pos = offset;
  375.     switch( origin )
  376.     {
  377.         case SEEK_CUR:
  378.             pos += stream_Tell( (stream_t*) stream );
  379.             break;
  380.         case SEEK_SET:
  381.             break;
  382.         case SEEK_END:
  383.             pos += stream_Size( (stream_t*) stream );
  384.             break;
  385.         default:
  386.             return -1;
  387.     }
  388.     //msg_Dbg( p_access, "seek (%d,%d): %" PRIu64, offset, origin, pos );
  389.     stream_Seek( (stream_t*) stream, pos );
  390.     /* Note: in unzip.c, unzlocal_SearchCentralDir seeks to the end of
  391.              the stream, which is doable but returns an error in VLC.
  392.              That's why we always assume this was OK. FIXME */
  393.     return 0;
  394. }
  395. /** **************************************************************************
  396.  * brief I/O functions for the ioapi: close
  397.  *****************************************************************************/
  398. static int ZCALLBACK ZipIO_Close( void* opaque, void* stream )
  399. {
  400.     (void)opaque;
  401.     stream_Delete( (stream_t*) stream );
  402.     return 0;
  403. }
  404. /** **************************************************************************
  405.  * brief I/O functions for the ioapi: test error (man 3 ferror)
  406.  *****************************************************************************/
  407. static int ZCALLBACK ZipIO_Error( void* opaque, void* stream )
  408. {
  409.     (void)opaque;
  410.     (void)stream;
  411.     //msg_Dbg( p_access, "error" );
  412.     return 0;
  413. }