user.module 86.4 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 40 41 42 43 44
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
 *   user, such as user name or email address.
 *
 * @return
 *   A fully-loaded $user object.
 */
Dries's avatar
 
Dries committed
45
function user_load($array = array()) {
Dries's avatar
Dries committed
46 47
  // Dynamically compose a SQL query:
  $query = '';
Dries's avatar
 
Dries committed
48

49
  $params = array();
Dries's avatar
 
Dries committed
50
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
51
    if ($key == 'pass') {
52
      $query .= "u.pass = '%s' AND ";
53
      $params[] = md5($value);
54
    }
55
    else if ($key == 'uid') {
56 57
      $query .= "u.uid = %d AND ";
      $params[] = $value;
58
    }
Dries's avatar
 
Dries committed
59
    else {
60 61
      $query .= "LOWER(u.$key) = LOWER('%s') AND ";
      $params[] = $value;
Dries's avatar
 
Dries committed
62 63
    }
  }
64
  $result = db_query_range("SELECT u.* FROM {users} u WHERE $query u.status < 3", $params, 0, 1);
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 71 72 73 74
    $user->roles = array();
    $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;
    }
75
    user_module_invoke('load', $array, $user);
76 77 78
  }
  else {
    $user = new StdClass();
Dries's avatar
 
Dries committed
79
  }
Dries's avatar
 
Dries committed
80 81 82 83

  return $user;
}

