user.module 79.5 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 53
      $query .= "u.$key = '%s' AND ";
      $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) = '%s' AND ";
      $params[] = strtolower($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 69
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
    user_module_invoke('load', $array, $user);
Dries's avatar
 
Dries committed
70

71 72 73 74 75 76 77 78
    $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;
    }
  }
  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 92 93 94 95
/**
 * 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');
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
96
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
97
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
98
  $user_fields = user_fields();
Dries's avatar
 
Dries committed
99
  if ($account->uid) {
100
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
 
Dries committed
101

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

Dries's avatar
 
Dries committed
129
    db_query("UPDATE {users} SET $query changed = %d WHERE uid = %d", array_merge($v, array(time(), $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
    // Refresh user object
Dries's avatar
 
Dries committed
141
    $user = user_load(array('uid' => $account->uid));
Dries's avatar
 
Dries committed
142 143
  }
  else {
Dries's avatar
 
Dries committed
144 145
    $array['created'] = time();
    $array['changed'] = time();
Dries's avatar
Dries committed
146
    $array['uid'] = db_next_id('{users}_uid');
Dries's avatar
 
Dries committed
147

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

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

173 174
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
175

176 177 178 179 180 181 182 183 184 185 186 187 188
    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
189 190
  }

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

  return $user;
}

Dries's avatar
Dries committed
204 205 206
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
207
function user_validate_name($name) {
Dries's avatar
Dries committed
208 209 210 211
  if (!$name) return t('You must enter a username.');
  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.');
212
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
Dries's avatar
Dries committed
213
  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.');
Dries's avatar
 
Dries committed
214
  if (strlen($name) > 56) return t('The username %name is too long: it must be less than 56 characters.', array('%name' => "<em>$name</em>"));
Dries's avatar
 
Dries committed
215 216 217
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
218
  if (!$mail) return t('You must enter an e-mail address.');
219
  if (!valid_email_address($mail)) {
Dries's avatar
 
Dries committed
220
    return t('The e-mail address %mail is not valid.', array('%mail' => "<em>$mail</em>"));
Dries's avatar
 
Dries committed
221 222 223
  }
}

Dries's avatar
 
Dries committed
224
function user_validate_picture($file, &$edit, $user) {
Dries's avatar
Dries committed
225
  // Initialize the picture:
Dries's avatar
 
Dries committed
226 227
  $edit['picture'] = $user->picture;

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

233
  if (!$info || !$info['extension']) {
Dries's avatar
 
Dries committed
234
    form_set_error('picture', t('The uploaded file was not an image.'));
Dries's avatar
 
Dries committed
235
  }
236 237
  else if (image_get_toolkit()) {
    image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
Dries's avatar
 
Dries committed
238
  }
239 240 241
  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'))));
  }
242 243
  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
244
  }
245 246 247 248 249 250 251 252

  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
253 254 255
  }
}

256
function user_validate_authmap($account, $authname, $module) {
Dries's avatar
 
Dries committed
257
  $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid != %d AND authname = '%s'", $account->uid, $authname);
Dries's avatar
 
Dries committed
258
  if (db_result($result) > 0) {
Dries's avatar
 
Dries committed
259
    $name = module_invoke($module, 'info', 'name');
Dries's avatar
 
Dries committed
260
    return t('The %u ID %s is already taken.', array('%u' => $name, '%s' => "<em>$authname</em>"));
Dries's avatar
 
Dries committed
261
  }
Dries's avatar
 
Dries committed
262 263
}

Dries's avatar
Dries committed
264 265 266
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
267 268 269 270 271
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
272 273
  $allowable_characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';

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

Dries's avatar
Dries committed
277
  // Seed the random number generator with the microtime stamp.
Dries's avatar
 
Dries committed
278
  mt_srand((double)microtime() * 1000000);
Dries's avatar
 
Dries committed
279

Dries's avatar
Dries committed
280 281
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
282

Dries's avatar
Dries committed
283
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
284 285 286 287 288 289 290 291
  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
292 293
}

Dries's avatar
Dries committed
294 295 296 297 298
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
299 300
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
301 302 303 304 305 306 307 308
 *
 * @return
 *   TRUE iff the current user has the requested permission.
 *
 * 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
309
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
310
  global $user;
Dries's avatar
 
Dries committed
311
  static $perm = array();
Dries's avatar
 
Dries committed
312

313 314 315 316
  if (is_null($account)) {
    $account = $user;
  }

317
  // User #1 has all privileges:
Dries's avatar
 
Dries committed
318
  if ($account->uid == 1) {
Dries's avatar
 
Dries committed
319 320 321
    return 1;
  }

Dries's avatar
Dries committed
322 323
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
Dries's avatar
 
Dries committed
324 325
  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
326 327

    while ($row = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
328
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
329
    }
Dries's avatar
 
Dries committed
330 331
  }

Dries's avatar
 
Dries committed
332
  return strstr($perm[$account->uid], "$string, ");
Dries's avatar
 
Dries committed
333 334
}

Dries's avatar
Dries committed
335 336 337
/**
 * Send an e-mail message.
 */
