user.module 78 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 114
        }
        else {
115 116 117 118 119 120 121
          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
122
        }
Dries's avatar
 
Dries committed
123 124
      }
    }
Dries's avatar
 
Dries committed
125 126
    $query .= "data = '%s', ";
    $v[] = serialize($data);
Dries's avatar
 
Dries committed
127

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

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

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

139
    // Refresh user object
Dries's avatar
 
Dries committed
140
    $user = user_load(array('uid' => $account->uid));
Dries's avatar
 
Dries committed
141 142
  }
  else {
Dries's avatar
 
Dries committed
143 144
    $array['created'] = time();
    $array['changed'] = time();
Dries's avatar
Dries committed
145
    $array['uid'] = db_next_id('{users}_uid');
Dries's avatar
 
Dries committed
146

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

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

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

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

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

  return $user;
}

Dries's avatar
Dries committed
203 204 205
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
206
function user_validate_name($name) {
Dries's avatar
Dries committed
207 208 209 210
  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.');
211
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
Dries's avatar
Dries committed
212
  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
213
  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
214 215 216
}

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

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

Dries's avatar
Dries committed
227 228
  // Check that uploaded file is an image, with a maximum file size
  // and maximum height/width.
Dries's avatar
 
Dries committed
229
  $extension = strtolower(strrchr($file->filename, '.'));
Steven Wittens's avatar
Steven Wittens committed
230
  $size = @getimagesize($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

Dries's avatar
Dries committed
233
  if ((!in_array($size[2], array(1, 2, 3))) || (!in_array($extension, array('.gif', '.jpg', '.png', '.jpeg')))) {
Dries's avatar
 
Dries committed
234
    form_set_error('picture', t('The uploaded file was not an image.'));
Dries's avatar
 
Dries committed
235
  }
Dries's avatar
Dries committed
236
  else if ($file->size > (variable_get('user_picture_file_size', '30') * 1000)) {
Dries's avatar
 
Dries committed
237
    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'))));
Dries's avatar
 
Dries committed
238 239
  }
  else if ($size[0] > $maxwidth || $size[1] > $maxheight) {
Dries's avatar
 
Dries committed
240
    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
241
  }
Steven Wittens's avatar
Steven Wittens committed
242
  else if ($file = file_save_upload('picture', variable_get('user_picture_path', 'pictures') .'/picture-'. $user->uid . $extension, 1)) {
Steven Wittens's avatar
Steven Wittens committed
243
    $edit['picture'] = $file->filepath;
Dries's avatar
 
Dries committed
244 245
  }
  else {
Dries's avatar
 
Dries committed
246
    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
247 248 249
  }
}

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

Dries's avatar
Dries committed
258 259 260
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
261 262 263 264 265
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
266 267
  $allowable_characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';

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

Dries's avatar
Dries committed
271
  // Seed the random number generator with the microtime stamp.
Dries's avatar
 
Dries committed
272
  mt_srand((double)microtime() * 1000000);
Dries's avatar
 
Dries committed
273

Dries's avatar
Dries committed
274 275
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
276

Dries's avatar
Dries committed
277
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
278 279 280 281 282 283 284 285
  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
286 287
}

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

307 308 309 310
  if (is_null($account)) {
    $account = $user;
  }

311
  // User #1 has all privileges:
Dries's avatar
 
Dries committed
312
  if ($account->uid == 1) {
Dries's avatar
 
Dries committed
313 314 315
    return 1;
  }

Dries's avatar
Dries committed
316 317
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
Dries's avatar
 
Dries committed
318 319
  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
320 321

    while ($row = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
322
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
323
    }
Dries's avatar
 
Dries committed
324 325
  }

Dries's avatar
 
Dries committed
326
  return strstr($perm[$account->uid], "$string, ");
Dries's avatar
 
Dries committed
327 328
}

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

function user_deny($type, $mask) {
Dries's avatar
Dries committed
368 369
  $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
370

Dries's avatar
 
Dries committed
371
  return $deny && !$allow;
Dries's avatar
 
Dries committed
372 373
}

Dries's avatar
 
Dries committed
374 375
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
376

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

Dries's avatar
 
Dries committed
388
  return $fields;
Dries's avatar
 
Dries committed
389 390
}

Dries's avatar
Dries committed
391 392 393
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
394
function user_perm() {
395
  return array('administer users');
Dries's avatar
 
Dries committed
396 397
}