84 85 86 87 88 89 90 91
/**
 * Save changes to a user account.
 *
 * @param $account
 *   The $user object for the user to modify.
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
92
 *   Setting a field to null deletes it from the data column.
93 94 95 96
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
97
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
98
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
99
  $user_fields = user_fields();
Dries's avatar
 
Dries committed
100
  if ($account->uid) {
101
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
 
Dries committed
102

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

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

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

135
      foreach (array_keys($array['roles']) as $rid) {
Dries's avatar
Dries committed
136
        db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
137
      }
Dries's avatar
 
Dries committed
138 139
    }

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

145
    // Refresh user object
Dries's avatar
 
Dries committed
146
    $user = user_load(array('uid' => $account->uid));
Dries's avatar
 
Dries committed
147 148
  }
  else {
Dries's avatar
 
Dries committed
149
    $array['created'] = time();
Dries's avatar
Dries committed
150
    $array['uid'] = db_next_id('{users}_uid');
Dries's avatar
 
Dries committed
151

152 153 154
    // 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
155
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
156
      if ($key == 'pass') {
Dries's avatar
 
Dries committed
157
        $fields[] = db_escape_string($key);
Dries's avatar
 
Dries committed
158 159
        $values[] = md5($value);
        $s[] = "'%s'";
Dries's avatar
 
Dries committed
160
      }
Dries's avatar
Dries committed
161
      else if (substr($key, 0, 4) !== 'auth') {
Kjartan's avatar
Kjartan committed
162
        if (in_array($key, $user_fields)) {
Dries's avatar
 
Dries committed
163
          $fields[] = db_escape_string($key);
Dries's avatar
 
Dries committed
164 165
          $values[] = $value;
          $s[] = "'%s'";
Dries's avatar
 
Dries committed
166
        }
Dries's avatar
 
Dries committed
167 168
      }
    }
Dries's avatar
Dries committed
169
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
Dries's avatar
 
Dries committed
170

Dries's avatar
Dries committed
171 172
    // Reload user roles (delete just to be safe).
    db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
173
    foreach ($array['roles'] as $rid) {
Dries's avatar
Dries committed
174
      db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
Dries's avatar
 
Dries committed
175 176
    }

177 178
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
179

180 181 182 183 184 185 186 187 188 189 190 191 192
    user_module_invoke('insert', $array, $user, $category);

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
      if ((substr($key, 0, 4) !== 'auth') && (!in_array($key, $user_fields)) && ($value !== null)) {
        $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
193 194
  }

195
  // Save distributed authentication mappings
Dries's avatar
 
Dries committed
196
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
197
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
 
Dries committed
198 199 200 201
      $authmaps[$key] = $value;
    }
  }
  if ($authmaps) {
Dries's avatar
 
Dries committed
202
    user_set_authmaps($user, $authmaps);
Dries's avatar
 
Dries committed
203 204 205 206 207
  }

  return $user;
}

Dries's avatar
Dries committed
208 209 210
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
211
function user_validate_name($name) {
212
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
213 214 215
  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.');
216
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
217 218 219 220 221 222 223 224 225 226 227
  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
228
  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.');
229
  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
230 231 232
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
233
  if (!$mail) return t('You must enter an e-mail address.');
234
  if (!valid_email_address($mail)) {
235
    return t('The e-mail address %mail is not valid.', array('%mail' => theme('placeholder', $mail)));
Dries's avatar
 
Dries committed
236 237 238
  }
}

Dries's avatar
 
Dries committed
239
function user_validate_picture($file, &$edit, $user) {
Dries's avatar
Dries committed
240
  // Initialize the picture:
Dries's avatar
 
Dries committed
241 242
  $edit['picture'] = $user->picture;

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

248
  if (!$info || !$info['extension']) {
Dries's avatar
 
Dries committed
249
    form_set_error('picture', t('The uploaded file was not an image.'));
Dries's avatar
 
Dries committed
250
  }
251 252
  else if (image_get_toolkit()) {
    image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
Dries's avatar
 
Dries committed
253
  }
254 255 256
  else if (filesize($file->filepath) > (variable_get('user_picture_file_size', '30') * 1000)) {
    form_set_error('picture', t('The uploaded image is too large; the maximum file size is %size kB.', array('%size' => variable_get('user_picture_file_size', '30'))));
  }
257 258
  else if ($info['width'] > $maxwidth || $info['height'] > $maxheight) {
    form_set_error('picture', 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
259
  }
260 261 262 263 264 265 266 267

  if (!form_get_errors()) {
    if ($file = file_save_upload('picture', variable_get('user_picture_path', 'pictures') .'/picture-'. $user->uid . '.' . $info['extension'], 1)) {
      $edit['picture'] = $file->filepath;
    }
    else {
      form_set_error('picture', t("Failed to upload the picture image; the %directory directory doesn't exist.", array('%directory' => '<em>'. variable_get('user_picture_path', 'pictures') .'</em>')));
    }
Dries's avatar
 
Dries committed
268 269 270
  }
}

271
function user_validate_authmap($account, $authname, $module) {
Dries's avatar
 
Dries committed
272
  $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid != %d AND authname = '%s'", $account->uid, $authname);
Dries's avatar
 
Dries committed
273
  if (db_result($result) > 0) {
Dries's avatar
 
Dries committed
274
    $name = module_invoke($module, 'info', 'name');
275
    return t('The %u ID %s is already taken.', array('%u' => $name, '%s' => theme('placeholder', $authname)));
Dries's avatar
 
Dries committed
276
  }
Dries's avatar
 
Dries committed
277 278
}

Dries's avatar
Dries committed
279 280 281
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
282 283 284 285 286
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
  // password.  Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two.  The same is true
  // of 'I' and 1.
Dries's avatar
Dries committed
287 288
  $allowable_characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';

Dries's avatar
 
Dries committed
289 290 291
  // We see how many characters are in the allowable list:
  $len = strlen($allowable_characters);

Dries's avatar
Dries committed
292
  // Seed the random number generator with the microtime stamp.
Dries's avatar
 
Dries committed
293
  mt_srand((double)microtime() * 1000000);
Dries's avatar
 
Dries committed
294

Dries's avatar
Dries committed
295 296
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
297

Dries's avatar
Dries committed
298
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
299 300 301 302 303 304 305 306
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
    $pass .= $allowable_characters[mt_rand(0, $len - 1)];
  }

  return $pass;
Dries's avatar
 
Dries committed
307 308
}

Dries's avatar
Dries committed
309 310 311 312 313
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
314 315
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
316 317
 *
 * @return
318
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
319 320 321 322 323
 *
 * 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
324
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
325
  global $user;
Dries's avatar
 
Dries committed
326
  static $perm = array();
Dries's avatar
 
Dries committed
327

328 329 330 331
  if (is_null($account)) {
    $account = $user;
  }

332
  // User #1 has all privileges:
333
  if ($account->uid == 1) {
334
    return TRUE;
Dries's avatar
 
Dries committed
335 336
  }

Dries's avatar
Dries committed
337 338
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
Dries's avatar
 
Dries committed
339 340
  if (!isset($perm[$account->uid])) {
    $result = db_query('SELECT DISTINCT(p.perm) FROM {role} r INNER JOIN {permission} p ON p.rid = r.rid INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d', $account->uid);
Dries's avatar
 
Dries committed
341

Steven Wittens's avatar
Steven Wittens committed
342
    $perm[$account->uid] = '';
Dries's avatar
 
Dries committed
343
    while ($row = db_fetch_object($result)) {
344
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
345
    }
Dries's avatar
 
Dries committed
346
  }
347

348
  if (isset($perm[$account->uid])) {
349
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
350
  }
351

352
  return FALSE;
Dries's avatar
 
Dries committed
353 354
}

355 356 357 358 359 360 361 362 363 364 365 366
/**
 * 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
367 368 369
/**
 * Send an e-mail message.
 */