Dries's avatar
 
Dries committed
338
function user_mail($mail, $subject, $message, $header) {
Dries's avatar
Dries committed
339 340
  if (variable_get('smtp_library', '') && file_exists(variable_get('smtp_library', ''))) {
    include_once variable_get('smtp_library', '');
341
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
342 343
  }
  else {
344 345
    /*
    ** Note: if you are having problems with sending mail, or mails look wrong
346
    ** when they are received you may have to modify the str_replace to suit
347 348 349 350
    ** 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
351 352 353 354 355 356 357 358 359 360 361 362
    **
    ** 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
    **
363
    */
Dries's avatar
 
Dries committed
364 365
    return mail(
      $mail,
Dries's avatar
 
Dries committed
366
      mime_header_encode($subject),
Dries's avatar
Dries committed
367
      str_replace("\r", '', $message),
Dries's avatar
 
Dries committed
368
      "MIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8; format=flowed\nContent-transfer-encoding: 8Bit\n" . $header
Dries's avatar
 
Dries committed
369
    );
Dries's avatar
 
Dries committed
370 371 372 373
  }
}

function user_deny($type, $mask) {
Dries's avatar
Dries committed
374 375
  $allow = db_fetch_object(db_query("SELECT * FROM {access} WHERE status = 1 AND type = '%s' AND LOWER('%s') LIKE LOWER(mask)", $type, $mask));
  $deny = db_fetch_object(db_query("SELECT * FROM {access} WHERE status = 0 AND type = '%s' AND LOWER('%s') LIKE LOWER(mask)", $type, $mask));
Dries's avatar
 
Dries committed
376

Dries's avatar
 
Dries committed
377
  return $deny && !$allow;
Dries's avatar
 
Dries committed
378 379
}

Dries's avatar
 
Dries committed
380 381
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
382

Dries's avatar
 
Dries committed
383
  if (!$fields) {
Dries's avatar
Dries committed
384
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
385 386 387
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
388 389
    else {
      // Make sure we return the default fields at least
Dries's avatar
 
Dries committed
390
      $fields = array('uid', 'name', 'pass', 'mail', 'picture', 'mode', 'sort', 'threshold', 'theme', 'signature', 'created', 'changed', 'status', 'timezone', 'language', 'init', 'data');
Dries's avatar
 
Dries committed
391
    }
Dries's avatar
 
Dries committed
392
  }
Dries's avatar
 
Dries committed
393

Dries's avatar
 
Dries committed
394
  return $fields;
Dries's avatar
 
Dries committed
395 396
}

Dries's avatar
Dries committed
397 398 399
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
400
function user_perm() {
401
  return array('administer users');
Dries's avatar
 
Dries committed
402 403
}

