updraftplus
Last commit date
addons
13 years ago
central
9 years ago
css
9 years ago
images
9 years ago
includes
9 years ago
languages
9 years ago
methods
9 years ago
templates
9 years ago
vendor
9 years ago
admin.php
9 years ago
backup.php
9 years ago
changelog.txt
9 years ago
class-updraftplus.php
9 years ago
class-zip.php
9 years ago
clean-composer.sh
9 years ago
composer.json
9 years ago
composer.lock
9 years ago
example-decrypt.php
9 years ago
index.html
9 years ago
options.php
9 years ago
readme.txt
9 years ago
restorer.php
9 years ago
updraftplus.php
9 years ago
class-zip.php
343 lines
| 1 | <?php |
| 2 | |
| 3 | if (!defined ('ABSPATH')) die('No direct access allowed'); |
| 4 | |
| 5 | if (class_exists('ZipArchive')): |
| 6 | # We just add a last_error variable for comaptibility with our UpdraftPlus_PclZip object |
| 7 | class UpdraftPlus_ZipArchive extends ZipArchive { |
| 8 | public $last_error = 'Unknown: ZipArchive does not return error messages'; |
| 9 | } |
| 10 | endif; |
| 11 | |
| 12 | # A ZipArchive compatibility layer, with behaviour sufficient for our usage of ZipArchive |
| 13 | class UpdraftPlus_PclZip { |
| 14 | |
| 15 | protected $pclzip; |
| 16 | protected $path; |
| 17 | protected $addfiles; |
| 18 | protected $adddirs; |
| 19 | private $statindex; |
| 20 | private $include_mtime = false; |
| 21 | public $last_error; |
| 22 | |
| 23 | public function __construct() { |
| 24 | $this->addfiles = array(); |
| 25 | $this->adddirs = array(); |
| 26 | // Put this in a non-backed-up, writeable location, to make sure that huge temporary files aren't created and then added to the backup - and that we have somewhere writable |
| 27 | global $updraftplus; |
| 28 | if (!defined('PCLZIP_TEMPORARY_DIR')) define('PCLZIP_TEMPORARY_DIR', trailingslashit($updraftplus->backups_dir_location())); |
| 29 | } |
| 30 | |
| 31 | # Used to include mtime in statindex (by default, not done - to save memory; probably a bit paranoid) |
| 32 | public function ud_include_mtime() { |
| 33 | $this->include_mtime = true; |
| 34 | } |
| 35 | |
| 36 | public function __get($name) { |
| 37 | if ($name == 'numFiles' || $name == 'numAll') { |
| 38 | |
| 39 | if (empty($this->pclzip)) return false; |
| 40 | |
| 41 | $statindex = $this->pclzip->listContent(); |
| 42 | |
| 43 | if (empty($statindex)) { |
| 44 | $this->statindex = array(); |
| 45 | // We return a value that is == 0, but allowing a PclZip error to be detected (PclZip returns 0 in the case of an error). |
| 46 | if (0 === $statindex) $this->last_error = $this->pclzip->errorInfo(true); |
| 47 | return (0 === $statindex) ? false : 0; |
| 48 | } |
| 49 | |
| 50 | if ($name == 'numFiles') { |
| 51 | |
| 52 | $result = array(); |
| 53 | foreach ($statindex as $i => $file) { |
| 54 | if (!isset($statindex[$i]['folder']) || 0 == $statindex[$i]['folder']) { |
| 55 | $result[] = $file; |
| 56 | } |
| 57 | unset($statindex[$i]); |
| 58 | } |
| 59 | |
| 60 | $this->statindex=$result; |
| 61 | |
| 62 | } else { |
| 63 | $this->statindex=$statindex; |
| 64 | } |
| 65 | |
| 66 | return count($this->statindex); |
| 67 | } |
| 68 | |
| 69 | return null; |
| 70 | |
| 71 | } |
| 72 | |
| 73 | public function statIndex($i) { |
| 74 | if (empty($this->statindex[$i])) return array('name' => null, 'size' => 0); |
| 75 | $v = array('name' => $this->statindex[$i]['filename'], 'size' => $this->statindex[$i]['size']); |
| 76 | if ($this->include_mtime) $v['mtime'] = $this->statindex[$i]['mtime']; |
| 77 | return $v; |
| 78 | } |
| 79 | |
| 80 | public function open($path, $flags = 0) { |
| 81 | |
| 82 | if(!class_exists('PclZip')) include_once(ABSPATH.'/wp-admin/includes/class-pclzip.php'); |
| 83 | if(!class_exists('PclZip')) { |
| 84 | $this->last_error = "No PclZip class was found"; |
| 85 | return false; |
| 86 | } |
| 87 | |
| 88 | # Route around PHP bug (exact version with the problem not known) |
| 89 | $ziparchive_create_match = (version_compare(PHP_VERSION, '5.2.12', '>') && defined('ZIPARCHIVE::CREATE')) ? ZIPARCHIVE::CREATE : 1; |
| 90 | |
| 91 | if ($flags == $ziparchive_create_match && file_exists($path)) @unlink($path); |
| 92 | |
| 93 | $this->pclzip = new PclZip($path); |
| 94 | |
| 95 | if (empty($this->pclzip)) { |
| 96 | $this->last_error = 'Could not get a PclZip object'; |
| 97 | return false; |
| 98 | } |
| 99 | |
| 100 | # Make the empty directory we need to implement addEmptyDir() |
| 101 | global $updraftplus; |
| 102 | $updraft_dir = $updraftplus->backups_dir_location(); |
| 103 | if (!is_dir($updraft_dir.'/emptydir') && !mkdir($updraft_dir.'/emptydir')) { |
| 104 | $this->last_error = "Could not create empty directory ($updraft_dir/emptydir)"; |
| 105 | return false; |
| 106 | } |
| 107 | |
| 108 | $this->path = $path; |
| 109 | |
| 110 | return true; |
| 111 | |
| 112 | } |
| 113 | |
| 114 | # Do the actual write-out - it is assumed that close() is where this is done. Needs to return true/false |
| 115 | public function close() { |
| 116 | if (empty($this->pclzip)) { |
| 117 | $this->last_error = 'Zip file was not opened'; |
| 118 | return false; |
| 119 | } |
| 120 | |
| 121 | global $updraftplus; |
| 122 | $updraft_dir = $updraftplus->backups_dir_location(); |
| 123 | |
| 124 | $activity = false; |
| 125 | |
| 126 | # Add the empty directories |
| 127 | foreach ($this->adddirs as $dir) { |
| 128 | if (false == $this->pclzip->add($updraft_dir.'/emptydir', PCLZIP_OPT_REMOVE_PATH, $updraft_dir.'/emptydir', PCLZIP_OPT_ADD_PATH, $dir)) { |
| 129 | $this->last_error = $this->pclzip->errorInfo(true); |
| 130 | return false; |
| 131 | } |
| 132 | $activity = true; |
| 133 | } |
| 134 | |
| 135 | foreach ($this->addfiles as $rdirname => $adirnames) { |
| 136 | foreach ($adirnames as $adirname => $files) { |
| 137 | if (false == $this->pclzip->add($files, PCLZIP_OPT_REMOVE_PATH, $rdirname, PCLZIP_OPT_ADD_PATH, $adirname)) { |
| 138 | $this->last_error = $this->pclzip->errorInfo(true); |
| 139 | return false; |
| 140 | } |
| 141 | $activity = true; |
| 142 | } |
| 143 | unset($this->addfiles[$rdirname]); |
| 144 | } |
| 145 | |
| 146 | $this->pclzip = false; |
| 147 | $this->addfiles = array(); |
| 148 | $this->adddirs = array(); |
| 149 | |
| 150 | clearstatcache(); |
| 151 | if ($activity && filesize($this->path) < 50) { |
| 152 | $this->last_error = "Write failed - unknown cause (check your file permissions)"; |
| 153 | return false; |
| 154 | } |
| 155 | |
| 156 | return true; |
| 157 | } |
| 158 | |
| 159 | # Note: basename($add_as) is irrelevant; that is, it is actually basename($file) that will be used. But these are always identical in our usage. |
| 160 | public function addFile($file, $add_as) { |
| 161 | # Add the files. PclZip appears to do the whole (copy zip to temporary file, add file, move file) cycle for each file - so batch them as much as possible. We have to batch by dirname(). On a test with 1000 files of 25KB each in the same directory, this reduced the time needed on that directory from 120s to 15s (or 5s with primed caches). |
| 162 | $rdirname = dirname($file); |
| 163 | $adirname = dirname($add_as); |
| 164 | $this->addfiles[$rdirname][$adirname][] = $file; |
| 165 | } |
| 166 | |
| 167 | # PclZip doesn't have a direct way to do this |
| 168 | public function addEmptyDir($dir) { |
| 169 | $this->adddirs[] = $dir; |
| 170 | } |
| 171 | |
| 172 | public function extract($path_to_extract, $path) { |
| 173 | return $this->pclzip->extract(PCLZIP_OPT_PATH, $path_to_extract, PCLZIP_OPT_BY_NAME, $path); |
| 174 | } |
| 175 | |
| 176 | } |
| 177 | |
| 178 | class UpdraftPlus_BinZip extends UpdraftPlus_PclZip { |
| 179 | |
| 180 | private $binzip; |
| 181 | |
| 182 | public function __construct() { |
| 183 | global $updraftplus_backup; |
| 184 | $this->binzip = $updraftplus_backup->binzip; |
| 185 | if (!is_string($this->binzip)) { |
| 186 | $this->last_error = "No binary zip was found"; |
| 187 | return false; |
| 188 | } |
| 189 | return parent::__construct(); |
| 190 | } |
| 191 | |
| 192 | public function addFile($file, $add_as) { |
| 193 | |
| 194 | global $updraftplus; |
| 195 | # Get the directory that $add_as is relative to |
| 196 | $base = $updraftplus->str_lreplace($add_as, '', $file); |
| 197 | |
| 198 | if ($file == $base) { |
| 199 | // Shouldn't happen; but see: https://bugs.php.net/bug.php?id=62119 |
| 200 | $updraftplus->log("File skipped due to unexpected name mismatch (locale: ".setlocale(LC_CTYPE, "0")."): file=$file add_as=$add_as", 'notice', false, true); |
| 201 | } else { |
| 202 | $rdirname = untrailingslashit($base); |
| 203 | # Note: $file equals $rdirname/$add_as |
| 204 | $this->addfiles[$rdirname][] = $add_as; |
| 205 | } |
| 206 | |
| 207 | } |
| 208 | |
| 209 | # The standard zip binary cannot list; so we use PclZip for that |
| 210 | # Do the actual write-out - it is assumed that close() is where this is done. Needs to return true/false |
| 211 | public function close() { |
| 212 | |
| 213 | if (empty($this->pclzip)) { |
| 214 | $this->last_error = 'Zip file was not opened'; |
| 215 | return false; |
| 216 | } |
| 217 | |
| 218 | global $updraftplus, $updraftplus_backup; |
| 219 | $updraft_dir = $updraftplus->backups_dir_location(); |
| 220 | |
| 221 | $activity = false; |
| 222 | |
| 223 | # BinZip does not like zero-sized zip files |
| 224 | if (file_exists($this->path) && 0 == filesize($this->path)) @unlink($this->path); |
| 225 | |
| 226 | $descriptorspec = array( |
| 227 | 0 => array('pipe', 'r'), |
| 228 | 1 => array('pipe', 'w'), |
| 229 | 2 => array('pipe', 'w') |
| 230 | ); |
| 231 | $exec = $this->binzip; |
| 232 | if (defined('UPDRAFTPLUS_BINZIP_OPTS') && UPDRAFTPLUS_BINZIP_OPTS) $exec .= ' '.UPDRAFTPLUS_BINZIP_OPTS; |
| 233 | $exec .= " -v -@ ".escapeshellarg($this->path); |
| 234 | |
| 235 | $last_recorded_alive = time(); |
| 236 | $something_useful_happened = $updraftplus->something_useful_happened; |
| 237 | $orig_size = file_exists($this->path) ? filesize($this->path) : 0; |
| 238 | $last_size = $orig_size; |
| 239 | clearstatcache(); |
| 240 | |
| 241 | $added_dirs_yet = false; |
| 242 | |
| 243 | # If there are no files to add, but there are empty directories, then we need to make sure the directories actually get added |
| 244 | if (0 == count($this->addfiles) && 0 < count($this->adddirs)) { |
| 245 | $dir = realpath($updraftplus_backup->make_zipfile_source); |
| 246 | $this->addfiles[$dir] = '././.'; |
| 247 | } |
| 248 | // Loop over each destination directory name |
| 249 | foreach ($this->addfiles as $rdirname => $files) { |
| 250 | |
| 251 | $process = proc_open($exec, $descriptorspec, $pipes, $rdirname); |
| 252 | |
| 253 | if (!is_resource($process)) { |
| 254 | $updraftplus->log('BinZip error: proc_open failed'); |
| 255 | $this->last_error = 'BinZip error: proc_open failed'; |
| 256 | return false; |
| 257 | } |
| 258 | |
| 259 | if (!$added_dirs_yet) { |
| 260 | # Add the directories - (in fact, with binzip, non-empty directories automatically have their entries added; but it doesn't hurt to add them explicitly) |
| 261 | foreach ($this->adddirs as $dir) { |
| 262 | fwrite($pipes[0], $dir."/\n"); |
| 263 | } |
| 264 | $added_dirs_yet=true; |
| 265 | } |
| 266 | |
| 267 | $read = array($pipes[1], $pipes[2]); |
| 268 | $except = null; |
| 269 | |
| 270 | if (!is_array($files) || 0 == count($files)) { |
| 271 | fclose($pipes[0]); |
| 272 | $write = array(); |
| 273 | } else { |
| 274 | $write = array($pipes[0]); |
| 275 | } |
| 276 | |
| 277 | while ((!feof($pipes[1]) || !feof($pipes[2]) || (is_array($files) && count($files)>0)) && false !== ($changes = @stream_select($read, $write, $except, 0, 200000))) { |
| 278 | |
| 279 | if (is_array($write) && in_array($pipes[0], $write) && is_array($files) && count($files)>0) { |
| 280 | $file = array_pop($files); |
| 281 | // Send the list of files on stdin |
| 282 | fwrite($pipes[0], $file."\n"); |
| 283 | if (0 == count($files)) fclose($pipes[0]); |
| 284 | } |
| 285 | |
| 286 | if (is_array($read) && in_array($pipes[1], $read)) { |
| 287 | $w = fgets($pipes[1]); |
| 288 | // Logging all this really slows things down; use debug to mitigate |
| 289 | if ($w && $updraftplus_backup->debug) $updraftplus->log("Output from zip: ".trim($w), 'debug'); |
| 290 | if (time() > $last_recorded_alive + 5) { |
| 291 | $updraftplus->record_still_alive(); |
| 292 | $last_recorded_alive = time(); |
| 293 | } |
| 294 | if (file_exists($this->path)) { |
| 295 | $new_size = @filesize($this->path); |
| 296 | if (!$something_useful_happened && $new_size > $orig_size + 20) { |
| 297 | $updraftplus->something_useful_happened(); |
| 298 | $something_useful_happened = true; |
| 299 | } |
| 300 | clearstatcache(); |
| 301 | # Log when 20% bigger or at least every 50MB |
| 302 | if ($new_size > $last_size*1.2 || $new_size > $last_size + 52428800) { |
| 303 | $updraftplus->log(basename($this->path).sprintf(": size is now: %.2f MB", round($new_size/1048576,1))); |
| 304 | $last_size = $new_size; |
| 305 | } |
| 306 | } |
| 307 | } |
| 308 | |
| 309 | if (is_array($read) && in_array($pipes[2], $read)) { |
| 310 | $last_error = fgets($pipes[2]); |
| 311 | if (!empty($last_error)) $this->last_error = rtrim($last_error); |
| 312 | } |
| 313 | |
| 314 | // Re-set |
| 315 | $read = array($pipes[1], $pipes[2]); |
| 316 | $write = (is_array($files) && count($files) >0) ? array($pipes[0]) : array(); |
| 317 | $except = null; |
| 318 | |
| 319 | } |
| 320 | |
| 321 | fclose($pipes[1]); |
| 322 | fclose($pipes[2]); |
| 323 | |
| 324 | $ret = proc_close($process); |
| 325 | |
| 326 | if ($ret != 0 && $ret != 12) { |
| 327 | if ($ret < 128) { |
| 328 | $updraftplus->log("Binary zip: error (code: $ret - look it up in the Diagnostics section of the zip manual at http://www.info-zip.org/mans/zip.html for interpretation... and also check that your hosting account quota is not full)"); |
| 329 | } else { |
| 330 | $updraftplus->log("Binary zip: error (code: $ret - a code above 127 normally means that the zip process was deliberately killed ... and also check that your hosting account quota is not full)"); |
| 331 | } |
| 332 | if (!empty($w) && !$updraftplus_backup->debug) $updraftplus->log("Last output from zip: ".trim($w), 'debug'); |
| 333 | return false; |
| 334 | } |
| 335 | |
| 336 | unset($this->addfiles[$rdirname]); |
| 337 | } |
| 338 | |
| 339 | return true; |
| 340 | } |
| 341 | |
| 342 | } |
| 343 |