user.module 120 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3
<?php
// $Id$

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Enables the user registration and login system.
 */

9 10 11
define('USERNAME_MAX_LENGTH', 60);
define('EMAIL_MAX_LENGTH', 64);

Dries's avatar
Dries committed
12 13 14
/**
 * Invokes hook_user() in every module.
 *
15
 * We cannot use module_invoke() for this, because the arguments need to
Dries's avatar
Dries committed
16 17
 * be passed by reference.
 */
18
function user_module_invoke($type, &$array, &$user, $category = NULL) {
Dries's avatar
 
Dries committed
19 20
  foreach (module_list() as $module) {
    $function = $module .'_user';
21 22 23
    if (function_exists($function)) {
      $function($type, $array, $user, $category);
    }
Dries's avatar
 
Dries committed
24 25 26
  }
}

27 28 29 30 31 32 33 34 35
/**
 * Implementation of hook_theme()
 */
function user_theme() {
  return array(
    'user_picture' => array(
      'arguments' => array('account' => NULL),
    ),
    'user_profile' => array(
36 37 38 39 40 41 42 43 44 45
      'arguments' => array('account' => NULL),
      'file' => 'user_profile',
    ),
    'user_profile_category' => array(
      'arguments' => array('element' => NULL),
      'file' => 'user_profile_category',
    ),
    'user_profile_item' => array(
      'arguments' => array('element' => NULL),
      'file' => 'user_profile_item',
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    ),
    'user_list' => array(
      'arguments' => array('users' => NULL, 'title' => NULL),
    ),
    'user_admin_perm' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_admin_new_role' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_admin_account' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_filter_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_filters' => array(
      'arguments' => array('form' => NULL),
    ),
65 66 67
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
68 69 70
  );
}

Dries's avatar
 
Dries committed
71
function user_external_load($authname) {
Dries's avatar
 
Dries committed
72
  $result = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
73

74
  if ($user = db_fetch_array($result)) {
Dries's avatar
 
Dries committed
75
    return user_load($user);
Dries's avatar
 
Dries committed
76 77 78 79 80 81
  }
  else {
    return 0;
  }
}

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
/**
* Perform standard Drupal login operations for a user object.  The
* user object must already be authenticated. This function verifies
* that the user account is not blocked/denied and then performs the login,
* updates the login timestamp in the database, invokes hook_user('login'),
* regenerates the session, etc.
*
* @param $account
*    An authenticated user object to be set as the currently logged
*    in user.
* @return boolean
*    TRUE if the login succeeds, FALSE otherwise.
*/
function user_external_login($account) {
  $form = drupal_get_form('user_login');

  $state = array();
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
    return FALSE;
  }
  global $user;
  $user = $account;
  user_login_submit($form, $state, (array)$account);
  return TRUE;
}

Dries's avatar
Dries committed
109 110 111 112 113
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
114
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
115 116
 *
 * @return
117
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
Dries's avatar
Dries committed
118
 */
Dries's avatar
 
Dries committed
119
function user_load($array = array()) {
Dries's avatar
Dries committed
120
  // Dynamically compose a SQL query:
121
  $query = array();
122
  $params = array();
123

124 125 126 127
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }

Dries's avatar
 
Dries committed
128
  foreach ($array as $key => $value) {
129 130
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
131
      $params[] = $value;
132
    }
133 134 135 136
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
 
Dries committed
137
    else {
138
      $query[]= "LOWER($key) = LOWER('%s')";
139
      $params[] = $value;
Dries's avatar
 
Dries committed
140 141
    }
  }
142
  $result = db_query('SELECT * FROM {users} u WHERE '. implode(' AND ', $query), $params);
Dries's avatar
 
Dries committed
143

144 145 146
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
Dries's avatar
 
Dries committed
147

148
    $user->roles = array();
149 150 151 152 153 154
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
155 156 157 158
    $result = db_query('SELECT r.rid, r.name FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d', $user->uid);
    while ($role = db_fetch_object($result)) {
      $user->roles[$role->rid] = $role->name;
    }
159
    user_module_invoke('load', $array, $user);
160 161
  }
  else {
162
    $user = FALSE;
Dries's avatar
 
Dries committed
163
  }
Dries's avatar
 
Dries committed
164 165 166 167

  return $user;
}