Dries's avatar
Dries committed
404 405 406 407 408
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
409
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
410
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
411 412
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
413 414 415
  }
}

Dries's avatar
Dries committed
416 417 418
/**
 * Implementation of hook_search().
 */
419 420 421 422 423 424 425
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
      return t('users');
    case 'search':
      $find = array();
      // Replace wildcards with MySQL/PostgreSQL wildcards.
426 427
      $keys = preg_replace('!\*+!', '%', $keys);
      $result = pager_query("SELECT * FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
428 429 430 431
      while ($account = db_fetch_object($result)) {
        $find[] = array('title' => $account->name, 'link' => url("user/$account->uid/view"));
      }
      return $find;
Dries's avatar
 
Dries committed
432 433 434
  }
}

Dries's avatar
Dries committed
435 436 437
/**
 * Implementation of hook_user().
 */
438
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
439
  if ($type == 'view') {
Dries's avatar
Dries committed
440
    return array(t('History') => form_item(t('Member for'), format_interval(time() - $user->created)));
Dries's avatar
Dries committed
441
  }
442 443 444 445 446 447 448 449 450 451 452 453

  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
454 455
}

Dries's avatar
Dries committed
456 457 458
/**
 * Implementation of hook_block().
 */
459
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
460 461
  global $user;

Dries's avatar
Dries committed
462 463 464 465 466
  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');
467

468
     return $blocks;
469
  }
470 471 472 473 474 475 476 477 478 479 480 481
  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
482 483
    $block = array();

Dries's avatar
 
Dries committed
484 485
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
486 487
        // 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
488
          $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
489

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

Dries's avatar
Dries committed
492 493 494 495 496 497 498
          // 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
499
          $output .= "</div>\n";
Dries's avatar
 
Dries committed
500

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

Dries's avatar
Dries committed
503 504
          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
505
          }
Dries's avatar
Dries committed
506
          $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
Dries's avatar
 
Dries committed
507

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

Dries's avatar
Dries committed
510 511
          $block['subject'] = t('User login');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
512
        }
Dries's avatar
Dries committed
513
        return $block;
Dries's avatar
Dries committed
514

515
      case 1:
Dries's avatar
 
Dries committed
516
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
517 518
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
           $block['content'] = '<div class="menu">'. $menu .'</div>';
Dries's avatar
 
Dries committed
519
        }
520
        return $block;
Dries's avatar
Dries committed
521

Dries's avatar
 
Dries committed
522
      case 2:
Dries's avatar
Dries committed
523 524
        if (user_access('access content')) {
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 ORDER BY uid DESC', 0, 5);
525
          while ($account = db_fetch_object($result)) {
526
            $items[] = format_name($account);
527
          }
Dries's avatar
 
Dries committed
528

Dries's avatar
Dries committed
529
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
530

Dries's avatar
Dries committed
531 532
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
533
        }
Dries's avatar
Dries committed
534 535
        return $block;

Dries's avatar
 
Dries committed
536
      case 3:
Dries's avatar
Dries committed
537 538 539
        if (user_access('access content')) {
          // Count users with activity in the past defined period.
          $time_period = variable_get('user_block_seconds_online', 2700);
Dries's avatar
 
Dries committed
540

Dries's avatar
Dries committed
541
          // Perform database queries to gather online user lists.
Dries's avatar
 
Dries committed
542
          $guests = db_fetch_object(db_query('SELECT COUNT(sid) AS count FROM {sessions} WHERE timestamp >= %d AND uid = 0', time() - $time_period));
Dries's avatar
 
Dries committed
543
          $users = db_query('SELECT DISTINCT(uid), MAX(timestamp) AS max_timestamp FROM {sessions} WHERE timestamp >= %d AND uid != 0 GROUP BY uid ORDER BY max_timestamp DESC', time() - $time_period );
Dries's avatar
 
Dries committed
544
          $total_users = db_num_rows($users);
Dries's avatar
 
Dries committed
545

Dries's avatar
Dries committed
546
          // Format the output with proper grammar.
Dries's avatar
 
Dries committed
547
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
548
            $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
549 550
          }
          else {
Dries's avatar
Dries committed
551
            $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
552 553
          }

