This repository has been archived by the owner on Jan 30, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 37
/
Zip.php
314 lines (260 loc) · 9.1 KB
/
Zip.php
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Filter\Compress;
use Zend\Filter\Exception;
use ZipArchive;
/**
* Compression adapter for zip
*/
class Zip extends AbstractCompressionAlgorithm
{
/**
* Compression Options
* array(
* 'archive' => Archive to use
* 'password' => Password to use
* 'target' => Target to write the files to
* )
*
* @var array
*/
protected $options = [
'archive' => null,
'target' => null,
];
/**
* Class constructor
*
* @param null|array|\Traversable $options (Optional) Options to set
* @throws Exception\ExtensionNotLoadedException if zip extension not loaded
*/
public function __construct($options = null)
{
if (! extension_loaded('zip')) {
throw new Exception\ExtensionNotLoadedException('This filter needs the zip extension');
}
parent::__construct($options);
}
/**
* Returns the set archive
*
* @return string
*/
public function getArchive()
{
return $this->options['archive'];
}
/**
* Sets the archive to use for de-/compression
*
* @param string $archive Archive to use
* @return self
*/
public function setArchive($archive)
{
$archive = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, (string) $archive);
$this->options['archive'] = $archive;
return $this;
}
/**
* Returns the set targetpath
*
* @return string
*/
public function getTarget()
{
return $this->options['target'];
}
/**
* Sets the target to use
*
* @param string $target
* @throws Exception\InvalidArgumentException
* @return self
*/
public function setTarget($target)
{
if (! file_exists(dirname($target))) {
throw new Exception\InvalidArgumentException("The directory '$target' does not exist");
}
$target = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, (string) $target);
$this->options['target'] = $target;
return $this;
}
/**
* Compresses the given content
*
* @param string $content
* @return string Compressed archive
* @throws Exception\RuntimeException if unable to open zip archive, or error during compression
*/
public function compress($content)
{
$zip = new ZipArchive();
$res = $zip->open($this->getArchive(), ZipArchive::CREATE | ZipArchive::OVERWRITE);
if ($res !== true) {
throw new Exception\RuntimeException($this->errorString($res));
}
if (file_exists($content)) {
$content = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, realpath($content));
$basename = substr($content, strrpos($content, DIRECTORY_SEPARATOR) + 1);
if (is_dir($content)) {
$index = strrpos($content, DIRECTORY_SEPARATOR) + 1;
$content .= DIRECTORY_SEPARATOR;
$stack = [$content];
while (! empty($stack)) {
$current = array_pop($stack);
$files = [];
$dir = dir($current);
while (false !== ($node = $dir->read())) {
if ($node === '.' || $node === '..') {
continue;
}
if (is_dir($current . $node)) {
$stack[] = $current . $node . DIRECTORY_SEPARATOR;
}
if (is_file($current . $node)) {
$files[] = $node;
}
}
$local = substr($current, $index);
$zip->addEmptyDir(substr($local, 0, -1));
foreach ($files as $file) {
$zip->addFile($current . $file, $local . $file);
if ($res !== true) {
throw new Exception\RuntimeException($this->errorString($res));
}
}
}
} else {
$res = $zip->addFile($content, $basename);
if ($res !== true) {
throw new Exception\RuntimeException($this->errorString($res));
}
}
} else {
$file = $this->getTarget();
if (! is_dir($file)) {
$file = basename($file);
} else {
$file = 'zip.tmp';
}
$res = $zip->addFromString($file, $content);
if ($res !== true) {
throw new Exception\RuntimeException($this->errorString($res));
}
}
$zip->close();
return $this->options['archive'];
}
/**
* Decompresses the given content
*
* @param string $content
* @return string
* @throws Exception\RuntimeException If archive file not found, target directory not found,
* or error during decompression
*/
public function decompress($content)
{
$archive = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, realpath($content));
if (empty($archive) || ! file_exists($archive)) {
throw new Exception\RuntimeException('ZIP Archive not found');
}
$zip = new ZipArchive();
$res = $zip->open($archive);
$target = $this->getTarget();
if (! empty($target) && ! is_dir($target)) {
$target = dirname($target);
}
if (! empty($target)) {
$target = rtrim($target, '/\\') . DIRECTORY_SEPARATOR;
}
if (empty($target) || ! is_dir($target)) {
throw new Exception\RuntimeException('No target for ZIP decompression set');
}
if ($res !== true) {
throw new Exception\RuntimeException($this->errorString($res));
}
$res = $zip->extractTo($target);
if ($res !== true) {
throw new Exception\RuntimeException($this->errorString($res));
}
$zip->close();
return $target;
}
/**
* Returns the proper string based on the given error constant
*
* @param string $error
* @return string
*/
public function errorString($error)
{
switch ($error) {
case ZipArchive::ER_MULTIDISK:
return 'Multidisk ZIP Archives not supported';
case ZipArchive::ER_RENAME:
return 'Failed to rename the temporary file for ZIP';
case ZipArchive::ER_CLOSE:
return 'Failed to close the ZIP Archive';
case ZipArchive::ER_SEEK:
return 'Failure while seeking the ZIP Archive';
case ZipArchive::ER_READ:
return 'Failure while reading the ZIP Archive';
case ZipArchive::ER_WRITE:
return 'Failure while writing the ZIP Archive';
case ZipArchive::ER_CRC:
return 'CRC failure within the ZIP Archive';
case ZipArchive::ER_ZIPCLOSED:
return 'ZIP Archive already closed';
case ZipArchive::ER_NOENT:
return 'No such file within the ZIP Archive';
case ZipArchive::ER_EXISTS:
return 'ZIP Archive already exists';
case ZipArchive::ER_OPEN:
return 'Can not open ZIP Archive';
case ZipArchive::ER_TMPOPEN:
return 'Failure creating temporary ZIP Archive';
case ZipArchive::ER_ZLIB:
return 'ZLib Problem';
case ZipArchive::ER_MEMORY:
return 'Memory allocation problem while working on a ZIP Archive';
case ZipArchive::ER_CHANGED:
return 'ZIP Entry has been changed';
case ZipArchive::ER_COMPNOTSUPP:
return 'Compression method not supported within ZLib';
case ZipArchive::ER_EOF:
return 'Premature EOF within ZIP Archive';
case ZipArchive::ER_INVAL:
return 'Invalid argument for ZLIB';
case ZipArchive::ER_NOZIP:
return 'Given file is no zip archive';
case ZipArchive::ER_INTERNAL:
return 'Internal error while working on a ZIP Archive';
case ZipArchive::ER_INCONS:
return 'Inconsistent ZIP archive';
case ZipArchive::ER_REMOVE:
return 'Can not remove ZIP Archive';
case ZipArchive::ER_DELETED:
return 'ZIP Entry has been deleted';
default:
return 'Unknown error within ZIP Archive';
}
}
/**
* Returns the adapter name
*
* @return string
*/
public function toString()
{
return 'Zip';
}
}