You are here

Home » API reference » Advanced CSS/JS Aggregation 8.3 » OperationsForm.php

class OperationsForm in Advanced CSS/JS Aggregation 8.3

Same name and namespace in other branches
  1. 8.4 src/Form/OperationsForm.php \Drupal\advagg\Form\OperationsForm
  2. 8.2 src/Form/OperationsForm.php \Drupal\advagg\Form\OperationsForm

Configure advagg settings for this site.

Hierarchy

Expanded class hierarchy of OperationsForm

1 file declares its use of OperationsForm
advagg.install in ./advagg.install
Handles Advanced Aggregation installation and upgrade tasks.
1 string reference to 'OperationsForm'
advagg.routing.yml in ./advagg.routing.yml
advagg.routing.yml

File

src/Form/OperationsForm.php, line 21

Namespace

Drupal\advagg\Form
View source 
class OperationsForm extends ConfigFormBase {

  /**
   * The private key service.
   *
   * @var \Drupal\Core\PrivateKey
   */
  protected $privateKey;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Obtaining system time.
   *
   * @var \Drupal\Component\Datetime\Time
   */
  protected $time;

  /**
   * The AdvAgg cache.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * The File System service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs the OperationsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\PrivateKey $private_key
   *   The private key service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The Date formatter service.
   * @param \Drupal\Core\Datetime\Time $time
   *   Obtaining system time.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The AdvAgg cache.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The File System service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, PrivateKey $private_key, DateFormatterInterface $date_formatter, Time $time, CacheBackendInterface $cache, FileSystemInterface $file_system, MessengerInterface $messenger) {
    parent::__construct($config_factory);
    $this->privateKey = $private_key;
    $this->dateFormatter = $date_formatter;
    $this->time = $time;
    $this->cache = $cache;
    $this->fileSystem = $file_system;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('private_key'), $container
      ->get('date.formatter'), $container
      ->get('datetime.time'), $container
      ->get('cache.advagg'), $container
      ->get('file_system'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'advagg_operations';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'advagg.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Explain what can be done on this page.
    $form['tip'] = [
      '#markup' => '<p>' . $this
        ->t('This is a collection of commands to control the cache and to manage testing of this module. In general this page is useful when troubleshooting some aggregation issues. For normal operations, you do not need to do anything on this page below the Smart Cache Flush. There are no configuration options here.') . '</p>',
    ];
    $form['wrapper'] = [
      '#prefix' => "<div id='operations-wrapper'>",
      '#suffix' => "</div>",
    ];

    // Set/Remove Bypass Cookie.
    $form['bypass'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Aggregation Bypass Cookie'),
      '#description' => $this
        ->t('This will set or remove a cookie that disables aggregation for a set period of time.'),
    ];
    $form['bypass']['timespan'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Bypass length'),
      '#options' => [
        21600 => $this
          ->t('6 hours'),
        43200 => $this
          ->t('12 hours'),
        86400 => $this
          ->t('1 day'),
        172800 => $this
          ->t('2 days'),
        604800 => $this
          ->t('1 week'),
        2592000 => $this
          ->t('1 month'),
        31536000 => $this
          ->t('1 year'),
      ],
    ];
    $form['bypass']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Toggle The "aggregation bypass cookie" For This Browser'),
      '#attributes' => [
        'onclick' => 'javascript:return advagg_toggle_cookie()',
      ],
      '#submit' => [
        '::toggleBypassCookie',
      ],
    ];

    // Add in aggregation bypass cookie javascript.
    $form['#attached']['drupalSettings']['advagg'] = [
      'key' => Crypt::hashBase64($this->privateKey
        ->get()),
    ];
    $form['#attached']['library'][] = 'advagg/admin.operations';

    // Tasks run by cron.
    $form['cron'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Cron Maintenance Tasks'),
      'description' => [
        '#markup' => $this
          ->t('The following operation is ran on cron but you can run it manually here.'),
      ],
    ];
    $form['cron']['wrapper'] = [
      '#prefix' => "<div id='cron-wrapper'>",
      '#suffix' => "</div>",
    ];
    $form['cron']['smart_file_flush'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Clear Stale Files'),
      '#description' => $this
        ->t('Scan all files in the css/js optimized directories and remove outdated ones.'),
    ];
    $form['cron']['smart_file_flush']['advagg_flush_stale_files'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Remove All Stale Files'),
      '#submit' => [
        '::clearStaleAggregates',
      ],
      '#ajax' => [
        'callback' => '::cronTasksAjax',
        'wrapper' => 'cron-wrapper',
      ],
    ];

    // Hide drastic measures as they should not be done unless really needed.
    $form['drastic_measures'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Drastic Measures'),
      '#description' => $this
        ->t('The options below should normally never need to be done.'),
    ];
    $form['drastic_measures']['wrapper'] = [
      '#prefix' => "<div id='drastic-measures-wrapper'>",
      '#suffix' => "</div>",
    ];
    $form['drastic_measures']['dumb_cache_flush'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Clear All Caches'),
      '#description' => $this
        ->t('Remove all entries from the advagg cache and file information stores. Useful if you suspect a cache is not getting cleared.'),
    ];
    $form['drastic_measures']['dumb_cache_flush']['advagg_flush_all_caches'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Clear All Caches & File Information'),
      '#submit' => [
        '::clearAggregates',
      ],
      '#ajax' => [
        'callback' => '::drasticTasksAjax',
        'wrapper' => 'drastic-measures-wrapper',
      ],
    ];
    $form['drastic_measures']['force_change'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Force new files'),
      '#description' => $this
        ->t('Force the creation of all new optimized files by incrementing a global counter. Current value of counter: %value. This is useful if a CDN has cached a file incorrectly as it will force new ones to be used even if nothing else has changed.', [
        '%value' => $this
          ->config('advagg.settings')
          ->get('global_counter'),
      ]),
    ];
    $form['drastic_measures']['force_change']['increment_global_counter'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Increment Global Counter'),
      '#submit' => [
        '::incrementCounter',
      ],
      '#ajax' => [
        'callback' => '::drasticTasksAjax',
        'wrapper' => 'drastic-measures-wrapper',
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Report results via Ajax.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   *
   * @return array
   *   The wrapper element.
   */
  public function tasksAjax(array &$form) {
    return $form['wrapper'];
  }

