user.module 86.8 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?php
// $Id$

session_set_save_handler("sess_open", "sess_close", "sess_read", "sess_write", "sess_destroy", "sess_gc");
session_start();

/*** Session functions *****************************************************/

function sess_open($save_path, $session_name) {
  return 1;
}

function sess_close() {
  return 1;
}

function sess_read($key) {
  global $user;
Dries's avatar
 
Dries committed
19 20 21

  $result = db_query_range("SELECT u.*, s.*, r.name AS role FROM {users} u INNER JOIN {role} r ON u.rid = r.rid INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.sid = '". check_query($key) ."' AND u.status < 3", 0, 1);
  $user = db_fetch_object($result);
Dries's avatar
 
Dries committed
22 23 24 25 26 27 28
  if ($user->data && $data = unserialize($user->data)) {
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
 
Dries committed
29

30
  return !empty($user->session) ? $user->session : '';
Dries's avatar
 
Dries committed
31 32 33
}

function sess_write($key, $value) {
Dries's avatar
 
Dries committed
34 35 36
  global $user;

  db_query("UPDATE {sessions} SET uid = %d, hostname = '%s', session = '%s', timestamp = %d WHERE sid = '$key'", $user->uid, $_SERVER["REMOTE_ADDR"], $value, time());
Dries's avatar
 
Dries committed
37

Dries's avatar
 
Dries committed
38 39 40
  if (!db_affected_rows()) {
    db_query("INSERT INTO {sessions} (uid, sid, hostname, session, timestamp) values(%d, '%s', '%s', '%s', %d)", $user->uid, $key, $_SERVER["REMOTE_ADDR"], $value, time());
  }
Dries's avatar
 
Dries committed
41

Dries's avatar
 
Dries committed
42 43 44 45 46
  return '';
}

function sess_destroy($key) {

Dries's avatar
 
Dries committed
47 48
  db_query("DELETE FROM {sessions} WHERE sid = '$key'");

Dries's avatar
 
Dries committed
49 50 51
}

function sess_gc($lifetime) {
Dries's avatar
 
Dries committed
52 53 54 55 56 57 58 59 60 61

  /*
  **  Be sure to adjust 'php_value session.gc_maxlifetime' to a large enough
  **   value.  For example, if you want user sessions to stay in your database
  **   for three weeks before deleting them, you need to set gc_maxlifetime
  **   to '1814400'.  At that value, only after a user doesn't log in after
  **   three weeks (1814400 seconds) will his/her session be removed.
  */
  db_query("DELETE FROM {sessions} WHERE timestamp < %d", time() - $lifetime);

Dries's avatar
 
Dries committed
62
  return 1;
Dries's avatar
 
Dries committed
63

Dries's avatar
 
Dries committed
64 65 66 67 68
}

/*** Common functions ******************************************************/

function user_external_load($authname) {
Dries's avatar
 
Dries committed
69
  $arr_uid = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

  if (db_fetch_object($arr_uid)) {
    $uid = db_result($arr_uid);
    return user_load(array("uid" => $uid));
  }
  else {
    return 0;
  }
}

function user_load($array = array()) {

  /*
  ** Dynamically compose a SQL query:
  */

Dries's avatar
 
Dries committed
86 87
  $query = "";

Dries's avatar
 
Dries committed
88 89
  foreach ($array as $key => $value) {
    if ($key == "pass") {
Kjartan's avatar
Kjartan committed
90
      $query .= "u.$key = '". md5($value) ."' AND ";
91
    }
Dries's avatar
 
Dries committed
92
    else {
Dries's avatar
 
Dries committed
93
      $query .= "u.$key = '". check_query($value) ."' AND ";
Dries's avatar
 
Dries committed
94 95
    }
  }
Dries's avatar
 
Dries committed
96
  $result = db_query_range("SELECT u.*, r.name AS role FROM {role} r INNER JOIN {users} u ON r.rid = u.rid WHERE $query u.status < 3", 0, 1);
Dries's avatar
 
Dries committed
97 98

  $user = db_fetch_object($result);
Dries's avatar
 
Dries committed
99
  if ($user->data && $data = unserialize($user->data)) {
Dries's avatar
 
Dries committed
100 101 102 103 104 105
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
 
Dries committed
106 107 108 109 110 111 112 113 114

  return $user;
}

function user_save($account, $array = array()) {
  /*
  ** Dynamically compose a SQL query:
  */

Kjartan's avatar
Kjartan committed
115
  $user_fields = user_fields();
Dries's avatar
 
Dries committed
116
  if ($account->uid) {
Dries's avatar
 
Dries committed
117
    $data = unserialize(db_result(db_query("SELECT data FROM {users} WHERE uid = %d", $account->uid)));
Dries's avatar
 
Dries committed
118 119
    foreach ($array as $key => $value) {
      if ($key == "pass") {
Dries's avatar
 
Dries committed
120 121
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
 
Dries committed
122 123
      }
      else if (substr($key, 0, 4) !== "auth") {
Kjartan's avatar
Kjartan committed
124
        if (in_array($key, $user_fields)) {
Dries's avatar
 
Dries committed
125 126
          // escape '%'s:
          $value = str_replace("%", "%%", $value);
Dries's avatar
 
Dries committed
127 128
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
 
Dries committed
129 130 131 132
        }
        else {
          $data[$key] = $value;
        }
Dries's avatar
 
Dries committed
133 134
      }
    }
Dries's avatar
 
Dries committed
135 136
    $query .= "data = '%s', ";
    $v[] = serialize($data);
Dries's avatar
 
Dries committed
137

Dries's avatar
 
Dries committed
138
    db_query("UPDATE {users} SET $query timestamp = %d WHERE uid = %d", array_merge($v, array(time(), $account->uid)));
Dries's avatar
 
Dries committed
139 140 141 142 143

    $user = user_load(array("uid" => $account->uid));
  }
  else {
    $array["timestamp"] = time();
Dries's avatar
 
Dries committed
144
    $array["uid"] = db_next_id("users_uid");
Dries's avatar
 
Dries committed
145 146 147 148

    foreach ($array as $key => $value) {
      if ($key == "pass") {
        $fields[] = check_query($key);
Dries's avatar
 
Dries committed
149 150
        $values[] = md5($value);
        $s[] = "'%s'";
Dries's avatar
 
Dries committed
151 152
      }
      else if (substr($key, 0, 4) !== "auth") {
Kjartan's avatar
Kjartan committed
153
        if (in_array($key, $user_fields)) {
Dries's avatar
 
Dries committed
154
          $fields[] = check_query($key);
Dries's avatar
 
Dries committed
155 156
          $values[] = $value;
          $s[] = "'%s'";
Dries's avatar
 
Dries committed
157 158 159 160
        }
        else {
          $data[$key] = $value;
        }
Dries's avatar
 
Dries committed
161 162 163
      }
    }

Dries's avatar
 
Dries committed
164
    $fields[] = "data";
Dries's avatar
 
Dries committed
165 166
    $values[] = serialize($data);
    $s[] = "'%s'";
Dries's avatar
 
Dries committed
167

Dries's avatar
 
Dries committed
168
    db_query("INSERT INTO {users} (". implode(", ", $fields) .") VALUES (". implode(", ", $s) .")", $values);
Dries's avatar
 
Dries committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200

    $user = user_load(array("name" => $array["name"]));
  }

  foreach ($array as $key => $value) {
    if (substr($key, 0, 4) == "auth") {
      $authmaps[$key] = $value;
    }
  }

  if ($authmaps) {
    $result = user_set_authmaps($user, $authmaps);
  }

  return $user;
}

function user_set($account, $key, $value) {
  $account->data[$key] = $value;
  return $account;
}

function user_get($account, $key) {
  return $account->data[$key];
}

function user_validate_name($name) {

  /*
  ** Verify the syntax of the given name:
  */

Dries's avatar
 
Dries committed
201 202 203 204
  if (!$name) return t("You must enter a username.");
  if (ereg("^ ", $name)) return t("The username cannot begin with a space.");
  if (ereg(" \$", $name)) return t("The username cannot end with a space.");
  if (ereg("  ", $name)) return t("The username cannot contain multiple spaces in a row.");
Dries's avatar
 
Dries committed
205
  if (ereg("[^ a-zA-Z0-9@_\.\-]", $name)) return t("The username contains an illegal character.");
Dries's avatar
 
Dries committed
206
  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
207
  if (strlen($name) > 56) return t("The username '%name' is too long: it must be less than 56 characters.", array("%name" => $name));
Dries's avatar
 
Dries committed
208 209 210 211
}

function user_validate_mail($mail) {

Dries's avatar
 
Dries committed
212
  if ($mail && !valid_email_address($mail)) {
Dries's avatar
 
Dries committed
213
    return t("The e-mail address '%mail' is not valid.", array("%mail" => $mail));
Dries's avatar
 
Dries committed
214 215 216
  }
}

217
function user_validate_authmap($account, $authname, $module) {
Dries's avatar
 
Dries committed
218
  $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid != %d AND authname = '%s'", $account->uid, $authname);
Dries's avatar
 
Dries committed
219 220 221 222
  if (db_result($result) > 0) {
    $name = module_invoke($module, "info", "name");
    return t("The %u ID %s is already taken.", array("%u" => ucfirst($name), "%s" => "<i>$authname</i>"));
  }
Dries's avatar
 
Dries committed
223 224
}

Dries's avatar
 
Dries committed
225
function user_password($length = 10) {
Dries's avatar
 
Dries committed
226 227

  /*
Dries's avatar
 
Dries committed
228
  ** Generate a random alphanumeric password.
Dries's avatar
 
Dries committed
229 230
  */

Dries's avatar
 
Dries committed
231 232 233 234 235 236 237 238 239
  // 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.
  $allowable_characters = "abcdefghijklmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
  // We see how many characters are in the allowable list:
  $len = strlen($allowable_characters);

  // Seed the random number generator with the microtime stamp:
Dries's avatar
 
Dries committed
240
  mt_srand((double)microtime() * 1000000);
Dries's avatar
 
Dries committed
241 242 243 244 245 246 247 248 249 250 251 252 253

  // Declare the password as a blank string:
  $pass = "";

  // Loop the number of times specified by $length:
  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
254 255 256 257 258 259
}

function user_access($string) {

  global $user;
  static $perm;
Dries's avatar
 
Dries committed
260
  static $cache;
Dries's avatar
 
Dries committed
261

Dries's avatar
 
Dries committed
262
  // User #1 has all priveleges:
Dries's avatar
 
Dries committed
263 264 265 266
  if ($user->uid == 1) {
    return 1;
  }

Dries's avatar
 
Dries committed
267 268 269 270
  /*
  ** To reduce the number of SQL queries, we cache the user's permissions
  ** in a static variable.
  */
Dries's avatar
 
Dries committed
271

Dries's avatar
 
Dries committed
272
  if (!$cache) {
Dries's avatar
 
Dries committed
273
    if ($user->uid) {
Dries's avatar
 
Dries committed
274
      $perm = db_result(db_query("SELECT p.perm FROM {role} r, {permission} p WHERE r.rid = p.rid AND name = '%s'", $user->role), 0);
Dries's avatar
 
Dries committed
275 276
    }
    else {
Dries's avatar
 
Dries committed
277
      $perm = db_result(db_query("SELECT p.perm FROM {role} r, {permission} p WHERE r.rid = p.rid AND name = 'anonymous user'"), 0);
Dries's avatar
 
Dries committed
278
    }
Dries's avatar
 
Dries committed
279 280 281 282 283 284 285

    /*
    ** We use a separate $cache variable because $perm might be empty when a
    ** user has no access rights.
    */

    $cache = 1;
Dries's avatar
 
Dries committed
286 287
  }

Dries's avatar
 
Dries committed
288
  return strstr($perm, $string);
Dries's avatar
 
Dries committed
289 290 291 292 293
}

function user_mail($mail, $subject, $message, $header) {
  if (variable_get("smtp_library", "") && file_exists(variable_get("smtp_library", ""))) {
    include_once variable_get("smtp_library", "");
294
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
295 296
  }
  else {
297 298 299 300 301 302 303
    /*
    ** Note: if you are having problems with sending mail, or mails look wrong
    ** when they are recieved you may have to modify the str_replace to suit
    ** 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
304 305 306 307 308 309 310 311 312 313 314 315
    **
    ** 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
    **
316
    */
Dries's avatar
 
Dries committed
317 318 319 320
    return mail(
      $mail,
      user_mail_encode($subject),
      str_replace("\r", "", $message),
Kjartan's avatar
Kjartan committed
321
      "MIME-Version: 1.0\nContent-type: text/plain; charset=UTF-8; format=flowed\nContent-transfer-encoding: 8Bit\n" . $header
Dries's avatar
 
Dries committed
322
    );
Dries's avatar
 
Dries committed
323 324 325
  }
}

Kjartan's avatar
Kjartan committed
326 327 328 329 330
function user_mail_encode($string, $charset = "UTF-8") {
  /*
  ** Used to encodes mail headers that contain non US- ASCII
  ** characters.
  ** http://www.rfc-editor.org/rfc/rfc2047.txt
Kjartan's avatar
Kjartan committed
331 332 333 334 335 336 337 338
  **
  ** Notes:
  **   - The chunks come in groupings of 4 bytes when using base64
  **     encoded.
  **   - trim() is used to ensure that no extra spacing is added by
  **     chunk_split() or preg_replace().
  **   - Using \n as the chunk separator may cause problems on some
  **     systems and may have to be changed to \r\n or \r.
Kjartan's avatar
Kjartan committed
339
  */
Kjartan's avatar
Kjartan committed
340 341 342
  $chunk_size = 75 - 7 - strlen($charset);
  $chunk_size -= $chunk_size % 4;
  $string = trim(chunk_split(base64_encode($string), $chunk_size, "\n"));
Kjartan's avatar
Kjartan committed
343 344
  $string = trim(preg_replace('/^(.*)$/m', " =?$charset?B?\\1?=", $string));
  return $string;
Dries's avatar
 
Dries committed
345 346
}

Dries's avatar
 
Dries committed
347 348
function user_deny($type, $mask) {

Dries's avatar
 
Dries committed
349
  $allow = db_fetch_object(db_query("SELECT * FROM {access} WHERE status = '1' AND type = '%s' AND LOWER('%s') LIKE LOWER(mask)", $type, $mask));
Dries's avatar
 
Dries committed
350

Dries's avatar
 
Dries committed
351
  $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
352 353 354 355 356 357 358 359 360

  if ($deny && !$allow) {
    return 1;
  }
  else {
    return 0;
  }
}

Dries's avatar
 
Dries committed
361 362
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
363

Dries's avatar
 
Dries committed
364
  if (!$fields) {
Dries's avatar
 
Dries committed
365
    $result = db_query("SELECT * FROM {users} WHERE uid = 1");
Kjartan's avatar
Kjartan committed
366 367 368
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
369
  }
Dries's avatar
 
Dries committed
370

Kjartan's avatar
Kjartan committed
371
  // Make sure we return the default fields at least
Dries's avatar
 
Dries committed
372
  return is_array($fields) ? $fields: array("uid", "name", "pass", "mail", "mode", "sort", "threshold", "theme", "signature", "timestamp", "status", "timezone", "language", "init", "data", "rid");
Dries's avatar
 
Dries committed
373 374
}

Dries's avatar
 
Dries committed
375 376 377 378 379 380 381
/*** Module hooks **********************************************************/

function user_perm() {
  return array("administer users");
}

function user_search($keys) {
Dries's avatar
 
Dries committed
382

Dries's avatar
 
Dries committed
383
  $result = db_query_range("SELECT * FROM {users} WHERE name LIKE '%". check_query($keys) ."%'", 0, 20);
Dries's avatar
 
Dries committed
384
  while ($account = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
385
    $find[$i++] = array("title" => $account->name, "link" => (strstr(request_uri(), "admin") ? url("admin/user/edit/$account->uid") : url("user/view/$account->uid")), "user" => $account->name);
Dries's avatar
 
Dries committed
386 387 388 389
  }
  return $find;
}

Dries's avatar
 
Dries committed
390
function user_block($op = "list", $delta = 0) {
Dries's avatar
 
Dries committed
391 392 393
  global $user;

  $edit = $_POST["edit"];
394

Dries's avatar
 
Dries committed
395
  if ($op == "list") {
Dries's avatar
 
Dries committed
396
     $blocks[0]["info"] = t("User login");
397
     $blocks[1]["info"] = t("Navigation");
398
     $blocks[2]["info"] = t("Who's new");
399

400
     return $blocks;
401 402
  }
  else {
Dries's avatar
 
Dries committed
403 404
    switch ($delta) {
      case 0:
405
        if (!$user->uid) {
Dries's avatar
 
Dries committed
406 407 408 409 410 411 412 413 414
          /*
          ** For usability's sake, avoid showing two login forms on one
          ** page.
          */

          if (arg(0) == "user" && arg(1) != "view") {
            return;
          }

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

417
          /*
Dries's avatar
Dries committed
418 419
          ** Save the referer.  We record where the user came from such
          ** that we/ can redirect him after having completed the login
420 421
          ** form.
          */
Dries's avatar
Dries committed
422

423
          if (empty($edit)) {
Dries's avatar
 
Dries committed
424
            $edit["destination"] = url($_GET["q"]);
425 426
          }
          // 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.
Dries's avatar
Dries committed
427

Dries's avatar
 
Dries committed
428 429 430
          $form = form_hidden("destination", $edit["destination"]);
          $form .= form_textfield(t("Username"), "name", $edit["name"], 15, 64);
          $form .= form_password(t("Password"), "pass", $pass, 15, 64);
Dries's avatar
 
Dries committed
431 432

          if (variable_get("user_remember", 0) == 0) {
Dries's avatar
 
Dries committed
433
            $form .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
 
Dries committed
434 435
          }
          elseif (variable_get("user_remember", 1) == 1) {
Dries's avatar
 
Dries committed
436
            $form .= form_hidden("remember_me", 1);
Dries's avatar
 
Dries committed
437
          }
438

Dries's avatar
 
Dries committed
439 440 441 442 443
          $form .= form_submit(t("Log in"));

          $output .= form($form, "post", url("user/login"));

          $output .= "</div>\n";
Dries's avatar
 
Dries committed
444

Dries's avatar
 
Dries committed
445
          if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
446
            $items[] = l(t("Create new account"), "user/register", array("title" => t("Create a new user account.")));
Dries's avatar
 
Dries committed
447
          }
Dries's avatar
 
Dries committed
448
          $items[] = l(t("Request new password"), "user/password", array("title" => t("Request new password via e-mail.")));
Dries's avatar
 
Dries committed
449

450
          $output .= theme("theme_item_list", $items);
451

Dries's avatar
 
Dries committed
452
          $block["subject"] = t("User login");
Dries's avatar
 
Dries committed
453
          $block["content"] = "<div class=\"user-login-link\">$output</div>";
Dries's avatar
 
Dries committed
454
        }
Dries's avatar
Dries committed
455
        return $block;
456
      case 1:
Dries's avatar
 
Dries committed
457 458 459 460 461
        if ($menu = menu_tree()) {
           $block["subject"] = $user->uid ? $user->name : t("Navigation");
           $block["content"] = "<div id=\"menu\">". $menu ."</div>";
        }

462
        return $block;
Dries's avatar
 
Dries committed
463
      case 2:
464 465 466 467 468
        if (user_access("access content")) {
          $result = db_query_range("SELECT uid, name FROM {users} WHERE status != '0' ORDER BY uid DESC", 0, 5);
          while ($account = db_fetch_object($result)) {
            $items[] = l((strlen($account->name) > 15 ? substr($account->name, 0, 15) . '...' : $account->name), "user/view/$account->uid");
          }
Dries's avatar
 
Dries committed
469

470
          $output = theme("theme_user_list", $items);
Dries's avatar
 
Dries committed
471

472 473 474 475
          $block["subject"] = t("Who's new");
          $block["content"] = $output;
          return $block;
        }
Dries's avatar
 
Dries committed
476 477
    }
  }
478 479
}

