user.module 85.6 KB
Newer Older
1 2 3
<?php
// $Id$

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) {
16 17
  foreach (module_list() as $module) {
    $function = $module .'_user';
18 19 20
    if (function_exists($function)) {
      $function($type, $array, $user, $category);
    }
21 22 23
  }
}

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

Dries's avatar
Dries committed
27 28
  if ($user = db_fetch_object($result)) {
    return user_load($user);
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.
 */
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();
50
  foreach ($array as $key => $value) {
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
    }
59
    else {
60 61
      $query .= "LOWER(u.$key) = LOWER('%s') AND ";
      $params[] = $value;
62 63
    }
  }
64
  $result = db_query_range("SELECT u.* FROM {users} u WHERE $query u.status < 3", $params, 0, 1);
65

66 67 68
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
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();
79
  }
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();
100
  if ($account->uid) {
101
    user_module_invoke('update', $array, $account, $category);
102

Dries's avatar
Dries committed
103
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
104
    foreach ($array as $key => $value) {
105
      if ($key == 'pass') {
106 107
        $query .= "$key = '%s', ";
        $v[] = md5($value);
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
112 113
          $query .= "$key = '%s', ";
          $v[] = $value;
114
        }
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;
          }
123
        }
124 125
      }
    }
126
    $query .= "data = '%s' ";
127
    $v[] = serialize($data);
128

129
    db_query("UPDATE {users} SET $query WHERE uid = %d", array_merge($v, array($account->uid)));
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);
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
      }
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
146
    $user = user_load(array('uid' => $account->uid));
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');
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.
155
    foreach ($array as $key => $value) {
156
      if ($key == 'pass') {
157
        $fields[] = db_escape_string($key);
158 159
        $values[] = md5($value);
        $s[] = "'%s'";
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)) {
163
          $fields[] = db_escape_string($key);
164 165
          $values[] = $value;
          $s[] = "'%s'";
166
        }
167 168
      }
    }
Dries's avatar
Dries committed
169
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
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);
175 176
    }

177 178
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
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']));
193 194
  }

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

  return $user;
}

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

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

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

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

249
  if (!$info || !$info['extension']) {
Dries's avatar
Dries committed
250
    form_set_error('picture', t('The uploaded file was not an image.'));
Dries's avatar
Dries committed
251
  }
252 253
  else if (image_get_toolkit()) {
    image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
Dries's avatar
Dries committed
254
  }
255 256 257
  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'))));
  }
258 259
  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
260
  }
261 262 263 264 265 266 267 268

  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
269 270 271
  }
}

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

Dries's avatar
Dries committed
280 281 282
/**
 * Generate a random alphanumeric password.
 */
283 284 285 286 287
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
288 289
  $allowable_characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';

290 291 292
  // We see how many characters are in the allowable list:
  $len = strlen($allowable_characters);

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

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

Dries's avatar
Dries committed
299
  // Loop the number of times specified by $length.
300 301 302 303 304 305 306 307
  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;
308 309
}

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

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

333
  // User #1 has all privileges:
334
  if ($account->uid == 1) {
335
    return TRUE;
336 337
  }

Dries's avatar
Dries committed
338 339
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
340 341
  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);
342

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

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

353
  return FALSE;
354 355
}

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

406 407
function user_fields() {
  static $fields;
408

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

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

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

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

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

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

  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
484 485
}

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

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

498
     return $blocks;
499
  }
500 501 502 503 504 505 506 507 508 509 510 511
  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') {
512 513
    $block = array();

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

Dries's avatar
Dries committed
520 521 522 523 524
          // 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);
525
          $output .= form_password(t('Password'), 'pass', '', 15, 64);
Dries's avatar
Dries committed
526
          $output .= form_submit(t('Log in'));
Dries's avatar
Dries committed
527

528
          $output  = form($output, 'post', url('user/login', drupal_get_destination()), array('id' => 'user-login-form'));
529

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

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

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

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

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

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

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

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

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

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

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

          if ($items) {
            $output .= theme('user_list', $items, t('Online users'));
590
          }
591

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