Dries's avatar
 
Dries committed
370
function user_mail($mail, $subject, $message, $header) {
Dries's avatar
Dries committed
371 372
  if (variable_get('smtp_library', '') && file_exists(variable_get('smtp_library', ''))) {
    include_once variable_get('smtp_library', '');
373
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
374 375
  }
  else {
376 377
    /*
    ** Note: if you are having problems with sending mail, or mails look wrong
378
    ** when they are received you may have to modify the str_replace to suit
379 380 381 382
    ** 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
383 384 385 386 387 388 389 390 391 392 393 394
    **
    ** 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
    ** Internet email, with lines of no more than 997 characters (by
    ** 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
    **
395
    */
Dries's avatar
 
Dries committed
396 397
    return mail(
      $mail,
Dries's avatar
 
Dries committed
398
      mime_header_encode($subject),
Dries's avatar
Dries committed
399
      str_replace("\r", '', $message),
Dries's avatar
 
Dries committed
400
      "MIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8; format=flowed\nContent-transfer-encoding: 8Bit\n" . $header
Dries's avatar
 
Dries committed
401
    );
Dries's avatar
 
Dries committed
402 403 404
  }
}

Dries's avatar
 
Dries committed
405 406
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
407

Dries's avatar
 
Dries committed
408
  if (!$fields) {
Dries's avatar
Dries committed
409
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
410 411 412
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
413 414
    else {
      // Make sure we return the default fields at least
415
      $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
416
    }
Dries's avatar
 
Dries committed
417
  }
Dries's avatar
 
Dries committed
418

Dries's avatar
 
Dries committed
419
  return $fields;
Dries's avatar
 
Dries committed
420 421
}

Dries's avatar
Dries committed
422 423 424
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
425
function user_perm() {
426
  return array('administer users', 'access user profiles');
Dries's avatar
 
Dries committed
427 428
}

Dries's avatar
Dries committed
429 430 431 432 433
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
434
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
435
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
436 437
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
438 439 440
  }
}

Dries's avatar
Dries committed
441 442 443
/**
 * Implementation of hook_search().
 */
444 445 446
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
447 448 449
      if (user_access('access user profiles')) {
        return t('users');
      }
450
    case 'search':
451 452 453 454 455 456
      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)) {
457
          $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid));
