DrupalUtils.php in Backup and Migrate 5.0.x

Namespace

Drupal\backup_migrate\Drupal\Filter

File

src/Drupal/Filter/DrupalUtils.php

<?php

namespace Drupal\backup_migrate\Drupal\Filter;

use Drupal\backup_migrate\Core\File\BackupFileReadableInterface;
use Drupal\backup_migrate\Core\Plugin\PluginBase;
use Drupal\backup_migrate\Core\Config\Config;

/**
 *
 *
 * @package Drupal\backup_migrate\Drupal\Filter
 */
class DrupalUtils extends PluginBase {

  /**
   * Whether the site was put in maintenance mode before the operation.
   *
   * @var bool
   */
  protected $maintenanceMode;

  /**
   * {@inheritdoc}
   */
  public function configSchema(array $params = []) {
    $schema = [];

    // Backup configuration.
    if ($params['operation'] == 'backup' || $params['operation'] == 'restore') {
      $schema['groups']['advanced'] = [
        'title' => 'Advanced Settings',
      ];
      $schema['fields']['site_offline'] = [
        'group' => 'advanced',
        'type' => 'boolean',
        'title' => $this
          ->t('Take site offline'),
        'description' => $this
          ->t('Take the site offline during backup and show a maintenance message. Site will be taken back online once the backup is complete.'),
      ];
    }
    return $schema;
  }

  /**
   * Get the default values for the plugin.
   *
   * @return \Drupal\backup_migrate\Core\Config\Config
   */
  public function configDefaults() {
    return new Config([
      'disable_query_log' => TRUE,
      'site_offline' => FALSE,
    ]);
  }

  /**
   * Run before the backup/restore begins.
   */
  public function setUp() {
    $this
      ->takeSiteOffline();
  }

  /**
   * Run after the operation is complete.
   */
  public function tearDown() {
    $this
      ->takeSiteOnline();
  }

  /**
   * Take the site offline if we need to.
   */
  protected function takeSiteOffline() {

    // Take the site offline.
    if ($this
      ->confGet('site_offline') && !\Drupal::state()
      ->get('system.maintenance_mode')) {
      \Drupal::state()
        ->set('system.maintenance_mode', TRUE);
      $this->maintenanceMode = TRUE;
    }
  }

  /**
   * Take the site online if it was taken offline for this operation.
   */
  protected function takeSiteOnline() {

    // Take the site online again.
    if ($this->maintenanceMode) {
      \Drupal::state()
        ->set('system.maintenance_mode', FALSE);
    }
  }

  /**
   * Perform actions before restoring the backup.
   *
   * This used to perform a file size check but it occurred *after* the file
   * was uploaded and uncompressed, which was a complete waste of time.
   *
   * @todo Remove this.
   *
   * @param \Drupal\backup_migrate\Core\File\BackupFileReadableInterface $file
   *
   * @return \Drupal\backup_migrate\Core\File\BackupFileReadableInterface
   */
  public function beforeRestore(BackupFileReadableInterface $file) {
    return $file;
  }

}

Classes

Name	Description
DrupalUtils	@package Drupal\backup_migrate\Drupal\Filter