user.module 85.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
      $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) = '%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
  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) {
Dries's avatar
Dries committed
212 213 214 215
  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.');
216
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
Dries's avatar
Dries committed
217
  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.');
218
  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
219 220 221
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
222
  if (!$mail) return t('You must enter an e-mail address.');
223
  if (!valid_email_address($mail)) {
224
    return t('The e-mail address %mail is not valid.', array('%mail' => theme('placeholder', $mail)));
Dries's avatar
 
Dries committed
225 226 227
  }
}

Dries's avatar
 
Dries committed
228
function user_validate_picture($file, &$edit, $user) {
Dries's avatar
Dries committed
229
  // Initialize the picture:
Dries's avatar
 
Dries committed
230 231
  $edit['picture'] = $user->picture;

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

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

  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
257 258 259
  }
}

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

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

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

Dries's avatar
Dries committed
281
  // Seed the random number generator with the microtime stamp.
Dries's avatar
 
Dries committed
282
  mt_srand((double)microtime() * 1000000);
Dries's avatar
 
Dries committed
283

Dries's avatar
Dries committed
284 285
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
286

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

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

317 318 319 320
  if (is_null($account)) {
    $account = $user;
  }

321
  // User #1 has all privileges:
Dries's avatar
 
Dries committed
322
  if ($account->uid == 1) {
Dries's avatar
 
Dries committed
323 324 325
    return 1;
  }

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

    while ($row = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
332
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
333
    }
Dries's avatar
 
Dries committed
334
  }
335 336 337 338
  if (isset($perm[$account->uid])) {
    return strstr($perm[$account->uid], "$string, ");
  }
  return FALSE;
Dries's avatar
 
Dries committed
339 340
}

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

Dries's avatar
 
Dries committed
391 392
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
393

Dries's avatar
 
Dries committed
394
  if (!$fields) {
Dries's avatar
Dries committed
395
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
396 397 398
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
399 400
    else {
      // Make sure we return the default fields at least
401
      $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
402
    }
Dries's avatar
 
Dries committed
403
  }
Dries's avatar
 
Dries committed
404

Dries's avatar
 
Dries committed
405
  return $fields;
Dries's avatar
 
Dries committed
406 407
}

Dries's avatar
Dries committed
408 409 410
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
411
function user_perm() {
412
  return array('administer users', 'access user profiles');
Dries's avatar
 
Dries committed
413 414
}

Dries's avatar
Dries committed
415 416 417 418 419
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
420
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
421
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
422 423
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
424 425 426
  }
}

Dries's avatar
Dries committed
427 428 429
/**
 * Implementation of hook_search().
 */
430 431 432
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
433 434 435
      if (user_access('access user profiles')) {
        return t('users');
      }
436
    case 'search':
437 438 439 440 441 442 443 444 445
      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)) {
          $find[] = array('title' => $account->name, 'link' => url("user/$account->uid/view"));
        }
        return $find;
446
      }
Dries's avatar
 
Dries committed
447 448 449
  }
}

Dries's avatar
Dries committed
450 451 452
/**
 * Implementation of hook_user().
 */
453
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
454
  if ($type == 'view') {
Dries's avatar
Dries committed
455
    return array(t('History') => form_item(t('Member for'), format_interval(time() - $user->created)));
Dries's avatar
Dries committed
456
  }
457 458 459 460 461 462 463 464 465 466 467 468

  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
469 470
}

Dries's avatar
Dries committed
471 472 473
/**
 * Implementation of hook_block().
 */
474
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
475 476
  global $user;

Dries's avatar
Dries committed
477 478 479 480 481
  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');
482

483
     return $blocks;
484
  }
485 486 487 488 489 490 491 492 493 494 495 496
  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
497 498
    $block = array();

Dries's avatar
 
Dries committed
499 500
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
501 502
        // 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
503
          $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
504

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

Dries's avatar
Dries committed
507 508 509 510 511 512 513
          // 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
514
          $output .= "</div>\n";
Dries's avatar
 
Dries committed
515

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

Dries's avatar
Dries committed
518 519
          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
520
          }
