realname.module 5.32 KB
Newer Older
1
<?php
2

3 4 5 6 7 8 9 10 11 12 13 14 15
/**
 * @file
 * Provides token-based name displays for users.
 *
 * @todo Alter the username autocomplete
 * @todo Allow users to login with their real name
 * @todo Disable the username field
 * @todo Allow users to override their real name
 */

/**
 * @defgroup realname Real name API
 */
16 17

/**
18
 * Implements hook_permission().
19
 */
20 21 22 23 24 25
function realname_permission() {
  $permissions['administer realname'] = array(
    'title' => t('Administer Real Name configuration.'),
  );
  return $permissions;
}
26

27
/**
28
 * Implements hook_menu().
29
 */
30 31 32 33 34 35 36 37
function realname_menu() {
  $items['admin/config/people/realname'] = array(
    'title' => 'Real name',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('realname_settings_form'),
    'access arguments' => array('administer realname'),
    'file' => 'realname.admin.inc',
  );
38

39
  return $items;
40 41
}

42
/**
43
 * Implements hook_username_alter().
44
 */
45 46
function realname_username_alter(&$name, stdClass $account) {
  static $in_username_alter = FALSE;
47

48 49
  if (isset($account->realname)) {
    $name = $account->realname;
50
  }
51 52 53 54 55 56
  elseif (!$in_username_alter) {
    // Because realname tokens may execute format_username() we need to prevent
    // recursion from happening.
    $in_username_alter = TRUE;
    if ($realname = realname_load($account)) {
      $name = $realname;
57
    }
58
    $in_username_alter = FALSE;
59
  }
60 61 62
}

/**
63
 * Implements hook_user_load().
64
 */
65 66 67 68
function realname_user_load(array $accounts) {
  $realnames = realname_load_multiple($accounts);
  foreach ($realnames as $uid => $realname) {
    $accounts[$uid]->realname = $realname;
69 70 71 72
  }
}

/**
73
 * Implements hook_user_update().
74
 */
75 76 77
function realname_user_update(array &$edit, stdClass $account, $category) {
  // Since user data may have changed, delete the existing realname.
  realname_delete($account->uid);
78 79
}

80 81 82 83 84 85
/**
 * Implements hook_user_delete().
 */
function realname_user_delete(stdClass $account) {
  realname_delete($account->uid);
}
86

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
/**
 * Implements hook_user_operations().
 */
function realname_user_operations() {
  $operations['realname_update'] = array(
    'label' => t('Update real name'),
    'callback' => 'realname_user_operations_realname_update',
  );
  return $operations;
}

/**
 * Callback function for admin mass generating user real names.
 *
 * @param $uids
 *   An array of user IDs.
 */
function realname_user_operations_realname_update(array $uids) {
  $accounts = user_load_multiple($uids);
  foreach ($accounts as $account) {
    realname_update($account);
  }
}

/**
 * @addtogroup realname
 * @{
 */

116
/**
117
 * Loads a real name.
118
 *
119 120
 * @param $uid
 *   A user account object.
121
 * @return
122
 *   The user's generated real name.
123
 */
124 125 126 127
function realname_load(stdClass $account) {
  $realnames = realname_load_multiple(array($account->uid => $account));
  return reset($realnames);
}
128

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
/**
 * Loads multiple real names.
 *
 * @param $accounts
 *   An array of user account objects keyed by user ID.
 * @return
 *   An array of real names keyed by user ID.
 */
function realname_load_multiple(array $accounts) {
  $realnames = &drupal_static(__FUNCTION__, array());

  if ($new_accounts = array_diff_key($accounts, $realnames)) {
    // Attempt to fetch realnames from the database first.
    $realnames += db_query("SELECT uid, realname FROM {realname} WHERE uid IN (:uids)", array(':uids' => array_keys($new_accounts)))->fetchAllKeyed();

    // For each account that was not present in the database, generate its
    // real name.
    foreach ($new_accounts as $uid => $account) {
      if (!isset($realnames[$uid]) || !drupal_strlen($realnames[$uid])) {
148
        $realnames[$uid] = realname_update($account);
149
      }
150
    }
151 152
  }

153
  return array_intersect_key($realnames, $accounts);
154 155
}

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/**
 * Update the realname for a user account.
 *
 * @param $account
 *   A user account object.
 *
 * @see hook_realname_pattern_alter()
 * @see hook_realname_alter()
 * @see hook_realname_update()
 */
function realname_update($account) {
  // Get the default pattern and allow other modules to alter it.
  $pattern = variable_get('realname_pattern', '[user:name-raw]');
  drupal_alter('realname_pattern', $pattern, $account);

  // Perform token replacement on the real name pattern.
  $realname = token_replace($pattern, array('user' => $account), array('clear' => TRUE));
  $realname = trim($realname);

  // Allow other modules to alter the generated realname.
  drupal_alter('realname', $realname, $account);

  // Save to the database and the static cache.
  db_merge('realname')
    ->key(array('uid' => $account->uid))
    ->fields(array(
      'realname' => $realname,
      'created' => REQUEST_TIME,
    ))
    ->execute();

  // Allow modules to react to the realname being updated.
  module_invoke_all('realname_update', $realname, $account);

  $account->realname = $realname;
  return $realname;
}

194
/**
195
 * Delete a real name.
196
 *
197 198
 * @param $uid
 *   A user ID.
199
 */
200 201
function realname_delete($uid) {
  return realname_delete_multiple(array($uid));
202 203 204
}

/**
205 206 207 208
 * Delete multiple real names.
 *
 * @param $uids
 *   An array of user IDs.
209
 */
210 211 212
function realname_delete_multiple(array $uids) {
  db_delete('realname')->condition('uid', $uids, 'IN')->execute();
  drupal_static_reset('realname_load_multiple');
213 214 215
}

/**
216
 * Delete all real names.
217
 */
218 219 220
function realname_delete_all() {
  db_delete('realname')->execute();
  drupal_static_reset('realname_load_multiple');
221
}
222 223 224 225

/**
 * @} End of "addtogroup realname".
 */