user.module 95.1 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.
 */

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

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

Dries's avatar
 
Dries committed
27 28
  if ($user = db_fetch_object($result)) {
    return user_load($user);
Dries's avatar
 
Dries committed
29 30 31 32 33 34
  }
  else {
    return 0;
  }
}

Dries's avatar
Dries committed
35 36 37 38 39
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
40
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
41 42
 *
 * @return
43
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
Dries's avatar
Dries committed
44
 */
Dries's avatar
 
Dries committed
45
function user_load($array = array()) {
Dries's avatar
Dries committed
46
  // Dynamically compose a SQL query:
47
  $query = array();
48
  $params = array();
49

Dries's avatar
 
Dries committed
50
  foreach ($array as $key => $value) {
51 52
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
53
      $params[] = $value;
54
    }
55 56 57 58
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
 
Dries committed
59
    else {
60
      $query[]= "LOWER($key) = LOWER('%s')";
61
      $params[] = $value;
Dries's avatar
 
Dries committed
62 63
    }
  }
64
  $result = db_query('SELECT * FROM {users} u WHERE ' . implode(' AND ', $query), $params);
Dries's avatar
 
Dries committed
65

66 67 68
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
Dries's avatar
 
Dries committed
69

70
    $user->roles = array();
71 72 73 74 75 76
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
77 78 79 80
    $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;
    }
81
    user_module_invoke('load', $array, $user);
82 83
  }
  else {
84
    $user = FALSE;
Dries's avatar
 
Dries committed
85
  }
Dries's avatar
 
Dries committed
86 87 88 89

  return $user;
}