168
/**
169
 * Save changes to a user account or add a new user.
170 171
 *
 * @param $account
172 173
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
174 175 176
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
177
 *   Setting a field to NULL deletes it from the data column.
178 179 180 181
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
182
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
183
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
184
  $user_fields = user_fields();
185
  if (is_object($account) && $account->uid) {
186
    user_module_invoke('update', $array, $account, $category);
187 188 189 190 191
    if (isset($array['status']) && $array['status'] != $account->status) {
      // The user's status is changing, conditionally send notification email.
      $op = $array['status'] == 1 ? 'status_activated' : 'status_blocked';
      _user_mail_notify($op, $account);
    }
192
    $query = '';
Dries's avatar
Dries committed
193
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
Dries's avatar
 
Dries committed
194
    foreach ($array as $key => $value) {
195
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
 
Dries committed
196 197
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
 
Dries committed
198
      }
199
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
200
        if (in_array($key, $user_fields)) {
201
          // Save standard fields
Dries's avatar
 
Dries committed
202 203
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
 
Dries committed
204
        }
Dries's avatar
 
Dries committed
205
        else if ($key != 'roles') {
206
          // Roles is a special case: it used below.
207
          if ($value === NULL) {
208 209 210 211 212
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
 
Dries committed
213
        }
Dries's avatar
 
Dries committed
214 215
      }
    }
216
    $query .= "data = '%s' ";
Dries's avatar
 
Dries committed
217
    $v[] = serialize($data);
Dries's avatar
 
Dries committed
218

219
    db_query("UPDATE {users} SET $query WHERE uid = %d", array_merge($v, array($account->uid)));
Dries's avatar
 
Dries committed
220

221
    // Reload user roles if provided
222
    if (isset($array['roles']) && is_array($array['roles'])) {
Dries's avatar
Dries committed
223
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $account->uid);
Dries's avatar
 
Dries committed
224

225
      foreach (array_keys($array['roles']) as $rid) {
226 227 228
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
        }
229
      }
Dries's avatar
 
Dries committed
230 231
    }

232
    // Delete a blocked user's sessions to kick them if they are online.
233
    if (isset($array['status']) && $array['status'] == 0) {
234
      sess_destroy_uid($account->uid);
235 236
    }

237 238 239 240 241 242 243
    // If the password changed, delete all open sessions and recreate
    // the current one.
    if (isset($array['pass'])) {
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

244
    // Refresh user object
Dries's avatar
 
Dries committed
245
    $user = user_load(array('uid' => $account->uid));
246
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
 
Dries committed
247 248
  }
  else {
249
    if (!isset($array['created'])) {    // Allow 'created' to be set by the caller
250 251 252
      $array['created'] = time();
    }

253 254 255
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there. We cannot invoke hook_user('insert') here
    // because we don't have a fully initialized user object yet.
Dries's avatar
 
Dries committed
256
    foreach ($array as $key => $value) {
257
      switch ($key) {
258 259 260
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
 
Dries committed
261
          $s[] = "'%s'";
Dries's avatar
Dries committed
262
          break;
263
        case 'mode':     case 'sort':
264 265 266 267 268 269 270 271 272 273 274 275 276
        case 'threshold':  case 'created':  case 'access':
        case 'login':      case 'status':
          $fields[] = $key;
          $values[] = $value;
          $s[] = "%d";
          break;
        default:
          if (substr($key, 0, 4) !== 'auth' && in_array($key, $user_fields)) {
            $fields[] = $key;
            $values[] = $value;
            $s[] = "'%s'";
          }
          break;
Dries's avatar
 
Dries committed
277 278
      }
    }
Dries's avatar
Dries committed
279
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
280
    $array['uid'] = db_last_insert_id('users', 'uid');
Dries's avatar
 
Dries committed
281

282 283
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
284

285 286 287 288 289
    user_module_invoke('insert', $array, $user, $category);

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
290
      if ((substr($key, 0, 4) !== 'auth') && ($key != 'roles') && (!in_array($key, $user_fields)) && ($value !== NULL)) {
291 292 293 294 295
        $data[$key] = $value;
      }
    }
    db_query("UPDATE {users} SET data = '%s' WHERE uid = %d", serialize($data), $user->uid);

296
    // Save user roles (delete just to be safe).
297
    if (isset($roles) && is_array($array['roles'])) {
298 299 300 301 302
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
      foreach (array_keys($array['roles']) as $rid) {
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
        }
303 304 305
      }
    }

306 307
    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
308 309
  }

310
  // Save distributed authentication mappings
311
  $authmaps = array();
Dries's avatar
 
Dries committed
312
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
313
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
 
Dries committed
314 315 316
      $authmaps[$key] = $value;
    }
  }
317
  if (sizeof($authmaps) > 0) {
Dries's avatar
 
Dries committed
318
    user_set_authmaps($user, $authmaps);
Dries's avatar
 
Dries committed
319 320 321 322 323
  }

  return $user;
}

Dries's avatar
Dries committed
324 325 326
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
327
function user_validate_name($name) {
328
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
329 330
  if (substr($name, 0, 1) == ' ') return t('The username cannot begin with a space.');
  if (substr($name, -1) == ' ') return t('The username cannot end with a space.');
331
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
332
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
333 334 335 336 337 338 339
  if (preg_match('/[\x{80}-\x{A0}'.          // Non-printable ISO-8859-1 + NBSP
                   '\x{AD}'.                 // Soft-hyphen
                   '\x{2000}-\x{200F}'.      // Various space characters
                   '\x{2028}-\x{202F}'.      // Bidirectional text overrides
                   '\x{205F}-\x{206F}'.      // Various text hinting characters
                   '\x{FEFF}'.               // Byte order mark
                   '\x{FF01}-\x{FF60}'.      // Full-width latin
340 341
                   '\x{FFF9}-\x{FFFD}'.      // Replacement characters
                   '\x{0}]/u',               // NULL byte
342 343 344
                   $name)) {
    return t('The username contains an illegal character.');
  }
345
  if (strpos($name, '@') !== FALSE && !eregi('@([0-9a-z](-?[0-9a-z])*.)+[a-z]{2}([zmuvtg]|fo|me)?$', $name)) return t('The username is not a valid authentication ID.');
346
  if (strlen($name) > USERNAME_MAX_LENGTH) return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
Dries's avatar
 
Dries committed
347 348 349
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
350
  if (!$mail) return t('You must enter an e-mail address.');
351
  if (!valid_email_address($mail)) {
352
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
353 354 355
  }
}

356
function user_validate_picture(&$form, &$form_state) {
357
  // If required, validate the uploaded picture.
358 359 360 361 362 363 364 365 366
  $validators = array(
    'file_validate_is_image' => array(),
    'file_validate_image_resolution' => array(variable_get('user_picture_dimensions', '85x85')),
    'file_validate_size' => array(variable_get('user_picture_file_size', '30') * 1024),
  );
  if ($file = file_save_upload('picture_upload', $validators)) {
    // The image was saved using file_save_upload() and was added to the
    // files table as a temorary file. We'll make a copy and let the garbage
    // collector delete the original upload.
367
    $info = image_get_info($file->filepath);
368 369
    $destination = variable_get('user_picture_path', 'pictures') .'/picture-'. $form['#uid'] .'.'. $info['extension'];
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
370
      $form_state['values']['picture'] = $file->filepath;
371
    }
372 373
    else {
      form_set_error('picture_upload', t("Failed to upload the picture image; the %directory directory doesn't exist or is not writable.", array('%directory' => variable_get('user_picture_path', 'pictures'))));
374
    }
Dries's avatar
 
Dries committed
375 376 377
  }
}

Dries's avatar
Dries committed
378 379 380
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
381 382
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
383 384
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
385 386
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
387

388 389
  // Zero-based count of characters in the allowable list:
  $len = strlen($allowable_characters) - 1;
Dries's avatar
 
Dries committed
390

Dries's avatar
Dries committed
391 392
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
393

Dries's avatar
Dries committed
394
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
395 396 397 398
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
399
    $pass .= $allowable_characters[mt_rand(0, $len)];
Dries's avatar
 
Dries committed
400 401 402
  }

  return $pass;
Dries's avatar
 
Dries committed
403 404
}

Dries's avatar
Dries committed
405 406 407 408 409
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
410 411
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
412 413
 *
 * @return
414
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
415 416 417 418 419
 *
 * All permission checks in Drupal should go through this function. This
 * way, we guarantee consistent behavior, and ensure that the superuser
 * can perform all actions.
 */