Dries's avatar
Dries committed
600 601 602 603 604 605 606 607 608 609
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
610
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
611
      $picture = theme('image', $picture, $alt, $alt, '', false);
Dries's avatar
Dries committed
612
      if ($account->uid) {
613
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')), NULL, NULL, FALSE, TRUE);
Dries's avatar
Dries committed
614 615 616 617 618 619 620
      }

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

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

  return $output;
}

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

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

Dries's avatar
Dries committed
651
  $items = array();
652

653 654 655
  $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
656

657
  if ($may_cache) {
658
    $items[] = array('path' => 'user', 'title' => t('user account'),
659
      'callback' => 'user_page', 'access' => TRUE, 'type' => MENU_CALLBACK);
660

661
    $items[] = array('path' => 'user/autocomplete', 'title' => t('user autocomplete'),
662
      'callback' => 'user_autocomplete', 'access' => $view_access, 'type' => MENU_CALLBACK);
663

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

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

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

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

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

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

  return $items;
762 763
}

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

Dries's avatar
Dries committed
772 773 774 775
/**
 * Accepts an user object, $account, or a DA name and returns an associative
 * array of modules and DA names. Called at external login.
 */
776
function user_get_authmaps($authname = NULL) {
777
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
778 779 780 781 782 783 784 785 786 787 788 789 790
  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
791
    $module = explode('_', $key, 2);
792
    if ($value) {
Dries's avatar
Dries committed
793
      db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module['1']);
Dries's avatar
Dries committed
794 795
      if (!db_affected_rows()) {
        db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
796 797 798
      }
    }
    else {
Dries's avatar
Dries committed
799
      db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module['1']);
800 801 802 803 804
    }
  }
}

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

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

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

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

824 825 826 827
  if (isset($edit['name'])) {
    if (user_is_blocked($edit['name'])) {
      // blocked in user administration
      $error = t('The username %name has been blocked.', array('%name' => theme('placeholder', $edit['name'])));
828
    }
829 830 831 832 833
    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'])));
    }
    else if ($edit['pass']) {
834

835 836 837
      if (!$user->uid) {
        $user = user_authenticate($edit['name'], trim($edit['pass']));
      }
838

839 840
      if ($user->uid) {
        watchdog('user', t('Session opened for %name.', array('%name' => theme('placeholder', $user->name))));
841

842 843
        // Update the user table timestamp noting user has logged in.
        db_query("UPDATE {users} SET login = '%d' WHERE uid = '%s'", time(), $user->uid);
844

845 846 847 848 849 850 851 852 853 854
        user_module_invoke('login', $edit, $user);

        // Redirect the user to the page he logged on from.
        drupal_goto();
      }
      else {
        if (!$error) {
          $error = t('Sorry. Unrecognized username or password.') .' '. l(t('Have you forgotten your password?'), 'user/password');
        }
        watchdog('user', t('Login attempt failed for %user: %error.', array('%user' => theme('placeholder', $edit['name']), '%error' => theme('placeholder', $error))));
855 856 857 858
      }
    }
  }

Dries's avatar
Dries committed
859
  // Display error message (if any):
860
  if ($error) {
861
    drupal_set_message($error, 'error');
862 863
  }

Dries's avatar
Dries committed
864
  // Display login form:
865 866 867
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
868
  if (count(user_auth_help_links()) > 0) {
Dries's avatar
Dries committed
869
    $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()))));
870 871
  }
  else {
Dries's avatar
Dries committed
872
    $output .= form_textfield(t('Username'), 'name', $edit['name'], 30, 64, t('Enter your %s username.', array('%s' => variable_get('site_name', 'local'))));
873
  }
Dries's avatar
Dries committed
874 875
  $output .= form_password(t('Password'), 'pass', $pass, 30, 64, t('Enter the password that accompanies your username.'));
  $output .= form_submit(t('Log in'));
876

877
  return form($output, 'post', url('user/login', drupal_get_destination()));
878
}
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896

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");
897
      watchdog('user', t('External load by %user using module %module.', array('%user' => theme('placeholder', $name .'@'. $server), '%module' => theme('placeholder', key($result)))));
898 899
    }
    else {
Steven Wittens's avatar