554 555 556 557
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
          if ($max_users) {
            $items = array();
Dries's avatar
 
Dries committed
558

559 560 561
            while ($max_users-- && $uid = db_fetch_object($users)) {
              $items[] = format_name(user_load(array('uid' => $uid->uid)));
            }
Dries's avatar
 
Dries committed
562

563 564 565
            if ($items) {
              if (db_fetch_object($users)) {
                $items[] = '...';
Dries's avatar
 
Dries committed
566
              }
567
              $output .= theme('item_list', $items, t('Online users:'));
Dries's avatar
 
Dries committed
568
            }
Dries's avatar
 
Dries committed
569
          }
570

Dries's avatar
Dries committed
571 572
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
573
        }
Dries's avatar
 
Dries committed
574
        return $block;
Dries's avatar
 
Dries committed
575 576
    }
  }
577 578
}

Dries's avatar
 
Dries committed
579 580 581 582 583 584 585 586 587 588
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
589
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
590
      $picture = theme('image', $picture, $alt, $alt, '', false);
Dries's avatar
 
Dries committed
591
      if ($account->uid) {
592
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')));
Dries's avatar
 
Dries committed
593 594 595 596 597 598 599
      }

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

Dries's avatar
Dries committed
600
function theme_user_profile($account, $fields) {
Dries's avatar
 
Dries committed
601 602
  $output = "<div class=\"profile\">\n";
  $output .= theme('user_picture', $account);
Dries's avatar
Dries committed
603 604 605
  foreach ($fields as $category => $value) {
    $output .= "<h2>$category</h2>$value";
  }
Dries's avatar
 
Dries committed
606 607 608 609 610
  $output .= "</div>\n";

  return $output;
}

Dries's avatar
 
Dries committed
611
function theme_user_list($items, $title = NULL) {
Dries's avatar
Dries committed
612
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
613 614
}

Dries's avatar
 
Dries committed
615
/**
Dries's avatar
 
Dries committed
616
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
617
 */
Dries's avatar
 