Dries's avatar
 
Dries committed
480
function theme_user_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
481
  return theme("theme_item_list", $items, $title);
Dries's avatar
 
Dries committed
482 483
}

Dries's avatar
 
Dries committed
484
function theme_menu_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
485
  return theme("theme_item_list", $items, $title);
Dries's avatar
 
Dries committed
486 487
}

Dries's avatar
 
Dries committed
488
function user_link($type) {
Dries's avatar
 
Dries committed
489 490 491

  $links = array();

Dries's avatar
 
Dries committed
492
  if ($type == "page") {
Dries's avatar
 
Dries committed
493
    $links[] = l(t("user account"), "user", array("title" => t("Create a user account, request a new password or edit your account settings.")));
Dries's avatar
 
Dries committed
494 495
  }

Dries's avatar
 
Dries committed
496
  if ($type == "system") {
Dries's avatar
Dries committed
497 498
    global $user;
    if ($user->uid) {
Dries's avatar
 
Dries committed
499 500
      menu("user/edit", t("my account"), "user_page", 8);
      menu("user/logout", t("log out"), "user_page", 10);
Dries's avatar
Dries committed
501
    }
Dries's avatar
 
Dries committed
502
    if (user_access("administer users")) {
Dries's avatar
 
Dries committed
503 504 505 506 507 508 509 510 511 512 513 514
      menu("admin/user", t("accounts"), "user_admin", 2);
      menu("admin/user/create", t("new user"), "user_admin", 1);
      menu("admin/user/account", t("users"), "user_admin", 2);
      menu("admin/user/access", t("access rules"), NULL, 3);
      menu("admin/user/access/mail", t("by e-mail"), "user_admin");
      menu("admin/user/access/user", t("by name"), "user_admin");
      menu("admin/user/role", t("roles"), "user_admin", 4);
      menu("admin/user/permission", t("permissions"), "user_admin", 5);
      menu("admin/user/search", t("search"), "user_admin", 8);
      menu("admin/user/help", t("help"), "user_help", 9);
      menu("admin/user/edit", t("edit user account"), "user_admin", 0, 1); // hidden menu
      menu("admin/user/account/1", t("blocked users"), "user_admin", 3);
Dries's avatar
 
Dries committed
515 516 517

      $i = 2;
      foreach (user_roles(1) as $key => $value) {
Dries's avatar
 
Dries committed
518
        menu("admin/user/account/$i", t("users with role '%role'", array("%role" => $value)), "user_admin", 4);
Dries's avatar
 
Dries committed
519
      }
Dries's avatar
 
Dries committed
520
    }
Dries's avatar
 
Dries committed
521 522
  }

Dries's avatar
 
Dries committed
523
  return $links;
Dries's avatar
 
Dries committed
524 525 526 527
}

