AccountForm.php 15.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\Core\Entity\ContentEntityForm;
11
use Drupal\Core\Entity\EntityConstraintViolationListInterface;
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 17 18
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\language\ConfigurableLanguageManagerInterface;
use Drupal\user\Plugin\LanguageNegotiation\LanguageNegotiationUser;
19
use Drupal\user\Plugin\LanguageNegotiation\LanguageNegotiationUserAdmin;
20
use Symfony\Component\DependencyInjection\ContainerInterface;
21 22 23 24

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

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

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

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

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

68
  /**
69
   * {@inheritdoc}
70
   */
71
  public function form(array $form, FormStateInterface $form_state) {
72
    /** @var \Drupal\user\UserInterface $account */
73
    $account = $this->entity;
74
    $user = $this->currentUser();
75
    $config = \Drupal::config('user.settings');
76
    $form['#cache']['tags'] = $config->getCacheTags();
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
    );

    // 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,
105
      '#description' => $this->t("Several special characters are allowed, including space, period (.), hyphen (-), apostrophe ('), underscore (_), and the @ sign."),
106 107 108 109 110 111 112 113 114
      '#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
      // The user must enter their current password to change to a new one.
135
      if ($user->id() == $account->id()) {
136 137
        $form['account']['current_pass'] = array(
          '#type' => 'password',
138
          '#title' => $this->t('Current password'),
139
          '#size' => 25,
140
          '#access' => !$form_state->get('user_pass_reset'),
141
          '#weight' => -5,
142 143 144
          // 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.
145 146
          '#attributes' => array('autocomplete' => 'off'),
        );
147
        $form_state->set('user', $account);
148 149 150 151

        // The user may only change their own password without their current
        // password if they logged in via a one-time login link.
        if (!$form_state->get('user_pass_reset')) {
152
          $form['account']['current_pass']['#description'] = $this->t('Required if you want to change the %mail or %pass below. <a href=":request_new_url" title="Send password reset instructions via email.">Reset your password</a>.', array(
153 154
            '%mail' => $form['account']['mail']['#title'],
            '%pass' => $this->t('Password'),
155
            ':request_new_url' => $this->url('user.pass'),
156 157
          ));
        }
158 159
      }
    }
160
    elseif (!$config->get('verify_mail') || $admin) {
161 162 163
      $form['account']['pass'] = array(
        '#type' => 'password_confirm',
        '#size' => 25,
164
        '#description' => $this->t('Provide a password for the new account in both fields.'),
165 166 167 168
        '#required' => TRUE,
      );
    }

169 170 171 172 173 174 175 176 177 178
    // 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';
        }
      }
    }

179 180
    if ($admin || !$register) {
      $status = $account->get('status')->value;
181 182
    }
    else {
183
      $status = $config->get('register') == USER_REGISTER_VISITORS ? 1 : 0;
184 185 186 187
    }

    $form['account']['status'] = array(
      '#type' => 'radios',
188
      '#title' => $this->t('Status'),
189
      '#default_value' => $status,
190
      '#options' => array($this->t('Blocked'), $this->t('Active')),
191 192 193
      '#access' => $admin,
    );

194
    $roles = array_map(array('\Drupal\Component\Utility\Html', 'escape'), user_role_names(TRUE));
195 196 197

    $form['account']['roles'] = array(
      '#type' => 'checkboxes',
198
      '#title' => $this->t('Roles'),
199
      '#default_value' => (!$register ? $account->getRoles() : array()),
200
      '#options' => $roles,
201
      '#access' => $roles && $user->hasPermission('administer permissions'),
202 203 204
    );

    // Special handling for the inevitable "Authenticated user" role.
205
    $form['account']['roles'][RoleInterface::AUTHENTICATED_ID] = array(
206 207
      '#default_value' => TRUE,
      '#disabled' => TRUE,
208 209 210 211
    );

    $form['account']['notify'] = array(
      '#type' => 'checkbox',
212
      '#title' => $this->t('Notify user of new account'),
213 214 215
      '#access' => $register && $admin,
    );

216
    $user_preferred_langcode = $register ? $language_interface->getId() : $account->getPreferredLangcode();