458 459
        }
        return $find;
460
      }
Dries's avatar
 
Dries committed
461 462 463
  }
}

Dries's avatar
Dries committed
464 465 466
/**
 * Implementation of hook_user().
 */
467
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
468
  if ($type == 'view') {
Dries's avatar
Dries committed
469
    return array(t('History') => form_item(t('Member for'), format_interval(time() - $user->created)));
Dries's avatar
Dries committed
470
  }
471 472 473 474 475 476 477 478 479 480 481 482

  if ($type == 'form' && $category == 'account') {
    return user_edit_form(arg(1), $edit);
  }

  if ($type == 'validate' && $category == 'account') {
    return user_edit_validate(arg(1), $edit);
  }

  if ($type == 'categories') {
    return array(array('name' => 'account', 'title' => t('account settings'), 'weight' => 1));
  }
Dries's avatar
Dries committed
483 484
}

Dries's avatar
Dries committed
485 486 487
/**
 * Implementation of hook_block().
 */
488
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
489 490
  global $user;

Dries's avatar
Dries committed
491 492 493 494 495
  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');
496

497
     return $blocks;
498
  }
499 500 501 502 503 504 505 506 507 508 509 510
  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');
    $output = form_select(t('User activity'), 'user_block_seconds_online', variable_get('user_block_seconds_online', 900), $period, t('A user is considered online for this long after they have last viewed a page.'));
    $output .= form_select(t('User list length'), 'user_block_max_list_count', variable_get('user_block_max_list_count', 10), drupal_map_assoc(array(0, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100)), t('Maximum number of currently online users to display.'));

    return $output;
  }
  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
511 512
    $block = array();

Dries's avatar
 
Dries committed
513 514
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
515 516
        // 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
517
          $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
518

Dries's avatar
 
Dries committed
519 520
          $output = "<div class=\"user-login-block\">\n";

Dries's avatar
Dries committed
521 522 523 524 525 526 527
          // NOTE: special care needs to be taken because on pages with forms,
          // such as node and comment submission pages, the $edit variable
          // might already be set.

          $output .= form_textfield(t('Username'), 'name', $edit['name'], 15, 64);
          $output .= form_password(t('Password'), 'pass', $pass, 15, 64);
          $output .= form_submit(t('Log in'));
Dries's avatar
 
Dries committed
528
          $output .= "</div>\n";
Dries's avatar
 
Dries committed
529

530
          $output  = form($output, 'post', url('user/login', drupal_get_destination()));
Dries's avatar
 
Dries committed
531

Dries's avatar
Dries committed
532 533
          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
534
          }
Dries's avatar
Dries committed
535
          $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
Dries's avatar
 
Dries committed
536

Dries's avatar
Dries committed
537
          $output .= theme('item_list', $items);
538

Dries's avatar
Dries committed
539 540
          $block['subject'] = t('User login');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
541
        }
Dries's avatar
Dries committed
542
        return $block;
Dries's avatar
Dries committed
543

544
      case 1:
Dries's avatar
 
Dries committed
545
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
546 547
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
           $block['content'] = '<div class="menu">'. $menu .'</div>';
Dries's avatar
 
Dries committed
548
        }
549
        return $block;
Dries's avatar
Dries committed
550

Dries's avatar
 
Dries committed
551
      case 2:
552
        if (user_access('access content')) {
553
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 ORDER BY created DESC', 0, 5);
554
          while ($account = db_fetch_object($result)) {
555
            $items[] = $account;
556
          }
Dries's avatar
Dries committed
557
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
558

Dries's avatar
Dries committed
559 560
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
561
        }
Dries's avatar
Dries committed
562 563
        return $block;

Dries's avatar
 
Dries committed
564
      case 3:
