user.module 86.2 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3 4 5 6
<?php
// $Id$

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

7
function user_system($field){
Kjartan's avatar
Kjartan committed
8
  $system["description"] = t("Enables the user registration and login system.");
Dries's avatar
 
Dries committed
9
  $system["admin_help"] = t("In order to use the full power of Drupal a visitor must sign up for an account. This page lets you setup how a user signs up, logs out, the guidelines from the system about user subscriptions, and the e-mails the system will send to the user.");
10 11 12
  return $system[$field];
}

Dries's avatar
 
Dries committed
13 14 15 16 17 18 19 20 21 22 23 24
/*** 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
25 26 27

  $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
28 29 30 31 32 33 34
  if ($user->data && $data = unserialize($user->data)) {
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
 
Dries committed
35

36
  return !empty($user->session) ? $user->session : '';
Dries's avatar
 
Dries committed
37 38 39
}

function sess_write($key, $value) {
Dries's avatar
 
Dries committed
40 41 42
  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
43

Dries's avatar
 
Dries committed
44 45 46
  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
47

Dries's avatar
 
Dries committed
48 49 50 51 52
  return '';
}

function sess_destroy($key) {

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

Dries's avatar
 
Dries committed
55 56 57
}

function sess_gc($lifetime) {
Dries's avatar
 
Dries committed
58 59 60 61 62 63 64 65 66 67

  /*
  **  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
68
  return 1;
Dries's avatar
 
Dries committed
69

Dries's avatar
 
Dries committed
70 71 72 73 74
}

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

function user_external_load($authname) {
Dries's avatar
 
Dries committed
75
  $arr_uid = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

  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
92 93
  $query = "";

Dries's avatar
 
Dries committed
94 95
  foreach ($array as $key => $value) {
    if ($key == "pass") {
Kjartan's avatar
Kjartan committed
96
      $query .= "u.$key = '". md5($value) ."' AND ";
97
    }
Dries's avatar
 
Dries committed
98
    else {
Dries's avatar
 
Dries committed
99
      $query .= "u.$key = '". check_query($value) ."' AND ";
Dries's avatar
 
Dries committed
100 101
    }
  }
Dries's avatar
 
Dries committed
102
  $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
103 104

  $user = db_fetch_object($result);
Dries's avatar
 
Dries committed
105
  if ($user->data && $data = unserialize($user->data)) {
Dries's avatar
 
Dries committed
106 107 108 109 110 111
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
 
Dries committed
112 113 114 115 116 117 118 119 120

  return $user;
}

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

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

Dries's avatar
 
Dries committed
144
    db_query("UPDATE {users} SET $query timestamp = %d WHERE uid = %d", array_merge($v, array(time(), $account->uid)));
Dries's avatar
 
Dries committed
145 146 147 148 149

    $user = user_load(array("uid" => $account->uid));
  }
  else {
    $array["timestamp"] = time();
Dries's avatar
 
Dries committed
150
    $array["uid"] = db_next_id("users_uid");
Dries's avatar
 
Dries committed
151 152 153 154

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

Dries's avatar
 
Dries committed
170
    $fields[] = "data";
Dries's avatar
 
Dries committed
171 172
    $values[] = serialize($data);
    $s[] = "'%s'";
Dries's avatar
 
Dries committed
173

Dries's avatar
 
Dries committed
174
    db_query("INSERT INTO {users} (". implode(", ", $fields) .") VALUES (". implode(", ", $s) .")", $values);
Dries's avatar
 
Dries committed
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 201 202 203 204 205 206

    $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
207 208 209 210
  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
211
  if (ereg("[^ a-zA-Z0-9@_\.\-]", $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" => $name));
Dries's avatar
 
Dries committed
214 215 216 217
}

function user_validate_mail($mail) {

Dries's avatar
 
Dries committed
218
  if ($mail && !valid_email_address($mail)) {
Dries's avatar
 
Dries committed
219
    return t("The e-mail address '%mail' is not valid.", array("%mail" => $mail));
Dries's avatar
 
Dries committed
220 221 222
  }
}

223
function user_validate_authmap($account, $authname, $module) {
Dries's avatar
 
Dries committed
224
  $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid != %d AND authname = '%s'", $account->uid, $authname);
Dries's avatar
 
Dries committed
225 226 227 228
  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
229 230
}

Dries's avatar
 
Dries committed
231
function user_password($length = 10) {
Dries's avatar
 
Dries committed
232 233

  /*
Dries's avatar
 
Dries committed
234
  ** Generate a random alphanumeric password.
Dries's avatar
 
Dries committed
235 236
  */

