<?php
/**
* @version $Id:zip.php 6961 2007-03-15 16:06:53Z tcp $
* @package Joomla.Framework
* @subpackage FileSystem
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
* Joomla! is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/
// Check to ensure this file is within the rest of the framework
if( ! defined( '_JEXEC' ) && ! defined( '_VALID_MOS' ) )
die( 'Restricted access' ) ;
/**
* ZIP format adapter for the JArchive class
*
* The ZIP compression code is partially based on code from:
* Eric Mueller <hide@address.com>
* http://www.zend.com/codex.php?id=535&single=1
*
* Deins125 <hide@address.com>
* http://www.zend.com/codex.php?id=470&single=1
*
* The ZIP compression date code is partially based on code from
* Peter Listiak <hide@address.com>
*
* This class is inspired from and draws heavily in code and concept from the Compress package of
* The Horde Project <http://www.horde.org>
*
* @contributor Chuck Hagenbuch <hide@address.com>
* @contributor Michael Slusarz <hide@address.com>
* @contributor Michael Cochrane <hide@address.com>
*
* @author Louis Landry <hide@address.com>
* @package Joomla.Framework
* @subpackage FileSystem
* @since 1.5
*/
class extArchiveZip {
/**
* ZIP compression methods.
* @var array
*/
var $_methods = array( 0x0 => 'None' , 0x1 => 'Shrunk' , 0x2 => 'Super Fast' , 0x3 => 'Fast' , 0x4 => 'Normal' , 0x5 => 'Maximum' , 0x6 => 'Imploded' , 0x8 => 'Deflated' ) ;
/**
* Beginning of central directory record.
* @var string
*/
var $_ctrlDirHeader = "\x50\x4b\x01\x02" ;
/**
* End of central directory record.
* @var string
*/
var $_ctrlDirEnd = "\x50\x4b\x05\x06\x00\x00\x00\x00" ;
/**
* Beginning of file contents.
* @var string
*/
var $_fileHeader = "\x50\x4b\x03\x04" ;
/**
* ZIP file data buffer
* @var string
*/
var $_data = null ;
/**
* ZIP file metadata array
* @var array
*/
var $_metadata = null ;
/**
* Create a ZIP compressed file from an array of file data.
*
* @todo Finish Implementation
*
* @access public
* @param string $archive Path to save archive
* @param array $files Array of files to add to archive
* @param array $options Compression options [unused]
* @return boolean True if successful
* @since 1.5
*/
function create( $archive, $files, $options = array () ) {
// Initialize variables
$contents = array( ) ;
$ctrldir = array( ) ;
foreach( $files as $file ) {
$this->_addToZIPFile( $file, $contents, $ctrldir ) ;
}
return $this->_createZIPFile( $contents, $ctrldir, $archive ) ;
}
/**
* Extract a ZIP compressed file to a given path
*
* @access public
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive into
* @param array $options Extraction options [unused]
* @return boolean True if successful
* @since 1.5
*/
function extract( $archive, $destination, $options = array () ) {
if( ! is_file( $archive ) ) {
return PEAR::raiseError( 'Archive does not exist' ) ;
}
if( $this->hasNativeSupport() ) {
return $this->_extractNative( $archive, $destination, $options ) ;
} else {
return $this->_extract( $archive, $destination, $options ) ;
}
}
/**
* Method to determine if the server has native zip support for faster handling
*
* @access public
* @return boolean True if php has native ZIP support
* @since 1.5
*/
function hasNativeSupport() {
return (function_exists( 'zip_open' ) && function_exists( 'zip_read' )) ;
}
/**
* Checks to see if the data is a valid ZIP file.
*
* @access public
* @param string $data ZIP archive data buffer
* @return boolean True if valid, false if invalid.
* @since 1.5
*/
function checkZipData( & $data ) {
if( strpos( $data, $this->_fileHeader ) === false ) {
return false ;
} else {
return true ;
}
}
/**
* Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support
*
* @access private
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive into
* @param array $options Extraction options [unused]
* @return boolean True if successful
* @since 1.5
*/
function _extract( $archive, $destination, $options ) {
// Initialize variables
$this->_data = null ;
$this->_metadata = null ;
if( ! extension_loaded( 'zlib' ) ) {
return PEAR::raiseError( 'Zlib Not Supported' ) ;
}
if( ! $this->_data = file_get_contents( $archive ) ) {
return PEAR::raiseError( 'Unable to read archive' ) ;
}
if( ! $this->_getZipInfo( $this->_data ) ) {
return false ;
}
for( $i = 0, $n = count( $this->_metadata ) ; $i < $n ; $i ++ ) {
if( substr( $this->_metadata[$i]['name'], - 1, 1 ) != '/' && substr( $this->_metadata[$i]['name'], - 1, 1 ) != '\\' ) {
$buffer = $this->_getFileData( $i ) ;
$path = extPath::clean( $destination . DS . $this->_metadata[$i]['name'] ) ;
// Make sure the destination folder exists
if( ! extMkdirR( dirname( $path ) ) ) {
return PEAR::raiseError( 'Unable to create destination' ) ;
}
if( file_put_contents( $path, $buffer ) === false ) {
return PEAR::raiseError( 'Unable to write entry' ) ;
}
}
}
return true ;
}
/**
* Extract a ZIP compressed file to a given path using native php api calls for speed
*
* @access private
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive into
* @param array $options Extraction options [unused]
* @return boolean True if successful
* @since 1.5
*/
function _extractNative( $archive, $destination, $options ) {
$zip = zip_open( $archive );
if( is_resource( $zip ) ) {
// Make sure the destination folder exists
if( ! is_dir( $destination ) && ! mkdir( $destination ) ) {
return PEAR::raiseError( 'Unable to create destination' ) ;
}
// Read files in the archive
while( $file = zip_read( $zip ) ) {
if( zip_entry_open( $zip, $file, "r" ) ) {
if( substr( zip_entry_name( $file ), strlen( zip_entry_name( $file ) ) - 1 ) != "/" ) {
$buffer = zip_entry_read( $file, zip_entry_filesize( $file ) ) ;
if( !extMkdirR(dirname($destination . DS . zip_entry_name( $file ))) || file_put_contents( $destination . DS . zip_entry_name( $file ), $buffer ) === false ) {
return PEAR::raiseError( 'Unable to write entry: '.$destination . DS. zip_entry_name( $file ) ) ;
}
zip_entry_close( $file ) ;
}
} else {
return PEAR::raiseError( 'Unable to read entry' ) ;
}
}
zip_close( $zip ) ;
} else {
return PEAR::raiseError( "Unable to open archive: ".extArchiveZip::zipFileErrMsg($zip) ) ;
}
return true ;
}
/**
* Get the list of files/data from a ZIP archive buffer.
*
* @access private
* @param string $data The ZIP archive buffer.
* @return array Archive metadata array
* <pre>
* KEY: Position in zipfile
* VALUES: 'attr' -- File attributes
* 'crc' -- CRC checksum
* 'csize' -- Compressed file size
* 'date' -- File modification time
* 'name' -- Filename
* 'method' -- Compression method
* 'size' -- Original file size
* 'type' -- File type
* </pre>
* @since 1.5
*/
function _getZipInfo( & $data ) {
// Initialize variables
$entries = array( ) ;
// Get details from Central directory structure.
$fhStart = strpos( $data, $this->_ctrlDirHeader ) ;
do {
if( strlen( $data ) < $fhStart + 31 ) {
return PEAR::raiseError( 'Invalid ZIP data' ) ;
}
$info = unpack( 'vMethod/VTime/VCRC32/VCompressed/VUncompressed/vLength', substr( $data, $fhStart + 10, 20 ) ) ;
$name = substr( $data, $fhStart + 46, $info['Length'] ) ;
$entries[$name] = array( 'attr' => null , 'crc' => sprintf( "%08s", dechex( $info['CRC32'] ) ) , 'csize' => $info['Compressed'] , 'date' => null , '_dataStart' => null , 'name' => $name , 'method' => $this->_methods[$info['Method']] , '_method' => $info['Method'] , 'size' => $info['Uncompressed'] , 'type' => null ) ;
$entries[$name]['date'] = mktime( (($info['Time'] >> 11) & 0x1f), (($info['Time'] >> 5) & 0x3f), (($info['Time'] << 1) & 0x3e), (($info['Time'] >> 21) & 0x07), (($info['Time'] >> 16) & 0x1f), ((($info['Time'] >> 25) & 0x7f) + 1980) ) ;
if( strlen( $data ) < $fhStart + 43 ) {
return PEAR::raiseError( 'Invalid ZIP data' ) ;
}
$info = unpack( 'vInternal/VExternal', substr( $data, $fhStart + 36, 6 ) ) ;
$entries[$name]['type'] = ($info['Internal'] & 0x01) ? 'text' : 'binary' ;
$entries[$name]['attr'] = (($info['External'] & 0x10) ? 'D' : '-') . (($info['External'] & 0x20) ? 'A' : '-') . (($info['External'] & 0x03) ? 'S' : '-') . (($info['External'] & 0x02) ? 'H' : '-') . (($info['External'] & 0x01) ? 'R' : '-') ;
} while( ($fhStart = strpos( $data, $this->_ctrlDirHeader, $fhStart + 46 )) !== false ) ;
// Get details from local file header.
$fhStart = strpos( $data, $this->_fileHeader ) ;
do {
if( strlen( $data ) < $fhStart + 34 ) {
return PEAR::raiseError( 'Invalid ZIP data' ) ;
}
$info = unpack( 'vMethod/VTime/VCRC32/VCompressed/VUncompressed/vLength/vExtraLength', substr( $data, $fhStart + 8, 25 ) ) ;
$name = substr( $data, $fhStart + 30, $info['Length'] ) ;
$entries[$name]['_dataStart'] = $fhStart + 30 + $info['Length'] + $info['ExtraLength'] ;
} while( strlen( $data ) > $fhStart + 30 + $info['Length'] && ($fhStart = strpos( $data, $this->_fileHeader, $fhStart + 30 + $info['Length'] )) !== false ) ;
$this->_metadata = array_values( $entries ) ;
return true ;
}
/**
* Returns the file data for a file by offsest in the ZIP archive
*
* @access private
* @param int $key The position of the file in the archive.
* @return string Uncompresed file data buffer
* @since 1.5
*/
function _getFileData( $key ) {
if( $this->_metadata[$key]['_method'] == 0x8 ) {
// If zlib extention is loaded use it
if( extension_loaded( 'zlib' ) ) {
return @ gzinflate( substr( $this->_data, $this->_metadata[$key]['_dataStart'], $this->_metadata[$key]['csize'] ) ) ;
}
} elseif( $this->_metadata[$key]['_method'] == 0x0 ) {
/* Files that aren't compressed. */
return substr( $this->_data, $this->_metadata[$key]['_dataStart'], $this->_metadata[$key]['csize'] ) ;
} elseif( $this->_metadata[$key]['_method'] == 0x12 ) {
// Is bz2 extension loaded? If not try to load it
if( ! extension_loaded( 'bz2' ) ) {
if( JPATH_ISWIN ) {
@ dl( 'php_bz2.dll' ) ;
} else {
@ dl( 'bz2.so' ) ;
}
}
// If bz2 extention is sucessfully loaded use it
if( extension_loaded( 'bz2' ) ) {
return bzdecompress( substr( $this->_data, $this->_metadata[$key]['_dataStart'], $this->_metadata[$key]['csize'] ) ) ;
}
}
return '' ;
}
/**
* Converts a UNIX timestamp to a 4-byte DOS date and time format
* (date in high 2-bytes, time in low 2-bytes allowing magnitude
* comparison).
*
* @access private
* @param int $unixtime The current UNIX timestamp.
* @return int The current date in a 4-byte DOS format.
* @since 1.5
*/
function _unix2DOSTime( $unixtime = null ) {
$timearray = (is_null( $unixtime )) ? getdate() : getdate( $unixtime ) ;
if( $timearray['year'] < 1980 ) {
$timearray['year'] = 1980 ;
$timearray['mon'] = 1 ;
$timearray['mday'] = 1 ;
$timearray['hours'] = 0 ;
$timearray['minutes'] = 0 ;
$timearray['seconds'] = 0 ;
}
return (($timearray['year'] - 1980) << 25) | ($timearray['mon'] << 21) | ($timearray['mday'] << 16) | ($timearray['hours'] << 11) | ($timearray['minutes'] << 5) | ($timearray['seconds'] >> 1) ;
}
/**
* Adds a "file" to the ZIP archive.
*
* @todo Review and finish implementation
*
* @access private
* @param array $file File data array to add
* @param array $contents An array of existing zipped files.
* @param array $ctrldir An array of central directory information.
* @return void
* @since 1.5
*/
function _addToZIPFile( & $file, & $contents, & $ctrldir ) {
$data = & $file['data'] ;
$name = str_replace( '\\', '/', $file['name'] ) ;
/* See if time/date information has been provided. */
$ftime = null ;
if( isset( $file['time'] ) ) {
$ftime = $file['time'] ;
}
/* Get the hex time. */
$dtime = dechex( $this->_unix2DosTime( $ftime ) ) ;
$hexdtime = chr( hexdec( $dtime[6] . $dtime[7] ) ) . chr( hexdec( $dtime[4] . $dtime[5] ) ) . chr( hexdec( $dtime[2] . $dtime[3] ) ) . chr( hexdec( $dtime[0] . $dtime[1] ) ) ;
$fr = $this->_fileHeader ; /* Begin creating the ZIP data. */
$fr .= "\x14\x00" ; /* Version needed to extract. */
$fr .= "\x00\x00" ; /* General purpose bit flag. */
$fr .= "\x08\x00" ; /* Compression method. */
$fr .= $hexdtime ; /* Last modification time/date. */
/* "Local file header" segment. */
$unc_len = strlen( $data ) ;
$crc = crc32( $data ) ;
$zdata = gzcompress( $data ) ;
$zdata = substr( substr( $zdata, 0, strlen( $zdata ) - 4 ), 2 ) ;
$c_len = strlen( $zdata ) ;
$fr .= pack( 'V', $crc ) ; /* CRC 32 information. */
$fr .= pack( 'V', $c_len ) ; /* Compressed filesize. */
$fr .= pack( 'V', $unc_len ) ; /* Uncompressed filesize. */
$fr .= pack( 'v', strlen( $name ) ) ; /* Length of filename. */
$fr .= pack( 'v', 0 ) ; /* Extra field length. */
$fr .= $name ; /* File name. */
/* "File data" segment. */
$fr .= $zdata ;
/* Add this entry to array. */
$old_offset = strlen( implode( '', $contents ) ) ;
$contents[] = & $fr ;
/* Add to central directory record. */
$cdrec = $this->_ctrlDirHeader ;
$cdrec .= "\x00\x00" ; /* Version made by. */
$cdrec .= "\x14\x00" ; /* Version needed to extract */
$cdrec .= "\x00\x00" ; /* General purpose bit flag */
$cdrec .= "\x08\x00" ; /* Compression method */
$cdrec .= $hexdtime ; /* Last mod time/date. */
$cdrec .= pack( 'V', $crc ) ; /* CRC 32 information. */
$cdrec .= pack( 'V', $c_len ) ; /* Compressed filesize. */
$cdrec .= pack( 'V', $unc_len ) ; /* Uncompressed filesize. */
$cdrec .= pack( 'v', strlen( $name ) ) ; /* Length of filename. */
$cdrec .= pack( 'v', 0 ) ; /* Extra field length. */
$cdrec .= pack( 'v', 0 ) ; /* File comment length. */
$cdrec .= pack( 'v', 0 ) ; /* Disk number start. */
$cdrec .= pack( 'v', 0 ) ; /* Internal file attributes. */
$cdrec .= pack( 'V', 32 ) ; /* External file attributes -
'archive' bit set. */
$cdrec .= pack( 'V', $old_offset ) ; /* Relative offset of local
header. */
$cdrec .= $name ; /* File name. */
/* Optional extra field, file comment goes here. */
// Save to central directory array. */
$ctrldir[] = & $cdrec ;
}
/**
* Creates the ZIP file.
* Official ZIP file format: http://www.pkware.com/appnote.txt
*
* @todo Review and finish implementation
*
* @access private
* @param array $contents An array of existing zipped files.
* @param array $ctrldir An array of central directory information.
* @param string $path The path to store the archive.
* @return boolean True if successful
* @since 1.5
*/
function _createZIPFile( & $contents, & $ctrlDir, $path ) {
$data = implode( '', $contents ) ;
$dir = implode( '', $ctrlDir ) ;
$buffer = $data . $dir . $this->_ctrlDirEnd .
/* Total # of entries "on this disk". */
pack( 'v', count( $ctrlDir ) ) .
/* Total # of entries overall. */
pack( 'v', count( $ctrlDir ) ) .
/* Size of central directory. */
pack( 'V', strlen( $dir ) ) .
/* Offset to start of central dir. */
pack( 'V', strlen( $data ) ) .
/* ZIP file comment length. */
"\x00\x00" ;
if( file_put_contents( $path, $buffer ) === false ) {
return false ;
} else {
return true ;
}
}
function zipFileErrMsg($errno) {
// using constant name as a string to make this function PHP4 compatible
$zipFileFunctionsErrors = array(
'ZIPARCHIVE::ER_MULTIDISK' => 'Multi-disk zip archives not supported.',
'ZIPARCHIVE::ER_RENAME' => 'Renaming temporary file failed.',
'ZIPARCHIVE::ER_CLOSE' => 'Closing zip archive failed',
'ZIPARCHIVE::ER_SEEK' => 'Seek error',
'ZIPARCHIVE::ER_READ' => 'Read error',
'ZIPARCHIVE::ER_WRITE' => 'Write error',
'ZIPARCHIVE::ER_CRC' => 'CRC error',
'ZIPARCHIVE::ER_ZIPCLOSED' => 'Containing zip archive was closed',
'ZIPARCHIVE::ER_NOENT' => 'No such file.',
'ZIPARCHIVE::ER_EXISTS' => 'File already exists',
'ZIPARCHIVE::ER_OPEN' => 'Can\'t open file',
'ZIPARCHIVE::ER_TMPOPEN' => 'Failure to create temporary file.',
'ZIPARCHIVE::ER_ZLIB' => 'Zlib error',
'ZIPARCHIVE::ER_MEMORY' => 'Memory allocation failure',
'ZIPARCHIVE::ER_CHANGED' => 'Entry has been changed',
'ZIPARCHIVE::ER_COMPNOTSUPP' => 'Compression method not supported.',
'ZIPARCHIVE::ER_EOF' => 'Premature EOF',
'ZIPARCHIVE::ER_INVAL' => 'Invalid argument',
'ZIPARCHIVE::ER_NOZIP' => 'Not a zip archive',
'ZIPARCHIVE::ER_INTERNAL' => 'Internal error',
'ZIPARCHIVE::ER_INCONS' => 'Zip archive inconsistent',
'ZIPARCHIVE::ER_REMOVE' => 'Can\'t remove file',
'ZIPARCHIVE::ER_DELETED' => 'Entry has been deleted',
);
$errmsg = 'unknown';
foreach ($zipFileFunctionsErrors as $constName => $errorMessage) {
if (defined($constName) and constant($constName) === $errno) {
return 'Zip File Function error: '.$errorMessage;
}
}
return 'Zip File Function error: unknown';
}
}
?>