Dries's avatar
 
Dries committed
420
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
421
  global $user;
Dries's avatar
 
Dries committed
422
  static $perm = array();
Dries's avatar
 
Dries committed
423

424 425 426 427
  if (is_null($account)) {
    $account = $user;
  }

428
  // User #1 has all privileges:
429
  if ($account->uid == 1) {
430
    return TRUE;
Dries's avatar
 
Dries committed
431 432
  }

Dries's avatar
Dries committed
433 434
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
435
  if (!isset($perm[$account->uid])) {
436
    $result = db_query("SELECT DISTINCT(p.perm) FROM {role} r INNER JOIN {permission} p ON p.rid = r.rid WHERE r.rid IN (%s)", implode(',', array_keys($account->roles)));
Dries's avatar
 
Dries committed
437

Steven Wittens's avatar
Steven Wittens committed
438
    $perm[$account->uid] = '';
Dries's avatar
 
Dries committed
439
    while ($row = db_fetch_object($result)) {
440
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
441
    }
Dries's avatar
 
Dries committed
442
  }
443

444
  if (isset($perm[$account->uid])) {
445
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
446
  }
447

448
  return FALSE;
Dries's avatar
 
Dries committed
449 450
}

451 452 453
/**
 * Checks for usernames blocked by user administration
 *
454
 * @return boolean TRUE for blocked users, FALSE for active
455 456
 */