Dries's avatar
 
Dries committed
237 238 239 240 241 242 243 244 245
  // 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
246
  mt_srand((double)microtime() * 1000000);
Dries's avatar
 
Dries committed
247 248 249 250 251 252 253 254 255 256 257 258 259

  // 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
260 261 262 263 264 265 266
}

function user_access($string) {

  global $user;
  static $perm;

Dries's avatar
 
Dries committed
267 268 269 270
  if ($user->uid == 1) {
    return 1;
  }

Dries's avatar
 
Dries committed
271 272 273 274
  /*
  ** To reduce the number of SQL queries, we cache the user's permissions
  ** in a static variable.
  */
Dries's avatar
 
Dries committed
275

Dries's avatar
 
Dries committed
276
  if (!$perm) {
Dries's avatar
 
Dries committed
277
    if ($user->uid) {
Dries's avatar
 
Dries committed
278
      $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
279 280
    }
    else {
Dries's avatar
 
Dries committed
281
      $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
282 283 284
    }
  }

Dries's avatar
 
Dries committed
285
  return strstr($perm, $string);
Dries's avatar
 
Dries committed
286 287 288 289 290
}

function user_mail($mail, $subject, $message, $header) {
  if (variable_get("smtp_library", "") && file_exists(variable_get("smtp_library", ""))) {
    include_once variable_get("smtp_library", "");
291
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
292 293
  }
  else {
294 295 296 297 298 299 300
    /*
    ** 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
301 302 303 304 305 306 307 308 309 310 311 312
    **
    ** 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
    **
313 314
    */
    return mail($mail, $subject, str_replace("\r", "", $message), $header);
Dries's avatar
 
Dries committed
315 316 317 318 319
  }
}

function user_deny($type, $mask) {

Dries's avatar
 
Dries committed
320
  $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
321

Dries's avatar
 
Dries committed
322
  $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
323 324 325 326 327 328 329 330 331

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

Dries's avatar
 
Dries committed
332 333
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
334

Dries's avatar
 
Dries committed
335
  if (!$fields) {
Dries's avatar
 
Dries committed
336
    $result = db_query("SELECT * FROM {users} WHERE uid = 1");
Kjartan's avatar
Kjartan committed
337 338 339
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
340
  }
Dries's avatar
 
Dries committed
341

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

Dries's avatar
 
Dries committed
346 347 348 349 350 351 352
/*** Module hooks **********************************************************/

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

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

Dries's avatar
 
Dries committed
354
  $result = db_query_range("SELECT * FROM {users} WHERE name LIKE '%". check_query($keys) ."%'", 0, 20);
Dries's avatar
 
Dries committed
355
  while ($account = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
356
    $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
357 358 359 360
  }
  return $find;
}

Dries's avatar
 
