class LdapAuthenticationAdminForm in Lightweight Directory Access Protocol (LDAP) 8.4

Same name and namespace in other branches

8.3 ldap_authentication/src/Form/LdapAuthenticationAdminForm.php \Drupal\ldap_authentication\Form\LdapAuthenticationAdminForm

Provides the form for ldap_authentication options.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\ldap_authentication\Form\LdapAuthenticationAdminForm

Expanded class hierarchy of LdapAuthenticationAdminForm

1 string reference to 'LdapAuthenticationAdminForm'

ldap_authentication.routing.yml in ldap_authentication/ldap_authentication.routing.yml: ldap_authentication/ldap_authentication.routing.yml

File

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

Namespace

Drupal\ldap_authentication\Form

View source

class LdapAuthenticationAdminForm extends ConfigFormBase {

  /**
   * Module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandler
   */
  protected $moduleHandler;

  /**
   * Storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * Entity Type Manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'ldap_authentication_admin_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() : array {
    return [
      'ldap_authentication.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandler $module_handler, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
    $this->entityTypeManager = $entity_type_manager;
    $this->storage = $entity_type_manager
      ->getStorage('ldap_server');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : LdapAuthenticationAdminForm {
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  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;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) : void {
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) : void {

    // Add form data to object and save or create.
    $values = $form_state
      ->getValues();
    $this
      ->config('ldap_authentication.settings')
      ->set('authenticationMode', $values['authenticationMode'])
      ->set('skipAdministrators', $values['skipAdministrators'])
      ->set('sids', $values['authenticationServers'])
      ->set('allowOnlyIfTextInDn', self::linesToArray($values['allowOnlyIfTextInDn']))
      ->set('excludeIfTextInDn', self::linesToArray($values['excludeIfTextInDn']))
      ->set('loginUIUsernameTxt', $values['loginUIUsernameTxt'])
      ->set('loginUIPasswordTxt', $values['loginUIPasswordTxt'])
      ->set('ldapUserHelpLinkUrl', $values['ldapUserHelpLinkUrl'])
      ->set('ldapUserHelpLinkText', $values['ldapUserHelpLinkText'])
      ->set('excludeIfNoAuthorizations', $values['excludeIfNoAuthorizations'])
      ->set('emailOption', $values['emailOption'])
      ->set('emailUpdate', $values['emailUpdate'])
      ->set('emailTemplateHandling', $values['emailTemplateHandling'])
      ->set('emailTemplate', $values['emailTemplate'])
      ->set('emailTemplateUsageResolveConflict', $values['templateUsageResolveConflict'])
      ->set('emailTemplateUsageNeverUpdate', $values['templateUsageNeverUpdate'])
      ->set('emailTemplateUsagePromptUser', $values['templateUsagePromptUser'])
      ->set('emailTemplateUsageRedirectOnLogin', $values['templateUsageRedirectOnLogin'])
      ->set('emailTemplateUsagePromptRegex', $values['templateUsagePromptRegex'])
      ->set('passwordOption', $values['passwordOption'])
      ->save();
    $this
      ->messenger()
      ->addMessage($this
      ->t('Settings updated.'));
  }

  /**
   * Helper function to convert array to serialized lines.
   *
   * Also used in ldap_sso, thus public.
   *
   * @param string $lines
   *   Serialized lines.
   *
   * @return array
   *   Deserialized content.
   */
  public static function linesToArray(string $lines) : array {
    $lines = trim($lines);
    $splitLines = [];
    if ($lines) {
      $splitLines = preg_split('/[\\n\\r]+/', $lines);
      if ($splitLines !== FALSE) {
        foreach ($splitLines as $i => $value) {
          $splitLines[$i] = trim($value);
        }
      }
    }
    return $splitLines;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LdapAuthenticationAdminForm::$entityTypeManager	protected	property	Entity Type Manager.
LdapAuthenticationAdminForm::$moduleHandler	protected	property	Module handler.
LdapAuthenticationAdminForm::$storage	protected	property	Storage.
LdapAuthenticationAdminForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LdapAuthenticationAdminForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
LdapAuthenticationAdminForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LdapAuthenticationAdminForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LdapAuthenticationAdminForm::linesToArray	public static	function	Helper function to convert array to serialized lines.
LdapAuthenticationAdminForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
LdapAuthenticationAdminForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
LdapAuthenticationAdminForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class LdapAuthenticationAdminForm in Lightweight Directory Access Protocol (LDAP) 8.4

Hierarchy

File

Namespace

Members

API Navigation