565
        if (user_access('access content')) {
Dries's avatar
Dries committed
566 567
          // Count users with activity in the past defined period.
          $time_period = variable_get('user_block_seconds_online', 2700);
Dries's avatar
 
Dries committed
568

Dries's avatar
Dries committed
569
          // Perform database queries to gather online user lists.
Dries's avatar
 
Dries committed
570
          $guests = db_fetch_object(db_query('SELECT COUNT(sid) AS count FROM {sessions} WHERE timestamp >= %d AND uid = 0', time() - $time_period));
571
          $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
572
          $total_users = db_num_rows($users);
Dries's avatar
 
Dries committed
573

Dries's avatar
Dries committed
574
          // Format the output with proper grammar.
Dries's avatar
 
Dries committed
575
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
576
            $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
577 578
          }
          else {
Dries's avatar
Dries committed
579
            $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
580 581
          }

582 583
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
584 585 586 587 588 589 590 591
          $items = array();

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

          if ($items) {
            $output .= theme('user_list', $items, t('Online users'));
Dries's avatar
 
Dries committed
592
          }
593

Dries's avatar
Dries committed
594 595
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
596
        }
Dries's avatar
 
Dries committed
597
        return $block;
Dries's avatar
 
Dries committed
598 599
    }
  }
600 601
}

Dries's avatar
 
