realname_registration.module in Realname registration 7.2

For using real names during registration/

The realname_registration allows usernames to be generated based upon required first name and last name fields on the registration form.

File

realname_registration.module

<?php

/**
 * @file
 * For using real names during registration/
 *
 * The realname_registration allows usernames to be generated based upon
 * required first name and last name fields on the registration form.
 */

/*
  TODO:
  - provide internal functions which determine first, middle, and last names
    to use
  - provide internal function to generate username so that validation
    functions can check username length
*/

/**
 * Implement hook_help().
 */
function realname_registration_help($path, $arg) {
  switch ($path) {
    case 'admin/help#realname_registration':
      $output = '<h3>' . t('Realname registration') . '</h3>';
      $output .= '<h4>' . t('Summary') . '</h4>';
      $output .= '<p>' . t('Usernames are made of a combination of the first name, middle name, and last name field. The values will be stored in your provided user fields.') . '</p>';
      $output .= '<h4>' . t('Settings') . '</h4>';
      $output .= '<dl>';
      $output .= '<dt><strong>' . t('Using the core Profile module') . '</strong></dt>';
      $output .= '<dd>' . t('(If you already have these fields, take note of the names and skip this step)') . '</dd>';
      $output .= '<dd>' . t('Navigate to <a href="../config/people/accounts/fields">admin/config/people/accounts/fields</a> and create a text field that will hold the user\'s first name.') . ' ';
      $output .= t('While editing the field, ensure that the Required field option is checked, also to Display on the registration form.') . ' ';
      $output .= t('Repeat this step for the last name field. The middle name field is optional, and does not need to be required. Be sure to take note of what you have named the new fields.') . '</dd>';
      $output .= '<dd><a href="../config/people/accounts/fields">' . t('Manage user fields') . ' &rarr;</a></dd>';
      if (module_exists('profile2')) {
        $output .= '<dt><strong>' . t('Using the Profile2 module') . '</strong></dt>';
        $output .= '<dd>' . t('If you have Profile2 installed, you will have additional fieldsets on the configuration page.') . ' ';
        $output .= t('Create your field names so that the first and last names are required. The middle name field is always optional.') . ' ';
        $output .= t('Ensure that your Profile2 type is used during registration.') . ' ';
        $output .= t('To use the fields in Realname registration, check the box saying use this module for storage and supply the machine name of the corresponding Profile2 type.') . '</dd>';
        $output .= '<dd><a href="../structure/profiles">' . t('Manage Profile2 types') . ' &rarr;</a></dd>';
      }
      $output .= '</dl>';
      $output .= '<dl>';
      $output .= '<dt><strong>' . t('Configure the Realname registration module') . '</strong></dt>';
      $output .= '<dd>' . t('Now that you have first name, middle name, and last name fields associated with your users, you can map these fields in Realname registration.') . ' ';
      $output .= t('Type the field names that you have created in the appropriate textfields, and select your other options and click Submit.') . '</dd>';
      $output .= '<dd><a href="../config/people/realname_registration">' . t('Configure Realname registration') . ' &rarr;</a></dd>';
      $output .= '</dl>';
      $output .= '<p><strong>' . t('Project resources') . '</strong></p>';
      $output .= '<ul>';
      $output .= '<li><a href="http://drupal.org/project/realname_registration">' . t('Project home') . '</a></li>';
      $output .= '<li><a href="http://drupal.org/node/1344864">' . t('Documentation') . '</a></li>';
      $output .= '<li><a href="http://drupal.org/project/issues/realname_registration?status=All&categories=All">' . t('Issue tracker') . '</a></li>';
      $output .= '</ul>';
      return $output;
  }
}

/**
 * Implementation of hook_form_alter().
 */
function realname_registration_form_alter(&$form, $form_state, $form_id) {
  if (!($form_id == 'user_register_form')) {
    return;
  }
  if (isset($form['account']) && is_array($form['account'])) {
    $form['account']['name']['#type'] = 'hidden';
    $form['account']['name']['#value'] = 'unset_username';
  }
  else {
    $form['name']['#type'] = 'hidden';
    $form['name']['#value'] = 'unset_username';
  }
  $form['#validate'][] = 'realname_registration_mandatory_validate';
  if (variable_get('realname_registration_use_validation')) {
    $form['#validate'][] = 'realname_registration_validate';
  }
}