function user_is_blocked($name) {
457
  $deny  = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
458

459
  return $deny;
460 461
}

Dries's avatar
 
Dries committed
462 463
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
464

Dries's avatar
 
Dries committed
465
  if (!$fields) {
Dries's avatar
Dries committed
466
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
467 468 469
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
470 471
    else {
      // Make sure we return the default fields at least
472
      $fields = array('uid', 'name', 'pass', 'mail', 'picture', 'mode', 'sort', 'threshold', 'theme', 'signature', 'created', 'access', 'login', 'status', 'timezone', 'language', 'init', 'data');
Dries's avatar
 
Dries committed
473
    }
Dries's avatar
 
Dries committed
474
  }
Dries's avatar
 
Dries committed
475

Dries's avatar
 
Dries committed
476
  return $fields;
Dries's avatar
 
Dries committed
477 478
}

Dries's avatar
Dries committed
479 480 481
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
482
function user_perm() {
483
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
 
Dries committed
484 485
}

Dries's avatar
Dries committed
486 487 488 489 490
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
491
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
492
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
493 494
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
495 496 497
  }
}

Dries's avatar
Dries committed
498 499 500
/**
 * Implementation of hook_search().
 */
501
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
502 503
  switch ($op) {
    case 'name':
504
      if ($skip_access_check || user_access('access user profiles')) {
505
        return t('Users');
506
      }
507
    case 'search':
508 509 510 511
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
512
        $result = pager_query("SELECT uid, name FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
513
        while ($account = db_fetch_object($result)) {
514
          $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
515 516
        }
        return $find;
517
      }
Dries's avatar
 
Dries committed
518 519 520
  }
}

Dries's avatar
Dries committed
521 522 523
/**
 * Implementation of hook_user().
 */
524
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
525
  if ($type == 'view') {
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
    $account->content['user_picture'] = array(
      '#value' => theme('user_picture', $account),
      '#weight' => -10,
    );
    if (!isset($account->content['summary'])) {
      $account->content['summary'] = array();
    }
    $account->content['summary'] += array(
      '#type' => 'user_profile_category',
      '#attributes' => array('class' => 'user-member'),
      '#weight' => -5,
      '#title' => t('History'),
    );
    $account->content['summary']['member_for'] =  array(
      '#type' => 'user_profile_item',
      '#title' => t('Member for'),
      '#value' => format_interval(time() - $account->created),
543
    );
Dries's avatar
Dries committed
544
  }
545
  if ($type == 'form' && $category == 'account') {
546 547
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
548 549 550
  }

  if ($type == 'validate' && $category == 'account') {
551
    return _user_edit_validate(arg(1), $edit);
552 553
  }

554 555 556 557
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

558
  if ($type == 'categories') {
559
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
560
  }
Dries's avatar
Dries committed
561 562
}

563 564
function user_login_block() {
  $form = array(
565
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
566
    '#id' => 'user-login-form',
567
    '#validate' => user_login_default_validators(),
568
    '#submit' => array('user_login_submit'),
569 570 571
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
572
    '#maxlength' => USERNAME_MAX_LENGTH,
573 574 575 576 577
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
578
    '#maxlength' => 60,
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
    $items[] = l(t('Create new account'), 'user/register', array('title' => t('Create a new user account.')));
  }
  $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
  $form['links'] = array('#value' => theme('item_list', $items));
  return $form;
}

Dries's avatar
Dries committed
594 595 596
/**
 * Implementation of hook_block().
 */
597
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
598 599
  global $user;

Dries's avatar
Dries committed
600 601 602 603 604
  if ($op == 'list') {
     $blocks[0]['info'] = t('User login');
     $blocks[1]['info'] = t('Navigation');
     $blocks[2]['info'] = t('Who\'s new');
     $blocks[3]['info'] = t('Who\'s online');
605

606
     return $blocks;
607
  }