/*** Authentication methods ************************************************/

528
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
529 530

  /*
531
  **  Called by authentication modules in order to edit/view their authmap information.
Dries's avatar
 
Dries committed
532 533
  */

Dries's avatar
 
Dries committed
534
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
535 536 537
  return db_result($result);
}

Dries's avatar
 
Dries committed
538

539 540 541 542 543 544 545
function user_get_authmaps($authname = NULL) {

  /*
  ** Accepts an user object, $account, or an DA name and returns an
  ** associtive array of modules and DA names. Called at external login.
  */

Dries's avatar
 
Dries committed
546
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
  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) {
    $module = explode("_", $key, 2);
    if ($value) {
Dries's avatar
 
Dries committed
562
      $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
563
      if (db_result($result) == 0) {
Dries's avatar
 
Dries committed
564
        $result = db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
Dries's avatar
 
Dries committed
565 566
      }
      else {
Dries's avatar
 
Dries committed
567
        $result = db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
568 569 570
      }
    }
    else {
Dries's avatar
 
Dries committed
571
      $result = db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
572 573 574 575 576 577
    }
  }
  return $result;
}

function user_auth_help_links() {
578
  $links = array();
Dries's avatar
 
Dries committed
579
  foreach (module_list() as $module) {
Dries's avatar
 
Dries committed
580
    if (module_hook($module, "auth")) {
Dries's avatar
 
Dries committed
581
      $links[] = l(module_invoke($module, "info", "name"), "user/help#$module");
Dries's avatar
 
Dries committed
582 583 584 585 586 587 588
    }
  }
  return $links;
}

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

