AccountForm.php 16.5 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\user\AccountForm.
6 7 8 9
 */

namespace Drupal\user;

10
use Drupal\Component\Utility\Unicode;
11
use Drupal\Core\Entity\ContentEntityForm;
12
use Drupal\Core\Entity\EntityManagerInterface;
13
use Drupal\Core\Entity\Query\QueryFactory;
14
use Drupal\Core\Form\FormStateInterface;
15
use Drupal\Core\Language\LanguageInterface;
16
use Drupal\Core\Language\LanguageManagerInterface;
17
use Drupal\Core\Url;
18 19
use Drupal\language\ConfigurableLanguageManagerInterface;
use Drupal\user\Plugin\LanguageNegotiation\LanguageNegotiationUser;
20
use Drupal\user\Plugin\LanguageNegotiation\LanguageNegotiationUserAdmin;
21
use Symfony\Component\DependencyInjection\ContainerInterface;
22 23 24 25

/**
 * Form controller for the user account forms.
 */
26
abstract class AccountForm extends ContentEntityForm {
27

28 29 30
  /**
   * The language manager.
   *
31
   * @var \Drupal\Core\Language\LanguageManagerInterface
32 33 34
   */
  protected $languageManager;

35 36 37 38 39 40 41
  /**
   * The entity query factory service.
   *
   * @var \Drupal\Core\Entity\Query\QueryFactory
   */
  protected $entityQuery;

42
  /**
43
   * Constructs a new EntityForm object.
44
   *
45 46
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
47
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
48
   *   The language manager.
49 50
   * @param \Drupal\Core\Entity\Query\QueryFactory
   *   The entity query factory.
51
   */
52
  public function __construct(EntityManagerInterface $entity_manager, LanguageManagerInterface $language_manager, QueryFactory $entity_query) {
53
    parent::__construct($entity_manager);
54
    $this->languageManager = $language_manager;
55
    $this->entityQuery = $entity_query;
56 57 58 59 60 61 62
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
63
      $container->get('entity.manager'),
64 65
      $container->get('language_manager'),
      $container->get('entity.query')
66 67 68
    );
  }

69
  /**
70
   * {@inheritdoc}
71
   */
