123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261 |
- <?php
- /**
- * @package Grav\Common\Backup
- *
- * @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
- * @license MIT License; see LICENSE file for details.
- */
- namespace Grav\Common\Backup;
- use Grav\Common\Filesystem\Archiver;
- use Grav\Common\Filesystem\Folder;
- use Grav\Common\Inflector;
- use Grav\Common\Scheduler\Job;
- use Grav\Common\Scheduler\Scheduler;
- use Grav\Common\Utils;
- use Grav\Common\Grav;
- use RocketTheme\Toolbox\Event\Event;
- use RocketTheme\Toolbox\Event\EventDispatcher;
- use RocketTheme\Toolbox\File\JsonFile;
- use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
- class Backups
- {
- protected const BACKUP_FILENAME_REGEXZ = "#(.*)--(\d*).zip#";
- protected const BACKUP_DATE_FORMAT = 'YmdHis';
- protected static $backup_dir;
- protected static $backups = null;
- public function init()
- {
- /** @var EventDispatcher $dispatcher */
- $dispatcher = Grav::instance()['events'];
- $dispatcher->addListener('onSchedulerInitialized', [$this, 'onSchedulerInitialized']);
- Grav::instance()->fireEvent('onBackupsInitialized', new Event(['backups' => $this]));
- }
- public function setup()
- {
- if (null === static::$backup_dir) {
- static::$backup_dir = Grav::instance()['locator']->findResource('backup://', true, true);
- Folder::create(static::$backup_dir);
- }
- }
- public function onSchedulerInitialized(Event $event)
- {
- /** @var Scheduler $scheduler */
- $scheduler = $event['scheduler'];
- /** @var Inflector $inflector */
- $inflector = Grav::instance()['inflector'];
- foreach (static::getBackupProfiles() as $id => $profile) {
- $at = $profile['schedule_at'];
- $name = $inflector::hyphenize($profile['name']);
- $logs = 'logs/backup-' . $name . '.out';
- /** @var Job $job */
- $job = $scheduler->addFunction('Grav\Common\Backup\Backups::backup', [$id], $name );
- $job->at($at);
- $job->output($logs);
- $job->backlink('/tools/backups');
- }
- }
- public function getBackupDownloadUrl($backup, $base_url)
- {
- $param_sep = $param_sep = Grav::instance()['config']->get('system.param_sep', ':');
- $download = urlencode(base64_encode(basename($backup)));
- $url = rtrim(Grav::instance()['uri']->rootUrl(true), '/') . '/' . trim($base_url,
- '/') . '/task' . $param_sep . 'backup/download' . $param_sep . $download . '/admin-nonce' . $param_sep . Utils::getNonce('admin-form');
- return $url;
- }
- public static function getBackupProfiles()
- {
- return Grav::instance()['config']->get('backups.profiles');
- }
- public static function getPurgeConfig()
- {
- return Grav::instance()['config']->get('backups.purge');
- }
- public function getBackupNames()
- {
- return array_column(static::getBackupProfiles(), 'name');
- }
- public static function getTotalBackupsSize()
- {
- $backups = static::getAvailableBackups();
- $size = array_sum(array_column($backups, 'size'));
- return $size ?? 0;
- }
- public static function getAvailableBackups($force = false)
- {
- if ($force || null === static::$backups) {
- static::$backups = [];
- $backups_itr = new \GlobIterator(static::$backup_dir . '/*.zip', \FilesystemIterator::KEY_AS_FILENAME);
- $inflector = Grav::instance()['inflector'];
- $long_date_format = DATE_RFC2822;
- /**
- * @var string $name
- * @var \SplFileInfo $file
- */
- foreach ($backups_itr as $name => $file) {
- if (preg_match(static::BACKUP_FILENAME_REGEXZ, $name, $matches)) {
- $date = \DateTime::createFromFormat(static::BACKUP_DATE_FORMAT, $matches[2]);
- $timestamp = $date->getTimestamp();
- $backup = new \stdClass();
- $backup->title = $inflector->titleize($matches[1]);
- $backup->time = $date;
- $backup->date = $date->format($long_date_format);
- $backup->filename = $name;
- $backup->path = $file->getPathname();
- $backup->size = $file->getSize();
- static::$backups[$timestamp] = $backup;
- }
- }
- // Reverse Key Sort to get in reverse date order
- krsort(static::$backups);
- }
- return static::$backups;
- }
- /**
- * Backup
- *
- * @param int $id
- * @param callable|null $status
- *
- * @return null|string
- */
- public static function backup($id = 0, callable $status = null)
- {
- $profiles = static::getBackupProfiles();
- /** @var UniformResourceLocator $locator */
- $locator = Grav::instance()['locator'];
- if (isset($profiles[$id])) {
- $backup = (object) $profiles[$id];
- } else {
- throw new \RuntimeException('No backups defined...');
- }
- $name = Grav::instance()['inflector']->underscorize($backup->name);
- $date = date(static::BACKUP_DATE_FORMAT, time());
- $filename = trim($name, '_') . '--' . $date . '.zip';
- $destination = static::$backup_dir . DS . $filename;
- $max_execution_time = ini_set('max_execution_time', 600);
- $backup_root = $backup->root;
- if ($locator->isStream($backup_root)) {
- $backup_root = $locator->findResource($backup_root);
- } else {
- $backup_root = rtrim(GRAV_ROOT . $backup_root, '/');
- }
- if (!file_exists($backup_root)) {
- throw new \RuntimeException("Backup location: {$backup_root} does not exist...");
- }
- $options = [
- 'exclude_files' => static::convertExclude($backup->exclude_files ?? ''),
- 'exclude_paths' => static::convertExclude($backup->exclude_paths ?? ''),
- ];
- /** @var Archiver $archiver */
- $archiver = Archiver::create('zip');
- $archiver->setArchive($destination)->setOptions($options)->compress($backup_root, $status)->addEmptyFolders($options['exclude_paths'], $status);
- $status && $status([
- 'type' => 'message',
- 'message' => 'Done...',
- ]);
- $status && $status([
- 'type' => 'progress',
- 'complete' => true
- ]);
- if ($max_execution_time !== false) {
- ini_set('max_execution_time', $max_execution_time);
- }
- // Log the backup
- Grav::instance()['log']->notice('Backup Created: ' . $destination);
- // Fire Finished event
- Grav::instance()->fireEvent('onBackupFinished', new Event(['backup' => $destination]));
- // Purge anything required
- static::purge();
- // Log
- $log = JsonFile::instance(Grav::instance()['locator']->findResource("log://backup.log", true, true));
- $log->content([
- 'time' => time(),
- 'location' => $destination
- ]);
- $log->save();
- return $destination;
- }
- public static function purge()
- {
- $purge_config = static::getPurgeConfig();
- $trigger = $purge_config['trigger'];
- $backups = static::getAvailableBackups(true);
- switch ($trigger)
- {
- case 'number':
- $backups_count = count($backups);
- if ($backups_count > $purge_config['max_backups_count']) {
- $last = end($backups);
- unlink ($last->path);
- static::purge();
- }
- break;
- case 'time':
- $last = end($backups);
- $now = new \DateTime();
- $interval = $now->diff($last->time);
- if ($interval->days > $purge_config['max_backups_time']) {
- unlink($last->path);
- static::purge();
- }
- break;
- default:
- $used_space = static::getTotalBackupsSize();
- $max_space = $purge_config['max_backups_space'] * 1024 * 1024 * 1024;
- if ($used_space > $max_space) {
- $last = end($backups);
- unlink($last->path);
- static::purge();
- }
- break;
- }
- }
- protected static function convertExclude($exclude)
- {
- $lines = preg_split("/[\s,]+/", $exclude);
- return array_map('trim', $lines, array_fill(0, \count($lines), '/'));
- }
- }
|