Dries's avatar
Dries committed
398 399 400 401 402
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
403
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
404
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
Steven Wittens's avatar
Steven Wittens committed
405
    list($width, $height, $type, $attr) = @getimagesize(file_create_path($file));
Dries's avatar
 
Dries committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
    $types = array(
      IMAGETYPE_GIF => 'image/gif',
      IMAGETYPE_JPEG => 'image/jpeg',
      IMAGETYPE_PNG => 'image/png',
      IMAGETYPE_SWF => 'application/x-shockwave-flash',
      IMAGETYPE_PSD => 'image/psd',
      IMAGETYPE_BMP => 'image/bmp',
      IMAGETYPE_TIFF_II => 'image/tiff',
      IMAGETYPE_TIFF_MM  => 'image/tiff',
      IMAGETYPE_JPC => 'application/octet-stream',
      IMAGETYPE_JP2 => 'image/jp2',
      IMAGETYPE_JPX => 'application/octet-stream',
      IMAGETYPE_JB2 => 'application/octet-stream',
      IMAGETYPE_SWC => 'application/x-shockwave-flash',
      IMAGETYPE_IFF => 'image/iff',
      IMAGETYPE_WBMP => 'image/vnd.wap.wbmp',
      IMAGETYPE_XBM => 'image/xbm'
    );
    return array('Content-type: '. $types[$type]);
  }
}

Dries's avatar
Dries committed
428 429 430
/**
 * Implementation of hook_search().
 */
431 432 433 434 435 436 437 438 439 440 441 442 443
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
      return t('users');
    case 'search':
      $find = array();
      // Replace wildcards with MySQL/PostgreSQL wildcards.
      $keys = str_replace('*', '%', $keys);
      $result = db_query_range("SELECT * FROM {users} WHERE LOWER(name) LIKE '%%%s%%'", strtolower($keys), 0, 20);
      while ($account = db_fetch_object($result)) {
        $find[] = array('title' => $account->name, 'link' => url("user/$account->uid/view"));
      }
      return $find;
Dries's avatar
 
Dries committed
444 445 446
  }
}

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

  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
466 467
}

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

Dries's avatar
Dries committed
474 475 476 477 478
  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');
479

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

Dries's avatar
 
Dries committed
496 497
    switch ($delta) {
      case 0:
Dries's avatar
 
Dries committed
498

499
        if (!$user->uid) {
Dries's avatar
Dries committed
500 501
          // For usability's sake, avoid showing two login forms on one page.
          if (arg(0) == 'user' && arg(1) != 'view') {
Dries's avatar
 
Dries committed
502 503 504
            return;
          }

Dries's avatar
Dries committed
505
          $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
506

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

Dries's avatar
Dries committed
509 510
          // Save the referer.  We record where the user came from such
          // that we can redirect him after having completed the login form.
Dries's avatar
Dries committed
511

512
          if (empty($edit)) {
Dries's avatar
Dries committed
513
            $edit['destination'] = $_GET['q'];
514
          }
Dries's avatar
Dries committed
515 516 517 518 519 520 521 522
          // 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_hidden('destination', $edit['destination']);
          $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
523
          $output .= "</div>\n";
Dries's avatar
 
Dries committed
524

Dries's avatar
Dries committed
525
          $output  = form($output, 'post', url('user/login'));
Dries's avatar
 
Dries committed
526

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

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

Dries's avatar
Dries committed
534 535
          $block['subject'] = t('User login');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
536
        }
Dries's avatar
Dries committed
537
        return $block;
538
      case 1:
Dries's avatar
 
Dries committed
539
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
540 541
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
           $block['content'] = '<div class="menu">'. $menu .'</div>';
Dries's avatar
 
Dries committed
542
        }
543
        return $block;
Dries's avatar
 
Dries committed
544
      case 2:
Dries's avatar
Dries committed
545 546
        if (user_access('access content')) {
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 ORDER BY uid DESC', 0, 5);
547
          while ($account = db_fetch_object($result)) {
548
            $items[] = format_name($account);
549
          }
Dries's avatar
 
Dries committed
550

Dries's avatar
Dries committed
551
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
552

Dries's avatar
Dries committed
553 554
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
555 556
          return $block;
        }
Dries's avatar
 
Dries committed
557
      case 3:
Dries's avatar
Dries committed
558 559 560
        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
561

Dries's avatar
Dries committed
562
          // Perform database queries to gather online user lists.
Dries's avatar
 
Dries committed
563
          $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
564
          $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
565
          $total_users = db_num_rows($users);
