public function LdapAuthenticationAdminForm::buildForm in Lightweight Directory Access Protocol (LDAP) 8.4

Same name and namespace in other branches

1. 8.3 ldap_authentication/src/Form/LdapAuthenticationAdminForm.php \Drupal\ldap_authentication\Form\LdapAuthenticationAdminForm::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

ldap_authentication/src/Form/LdapAuthenticationAdminForm.php, line 84

Class

LdapAuthenticationAdminForm

Provides the form for ldap_authentication options.

Namespace

Drupal\ldap_authentication\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) : array {
  $config = $this
    ->config('ldap_authentication.settings');
  $query_result = $this->storage
    ->getQuery()
    ->execute();

  /** @var \Drupal\ldap_servers\Entity\Server[] $servers */
  $servers = $this->storage
    ->loadMultiple($query_result);
  $authenticationServers = [];
  foreach ($servers as $sid => $ldap_server) {
    $authenticationServers[$sid] = sprintf('%s (%s) Status: %s', $ldap_server
      ->get('label'), $ldap_server
      ->get('address'), $ldap_server
      ->get('status') ? 'Enabled' : 'Disabled');
  }
  if (count($authenticationServers) === 0) {
    $url = Url::fromRoute('entity.ldap_server.collection');
    $edit_server_link = Link::fromTextAndUrl($this
      ->t('@path', [
      '@path' => 'LDAP Servers',
    ]), $url)
      ->toString();
    $this
      ->messenger()
      ->addWarning($this
      ->t('At least one LDAP server must configured and <em>enabled</em> before configuring LDAP authentication. Please go to @link to configure an LDAP server.', [
      '@link' => $edit_server_link,
    ]));
    return $form;
  }
  $form['intro'] = [
    '#type' => 'item',
    '#markup' => $this
      ->t('<h1>LDAP Authentication Settings</h1>'),
  ];
  $form['logon'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Logon Options'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  ];
  $form['logon']['authenticationMode'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Allowable Authentications'),
    '#required' => TRUE,
    '#default_value' => $config
      ->get('authenticationMode'),
    '#options' => [
      'mixed' => $this
        ->t('Mixed mode: Drupal authentication is tried first. On failure, LDAP authentication is performed.'),
      'exclusive' => $this
        ->t('Exclusive mode: Only LDAP Authentication is allowed.'),
    ],
    '#description' => $this
      ->t('If exclusive is selected: <br> (1) reset password links will be replaced with links to LDAP end user documentation below.<br>
        (2) The reset password form will be left available at user/password for administrators; but no links to it will be provided to anonymous users.<br>
        (3) Password fields in user profile form will be removed except for administrators.'),
  ];
  $admin_roles = $this->entityTypeManager
    ->getStorage('user_role')
    ->getQuery()
    ->condition('is_admin', TRUE)
    ->execute();
  $form['logon']['skipAdministrators'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Exclude members of the administrative group from LDAP authentication'),
    '#default_value' => $config
      ->get('skipAdministrators'),
    '#description' => $this
      ->t('Members in the group(s) "@groups" will not be able to log in with LDAP', [
      '@groups' => implode(', ', $admin_roles),
    ]),
  ];
  $form['logon']['authenticationServers'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Authentication LDAP Server Configurations'),
    '#required' => FALSE,
    '#default_value' => $config
      ->get('sids'),
    '#options' => $authenticationServers,
    '#description' => $this
      ->t('Check all LDAP server configurations to use in authentication.
     Each will be tested for authentication until successful or
     until each is exhausted.  In most cases only one server configuration is selected.'),
  ];
  $form['login_UI'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('User Login Interface'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  ];
  $form['login_UI']['loginUIUsernameTxt'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Username Description Text'),
    '#required' => FALSE,
    '#default_value' => $config
      ->get('loginUIUsernameTxt'),
    '#description' => $this
      ->t('Text to be displayed to user below the username field of the user login screen.'),
  ];
  $form['login_UI']['loginUIPasswordTxt'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Password Description Text'),
    '#required' => FALSE,
    '#default_value' => $config
      ->get('loginUIPasswordTxt'),
    '#description' => $this
      ->t('Text to be displayed to user below the password field of the user login screen.'),
  ];
  $form['login_UI']['ldapUserHelpLinkUrl'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('LDAP Account User Help URL'),
    '#required' => FALSE,
    '#default_value' => $config
      ->get('ldapUserHelpLinkUrl'),
    '#description' => $this
      ->t('URL to LDAP user help/documentation for users resetting
     passwords etc. Should be of form http://domain.com/. Could be the institutions LDAP password support page
     or a page within this Drupal site that is available to anonymous users.'),
  ];
  $form['login_UI']['ldapUserHelpLinkText'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('LDAP Account User Help Link Text'),
    '#required' => FALSE,
    '#default_value' => $config
      ->get('ldapUserHelpLinkText'),
    '#description' => $this
      ->t('Text for above link e.g. Account Help or Campus Password Help Page'),
  ];
  $form['restrictions'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('LDAP User "Whitelists" and Restrictions'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  ];
  $form['restrictions']['allowOnlyIfTextInDn'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Allow Only Text Test'),
    '#default_value' => is_array($config
      ->get('allowOnlyIfTextInDn')) ? implode("\n", $config
      ->get('allowOnlyIfTextInDn')) : '',
    '#cols' => 50,
    '#rows' => 3,
    '#description' => $this
      ->t("A list of text such as ou=education or cn=barclay that at least one of be found in user's DN string. Enter one per line such as <pre>ou=education<br>ou=engineering</pre> This test will be case insensitive."),
  ];
  $form['restrictions']['excludeIfTextInDn'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Excluded Text Test'),
    '#default_value' => implode("\n", $config
      ->get('excludeIfTextInDn')),
    '#cols' => 50,
    '#rows' => 3,
    '#description' => $this
      ->t("A list of text such as ou=evil or cn=bad that if found in a user's DN, exclude them from LDAP authentication. Enter one per line such as <pre>ou=evil<br>cn=bad</pre> This test will be case insensitive."),
  ];
  $form['restrictions']['excludeIfNoAuthorizations'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Deny access to users without LDAP Authorization Module
        authorization mappings such as Drupal roles.
        Requires LDAP Authorization to be enabled and configured!'),
    '#default_value' => $config
      ->get('excludeIfNoAuthorizations'),
    '#description' => $this
      ->t('If the user is not granted any Drupal roles, organic groups, etc. by LDAP Authorization, login will be denied.  LDAP Authorization must be enabled for this to work.'),
    '#disabled' => !$this->moduleHandler
      ->moduleExists('ldap_authorization'),
  ];
  $form['email'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Email'),
  ];
  $form['email']['emailOption'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Email Behavior'),
    '#required' => TRUE,
    '#default_value' => $config
      ->get('emailOption'),
    '#options' => [
      'remove' => $this
        ->t("Don't show an email field on user forms. LDAP derived email will be used for user and cannot be changed by user."),
      'disable' => $this
        ->t('Show disabled email field on user forms with LDAP derived email. LDAP derived email will be used for user and cannot be changed by user.'),
      'allow' => $this
        ->t('Leave email field on user forms enabled. Generally used when provisioning to LDAP or not using email derived from LDAP.'),
    ],
  ];
  $form['email']['emailUpdate'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Email Update'),
    '#required' => TRUE,
    '#default_value' => $config
      ->get('emailUpdate'),
    '#options' => [
      'update_notify' => $this
        ->t('Update stored email if LDAP email differs at login and notify user.'),
      'update' => $this
        ->t("Update stored email if LDAP email differs at login but don't notify user."),
      'no_update' => $this
        ->t("Don't update stored email if LDAP email differs at login."),
    ],
  ];
  $form['email']['template'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Email Templates'),
  ];
  $form['email']['template']['emailTemplateHandling'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Email Template Handling'),
    '#required' => TRUE,
    '#default_value' => $config
      ->get('emailTemplateHandling'),
    '#options' => [
      'none' => $this
        ->t('Never use the template.'),
      'if_empty' => $this
        ->t('Use the template if no email address was provided by the LDAP server.'),
      'always' => $this
        ->t('Always use the template.'),
    ],
  ];
  $form['email']['template']['emailTemplate'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Email Template'),
    '#description' => $this
      ->t("This is a pattern in the form of <em>@username@yourdomain.com</em>. <br>Note that the <em>@username</em> placeholder including the '@' will be replaced with the actual username."),
    '#required' => FALSE,
    '#default_value' => $config
      ->get('emailTemplate'),
  ];
  $form['email']['template']['templateUsageResolveConflict'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('If a Drupal account already exists with the same email, but different account name, use the email template instead of the LDAP email.'),
    '#default_value' => $config
      ->get('emailTemplateUsageResolveConflict'),
  ];
  $form['email']['template']['templateUsageNeverUpdate'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Ignore the Email Update settings and never update the stored email if the template is used.'),
    '#default_value' => $config
      ->get('emailTemplateUsageNeverUpdate'),
  ];
  $form['email']['prompts'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('User Email Prompt'),
    '#description' => $this
      ->t('These settings allow the user to fill in their email address after logging in if the template was used to generate their email address.'),
  ];
  $form['email']['prompts']['templateUsagePromptUser'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Prompt user for email on every page load.'),
    '#default_value' => $config
      ->get('emailTemplateUsagePromptUser'),
  ];
  $form['email']['prompts']['templateUsageRedirectOnLogin'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Redirect the user to the form after logging in.'),
    '#default_value' => $config
      ->get('emailTemplateUsageRedirectOnLogin'),
  ];
  $form['email']['prompts']['templateUsagePromptRegex'] = [
    '#type' => 'textfield',
    '#default_value' => $config
      ->get('emailTemplateUsagePromptRegex'),
    '#title' => $this
      ->t('Template Regex'),
    '#description' => $this
      ->t('This regex will be used to determine if the template was used to create an account.'),
  ];
  $form['password'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Password'),
  ];
  $form['password']['passwordOption'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Password Behavior'),
    '#required' => TRUE,
    '#default_value' => $config
      ->get('passwordOption'),
    '#options' => [
      'disable' => $this
        ->t('Display password field disabled (prevents password updates, password reset disabled).'),
      'hide' => $this
        ->t("Don't show password field on user forms except login form (prevents password updates, password reset disabled)."),
      'allow' => $this
        ->t('Display password field and allow updating it (including password reset). In order to change password in LDAP, LDAP provisioning for this field must be enabled.'),
    ],
  ];
  $form['submit'] = [
    '#type' => 'submit',
    '#value' => 'Save',
  ];
  return $form;
}