AccountForm.php 16.4 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 20
use Drupal\language\ConfigurableLanguageManagerInterface;
use Drupal\user\Plugin\LanguageNegotiation\LanguageNegotiationUserAdmin;
use Drupal\user\Plugin\LanguageNegotiation\LanguageNegotiationUser;
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 92
    $form['account']['mail'] = array(
      '#type' => 'email',
93 94
      '#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.'),
95
      '#required' => !(!$account->getEmail() && $user->hasPermission('administer users')),
96
      '#default_value' => (!$register ? $account->getEmail() : ''),
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    );

    // 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),
114 115 116 117 118 119 120 121
    );

    // 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,
122
        '#description' => $this->t('To change the current user password, enter the new password in both fields.'),
123 124 125 126
      );

      // To skip the current password field, the user must have logged in via a
      // one-time link and have the token in the URL.
127 128
      $pass_reset = isset($_SESSION['pass_reset_' . $account->id()]) && (\Drupal::request()->query->get('pass-reset-token') == $_SESSION['pass_reset_' . $account->id()]);

129 130 131 132 133 134 135
      $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.
      if (!$pass_reset) {
        $protected_values['mail'] = $form['account']['mail']['#title'];
136
        $protected_values['pass'] = $this->t('Password');
137
        $request_new = $this->l($this->t('Request new password'), new Url('user.pass', array(), array('attributes' => array('title' => $this->t('Request new password via email.')))));
138
        $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));
139 140 141
      }

      // The user must enter their current password to change to a new one.
142
      if ($user->id() == $account->id()) {
143 144 145 146 147 148 149
        $form['account']['current_pass_required_values'] = array(
          '#type' => 'value',
          '#value' => $protected_values,
        );

        $form['account']['current_pass'] = array(
          '#type' => 'password',
150
          '#title' => $this->t('Current password'),
151 152 153 154
          '#size' => 25,
          '#access' => !empty($protected_values),
          '#description' => $current_pass_description,
          '#weight' => -5,
155 156 157
          // 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.
158 159 160
          '#attributes' => array('autocomplete' => 'off'),
        );

161
        $form_state->set('user', $account);
162 163 164
        $form['#validate'][] = 'user_validate_current_pass';
      }
    }
165
    elseif (!$config->get('verify_mail') || $admin) {
166 167 168
      $form['account']['pass'] = array(
        '#type' => 'password_confirm',
        '#size' => 25,
169
        '#description' => $this->t('Provide a password for the new account in both fields.'),
170 171 172 173
        '#required' => TRUE,
      );
    }

174 175 176 177 178 179 180 181 182 183
    // 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';
        }
      }
    }

184
    if ($admin) {
185
      $status = $account->isActive();
186 187
    }
    else {
188
      $status = $register ? $config->get('register') == USER_REGISTER_VISITORS : $account->isActive();
189 190 191 192
    }

    $form['account']['status'] = array(
      '#type' => 'radios',
193
      '#title' => $this->t('Status'),
194
      '#default_value' => $status,
195
      '#options' => array($this->t('Blocked'), $this->t('Active')),
196 197 198
      '#access' => $admin,
    );

199
    $roles = array_map(array('\Drupal\Component\Utility\String', 'checkPlain'), user_role_names(TRUE));
200 201 202

    $form['account']['roles'] = array(
      '#type' => 'checkboxes',
203
      '#title' => $this->t('Roles'),
204
      '#default_value' => (!$register ? $account->getRoles() : array()),
205
      '#options' => $roles,
206
      '#access' => $roles && $user->hasPermission('administer permissions'),
207 208 209 210 211 212
    );

    // Special handling for the inevitable "Authenticated user" role.
    $form['account']['roles'][DRUPAL_AUTHENTICATED_RID] = array(
      '#default_value' => TRUE,
      '#disabled' => TRUE,
213 214 215 216
    );

    $form['account']['notify'] = array(
      '#type' => 'checkbox',
217
      '#title' => $this->t('Notify user of new account'),
218 219 220 221 222
      '#access' => $register && $admin,
    );

    // Signature.
    $form['signature_settings'] = array(
223
      '#type' => 'details',
224
      '#title' => $this->t('Signature settings'),
225
      '#open' => TRUE,
226
      '#weight' => 1,
227
      '#access' => (!$register && $config->get('signatures')),
228
    );
229 230 231 232 233 234 235 236 237 238 239 240 241 242
    // 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(),
      );
    }
243

244
    $user_preferred_langcode = $register ? $language_interface->getId() : $account->getPreferredLangcode();
245

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

248 249
    // Is the user preferred language added?
    $user_language_added = FALSE;
250 251
    if ($this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $negotiator = $this->languageManager->getNegotiator();
252
      $user_language_added = $negotiator && $negotiator->isNegotiationMethodEnabled(LanguageNegotiationUser::METHOD_ID, LanguageInterface::TYPE_INTERFACE);
253
    }
254
    $form['language'] = array(
255
      '#type' => $this->languageManager->isMultilingual() ? 'details' : 'container',
256
      '#title' => $this->t('Language settings'),
257
      '#open' => TRUE,
258 259
      // Display language selector when either creating a user on the admin
      // interface or editing a user account.
260
      '#access' => !$register || $user->hasPermission('administer users'),
261
    );