90
/**
91
 * Save changes to a user account or add a new user.
92 93
 *
 * @param $account
94 95
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
96 97 98
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
99
 *   Setting a field to null deletes it from the data column.
100 101 102 103
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
104
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
105
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
106
  $user_fields = user_fields();
Dries's avatar
 
Dries committed
107
  if ($account->uid) {
108
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
 
Dries committed
109

Dries's avatar
Dries committed
110
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
Dries's avatar
 
Dries committed
111
    foreach ($array as $key => $value) {
112
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
 
Dries committed
113 114
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
 
Dries committed
115
      }
116
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
117
        if (in_array($key, $user_fields)) {
118
          // Save standard fields
Dries's avatar
 
Dries committed
119 120
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
 
Dries committed
121
        }
Dries's avatar
 
Dries committed
122
        else if ($key != 'roles') {
123
          // Roles is a special case: it used below.
124 125 126 127 128 129
          if ($value === null) {
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
 
Dries committed
130
        }
Dries's avatar
 
Dries committed
131 132
      }
    }
133
    $query .= "data = '%s' ";
Dries's avatar
 
Dries committed
134
    $v[] = serialize($data);
Dries's avatar
 
Dries committed
135

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

138
    // Reload user roles if provided
139
    if (is_array($array['roles'])) {
Dries's avatar
Dries committed
140
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $account->uid);
Dries's avatar
 
Dries committed
141

142
      foreach (array_keys($array['roles']) as $rid) {
143 144 145
        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);
        }
146
      }
Dries's avatar
 
Dries committed
147 148
    }

149
    // Delete a blocked user's sessions to kick them if they are online.
150
    if (isset($array['status']) && $array['status'] == 0) {
151
      db_query('DELETE FROM {sessions} WHERE uid = %d', $account->uid);
152 153
    }

154
    // Refresh user object
Dries's avatar
 
Dries committed
155
    $user = user_load(array('uid' => $account->uid));
156
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
 
Dries committed
157 158
  }
  else {
Dries's avatar
 
Dries committed
159
    $array['created'] = time();
Dries's avatar
Dries committed
160
    $array['uid'] = db_next_id('{users}_uid');
Dries's avatar
 
Dries committed
161

162 163 164
    // 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
165
    foreach ($array as $key => $value) {
166 167 168 169
      switch($key) {
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
 
Dries committed
170
          $s[] = "'%s'";
Dries's avatar
Dries committed
171
          break;
172 173 174 175 176 177 178 179 180 181 182 183 184 185
        case 'uid':        case 'mode':     case 'sort':
        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
186 187
      }
    }
Dries's avatar
Dries committed
188
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
Dries's avatar
 
Dries committed
189

Dries's avatar
Dries committed
190 191
    // Reload user roles (delete just to be safe).
    db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
192
    foreach ((array)$array['roles'] as $rid) {
Dries's avatar
Dries committed
193
      db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
Dries's avatar
 
Dries committed
194 195
    }

196 197
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
198

199 200 201 202 203
    user_module_invoke('insert', $array, $user, $category);

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
204
      if ((substr($key, 0, 4) !== 'auth') && ($key != 'roles') && (!in_array($key, $user_fields)) && ($value !== null)) {
205 206 207 208 209 210 211
        $data[$key] = $value;
      }
    }
    db_query("UPDATE {users} SET data = '%s' WHERE uid = %d", serialize($data), $user->uid);

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

214
  // Save distributed authentication mappings
215
  $authmaps = array();
Dries's avatar
 
Dries committed
216
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
217
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
 
Dries committed
218 219 220
      $authmaps[$key] = $value;
    }
  }
221
  if (sizeof($authmaps) > 0) {
Dries's avatar
 
Dries committed
222
    user_set_authmaps($user, $authmaps);
Dries's avatar
 
Dries committed
223 224 225 226 227
  }

  return $user;
}

Dries's avatar
Dries committed
228 229 230
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
231
function user_validate_name($name) {
232
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
233 234 235
  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.');
  if (ereg('  ', $name)) return t('The username cannot contain multiple spaces in a row.');
236
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
237 238 239 240 241 242 243 244 245 246 247
  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
                   '\x{FFF9}-\x{FFFD}]/u',   // Replacement characters
                   $name)) {
    return t('The username contains an illegal character.');
  }
Dries's avatar
Dries committed
248
  if (ereg('@', $name) && !eregi('@([0-9a-z](-?[0-9a-z])*.)+[a-z]{2}([zmuvtg]|fo|me)?$', $name)) return t('The username is not a valid authentication ID.');
249
  if (strlen($name) > 56) return t('The username %name is too long: it must be less than 56 characters.', array('%name' => theme('placeholder', $name)));
Dries's avatar
 
Dries committed
250 251 252
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
253
  if (!$mail) return t('You must enter an e-mail address.');
254
  if (!valid_email_address($mail)) {
255
    return t('The e-mail address %mail is not valid.', array('%mail' => theme('placeholder', $mail)));
Dries's avatar
 
Dries committed
256 257 258
  }
}

Dries's avatar
 
Dries committed
259
function user_validate_picture($file, &$edit, $user) {
260
  global $form_values;
Dries's avatar
Dries committed
261
  // Initialize the picture:
262
  $form_values['picture'] = $user->picture;
Dries's avatar
 
Dries committed
263

Dries's avatar
Dries committed
264 265
  // Check that uploaded file is an image, with a maximum file size
  // and maximum height/width.
266
  $info = image_get_info($file->filepath);
Dries's avatar
Dries committed
267
  list($maxwidth, $maxheight) = explode('x', variable_get('user_picture_dimensions', '85x85'));
Dries's avatar
 
Dries committed
268

269
  if (!$info || !$info['extension']) {
270
    form_set_error('picture_upload', t('The uploaded file was not an image.'));
Dries's avatar
 
Dries committed
271
  }
272 273
  else if (image_get_toolkit()) {
    image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
Dries's avatar
 
Dries committed
274
  }
275
  else if (filesize($file->filepath) > (variable_get('user_picture_file_size', '30') * 1000)) {
276
    form_set_error('picture_upload', t('The uploaded image is too large; the maximum file size is %size kB.', array('%size' => variable_get('user_picture_file_size', '30'))));
277
  }
278
  else if ($info['width'] > $maxwidth || $info['height'] > $maxheight) {
279
    form_set_error('picture_upload', t('The uploaded image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => variable_get('user_picture_dimensions', '85x85'))));
Dries's avatar
 
Dries committed
280
  }
281 282

  if (!form_get_errors()) {
283
    if ($file = file_save_upload('picture_upload', variable_get('user_picture_path', 'pictures') .'/picture-'. $user->uid . '.' . $info['extension'], 1)) {
284
      $form_values['picture'] = $file->filepath;
285 286
    }
    else {
287
      form_set_error('picture_upload', t("Failed to upload the picture image; the %directory directory doesn't exist.", array('%directory' => '<em>'. variable_get('user_picture_path', 'pictures') .'</em>')));
288
    }
Dries's avatar
 
Dries committed
289 290 291
  }
}

Dries's avatar
Dries committed
292 293 294
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
295 296
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
297 298
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
299 300
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
301

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

Dries's avatar
Dries committed
305 306
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
307

Dries's avatar
Dries committed
308
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
309 310 311 312
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
317 318
}

Dries's avatar
Dries committed
319 320 321 322 323
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
324 325
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
326 327
 *
 * @return
328
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
329 330 331 332 333
 *
 * 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
334
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
335
  global $user;
Dries's avatar
 
Dries committed
336
  static $perm = array();
Dries's avatar
 
Dries committed
337

338 339 340 341
  if (is_null($account)) {
    $account = $user;
  }

342
  // User #1 has all privileges:
343
  if ($account->uid == 1) {
344
    return TRUE;
Dries's avatar
 
Dries committed
345 346
  }

Dries's avatar
Dries committed
347 348
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
349
  if (!isset($perm[$account->uid])) {
350
    $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
351

Steven Wittens's avatar
Steven Wittens committed
352
    $perm[$account->uid] = '';
Dries's avatar
 
Dries committed
353
    while ($row = db_fetch_object($result)) {
354
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
355
    }
Dries's avatar
 
Dries committed
356
  }
357

358
  if (isset($perm[$account->uid])) {
359
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
360
  }
361

362
  return FALSE;
Dries's avatar
 
Dries committed
363 364
}

365 366 367 368 369 370 371 372 373 374 375 376
/**
 * Checks for usernames blocked by user administration
 *
 * @return boolean true for blocked users, false for active
 */
