annotate core/modules/update/src/UpdateSettingsForm.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\update;
Chris@0 4
Chris@18 5 use Drupal\Component\Utility\EmailValidatorInterface;
Chris@0 6 use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
Chris@0 7 use Symfony\Component\DependencyInjection\ContainerInterface;
Chris@0 8 use Drupal\Core\Form\ConfigFormBase;
Chris@0 9 use Drupal\Core\Form\FormStateInterface;
Chris@0 10
Chris@0 11 /**
Chris@0 12 * Configure update settings for this site.
Chris@14 13 *
Chris@14 14 * @internal
Chris@0 15 */
Chris@0 16 class UpdateSettingsForm extends ConfigFormBase implements ContainerInjectionInterface {
Chris@0 17
Chris@0 18 /**
Chris@0 19 * The email validator.
Chris@0 20 *
Chris@18 21 * @var \Drupal\Component\Utility\EmailValidatorInterface
Chris@0 22 */
Chris@0 23 protected $emailValidator;
Chris@0 24
Chris@0 25 /**
Chris@0 26 * Constructs a new UpdateSettingsForm.
Chris@0 27 *
Chris@18 28 * @param \Drupal\Component\Utility\EmailValidatorInterface $email_validator
Chris@0 29 * The email validator.
Chris@0 30 */
Chris@18 31 public function __construct(EmailValidatorInterface $email_validator) {
Chris@0 32 $this->emailValidator = $email_validator;
Chris@0 33 }
Chris@0 34
Chris@0 35 /**
Chris@0 36 * {@inheritdoc}
Chris@0 37 */
Chris@0 38 public static function create(ContainerInterface $container) {
Chris@0 39 return new static(
Chris@0 40 $container->get('email.validator')
Chris@0 41 );
Chris@0 42 }
Chris@0 43
Chris@0 44 /**
Chris@0 45 * {@inheritdoc}
Chris@0 46 */
Chris@0 47 public function getFormId() {
Chris@0 48 return 'update_settings';
Chris@0 49 }
Chris@0 50
Chris@0 51 /**
Chris@0 52 * {@inheritdoc}
Chris@0 53 */
Chris@0 54 protected function getEditableConfigNames() {
Chris@0 55 return ['update.settings'];
Chris@0 56 }
Chris@0 57
Chris@0 58 /**
Chris@0 59 * {@inheritdoc}
Chris@0 60 */
Chris@0 61 public function buildForm(array $form, FormStateInterface $form_state) {
Chris@0 62 $config = $this->config('update.settings');
Chris@0 63
Chris@0 64 $form['update_check_frequency'] = [
Chris@0 65 '#type' => 'radios',
Chris@0 66 '#title' => t('Check for updates'),
Chris@0 67 '#default_value' => $config->get('check.interval_days'),
Chris@0 68 '#options' => [
Chris@0 69 '1' => t('Daily'),
Chris@0 70 '7' => t('Weekly'),
Chris@0 71 ],
Chris@0 72 '#description' => t('Select how frequently you want to automatically check for new releases of your currently installed modules and themes.'),
Chris@0 73 ];
Chris@0 74
Chris@0 75 $form['update_check_disabled'] = [
Chris@0 76 '#type' => 'checkbox',
Chris@0 77 '#title' => t('Check for updates of uninstalled modules and themes'),
Chris@0 78 '#default_value' => $config->get('check.disabled_extensions'),
Chris@0 79 ];
Chris@0 80
Chris@0 81 $notification_emails = $config->get('notification.emails');
Chris@0 82 $form['update_notify_emails'] = [
Chris@0 83 '#type' => 'textarea',
Chris@0 84 '#title' => t('Email addresses to notify when updates are available'),
Chris@0 85 '#rows' => 4,
Chris@0 86 '#default_value' => implode("\n", $notification_emails),
Chris@0 87 '#description' => t('Whenever your site checks for available updates and finds new releases, it can notify a list of users via email. Put each address on a separate line. If blank, no emails will be sent.'),
Chris@0 88 ];
Chris@0 89
Chris@0 90 $form['update_notification_threshold'] = [
Chris@0 91 '#type' => 'radios',
Chris@0 92 '#title' => t('Email notification threshold'),
Chris@0 93 '#default_value' => $config->get('notification.threshold'),
Chris@0 94 '#options' => [
Chris@0 95 'all' => t('All newer versions'),
Chris@0 96 'security' => t('Only security updates'),
Chris@0 97 ],
Chris@17 98 '#description' => t('You can choose to send email only if a security update is available, or to be notified about all newer versions. If there are updates available of Drupal core or any of your installed modules and themes, your site will always print a message on the <a href=":status_report">status report</a> page, and will also display an error message on administration pages if there is a security update.', [':status_report' => $this->url('system.status')]),
Chris@0 99 ];
Chris@0 100
Chris@0 101 return parent::buildForm($form, $form_state);
Chris@0 102 }
Chris@0 103
Chris@0 104 /**
Chris@0 105 * {@inheritdoc}
Chris@0 106 */
Chris@0 107 public function validateForm(array &$form, FormStateInterface $form_state) {
Chris@0 108 $form_state->set('notify_emails', []);
Chris@0 109 if (!$form_state->isValueEmpty('update_notify_emails')) {
Chris@0 110 $valid = [];
Chris@0 111 $invalid = [];
Chris@0 112 foreach (explode("\n", trim($form_state->getValue('update_notify_emails'))) as $email) {
Chris@0 113 $email = trim($email);
Chris@0 114 if (!empty($email)) {
Chris@0 115 if ($this->emailValidator->isValid($email)) {
Chris@0 116 $valid[] = $email;
Chris@0 117 }
Chris@0 118 else {
Chris@0 119 $invalid[] = $email;
Chris@0 120 }
Chris@0 121 }
Chris@0 122 }
Chris@0 123 if (empty($invalid)) {
Chris@0 124 $form_state->set('notify_emails', $valid);
Chris@0 125 }
Chris@0 126 elseif (count($invalid) == 1) {
Chris@0 127 $form_state->setErrorByName('update_notify_emails', $this->t('%email is not a valid email address.', ['%email' => reset($invalid)]));
Chris@0 128 }
Chris@0 129 else {
Chris@0 130 $form_state->setErrorByName('update_notify_emails', $this->t('%emails are not valid email addresses.', ['%emails' => implode(', ', $invalid)]));
Chris@0 131 }
Chris@0 132 }
Chris@0 133
Chris@0 134 parent::validateForm($form, $form_state);
Chris@0 135 }
Chris@0 136
Chris@0 137 /**
Chris@0 138 * {@inheritdoc}
Chris@0 139 */
Chris@0 140 public function submitForm(array &$form, FormStateInterface $form_state) {
Chris@0 141 $config = $this->config('update.settings');
Chris@0 142 // See if the update_check_disabled setting is being changed, and if so,
Chris@0 143 // invalidate all update status data.
Chris@0 144 if ($form_state->getValue('update_check_disabled') != $config->get('check.disabled_extensions')) {
Chris@0 145 update_storage_clear();
Chris@0 146 }
Chris@0 147
Chris@0 148 $config
Chris@0 149 ->set('check.disabled_extensions', $form_state->getValue('update_check_disabled'))
Chris@0 150 ->set('check.interval_days', $form_state->getValue('update_check_frequency'))
Chris@0 151 ->set('notification.emails', $form_state->get('notify_emails'))
Chris@0 152 ->set('notification.threshold', $form_state->getValue('update_notification_threshold'))
Chris@0 153 ->save();
Chris@0 154
Chris@0 155 parent::submitForm($form, $form_state);
Chris@0 156 }
Chris@0 157
Chris@0 158 }