Dries committed
361
function user_block($op = "list", $delta = 0) {
Dries's avatar
 
Dries committed
362 363 364
  global $user;

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

Dries's avatar
 
Dries committed
366
  if ($op == "list") {
Dries's avatar
 
Dries committed
367
     $blocks[0]["info"] = t("User login");
368 369
     $blocks[1]["info"] = t("User information");
     $blocks[2]["info"] = t("Who's new");
370

371
     return $blocks;
372 373
  }
  else {
Dries's avatar
 
Dries committed
374 375 376
    switch ($delta) {
      case 0:
        if (!$user->uid) {
Dries's avatar
 
Dries committed
377 378 379 380 381 382 383 384 385
          /*
          ** 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
386 387
          $output = "<div class=\"user-login-block\">\n";

388
          /*
Dries's avatar
Dries committed
389 390
          ** Save the referer.  We record where the user came from such
          ** that we/ can redirect him after having completed the login
391 392
          ** form.
          */
Dries's avatar
Dries committed
393

394
          if (empty($edit)) {
Dries's avatar
 
Dries committed
395
            $edit["destination"] = url($_GET["q"]);
396 397
          }
          // 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
398

Dries's avatar
 
Dries committed
399 400 401
          $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
402 403

          if (variable_get("user_remember", 0) == 0) {
Dries's avatar
 
Dries committed
404
            $form .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
 
Dries committed
405 406
          }
          elseif (variable_get("user_remember", 1) == 1) {
Dries's avatar
 
Dries committed
407
            $form .= form_hidden("remember_me", 1);
Dries's avatar
 
Dries committed
408
          }
409

Dries's avatar
 
Dries committed
410 411 412 413 414
          $form .= form_submit(t("Log in"));

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

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

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

421
          $output .= theme("theme_item_list", $items);
422

Dries's avatar
 
Dries committed
423
          $block["subject"] = t("User login");
Dries's avatar
 
Dries committed
424
          $block["content"] = "<div class=\"user-login-link\">$output</div>";
Dries's avatar
 
Dries committed
425 426 427 428 429
          return $block;
        }
        break;
      case 1:
        if ($user->uid) {
Dries's avatar
 
Dries committed
430
          $output = "<div class=\"user-information-block\">\n";
Dries's avatar
 
Dries committed
431 432 433 434
          $output .= theme("theme_menu_list", module_invoke_all("link", "menu.create"));
          $output .= theme("theme_menu_list", module_invoke_all("link", "menu.view"));
          $output .= theme("theme_menu_list", module_invoke_all("link", "menu.settings"));
          $output .= theme("theme_menu_list", module_invoke_all("link", "menu.misc"));
Dries's avatar
 
Dries committed
435
          $output .= "</div>\n";
436

Dries's avatar
 
Dries committed
437
          $block["subject"] = $user->name;
Dries's avatar
 
Dries committed
438
          $block["content"] = "<div class=\"user-login-link\">$output</div>";
Dries's avatar
 
Dries committed
439 440 441 442
          return $block;
        }
        break;
      case 2:
443 444 445 446 447
        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
448

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

451 452 453 454
          $block["subject"] = t("Who's new");
          $block["content"] = $output;
          return $block;
        }
Dries's avatar
 
Dries committed
455 456
    }
  }
457 458
}

Dries's avatar
 
Dries committed
459
function theme_user_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
460 461 462
  return theme("theme_item_list",$items, $title);
}

Dries's avatar
 
Dries committed
463
function theme_menu_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
464 465 466
  return theme("theme_item_list",$items, $title);
}

Dries's avatar
 
Dries committed
467
function user_link($type) {
Dries's avatar
 
Dries committed
468 469 470

  $links = array();

Dries's avatar
 
Dries committed
471
  if ($type == "page") {
Dries's avatar
 
Dries committed
472
    $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
473 474
  }

Dries's avatar
 
Dries committed
475
  if ($type == "menu.settings") {
Dries's avatar
 
Dries committed
476
    $links[] = l(t("edit account"), "user/edit", array("title" => t("View and edit your account information.")));
Dries's avatar
 
Dries committed
477 478 479 480
  }

  if ($type == "menu.misc") {
    if (user_access("access administration pages")) {
Dries's avatar
 
Dries committed
481
      $links[] = l(t("administer %a", array("%a" => variable_get("site_name", "drupal"))), "admin", array("title" => t("Access administration pages.")));
Dries's avatar
 
Dries committed
482 483
    }

Dries's avatar
 
Dries committed
484
    $links[] = l(t("logout"), "user/logout", array("title" => t("Logout.")));
Dries's avatar
 
Dries committed
485 486 487
  }

  if ($type == "admin" && user_access("administer users")) {
Dries's avatar
 
Dries committed
488 489 490 491 492 493 494 495 496
    menu("admin/user", "user management", "user_admin", user_help("admin/user"), 2);
    menu("admin/user/create", "create new account", "user_admin", user_help("admin/user/create"), 1);
    menu("admin/user/account", "view user accounts", "user_admin", user_help("admin/user/account"), 2);
    menu("admin/user/access", "access rules", NULL, user_help("admin/user/access"), 3);
    menu("admin/user/access/mail", "e-mail rules", "user_admin", user_help("admin/user/access/mail"));
    menu("admin/user/access/user", "username rules", "user_admin", user_help("admin/user/access/user"));
    menu("admin/user/role", "user roles", "user_admin", user_help("admin/user/role"), 4);
    menu("admin/user/permission", "user permissions", "user_admin", user_help("admin/user/permission"), 5);
    menu("admin/user/search", "search accounts", "user_admin", user_help("admin/user/search"), 8);
Dries's avatar
 
Dries committed
497 498
    menu("admin/user/help", "help", "user_help", NULL, 9);
    menu("admin/user/edit", "edit user account", "user_admin", NULL, 0, 1); // hidden menu
Dries's avatar
 
Dries committed
499 500 501
    menu("admin/user/account/0", "active users", "user_admin", user_help("admin/user/account/0"), 1);
    menu("admin/user/account/1", "new users", "user_admin", user_help("admin/user/account/1"), 2);
    menu("admin/user/account/2", "blocked users", "user_admin", user_help("admin/user/account/2"), 3);
Dries's avatar
 
Dries committed
502 503 504

    $i = 3;
    foreach (user_roles(1) as $key => $value) {
Dries's avatar
 
Dries committed
505
      menu("admin/user/account/". $i++, "users with role '$value'", "user_admin", NULL, 4);
Dries's avatar
 
Dries committed
506
    }
Dries's avatar
 
Dries committed
507 508
  }

Dries's avatar
 
Dries committed
509
  return $links;
Dries's avatar
 
Dries committed
510 511 512 513
}

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