Dries's avatar
 
Dries committed
589
function user_login($edit = array(), $msg = "") {
Dries's avatar
 
Dries committed
590
  global $user, $base_url;
Dries's avatar
 
Dries committed
591 592 593 594 595 596

  /*
  ** If we are already logged on, go to the user page instead.
  */

  if ($user->uid) {
Dries's avatar
 
Dries committed
597
    drupal_goto(url("user"));
Dries's avatar
 
Dries committed
598 599 600
  }

  if (user_deny("user", $edit["name"])) {
Dries's avatar
 
Dries committed
601
    $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
602 603 604 605
  }
  else if ($edit["name"] && $edit["pass"]) {

    /*
Dries's avatar
 
Dries committed
606
    ** Try to log in the user locally:
Dries's avatar
 
Dries committed
607 608
    */

Dries's avatar
 
Dries committed
609
    if (!$user->uid) {
610 611
      $name = $edit["name"];
      $pass = $edit["pass"];
Dries's avatar
 
Dries committed
612 613 614 615 616 617 618 619
      $user = user_load(array("name" => $name, "pass" => $pass, "status" => 1));
    }

    /*
    ** Strip name and server from ID:
    */

    if ($server = strrchr($edit["name"], "@")) {
620 621 622
      $name = substr($edit["name"], 0, strlen($edit["name"]) - strlen($server));
      $server = substr($server, 1);
      $pass = $edit["pass"];
Dries's avatar
 
Dries committed
623
    }
Dries's avatar
 
Dries committed
624

Dries's avatar
 
Dries committed
625 626 627 628
    /*
    ** When possible, determine corrosponding external auth source. Invoke source, and login user if successful:
    */

Dries's avatar
 
Dries committed
629
    if (!$user->uid && $server && $result = user_get_authmaps("$name@$server")) {
Dries's avatar
 
Dries committed
630 631
      if (module_invoke(key($result), "auth", $name, $pass, $server)) {
        $user = user_external_load("$name@$server");
Dries's avatar
 
Dries committed
632
        watchdog("user", "external load: $name@$server, module: ". key($result));
Dries's avatar
 
Dries committed
633 634
      }
      else {
Dries's avatar
 
Dries committed
635
        $error = t("Invalid password for %s.", array("%s" => "<i>$name@$server</i>"));
Dries's avatar
 
Dries committed
636 637 638 639 640 641 642
      }
    }

     /*
    ** Try each external authentication source in series. Register user if successful.
    */

Dries's avatar
 
Dries committed
643
    else if (!$user->uid && $server) {
Dries's avatar
 
Dries committed
644 645 646 647
      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 && !user_load(array("name" => "$name@$server"))) { //register this new user
Dries's avatar
Dries committed
648
              $user = user_save("", array("name" => "$name@$server", "pass" => user_password(), "init" => "$name@$server", "status" => 1, "authname_$module" => "$name@$server", "rid" => _user_authenticated_id()));
Dries's avatar
 
Dries committed
649
              watchdog("user", "new user: $name@$server ($module ID)", l(t("edit user"), "admin/user/edit/$user->uid"));
Dries's avatar
 
Dries committed
650 651 652 653 654 655 656 657 658 659
              break;
            }
          }
        }
      }
    }

    if ($user->uid) {
      watchdog("user", "session opened for '$user->name'");

Dries's avatar
 
Dries committed
660 661
      // update the user table timestamp noting user has logged in
      db_query("UPDATE {users} SET timestamp = '%d' WHERE uid = '%s'", time(), $user->uid);
Dries's avatar
 
Dries committed
662 663 664 665 666 667

      /*
      ** If the user wants to be remembered, set the proper cookie such
      ** that the session won't expire.
      */

Dries's avatar
 
Dries committed
668
      $path = preg_replace("/.+\/\/[^\/]+(.*)/", "\$1/", $base_url);
Dries's avatar
 
Dries committed
669
      if ($edit["remember_me"]) {
Dries's avatar
 
Dries committed
670
        setcookie(session_name(), session_id(), time() + 3600 * 24 * 365, $path);
Dries's avatar
 
Dries committed
671
      }
Dries's avatar
 
Dries committed
672
      else {
Dries's avatar
 
Dries committed
673
        setcookie(session_name(), session_id(), FALSE, $path);
Dries's avatar
 
Dries committed
674 675 676
      }

      /*
Dries's avatar
 
Dries committed
677
      ** Redirect the user to the page he logged on from.
Dries's avatar
 
Dries committed
678 679
      */

Dries's avatar
 
Dries committed
680
      drupal_goto($edit["destination"]);
Dries's avatar
 
Dries committed
681 682 683
    }
    else {
      if (!$error) {
Dries's avatar
 
Dries committed
684
        $error = t("Sorry.  Unrecognized username or password.") ." ". l(t("Have you forgotten your password?"), "user/password");
Dries's avatar
 
Dries committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
      }
      if ($server) {
        watchdog("user", "failed login for '$name@$server': $error");
      }
      else {
        watchdog("user", "failed login for '$name': $error");
      }
    }
  }

  /*
  ** Display error message (if any):
  */

  if ($error) {
700
    $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
701 702
  }