Dries's avatar
 
Dries committed
566

Dries's avatar
Dries committed
567
          // Format the output with proper grammar.
Dries's avatar
 
Dries committed
568
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
569
            $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
570 571
          }
          else {
Dries's avatar
Dries committed
572
            $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
573 574
          }

575 576 577 578
          // 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
579

580 581 582
            while ($max_users-- && $uid = db_fetch_object($users)) {
              $items[] = format_name(user_load(array('uid' => $uid->uid)));
            }
Dries's avatar
 
Dries committed
583

584 585 586
            if ($items) {
              if (db_fetch_object($users)) {
                $items[] = '...';
Dries's avatar
 
Dries committed
587
              }
588
              $output .= theme('item_list', $items, t('Online users:'));
Dries's avatar
 
Dries committed
589
            }
Dries's avatar
 
Dries committed
590
          }
591

Dries's avatar
Dries committed
592 593
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
594
        }
Dries's avatar
 
Dries committed
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.')));
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 625 626
  foreach ($fields as $category => $value) {
    $output .= "<h2>$category</h2>$value";
  }
Dries's avatar
 
Dries committed
627 628 629 630 631
  $output .= "</div>\n";

  return $output;
}

Dries's avatar
 
Dries committed
632
function theme_user_list($items, $title = NULL) {
Dries's avatar
Dries committed
633
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
634 635
}

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

Dries's avatar
 
Dries committed
642
  $items = array();
Dries's avatar
 
Dries committed
643

Dries's avatar
 
Dries committed
644 645
  $access = user_access('administer users');

Dries's avatar
 
Dries committed
646
  if ($may_cache) {
Dries's avatar
 
Dries committed
647
    $items[] = array('path' => 'user', 'title' => t('user account'),
Dries's avatar
 
Dries committed
648
      'callback' => 'user_page', 'access' => TRUE, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
649 650
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
 
Dries committed
651
    $items[] = array('path' => 'user/register', 'title' => t('register'),
Dries's avatar
 
Dries committed
652
      'callback' => 'user_page', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
653
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
Dries's avatar
 
Dries committed
654
      'callback' => 'user_page', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
655 656
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
657 658 659 660

    $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
661
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
662
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
Dries's avatar
 
Dries committed
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
      '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);
    $items[] = array('path' => 'admin/user/configure/settings', 'title' => t('settings'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/user/configure/access', 'title' => t('access rules'),
      'callback' => 'user_configure', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/user/configure/access/mail', 'title' => t('e-mail rules'),
      'callback' => 'user_configure', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/user/configure/access/user', 'title' => t('name rules'),
      'callback' => 'user_configure', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/user/configure/role', 'title' => t('roles'),
      'callback' => 'user_configure', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/user/configure/permission', 'title' => t('permissions'),
      'callback' => 'user_configure', 'access' => $access,
Dries's avatar
 
Dries committed
684
      'type' => MENU_LOCAL_TASK);
685

Dries's avatar
 
Dries committed
686 687 688 689
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
        'callback' => 'user_admin', 'access' => $access,
        'type' => MENU_LOCAL_TASK);
690
    }
Dries's avatar
 
Dries committed
691

Dries's avatar
 
Dries committed
692 693 694 695 696 697 698 699 700 701 702 703
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
        'callback' => 'user_page', 'access' => TRUE);
      $items[] = array('path' => 'logout', 'title' => t('log out'),
        'access' => TRUE,
        'callback' => 'user_logout',
        'weight' => 10);
    }
    else {
      $items[] = array('path' => 'logout', 'title' => t('log out'),
        'callback' => 'user_logout', 'access' => FALSE);
    }
Dries's avatar
 
Dries committed
704 705
  }
  else {
Dries's avatar
 
Dries committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
    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
725
  }
Dries's avatar
 
Dries committed
726 727

  return $items;
Dries's avatar
 
Dries committed
728 729
}

Dries's avatar
Dries committed
730 731 732
/**
 * Called by authentication modules in order to edit/view their authmap information.
 */
733
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
734
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
735 736 737
  return db_result($result);
}

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

function user_auth_help_links() {
771
  $links = array();
Dries's avatar
 
Dries committed
772
  foreach (module_list() as $module) {
Dries's avatar
Dries committed
773
    if (module_hook($module, 'auth')) {
Dries's avatar
 
Dries committed
774
      $links[] = l(module_invoke($module, 'info', 'name'), "user/help#$module");
Dries's avatar
 
Dries committed
775 776 777 778 779 780 781
    }
  }
  return $links;
}

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