/**
 * Implementation of hook_user_presave().
 */
function realname_registration_user_presave(&$edit, $account, $category) {
  if (isset($edit['name'])) {
    if ($edit['name'] == 'unset_username') {
      $firstname_field = variable_get('realname_registration_firstname_field');
      $middlename_field = variable_get('realname_registration_middlename_field');
      $lastname_field = variable_get('realname_registration_lastname_field');
      $firstname_type = variable_get('realname_registration_profile2_firstname_field_profile_name');
      $middlename_type = variable_get('realname_registration_profile2_middlename_field_profile_name');
      $lastname_type = variable_get('realname_registration_profile2_lastname_field_profile_name');
      if (variable_get('realname_registration_ucfirst')) {
        if (variable_get('realname_registration_use_profile2_firstname_field')) {
          $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'] = drupal_ucfirst($edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value']);
        }
        else {
          $edit[$firstname_field][LANGUAGE_NONE][0]['value'] = drupal_ucfirst($edit[$firstname_field][LANGUAGE_NONE][0]['value']);
        }
        if (variable_get('realname_registration_use_profile2_middlename_field')) {
          if (!empty($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'])) {
            $edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'] = drupal_ucfirst($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value']);
          }
        }
        else {
          if (!empty($edit[$middlename_field][LANGUAGE_NONE][0]['value'])) {
            $edit[$middlename_field][LANGUAGE_NONE][0]['value'] = drupal_ucfirst($edit[$middlename_field][LANGUAGE_NONE][0]['value']);
          }
        }
        if (variable_get('realname_registration_use_profile2_lastname_field')) {
          $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'] = drupal_ucfirst($edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value']);
        }
        else {
          $edit[$lastname_field][LANGUAGE_NONE]['0']['value'] = drupal_ucfirst($edit[$lastname_field][LANGUAGE_NONE][0]['value']);
        }
      }

      // Generate the username based on first name and last name fields.
      switch (variable_get('realname_registration_format')) {
        case 0:

          // Create username based on first name and last name (e.g., John Smith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          $username .= ' ';
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 1:

          // Create username based on first initial and last name (e.g., JSmith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = drupal_substr($edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          else {
            $username = drupal_substr($edit[$firstname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 2:

          // Create username based on first name, middle name, and last name (e.g., John Jacob Smith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          $username .= ' ';
          if (variable_get('realname_registration_use_profile2_middlename_field')) {
            if (!empty($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= $edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'];
              $username .= ' ';
            }
          }
          else {
            if (!empty($edit[$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= $edit[$middlename_field][LANGUAGE_NONE][0]['value'];
              $username .= ' ';
            }
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 3:

          // Create username based on first name, middle initial, and last name (e.g., John J Smith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          $username .= ' ';
          if (variable_get('realname_registration_use_profile2_middlename_field')) {
            if (!empty($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= drupal_substr($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'], 0, 1);
              $username .= ' ';
            }
          }
          else {
            if (!empty($edit[$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= drupal_substr($edit[$middlename_field][LANGUAGE_NONE][0]['value'], 0, 1);
              $username .= ' ';
            }
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 4:

          // Create username based on first initial, middle initial, and last name (e.g., JJSmith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = drupal_substr($edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          else {
            $username = drupal_substr($edit[$firstname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          if (variable_get('realname_registration_use_profile2_middlename_field')) {
            if (!empty($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= drupal_substr($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'], 0, 1);
            }
          }
          else {
            if (!empty($edit[$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= drupal_substr($edit[$middlename_field][LANGUAGE_NONE][0]['value'], 0, 1);
            }
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 5:

          // Create username based on first name and last name without spaces (e.g., JohnSmith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 6:

          // Create username based on first name, middle name, and last name without spaces (e.g., JohnJacobSmith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          if (variable_get('realname_registration_use_profile2_middlename_field')) {
            if (!empty($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= $edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'];
            }
          }
          else {
            if (!empty($edit[$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= $edit[$middlename_field][LANGUAGE_NONE][0]['value'];
            }
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 7:

          // Create username based on first name, middle initial, and last name without spaces (e.g., JohnJSmith).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          if (variable_get('realname_registration_use_profile2_middlename_field')) {
            if (!empty($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= drupal_substr($edit['profile_' . $middlename_type][$middlename_field][LANGUAGE_NONE][0]['value'], 0, 1);
            }
          }
          else {
            if (!empty($edit[$middlename_field][LANGUAGE_NONE][0]['value'])) {
              $username .= drupal_substr($edit[$middlename_field][LANGUAGE_NONE][0]['value'], 0, 1);
            }
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 8:

          // Create username based on last name and first name without spaces (e.g., SmithJohn).
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username = $edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$lastname_field][LANGUAGE_NONE][0]['value'];
          }
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username .= $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username .= $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          break;
        case 9:

          // Create username based on first name and last initial (e.g., JohnS).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= drupal_substr($edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          else {
            $username .= drupal_substr($edit[$lastname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          break;
        case 10:

          // Create username based on first name and last initial (e.g., John S).
          if (variable_get('realname_registration_use_profile2_firstname_field')) {
            $username = $edit['profile_' . $firstname_type][$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          else {
            $username = $edit[$firstname_field][LANGUAGE_NONE][0]['value'];
          }
          if (variable_get('realname_registration_use_profile2_lastname_field')) {
            $username .= ' ' . drupal_substr($edit['profile_' . $lastname_type][$lastname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          else {
            $username .= ' ' . drupal_substr($edit[$lastname_field][LANGUAGE_NONE][0]['value'], 0, 1);
          }
          break;
      }
      if (variable_get('realname_registration_tolower')) {
        $username = drupal_strtolower($username);
      }

      // Make sure username is at least 3 characters less than the maximum
      // length in the database schema to allow for adding digits in case of
      // duplicates
      if (drupal_strlen($username) > USERNAME_MAX_LENGTH - 3) {
        $username = drupal_substr($username, 0, USERNAME_MAX_LENGTH - 3);
      }

      // Check if the username already exists in the database.
      $result = db_query("SELECT name FROM {users} WHERE name = :username", array(
        ':username' => $username,
      ));

      // While the username is taken, append a number and increment it until our username is unique.
      $i = 0;
      while ($result
        ->rowCount()) {
        $result = db_query("SELECT name FROM {users} WHERE name = :username", array(
          ':username' => $username . ++$i,
        ));
        if (!$result
          ->rowCount()) {
          $username = $username . $i;
        }
      }
      $edit['name'] = $username;
    }
  }
}

/**
 * Form validation handler for user_register_form().
 *
 * @see user_register_form()
 * @see user_register_submit()
 */
function realname_registration_validate($form, &$form_state) {

  // A first name may not contain symbols or numbers.
  $firstname_field = variable_get('realname_registration_firstname_field', FALSE);
  if ($firstname_field) {
    $firstname = '';
    if (variable_get('realname_registration_use_profile2_firstname_field')) {
      $firstname = $form_state['input']['profile_' . variable_get('realname_registration_profile2_firstname_field_profile_name')][$firstname_field][LANGUAGE_NONE][0]['value'];
    }
    else {
      $firstname = $form_state['values'][$firstname_field][LANGUAGE_NONE][0]['value'];
    }
    if (!preg_match("/^[-\\pL' ]*\$/u", $firstname)) {
      form_set_error($firstname_field, t('First name may not contain symbols or numbers.'));
    }
  }

  // A middle name may not contain symbols or numbers.
  $middlename_field = variable_get('realname_registration_middlename_field', FALSE);
  if ($middlename_field) {
    $middlename = '';
    if (variable_get('realname_registration_use_profile2_middlename_field')) {
      $middlename = $form_state['input']['profile_' . variable_get('realname_registration_profile2_middlename_field_profile_name')][$middlename_field][LANGUAGE_NONE][0]['value'];
    }
    else {
      $middlename = $form_state['values'][$middlename_field][LANGUAGE_NONE][0]['value'];
    }
    if (!preg_match("/^[-\\pL' ]*\$/u", $middlename)) {
      form_set_error($middlename_field, t('First name may not contain symbols or numbers.'));
    }
  }

  // A last name may not contain symbols or numbers.
  $lastname_field = variable_get('realname_registration_lastname_field', FALSE);
  if ($lastname_field) {
    $lastname = '';
    if (variable_get('realname_registration_use_profile2_lastname_field')) {
      $lastname = $form_state['input']['profile_' . variable_get('realname_registration_profile2_lastname_field_profile_name')][$lastname_field][LANGUAGE_NONE][0]['value'];
    }
    else {
      $lastname = $form_state['values'][$lastname_field][LANGUAGE_NONE][0]['value'];
    }
    if (!preg_match("/^[-\\pL' ]*\$/u", $lastname)) {
      form_set_error($lastname_field, t('Last name may not contain symbols or numbers.'));
    }
  }
}

/**
 * Form validation handler for user_register_form().
 *
 * @see user_register_form()
 * @see user_register_submit()
 */
function realname_registration_mandatory_validate($form, &$form_state) {

  // Verify the syntax of the first name using core's validation function.
  $firstname_field = variable_get('realname_registration_firstname_field', FALSE);
  if ($firstname_field) {
    $firstname = '';
    if (variable_get('realname_registration_use_profile2_firstname_field')) {
      $firstname = $form_state['input']['profile_' . variable_get('realname_registration_profile2_firstname_field_profile_name')][$firstname_field][LANGUAGE_NONE][0]['value'];
    }
    else {
      $firstname = $form_state['values'][$firstname_field][LANGUAGE_NONE][0]['value'];
    }
    if ($err = user_validate_name($firstname)) {
      form_set_error($firstname_field, $err);
      drupal_set_message(t('Please supply a valid first name.'), 'error');
    }
  }

  // Verify the syntax of the middle name using core's validation function.
  $middlename_field = variable_get('realname_registration_middlename_field', FALSE);
  if ($middlename_field) {
    $middlename = '';
    if (variable_get('realname_registration_use_profile2_middlename_field')) {
      $middlename = $form_state['input']['profile_' . variable_get('realname_registration_profile2_middlename_field_profile_name')][$middlename_field][LANGUAGE_NONE][0]['value'];
    }
    else {
      $middlename = $form_state['values'][$middlename_field][LANGUAGE_NONE][0]['value'];
    }
    if ($middlename != '' && ($err = user_validate_name($middlename))) {
      form_set_error($middlename_field, $err);
      drupal_set_message(t('Please supply a valid middle name.'), 'error');
    }
  }

  // Verify the syntax of the last name using core's validation function.
  $lastname_field = variable_get('realname_registration_lastname_field', FALSE);
  if ($lastname_field) {
    $lastname = '';
    if (variable_get('realname_registration_use_profile2_lastname_field')) {
      $lastname = $form_state['input']['profile_' . variable_get('realname_registration_profile2_lastname_field_profile_name')][$lastname_field][LANGUAGE_NONE][0]['value'];
    }
    else {
      $lastname = $form_state['values'][$lastname_field][LANGUAGE_NONE][0]['value'];
    }
    if ($err = user_validate_name($lastname)) {
      form_set_error($lastname_field, $err);
      drupal_set_message(t('Please supply a valid last name.'), 'error');
    }
  }
}

/**
 * Implementation of hook_menu().
 */
function realname_registration_menu() {
  $items = array();
  $items['admin/config/people/realname_registration'] = array(
    'title' => 'Realname registration',
    'description' => 'Administer settings for Realname registration.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'realname_registration_settings_form',
    ),
    'access arguments' => array(
      'administer realname registration',
    ),
    'file' => 'realname_registration.admin.inc',
  );
  return $items;
}

/**
* Implementation of hook_permission().
*/
function realname_registration_permission() {
  return array(
    'administer realname registration' => array(
      'title' => t('Administer Realname registration'),
      'description' => t('Perform administration tasks for Realname registration.'),
    ),
  );
}

Functions

Name	Description
realname_registration_form_alter	Implementation of hook_form_alter().
realname_registration_help	Implement hook_help().
realname_registration_mandatory_validate	Form validation handler for user_register_form().
realname_registration_menu	Implementation of hook_menu().
realname_registration_permission	Implementation of hook_permission().
realname_registration_user_presave	Implementation of hook_user_presave().
realname_registration_validate	Form validation handler for user_register_form().