514
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
515 516

  /*
517
  **  Called by authentication modules in order to edit/view their authmap information.
Dries's avatar
 
Dries committed
518 519
  */

Dries's avatar
 
Dries committed
520
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
521 522 523
  return db_result($result);
}

Dries's avatar
 
Dries committed
524

525 526 527 528 529 530 531
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
532
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
  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
548
      $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
549
      if (db_result($result) == 0) {
Dries's avatar
 
Dries committed
550
        $result = db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
Dries's avatar
 
Dries committed
551 552
      }
      else {
Dries's avatar
 
Dries committed
553
        $result = db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
554 555 556
      }
    }
    else {
Dries's avatar
 
Dries committed
557
      $result = db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
558 559 560 561 562 563
    }
  }
  return $result;
}

function user_auth_help_links() {
564
  $links = array();
Dries's avatar
 
Dries committed
565 566
  foreach (module_list() as $module) {
    if (module_hook($module, "auth_help")) {
Dries's avatar
 
Dries committed
567
      $links[] = l(module_invoke($module, "info", "name"), "user/help#$module");
Dries's avatar
 
Dries committed
568 569 570 571 572 573 574
    }
  }
  return $links;
}

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

Dries's avatar
 
Dries committed
575
function user_login($edit = array(), $msg = "") {
Dries's avatar
 
Dries committed
576
  global $user, $base_url;
Dries's avatar
 
Dries committed
577 578 579 580 581 582

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

  if ($user->uid) {
Dries's avatar
 
Dries committed
583
    drupal_goto(url("user"));
Dries's avatar
 
Dries committed
584 585 586
  }

  if (user_deny("user", $edit["name"])) {
Dries's avatar
 
Dries committed
587
    $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
588 589 590 591
  }
  else if ($edit["name"] && $edit["pass"]) {

    /*
Dries's avatar
 
Dries committed
592
    ** Try to log in the user locally:
Dries's avatar
 
Dries committed
593 594
    */

Dries's avatar
 
Dries committed
595
    if (!$user->uid) {
596 597
      $name = $edit["name"];
      $pass = $edit["pass"];
Dries's avatar
 
Dries committed
598 599 600 601 602 603 604 605
      $user = user_load(array("name" => $name, "pass" => $pass, "status" => 1));
    }

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

    if ($server = strrchr($edit["name"], "@")) {
606 607 608
      $name = substr($edit["name"], 0, strlen($edit["name"]) - strlen($server));
      $server = substr($server, 1);
      $pass = $edit["pass"];
Dries's avatar
 
Dries committed
609
    }
Dries's avatar
 
Dries committed
610

Dries's avatar
 
Dries committed
611 612 613 614
    /*
    ** When possible, determine corrosponding external auth source. Invoke source, and login user if successful:
    */

Dries's avatar
 
Dries committed
615
    if (!$user->uid && $server && $result = user_get_authmaps("$name@$server")) {
Dries's avatar
 
Dries committed
616 617
      if (module_invoke(key($result), "auth", $name, $pass, $server)) {
        $user = user_external_load("$name@$server");
Dries's avatar
 
Dries committed
618
        watchdog("user", "external load: $name@$server, module: ". key($result));
Dries's avatar
 
Dries committed
619 620
      }
      else {
Dries's avatar
 
Dries committed
621
        $error = t("Invalid password for %s.", array("%s" => "<i>$name@$server</i>"));
Dries's avatar
 
Dries committed
622 623 624 625 626 627 628
      }
    }

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

Dries's avatar
 
Dries committed
629
    else if (!$user->uid && $server) {
Dries's avatar
 
Dries committed
630 631 632 633
      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
634
              $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
635
              watchdog("user", "new user: $name@$server ($module ID)", l(t("edit user"), "admin/user/edit/$user->uid"));
Dries's avatar
 
Dries committed
636 637 638 639 640 641 642 643 644 645
              break;
            }
          }
        }
      }
    }

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