72
  public function form(array $form, FormStateInterface $form_state) {
73
    /** @var \Drupal\user\UserInterface $account */
74
    $account = $this->entity;
75
    $user = $this->currentUser();
76
    $config = \Drupal::config('user.settings');
77

78
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
79
    $register = $account->isAnonymous();
80
    $admin = $user->hasPermission('administer users');
81 82 83 84 85 86 87 88 89

    // Account information.
    $form['account'] = array(
      '#type'   => 'container',
      '#weight' => -10,
    );

    // The mail field is NOT required if account originally had no mail set
    // and the user performing the edit has 'administer users' permission.
90
    // This allows users without email address to be edited and deleted.
91
    // Also see \Drupal\user\Plugin\Validation\Constraint\UserMailRequired.
92 93
    $form['account']['mail'] = array(
      '#type' => 'email',
94 95
      '#title' => $this->t('Email address'),
      '#description' => $this->t('A valid email address. All emails from the system will be sent to this address. The email address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by email.'),
96
      '#required' => !(!$account->getEmail() && $user->hasPermission('administer users')),
97
      '#default_value' => (!$register ? $account->getEmail() : ''),
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    );

    // Only show name field on registration form or user can change own username.
    $form['account']['name'] = array(
      '#type' => 'textfield',
      '#title' => $this->t('Username'),
      '#maxlength' => USERNAME_MAX_LENGTH,
      '#description' => $this->t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'),
      '#required' => TRUE,
      '#attributes' => array(
        'class' => array('username'),
        'autocorrect' => 'off',
        'autocapitalize' => 'off',
        'spellcheck' => 'false',
      ),
      '#default_value' => (!$register ? $account->getUsername() : ''),
      '#access' => ($register || ($user->id() == $account->id() && $user->hasPermission('change own username')) || $admin),
115 116 117 118 119 120 121 122
    );

    // Display password field only for existing users or when user is allowed to
    // assign a password during registration.
    if (!$register) {
      $form['account']['pass'] = array(
        '#type' => 'password_confirm',
        '#size' => 25,
123
        '#description' => $this->t('To change the current user password, enter the new password in both fields.'),
124 125 126
      );

      // To skip the current password field, the user must have logged in via a
127 128 129 130 131 132
      // one-time link and have the token in the URL. Store this in $form_state
      // so it persists even on subsequent Ajax requests.
      if (!$form_state->get('user_pass_reset')) {
        $user_pass_reset = $pass_reset = isset($_SESSION['pass_reset_' . $account->id()]) && (\Drupal::request()->query->get('pass-reset-token') == $_SESSION['pass_reset_' . $account->id()]);
        $form_state->set('user_pass_reset', $user_pass_reset);
      }
133

134 135 136 137 138
      $protected_values = array();
      $current_pass_description = '';

      // The user may only change their own password without their current
      // password if they logged in via a one-time login link.
139
      if (!$form_state->get('user_pass_reset')) {
140
        $protected_values['mail'] = $form['account']['mail']['#title'];
141
        $protected_values['pass'] = $this->t('Password');
142 143 144 145 146 147 148 149 150 151
        $request_new = $this->l($this->t('Reset your password'), new Url('user.pass',
          array(), array('attributes' => array('title' => $this->t('Send password reset instructions via e-mail.'))))
        );
        $current_pass_description = $this->t('Required if you want to change the %mail or %pass below. !request_new.',
          array(
            '%mail' => $protected_values['mail'],
            '%pass' => $protected_values['pass'],
            '!request_new' => $request_new,
          )
        );
152 153 154
      }

      // The user must enter their current password to change to a new one.
155
      if ($user->id() == $account->id()) {
156 157 158 159 160 161 162
        $form['account']['current_pass_required_values'] = array(
          '#type' => 'value',
          '#value' => $protected_values,
        );

        $form['account']['current_pass'] = array(
          '#type' => 'password',
163
          '#title' => $this->t('Current password'),
164 165 166 167
          '#size' => 25,
          '#access' => !empty($protected_values),
          '#description' => $current_pass_description,
          '#weight' => -5,
168 169 170
          // Do not let web browsers remember this password, since we are
          // trying to confirm that the person submitting the form actually
          // knows the current one.
171 172 173
          '#attributes' => array('autocomplete' => 'off'),
        );

174
        $form_state->set('user', $account);
175 176 177
        $form['#validate'][] = 'user_validate_current_pass';
      }
    }
178
    elseif (!$config->get('verify_mail') || $admin) {
179 180 181
      $form['account']['pass'] = array(
        '#type' => 'password_confirm',
        '#size' => 25,
182
        '#description' => $this->t('Provide a password for the new account in both fields.'),
183 184 185 186
        '#required' => TRUE,
      );
    }

187 188 189 190 191 192 193 194 195 196
    // When not building the user registration form, prevent web browsers from
    // autofilling/prefilling the email, username, and password fields.
    if ($this->getOperation() != 'register') {
      foreach (array('mail', 'name', 'pass') as $key) {
        if (isset($form['account'][$key])) {
          $form['account'][$key]['#attributes']['autocomplete'] = 'off';
        }
      }
    }

197
    if ($admin) {
198
      $status = $account->isActive();
199 200
    }
    else {
201
      $status = $register ? $config->get('register') == USER_REGISTER_VISITORS : $account->isActive();
202 203 204 205
    }

    $form['account']['status'] = array(
      '#type' => 'radios',
206
      '#title' => $this->t('Status'),
207
      '#default_value' => $status,
208
      '#options' => array($this->t('Blocked'), $this->t('Active')),
209 210 211
      '#access' => $admin,
    );

212
    $roles = array_map(array('\Drupal\Component\Utility\String', 'checkPlain'), user_role_names(TRUE));
213 214 215

    $form['account']['roles'] = array(
      '#type' => 'checkboxes',
216
      '#title' => $this->t('Roles'),
217
      '#default_value' => (!$register ? $account->getRoles() : array()),
218
      '#options' => $roles,
219
      '#access' => $roles && $user->hasPermission('administer permissions'),
220 221 222 223 224 225
    );

    // Special handling for the inevitable "Authenticated user" role.
    $form['account']['roles'][DRUPAL_AUTHENTICATED_RID] = array(
      '#default_value' => TRUE,
      '#disabled' => TRUE,
226 227 228 229
    );

    $form['account']['notify'] = array(
      '#type' => 'checkbox',
230
      '#title' => $this->t('Notify user of new account'),
231 232 233 234 235
      '#access' => $register && $admin,
    );

    // Signature.
    $form['signature_settings'] = array(
236
      '#type' => 'details',
237
      '#title' => $this->t('Signature settings'),
238
      '#open' => TRUE,
239
      '#weight' => 1,
240
      '#access' => (!$register && $config->get('signatures')),
241
    );
242 243 244 245 246 247 248 249 250 251 252 253 254 255
    // While the details group will simply not be rendered if empty, the actual
    // signature element cannot use #access, since #type 'text_format' is not
    // available when Filter module is not installed. If the user account has an
    // existing signature value and format, then the existing field values will
    // just be re-saved to the database in case of an entity update.
    if ($this->moduleHandler->moduleExists('filter')) {
      $form['signature_settings']['signature'] = array(
        '#type' => 'text_format',
        '#title' => $this->t('Signature'),
        '#default_value' => $account->getSignature(),
        '#description' => $this->t('Your signature will be publicly displayed at the end of your comments.'),
        '#format' => $account->getSignatureFormat(),
      );
    }
256

257
    $user_preferred_langcode = $register ? $language_interface->getId() : $account->getPreferredLangcode();
258

259
    $user_preferred_admin_langcode = $register ? $language_interface->getId() : $account->getPreferredAdminLangcode(FALSE);
260

261 262
    // Is the user preferred language added?
    $user_language_added = FALSE;
263 264
    if ($this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $negotiator = $this->languageManager->getNegotiator();
265
      $user_language_added = $negotiator && $negotiator->isNegotiationMethodEnabled(LanguageNegotiationUser::METHOD_ID, LanguageInterface::TYPE_INTERFACE);
266
    }
267
    $form['language'] = array(
268
      '#type' => $this->languageManager->isMultilingual() ? 'details' : 'container',
269
      '#title' => $this->t('Language settings'),
270
      '#open' => TRUE,
271 272
      // Display language selector when either creating a user on the admin
      // interface or editing a user account.
273
      '#access' => !$register || $user->hasPermission('administer users'),
274
    );
275

276 277
    $form['language']['preferred_langcode'] = array(
      '#type' => 'language_select',
278
      '#title' => $this->t('Site language'),
279
      '#languages' => LanguageInterface::STATE_CONFIGURABLE,
280
      '#default_value' => $user_preferred_langcode,
281
      '#description' => $user_language_added ? $this->t("This account's preferred language for emails and site presentation.") : $this->t("This account's preferred language for emails."),
282 283 284 285
      // This is used to explain that user preferred language and entity
      // language are synchronized. It can be removed if a different behavior is
      // desired.
      '#pre_render' => ['user_langcode' => [$this, 'alterPreferredLangcodeDescription']],
286
    );
287

288 289 290
    // Only show the account setting for Administration pages language to users
    // if one of the detection and selection methods uses it.
    $show_admin_language = FALSE;
291 292 293
    if ($account->hasPermission('access administration pages') && $this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $negotiator = $this->languageManager->getNegotiator();
      $show_admin_language = $negotiator && $negotiator->isNegotiationMethodEnabled(LanguageNegotiationUserAdmin::METHOD_ID);
294
    }
295 296
    $form['language']['preferred_admin_langcode'] = array(
      '#type' => 'language_select',
297
      '#title' => $this->t('Administration pages language'),
298
      '#languages' => LanguageInterface::STATE_CONFIGURABLE,
299
      '#default_value' => $user_preferred_admin_langcode,
300
      '#access' => $show_admin_language,
301 302
      '#empty_option' => $this->t('- No preference -'),
      '#empty_value' => '',
303
    );
304

305 306 307 308
    // User entities contain both a langcode property (for identifying the
    // language of the entity data) and a preferred_langcode property (see
    // above). Rather than provide a UI forcing the user to choose both
    // separately, assume that the user profile data is in the user's preferred
309 310 311 312
    // language. This entity builder provides that synchronization. For
    // use-cases where this synchronization is not desired, a module can alter
    // or remove this item.
    $form['#entity_builders']['sync_user_langcode'] = [$this, 'syncUserLangcode'];
313 314 315 316

    return parent::form($form, $form_state, $account);
  }

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  /**
   * Alters the preferred language widget description.
   *
   * @param array $element
   *   The preferred language form element.
   *
   * @return array
   *   The preferred language form element.
   */
  public function alterPreferredLangcodeDescription(array $element) {
    // Only add to the description if the form element has a description.
    if (isset($element['#description'])) {
      $element['#description'] .= ' ' . $this->t("This is also assumed to be the primary language of this account's profile information.");
    }
    return $element;
  }

  /**
   * Synchronizes preferred language and entity language.
   *
   * @param string $entity_type_id
   *   The entity type identifier.
   * @param \Drupal\user\UserInterface $user
   *   The entity updated with the submitted values.
   * @param array $form
   *   The complete form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function syncUserLangcode($entity_type_id, UserInterface $user, array &$form, FormStateInterface &$form_state) {
    $user->langcode = $user->preferred_langcode;
  }

350 351 352
  /**
   * {@inheritdoc}
   */
