Newer
Older
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
<?php
/*
Copyright (c) 2007, Till Brehm, projektfarm Gmbh
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of ISPConfig nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* Class backup
* All code that makes actual backup and restore of web files and database is here.
* @author Ramil Valitov <ramilvalitov@gmail.com>
* @see backup::run_backup() to run a single backup
* @see backup::run_all_backups() to run all backups
* @see backup::restoreBackupDatabase() to restore a database
* @see backup::restoreBackupWebFiles() to restore web files
*/
class backup
{
/**
* Returns file extension for specified backup format
* @param string $format backup format
* @return string|null
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function getBackupDbExtension($format)
{
$prefix = '.sql';
switch ($format) {
case 'gzip':
return $prefix . '.gz';
case 'bzip2':
return $prefix . '.bz2';
case 'xz':
return $prefix . '.xz';
case 'zip':
case 'zip_bzip2':
return '.zip';
case 'rar':
return '.rar';
}
if (strpos($format, "7z_") === 0) {
return $prefix . '.7z';
}
return null;
}
/**
* Returns file extension for specified backup format
* @param string $format backup format
* @return string|null
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function getBackupWebExtension($format)
{
switch ($format) {
case 'tar_gzip':
return '.tar.gz';
case 'tar_bzip2':
return '.tar.bz2';
case 'tar_xz':
return '.tar.xz';
case 'zip':
case 'zip_bzip2':
return '.zip';
case 'rar':
return '.rar';
}
if (strpos($format, "tar_7z_") === 0) {
return '.tar.7z';
}
return null;
}
/**
* Sets file ownership to $web_user for all files and folders except log, ssl and web/stats
* @param string $web_document_root
* @param string $web_user
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function restoreFileOwnership($web_document_root, $web_user)
{
global $app;
$app->log('Restoring permissions for ' . $web_document_root, LOGLEVEL_DEBUG);
$app->system->exec_safe('cd ? && find . -not -path "./web/stats/*" -and -not -path "./log" -and -not -path "./log/*" -and -not -path "./ssl" -and -not -path "./ssl/*" -and -not -path "." -exec chown ?:? {} \;', $web_document_root, $web_user, $web_user);
}
/**
* Returns default backup format used in previous versions of ISPConfig
* @param string $backup_mode can be 'userzip' or 'rootgz'
* @param string $backup_type can be 'web' or 'mysql'
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
* @return string
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function getDefaultBackupFormat($backup_mode, $backup_type)
{
//We have a backup from old version of ISPConfig
switch ($backup_type) {
case 'mysql':
return 'gzip';
case 'web':
return ($backup_mode == 'userzip') ? 'zip' : 'tar_gzip';
}
return "";
}
/**
* Restores a database backup.
* The backup directory must be mounted before calling this method.
* @param string $backup_format
* @param string $password password for encrypted backup or empty string if archive is not encrypted
* @param string $backup_dir
* @param string $filename
* @param string $backup_mode
* @param string $backup_type
* @return bool true if succeeded
* @see backup_plugin::mount_backup_dir()
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
public static function restoreBackupDatabase($backup_format, $password, $backup_dir, $filename, $backup_mode, $backup_type)
{
global $app;
//* Load sql dump into db
include 'lib/mysql_clientdb.conf';
if (empty($backup_format)) {
$backup_format = self::getDefaultBackupFormat($backup_mode, $backup_type);
}
$extension = self::getBackupDbExtension($backup_format);
if (!empty($extension)) {
//Replace dots for preg_match search
$extension = str_replace('.', '\.', $extension);
}
$success = false;
$full_filename = $backup_dir . '/' . $filename;
$app->log('Restoring MySQL backup ' . $full_filename . ', backup format "' . $backup_format . '", backup mode "' . $backup_mode . '"', LOGLEVEL_DEBUG);
if (file_exists($full_filename) && !empty($extension)) {
preg_match('@^(manual-)?db_(?P<db>.+)_\d{4}-\d{2}-\d{2}_\d{2}-\d{2}' . $extension . '$@', $filename, $matches);
if (!isset($matches['db']) || empty($matches['db'])) {
$app->log('Failed to detect database name during restore of ' . $full_filename, LOGLEVEL_ERROR);
return false;
}
$db_name = $matches['db'];
switch ($backup_format) {
case "gzip":
$command = "gunzip --stdout ? | mysql -h ? -u ? -p? ?";
break;
case "zip":
case "zip_bzip2":
$command = "unzip -qq -p -P " . escapeshellarg($password) . " ? | mysql -h ? -u ? -p? ?";
break;
case "bzip2":
$command = "bunzip2 -q -c ? | mysql -h ? -u ? -p? ?";
break;
case "xz":
$command = "unxz -q -q -c ? | mysql -h ? -u ? -p? ?";
break;
case "rar":
//First, test that the archive is correct and we have a correct password
$options = self::getUnrarOptions($password);
$app->system->exec_safe("rar t " . $options . " ?", $full_filename);
if ($app->system->last_exec_retcode() == 0) {
$app->log('Archive test passed for ' . $full_filename, LOGLEVEL_DEBUG);
$command = "rar x " . $options. " ? | mysql -h ? -u ? -p? ?";
}
break;
}
if (strpos($backup_format, "7z_") === 0) {
$options = self::get7zDecompressOptions($password);
//First, test that the archive is correct and we have a correct password
$app->system->exec_safe("7z t " . $options . " ?", $full_filename);
if ($app->system->last_exec_retcode() == 0) {
$app->log('Archive test passed for ' . $full_filename, LOGLEVEL_DEBUG);
$command = "7z x " . $options . " -so ? | mysql -h ? -u ? -p? ?";
} else
$command = null;
}
if (!empty($command)) {
/** @var string $clientdb_host */
/** @var string $clientdb_user */
/** @var string $clientdb_password */
$app->system->exec_safe($command, $full_filename, $clientdb_host, $clientdb_user, $clientdb_password, $db_name);
$retval = $app->system->last_exec_retcode();
if ($retval == 0) {
$app->log('Restored MySQL backup ' . $full_filename, LOGLEVEL_DEBUG);
$success = true;
} else {
$app->log('Failed to restore web backup ' . $full_filename . ', exit code ' . $retval, LOGLEVEL_ERROR);
}
} else {
$app->log('Archive test failed for ' . $full_filename, LOGLEVEL_DEBUG);
}
} else {
$app->log('Failed to process MySQL backup ' . $full_filename, LOGLEVEL_ERROR);
}
unset($clientdb_host);
unset($clientdb_user);
unset($clientdb_password);
return $success;
}
/**
* Restores web files backup.
* The backup directory must be mounted before calling this method.
* @param string $backup_format
* @param string $password password for encrypted backup or empty string if archive is not encrypted
* @param string $backup_dir
* @param string $filename
* @param string $backup_mode
* @param string $backup_type
* @param string $web_root
* @param string $web_user
* @param string $web_group
* @return bool true if succeed
* @see backup_plugin::mount_backup_dir()
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
public static function restoreBackupWebFiles($backup_format, $password, $backup_dir, $filename, $backup_mode, $backup_type, $web_root, $web_user, $web_group)
{
global $app;
if (empty($backup_format)) {
$backup_format = self::getDefaultBackupFormat($backup_mode, $backup_type);
}
$full_filename = $backup_dir . '/' . $filename;
$result = false;
$app->log('Restoring web backup ' . $full_filename . ', backup format "' . $backup_format . '", backup mode "' . $backup_mode . '"', LOGLEVEL_DEBUG);
if (!empty($backup_format)) {
$app->system->web_folder_protection($web_root, false);
if ($backup_mode == 'userzip' || $backup_mode == 'rootgz') {
$user_mode = $backup_mode == 'userzip';
$filename = $user_mode ? ($web_root . '/backup/' . $filename) : $full_filename;
if (file_exists($full_filename) && $web_root != '' && $web_root != '/' && !stristr($full_filename, '..') && !stristr($full_filename, 'etc')) {
if ($user_mode) {
if (file_exists($filename)) rename($filename, $filename . '.bak');
copy($full_filename, $filename);
chgrp($filename, $web_group);
}
$user_prefix_cmd = $user_mode ? 'sudo -u ' . escapeshellarg($web_user) : '';
$success = false;
$retval = 0;
switch ($backup_format) {
case "tar_gzip":
case "tar_bzip2":
case "tar_xz":
$command = $user_prefix_cmd . ' tar xf ? --directory ?';
$app->system->exec_safe($command, $filename, $web_root);
$retval = $app->system->last_exec_retcode();
$success = ($retval == 0 || $retval == 2);
break;
case "zip":
case "zip_bzip2":
$command = $user_prefix_cmd . ' unzip -qq -P ' . escapeshellarg($password) . ' -o ? -d ? 2> /dev/null';
$app->system->exec_safe($command, $filename, $web_root);
$retval = $app->system->last_exec_retcode();
/*
* Exit code 50 can happen when zip fails to overwrite files that do not
* belong to selected user, so we can consider this situation as success
* with warnings.
*/
$success = ($retval == 0 || $retval == 50);
if ($success) {
self::restoreFileOwnership($web_root, $web_user);
}
break;
case 'rar':
$options = self::getUnRarOptions($password);
//First, test that the archive is correct and we have a correct password
$command = $user_prefix_cmd . " rar t " . $options . " ? ?";
//Rar requires trailing slash
$app->system->exec_safe($command, $filename, $web_root . '/');
$success = ($app->system->last_exec_retcode() == 0);
if ($success) {
//All good, now we can extract
$app->log('Archive test passed for ' . $full_filename, LOGLEVEL_DEBUG);
$command = $user_prefix_cmd . " rar x " . $options . " ? ?";
//Rar requires trailing slash
$app->system->exec_safe($command, $filename, $web_root . '/');
$retval = $app->system->last_exec_retcode();
//Exit code 9 can happen when we have file permission errors, in this case some
//files will be skipped during extraction.
$success = ($retval == 0 || $retval == 1 || $retval == 9);
} else {
$app->log('Archive test failed for ' . $full_filename, LOGLEVEL_DEBUG);
}
break;
}
if (strpos($backup_format, "tar_7z_") === 0) {
$options = self::get7zDecompressOptions($password);
//First, test that the archive is correct and we have a correct password
$command = $user_prefix_cmd . " 7z t " . $options . " ?";
$app->system->exec_safe($command, $filename);
$success = ($app->system->last_exec_retcode() == 0);
if ($success) {
//All good, now we can extract
$app->log('Archive test passed for ' . $full_filename, LOGLEVEL_DEBUG);
$command = $user_prefix_cmd . " 7z x " . $options . " -so ? | tar xf - --directory ?";
$app->system->exec_safe($command, $filename, $web_root);
$retval = $app->system->last_exec_retcode();
$success = ($retval == 0 || $retval == 2);
} else {
$app->log('Archive test failed for ' . $full_filename, LOGLEVEL_DEBUG);
}
}
if ($user_mode) {
unlink($filename);
if (file_exists($filename . '.bak')) rename($filename . '.bak', $filename);
}
if ($success) {
$app->log('Restored web backup ' . $full_filename, LOGLEVEL_DEBUG);
$result = true;
} else {
$app->log('Failed to restore web backup ' . $full_filename . ', exit code ' . $retval, LOGLEVEL_ERROR);
}
}
} else {
$app->log('Failed to restore web backup ' . $full_filename . ', backup mode "' . $backup_mode . '" not recognized.', LOGLEVEL_DEBUG);
}
$app->system->web_folder_protection($web_root, true);
} else {
$app->log('Failed to restore web backup ' . $full_filename . ', backup format not recognized.', LOGLEVEL_DEBUG);
}
return $result;
}
/**
* Returns a compression method, for example returns bzip2 for tar_7z_bzip2
* @param string $format
* @return false|string
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function getCompressionMethod($format)
{
$pos = strrpos($format, "_");
return substr($format, $pos + 1);
}
/**
* Returns default options for compressing rar
* @param string $backup_tmp temporary directory that rar can use
* @param string|null $password backup password if any
* @return string options for rar
*/
protected static function getRarOptions($backup_tmp, $password)
{
/**
* All rar options are listed here:
* https://documentation.help/WinRAR/HELPCommands.htm
* https://documentation.help/WinRAR/HELPSwitches.htm
* Some compression profiles and different versions of rar may use different default values, so it's better
* to specify everything explicitly.
* The difference between compression methods is not big in terms of file size, but is huge in terms of
* CPU and RAM consumption. Therefore it makes sense only to use fastest the compression method.
*/
$options = array(
/**
* Start with fastest compression method (least compressive)
*/
'-m1',
/**
* Disable solid archiving.
* Never use solid archive: it's very slow and requires to read and sort all files first
*/
'-S-',
/**
* Ignore default profile and environment variables
* https://documentation.help/WinRAR/HELPSwCFGm.htm
*/
'-CFG-',
/**
* Disable error messages output
* https://documentation.help/WinRAR/HELPSwINUL.htm
*/
'-inul',
/**
* Lock archive: this switch prevents any further archive modifications by rar
* https://documentation.help/WinRAR/HELPSwK.htm
*/
'-k',
/**
* Create archive in RAR 5.0 format
* https://documentation.help/WinRAR/HELPSwMA.htm
*/
'-ma',
/**
* Set dictionary size to 16Mb.
* When archiving, rar needs about 6x memory of specified dictionary size.
* https://documentation.help/WinRAR/HELPSwMD.htm
*/
'-md16m',
/**
* Use only one CPU thread
* https://documentation.help/WinRAR/HELPSwMT.htm
*/
'-mt1',
/**
* Use this switch when archiving to save file security information and when extracting to restore it.
* It stores file owner, group, file permissions and audit information.
* https://documentation.help/WinRAR/HELPSwOW.htm
*/
'-ow',
/**
* Overwrite all
* https://documentation.help/WinRAR/HELPSwO.htm
*/
'-o+',
/**
* Exclude base folder from names.
* Required for correct directory structure inside archive
* https://documentation.help/WinRAR/HELPSwEP1.htm
*/
'-ep1',
/**
* Never add quick open information.
* This information is useful only if you want to read the contents of archive (list of files).
* Besides it can increase the archive size. As we need the archive only for future complete extraction,
* there's no need to use this information at all.
* https://documentation.help/WinRAR/HELPSwQO.htm
*/
'-qo-',
/**
* Set lowest task priority (1) and 10ms sleep time between read/write operations.
* https://documentation.help/WinRAR/HELPSwRI.htm
*/
'-ri1:10',
/**
* Temporary folder
* https://documentation.help/WinRAR/HELPSwW.htm
*/
'-w' . escapeshellarg($backup_tmp),
/**
* Assume Yes on all queries
* https://documentation.help/WinRAR/HELPSwY.htm
*/
'-y',
);
$options = implode(" ", $options);
if (!empty($password)) {
/**
* Encrypt both file data and headers
* https://documentation.help/WinRAR/HELPSwHP.htm
*/
$options .= ' -HP' . escapeshellarg($password);
}
return $options;
}
/**
* Returns default options for decompressing rar
* @param string|null $password backup password if any
* @return string options for rar
*/
protected static function getUnRarOptions($password)
{
/**
* All rar options are listed here:
* https://documentation.help/WinRAR/HELPCommands.htm
* https://documentation.help/WinRAR/HELPSwitches.htm
* Some compression profiles and different versions of rar may use different default values, so it's better
* to specify everything explicitly.
* The difference between compression methods is not big in terms of file size, but is huge in terms of
* CPU and RAM consumption. Therefore it makes sense only to use fastest the compression method.
*/
$options = array(
/**
* Ignore default profile and environment variables
* https://documentation.help/WinRAR/HELPSwCFGm.htm
*/
'-CFG-',
/**
* Disable error messages output
* https://documentation.help/WinRAR/HELPSwINUL.htm
*/
'-inul',
/**
* Use only one CPU thread
* https://documentation.help/WinRAR/HELPSwMT.htm
*/
'-mt1',
/**
* Use this switch when archiving to save file security information and when extracting to restore it.
* It stores file owner, group, file permissions and audit information.
* https://documentation.help/WinRAR/HELPSwOW.htm
*/
'-ow',
/**
* Overwrite all
* https://documentation.help/WinRAR/HELPSwO.htm
*/
'-o+',
/**
* Set lowest task priority (1) and 10ms sleep time between read/write operations.
* https://documentation.help/WinRAR/HELPSwRI.htm
*/
'-ri1:10',
/**
* Assume Yes on all queries
* https://documentation.help/WinRAR/HELPSwY.htm
*/
'-y',
);
$options = implode(" ", $options);
if (!empty($password)) {
$options .= ' -P' . escapeshellarg($password);
}
return $options;
}
/**
* Returns compression options for 7z
* @param string $format compression format used in 7z
* @param string $password password if any
* @return string
*/
protected static function get7zCompressOptions($format, $password)
{
$method = self::getCompressionMethod($format);
/**
* List of 7z options is here:
* https://linux.die.net/man/1/7z
* https://sevenzip.osdn.jp/chm/cmdline/syntax.htm
* https://sevenzip.osdn.jp/chm/cmdline/switches/
*/
$options = array(
/**
* Use 7z format (container)
*/
'-t7z',
/**
* Compression method (LZMA, LZMA2, etc.)
* https://sevenzip.osdn.jp/chm/cmdline/switches/method.htm
*/
'-m0=' . $method,
/**
* Fastest compression method
*/
'-mx=1',
/**
* Disable solid mode
*/
'-ms=off',
/**
* Disable multithread mode, use less CPU
*/
'-mmt=off',
/**
* Disable multithread mode for filters, use less CPU
*/
'-mmtf=off',
/**
* Disable progress indicator
*/
'-bd',
/**
* Assume yes on all queries
* https://sevenzip.osdn.jp/chm/cmdline/switches/yes.htm
*/
'-y',
);
$options = implode(" ", $options);
switch (strtoupper($method)) {
case 'LZMA':
case 'LZMA2':
/**
* Dictionary size is 5Mb.
* 7z can use 12 times more RAM
*/
$options .= ' -md=5m';
break;
case 'PPMD':
/**
* Dictionary size is 64Mb.
* It's the maximum RAM that 7z is allowed to use.
*/
$options .= ' -mmem=64m';
break;
}
if (!empty($password)) {
$options .= ' -mhe=on -p' . escapeshellarg($password);
}
return $options;
}
/**
* Returns decompression options for 7z
* @param string $password password if any
* @return string
*/
protected static function get7zDecompressOptions($password)
{
/**
* List of 7z options is here:
* https://linux.die.net/man/1/7z
* https://sevenzip.osdn.jp/chm/cmdline/syntax.htm
* https://sevenzip.osdn.jp/chm/cmdline/switches/
*/
$options = array(
/**
* Disable multithread mode, use less CPU
*/
'-mmt=off',
/**
* Disable progress indicator
*/
'-bd',
/**
* Assume yes on all queries
* https://sevenzip.osdn.jp/chm/cmdline/switches/yes.htm
*/
'-y',
);
$options = implode(" ", $options);
if (!empty($password)) {
$options .= ' -p' . escapeshellarg($password);
}
return $options;
}
/**
* Clears expired backups.
* The backup directory must be mounted before calling this method.
* @param integer $server_id
* @param integer $web_id id of the website
* @param integer $max_backup_copies number of backup copies to keep, all files beyond the limit will be erased
* @param string $backup_dir directory to scan
* @return bool
* @see backup_plugin::backups_garbage_collection() call this method first
* @see backup_plugin::mount_backup_dir()
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function clearBackups($server_id, $web_id, $max_backup_copies, $backup_dir, $prefix_list=null)
$files = self::get_files($backup_dir, $prefix_list);
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
usort($files, function ($a, $b) use ($backup_dir) {
$time_a = filemtime($backup_dir . '/' . $a);
$time_b = filemtime($backup_dir . '/' . $b);
return ($time_a > $time_b) ? -1 : 1;
});
$db_list = array($app->db);
if ($app->db->dbHost != $app->dbmaster->dbHost)
array_push($db_list, $app->dbmaster);
//Delete old files that are beyond the limit
for ($n = $max_backup_copies; $n < sizeof($files); $n++) {
$filename = $files[$n];
$full_filename = $backup_dir . '/' . $filename;
$app->log('Backup file ' . $full_filename . ' is beyond the limit of ' . $max_backup_copies . " copies and will be deleted from disk and database", LOGLEVEL_DEBUG);
$sql = "DELETE FROM web_backup WHERE server_id = ? AND parent_domain_id = ? AND filename = ?";
foreach ($db_list as $db) {
$db->query($sql, $server_id, $web_id, $filename);
}
@unlink($full_filename);
}
return true;
}
/**
* Garbage collection: deletes records from database about files that do not exist and deletes untracked files.
* The backup directory must be mounted before calling this method.
* @param int $server_id
* @param string|null $backup_type if defined then process only backups of this type
* @param string|null $domain_id if defined then process only backups that belong to this domain
* @author Ramil Valitov <ramilvalitov@gmail.com>
* @see backup_plugin::mount_backup_dir()
*/
protected static function backups_garbage_collection($server_id, $backup_type = null, $domain_id = null)
{
global $app;
//First check that all records in database have related files and delete records without files on disk
$args = array();
$args_domains = array();
$server_config = $app->getconf->get_server_config($server_id, 'server');
$backup_dir = trim($server_config['backup_dir']);
$sql = "SELECT * FROM web_backup WHERE server_id = ?";
$sql_domains = "SELECT domain_id,document_root,system_user,system_group,backup_interval FROM web_domain WHERE server_id = ? AND (type = 'vhost' OR type = 'vhostsubdomain' OR type = 'vhostalias')";
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
array_push($args, $server_id);
array_push($args_domains, $server_id);
if (!empty($backup_type)) {
$sql .= " AND backup_type = ?";
array_push($args, $backup_type);
}
if (!empty($domain_id)) {
$sql .= " AND parent_domain_id = ?";
$sql_domains .= " AND domain_id = ?";
array_push($args, $domain_id);
array_push($args_domains, $domain_id);
}
array_unshift($args, $sql);
array_unshift($args_domains, $sql_domains);
$db_list = array($app->db);
if ($app->db->dbHost != $app->dbmaster->dbHost)
array_push($db_list, $app->dbmaster);
foreach ($db_list as $db) {
$backups = call_user_func_array(array($db, "queryAllRecords"), $args);
foreach ($backups as $backup) {
$backup_file = $backup_dir . '/web' . $backup['parent_domain_id'] . '/' . $backup['filename'];
if (!is_file($backup_file)) {
$app->log('Backup file ' . $backup_file . ' does not exist on disk, deleting this entry from database', LOGLEVEL_DEBUG);
$sql = "DELETE FROM web_backup WHERE backup_id = ?";
$db->query($sql, $backup['backup_id']);
}
}
}
foreach ($db_list as $db) {
$domains = call_user_func_array(array($db, "queryAllRecords"), $args_domains);
foreach ($domains as $rec) {
$domain_id = $rec['domain_id'];
$domain_backup_dir = $backup_dir . '/web' . $domain_id;
$files = self::get_files($domain_backup_dir);
//Delete files that are in backup directory, but do not exist in database
if (!empty($files)) {
$sql = "SELECT backup_id,filename FROM web_backup WHERE server_id = ? AND parent_domain_id = ?";
$backups = $db->queryAllRecords($sql, $server_id, $domain_id);
foreach ($backups as $backup) {
if (!in_array($backup['filename'],$files)) {
$backup_file = $backup_dir . '/web' . $domain_id . '/' . $backup['filename'];
$app->log('Backup file ' . $backup_file . ' is not contained in database, deleting this file from disk', LOGLEVEL_DEBUG);
@unlink($backup_file);
}
}
}
//Remove backupdir symlink and create as directory instead
$web_path = $rec['document_root'];
$app->system->web_folder_protection($web_path, false);
$backup_download_dir = $web_path . '/backup';
if (is_link($backup_download_dir)) {
unlink($backup_download_dir);
}
if (!is_dir($backup_download_dir)) {
mkdir($backup_download_dir);
chown($backup_download_dir, $rec['system_user']);
chgrp($backup_download_dir, $rec['system_group']);
}
$app->system->web_folder_protection($web_path, true);
// delete old files from backup download dir (/var/www/example.com/backup)
if (is_dir($backup_download_dir)) {
$dir_handle = dir($backup_download_dir);
$now = time();
while (false !== ($entry = $dir_handle->read())) {
$full_filename = $backup_download_dir . '/' . $entry;
if ($entry != '.' && $entry != '..' && is_file($full_filename)) {
// delete files older than 3 days
if ($now - filemtime($full_filename) >= 60 * 60 * 24 * 3) {
$app->log('Backup file ' . $full_filename . ' is too old, deleting this file from disk', LOGLEVEL_DEBUG);
@unlink($full_filename);
}
}
}
$dir_handle->close();
}
}
}
}
/**
* Gets list of files in directory
* @param string $directory
* @param string[]|null $prefix_list filter files that have one of the prefixes. Use null for default filtering.
* @param string[]|null $endings_list filter files that have one of the endings. Use null for default filtering.
* @return string[]
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function get_files($directory, $prefix_list = null, $endings_list = null)
{
$default_prefix_list = array(
'web',
'manual-web',
'db_',
'manual-db_',
);
$default_endings_list = array(
'.gz',
'.7z',
'.rar',
'.zip',
'.xz',
'.bz2',
);
if (is_null($prefix_list))
$prefix_list = $default_prefix_list;
if (is_null($endings_list))
$endings_list = $default_endings_list;
if (!is_dir($directory)) {
return array();
}
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
$dir_handle = dir($directory);
$files = array();
while (false !== ($entry = $dir_handle->read())) {
$full_filename = $directory . '/' . $entry;
if ($entry != '.' && $entry != '..' && is_file($full_filename)) {
if (!empty($prefix_list)) {
$add = false;
foreach ($prefix_list as $prefix) {
if (substr($entry, 0, strlen($prefix)) == $prefix) {
$add = true;
break;
}
}
} else
$add = true;
if ($add && !empty($endings_list)) {
$add = false;
foreach ($endings_list as $ending) {
if (substr($entry, -strlen($ending)) == $ending) {
$add = true;
break;
}
}
}
if ($add)
array_push($files, $entry);
}
}
$dir_handle->close();
return $files;
}
/**
* Generates excludes list for compressors
* @param string[] $backup_excludes
* @param string $arg
* @return string
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function generateExcludeList($backup_excludes, $arg)
{
$excludes = implode(" " . $arg, $backup_excludes);
if (!empty($excludes)) {
$excludes = $arg . $excludes;
}
return $excludes;
}
/**
* Runs a web compression routine
* @param string $format
* @param string[] $backup_excludes
* @param string $backup_mode
* @param string $web_path
* @param string $web_backup_dir
* @param string $web_backup_file
* @param string $web_user
* @param string $web_group
* @param string $http_server_user
* @param string $backup_tmp
* @param string|null $password
* @return bool true if success
* @author Ramil Valitov <ramilvalitov@gmail.com>
*/
protected static function runWebCompression($format, $backup_excludes, $backup_mode, $web_path, $web_backup_dir, $web_backup_file, $web_user, $web_group, $http_server_user, $backup_tmp, $password)
{
global $app;
$find_user_files = 'cd ? && sudo -u ? find . -group ? -or -user ? -print 2> /dev/null';
$excludes = self::generateExcludeList($backup_excludes, '--exclude=');
$tar_dir = 'tar pcf - ' . $excludes . ' --directory ? .';
$tar_input = 'tar pcf --null -T -';
$app->log('Performing web files backup of ' . $web_path . ' in format ' . $format . ', mode ' . $backup_mode, LOGLEVEL_DEBUG);
switch ($format) {
case 'tar_gzip':
if ($app->system->is_installed('pigz')) {
//use pigz
if ($backup_mode == 'user_zip') {
$app->system->exec_safe($find_user_files . ' | ' . $tar_input . ' | pigz > ?', $web_path, $web_user, $web_group, $http_server_user, $web_path, $web_backup_dir . '/' . $web_backup_file);
} else {
//Standard casual behaviour of ISPConfig
$app->system->exec_safe($tar_dir . ' | pigz > ?', $web_path, $web_backup_dir . '/' . $web_backup_file);
}
$exit_code = $app->system->last_exec_retcode();
return $exit_code == 0;
} else {
//use gzip
if ($backup_mode == 'user_zip') {
$app->system->exec_safe($find_user_files . ' | tar pczf ? --null -T -', $web_path, $web_user, $web_group, $http_server_user, $web_backup_dir . '/' . $web_backup_file);
} else {
//Standard casual behaviour of ISPConfig
$app->system->exec_safe('tar pczf ? ' . $excludes . ' --directory ? .', $web_backup_dir . '/' . $web_backup_file, $web_path);
}
$exit_code = $app->system->last_exec_retcode();
// tar can return 1 and still create valid backups
return ($exit_code == 0 || $exit_code == 1);
}
case 'zip':
case 'zip_bzip2':
$zip_options = ($format === 'zip_bzip2') ? ' -Z bzip2 ' : '';
if (!empty($password)) {
$zip_options .= ' --password ' . escapeshellarg($password);
}
if ($backup_mode == 'user_zip') {
//Standard casual behaviour of ISPConfig
$app->system->exec_safe($find_user_files . ' | zip ' . $zip_options . ' -b ? ' . $excludes . ' --symlinks ? -@', $web_path, $web_user, $web_group, $http_server_user, $backup_tmp, $web_backup_dir . '/' . $web_backup_file);
} else {
//Use cd to have a correct directory structure inside the archive, extra options to zip hidden (dot) files
$app->system->exec_safe('cd ? && zip ' . $zip_options . ' -b ? ' . $excludes . ' --symlinks -r ? * .* -x "../*"', $web_path, $backup_tmp, $web_backup_dir . '/' . $web_backup_file);
}
$exit_code = $app->system->last_exec_retcode();
// zip can return 12(due to harmless warnings) and still create valid backups
return ($exit_code == 0 || $exit_code == 12);
case 'tar_bzip2':
if ($backup_mode == 'user_zip') {
$app->system->exec_safe($find_user_files . ' | tar pcjf ? --null -T -', $web_path, $web_user, $web_group, $http_server_user, $web_backup_dir . '/' . $web_backup_file);
} else {
$app->system->exec_safe('tar pcjf ? ' . $excludes . ' --directory ? .', $web_backup_dir . '/' . $web_backup_file, $web_path);
}
$exit_code = $app->system->last_exec_retcode();
// tar can return 1 and still create valid backups
return ($exit_code == 0 || $exit_code == 1);
case 'tar_xz':
if ($backup_mode == 'user_zip') {
$app->system->exec_safe($find_user_files . ' | tar pcJf ? --null -T -', $web_path, $web_user, $web_group, $http_server_user, $web_backup_dir . '/' . $web_backup_file);
} else {
$app->system->exec_safe('tar pcJf ? ' . $excludes . ' --directory ? .', $web_backup_dir . '/' . $web_backup_file, $web_path);
}
$exit_code = $app->system->last_exec_retcode();
// tar can return 1 and still create valid backups
return ($exit_code == 0 || $exit_code == 1);
case 'rar':
$options = self::getRarOptions($backup_tmp,$password);
if ($backup_mode != 'user_zip') {
//Recurse subfolders, otherwise we will pass a list of files to compress
$options .= ' -r';