You are here

SettingsForm.php in Automatic Updates 8

File

src/Form/SettingsForm.php
View source
<?php

namespace Drupal\automatic_updates\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\update\UpdateManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Settings form for automatic updates.
 */
class SettingsForm extends ConfigFormBase {

  /**
   * The readiness checker.
   *
   * @var \Drupal\automatic_updates\ReadinessChecker\ReadinessCheckerManagerInterface
   */
  protected $checker;

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

  /**
   * Drupal root path.
   *
   * @var string
   */
  protected $drupalRoot;

  /**
   * The update manager service.
   *
   * @var \Drupal\update\UpdateManagerInterface
   */
  protected $updateManager;

  /**
   * The update processor.
   *
   * @var \Drupal\update\UpdateProcessorInterface
   */
  protected $updateProcessor;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->checker = $container
      ->get('automatic_updates.readiness_checker');
    $instance->dateFormatter = $container
      ->get('date.formatter');
    $instance->drupalRoot = (string) $container
      ->get('app.root');
    $instance->updateManager = $container
      ->get('update.manager');
    $instance->updateProcessor = $container
      ->get('update.processor');
    return $instance;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('automatic_updates.settings');
    $form['psa'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Public service announcements'),
      '#open' => TRUE,
    ];
    $form['psa']['description'] = [
      '#markup' => '<p>' . $this
        ->t('Public service announcements are compared against the entire code for the site, not just installed extensions.') . '</p>',
    ];
    $form['psa']['enable_psa'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show Public service announcements on administrative pages.'),
      '#default_value' => $config
        ->get('enable_psa'),
    ];
    $form['psa']['notify'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Send email notifications for Public service announcements.'),
      '#default_value' => $config
        ->get('notify'),
      '#description' => $this
        ->t('The email addresses listed in <a href="@update_manager">update manager settings</a> will be notified.', [
        '@update_manager' => Url::fromRoute('update.settings')
          ->toString(),
      ]),
    ];
    $form['readiness'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Readiness checks'),
      '#open' => TRUE,
    ];
    $last_check_timestamp = $this->checker
      ->timestamp();
    $form['readiness']['enable_readiness_checks'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Check the readiness of automatically updating the site.'),
      '#default_value' => $config
        ->get('enable_readiness_checks'),
    ];
    if ($this->checker
      ->isEnabled()) {
      $form['readiness']['enable_readiness_checks']['#description'] = $this
        ->t('Readiness checks were last run @time ago. Manually <a href="@link">run the readiness checks</a>.', [
        '@time' => $this->dateFormatter
          ->formatTimeDiffSince($last_check_timestamp),
        '@link' => Url::fromRoute('automatic_updates.update_readiness')
          ->toString(),
      ]);
    }
    $form['readiness']['ignored_paths'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Paths to ignore for readiness checks'),
      '#description' => $this
        ->t('Paths relative to %drupal_root. One path per line. Automatic Updates is intentionally limited to Drupal core. It is recommended to ignore paths to contrib extensions.', [
        '%drupal_root' => $this->drupalRoot,
      ]),
      '#default_value' => $config
        ->get('ignored_paths'),
      '#states' => [
        'visible' => [
          ':input[name="enable_readiness_checks"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $this->updateManager
      ->refreshUpdateData();
    $this->updateProcessor
      ->fetchData();
    $available = update_get_available(TRUE);
    $projects = update_calculate_project_data($available);
    $not_recommended_version = $projects['drupal']['status'] !== UpdateManagerInterface::CURRENT;
    $not_dev_core = strpos(\Drupal::VERSION, '-dev') === FALSE;
    $security_update = in_array($projects['drupal']['status'], [
      UpdateManagerInterface::NOT_SECURE,
      UpdateManagerInterface::REVOKED,
    ], TRUE);
    $recommended_release = $projects['drupal']['releases'][$projects['drupal']['recommended']];
    $form['experimental'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Experimental'),
      '#states' => [
        'visible' => [
          ':input[name="enable_readiness_checks"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if ($not_recommended_version && $not_dev_core) {
      $existing_major_version = explode('.', \Drupal::VERSION, -2);
      $recommended_major_version = explode('.', $recommended_release['version'], -2);
      $major_upgrade = $existing_major_version !== $recommended_major_version;
      if ($security_update) {
        $form['experimental']['security'] = [
          '#type' => 'html_tag',
          '#tag' => 'p',
          '#value' => $this
            ->t('A security update is available for your version of Drupal.'),
        ];
      }
      if ($major_upgrade) {
        $form['experimental']['major_version'] = [
          '#type' => 'html_tag',
          '#tag' => 'p',
          '#value' => $this
            ->t('This update is a major version update which means that it may not be backwards compatible with your currently running version. It is recommended that you read the release notes and proceed at your own risk.'),
        ];
      }
    }
    $update_text = $this
      ->t('Your site is running %version of Drupal core. No recommended update is available at this time.</i>', [
      '%version' => \Drupal::VERSION,
    ]);
    if ($not_recommended_version && $not_dev_core) {
      $update_text = $this
        ->t('A newer version of Drupal is available and you may <a href="@link">manually update now</a>.', [
        '@link' => Url::fromRoute('automatic_updates.inplace-update', [
          'project' => 'drupal',
          'type' => 'core',
          'from' => \Drupal::VERSION,
          'to' => $recommended_release['version'],
        ])
          ->toString(),
      ]);
    }
    $form['experimental']['update'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $update_text,
    ];
    $form['experimental']['enable_cron_updates'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable automatic updates of Drupal core via cron.'),
      '#default_value' => $config
        ->get('enable_cron_updates'),
      '#description' => $this
        ->t('When a recommended update for Drupal core is available, a manual method to update is available. As an alternative to the full control of manually executing an update, enable automated updates via cron.'),
    ];
    $form['experimental']['enable_cron_security_updates'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable security only updates'),
      '#default_value' => $config
        ->get('enable_cron_security_updates'),
      '#description' => $this
        ->t('Enable automated updates via cron for security-only releases of Drupal core.'),
      '#states' => [
        'visible' => [
          ':input[name="enable_cron_updates"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $form_state
      ->cleanValues();
    $config = $this
      ->config('automatic_updates.settings');
    foreach ($form_state
      ->getValues() as $key => $value) {
      $config
        ->set($key, $value);

      // Disable cron automatic updates if readiness checks are disabled.
      if (in_array($key, [
        'enable_cron_updates',
        'enable_cron_security_updates',
      ], TRUE) && !$form_state
        ->getValue('enable_readiness_checks')) {
        $config
          ->set($key, FALSE);
      }
    }
    $config
      ->save();
  }

}

Classes

Namesort descending Description
SettingsForm Settings form for automatic updates.