353
  public function buildEntity(array $form, FormStateInterface $form_state) {
354 355 356 357 358
    // Change the roles array to a list of enabled roles.
    // @todo: Alter the form state as the form values are directly extracted and
    //   set on the field, which throws an exception as the list requires
    //   numeric keys. Allow to override this per field. As this function is
    //   called twice, we have to prevent it from getting the array keys twice.
359

360 361
    if (is_string(key($form_state->getValue('roles')))) {
      $form_state->setValue('roles', array_keys(array_filter($form_state->getValue('roles'))));
362
    }
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379

    /** @var \Drupal\user\UserInterface $account */
    $account = parent::buildEntity($form, $form_state);

    // Take care of mapping signature form element values as their structure
    // does not directly match the field structure.
    $signature = $form_state->getValue('signature');
    $account->setSignature($signature['value']);
    $account->setSignatureFormat($signature['format']);

    // Translate the empty value '' of language selects to an unset field.
    foreach (array('preferred_langcode', 'preferred_admin_langcode') as $field_name) {
      if ($form_state->getValue($field_name) === '') {
        $account->$field_name = NULL;
      }
    }
    return $account;
380 381
  }

382
  /**
383
   * {@inheritdoc}
384
   */
385
  public function validate(array $form, FormStateInterface $form_state) {
386
    /** @var \Drupal\user\UserInterface $account */
387 388
    $account = parent::validate($form, $form_state);

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
    // Customly trigger validation of manually added fields and add in
    // violations. This is necessary as entity form displays only invoke entity
    // validation for fields contained in the display.
    $field_names = array(
      'name',
      'mail',
      'signature',
      'signature_format',
      'timezone',
      'langcode',
      'preferred_langcode',
      'preferred_admin_langcode'
    );
    foreach ($field_names as $field_name) {
      $violations = $account->$field_name->validate();
      foreach ($violations as $violation) {
        $form_state->setErrorByName($field_name, $violation->getMessage());
406 407
      }
    }
408 409

    return $account;
410
  }
411

412 413 414
  /**
   * {@inheritdoc}
   */
415 416
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
417 418 419 420 421 422 423 424

    $user = $this->getEntity($form_state);
    // If there's a session set to the users id, remove the password reset tag
    // since a new password was saved.
    if (isset($_SESSION['pass_reset_'. $user->id()])) {
      unset($_SESSION['pass_reset_'. $user->id()]);
    }
  }
425
}