Dries committed
618
function user_menu($may_cache) {
Dries's avatar
 
Dries committed
619
  global $user;
Dries's avatar
 
Dries committed
620

Dries's avatar
 
Dries committed
621
  $items = array();
Dries's avatar
 
Dries committed
622

Dries's avatar
 
Dries committed
623 624
  $access = user_access('administer users');

Dries's avatar
 
Dries committed
625
  if ($may_cache) {
Dries's avatar
 
Dries committed
626
    $items[] = array('path' => 'user', 'title' => t('user account'),
Dries's avatar
 
Dries committed
627
      'callback' => 'user_page', 'access' => TRUE, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
628 629
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
 
Dries committed
630
    $items[] = array('path' => 'user/register', 'title' => t('register'),
Dries's avatar
 
Dries committed
631
      'callback' => 'user_page', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
632
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
633
      'callback' => 'user_pass', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
634 635
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
636 637 638 639

    $items[] = array('path' => 'admin/user', 'title' => t('users'),
      'callback' => 'user_admin', 'access' => $access);
    $items[] = array('path' => 'admin/user/list', 'title' => t('list'),
Dries's avatar
 
Dries committed
640
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
641
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
Dries's avatar
 
Dries committed
642 643 644 645 646
      'callback' => 'user_admin', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/user/configure', 'title' => t('configure'),
      'callback' => 'user_configure', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
647 648 649

    $items[] = array('path' => 'admin/access', 'title' => t('access control'),
      'callback' => 'user_admin_perm', 'access' => $access);
650
    $items[] = array('path' => 'admin/access/permissions', 'title' => t('permissions'),
651
      'callback' => 'user_admin_perm', 'access' => $access,
Dries's avatar
 
Dries committed
652
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
653 654
    $items[] = array('path' => 'admin/access/roles', 'title' => t('roles'),
      'callback' => 'user_admin_role', 'access' => $access,
Dries's avatar
 
Dries committed
655
      'type' => MENU_LOCAL_TASK);
656 657 658 659 660 661 662 663 664 665
    $items[] = array('path' => 'admin/access/roles/edit', 'title' => t('edit role'),
      'callback' => 'user_admin_role', 'access' => $access,
      'type' => MENU_CALLBACK);

    $items[] = array('path' => 'admin/access/rules', 'title' => t('account rules'),
      'callback' => 'user_admin_access', 'access' => $access,
      'type' => MENU_LOCAL_TASK, 'weight' => 10);
    $items[] = array('path' => 'admin/access/rules/list', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/access/rules/add', 'title' => t('add rule'),
666
      'callback' => 'user_admin_access_add', 'access' => $access,
Dries's avatar
 
Dries committed
667
      'type' => MENU_LOCAL_TASK);
668 669
    $items[] = array('path' => 'admin/access/rules/check', 'title' => t('check rules'),
      'callback' => 'user_admin_access_check', 'access' => $access,
Dries's avatar
 
Dries committed
670
      'type' => MENU_LOCAL_TASK);
671 672
    $items[] = array('path' => 'admin/access/rules/edit', 'title' => t('edit rule'),
      'callback' => 'user_admin_access_edit', 'access' => $access,
673
      'type' => MENU_CALLBACK);
674
    $items[] = array('path' => 'admin/access/rules/delete', 'title' => t('delete rule'),
675 676
      'callback' => 'user_admin_access_delete', 'access' => $access,
      'type' => MENU_CALLBACK);
677

Dries's avatar
 
Dries committed
678 679 680 681
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
        'callback' => 'user_admin', 'access' => $access,
        'type' => MENU_LOCAL_TASK);
682
    }
Dries's avatar
 
Dries committed
683

Dries's avatar
 
Dries committed
684 685
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
686 687
        'callback' => 'user_page', 'access' => TRUE,
        'type' => MENU_DYNAMIC_ITEM);
Dries's avatar
 
Dries committed
688
    }
Dries's avatar
 
Dries committed
689 690 691 692 693

    $items[] = array('path' => 'logout', 'title' => t('log out'),
      'access' => $user->uid != 0,
      'callback' => 'user_logout',
      'weight' => 10);
Dries's avatar
 
Dries committed
694 695
  }
  else {
Dries's avatar
 
Dries committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
    if (arg(0) == 'user' && is_numeric(arg(1))) {
      $items[] = array('path' => 'user/'. arg(1), 'title' => t('user'),
        'type' => MENU_CALLBACK, 'callback' => 'user_page', 'access' => TRUE);
      $items[] = array('path' => 'user/'. arg(1) .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
      $items[] = array('path' => 'user/'. arg(1) .'/edit', 'title' => t('edit'),
        'callback' => 'user_edit', 'access' => $access || $user->uid == arg(1),
        'type' => MENU_LOCAL_TASK);

      if (arg(2) == 'edit') {
        if (($categories = _user_categories()) && (count($categories) > 1)) {
          foreach ($categories as $key => $category) {
            $items[] = array('path' => 'user/'. arg(1) .'/edit/'. $category['name'], 'title' => $category['title'],
              'type' => $category['name'] == 'account' ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
              'weight' => $category['weight']);
          }
        }
      }
    }
Dries's avatar
 
Dries committed
715
  }
Dries's avatar
 
Dries committed
716 717

  return $items;
Dries's avatar
 
Dries committed
718 719
}

Dries's avatar
Dries committed
720 721 722
/**
 * Called by authentication modules in order to edit/view their authmap information.
 */
723
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
724
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
725 726 727
  return db_result($result);
}