Dries's avatar
 
Dries committed
703 704 705 706 707
  /*
  ** Save the referer.  We record where the user came from such that we
  ** can redirect him after having completed the login form.
  */

708
  if (empty($edit)) {
Dries's avatar
 
Dries committed
709
    $edit["destination"] = url($_GET["q"]);
Dries's avatar
 
Dries committed
710 711 712
  }
  $output .= form_hidden("destination", $edit["destination"]);

Dries's avatar
 
Dries committed
713 714 715 716
  /*
  ** Display login form:
  */

Dries's avatar
 
Dries committed
717 718 719
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
Dries's avatar
 
Dries committed
720
  if (count(user_auth_help_links()) > 0) {
Dries's avatar
 
Dries committed
721
    $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
722 723
  }
  else {
Dries's avatar
 
Dries committed
724
    $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
725
  }
Dries's avatar
 
Dries committed
726
  $output .= form_password(t("Password"), "pass", $pass, 30, 64, t("Enter the password that accompanies your username."));
727
  $output .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
 
Dries committed
728
  $output .= form_submit(t("Log in"));
Dries's avatar
 
Dries committed
729
  $items[] = l(t("Request new password"), "user/password");
730
  if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
731
    $items[] = l(t("Create new account"), "user/register");
732
  }
Dries's avatar
 