262

263 264
    $form['language']['preferred_langcode'] = array(
      '#type' => 'language_select',
265
      '#title' => $this->t('Site language'),
266
      '#languages' => LanguageInterface::STATE_CONFIGURABLE,
267
      '#default_value' => $user_preferred_langcode,
268
      '#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."),
269
    );
270

271 272 273
    // 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;
274 275 276
    if ($account->hasPermission('access administration pages') && $this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $negotiator = $this->languageManager->getNegotiator();
      $show_admin_language = $negotiator && $negotiator->isNegotiationMethodEnabled(LanguageNegotiationUserAdmin::METHOD_ID);
277
    }
278 279
    $form['language']['preferred_admin_langcode'] = array(
      '#type' => 'language_select',
280
      '#title' => $this->t('Administration pages language'),
281
      '#languages' => LanguageInterface::STATE_CONFIGURABLE,
282
      '#default_value' => $user_preferred_admin_langcode,
283
      '#access' => $show_admin_language,
284 285
      '#empty_option' => $this->t('- No preference -'),
      '#empty_value' => '',
286
    );
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
    // 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
    // language. This element provides that synchronization. For use-cases where
    // this synchronization is not desired, a module can alter or remove this
    // element.
    $form['language']['langcode'] = array(
      '#type' => 'value',
      '#value_callback' => '_user_language_selector_langcode_value',
      // For the synchronization to work, this element must have a larger weight
      // than the preferred_langcode element. Set a large weight here in case
      // a module alters the weight of the other element.
      '#weight' => 100,
    );

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

306 307 308
  /**
   * {@inheritdoc}
   */
309
  public function buildEntity(array $form, FormStateInterface $form_state) {
310 311 312 313 314
    // 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.
315

316 317
    if (is_string(key($form_state->getValue('roles')))) {
      $form_state->setValue('roles', array_keys(array_filter($form_state->getValue('roles'))));
318 319 320 321
    }
    return parent::buildEntity($form, $form_state);
  }

322
  /**
323
   * {@inheritdoc}
324
   */
325
  public function validate(array $form, FormStateInterface $form_state) {
326 327
    parent::validate($form, $form_state);

328
    $account = $this->entity;
329
    // Validate new or changing username.
330 331
    if ($form_state->hasValue('name')) {
      if ($error = user_validate_name($form_state->getValue('name'))) {
332
        $form_state->setErrorByName('name', $error);
333 334 335 336
      }
      // Cast the user ID as an integer. It might have been set to NULL, which
      // could lead to unexpected results.
      else {
337 338
        $name_taken = (bool) $this->entityQuery->get('user')
          ->condition('uid', (int) $account->id(), '<>')
339
          ->condition('name', $form_state->getValue('name'))
340 341 342
          ->range(0, 1)
          ->count()
          ->execute();
343 344

        if ($name_taken) {
345
          $form_state->setErrorByName('name', $this->t('The username %name is already taken.', array('%name' => $form_state->getValue('name'))));
346 347 348 349
        }
      }
    }

350
    $mail = $form_state->getValue('mail');
351 352

    if (!empty($mail)) {
353 354 355 356 357 358
      $mail_taken = (bool) $this->entityQuery->get('user')
        ->condition('uid', (int) $account->id(), '<>')
        ->condition('mail', $mail)
        ->range(0, 1)
        ->count()
        ->execute();
359 360 361

      if ($mail_taken) {
        // Format error message dependent on whether the user is logged in or not.
362
        if (\Drupal::currentUser()->isAuthenticated()) {
363
          $form_state->setErrorByName('mail', $this->t('The email address %email is already taken.', array('%email' => $mail)));
364 365
        }
        else {
366
          $form_state->setErrorByName('mail', $this->t('The email address %email is already registered. <a href="@password">Have you forgotten your password?</a>', array('%email' => $mail, '@password' => $this->url('user.pass'))));
367 368 369 370 371 372
        }
      }
    }

    // Make sure the signature isn't longer than the size of the database field.
    // Signatures are disabled by default, so make sure it exists first.
373
    if ($signature = $form_state->getValue('signature')) {
374
      // Move text format for user signature into 'signature_format'.
375
      $form_state->setValue('signature_format', $signature['format']);
376
      // Move text value for user signature into 'signature'.
377
      $form_state->setValue('signature', $signature['value']);
378

379 380 381 382
      // @todo Make the user signature field use a widget to benefit from
      //   automatic typed data validation in https://drupal.org/node/2227381.
      $field_definitions = $this->entityManager->getFieldDefinitions('user', $this->getEntity()->bundle());
      $max_length = $field_definitions['signature']->getSetting('max_length');
383
      if (Unicode::strlen($form_state->getValue('signature')) > $max_length) {
384
        $form_state->setErrorByName('signature', $this->t('The signature is too long: it must be %max characters or less.', array('%max' => $max_length)));
385 386 387
      }
    }
  }
388

389 390 391
  /**
   * {@inheritdoc}
   */
392 393
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
394 395 396 397 398 399 400 401

    $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()]);
    }
  }
402
}