Dries's avatar
Dries committed
728 729 730 731
/**
 * Accepts an user object, $account, or a DA name and returns an associative
 * array of modules and DA names. Called at external login.
 */
732
function user_get_authmaps($authname = NULL) {
Dries's avatar
 
Dries committed
733
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
734 735 736 737 738 739 740 741 742 743 744 745 746
  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
747
    $module = explode('_', $key, 2);
Dries's avatar
 
Dries committed
748
    if ($value) {
Dries's avatar
Dries committed
749
      db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module['1']);
Dries's avatar
 
Dries committed
750 751
      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
752 753 754
      }
    }
    else {
Dries's avatar
Dries committed
755
      db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module['1']);
Dries's avatar
 
Dries committed
756 757 758 759 760
    }
  }
}

function user_auth_help_links() {
761
  $links = array();
Dries's avatar
 
Dries committed
762
  foreach (module_list() as $module) {
Dries's avatar
Dries committed
763
    if (module_hook($module, 'auth')) {
Dries's avatar
 
Dries committed
764
      $links[] = l(module_invoke($module, 'info', 'name'), "user/help#$module");
Dries's avatar
 
Dries committed
765 766 767 768 769 770 771
    }
  }
  return $links;
}

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

Dries's avatar
Dries committed
772
function user_login($edit = array(), $msg = '') {
Dries's avatar
 
Dries committed
773
  global $user, $base_url;
Dries's avatar
 
Dries committed
774

Dries's avatar
Dries committed
775
  // If we are already logged on, go to the user page instead.
Dries's avatar
 
Dries committed
776
  if ($user->uid) {
Dries's avatar
Dries committed
777
    drupal_goto('user');
Dries's avatar
 
Dries committed
778 779
  }

Dries's avatar
 
Dries committed
780
  if (user_deny('user', $edit['name'])) {
Dries's avatar
 
Dries committed
781
    $error = t('The name %s has been denied access.', array('%s' => '<em>'. $edit['name'] .'</em>'));
Dries's avatar
 
Dries committed
782
  }
Dries's avatar
 
Dries committed
783
  else if ($edit['name'] && $edit['pass']) {
Dries's avatar
 
Dries committed
784

Dries's avatar
 
Dries committed
785
    if (!$user->uid) {
786
      $user = user_authenticate($edit['name'], $edit['pass']);
Dries's avatar
 
Dries committed
787 788 789
    }

    if ($user->uid) {
Dries's avatar
 
Dries committed
790
      watchdog('user', t('Session opened for %name.', array('%name' => "<em>$user->name</em>")));
Dries's avatar
 
Dries committed
791

Dries's avatar
Dries committed
792
      // Update the user table timestamp noting user has logged in.
Dries's avatar
 
Dries committed
793
      db_query("UPDATE {users} SET changed = '%d' WHERE uid = '%s'", time(), $user->uid);
Dries's avatar
 
Dries committed
794

Dries's avatar
Dries committed
795
      user_module_invoke('login', $edit, $user);
Dries's avatar
 
Dries committed
796

Dries's avatar
Dries committed
797
      // Redirect the user to the page he logged on from.
798
      drupal_goto();
Dries's avatar
 
Dries committed
799 800 801
    }
    else {
      if (!$error) {
Dries's avatar
Dries committed
802
        $error = t('Sorry.  Unrecognized username or password.') .' '. l(t('Have you forgotten your password?'), 'user/password');
Dries's avatar
 
Dries committed
803
      }
804
      watchdog('user', t('Login attempt failed for %user: %error.', array('%user' => '<em>'. $edit['name'] .'</em>', '%error' => '<em>'. $error .'</em>')));
Dries's avatar
 
Dries committed
805 806 807
    }
  }

Dries's avatar
Dries committed
808
  // Display error message (if any):
Dries's avatar
 
Dries committed
809
  if ($error) {
Dries's avatar
 
Dries committed
810
    drupal_set_message($error, 'error');
Dries's avatar
 
Dries committed
811 812
  }

Dries's avatar
Dries committed
813
  // Display login form:
Dries's avatar
 
Dries committed
814 815 816
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
Dries's avatar
 
Dries committed
817
  if (count(user_auth_help_links()) > 0) {
Dries's avatar
Dries committed
818
    $output .= form_textfield(t('Username'), 'name', $edit['name'], 30, 64, t('Enter your %s username, or an ID from one of our affiliates: %a.', array('%s' => variable_get('site_name', 'local'), '%a' => implode(', ', user_auth_help_links()))));
Dries's avatar
 
Dries committed
819 820
  }
  else {
Dries's avatar
Dries committed
821
    $output .= form_textfield(t('Username'), 'name', $edit['name'], 30, 64, t('Enter your %s username.', array('%s' => variable_get('site_name', 'local'))));
Dries's avatar
 
Dries committed
822
  }
Dries's avatar
Dries committed
823 824
  $output .= form_password(t('Password'), 'pass', $pass, 30, 64, t('Enter the password that accompanies your username.'));
  $output .= form_submit(t('Log in'));
Dries's avatar
 
Dries committed
825

826
  return form($output, 'post', url('user/login', drupal_get_destination()));
Dries's avatar
 
Dries committed
827
}
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845