Dries committed
733
  $output .= theme("theme_item_list", $items);
Dries's avatar
 
Dries committed
734

Dries's avatar
 
Dries committed
735
  return form($output, "post", url("user"));
Dries's avatar
 
Dries committed
736 737
}

738
function _user_authenticated_id() {
Dries's avatar
 
Dries committed
739
  return db_result(db_query("SELECT rid FROM {role} WHERE name = 'authenticated user'"));
740 741
}

Dries's avatar
 
Dries committed
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
function user_logout() {
  global $user;

  if ($user->uid) {
    watchdog("user", "session closed for user '$user->name'");

    /*
    ** Destroy the current session:
    */

    session_destroy();
    unset($user);
  }

  /*
  ** Redirect the user to his personal information page:
  */

Dries's avatar
 
Dries committed
760
  drupal_goto(url());
Dries's avatar
 
Dries committed
761 762 763 764 765

}

function user_pass($edit = array()) {

Dries's avatar
 
Dries committed
766 767
  global $base_url;

Kjartan's avatar
Kjartan committed
768
  if ($edit["name"]) {
Dries's avatar
 
Dries committed
769
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM {users} WHERE name = '%s'", $edit["name"]));
Dries's avatar
 
Dries committed
770
    if (!$account) $error = t("Sorry. The username <i>%s</i> is not recognized.", array("%s" => $edit["name"]));
771
  }
Kjartan's avatar
Kjartan committed
772
  else if ($edit["mail"]) {
Dries's avatar
 
Dries committed
773
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM {users} WHERE mail = '%s'", $edit["mail"]));
Dries's avatar
 
Dries committed
774
    if (!$account) $error = t("Sorry. The e-mail address <i>%s</i> is not recognized.", array("%s" => $edit["mail"]));
Kjartan's avatar
Kjartan committed
775 776
  }
  if ($account) {
Dries's avatar
 
Dries committed
777

778
      $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
779 780 781 782 783 784 785 786 787 788 789 790
      $pass = user_password();

      /*
      ** Save new password:
      */

      user_save($account, array("pass" => $pass));

      /*
      ** Mail new password:
      */

Dries's avatar
 
Dries committed
791
      $variables = array("%username" => $account->name, "%site" => variable_get("site_name", "drupal"), "%password" => $pass, "%uri" => $base_url, "%uri_brief" => substr($base_url, strlen("http://")), "%mailto" => $account->mail, "%date" => format_date(time()));
Dries's avatar
 
Dries committed
792 793
      $subject = strtr(variable_get("user_mail_pass_subject", _user_mail_text("pass_subject")), $variables);
      $body = strtr(variable_get("user_mail_pass_body", _user_mail_text("pass_body")), $variables);
794
      $headers = "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from";
Dries's avatar
 
Dries committed
795
      $mail_success = user_mail($account->mail, $subject, $body, $headers);
Dries's avatar
 
Dries committed
796

Dries's avatar
 
Dries committed
797 798 799 800 801 802 803 804
      if ($mail_success) {
        watchdog("user", "mail password: '". $account->name ."' &lt;". $account->mail ."&gt;");
        return t("Your password and further instructions have been sent to your e-mail address.");
      }
      else {
        watchdog("error", "error mailing new password: '". $account->name ."' &lt;". $account->mail ."&gt;");
        return t("Unable to send mail. Please contact the site admin.");
      }
Dries's avatar
 
Dries committed
805 806
    }
    else {
807

Kjartan's avatar
Kjartan committed
808 809
    // Display error message if necessary.
    if ($error) {
810
      $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
811 812 813 814 815 816
    }

    /*
    ** Display form:
    */

Dries's avatar
 
Dries committed
817
    $output .= "<p>". sprintf(t("Enter your username %sor%s your e-mail address."), "<b><i>", "</i></b>") ."</p>";
Dries's avatar
 
Dries committed
818 819 820
    $output .= form_textfield(t("Username"), "name", $edit["name"], 30, 64);
    $output .= form_textfield(t("E-mail address"), "mail", $edit["mail"], 30, 64);
    $output .= form_submit(t("E-mail new password"));
Dries's avatar
 
Dries committed
821
    $items[] = l(t("Log in"), "user/login");
822
    if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
823
      $items[] = l(t("Create new account"), "user/register");
824
    }
Dries's avatar
 
Dries committed
825
    $output .= theme("theme_item_list", $items);
Dries's avatar
 
Dries committed
826

Dries's avatar
 
Dries committed
827
    return form($output, "post", url("user"));
Dries's avatar
 
Dries committed
828 829 830 831
  }
}