Dries's avatar
Dries committed
782
function user_login($edit = array(), $msg = '') {
Dries's avatar
 
Dries committed
783
  global $user, $base_url;
Dries's avatar
 
Dries committed
784

Dries's avatar
Dries committed
785
  // If we are already logged on, go to the user page instead.
Dries's avatar
 
Dries committed
786
  if ($user->uid) {
Dries's avatar
Dries committed
787
    drupal_goto('user');
Dries's avatar
 
Dries committed
788 789
  }

Dries's avatar
 
Dries committed
790
  if (user_deny('user', $edit['name'])) {
Dries's avatar
 
Dries committed
791
    $error = t('The name %s has been denied access.', array('%s' => '<em>'. $edit['name'] .'</em>'));
Dries's avatar
 
Dries committed
792
  }
Dries's avatar
 
Dries committed
793
  else if ($edit['name'] && $edit['pass']) {
Dries's avatar
 
Dries committed
794

Dries's avatar
 
Dries committed
795
    if (!$user->uid) {
796
      $user = user_authenticate($edit['name'], $edit['pass']);
Dries's avatar
 
Dries committed
797 798 799
    }

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

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

Dries's avatar
Dries committed
805
      user_module_invoke('login', $edit, $user);
Dries's avatar
 
Dries committed
806

Dries's avatar
Dries committed
807 808
      // Redirect the user to the page he logged on from.
      drupal_goto($edit['destination']);
Dries's avatar
 
Dries committed
809 810 811
    }
    else {
      if (!$error) {
Dries's avatar
Dries committed
812
        $error = t('Sorry.  Unrecognized username or password.') .' '. l(t('Have you forgotten your password?'), 'user/password');
Dries's avatar
 
Dries committed
813
      }
814
      watchdog('user', t('Login attempt failed for %user: %error.', array('%user' => '<em>'. $edit['name'] .'</em>', '%error' => '<em>'. $error .'</em>')));
Dries's avatar
 
Dries committed
815 816 817
    }
  }

Dries's avatar
Dries committed
818
  // Display error message (if any):
Dries's avatar
 
Dries committed
819
  if ($error) {
Dries's avatar
 
Dries committed
820
    drupal_set_message($error, 'error');
Dries's avatar
 
Dries committed
821 822
  }

Dries's avatar
Dries committed
823 824
  // Save the referrer.  We record where the user came from such that we
  // can redirect him after having completed the login form.
825
  if (empty($edit)) {
Dries's avatar
Dries committed
826
    $edit['destination'] = $_GET['q'];
Dries's avatar
 
Dries committed
827
  }
Dries's avatar
Dries committed
828
  $output .= form_hidden('destination', $edit['destination']);
Dries's avatar
 
Dries committed
829

Dries's avatar
Dries committed
830
  // Display login form:
Dries's avatar
 
Dries committed
831 832 833
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
Dries's avatar
 
Dries committed
834
  if (count(user_auth_help_links()) > 0) {
Dries's avatar
Dries committed
835
    $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
836 837
  }
  else {
Dries's avatar
Dries committed
838
    $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
839
  }
Dries's avatar
Dries committed
840 841
  $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
842

Dries's avatar
Dries committed
843
  return form($output, 'post', url('user/login'));
Dries's avatar
 
Dries committed
844
}
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862

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
863
      watchdog('user', t('External load by %user using module %module.', array('%user' => "<em>$name@$server</em>", '%module' => '<em>'. key($result) .'</em>')));
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
    }
    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())));
Dries's avatar
 
Dries committed
880
              watchdog('user', t('New external user: %user using module %module.', array('%user' => "<em>$name@$server</em>", '%module' => "<em>$module</em>")), l(t('edit'), 'user/'. $user->uid .'/edit'));
881 882 883 884 885 886 887 888 889
              break;
            }
          }
        }
      }
    }
  }
  return $user;
}
Dries's avatar
 
Dries committed
890

891
function _user_authenticated_id() {
Dries's avatar
 
Dries committed
892
  return db_result(db_query("SELECT rid FROM {role} WHERE name = 'authenticated user'"));
893 894
}

Dries's avatar
Dries committed
895 896 897
/**
 * Menu callback; logs the current user out, and redirects to the home page.
 */
Dries's avatar
 
Dries committed
898 899 900 901
function user_logout() {
  global $user;

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

Dries's avatar
Dries committed
904