Dries's avatar
 
Dries committed
646 647
      // 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
648 649 650 651 652 653

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

Dries's avatar
 
Dries committed
654
      $path = preg_replace("/.+\/\/[^\/]+(.*)/", "\$1/", $base_url);
Dries's avatar
 
Dries committed
655
      if ($edit["remember_me"]) {
Dries's avatar
 
Dries committed
656
        setcookie(session_name(), session_id(), time() + 3600 * 24 * 365, $path);
Dries's avatar
 
Dries committed
657
      }
Dries's avatar
 
Dries committed
658
      else {
Dries's avatar
 
Dries committed
659
        setcookie(session_name(), session_id(), FALSE, $path);
Dries's avatar
 
Dries committed
660 661 662
      }

      /*
Dries's avatar
 
Dries committed
663
      ** Redirect the user to the page he logged on from.
Dries's avatar
 
Dries committed
664 665
      */

Dries's avatar
 
Dries committed
666
      drupal_goto($edit["destination"]);
Dries's avatar
 
Dries committed
667 668 669
    }
    else {
      if (!$error) {
Dries's avatar
 
Dries committed
670
        $error = t("Sorry.  Unrecognized username or password.") ." ". l(t("Have you forgotten your password?"), "user/password");
Dries's avatar
 
Dries committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
      }
      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) {
686
    $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
687 688
  }

Dries's avatar
 
Dries committed
689 690 691 692 693
  /*
  ** Save the referer.  We record where the user came from such that we
  ** can redirect him after having completed the login form.
  */

694
  if (empty($edit)) {
Dries's avatar
 
Dries committed
695
    $edit["destination"] = url($_GET["q"]);
Dries's avatar
 
Dries committed
696 697 698
  }
  $output .= form_hidden("destination", $edit["destination"]);

Dries's avatar
 
Dries committed
699 700 701 702
  /*
  ** Display login form:
  */

Dries's avatar
 
Dries committed
703 704 705
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
Dries's avatar
 
Dries committed
706
  if (count(user_auth_help_links()) > 0) {
Dries's avatar
 
Dries committed
707
    $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
708 709
  }
  else {
Dries's avatar
 
Dries committed
710
    $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
711
  }
Dries's avatar
 
Dries committed
712
  $output .= form_password(t("Password"), "pass", $pass, 30, 64, t("Enter the password that accompanies your username."));
713
  $output .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
 
Dries committed
714
  $output .= form_submit(t("Log in"));
Dries's avatar
 
Dries committed
715
  $items[] = l(t("Request new password"), "user/password");
716
  if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
717
    $items[] = l(t("Create new account"), "user/register");
718
  }
Dries's avatar
 
Dries committed
719
  $output .= theme("theme_item_list", $items);
Dries's avatar
 
Dries committed
720

Dries's avatar
 
Dries committed
721
  return form($output, "post", url("user"));
Dries's avatar
 
Dries committed
722 723
}

724
function _user_authenticated_id() {
Dries's avatar
 
Dries committed
725
  return db_result(db_query("SELECT rid FROM {role} WHERE name = 'authenticated user'"));
726 727
}

Dries's avatar
 
Dries committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
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
746
  drupal_goto(url());
Dries's avatar
 
Dries committed
747 748 749 750 751

}