function user_register($edit = array()) {
Dries's avatar
 
Dries committed
832
  global $user, $base_url;
833

Dries's avatar
 
Dries committed
834
  $edit = $_POST["edit"];
835 836 837 838 839
  /*
  ** If we are already logged on, go to the user page instead.
  */

  if ($user->uid) {
Dries's avatar
 
Dries committed
840
    drupal_goto(url("user/edit"));
841
  }
Dries's avatar
 
Dries committed
842 843 844 845 846 847 848 849 850

  if ($edit["name"] && $edit["mail"]) {
    if ($error = user_validate_name($edit["name"])) {
      // do nothing
    }
    else if ($error = user_validate_mail($edit["mail"])) {
      // do nothing
    }
    else if (user_deny("user", $edit["name"])) {
Dries's avatar
 
Dries committed
851
      $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
852 853
    }
    else if (user_deny("mail", $edit["mail"])) {
Dries's avatar
 
Dries committed
854
      $error = t("The e-mail address '%s' has been denied access.", array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
855
    }
Dries's avatar
 
Dries committed
856
    else if (db_num_rows(db_query("SELECT name FROM {users} WHERE LOWER(name) = LOWER('%s')", $edit["name"])) > 0) {
Dries's avatar
 
Dries committed
857
      $error = t("The name '%s' is already taken.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
858
    }
Dries's avatar
 
Dries committed
859
    else if (db_num_rows(db_query("SELECT mail FROM {users} WHERE LOWER(mail) = LOWER('%s') OR LOWER(init) = LOWER('%s')", $edit["mail"], $edit["mail"])) > 0) {
Dries's avatar
 
Dries committed
860
      $error = t("The e-mail address '%s' is already taken.", array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
861
    }
Dries's avatar
 
Dries committed
862
    else if (variable_get("user_register", 1) == 0) {
Dries's avatar
 
Dries committed
863 864 865
      $error = t("Public registrations have been disabled by the site administrator.");
    }
    else {
Dries's avatar
 
Dries committed
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
      foreach (module_list() as $module) {
        if (module_hook($module, "user")) {
          $result = module_invoke($module, "user", "register_validate", $edit, $user);
          if (is_array($result)) {
            $data = array_merge($data, $result);
          }
          elseif (is_string($result)) {
            $error = $result;
            break;
          }
        }
      }
      if (!$error) {
        $success = 1;
      }
Dries's avatar
 
Dries committed
881 882 883 884 885
    }
  }

  if ($success) {

886
    $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
887 888
    $pass = user_password();

889
    // create new user account, noting whether administrator approval is required
890 891 892
    user_role_init();
    // TODO: is this necessary? Won't session_write replicate this?
    unset($edit["session"]);
893
    $account = user_save("", array_merge(array("name" => $edit["name"], "pass" => $pass, "init" => $edit["mail"], "mail" => $edit["mail"], "rid" => _user_authenticated_id(), "status" => (variable_get("user_register", 1) == 1 ? 1 : 0)), $data));
Dries's avatar
 
Dries committed
894
    watchdog("user", "new user: '". $edit["name"] ."' &lt;". $edit["mail"] ."&gt;", l(t("edit user"), "admin/user/edit/$account->uid"));
Dries's avatar
 
Dries committed
895

Dries's avatar
 
Dries committed
896
    $variables = array("%username" => $edit["name"], "%site" => variable_get("site_name", "drupal"), "%password" => $pass, "%uri" => $base_url, "%uri_brief" => substr($base_url, strlen("http://")), "%mailto" => $edit["mail"], "%date" => format_date(time()));
897

Dries's avatar
 
Dries committed
898
    //the first user may login immediately, and receives a customized welcome e-mail.
899
    if ($account->uid == 1) {
Dries's avatar
 
Dries committed
900
      user_mail($edit["mail"], t("drupal user account details for %s", array("%s" => $edit["name"])), strtr(t("%username,\n\nYou may now login to %uri using the following username and password:\n\n  username: %username\n  password: %password\n\n". url("user/edit") ."\n\n--drupal"), $variables), "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
901
      // This should not be t()'ed. No point as its only shown once in the sites lifetime, and it would be bad to store the password
Dries's avatar
 
Dries committed
902
      $output .= "<p>Welcome to Drupal. You are user #1, which gives you full and immediate access.  All future registrants will receive their passwords via e-mail, so please configure your e-mail settings using the Administration pages.</p><p> Your password is <b>$pass</b>. You may change your password on the next page.</p><p>Please login below.</p>";
Dries's avatar
 
Dries committed
903
      $output .= form_hidden("destination", url("user/edit"));
904
      $output .= form_hidden("name", $account->name);
905 906 907 908 909
      $output .= form_hidden("pass", $pass);
      $output .= form_submit(t("Log in"));
      return form($output);
    }
    else {
910 911 912 913 914
      if ($account->status) {
        /*
        ** Create new user account, no administrator approval required:
        */

Dries's avatar
 
Dries committed
915 916
        $subject = strtr(variable_get("user_mail_welcome_subject", _user_mail_text("welcome_subject")), $variables);
        $body = strtr(variable_get("user_mail_welcome_body", _user_mail_text("welcome_body")), $variables);
917 918 919 920 921 922 923
        user_mail($edit["mail"], $subject, $body, "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
        return t("Your password and further instructions have been sent to your e-mail address.");
      }
      else {
        /*
        ** Create new user account, administrator approval required:
        */
Dries's avatar
 
Dries committed
924 925
        $subject = strtr(variable_get("user_mail_approval_subject", _user_mail_text("welcome_approval_subject")), $variables);
        $body = strtr(variable_get("user_mail_approval_body", _user_mail_text("welcome_approval_body")), $variables);
926
        user_mail($edit["mail"], $subject, $body, "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
Dries's avatar
 
Dries committed
927
        user_mail(variable_get("site_mail", ini_get("sendmail_from")), $subject, t("%u has applied for an account.\n\n%uri", array("%u" => $account->name, "%uri" => url("admin/user/edit/$account->uid"))), "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
Dries's avatar
 
Dries committed
928
        return t("Thank you for applying for an account. Your account is currently pending approval by the site administrator.<br />In the meantime, your password and further instructions have been sent to your e-mail address.");
929
      }
930
    }
Dries's avatar
 
Dries committed
931 932 933
  }
  else {
    if ($error) {
934
      $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
935
    }
936
  }
Dries's avatar
 
Dries committed
937

938
  // display the registration form
939
  $output .= variable_get("user_registration_help", "");
940
  $affiliates = user_auth_help_links();
Dries's avatar
 
Dries committed
941
  if (count($affiliates) > 0) {
942
    $affiliates = implode(", ", $affiliates);
Dries's avatar
 
Dries committed
943
    $output .= "<p>". t("Note: If you have an account with one of our affiliates (%s), you may ". l("login now", "user/login") ." instead of registering.", array("%s" => $affiliates)) ."</p>";
944
  }
Dries's avatar
 
Dries committed
945
  $output .= form_textfield(t("Username"), "name", $edit["name"], 30, 64, t("Your full name or your preferred username: only letters, numbers and spaces are allowed."));
946 947 948 949
  $output .= form_textfield(t("E-mail address"), "mail", $edit["mail"], 30, 64, t("A password and instructions will be sent to this e-mail address, so make sure it is accurate."));
  foreach (module_list() as $module) {
    if (module_hook($module, "user")) {
      $output .= module_invoke($module, "user", "register_form", $edit, $user);
Dries's avatar
 
Dries committed
950
    }
Dries's avatar
 
Dries committed
951
  }