aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_archive/lib/tar.php
blob: a5d54004788f7fe0b6f8a64213ca3795f53b4fc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?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 $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){
		$tmpBase=get_temp_dir().'/';
		if(substr($path,-1,1)!='/'){
			$path.='/';
		}
		if($this->fileExists($path)){
			return false;
		}
		mkdir($tmpBase.$path);
		$result=$this->tar->addModify(array($tmpBase.$path),'',$tmpBase);
		rmdir($tmpBase.$path);
		return $result;
	}
	/**
	 * 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);
		}
		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){
		$headers=$this->tar->listContent();
		foreach($headers as $header){
			if($file==$header['filename'] or $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();
		if(!$this->fileExists($path)){
			return false;
		}
		$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){
		if(!$this->fileExists($path)){
			return false;
		}
		//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);
		return true;
	}
	/**
	 * 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)]);
	}
}