Dries's avatar
Dries committed
521
          $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
Dries's avatar
 
Dries committed
522

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

Dries's avatar
Dries committed
525 526
          $block['subject'] = t('User login');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
527
        }
Dries's avatar
Dries committed
528
        return $block;
Dries's avatar
Dries committed
529

530
      case 1:
Dries's avatar
 
Dries committed
531
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
532 533
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
           $block['content'] = '<div class="menu">'. $menu .'</div>';
Dries's avatar
 
Dries committed
534
        }
535
        return $block;
Dries's avatar
Dries committed
536

Dries's avatar
 
Dries committed
537
      case 2:
538
        if (user_access('access content')) {
Dries's avatar
Dries committed
539
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 ORDER BY uid DESC', 0, 5);
540
          while ($account = db_fetch_object($result)) {
541
            $items[] = $account;
542
          }
Dries's avatar
Dries committed
543
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
544

Dries's avatar
Dries committed
545 546
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
547
        }
Dries's avatar
Dries committed
548 549
        return $block;

Dries's avatar
 
Dries committed
550
      case 3:
551
        if (user_access('access content')) {
Dries's avatar
Dries committed
552 553
          // Count users with activity in the past defined period.
          $time_period = variable_get('user_block_seconds_online', 2700);
Dries's avatar
 
Dries committed
554

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

Dries's avatar
Dries committed
560
          // Format the output with proper grammar.
Dries's avatar
 
Dries committed
561
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
562
            $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
563 564
          }
          else {
Dries's avatar
Dries committed
565
            $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
566 567
          }

568 569
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
570 571 572 573 574 575 576 577
          $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
578
          }
579

Dries's avatar
Dries committed
580 581
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
582
        }
Dries's avatar
 
Dries committed
583
        return $block;
Dries's avatar
 
Dries committed
584 585
    }
  }
586 587
}

Dries's avatar
 
Dries committed
588 589 590 591 592 593 594 595 596 597
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
598
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
599
      $picture = theme('image', $picture, $alt, $alt, '', false);
Dries's avatar
 
Dries committed
600
      if ($account->uid) {
601
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')), NULL, NULL, FALSE, TRUE);
Dries's avatar
 
Dries committed
602 603 604 605 606 607 608
      }

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

Dries's avatar
Dries committed
609
function theme_user_profile($account, $fields) {
Dries's avatar
 
Dries committed
610 611
  $output = "<div class=\"profile\">\n";
  $output .= theme('user_picture', $account);
Dries's avatar
Dries committed
612
  foreach ($fields as $category => $value) {
613
    $output .= theme('box', $category, $value);
Dries's avatar
Dries committed
614
  }
Dries's avatar
 
Dries committed
615 616 617 618 619
  $output .= "</div>\n";

  return $output;
}

620 621 622 623 624 625 626 627 628 629
/**
 * 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) {
    $items[] = format_name($user);
  }
Dries's avatar
Dries committed
630
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
631 632
}

Dries's avatar
 
Dries committed
633
/**
Dries's avatar
 
Dries committed
634
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
635
 */
Dries's avatar
 
