diff options
author | Aron Bergman <bathingrad@gmail.com> | 2017-07-10 10:39:37 +0300 |
---|---|---|
committer | Aron Bergman <bathingrad@gmail.com> | 2017-07-10 10:39:37 +0300 |
commit | dd73e321e38cf48bef9bf82319da0c4977f392c5 (patch) | |
tree | ad8b4fd9ac93dad730a6f39e163dedd79d544fa7 /libraries/classes/ZipExtension.php | |
parent | 9d2faf01a34f6c1e2e5eeb1f1a191fd504efe9ca (diff) |
Refractor ZipExtension to use ZipArchive
ZipExtension is now using ZipArchive instead of zip_* functions.
Replaced getError with ZipArchive::getStatusString.
The documentation for the file has been refractored.
ZipExtension now includes ZipFile functionality, and thus ZipFile is removed.
See issue #13365
Signed-off-by: Aron Bergman <bathingrad@gmail.com>
Diffstat (limited to 'libraries/classes/ZipExtension.php')
-rw-r--r-- | libraries/classes/ZipExtension.php | 309 |
1 files changed, 191 insertions, 118 deletions
diff --git a/libraries/classes/ZipExtension.php b/libraries/classes/ZipExtension.php index 6dd715c5d5..0f2ca23c64 100644 --- a/libraries/classes/ZipExtension.php +++ b/libraries/classes/ZipExtension.php @@ -19,7 +19,7 @@ class ZipExtension /** * Gets zip file contents * - * @param string $file zip file + * @param string $file path to zip file * @param string $specific_entry regular expression to match a file * * @return array ($error_message, $file_data); $error_message @@ -27,138 +27,117 @@ class ZipExtension */ public static function getContents($file, $specific_entry = null) { + /** + * This function is used to "import" a SQL file which has been exported earlier + * That means that this function works on the assumption that the zip file contains only a single SQL file + * It might also be an ODS file, look below + */ + $error_message = ''; $file_data = ''; - $zip_handle = zip_open($file); - if (!is_resource($zip_handle)) { - $error_message = __('Error in ZIP archive:') - . ' ' . self::getError($zip_handle); - return (array('error' => $error_message, 'data' => $file_data)); - } - $first_zip_entry = zip_read($zip_handle); - if (false === $first_zip_entry) { - $error_message = __('No files found inside ZIP archive!'); - zip_close($zip_handle); - return (array('error' => $error_message, 'data' => $file_data)); - } + $zip = new ZipArchive; + $res = $zip->open($file); - /* Is the the zip really an ODS file? */ - $read = zip_entry_read($first_zip_entry); - $ods_mime = 'application/vnd.oasis.opendocument.spreadsheet'; - if (!strcmp($ods_mime, $read)) { - $specific_entry = '/^content\.xml$/'; - } + if ($res === TRUE) { + if ($zip->numFiles === 0) { + $error_message = __('No files found inside ZIP archive!'); + $zip->close(); + return (array('error' => $error_message, 'data' => $file_data)); + } - if (!isset($specific_entry)) { - zip_entry_open($zip_handle, $first_zip_entry, 'r'); - /* File pointer has already been moved, - * so include what was read above */ - $file_data = $read; - $file_data .= zip_entry_read( - $first_zip_entry, - zip_entry_filesize($first_zip_entry) - ); - zip_entry_close($first_zip_entry); - zip_close($zip_handle); - return (array('error' => $error_message, 'data' => $file_data)); - } + /* Is the the zip really an ODS file? */ + $ods_mime = 'application/vnd.oasis.opendocument.spreadsheet'; + $first_zip_entry = $zip->getFromIndex(0); + if (!strcmp($ods_mime, $first_zip_entry)) { + $specific_entry = '/^content\.xml$/'; + } + + if (!isset($specific_entry)) { + $file_data = $first_zip_entry; + $zip->close(); + return (array('error' => $error_message, 'data' => $file_data)); + } - /* Return the correct contents, not just the first entry */ - for ( ; ; ) { - $entry = zip_read($zip_handle); - if (is_resource($entry)) { - if (preg_match($specific_entry, zip_entry_name($entry))) { - zip_entry_open($zip_handle, $entry, 'r'); - $file_data = zip_entry_read( - $entry, - zip_entry_filesize($entry) - ); - zip_entry_close($entry); + /* Return the correct contents, not just the first entry */ + for ($i = 0; $i < $zip->numFiles; $i++) { + if (@preg_match($specific_entry, $zip->getNameIndex($i))) { + $file_data = $zip->getFromIndex($i); break; } - } else { - /** - * Either we have reached the end of the zip and still - * haven't found $specific_entry or there was a parsing - * error that we must display - */ - if ($entry === false) { - $error_message = __('Error in ZIP archive:') - . ' Could not find "' . $specific_entry . '"'; - } else { - $error_message = __('Error in ZIP archive:') - . ' ' . self::getError($zip_handle); - } + } - break; + /* Couldn't find any files that matched $specific_entry */ + if (empty($file_data)) { + $error_message = __('Error in ZIP archive:') + . ' Could not find "' . $specific_entry . '"'; } - } - zip_close($zip_handle); - return (array('error' => $error_message, 'data' => $file_data)); + $zip->close(); + return (array('error' => $error_message, 'data' => $file_data)); + } else { + $error_message = __('Error in ZIP archive:') . ' ' . $zip->getStatusString(); + $zip->close(); + return (array('error' => $error_message, 'data' => $file_data)); + } } /** - * Returns the file name of the first file that matches the given $file_regexp. + * Returns the filename of the first file that matches the given $file_regexp. * - * @param string $file_regexp regular expression for the file name to match - * @param string $file zip archive + * @param string $file path to zip file + * @param string $regex regular expression for the file name to match * - * @return string the file name of the first file that matches the given regexp + * @return string the file name of the first file that matches the given regular expression */ - public static function findFile($file_regexp, $file) + public static function findFile($file, $regex) { - $zip_handle = zip_open($file); - if (is_resource($zip_handle)) { - $entry = zip_read($zip_handle); - while (is_resource($entry)) { - if (preg_match($file_regexp, zip_entry_name($entry))) { - $file_name = zip_entry_name($entry); - zip_close($zip_handle); - return $file_name; + $zip = new ZipArchive; + $res = $zip->open($file); + + if ($res === TRUE) { + for ($i = 0; $i < $zip->numFiles; $i++) { + if (preg_match($regex, $zip->getNameIndex($i))) { + $filename = $zip->getNameIndex($i); + $zip->close(); + return $filename; } - $entry = zip_read($zip_handle); } } - zip_close($zip_handle); return false; } /** * Returns the number of files in the zip archive. * - * @param string $file zip archive + * @param string $file path to zip file * - * @return int the number of files in the zip archive + * @return int the number of files in the zip archive or 0, either if there wern't any files or an error occured. */ public static function getNumberOfFiles($file) { - $count = 0; - $zip_handle = zip_open($file); - if (is_resource($zip_handle)) { - $entry = zip_read($zip_handle); - while (is_resource($entry)) { - $count++; - $entry = zip_read($zip_handle); - } - zip_close($zip_handle); + $num = 0; + $zip = new ZipArchive; + $res = $zip->open($file); + + if ($res === TRUE) { + $num = $zip->numFiles; } - return $count; + return $num; } /** - * Extracts a set of files from the given zip archive to a given destinations. + * Extracts the content of $entry. * - * @param string $zip_path path to the zip archive - * @param string $entry file in the archive that should be extracted + * @param string $file path to zip file + * @param string $entry file in the archive that should be extracted * * @return string|bool data on sucess, false otherwise */ - public static function extract($zip_path, $entry) + public static function extract($file, $entry) { $zip = new ZipArchive; - if ($zip->open($zip_path) === true) { + if ($zip->open($file) === true) { $result = $zip->getFromName($entry); $zip->close(); return $result; @@ -167,34 +146,128 @@ class ZipExtension } /** - * Gets zip error message - * - * @param resource $code error code - * - * @return string error message + * Creates a zip file. + * If $data is an array and $name is a string, the filenames will be indexed. + * The function will return false if $data is a string but $name is an array or if $data is an array and $name is an array, but they don't have the same amount of elements. + * + * @param array|string $data contents of the file/files + * @param array|string $name name of the file/files in the archive + * @param integer $time the current timestamp + * + * @return string|bool the ZIP file contents, or false if there was an error. */ - public static function getError($code) + public static function createFile($data, $name, $time = 0) { - // I don't think this needs translation - switch ($code) { - case ZipArchive::ER_MULTIDISK: - $message = 'Multi-disk zip archives not supported'; - break; - case ZipArchive::ER_READ: - $message = 'Read error'; - break; - case ZipArchive::ER_CRC: - $message = 'CRC error'; - break; - case ZipArchive::ER_NOZIP: - $message = 'Not a zip archive'; - break; - case ZipArchive::ER_INCONS: - $message = 'Zip archive inconsistent'; - break; - default: - $message = $code; + $datasec = array(); // Array to store compressed data + $ctrl_dir = array(); // Central directory + $old_offset = 0; // Last offset position + $eof_ctrl_dir = "\x50\x4b\x05\x06\x00\x00\x00\x00"; // End of central directory record + $index = false; // Whether or not to index files + + if (count($name) === 1) { + $index = true; + $name = str_replace('\\', '/', $name); + $extension_pos = strpos($name, '.'); + $extension = substr($name, $extension_pos); + $name = substr($name, 0, -$extension_pos - 1); + } else { + if (count($name) != count($data)) { + return false; + } } - return $message; + + for ($i = 0; $i < count($data); $i++) { + if ($index) { + $temp_name = $name . '_' . $i . $extension; + } else { + $temp_name = str_replace('\\', '/', $name[$i]); + } + + /* Convert Unix timestamp to DOS timestamp */ + $timearray = ($time == 0) ? getdate() : getdate($time); + + if ($timearray['year'] < 1980) { + $timearray['year'] = 1980; + $timearray['mon'] = 1; + $timearray['mday'] = 1; + $timearray['hours'] = 0; + $timearray['minutes'] = 0; + $timearray['seconds'] = 0; + } + + $time = (($timearray['year'] - 1980) << 25) + | ($timearray['mon'] << 21) + | ($timearray['mday'] << 16) + | ($timearray['hours'] << 11) + | ($timearray['minutes'] << 5) + | ($timearray['seconds'] >> 1); + + $hexdtime = pack('V', $time); + + $fr = "\x50\x4b\x03\x04"; + $fr .= "\x14\x00"; // ver needed to extract + $fr .= "\x00\x00"; // gen purpose bit flag + $fr .= "\x08\x00"; // compression method + $fr .= $hexdtime; // last mod time and date + + // "local file header" segment + $unc_len = strlen($data[$i]); + $crc = crc32($data[$i]); + $zdata = gzcompress($data[$i]); + $zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2); // fix crc bug + $c_len = strlen($zdata); + $fr .= pack('V', $crc); // crc32 + $fr .= pack('V', $c_len); // compressed filesize + $fr .= pack('V', $unc_len); // uncompressed filesize + $fr .= pack('v', strlen($temp_name)); // length of filename + $fr .= pack('v', 0); // extra field length + $fr .= $temp_name; + + // "file data" segment + $fr .= $zdata; + + $datasec[] = $fr; + + // now add to central directory record + $cdrec = "\x50\x4b\x01\x02"; + $cdrec .= "\x00\x00"; // version made by + $cdrec .= "\x14\x00"; // version needed to extract + $cdrec .= "\x00\x00"; // gen purpose bit flag + $cdrec .= "\x08\x00"; // compression method + $cdrec .= $hexdtime; // last mod time & date + $cdrec .= pack('V', $crc); // crc32 + $cdrec .= pack('V', $c_len); // compressed filesize + $cdrec .= pack('V', $unc_len); // uncompressed filesize + $cdrec .= pack('v', strlen($temp_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 + $old_offset += strlen($fr); + + $cdrec .= $temp_name; + + // optional extra field, file comment goes here + // save to central directory + $ctrl_dir[] = $cdrec; + } + + /* Build string to return */ + $temp_ctrldir = implode('', $ctrl_dir); + $header = $temp_ctrldir . + $eof_ctrl_dir . + pack('v', sizeof($ctrl_dir)) . //total #of entries "on this disk" + pack('v', sizeof($ctrl_dir)) . //total #of entries overall + pack('V', strlen($temp_ctrldir)) . //size of central dir + pack('V', $old_offset) . //offset to start of central dir + "\x00\x00"; //.zip file comment length + + $data = implode('', $datasec); + + return $data . $header; } } |