function user_is_blocked($name) {
  $allow = db_fetch_object(db_query("SELECT * FROM {users} WHERE status = 1 AND name = LOWER('%s')", $name));
  $deny  = db_fetch_object(db_query("SELECT * FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));

  return $deny && !$allow;
}

Dries's avatar
Dries committed
377 378 379
/**
 * Send an e-mail message.
 */
Dries's avatar
 
Dries committed
380
function user_mail($mail, $subject, $message, $header) {
Dries's avatar
Dries committed
381
  if (variable_get('smtp_library', '') && file_exists(variable_get('smtp_library', ''))) {
382
   include_once './' . variable_get('smtp_library', '');
383
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
384 385
  }
  else {
386 387
    /*
    ** Note: if you are having problems with sending mail, or mails look wrong
388
    ** when they are received you may have to modify the str_replace to suit
389 390 391 392
    ** your systems.
    **  - \r\n will work under dos and windows.
    **  - \n will work for linux, unix and BSDs.
    **  - \r will work for macs.
Dries's avatar
 
Dries committed
393 394 395 396
    **
    ** According to RFC 2646, it's quite rude to not wrap your e-mails:
    **
    ** "The Text/Plain media type is the lowest common denominator of
397
    ** Internet e-mail, with lines of no more than 997 characters (by
Dries's avatar
 
Dries committed
398 399 400 401 402 403 404
    ** convention usually no more than 80), and where the CRLF sequence
    ** represents a line break [MIME-IMT]."
    **
    ** CRLF === \r\n
    **
    ** http://www.rfc-editor.org/rfc/rfc2646.txt
    **
405
    */
Dries's avatar
 
Dries committed
406 407
    return mail(
      $mail,
Dries's avatar
 
Dries committed
408
      mime_header_encode($subject),
Dries's avatar
Dries committed
409
      str_replace("\r", '', $message),
Dries's avatar
 
Dries committed
410
      "MIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8; format=flowed\nContent-transfer-encoding: 8Bit\n" . $header
Dries's avatar
 
Dries committed
411
    );
Dries's avatar
 
Dries committed
412 413 414
  }
}

Dries's avatar
 
Dries committed
415 416
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
417

Dries's avatar
 
Dries committed
418
  if (!$fields) {
Dries's avatar
Dries committed
419
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
420 421 422
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
423 424
    else {
      // Make sure we return the default fields at least
425
      $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
426
    }
Dries's avatar
 
Dries committed
427
  }
Dries's avatar
 
Dries committed
428

Dries's avatar
 
Dries committed
429
  return $fields;
Dries's avatar
 
Dries committed
430 431
}

Dries's avatar
Dries committed
432 433 434
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
435
function user_perm() {
436
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
 
Dries committed
437 438
}

Dries's avatar
Dries committed
439 440 441 442 443
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
444
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
445
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
446 447
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
448 449 450
  }
}

Dries's avatar
Dries committed
451 452 453
/**
 * Implementation of hook_search().
 */
454 455 456
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
457 458 459
      if (user_access('access user profiles')) {
        return t('users');
      }
460
    case 'search':
461 462 463 464 465 466
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
        $result = pager_query("SELECT * FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
        while ($account = db_fetch_object($result)) {
467
          $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid));
