forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
zip_archive.php
331 lines (274 loc) · 8.65 KB
/
zip_archive.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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Implementation of zip file archive.
*
* @package moodlecore
* @subpackage file-packer
* @copyright 2008 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("$CFG->libdir/packer/file_archive.php");
class zip_archive extends file_archive {
/** Pathname of archive */
protected $archivepathname = null;
/** Used memory tracking */
protected $usedmem = 0;
/** Iteration position */
protected $pos = 0;
/** TipArchive instance */
protected $za;
/**
* Open or create archive (depending on $mode)
* @param string $archivepathname
* @param int $mode OPEN, CREATE or OVERWRITE constant
* @param string $encoding archive local paths encoding
* @return bool success
*/
public function open($archivepathname, $mode=file_archive::CREATE, $encoding='utf-8') {
$this->close();
$this->usedmem = 0;
$this->pos = 0;
$this->za = new ZipArchive();
switch($mode) {
case file_archive::OPEN: $flags = 0; break;
case file_archive::OVERWRITE: $flags = ZIPARCHIVE::OVERWRITE; break;
case file_archive::CREATE:
default : $flags = ZIPARCHIVE::CREATE; break;
}
$result = $this->za->open($archivepathname, $flags);
if ($result === true) {
$this->encoding = $encoding;
if (file_exists($archivepathname)) {
$this->archivepathname = realpath($archivepathname);
} else {
$this->archivepathname = $archivepathname;
}
return true;
} else {
$this->za = null;
$this->archivepathname = null;
$this->encooding = 'utf-8';
// TODO: maybe we should return some error info
return false;
}
}
/**
* Close archive
* @return bool success
*/
public function close() {
if (!isset($this->za)) {
return false;
}
$res = $this->za->close();
$this->za = null;
return $res;
}
/**
* Returns file stream for reading of content
* @param int $index of file
* @return stream or false if error
*/
public function get_stream($index) {
if (!isset($this->za)) {
return false;
}
$name = $this->za->getNameIndex($index);
if ($name === false) {
return false;
}
return $this->za->getStream($name);
}
/**
* Returns file information
* @param int $index of file
* @return info object or false if error
*/
public function get_info($index) {
if (!isset($this->za)) {
return false;
}
if ($index < 0 or $index >=$this->count()) {
return false;
}
$result = $this->za->statIndex($index);
if ($result === false) {
return false;
}
$info = new object();
$info->index = $index;
$info->original_pathname = $result['name'];
$info->pathname = $this->unmangle_pathname($result['name']);
$info->mtime = (int)$result['mtime'];
if ($info->pathname[strlen($info->pathname)-1] === '/') {
$info->is_directory = true;
$info->size = 0;
} else {
$info->is_directory = false;
$info->size = (int)$result['size'];
}
return $info;
}
/**
* Returns array of info about all files in archive
* @return array of file infos
*/
public function list_files() {
if (!isset($this->za)) {
return false;
}
$infos = array();
for ($i=0; $i<$this->count(); $i++) {
$info = $this->get_info($i);
if ($info === false) {
continue;
}
$infos[$i] = $info;
}
return $infos;
}
/**
* Returns number of files in archive
* @return int number of files
*/
public function count() {
if (!isset($this->za)) {
return false;
}
return $this->za->numFiles;
}
/**
* Add file into archive
* @param string $localname name of file in archive
* @param string $pathname localtion of file
* @return bool success
*/
public function add_file_from_pathname($localname, $pathname) {
if (!isset($this->za)) {
return false;
}
if ($this->archivepathname === realpath($pathname)) {
// do not add self into archive
return false;
}
if (is_null($localname)) {
$localname = clean_param($pathname, PARAM_PATH);
}
$localname = trim($localname, '/'); // no leading slashes in archives
$localname = $this->mangle_pathname($localname);
if ($localname === '') {
//sorry - conversion failed badly
return false;
}
if (!check_php_version('5.2.8')) {
// workaround for open file handles problem, ZipArchive uses file locking in order to prevent file modifications before the close() (strange, eh?)
if ($this->count() > 0 and $this->count() % 500 === 0) {
$this->close();
$res = $this->open($this->archivepathname, file_archive::OPEN, $this->encoding);
if ($res !== true) {
print_error('cannotopenzip'); //TODO ??
}
}
}
return $this->za->addFile($pathname, $localname);
}
/**
* Add content of string into archive
* @param string $localname name of file in archive
* @param string $contents
* @return bool success
*/
public function add_file_from_string($localname, $contents) {
if (!isset($this->za)) {
return false;
}
$localname = trim($localname, '/'); // no leading slashes in archives
$localname = $this->mangle_pathname($localname);
if ($localname === '') {
//sorry - conversion failed badly
return false;
}
if ($this->usedmem > 2097151) {
/// this prevents running out of memory when adding many large files using strings
$this->close();
$res = $this->open($this->archivepathname, file_archive::OPEN, $this->encoding);
if ($res !== true) {
print_error('cannotopenzip'); //TODO ??
}
}
$this->usedmem += strlen($contents);
return $this->za->addFromString($localname, $contents);
}
/**
* Add empty directory into archive
* @param string $local
* @return bool success
*/
public function add_directory($localname) {
if (!isset($this->za)) {
return false;
}
$localname = ltrim($localname, '/'). '/';
$localname = $this->mangle_pathname($localname);
if ($localname === '/') {
//sorry - conversion failed badly
return false;
}
return $this->za->addEmptyDir($localname);
}
/**
* Returns current file info
* @return object
*/
public function current() {
if (!isset($this->za)) {
return false;
}
return $this->get_info($this->pos);
}
/**
* Returns the index of current file
* @return int current file index
*/
public function key() {
return $this->pos;
}
/**
* Moves forward to next file
* @return void
*/
public function next() {
$this->pos++;
}
/**
* Revinds back to the first file
* @return void
*/
public function rewind() {
$this->pos = 0;
}
/**
* Did we reach the end?
* @return boolean
*/
public function valid() {
if (!isset($this->za)) {
return false;
}
return ($this->pos < $this->count());
}
}