608 609 610 611 612 613 614 615 616
  else if ($op == 'configure' && $delta == 2) {
    $form['user_block_whois_new_count'] = array(
      '#type' => 'select',
      '#title' => t('Number of users to display'),
      '#default_value' => variable_get('user_block_whois_new_count', 5),
      '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
    );
    return $form;
  }
617 618
  else if ($op == 'configure' && $delta == 3) {
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
619 620
    $form['user_block_seconds_online'] = array('#type' => 'select', '#title' => t('User activity'), '#default_value' => variable_get('user_block_seconds_online', 900), '#options' => $period, '#description' => t('A user is considered online for this long after they have last viewed a page.'));
    $form['user_block_max_list_count'] = array('#type' => 'select', '#title' => t('User list length'), '#default_value' => variable_get('user_block_max_list_count', 10), '#options' => drupal_map_assoc(array(0, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100)), '#description' => t('Maximum number of currently online users to display.'));
621

622
    return $form;
623
  }
624 625 626
  else if ($op == 'save' && $delta == 2) {
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
627 628 629 630 631
  else if ($op == 'save' && $delta == 3) {
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
  else if ($op == 'view') {
Dries's avatar
 
Dries committed
632 633
    $block = array();

Dries's avatar
 
Dries committed
634 635
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
636 637
        // For usability's sake, avoid showing two login forms on one page.
        if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
Dries's avatar
 
Dries committed
638

Dries's avatar
Dries committed
639
          $block['subject'] = t('User login');
640
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
 
Dries committed
641
        }
Dries's avatar
Dries committed
642
        return $block;
Dries's avatar
Dries committed
643

644
      case 1:
645
        if ($menu = menu_tree()) {
Dries's avatar
Dries committed
646
           $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
647
           $block['content'] = $menu;
Dries's avatar
 
Dries committed
648
        }
649
        return $block;
Dries's avatar
Dries committed
650

Dries's avatar
 
Dries committed
651
      case 2:
652
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
653
          // Retrieve a list of new users who have subsequently accessed the site successfully.
654
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', 0, variable_get('user_block_whois_new_count', 5));
655
          while ($account = db_fetch_object($result)) {
656
            $items[] = $account;
657
          }
Dries's avatar
Dries committed
658
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
659

Dries's avatar
Dries committed
660 661
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
662
        }
Dries's avatar
Dries committed
663 664
        return $block;

Dries's avatar
 
Dries committed
665
      case 3:
666
        if (user_access('access content')) {
667
          // Count users active within the defined period.
668
          $interval = time() - variable_get('user_block_seconds_online', 900);
669

670
          // Perform database queries to gather online user lists.  We use s.timestamp
671
          // rather than u.access because it is much faster.
672
          $anonymous_count = sess_count($interval);
673
          $authenticated_users = db_query('SELECT DISTINCT u.uid, u.name, s.timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.timestamp >= %d AND s.uid > 0 ORDER BY s.timestamp DESC', $interval);
674
          $authenticated_count = db_num_rows($authenticated_users);
Dries's avatar
 
Dries committed
675

Dries's avatar
Dries committed
676
          // Format the output with proper grammar.
677 678
          if ($anonymous_count == 1 && $authenticated_count == 1) {
            $output = t('There is currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests')));
Dries's avatar
 
Dries committed
679 680
          }
          else {
681
            $output = t('There are currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests')));
Dries's avatar
 
Dries committed
682 683
          }

684 685
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
686
          if ($authenticated_count && $max_users) {
687
            $items = array();
688

689
            while ($max_users-- && $account = db_fetch_object($authenticated_users)) {
690 691
              $items[] = $account;
            }
692

693 694
            $output .= theme('user_list', $items, t('Online users'));
          }
695

Dries's avatar
Dries committed
696 697
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
698
        }
Dries's avatar
 
Dries committed
699
        return $block;
Dries's avatar
 
Dries committed
700 701
    }
  }
702 703
}

Dries's avatar
 
Dries committed
704 705
function theme_user_picture($account) {
  if (variable_get('user_pictures', 0)) {
706
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
 
Dries committed
707 708 709 710 711 712
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

713
    if (isset($picture)) {
714
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
715
      $picture = theme('image', $picture, $alt, $alt, '', FALSE);
716
      if (!empty($account->uid) && user_access('access user profiles')) {
717
        $picture = l($picture, "user/$account->uid", array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE));
Dries's avatar
 
Dries committed
718 719 720 721 722 723 724
      }

      return "<div class=\"picture\">$picture</div>";
    }
  }
}