468 469
        }
        return $find;
470
      }
Dries's avatar
 
Dries committed
471 472 473
  }
}

Dries's avatar
Dries committed
474 475 476
/**
 * Implementation of hook_user().
 */
477
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
478
  if ($type == 'view') {
479 480 481 482 483 484
    $items[] = array('title' => t('Member for'),
      'value' => format_interval(time() - $user->created),
      'class' => 'member',
    );

    return array(t('History') => $items);
Dries's avatar
Dries committed
485
  }
486 487 488 489 490
  if ($type == 'form' && $category == 'account') {
    return user_edit_form(arg(1), $edit);
  }

  if ($type == 'validate' && $category == 'account') {
491
    return _user_edit_validate(arg(1), $edit);
492 493
  }

494 495 496 497
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

498 499 500
  if ($type == 'categories') {
    return array(array('name' => 'account', 'title' => t('account settings'), 'weight' => 1));
  }
Dries's avatar
Dries committed
501 502
}

Dries's avatar
Dries committed
503 504 505
/**
 * Implementation of hook_block().
 */
506
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
507 508
  global $user;

Dries's avatar
Dries committed
509 510 511 512 513
  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');
514

515
     return $blocks;
516
  }
517 518
  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');
519 520
    $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.'));
521

522
    return $form;
523 524 525 526 527 528
  }
  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
529 530
    $block = array();

Dries's avatar
 
Dries committed
531 532
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
533 534
        // For usability's sake, avoid showing two login forms on one page.
        if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
535
          $form['#action'] = url($_GET['q'], drupal_get_destination());
536
          $form['#id'] = 'user-login-form';
Dries's avatar
Dries committed
537 538 539 540 541 542 543 544 545 546 547 548 549 550
          $form['name'] = array('#type' => 'textfield',
            '#title' => t('Username'),
            '#maxlength' => 60,
            '#size' => 15,
            '#required' => TRUE,
          );
          $form['pass'] = array('#type' => 'password',
            '#title' => t('Password'),
            '#size' => 15,
            '#required' => TRUE,
          );
          $form['submit'] = array('#type' => 'submit',
            '#value' => t('Log in'),
          );
551

Dries's avatar
Dries committed
552 553
          if (variable_get('user_register', 1)) {
            $items[] = l(t('Create new account'), 'user/register', array('title' => t('Create a new user account.')));
Dries's avatar
 
Dries committed
554
          }
Dries's avatar
Dries committed
555
          $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
556
          $form['links'] = array('#value' => theme('item_list', $items));
Dries's avatar
 
Dries committed
557

Dries's avatar
Dries committed
558
          $block['subject'] = t('User login');
559
          $block['content'] = drupal_get_form('user_login_block', $form, 'user_login');
Dries's avatar
 
Dries committed
560
        }
Dries's avatar
Dries committed
561
        return $block;
Dries's avatar
Dries committed
562

563
      case 1:
Dries's avatar
 
Dries committed
564
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
565
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
566
           $block['content'] = $menu;
Dries's avatar
 
Dries committed
567
        }
568
        return $block;
Dries's avatar
Dries committed
569

Dries's avatar
 
Dries committed
570
      case 2:
571
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
572
          // Retrieve a list of new users who have subsequently accessed the site successfully.
573
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', 0, 5);
574
          while ($account = db_fetch_object($result)) {
575
            $items[] = $account;
576
          }
Dries's avatar
Dries committed
577
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
578

Dries's avatar
Dries committed
579 580
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
581
        }
Dries's avatar
Dries committed
582 583
        return $block;

Dries's avatar
 
Dries committed
584
      case 3:
585
        if (user_access('access content')) {
Dries's avatar
Dries committed
586
          // Count users with activity in the past defined period.
587
          $time_period = variable_get('user_block_seconds_online', 900);
Dries's avatar
 
Dries committed
588

Dries's avatar
Dries committed
589
          // Perform database queries to gather online user lists.
Dries's avatar
 
Dries committed
590
          $guests = db_fetch_object(db_query('SELECT COUNT(sid) AS count FROM {sessions} WHERE timestamp >= %d AND uid = 0', time() - $time_period));
591
          $users = db_query('SELECT uid, name, access FROM {users} WHERE access >= %d AND uid != 0 ORDER BY access DESC', time() - $time_period);
Dries's avatar
 
Dries committed
592
          $total_users = db_num_rows($users);
Dries's avatar
 
Dries committed
593

Dries's avatar
Dries committed
594
          // Format the output with proper grammar.
Dries's avatar
 
Dries committed
595
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
596
            $output = t('There is currently %members and %visitors online.', array('%members' => format_plural($total_users, '1 user', '%count users'), '%visitors' => format_plural($guests->count, '1 guest', '%count guests')));
Dries's avatar
 
Dries committed
597 598
          }
          else {
Dries's avatar
Dries committed
599
            $output = t('There are currently %members and %visitors online.', array('%members' => format_plural($total_users, '1 user', '%count users'), '%visitors' => format_plural($guests->count, '1 guest', '%count guests')));
Dries's avatar
 
Dries committed
600 601
          }

