add tar backend for OC_Archive

also handles bz2/gz compression

3 files changed, 293 insertions, 1 deletions

diff --git a/apps/files_archive/appinfo/app.php b/apps/files_archive/appinfo/app.php
index 693c28d98a0..67809ec980a 100644
--- a/apps/files_archive/appinfo/app.php
+++ b/apps/files_archive/appinfo/app.php
@@ -7,7 +7,8 @@
  */
 
 OC::$CLASSPATH['OC_Archive'] = 'apps/files_archive/lib/archive.php';
-foreach(array('ZIP') as $type){
+OC::$CLASSPATH['Archive_Tar'] = '3rdparty/Archive/Tar.php';
+foreach(array('ZIP','TAR') as $type){
 	OC::$CLASSPATH['OC_Archive_'.$type] = 'apps/files_archive/lib/'.strtolower($type).'.php';
 }
 
diff --git a/apps/files_archive/lib/tar.php b/apps/files_archive/lib/tar.php
new file mode 100644
index 00000000000..40b314a2abf
--- /dev/null
+++ b/apps/files_archive/lib/tar.php
@@ -0,0 +1,271 @@
+<?php
+/**
+ * Copyright (c) 2012 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+class OC_Archive_TAR extends OC_Archive{
+	const PLAIN=0;
+	const GZIP=1;
+	const BZIP=2;
+	
+	/**
+	 * @var Archive_Tar tar
+	 */
+	private $tar=null;
+	private $headers=array();
+	private $path;
+
+	function __construct($source){
+		$types=array(null,'gz','bz');
+		$this->path=$source;
+		$this->tar=new Archive_Tar($source,$types[self::getTarType($source)]);
+	}
+
+	/**
+	 * try to detect the type of tar compression
+	 * @param string file
+	 * @return str
+	 */
+	static public function getTarType($file){
+		if(strpos($file,'.')){
+			$extention=substr($file,strrpos($file,'.'));
+			switch($extention){
+				case 'gz':
+				case 'tgz':
+					return self::GZIP;
+				case 'bz':
+				case 'bz2':
+					return self::BZIP;
+				default:
+					return self::PLAIN;
+			}
+		}else{
+			return self::PLAIN;
+		}
+	}
+
+	/**
+	 * add an empty folder to the archive
+	 * @param string path
+	 * @return bool
+	 */
+	function addFolder($path){
+		if(substr($path,-1)!=='/'){
+			$path.='/';
+		}
+		return $this->tar->add(array($path));
+	}
+	/**
+	 * add a file to the archive
+	 * @param string path
+	 * @param string source either a local file or string data
+	 * @return bool
+	 */
+	function addFile($path,$source=''){
+		if($this->fileExists($path)){
+			$this->remove($path);
+		}
+		if(file_exists($source)){
+			$header=array();
+			$dummy='';
+			$this->tar->_openAppend();
+			$result=$this->tar->_addfile($source,$header,$dummy,$dummy,$path);
+		}else{
+			$result=$this->tar->addString($path,$source);
+		}
+// 		$this->reopen();
+// 		var_dump($this->getFiles());
+// 		exit();
+		
+		return $result;
+	}
+
+	/**
+	 * rename a file or folder in the archive
+	 * @param string source
+	 * @param string dest
+	 * @return bool
+	 */
+	function rename($source,$dest){
+		//no proper way to delete, rename entire archive, rename file and remake archive
+		$tmp=OC_Helper::tmpFolder();
+		$this->tar->extract($tmp);
+		rename($tmp.$source,$tmp.$dest);
+		$this->tar=null;
+		unlink($this->path);
+		$types=array(null,'gz','bz');
+		$this->tar=new Archive_Tar($this->path,$types[self::getTarType($this->path)]);
+		$this->tar->createModify(array($tmp),'',$tmp);
+	}
+
+	private function getHeader($file){
+		if(isset($this->headers[$file])){
+			return $this->headers[$file];
+		}
+		$headers=$this->tar->listContent();
+		foreach($headers as $header){
+			if($file==$header['filename']){
+				return $header;
+			}
+		}
+		return null;
+	}
+	
+	/**
+	 * get the uncompressed size of a file in the archive
+	 * @param string path
+	 * @return int
+	 */
+	function filesize($path){
+		$stat=$this->getHeader($path);
+		return $stat['size'];
+	}
+	/**
+	 * get the last modified time of a file in the archive
+	 * @param string path
+	 * @return int
+	 */
+	function mtime($path){
+		$stat=$this->getHeader($path);
+		return $stat['mtime'];
+	}
+
+	/**
+	 * get the files in a folder
+	 * @param path
+	 * @return array
+	 */
+	function getFolder($path){
+		$files=$this->getFiles();
+		$folderContent=array();
+		$pathLength=strlen($path);
+		foreach($files as $file){
+			if(substr($file,0,$pathLength)==$path and $file!=$path){
+				if(strrpos(substr($file,0,-1),'/')<=$pathLength){
+					$folderContent[]=substr($file,$pathLength);
+				}
+			}
+		}
+		return $folderContent;
+	}
+	/**
+	 *get all files in the archive
+	 * @return array
+	 */
+	function getFiles(){
+		$headers=$this->tar->listContent();
+		$files=array();
+		foreach($headers as $header){
+			$files[]=$header['filename'];
+		}
+		return $files;
+	}
+	/**
+	 * get the content of a file
+	 * @param string path
+	 * @return string
+	 */
+	function getFile($path){
+		return $this->tar->extractInString($path);
+	}
+	/**
+	 * extract a single file from the archive
+	 * @param string path
+	 * @param string dest
+	 * @return bool
+	 */
+	function extractFile($path,$dest){
+		$tmp=OC_Helper::tmpFolder();
+		$success=$this->tar->extractList(array($path),$tmp);
+		if($success){
+			rename($tmp.$path,$dest);
+		}
+		OC_Helper::rmdirr($tmp);
+		return $success;
+	}
+	/**
+	 * extract the archive
+	 * @param string path
+	 * @param string dest
+	 * @return bool
+	 */
+	function extract($dest){
+		return $this->tar->extract($dest);
+	}
+	/**
+	 * check if a file or folder exists in the archive
+	 * @param string path
+	 * @return bool
+	 */
+	function fileExists($path){
+		return $this->getHeader($path)!==null;
+	}
+	
+	/**
+	 * remove a file or folder from the archive
+	 * @param string path
+	 * @return bool
+	 */
+	function remove($path){
+		//no proper way to delete, extract entire archive, delete file and remake archive
+		$tmp=OC_Helper::tmpFolder();
+		$this->tar->extract($tmp);
+		OC_Helper::rmdirr($tmp.$path);
+		$this->tar=null;
+		unlink($this->path);
+		$this->reopen();
+		$this->tar->createModify(array($tmp),'',$tmp);
+	}
+	/**
+	 * get a file handler
+	 * @param string path
+	 * @param string mode
+	 * @return resource
+	 */
+	function getStream($path,$mode){
+		if(strrpos($path,'.')!==false){
+			$ext=substr($path,strrpos($path,'.'));
+		}else{
+			$ext='';
+		}
+		$tmpFile=OC_Helper::tmpFile($ext);
+		if($this->fileExists($path)){
+			$this->extractFile($path,$tmpFile);
+		}elseif($mode=='r' or $mode=='rb'){
+			return false;
+		}
+		if($mode=='r' or $mode=='rb'){
+			return fopen($tmpFile,$mode);
+		}else{
+			OC_CloseStreamWrapper::$callBacks[$tmpFile]=array($this,'writeBack');
+			self::$tempFiles[$tmpFile]=$path;
+			return fopen('close://'.$tmpFile,$mode);
+		}
+	}
+
+	private static $tempFiles=array();
+	/**
+	 * write back temporary files
+	 */
+	function writeBack($tmpFile){
+		if(isset(self::$tempFiles[$tmpFile])){
+			$this->addFile(self::$tempFiles[$tmpFile],$tmpFile);
+			unlink($tmpFile);
+		}
+	}
+
+	/**
+	 * reopen the archive to ensure everything is written
+	 */
+	private function reopen(){
+		if($this->tar){
+			$this->tar->_close();
+			$this->tar=null;
+		}
+		$types=array(null,'gz','bz');
+		$this->tar=new Archive_Tar($this->path,$types[self::getTarType($this->path)]);
+	}
+}
diff --git a/apps/files_archive/tests/tar.php b/apps/files_archive/tests/tar.php
new file mode 100644
index 00000000000..193a65b550a
--- /dev/null
+++ b/apps/files_archive/tests/tar.php
@@ -0,0 +1,20 @@
+<?php
+/**
+ * Copyright (c) 2012 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+require_once('archive.php');
+
+class Test_Archive_TAR extends Test_Archive{
+	protected function getExisting(){
+		$dir=OC::$SERVERROOT.'/apps/files_archive/tests/data';
+		return new OC_Archive_TAR($dir.'/data.tar.gz');
+	}
+
+	protected function getNew(){
+		return new OC_Archive_TAR(OC_Helper::tmpFile('.tar.gz'));
+	}
+}