cvs: php4 /pear/Experimental/Archive Tar.php

vblavet Thu Aug 16 03:25:23 2001 EDT Added files: /php4/pear/Experimental/Archive Tar.php Log: First release of Archive_Tar class. Simple public methods are create(), add(), listContent() and extract(). More features are available with createModify(), addModify(), extractModify() and extractList().

Index: php4/pear/Experimental/Archive/Tar.php +++ php4/pear/Experimental/Archive/Tar.php <?php /* vim: set ts=4 sw=4: */ // +----------------------------------------------------------------------+ // | PHP version 4.0 | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2001 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.02 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Authors: Vincent Blavet <vincent@blavet.net> | // +----------------------------------------------------------------------+ // // $Id: Tar.php,v 1.1 2001/08/16 07:25:22 vblavet Exp $ require_once 'PEAR.php'; class Archive_Tar extends PEAR { var $_tarname; var $_compress; // ----- File descriptor (when file is opened or 0 if closed) var $_file; // {{{ constructor function Archive_Tar($p_tarname, $p_compress = false) { $this->PEAR(); $this->_tarname = $p_tarname; $this->_compress = $p_compress; } // }}} // {{{ constructor function Archive_Tar($p_tarname, $p_filelist, $p_compress = false) { $this->PEAR(); $this->_tarname = $p_tarname; $this->_compress = $p_compress; if (!$this->create($p_filelist)) return 0; } // }}} // {{{ destructor function _Archive_Tar() { $this->_close(); $this->_PEAR(); } // }}} // {{{ create() function create($p_filelist) { return $this->createModify($p_filelist, "", ""); } // }}} // {{{ add() function add($p_filelist) { return $this->addModify($p_filelist, "", ""); } // }}} // {{{ extract() function extract($p_path="") { return $this->extractModify($p_path, ""); } // }}} // {{{ listContent() function listContent() { $v_list_detail = array(); if ($this->_openRead()) { if (!$this->_extractList("", $v_list_detail, "list", "", "")) { unset($v_list_detail); return(0); } $this->_close(); } return $v_list_detail; } // }}} // {{{ createModify() function createModify($p_filelist, $p_add_dir, $p_remove_dir="") { $v_result = true; if (!$this->_openWrite()) return false; if ($p_filelist != "") { if (is_array($p_filelist)) $v_list = $p_filelist; elseif (is_string($p_filelist)) $v_list = explode(" ", $p_filelist); else { $this->_cleanFile(); $this->_error("Invalid file list"); return false; } $v_result = $this->_addList($v_list, "", ""); } if ($v_result) { $this->_writeFooter(); $this->_close(); } else $this->_cleanFile(); return $v_result; } // }}} // {{{ addModify() function addModify($p_filelist, $p_add_dir, $p_remove_dir="") { $v_result = true; if (!@is_file($this->_tarname)) $v_result = $this->createModify($p_filelist, $p_add_dir, $p_remove_dir); else { if (is_array($p_filelist)) $v_list = $p_filelist; elseif (is_string($p_filelist)) $v_list = explode(" ", $p_filelist); else { $this->_error("Invalid file list"); return false; } $v_result = $this->_append($v_list, $p_add_dir, $p_remove_dir); } return $v_result; } // }}} // {{{ extractModify() function extractModify($p_path, $p_remove_path) { $v_result = true; $v_list_detail = array(); if ($v_result = $this->_openRead()) { $v_result = $this->_extractList($p_path, $v_list_detail, "complete", 0, $p_remove_path); $this->_close(); } return $v_result; } // }}} // {{{ extractList() function extractList($p_filelist, $p_path="", $p_remove_path="") { $v_result = true; $v_list_detail = array(); if (is_array($p_filelist)) $v_list = $p_filelist; elseif (is_string($p_filelist)) $v_list = explode(" ", $p_filelist); else { $this->_error("Invalid string list"); return false; } if ($v_result = $this->_openRead()) { $v_result = $this->_extractList($p_path, $v_list_detail, "complete", $v_list, $p_remove_path); $this->_close(); } return $v_result; } // }}} // {{{ _error() function _error($p_message) { // ----- To be completed $this->raiseError($p_message); } // }}} // {{{ _warning() function _warning($p_message) { // ----- To be completed $this->raiseError($p_message); } // }}} // {{{ _openWrite() function _openWrite() { if ($this->_compress) $this->_file = @gzopen($this->_tarname, "w"); else $this->_file = @fopen($this->_tarname, "w"); if ($this->_file == 0) { $this->_error("Unable to open in write mode '".$this->_tarname."'"); return false; } return true; } // }}} // {{{ _openRead() function _openRead() { if ($this->_compress) $this->_file = @gzopen($this->_tarname, "rb"); else $this->_file = @fopen($this->_tarname, "rb"); if ($this->_file == 0) { $this->_error("Unable to open in read mode '".$this->_tarname."'"); return false; } return true; } // }}} // {{{ _openReadWrite() function _openReadWrite() { if ($this->_compress) $this->_file = @gzopen($this->_tarname, "r+b"); else $this->_file = @fopen($this->_tarname, "r+b"); if ($this->_file == 0) { $this->_error("Unable to open in read/write mode '".$this->_tarname."'"); return false; } return true; } // }}} // {{{ _close() function _close() { if ($this->_file) { if ($this->_compress) @gzclose($this->_file); else @fclose($this->_file); $this->_file = 0; } return true; } // }}} // {{{ _cleanFile() function _cleanFile() { _close(); @unlink($this->tarname); return true; } // }}} // {{{ _writeFooter() function _writeFooter() { if ($this->_file) { // ----- Write the last 0 filled block for end of archive $v_binary_data = pack("a512", ""); if ($this->_compress) @gzputs($this->_file, $v_binary_data); else @fputs($this->_file, $v_binary_data); } return true; } // }}} // {{{ _addList() function _addList($p_list, $p_add_dir, $p_remove_dir) { $v_result=true; $v_header = array(); if (!$this->_file) { $this->_error("Invalid file descriptor"); return false; } if (sizeof($p_list) == 0) return true; for ($j=0; ($j<count($p_list)) && ($v_result); $j++) { $v_filename = $p_list[$j]; // ----- Skip the current tar name if ($v_filename == $this->_tarname) continue; if ($v_filename == "") continue; if (!file_exists($v_filename)) { $this->_warning("File '$v_filename' does not exists"); continue; } // ----- Add the file or directory header if (!$this->_addFile($v_filename, $v_header, $p_add_dir, $p_remove_dir)) return false; if (is_dir($v_filename)) { if (!($p_hdir = opendir($v_filename))) { $this->_warning("Directory '$v_filename' can not be read"); continue; } $p_hitem = readdir($p_hdir); // '.' directory $p_hitem = readdir($p_hdir); // '..' directory while ($p_hitem = readdir($p_hdir)) { if ($v_filename != ".") $p_temp_list[0] = $v_filename."/".$p_hitem; else $p_temp_list[0] = $p_hitem; $v_result = $this->_addList($p_temp_list, $p_add_dir, $p_remove_dir); } unset($p_temp_list); unset($p_hdir); unset($p_hitem); } } return $v_result; } // }}} // {{{ _addFile() function _addFile($p_filename, &$p_header, $p_add_dir, $p_remove_dir) { if (!$this->_file) { $this->_error("Invalid file descriptor"); return false; } if ($p_filename == "") { $this->_error("Invalid file name"); return false; } // ----- Calculate the stored filename $v_stored_filename = $p_filename; if ($p_remove_dir != "") { if (substr($p_remove_dir, -1) != '/') $p_remove_dir .= "/"; if (substr($p_filename, 0, strlen($p_remove_dir)) == $p_remove_dir) $v_stored_filename = substr($p_filename, strlen($p_remove_dir)); } if ($p_add_dir != "") { if (substr($p_add_dir, -1) == "/") $v_stored_filename = $p_add_dir.$v_stored_filename; else $v_stored_filename = $p_add_dir."/".$v_stored_filename; } if (strlen($v_stored_filename) > 99) { $this->_warning("Stored file name is too long (max. 99) : '$v_stored_filename'"); fclose($v_file); return true; } if (is_file($p_filename)) { if (($v_file = @fopen($p_filename, "rb")) == 0) { $this->_warning("Unable to open file '$p_filename' in binary read mode"); return true; } if (!$this->_writeHeader($p_filename, $v_stored_filename)) return false; while (($v_buffer = fread($v_file, 512)) != "") { $v_binary_data = pack("a512", "$v_buffer"); if ($this->_compress) @gzputs($this->_file, $v_binary_data); else @fputs($this->_file, $v_binary_data); } fclose($v_file); } else { // ----- Only header for dir if (!$this->_writeHeader($p_filename, $v_stored_filename)) return false; } return true; } // }}} // {{{ _writeHeader() function _writeHeader($p_filename, $p_stored_filename) { if ($p_stored_filename == "") $p_stored_filename = $p_filename; $v_reduce_filename = $this->_pathReduction($p_stored_filename); $v_info = stat($p_filename); $v_uid = sprintf("%6s ", DecOct($v_info[4])); $v_gid = sprintf("%6s ", DecOct($v_info[5])); $v_perms = sprintf("%6s ", DecOct(fileperms($p_filename))); clearstatcache(); $v_size = sprintf("%11s ", DecOct(filesize($p_filename))); $v_mtime = sprintf("%11s", DecOct(filemtime($p_filename))); if (is_dir($p_filename)) $v_typeflag = "5"; else $v_typeflag = ""; $v_linkname = ""; $v_magic = ""; $v_version = ""; $v_uname = ""; $v_gname = ""; $v_devmajor = ""; $v_devminor = ""; $v_prefix = ""; $v_binary_data_first = pack("a100a8a8a8a12A12", $v_reduce_filename, $v_perms, $v_uid, $v_gid, $v_size, $v_mtime); $v_binary_data_last = pack("a1a100a6a2a32a32a8a8a155a12", $v_typeflag, $v_linkname, $v_magic, $v_version, $v_uname, $v_gname, $v_devmajor, $v_devminor, $v_prefix, ""); // ----- Calculate the checksum $v_checksum = 0; // ..... First part of the header for ($i=0; $i<148; $i++) $v_checksum += ord(substr($v_binary_data_first,$i,1)); // ..... Ignore the checksum value and replace it by ' ' (space) for ($i=148; $i<156; $i++) $v_checksum += ord(' '); // ..... Last part of the header for ($i=156, $j=0; $i<512; $i++, $j++) $v_checksum += ord(substr($v_binary_data_last,$j,1)); // ----- Write the first 148 bytes of the header in the archive if ($this->_compress) @gzputs($this->_file, $v_binary_data_first, 148); else @fputs($this->_file, $v_binary_data_first, 148); // ----- Write the calculated checksum $v_checksum = sprintf("%6s ", DecOct($v_checksum)); $v_binary_data = pack("a8", $v_checksum); if ($this->_compress) @gzputs($this->_file, $v_binary_data, 8); else @fputs($this->_file, $v_binary_data, 8); // ----- Write the last 356 bytes of the header in the archive if ($this->_compress) @gzputs($this->_file, $v_binary_data_last, 356); else @fputs($this->_file, $v_binary_data_last, 356); return true; } // }}} // {{{ _readHeader() function _readHeader($v_binary_data, &$v_header) { if (strlen($v_binary_data)==0) { $v_header[filename] = ""; return true; } if (strlen($v_binary_data) != 512) { $v_header[filename] = ""; $this->_error("Invalid block size : ".strlen($v_binary_data)); return false; } // ----- Calculate the checksum $v_checksum = 0; // ..... First part of the header for ($i=0; $i<148; $i++) $v_checksum+=ord(substr($v_binary_data,$i,1)); // ..... Ignore the checksum value and replace it by ' ' (space) for ($i=148; $i<156; $i++) $v_checksum += ord(' '); // ..... Last part of the header for ($i=156; $i<512; $i++) $v_checksum+=ord(substr($v_binary_data,$i,1)); $v_data = unpack("a100filename/a8mode/a8uid/a8gid/a12size/a12mtime/a8checksum/a1typeflag/a100link/a6magic/a2version/a32uname/a32gname/a8devmajor/a8devminor", $v_binary_data); // ----- Extract the checksum $v_header[checksum] = OctDec(trim($v_data[checksum])); if ($v_header[checksum] != $v_checksum) { $v_header[filename] = ""; // ----- Look for last block (empty block) if (($v_checksum == 256) && ($v_header[checksum] == 0)) return true; $this->_error("Invalid checksum : $v_checksum calculated, ".$v_header[checksum]." expected"); return false; } // ----- Extract the properties $v_header[filename] = trim($v_data[filename]); $v_header[mode] = OctDec(trim($v_data[mode])); $v_header[uid] = OctDec(trim($v_data[uid])); $v_header[gid] = OctDec(trim($v_data[gid])); $v_header[size] = OctDec(trim($v_data[size])); $v_header[mtime] = OctDec(trim($v_data[mtime])); $v_header[typeflag] = $v_data[typeflag]; /* ----- All these fields are removed form the header because they do not carry interesting info $v_header[link] = trim($v_data[link]); $v_header[magic] = trim($v_data[magic]); $v_header[version] = trim($v_data[version]); $v_header[uname] = trim($v_data[uname]); $v_header[gname] = trim($v_data[gname]); $v_header[devmajor] = trim($v_data[devmajor]); $v_header[devminor] = trim($v_data[devminor]); */ return true; } // }}} // {{{ _extractList() function _extractList($p_path, &$p_list_detail, $p_mode, $p_file_list, $p_remove_path) { $v_result=true; $v_nb = 0; $v_extract_all = true; $v_listing = false; if (($p_path == "") || ((substr($p_path, 0, 1) != "/") && (substr($p_path, 0, 3) != "../"))) $p_path = "./".$p_path; // ----- Look for path to remove format (should end by /) if (($p_remove_path != "") && (substr($p_remove_path, -1) != '/')) $p_remove_path .= '/'; $p_remove_path_size = strlen($p_remove_path); switch ($p_mode) { case "complete" : $v_extract_all = TRUE; $v_listing = FALSE; break; case "partial" : $v_extract_all = FALSE; $v_listing = FALSE; break; case "list" : $v_extract_all = FALSE; $v_listing = TRUE; break; default : $this->_error("Invalid extract mode ($p_mode)"); return false; } clearstatcache(); While (!($v_end_of_file = ($this->_compress?@gzeof($this->_file):@feof($this->_file)))) { $v_extract_file = FALSE; $v_extraction_stopped = 0; if ($this->_compress) $v_binary_data = @gzread($this->_file, 512); else $v_binary_data = @fread($this->_file, 512); if (!$this->_readHeader($v_binary_data, $v_header)) return false; if ($v_header[filename] == "") continue; if ((!$v_extract_all) && (is_array($p_file_list))) { // ----- By default no unzip if the file is not found $v_extract_file = false; for ($i=0; $i<sizeof($p_file_list); $i++) { // ----- Look if it is a directory if (substr($p_file_list[$i], -1) == "/") { // ----- Look if the directory is in the filename path if ((strlen($v_header[filename]) > strlen($p_file_list[$i])) && (substr($v_header[filename], 0, strlen($p_file_list[$i])) == $p_file_list[$i])) { $v_extract_file = TRUE; break; } } // ----- It is a file, so compare the file names elseif ($p_file_list[$i] == $v_header[filename]) { $v_extract_file = TRUE; break; } } } else { $v_extract_file = TRUE; } // ----- Look if this file need to be extracted if (($v_extract_file) && (!$v_listing)) { if (($p_remove_path != "") && (substr($v_header[filename], 0, $p_remove_path_size) == $p_remove_path)) $v_header[filename] = substr($v_header[filename], $p_remove_path_size); if (($p_path != "./") && ($p_path != "/")) { while (substr($p_path, -1) == "/") $p_path = substr($p_path, 0, strlen($p_path)-1); if (substr($v_header[filename], 0, 1) == "/") $v_header[filename] = $p_path.$v_header[filename]; else $v_header[filename] = $p_path."/".$v_header[filename]; } if (file_exists($v_header[filename])) { if ((is_dir($v_header[filename])) && ($v_header[typeflag] == "")) { $this->_error("File '$v_header[filename]' already exists as a directory"); return false; } if ((is_file($v_header[filename])) && ($v_header[typeflag] == "5")) { $this->_error("Directory '$v_header[filename]' already exists as a file"); return false; } if (!is_writeable($v_header[filename])) { $this->_error("File '$v_header[filename]' already exists and is write protected"); return false; } if (filemtime($v_header[filename]) > $v_header[mtime]) { // To be completed : An error or silent no replace ? } } // ----- Check the directory availability and create it if necessary elseif (($v_result = $this->_dirCheck(($v_header[typeflag] == "5"?$v_header[filename]:dirname($v_header[filename])))) != 1) { $this->_error("Unable to create path for '$v_header[filename]'"); return false; } if ($v_extract_file) { if ($v_header[typeflag] == "5") { if (!@file_exists($v_header[filename])) { if (!@mkdir($v_header[filename], 0777)) { $this->_error("Unable to create directory '".$v_header[filename]."'"); return false; } } } else { if (($v_dest_file = @fopen($v_header[filename], "wb")) == 0) { $this->_error("Error while opening '$v_header[filename]' in write binary mode"); return false; } else { $n = floor($v_header[size]/512); for ($i=0; $i<$n; $i++) { if ($this->_compress) $v_content = @gzread($this->_file, 512); else $v_content = @fread($this->_file, 512); fwrite($v_dest_file, $v_content, 512); } if (($v_header[size] % 512) != 0) { if ($this->_compress) $v_content = @gzread($this->_file, 512); else $v_content = @fread($this->_file, 512); fwrite($v_dest_file, $v_content, ($v_header[size] % 512)); } @fclose($v_dest_file); // ----- Change the file mode, mtime @touch($v_header[filename], $v_header[mtime]); // To be completed //chmod($v_header[filename], DecOct($v_header[mode])); } // ----- Check the file size if (filesize($v_header[filename]) != $v_header[size]) { $this->_error("Extracted file '$v_header[filename]' does not have the correct file size '".filesize($v_filename)."' ('$v_header[size]' expected). Archive may be corrupted."); return false; } } } else { // ----- Jump to next file if ($this->_compress) @gzseek($this->_file, @gztell($this->_file)+(ceil(($v_header[size]/512))*512)); else @fseek($this->_file, @ftell($this->_file)+(ceil(($v_header[size]/512))*512)); } } else { // ----- Jump to next file if ($this->_compress) @gzseek($this->_file, @gztell($this->_file)+(ceil(($v_header[size]/512))*512)); else @fseek($this->_file, @ftell($this->_file)+(ceil(($v_header[size]/512))*512)); } if ($this->_compress) $v_end_of_file = @gzeof($this->_file); else $v_end_of_file = @feof($this->_file); if ($v_listing || $v_extract_file || $v_extraction_stopped) { // ----- Log extracted files if (($v_file_dir = dirname($v_header[filename])) == $v_header[filename]) $v_file_dir = ""; if ((substr($v_header[filename], 0, 1) == "/") && ($v_file_dir == "")) $v_file_dir = "/"; $p_list_detail[$v_nb++] = $v_header; } } return true; } // }}} // {{{ _append() function _append($p_filelist, $p_add_dir="", $p_remove_dir="") { if ($this->_compress) { $this->_close(); if (!@rename($this->_tarname, $this->_tarname.".tmp")) { $this->_error("Error while renaming '".$this->_tarname."' to temporary file '".$this->_tarname.".tmp'"); return false; } if (($v_temp_tar = @gzopen($this->_tarname.".tmp", "rb")) == 0) { $this->_error("Unable to open file '".$this->_tarname.".tmp' in binary read mode"); @rename($this->_tarname.".tmp", $this->_tarname); return false; } if (!$this->_openWrite()) { @rename($this->_tarname.".tmp", $this->_tarname); return false; } $v_buffer = @gzread($v_temp_tar, 512); // ----- Read the following blocks but not the last one if (!@gzeof($v_temp_tar)) { do{ $v_binary_data = pack("a512", "$v_buffer"); @gzputs($this->_file, $v_binary_data); $v_buffer = @gzread($v_temp_tar, 512); } while (!@gzeof($v_temp_tar)); } if ($this->_addList($p_filelist, $p_add_dir, $p_remove_dir)) $this->_writeFooter(); $this->_close(); @gzclose($v_temp_tar); if (!@unlink($this->_tarname.".tmp")) { $this->_error("Error while deleting temporary file '".$this->_tarname.".tmp'"); } return true; } // ----- For not compressed tar, just add files before the last 512 bytes block if (!$this->_openReadWrite()) return false; $v_size = filesize($this->_tarname); fseek($this->_file, $v_size-512); if ($this->_addList($p_filelist, $p_add_dir, $p_remove_dir)) $this->_writeFooter(); $this->_close(); return true; } // }}} // {{{ _dirCheck() function _dirCheck($p_dir) { if ((is_dir($p_dir)) || ($p_dir == "")) return true; $p_parent_dir = dirname($p_dir); if (($p_parent_dir != $p_dir) && ($p_parent_dir != "") && (!$this->_dirCheck($p_parent_dir))) return false; if (!@mkdir($p_dir, 0777)) { $this->_error("Unable to create directory '$p_dir'"); return false; } return true; } // }}} // {{{ _pathReduction() function _pathReduction($p_dir) { $v_result = ""; // ----- Look for not empty path if ($p_dir != "") { // ----- Explode path by directory names $v_list = explode("/", $p_dir); // ----- Study directories from last to first for ($i=sizeof($v_list)-1; $i>=0; $i--) { // ----- Look for current path if ($v_list[$i] == ".") { // ----- Ignore this directory // Should be the first $i=0, but no check is done } else if ($v_list[$i] == "..") { // ----- Ignore it and ignore the $i-1 $i--; } else if (($v_list[$i] == "") && ($i!=(sizeof($v_list)-1)) && ($i!=0)) { // ----- Ignore only the double '//' in path, // but not the first and last '/' } else { $v_result = $v_list[$i].($i!=(sizeof($v_list)-1)?"/".$v_result:""); } } } return $v_result; } // }}} } ?>