Dries committed
636
function user_menu($may_cache) {
Dries's avatar
 
Dries committed
637
  global $user;
Dries's avatar
 
Dries committed
638

Dries's avatar
 
Dries committed
639
  $items = array();
Dries's avatar
 
Dries committed
640

641 642 643
  $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
644

Dries's avatar
 
Dries committed
645
  if ($may_cache) {
Dries's avatar
 
Dries committed
646
    $items[] = array('path' => 'user', 'title' => t('user account'),
Dries's avatar
 
Dries committed
647
      'callback' => 'user_page', 'access' => TRUE, 'type' => MENU_CALLBACK);
648

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

652
    //registration and login pages.
Dries's avatar
 
Dries committed
653 654
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
 
Dries committed
655
    $items[] = array('path' => 'user/register', 'title' => t('register'),
Dries's avatar
 
Dries committed
656
      'callback' => 'user_page', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
657
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
658
      'callback' => 'user_pass', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
659 660
    $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
661 662
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
663

664
    //admin pages
Dries's avatar
 
Dries committed
665
    $items[] = array('path' => 'admin/user', 'title' => t('users'),
666
      'callback' => 'user_admin', 'access' => $admin_access);
Dries's avatar
 
Dries committed
667
    $items[] = array('path' => 'admin/user/list', 'title' => t('list'),
Dries's avatar
 
Dries committed
668
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
669
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
670
      'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
671 672
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/user/configure', 'title' => t('configure'),
673
      'callback' => 'user_configure', 'access' => $admin_access,
Dries's avatar
 
Dries committed
674
      'type' => MENU_LOCAL_TASK);
675
    $items[] = array('path' => 'admin/access', 'title' => t('access control'),
676
      'callback' => 'user_admin_perm', 'access' => $admin_access);
677
    $items[] = array('path' => 'admin/access/permissions', 'title' => t('permissions'),
678
      'callback' => 'user_admin_perm', 'access' => $admin_access,
Dries's avatar
 
Dries committed
679
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
680
    $items[] = array('path' => 'admin/access/roles', 'title' => t('roles'),
681
      'callback' => 'user_admin_role', 'access' => $admin_access,
Dries's avatar
 
Dries committed
682
      'type' => MENU_LOCAL_TASK);
683
    $items[] = array('path' => 'admin/access/roles/edit', 'title' => t('edit role'),
684
      'callback' => 'user_admin_role', 'access' => $admin_access,
685
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
686
    $items[] = array('path' => 'admin/access/rules', 'title' => t('access rules'),
687
      'callback' => 'user_admin_access', 'access' => $admin_access,
688 689
      'type' => MENU_LOCAL_TASK, 'weight' => 10);
    $items[] = array('path' => 'admin/access/rules/list', 'title' => t('list'),
690
      'access' => $admin_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
691
    $items[] = array('path' => 'admin/access/rules/add', 'title' => t('add rule'),
692
      'callback' => 'user_admin_access_add', 'access' => $admin_access,
Dries's avatar
 
Dries committed
693
      'type' => MENU_LOCAL_TASK);
694
    $items[] = array('path' => 'admin/access/rules/check', 'title' => t('check rules'),
695
      'callback' => 'user_admin_access_check', 'access' => $admin_access,
Dries's avatar
 
Dries committed
696
      'type' => MENU_LOCAL_TASK);
697
    $items[] = array('path' => 'admin/access/rules/edit', 'title' => t('edit rule'),
698
      'callback' => 'user_admin_access_edit', 'access' => $admin_access,
699
      'type' => MENU_CALLBACK);
700
    $items[] = array('path' => 'admin/access/rules/delete', 'title' => t('delete rule'),
701
      'callback' => 'user_admin_access_delete', 'access' => $admin_access,
702
      'type' => MENU_CALLBACK);
703

Dries's avatar
 
Dries committed
704 705
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
706
        'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
707
        'type' => MENU_LOCAL_TASK);
708
    }
Dries's avatar
 
Dries committed
709

710
    //Your personal page
Dries's avatar
 
Dries committed
711 712
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
713 714
        'callback' => 'user_page', 'access' => TRUE,
        'type' => MENU_DYNAMIC_ITEM);
Dries's avatar
 
Dries committed
715
    }
Dries's avatar
 
Dries committed
716 717 718 719 720

    $items[] = array('path' => 'logout', 'title' => t('log out'),
      'access' => $user->uid != 0,
      'callback' => 'user_logout',
      'weight' => 10);
Dries's avatar
 
Dries committed
721 722
  }
  else {
Dries's avatar
 
Dries committed
723 724
    if (arg(0) == 'user' && is_numeric(arg(1))) {
      $items[] = array('path' => 'user/'. arg(1), 'title' => t('user'),
725
        'type' => MENU_CALLBACK, 'callback' => 'user_page', 'access' => $view_access);
Dries's avatar
 
Dries committed
726
      $items[] = array('path' => 'user/'. arg(1) .'/view', 'title' => t('view'),
727
        'access' => $view_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
728
      $items[] = array('path' => 'user/'. arg(1) .'/edit', 'title' => t('edit'),
729
        'callback' => 'user_edit', 'access' => $admin_access || $user->uid == arg(1),
Dries's avatar
 
Dries committed
730
        'type' => MENU_LOCAL_TASK);
731
      $items[] = array('path' => 'user/'. arg(1) .'/delete', 'title' => t('delete'),
732
        'callback' => 'user_edit', 'access' => $admin_access,
733
        'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
734 735 736 737

      if (arg(2) == 'edit') {
        if (($categories = _user_categories()) && (count($categories) > 1)) {
          foreach ($categories as $key => $category) {
738 739 740
            $items[] = array(
              'path' => 'user/'. arg(1) .'/edit/'. $category['name'],
              'title' => $category['title'],
Dries's avatar
 
Dries committed
741
              'type' => $category['name'] == 'account' ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
742
              'weight' => $category['weight'],
743
              'access' => ($admin_access || $user->uid == arg(1)));
Dries's avatar
 
Dries committed
744 745 746 747
          }
        }
      }
    }
Dries's avatar
 
Dries committed
748
  }
Dries's avatar
 
Dries committed
749 750

  return $items;
Dries's avatar
 
Dries committed
751 752
}

Dries's avatar
Dries committed
753 754 755
/**
 * Called by authentication modules in order to edit/view their authmap information.
 */
756
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
757
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
758 759 760
  return db_result($result);
}

Dries's avatar
Dries committed
761 762 763 764
/**
 * Accepts an user object, $account, or a DA name and returns an associative
 * array of modules and DA names. Called at external login.
 */
765
function user_get_authmaps($authname = NULL) {
Dries's avatar
 
Dries committed
766
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
767 768 769 770 771 772 773 774 775 776 777 778 779
  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
780
    $module = explode('_', $key, 2);
Dries's avatar
 
Dries committed
781
    if ($value) {
Dries's avatar
Dries committed
782
      db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module['1']);
Dries's avatar
 
Dries committed
783 784
      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
785 786 787
      }
    }
    else {
Dries's avatar
Dries committed
788
      db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module['1']);