  /**
   * Clear out all advagg cache bins and clear out all advagg aggregated files.
   */
  public function clearAggregates() {

    // Clear out the cache.
    Cache::invalidateTags([
      'library_info',
    ]);
    $this->cache
      ->invalidateAll();
    $pub = $this->fileSystem
      ->realpath('public://');
    $css_count = count(glob($pub . '/css/optimized/*.css'));
    $js_count = count(glob($pub . '/js/optimized/*.js'));
    foreach ([
      'public://js/optimized',
      'public://css/optimized',
    ] as $path) {
      if (file_exists($path)) {
        file_unmanaged_delete_recursive($path);
      }
    }

    // Report back the results.
    $this->messenger
      ->addMessage($this
      ->t('All AdvAgg optimized files have been deleted. %css_count CSS files and %js_count JS files have been removed.', [
      '%css_count' => $css_count,
      '%js_count' => $js_count,
    ]));
  }

  /**
   * Clear out all stale advagg aggregated files.
   */
  public function clearStaleAggregates() {
    $counts = advagg_cron(TRUE);

    // Report back the results.
    if (!empty($counts['css']) || !empty($counts['js'])) {
      $this->messenger
        ->addMessage($this
        ->t('All stale aggregates have been deleted. %css_count CSS files and %js_count JS files have been removed.', [
        '%css_count' => count($counts['css']),
        '%js_count' => count($counts['js']),
      ]));
    }
    else {
      $this->messenger
        ->addMessage($this
        ->t('No stale aggregates found. Nothing was deleted.'));
    }
  }

  /**
   * Increment the global counter. Also full cache clear.
   */
  public function incrementCounter() {

    // Clear out the cache and delete aggregates.
    $this
      ->clearAggregates();

    // Increment counter.
    $new_value = $this
      ->config('advagg.settings')
      ->get('global_counter') + 1;
    $this
      ->config('advagg.settings')
      ->set('global_counter', $new_value)
      ->save();
    $this->messenger
      ->addMessage($this
      ->t('Global counter is now set to %new_value', [
      '%new_value' => $new_value,
    ]));
  }

  /**
   * Report results from the drastic measure tasks via Ajax.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   *
   * @return array
   *   The wrapper element.
   */
  public function drasticTasksAjax(array &$form) {
    return $form['drastic_measures']['wrapper'];
  }

  /**
   * Report results from the cron tasks via Ajax.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   *
   * @return array
   *   The wrapper element.
   */
  public function cronTasksAjax(array &$form) {
    return $form['cron']['wrapper'];
  }

  /**
   * Set or remove the AdvAggDisabled cookie.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function toggleBypassCookie(array &$form, FormStateInterface $form_state) {
    $cookie_name = 'AdvAggDisabled';
    $key = Crypt::hashBase64($this->privateKey
      ->get());

    // If the cookie does exist then remove it.
    if (!empty($_COOKIE[$cookie_name]) && $_COOKIE[$cookie_name] == $key) {
      setcookie($cookie_name, '', -1, $GLOBALS['base_path'], '.' . $_SERVER['HTTP_HOST']);
      unset($_COOKIE[$cookie_name]);
      $this->messenger
        ->addMessage($this
        ->t('AdvAgg Bypass Cookie Removed.'));
    }
    else {
      setcookie($cookie_name, $key, $this->time
        ->getRequestTime() + $form_state
        ->getValue('timespan'), $GLOBALS['base_path'], '.' . $_SERVER['HTTP_HOST']);
      $_COOKIE[$cookie_name] = $key;
      $this->messenger
        ->addMessage($this
        ->t('AdvAgg Bypass Cookie Set for %time.', [
        '%time' => $this->dateFormatter
          ->formatInterval($form_state
          ->getValue('timespan')),
      ]));
    }
    $this
      ->clearAggregates();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 26
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OperationsForm::$cache protected property The AdvAgg cache.
OperationsForm::$dateFormatter protected property The date formatter service.
OperationsForm::$fileSystem protected property The File System service.
OperationsForm::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
OperationsForm::$privateKey protected property The private key service.
OperationsForm::$time protected property Obtaining system time.
OperationsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
OperationsForm::clearAggregates public function Clear out all advagg cache bins and clear out all advagg aggregated files.
OperationsForm::clearStaleAggregates public function Clear out all stale advagg aggregated files.
OperationsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
OperationsForm::cronTasksAjax public function Report results from the cron tasks via Ajax.
OperationsForm::drasticTasksAjax public function Report results from the drastic measure tasks via Ajax.
OperationsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
OperationsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OperationsForm::incrementCounter public function Increment the global counter. Also full cache clear.
OperationsForm::tasksAjax public function Report results via Ajax.
OperationsForm::toggleBypassCookie public function Set or remove the AdvAggDisabled cookie.
OperationsForm::__construct public function Constructs the OperationsForm object. Overrides ConfigFormBase::__construct
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.