725 726 727 728 729 730 731
/**
 * Make a list of users.
 * @param $items an array with user objects. Should contain at least the name and uid
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
732 733 734 735
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
736
  }
Dries's avatar
Dries committed
737
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
738 739
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
function user_is_anonymous() {
  return !$GLOBALS['user']->uid;
}

function user_is_logged_in() {
  return (bool)$GLOBALS['user']->uid;
}

function user_register_access() {
  return !$GLOBALS['user']->uid && variable_get('user_register', 1);
}

function user_view_access($account) {
  return $account && $account->uid &&
    (
      // Always let users view their own profile.
      ($GLOBALS['user']->uid == $account->uid) ||
      // Administrators can view all accounts.
      user_access('administer users') ||
      // The user is not blocked and logged in at least once.
      ($account->access && $account->status && user_access('access user profiles'))
    );
}

764
function user_edit_access($account) {
765
  return ($GLOBALS['user']->uid == $account->uid) || user_access('administer users');
766 767 768 769 770 771 772
}

function user_load_self($arg) {
  $arg[1] = user_load($GLOBALS['user']->uid);
  return $arg;
}

Dries's avatar
 
Dries committed
773
/**
Dries's avatar
 
Dries committed
774
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
775
 */
776 777
function user_menu() {
  $items['user/autocomplete'] = array(
778
    'title' => 'User autocomplete',
779
    'page callback' => 'user_autocomplete',
780
    'access callback' => 'user_access',
781 782 783
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
 
Dries committed
784

785
  // Registration and login pages.
786
  $items['user'] = array(
787
    'title' => 'Log in',
788 789 790
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_login'),
    'access callback' => 'user_is_anonymous',
791
    'type' => MENU_CALLBACK,
792 793 794
  );

  $items['user/login'] = array(
795
    'title' => 'Log in',
796 797
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
 
Dries committed
798

799
  $items['user/register'] = array(
800
    'title' => 'Create new account',
801 802 803 804 805 806 807
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
  );

  $items['user/password'] = array(
808
    'title' => 'Request new password',
809 810
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),
811
    'access callback' => 'user_is_anonymous',
812 813 814
    'type' => MENU_LOCAL_TASK,
  );
  $items['user/reset/%/%/%'] = array(
815
    'title' => 'Reset password',
816 817 818 819 820 821 822 823
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
  );

  // Admin user pages
  $items['admin/user'] = array(
824 825
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
826 827 828
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
829 830
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
831 832
  );
  $items['admin/user/user'] = array(
833 834
    'title' => 'Users',
    'description' => 'List, add, and edit users.',
835 836 837 838
    'page callback' => 'user_admin',
    'page arguments' => array('list'),
    'access arguments' => array('administer users'));
  $items['admin/user/user/list'] = array(
839
    'title' => 'List',
840 841 842 843
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/user/create'] = array(
844
    'title' => 'Add user',
845 846 847 848
    'page arguments' => array('create'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/settings'] = array(
849 850
    'title' => 'User settings',
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, and user pictures.',
851 852 853 854 855 856
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_settings'),
  );

  // Admin access pages
  $items['admin/user/access'] = array(
857 858
    'title' => 'Access control',
    'description' => 'Determine access to features by selecting permissions for roles.',
859 860 861 862 863
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_perm'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles'] = array(
864 865
    'title' => 'Roles',
    'description' => 'List, edit, or add user roles.',
866 867 868 869 870
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_new_role'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles/edit'] = array(
871
    'title' => 'Edit role',
872 873 874 875
    'page arguments' => array('user_admin_role'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/rules'] = array(
876 877
    'title' => 'Access rules',
    'description' => 'List and create rules to disallow usernames, e-mail addresses, and IP addresses.',
878 879 880 881
    'page callback' => 'user_admin_access',
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/rules/list'] = array(
882
    'title' => 'List',
883 884 885 886
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/rules/add'] = array(
887
    'title' => 'Add rule',
888 889 890 891
    'page callback' => 'user_admin_access_add',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/rules/check'] = array(
892
    'title' => 'Check rules',
893 894 895 896
    'page callback' => 'user_admin_access_check',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/rules/edit'] = array(
897
    'title' => 'Edit rule',
898 899 900 901
    'page callback' => 'user_admin_access_edit',
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/rules/delete'] = array(
902
    'title' => 'Delete rule',
903 904 905