217

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

220 221
    // Is the user preferred language added?
    $user_language_added = FALSE;
222 223
    if ($this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $negotiator = $this->languageManager->getNegotiator();
224
      $user_language_added = $negotiator && $negotiator->isNegotiationMethodEnabled(LanguageNegotiationUser::METHOD_ID, LanguageInterface::TYPE_INTERFACE);
225
    }
226
    $form['language'] = array(
227
      '#type' => $this->languageManager->isMultilingual() ? 'details' : 'container',
228
      '#title' => $this->t('Language settings'),
229
      '#open' => TRUE,
230 231
      // Display language selector when either creating a user on the admin
      // interface or editing a user account.
232
      '#access' => !$register || $user->hasPermission('administer users'),
233
    );
234

235 236
    $form['language']['preferred_langcode'] = array(
      '#type' => 'language_select',
237
      '#title' => $this->t('Site language'),
238
      '#languages' => LanguageInterface::STATE_CONFIGURABLE,
239
      '#default_value' => $user_preferred_langcode,
240
      '#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."),
241 242 243 244
      // 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']],
245
    );
246

247 248 249
    // 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;
250 251 252
    if ($account->hasPermission('access administration pages') && $this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $negotiator = $this->languageManager->getNegotiator();
      $show_admin_language = $negotiator && $negotiator->isNegotiationMethodEnabled(LanguageNegotiationUserAdmin::METHOD_ID);
253
    }
254 255
    $form['language']['preferred_admin_langcode'] = array(
      '#type' => 'language_select',
256
      '#title' => $this->t('Administration pages language'),
257
      '#languages' => LanguageInterface::STATE_CONFIGURABLE,
258
      '#default_value' => $user_preferred_admin_langcode,
259
      '#access' => $show_admin_language,
260 261
      '#empty_option' => $this->t('- No preference -'),
      '#empty_value' => '',
262
    );
263

264 265 266 267
    // 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
268 269 270 271
    // 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'];
272 273 274 275

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

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  /**
   * 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) {
306
    $user->getUntranslated()->langcode = $user->preferred_langcode;
307 308
  }

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

319 320
    if (is_string(key($form_state->getValue('roles')))) {
      $form_state->setValue('roles', array_keys(array_filter($form_state->getValue('roles'))));
321
    }
322 323 324 325 326 327 328 329 330 331

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

    // 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;
      }
    }
332 333

    // Set existing password if set in the form state.
334 335
    $current_pass = trim($form_state->getValue('current_pass'));
    if (strlen($current_pass) > 0) {
336 337 338
      $account->setExistingPassword($current_pass);
    }

339 340 341 342
    // Skip the protected user field constraint if the user came from the
    // password recovery page.
    $account->_skipProtectedUserFieldConstraint = $form_state->get('user_pass_reset');

343
    return $account;
344 345
  }

346
  /**
347
   * {@inheritdoc}
348
   */
349 350 351 352 353 354 355 356 357 358 359
  protected function getEditedFieldNames(FormStateInterface $form_state) {
    return array_merge(array(
      'name',
      'pass',
      'mail',
      'timezone',
      'langcode',
      'preferred_langcode',
      'preferred_admin_langcode'
    ), parent::getEditedFieldNames($form_state));
  }
360

361 362 363 364 365 366 367
  /**
   * {@inheritdoc}
   */
  protected function flagViolations(EntityConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
    // Manually flag violations of fields not handled by the form display. This
    // is necessary as entity form displays only flag violations for fields
    // contained in the display.
368 369
    $field_names = array(
      'name',
370
      'pass',
371 372 373 374 375 376
      'mail',
      'timezone',
      'langcode',
      'preferred_langcode',
      'preferred_admin_langcode'
    );
377 378 379
    foreach ($violations->getByFields($field_names) as $violation) {
      list($field_name) = explode('.', $violation->getPropertyPath(), 2);
      $form_state->setErrorByName($field_name, $violation->getMessage());
380
    }
381
    parent::flagViolations($violations, $form, $form_state);
382
  }
383

384 385 386
  /**
   * {@inheritdoc}
   */
387 388
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
389 390 391 392 393 394 395 396

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