function user_pass($edit = array()) {

Dries's avatar
 
Dries committed
752 753
  global $base_url;

Kjartan's avatar
Kjartan committed
754
  if ($edit["name"]) {
Dries's avatar
 
Dries committed
755
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM {users} WHERE name = '%s'", $edit["name"]));
Dries's avatar
 
Dries committed
756
    if (!$account) $error = t("Sorry. The username <i>%s</i> is not recognized.", array("%s" => $edit["name"]));
757
  }
Kjartan's avatar
Kjartan committed
758
  else if ($edit["mail"]) {
Dries's avatar
 
Dries committed
759
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM {users} WHERE mail = '%s'", $edit["mail"]));
Dries's avatar
 
Dries committed
760
    if (!$account) $error = t("Sorry. The e-mail address <i>%s</i> is not recognized.", array("%s" => $edit["mail"]));
Kjartan's avatar
Kjartan committed
761 762
  }
  if ($account) {
Dries's avatar
 
Dries committed
763

764
      $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
765 766 767 768 769 770 771 772 773 774 775 776
      $pass = user_password();

      /*
      ** Save new password:
      */

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

      /*
      ** Mail new password:
      */

Dries's avatar
 
Dries committed
777
      $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
778 779
      $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);
780
      $headers = "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from";
Dries's avatar
 
Dries committed
781
      $mail_success = user_mail($account->mail, $subject, $body, $headers);
Dries's avatar
 
Dries committed
782

Dries's avatar
 
Dries committed
783 784 785 786 787 788 789 790
      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
791 792
    }
    else {
793

Kjartan's avatar
Kjartan committed
794 795
    // Display error message if necessary.
    if ($error) {
796
      $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
797 798 799 800 801 802
    }

    /*
    ** Display form:
    */

Dries's avatar
 
Dries committed
803
    $output .= "<p>". sprintf(t("Enter your username %sor%s your e-mail address."), "<b><i>", "</i></b>") ."</p>";
Dries's avatar
 
Dries committed
804 805 806
    $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
807
    $items[] = l(t("Log in"), "user/login");
808
    if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
809
      $items[] = l(t("Create new account"), "user/register");
810
    }
Dries's avatar
 
Dries committed
811
    $output .= theme("theme_item_list", $items);
Dries's avatar
 
Dries committed
812

Dries's avatar
 
Dries committed
813
    return form($output, "post", url("user"));
Dries's avatar
 
Dries committed
814 815 816 817
  }
}

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

Dries's avatar
 
Dries committed
820
  $edit = $_POST["edit"];
821 822 823 824 825
  /*
  ** If we are already logged on, go to the user page instead.
  */

  if ($user->uid) {
Dries's avatar
 
Dries committed
826
    drupal_goto(url("user/edit"));
827
  }
Dries's avatar
 
Dries committed
828 829 830 831 832 833 834 835 836

  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
837
      $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
838 839
    }
    else if (user_deny("mail", $edit["mail"])) {
Dries's avatar
 
Dries committed
840
      $error = t("The e-mail address '%s' has been denied access.", array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
841
    }
Dries's avatar
 
Dries committed
842
    else if (db_num_rows(db_query("SELECT name FROM {users} WHERE LOWER(name) = LOWER('%s')", $edit["name"])) > 0) {
Dries's avatar
 
Dries committed
843
      $error = t("The name '%s' is already taken.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
844
    }
Dries's avatar
 
Dries committed
845
    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
846
      $error = t("The e-mail address '%s' is already taken.", array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
847
    }
Dries's avatar
 
Dries committed
848
    else if (variable_get("user_register", 1) == 0) {
Dries's avatar
 
Dries committed
849 850 851
      $error = t("Public registrations have been disabled by the site administrator.");
    }
    else {
Dries's avatar
 
Dries committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
      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
867 868 869 870 871
    }
  }

  if ($success) {

872
    $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
873 874
    $pass = user_password();

875
    // create new user account, noting whether administrator approval is required
876 877 878
    user_role_init();
    // TODO: is this necessary? Won't session_write replicate this?
    unset($edit["session"]);
879
    $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
880
    watchdog("user", "new user: '". $edit["name"] ."' &lt;". $edit["mail"] ."&gt;", l(t("edit user"), "admin/user/edit/$account->uid"));
Dries's avatar
 
Dries committed
881

Dries's avatar
 
Dries committed
882
    $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()));
883

Dries's avatar
 
Dries committed
884
    //the first user may login immediately, and receives a customized welcome e-mail.
885
    if ($account->uid == 1) {
Dries's avatar
 
Dries committed
886
      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");
887
      // 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
888
      $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
889
      $output .= form_hidden("destination", url("user/edit"));
890
      $output .= form_hidden("name", $account->name);
891 892 893 894 895
      $output .= form_hidden("pass", $pass);
      $output .= form_submit(t("Log in"));
      return form($output);
    }
    else {
896 897 898 899 900
      if ($account->status) {
        /*
        ** Create new user account, no administrator approval required:
        */

Dries's avatar
 
Dries committed
901 902
        $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);
903 904 905 906 907 908 909
        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
910 911
        $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);
912
        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
913
        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
914
        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.");
915
      }
916
    }
Dries's avatar
 
Dries committed
917 918 919
  }
  else {
    if ($error) {
920
      $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
921
    }
922
  }
Dries's avatar
 
Dries committed
923

924
  // display the registration form