function user_authenticate($name, $pass) {
  global $user;

  // Try to log in the user locally:
  $user = user_load(array('name' => $name, 'pass' => $pass, 'status' => 1));

  // Strip name and server from ID:
  if ($server = strrchr($name, '@')) {
    $name = substr($name, 0, strlen($name) - strlen($server));
    $server = substr($server, 1);
  }

  // When possible, determine corresponding external auth source. Invoke
  // source, and log in user if successful:
  if (!$user->uid && $server && $result = user_get_authmaps("$name@$server")) {
    if (module_invoke(key($result), 'auth', $name, $pass, $server)) {
      $user = user_external_load("$name@$server");
Dries's avatar
 
Dries committed
846
      watchdog('user', t('External load by %user using module %module.', array('%user' => "<em>$name@$server</em>", '%module' => '<em>'. key($result) .'</em>')));
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
    }
    else {
      $error = t('Invalid password for %s.', array('%s' => "<em>$name@$server</em>"));
    }
  }

  // Try each external authentication source in series. Register user if
  // successful.
  else if (!$user->uid && $server) {
    foreach (module_list() as $module) {
      if (module_hook($module, 'auth')) {
        if (module_invoke($module, 'auth', $name, $pass, $server)) {
          if (variable_get('user_register', 1) == 1) {
            $account = user_load(array('name' => "$name@$server"));
            if (!$account->uid) { // Register this new user.
              $user = user_save('', array('name' => "$name@$server", 'pass' => user_password(), 'init' => "$name@$server", 'status' => 1, "authname_$module" => "$name@$server", 'roles' => array(_user_authenticated_id())));
863
              watchdog('user', t('New external user: %user using module %module.', array('%user' => "<em>$name@$server</em>", '%module' => "<em>$module</em>")), WATCHDOG_NOTICE, l(t('edit'), 'user/'. $user->uid .'/edit'));
864 865 866 867 868 869 870 871 872
              break;
            }
          }
        }
      }
    }
  }
  return $user;
}
Dries's avatar
 
Dries committed
873

874
function _user_authenticated_id() {
Dries's avatar
 
Dries committed
875
  return db_result(db_query("SELECT rid FROM {role} WHERE name = 'authenticated user'"));
876 877
}

Dries's avatar
Dries committed
878 879 880
/**
 * Menu callback; logs the current user out, and redirects to the home page.
 */
Dries's avatar
 
Dries committed
881 882 883
function user_logout() {
  global $user;

Dries's avatar