Dries's avatar
 
Dries committed
789 790 791 792 793
    }
  }
}

function user_auth_help_links() {
794
  $links = array();
Dries's avatar
 
Dries committed
795
  foreach (module_list() as $module) {
Dries's avatar
Dries committed
796
    if (module_hook($module, 'auth')) {
Dries's avatar
 
Dries committed
797
      $links[] = l(module_invoke($module, 'info', 'name'), "user/help#$module");
Dries's avatar
 
Dries committed
798 799 800 801 802 803 804
    }
  }
  return $links;
}

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

Dries's avatar
Dries committed
805
function user_login($edit = array(), $msg = '') {
Dries's avatar
 
Dries committed
806
  global $user, $base_url;
Dries's avatar
 
Dries committed
807

Dries's avatar
Dries committed
808
  // If we are already logged on, go to the user page instead.
Dries's avatar
 
Dries committed
809
  if ($user->uid) {
Dries's avatar
Dries committed
810
    drupal_goto('user');
Dries's avatar
 
Dries committed
811 812
  }

813 814 815 816 817 818 819
  if (user_is_blocked($edit['name'])) {
    // blocked in user administration
    $error = t('The username %name has been blocked.', array('%name' => theme('placeholder', $edit['name'])));
  }
  else if (drupal_is_denied('user', $edit['name'])) {
    // denied by access controls
    $error = t('The name %name is a reserved username.', array('%name' => theme('placeholder', $edit['name'])));
Dries's avatar
 
Dries committed
820
  }
Dries's avatar
 
Dries committed
821
  else if ($edit['name'] && $edit['pass']) {
Dries's avatar
 
Dries committed
822

Dries's avatar
 
Dries committed
823
    if (!$user->uid) {
824
      $user = user_authenticate($edit['name'], trim($edit['pass']));
Dries's avatar
 
Dries committed
825 826 827
    }

    if ($user->uid) {
828
      watchdog('user', t('Session opened for %name.', array('%name' => theme('placeholder', $user->name))));
Dries's avatar
 
Dries committed
829

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