602 603
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
604 605
          if ($total_users && $max_users) {
            $items = array();
606

607 608 609
            while ($max_users-- && $account = db_fetch_object($users)) {
              $items[] = $account;
            }
610

611 612
            $output .= theme('user_list', $items, t('Online users'));
          }
613

Dries's avatar
Dries committed
614 615
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
616
        }
Dries's avatar
 
Dries committed
617
        return $block;
Dries's avatar
 
Dries committed
618 619
    }
  }
620 621
}

Dries's avatar
 
Dries committed
622 623 624 625 626 627 628 629 630
function theme_user_picture($account) {
  if (variable_get('user_pictures', 0)) {
    if ($account->picture && file_exists($account->picture)) {
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

631
    if (isset($picture)) {
Dries's avatar
Dries committed
632
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
633
      $picture = theme('image', $picture, $alt, $alt, '', false);
634
      if (!empty($account->uid) && user_access('access user profiles')) {
635
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')), NULL, NULL, FALSE, TRUE);
Dries's avatar
 
Dries committed
636 637 638 639 640 641 642
      }

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

643 644 645
/**
 * Theme a user page
 * @param $account the user object
646 647 648 649 650
 * @param $fields a multidimensional array for the fields, in the form of array (
 *   'category1' => array(item_array1, item_array2), 'category2' => array(item_array3,
 *    .. etc.). Item arrays are formatted as array(array('title' => 'item title',
 * 'value' => 'item value', 'class' => 'class-name'), ... etc.). Module names are incorporated
 * into the CSS class.
651 652 653
 *
 * @ingroup themeable
 */
Dries's avatar
Dries committed
654
function theme_user_profile($account, $fields) {
655
  $output = '<div class="profile">';
Dries's avatar
 
Dries committed
656
  $output .= theme('user_picture', $account);
657
  foreach ($fields as $category => $items) {
658
    if (strlen($category) > 0) {
659
      $output .= '<h2 class="title">'. $category .'</h2>';
660
    }
661 662
    $output .= '<dl>';
    foreach ($items as $item) {
663
      if (isset($item['title'])) {
664
        $output .= '<dt class="'. $item['class'] .'">'. $item['title'] .'</dt>';
665 666
      }
      $output .= '<dd class="'. $item['class'] .'">'. $item['value'] .'</dd>';
667 668
    }
    $output .= '</dl>';
Dries's avatar
Dries committed
669
  }
670
  $output .= '</div>';
Dries's avatar
 
Dries committed
671 672 673 674

  return $output;
}

675 676 677 678 679 680 681
/**
 * 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) {
682 683 684 685
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
686
  }
Dries's avatar
Dries committed
687
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
688 689
}

Dries's avatar
 
Dries committed
690
/**
Dries's avatar
 
Dries committed
691
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
692
 */
Dries's avatar
 
Dries committed
693
function user_menu($may_cache) {
Dries's avatar
 
Dries committed
694
  global $user;
Dries's avatar
 
Dries committed
695

Dries's avatar
 
Dries committed
696
  $items = array();
Dries's avatar
 
Dries committed
697

698
  $admin_access = user_access('administer users');
699
  $access_access = user_access('administer access control');
700
  $view_access = user_access('access user profiles');
Dries's avatar
 
Dries committed
701

Dries's avatar
 
Dries committed
702
  if ($may_cache) {
Dries's avatar
 
Dries committed
703
    $items[] = array('path' => 'user', 'title' => t('user account'),
704
      'callback' => 'user_login', 'access' => TRUE, 'type' => MENU_CALLBACK);
705

Steven Wittens's avatar
Steven Wittens committed
706
    $items[] = array('path' => 'user/autocomplete', 'title' => t('user autocomplete'),
707
      'callback' => 'user_autocomplete', 'access' => $view_access, 'type' => MENU_CALLBACK);
Steven Wittens's avatar
Steven Wittens committed
708

Steven Wittens's avatar
Steven Wittens committed
709
    // Registration and login pages.
Dries's avatar
 
Dries committed
710
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
711
      'callback' => 'user_login', 'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
 
Dries committed
712
    $items[] = array('path' => 'user/register', 'title' => t('register'),
713
      'callback' => 'user_register', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
714
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
715
      'callback' => 'user_pass', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
716
    $items[] = array('path' => 'user/reset', 'title' => t('reset password'),
717
      'callback' => 'user_pass_reset', 'access' => TRUE, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
718 719
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
720

Steven Wittens's avatar
Steven Wittens committed
721
    // Admin user pages
Dries's avatar
 
Dries committed
722
    $items[] = array('path' => 'admin/user', 'title' => t('users'),
723
      'callback' => 'user_admin', 'access' => $admin_access);
Dries's avatar
 
Dries committed
724
    $items[] = array('path' => 'admin/user/list', 'title' => t('list'),
Dries's avatar
 
Dries committed
725
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
726
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
727
      'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
728
      'type' => MENU_LOCAL_TASK);
729
    $items[] = array('path' => 'admin/settings/user', 'title' => t('users'),
730
      'callback' => 'user_configure');
731

Steven Wittens's avatar
Steven Wittens committed
732
    // Admin access pages
733
    $items[] = array('path' => 'admin/access', 'title' => t('access control'),
734
      'callback' => 'user_admin_perm', 'access' => $access_access);
735
    $items[] = array('path' => 'admin/access/permissions', 'title' => t('permissions'),
736
      'callback' => 'user_admin_perm', 'access' => $access_access,
Dries's avatar
 
Dries committed
737
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
738
    $items[] = array('path' => 'admin/access/roles', 'title' => t('roles'),
739
      'callback' => 'user_admin_role', 'access' => $access_access,
Dries's avatar
 
Dries committed
740
      'type' => MENU_LOCAL_TASK);
741
    $items[] = array('path' => 'admin/access/roles/edit', 'title' => t('edit role'),
742
      'callback' => 'user_admin_role', 'access' => $access_access,
743
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
744
    $items[] = array('path' => 'admin/access/rules', 'title' => t('access rules'),
745
      'callback' => 'user_admin_access', 'access' => $access_access,
746 747
      'type' => MENU_LOCAL_TASK, 'weight' => 10);
    $items[] = array('path' => 'admin/access/rules/list', 'title' => t('list'),
748
      'access' => $access_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
749
    $items[] = array('path' => 'admin/access/rules/add', 'title' => t('add rule'),
750
      'callback' => 'user_admin_access_add', 'access' => $access_access,
Dries's avatar
 
Dries committed
751
      'type' => MENU_LOCAL_TASK);
752
    $items[] = array('path' => 'admin/access/rules/check', 'title' => t('check rules'),
753
      'callback' => 'user_admin_access_check', 'access' => $access_access,
Dries's avatar
 
Dries committed
754
      'type' => MENU_LOCAL_TASK);
755
    $items[] = array('path' => 'admin/access/rules/edit', 'title' => t('edit rule'),
756
      'callback' => 'user_admin_access_edit', 'access' => $access_access,
757
      'type' => MENU_CALLBACK);
758
    $items[] = array('path' => 'admin/access/rules/delete', 'title' => t('delete rule'),
759
      'callback' => 'user_admin_access_delete', 'access' => $access_access,
760
      'type' => MENU_CALLBACK);
761

Dries's avatar
 
Dries committed
762 763
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
764
        'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
765
        'type' => MENU_LOCAL_TASK);
766
    }
Dries's avatar
 
Dries committed
767

Steven Wittens's avatar
Steven Wittens committed
768
    // Your personal page
Dries's avatar
 
Dries committed
769 770
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
771
        'callback' => 'user_view', 'callback arguments' => array(arg(1)), 'access' => TRUE,
772
        'type' => MENU_DYNAMIC_ITEM);
Dries's avatar
 
Dries committed
773
    }
Dries's avatar
 
Dries committed
774 775 776 777 778

    $items[] = array('path' => 'logout', 'title' => t('log out'),
      'access' => $user->uid != 0,
      'callback' => 'user_logout',
      'weight' => 10);
Dries's avatar
 
Dries committed
779 780
  }
  else {
781
    if (arg(0) == 'user' && is_numeric(arg(1)) && arg(1) > 0) {