Dries committed
602 603 604 605 606 607 608 609 610 611
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', '');
    }

    if ($picture) {
Dries's avatar
Dries committed
612
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
613
      $picture = theme('image', $picture, $alt, $alt, '', false);
Dries's avatar
 
Dries committed
614
      if ($account->uid) {
615
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')), NULL, NULL, FALSE, TRUE);
Dries's avatar
 
Dries committed
616 617 618 619 620 621 622
      }

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

Dries's avatar
Dries committed
623
function theme_user_profile($account, $fields) {
Dries's avatar
 
Dries committed
624 625
  $output = "<div class=\"profile\">\n";
  $output .= theme('user_picture', $account);
Dries's avatar
Dries committed
626
  foreach ($fields as $category => $value) {
627
    $output .= theme('box', $category, $value);
Dries's avatar
Dries committed
628
  }
Dries's avatar
 
Dries committed
629 630 631 632 633
  $output .= "</div>\n";

  return $output;
}

634 635 636 637 638 639 640 641
/**
 * 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) {
  foreach ($users as $user) {
642
    $items[] = theme('username', $user);
643
  }
Dries's avatar
Dries committed
644
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
645 646
}

Dries's avatar
 
Dries committed
647
/**
Dries's avatar
 
Dries committed
648
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
649
 */
Dries's avatar
 
Dries committed
650
function user_menu($may_cache) {
Dries's avatar
 
Dries committed
651
  global $user;
Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653
  $items = array();
Dries's avatar
 
Dries committed
654

655 656 657
  $admin_access = user_access('administer users');
  // users should always be allowed to see their own user page
  $view_access = (user_access('access user profiles') || ($user->uid == arg(1)));
Dries's avatar
 
Dries committed
658

Dries's avatar
 
Dries committed
659
  if ($may_cache) {
Dries's avatar
 
Dries committed
660
    $items[] = array('path' => 'user', 'title' => t('user account'),
Dries's avatar
 
Dries committed
661
      'callback' => 'user_page', 'access' => TRUE, 'type' => MENU_CALLBACK);
662

Steven Wittens's avatar
Steven Wittens committed
663 664 665
    $items[] = array('path' => 'user/autocomplete', 'title' => t('user autocomplete'),
      'callback' => 'user_autocomplete', 'access' => $admin_access, 'type' => MENU_CALLBACK);

666
    //registration and login pages.
Dries's avatar
 
Dries committed
667 668
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
 
Dries committed
669
    $items[] = array('path' => 'user/register', 'title' => t('register'),
Dries's avatar
 
Dries committed
670
      'callback' => 'user_page', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
671
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
672
      'callback' => 'user_pass', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
673 674
    $items[] = array('path' => 'user/reset', 'title' => t('reset password'),
      'callback' => 'user_pass_reset', 'access' => $user->uid == 0, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
675 676
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
677

678
    //admin pages
Dries's avatar
 
Dries committed
679
    $items[] = array('path' => 'admin/user', 'title' => t('users'),
680
      'callback' => 'user_admin', 'access' => $admin_access);
Dries's avatar
 
Dries committed
681
    $items[] = array('path' => 'admin/user/list', 'title' => t('list'),
Dries's avatar
 
Dries committed
682
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
683
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
684
      'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
685
      'type' => MENU_LOCAL_TASK);
686 687
    $items[] = array('path' => 'admin/settings/user', 'title' => t('users'),
      'callback' => 'user_configure', 'access' => $admin_access);
688
    $items[] = array('path' => 'admin/access', 'title' => t('access control'),
689
      'callback' => 'user_admin_perm', 'access' => $admin_access);
690
    $items[] = array('path' => 'admin/access/permissions', 'title' => t('permissions'),
691
      'callback' => 'user_admin_perm', 'access' => $admin_access,
Dries's avatar
 
Dries committed
692
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
693
    $items[] = array('path' => 'admin/access/roles', 'title' => t('roles'),
694
      'callback' => 'user_admin_role', 'access' => $admin_access,
Dries's avatar
 
Dries committed
695
      'type' => MENU_LOCAL_TASK);
696
    $items[] = array('path' => 'admin/access/roles/edit', 'title' => t('edit role'),
697
      'callback' => 'user_admin_role', 'access' => $admin_access,
698
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
699
    $items[] = array('path' => 'admin/access/rules', 'title' => t('access rules'),
700
      'callback' => 'user_admin_access', 'access' => $admin_access,
701 702
      'type' => MENU_LOCAL_TASK, 'weight' => 10);
    $items[] = array('path' => 'admin/access/rules/list', 'title' => t('list'),
703
      'access' => $admin_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
704
    $items[] = array('path' => 'admin/access/rules/add', 'title' => t('add rule'),
705
      'callback' => 'user_admin_access_add', 'access' => $admin_access,
Dries's avatar
 
Dries committed
706
      'type' => MENU_LOCAL_TASK);
707
    $items[] = array('path' => 'admin/access/rules/check', 'title' => t('check rules'),
708
      'callback' => 'user_admin_access_check', 'access' => $admin_access,
Dries's avatar
 
Dries committed
709
      'type' => MENU_LOCAL_TASK);
710
    $items[] = array('path' => 'admin/access/rules/edit', 'title' => t('edit rule'),
711
      'callback' => 'user_admin_access_edit', 'access' => $admin_access,
712
      'type' => MENU_CALLBACK);
713
    $items[] = array('path' => 'admin/access/rules/delete', 'title' => t('delete rule'),
714
      'callback' => 'user_admin_access_delete', 'access' => $admin_access,
715
      'type' => MENU_CALLBACK);
716

Dries's avatar
 
Dries committed
717 718
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
719
        'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
720
        'type' => MENU_LOCAL_TASK);
721
    }
Dries's avatar
 
Dries committed
722

723
    //Your personal page
Dries's avatar
 
Dries committed
724 725
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
726 727
        'callback' => 'user_page', 'access' => TRUE,
        'type' => MENU_DYNAMIC_ITEM);
Dries's avatar
 
Dries committed
728
    }
Dries's avatar
 
Dries committed
729 730 731 732 733

    $items[] = array('path' => 'logout', 'title' => t('log out'),
      'access' => $user->uid != 0,
      'callback' => 'user_logout',
      'weight' => 10);
Dries's avatar
 
Dries committed
734 735
  }
  else {
Dries's avatar
 
Dries committed
736 737
    if (arg(0) == 'user' && is_numeric(arg(1))) {
      $items[] = array('path' => 'user/'. arg(1), 'title' => t('user'),
738
        'type' => MENU_CALLBACK, 'callback' => 'user_page', 'access' => $view_access);
Dries's avatar
 
Dries committed
739
      $items[] = array('path' => 'user/'. arg(1) .'/view', 'title' => t('view'),
740
        'access' => $view_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
741
      $items[] = array('path' => 'user/'. arg(1) .'/edit', 'title' => t('edit'),
742
        'callback' => 'user_edit', 'access' => $admin_access || $user->uid == arg(1),
Dries's avatar
 
Dries committed
743
        'type' => MENU_LOCAL_TASK);
744
      $items[] = array('path' => 'user/'. arg(1) .'/delete', 'title' => t('delete'),
745
        'callback' => 'user_edit', 'access' => $admin_access,
746
        'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
747 748 749 750

      if (arg(2) == 'edit') {
        if (($categories = _user_categories()) && (count($categories) > 1)) {
          foreach ($categories as $key => $category) {
751 752 753
            $items[] = array(
              'path' => 'user/'. arg(1) .'/edit/'. $category['name'],
              'title' => $category['title'],
Dries's avatar
 
Dries committed
754
              'type' => $category['name'] == 'account' ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
755
              'weight' => $category['weight'],
756
              'access' => ($admin_access || $user->uid == arg(1)));
Dries's avatar
 
Dries committed
757 758 759 760
          }
        }
      }
    }
Dries's avatar
 
Dries committed
761
  }
Dries's avatar
 
Dries committed
762 763

  return $items;
Dries's avatar
 
Dries committed
764 765
}

Dries's avatar
Dries committed
766 767 768
/**
 * Called by authentication modules in order to edit/view their authmap information.
 */
769
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
770
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
771 772 773
  return db_result($result);
}

Dries's avatar
Dries committed
774 775 776 777
/**
 * Accepts an user object, $account, or a DA name and returns an associative
 * array of modules and DA names. Called at external login.
 */
778
function user_get_authmaps($authname = NULL) {
Dries's avatar
 
Dries committed
779
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
780 781 782 783 784 785 786 787 788 789 790 791 792
  if (db_num_rows($result) > 0) {
    while ($authmap = db_fetch_object($result)) {
      $authmaps[$authmap->module] = $authmap->authname;
    }
    return $authmaps;
  }
  else {
    return 0;
  }
}

function user_set_authmaps($account, $authmaps) {
  foreach ($authmaps as $key => $value) {
Dries's avatar
Dries committed
793
    $module = explode('_', $key, 2);
Dries's avatar
 
Dries committed
794
    if ($value) {
Dries's avatar
Dries committed
795
      db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module['1']);
Dries's avatar
 
Dries committed
796 797
      if (!db_affected_rows()) {
        db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
Dries's avatar
 
Dries committed
798 799 800
      }
    }
    else {
Dries's avatar
Dries committed
801
      db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module['1']);
Dries's avatar
 
Dries committed
802 803 804 805 806
    }
  }
}

function user_auth_help_links() {
807
  $links = array();
Dries's avatar
 
Dries committed
808
  foreach (module_list() as $module) {
Dries's avatar
Dries committed
809
    if (module_hook($module, 'auth')) {
Dries's avatar
 
Dries committed
810
      $links[] = l(module_invoke($module, 'info', 'name'), "user/help#$module");
Dries's avatar
 
Dries committed
811 812 813 814 815 816 817
    }
  }
  return $links;
}

/*** User features *********************************************************/

Dries's avatar
Dries committed
818
function user_login($edit = array(), $msg = '') {
Dries's avatar
 
Dries committed
819
  global $user, $base_url;
Dries's avatar
 
Dries committed
820

Dries's avatar
Dries committed
821
  // If we are already logged on, go to the user page instead.
Dries's avatar
 
Dries committed
822
  if ($user->uid) {
Dries's avatar
Dries committed
823
    drupal_goto('user');
Dries's avatar
 
Dries committed