user.module 85.4 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
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
376 377 378 379
        if ($user->uid) {
          $block["subject"] = $user->name;
        }
        else {
Dries's avatar
 
Dries committed
380 381 382 383 384 385 386 387 388
          /*
          ** 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
389 390
          $output = "<div class=\"user-login-block\">\n";

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

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

Dries's avatar
 
Dries committed
402 403 404
          $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
405 406

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

Dries's avatar
 
Dries committed
413 414 415 416 417
          $form .= form_submit(t("Log in"));

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

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

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

424
          $output .= theme("theme_item_list", $items);
425

Dries's avatar
 
Dries committed
426
          $block["subject"] = t("User login");
Dries's avatar
 
Dries committed
427
          $block["content"] = "<div class=\"user-login-link\">$output</div>";
Dries's avatar
 
Dries committed
428
        }
429

Dries's avatar
Dries committed
430 431 432
        menu_build("system");
        $block["content"] .= "<div id=\"menu\">". menu_tree()."</div>";
        return $block;
Dries's avatar
 
Dries committed
433 434
        break;
      case 2:
435 436 437 438 439
        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
440

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

443 444 445 446
          $block["subject"] = t("Who's new");
          $block["content"] = $output;
          return $block;
        }
Dries's avatar
 
Dries committed
447 448
    }
  }
449 450
}

Dries's avatar
 
Dries committed
451
function theme_user_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
452 453 454
  return theme("theme_item_list",$items, $title);
}

Dries's avatar
 
Dries committed
455
function theme_menu_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
456 457 458
  return theme("theme_item_list",$items, $title);
}

Dries's avatar
 
Dries committed
459
function user_link($type) {
Dries's avatar
 
Dries committed
460 461 462

  $links = array();

Dries's avatar
 
Dries committed
463
  if ($type == "page") {
Dries's avatar
 
Dries committed
464
    $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
465 466
  }

Dries's avatar
 
Dries committed
467
  if ($type == "system") {
Dries's avatar
Dries committed
468 469 470 471 472
    global $user;
    if ($user->uid) {
      menu("user/edit", t("edit account"), NULL, NULL, 8);
      menu("user/logout", t("logout"), NULL, NULL, 10);
    }
Dries's avatar
 
Dries committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
    if (user_access("administer users")) {
      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);
      menu("admin/user/help", "help", "user_help", NULL, 9);
      menu("admin/user/edit", "edit user account", "user_admin", NULL, 0, 1); // hidden menu
      menu("admin/user/account/1", "blocked users", "user_admin", user_help("admin/user/account/1"), 3);

      $i = 2;
      foreach (user_roles(1) as $key => $value) {
        menu("admin/user/account/". $i++, "users with role '$value'", "user_admin", NULL, 4);
      }
Dries's avatar
 
Dries committed
491
    }
Dries's avatar
 
Dries committed
492 493
  }

Dries's avatar
 
Dries committed
494
  return $links;
Dries's avatar
 
Dries committed
495 496 497 498
}

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

499
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
500 501

  /*
502
  **  Called by authentication modules in order to edit/view their authmap information.
Dries's avatar
 
Dries committed
503 504
  */

Dries's avatar
 
Dries committed
505
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
506 507 508
  return db_result($result);
}

Dries's avatar
 
Dries committed
509

510 511 512 513 514 515 516
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
517
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
  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
533
      $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
534
      if (db_result($result) == 0) {
Dries's avatar
 
Dries committed
535
        $result = db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
Dries's avatar
 
Dries committed
536 537
      }
      else {
Dries's avatar
 
Dries committed
538
        $result = db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
539 540 541
      }
    }
    else {
Dries's avatar
 
Dries committed
542
      $result = db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module["1"]);
Dries's avatar
 
Dries committed
543 544 545 546 547 548
    }
  }
  return $result;
}

function user_auth_help_links() {
549
  $links = array();
Dries's avatar
 
Dries committed
550 551
  foreach (module_list() as $module) {
    if (module_hook($module, "auth_help")) {
Dries's avatar
 
Dries committed
552
      $links[] = l(module_invoke($module, "info", "name"), "user/help#$module");
Dries's avatar
 
Dries committed
553 554 555 556 557 558 559
    }
  }
  return $links;
}

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

Dries's avatar
 
Dries committed
560
function user_login($edit = array(), $msg = "") {
Dries's avatar
 
Dries committed
561
  global $user, $base_url;
Dries's avatar
 
Dries committed
562 563 564 565 566 567

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

  if ($user->uid) {
Dries's avatar
 
Dries committed
568
    drupal_goto(url("user"));
Dries's avatar
 
Dries committed
569 570 571
  }

  if (user_deny("user", $edit["name"])) {
Dries's avatar
 
Dries committed
572
    $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
573 574 575 576
  }
  else if ($edit["name"] && $edit["pass"]) {

    /*
Dries's avatar
 
Dries committed
577
    ** Try to log in the user locally:
Dries's avatar
 
Dries committed
578 579
    */

Dries's avatar
 
Dries committed
580
    if (!$user->uid) {
581 582
      $name = $edit["name"];
      $pass = $edit["pass"];
Dries's avatar
 
Dries committed
583 584 585 586 587 588 589 590
      $user = user_load(array("name" => $name, "pass" => $pass, "status" => 1));
    }

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

    if ($server = strrchr($edit["name"], "@")) {
591 592 593
      $name = substr($edit["name"], 0, strlen($edit["name"]) - strlen($server));
      $server = substr($server, 1);
      $pass = $edit["pass"];
Dries's avatar
 
Dries committed
594
    }
Dries's avatar
 
Dries committed
595

Dries's avatar
 
Dries committed
596 597 598 599
    /*
    ** When possible, determine corrosponding external auth source. Invoke source, and login user if successful:
    */

Dries's avatar
 
Dries committed
600
    if (!$user->uid && $server && $result = user_get_authmaps("$name@$server")) {
Dries's avatar
 
Dries committed
601 602
      if (module_invoke(key($result), "auth", $name, $pass, $server)) {
        $user = user_external_load("$name@$server");
Dries's avatar
 
Dries committed
603
        watchdog("user", "external load: $name@$server, module: ". key($result));
Dries's avatar
 
Dries committed
604 605
      }
      else {
Dries's avatar
 
Dries committed
606
        $error = t("Invalid password for %s.", array("%s" => "<i>$name@$server</i>"));
Dries's avatar
 
Dries committed
607 608 609 610 611 612 613
      }
    }

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

Dries's avatar
 
Dries committed
614
    else if (!$user->uid && $server) {
Dries's avatar
 
Dries committed
615 616 617 618
      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
619
              $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
620
              watchdog("user", "new user: $name@$server ($module ID)", l(t("edit user"), "admin/user/edit/$user->uid"));
Dries's avatar
 
Dries committed
621 622 623 624 625 626 627 628 629 630
              break;
            }
          }
        }
      }
    }

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

Dries's avatar
 
Dries committed
631 632
      // 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
633 634 635 636 637 638

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

Dries's avatar
 
Dries committed
639
      $path = preg_replace("/.+\/\/[^\/]+(.*)/", "\$1/", $base_url);
Dries's avatar
 
Dries committed
640
      if ($edit["remember_me"]) {
Dries's avatar
 
Dries committed
641
        setcookie(session_name(), session_id(), time() + 3600 * 24 * 365, $path);
Dries's avatar
 
Dries committed
642
      }
Dries's avatar
 
Dries committed
643
      else {
Dries's avatar
 
Dries committed
644
        setcookie(session_name(), session_id(), FALSE, $path);
Dries's avatar
 
Dries committed
645 646 647
      }

      /*
Dries's avatar
 
Dries committed
648
      ** Redirect the user to the page he logged on from.
Dries's avatar
 
Dries committed
649 650
      */

Dries's avatar
 
Dries committed
651
      drupal_goto($edit["destination"]);
Dries's avatar
 
Dries committed
652 653 654
    }
    else {
      if (!$error) {
Dries's avatar
 
Dries committed
655
        $error = t("Sorry.  Unrecognized username or password.") ." ". l(t("Have you forgotten your password?"), "user/password");
Dries's avatar
 
Dries committed
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
      }
      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) {
671
    $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
672 673
  }

Dries's avatar
 
Dries committed
674 675 676 677 678
  /*
  ** Save the referer.  We record where the user came from such that we
  ** can redirect him after having completed the login form.
  */

679
  if (empty($edit)) {
Dries's avatar
 
Dries committed
680
    $edit["destination"] = url($_GET["q"]);
Dries's avatar
 
Dries committed
681 682 683
  }
  $output .= form_hidden("destination", $edit["destination"]);

Dries's avatar
 
Dries committed
684 685 686 687
  /*
  ** Display login form:
  */

Dries's avatar
 
Dries committed
688 689 690
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
Dries's avatar
 
Dries committed
691
  if (count(user_auth_help_links()) > 0) {
Dries's avatar
 
Dries committed
692
    $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
693 694
  }
  else {
Dries's avatar
 
Dries committed
695
    $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
696
  }
Dries's avatar
 
Dries committed
697
  $output .= form_password(t("Password"), "pass", $pass, 30, 64, t("Enter the password that accompanies your username."));
698
  $output .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
 
Dries committed
699
  $output .= form_submit(t("Log in"));
Dries's avatar
 
Dries committed
700
  $items[] = l(t("Request new password"), "user/password");
701
  if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
702
    $items[] = l(t("Create new account"), "user/register");
703
  }
Dries's avatar
 
Dries committed
704
  $output .= theme("theme_item_list", $items);
Dries's avatar
 
Dries committed
705

Dries's avatar
 
Dries committed
706
  return form($output, "post", url("user"));
Dries's avatar
 
Dries committed
707 708
}

709
function _user_authenticated_id() {
Dries's avatar
 
Dries committed
710
  return db_result(db_query("SELECT rid FROM {role} WHERE name = 'authenticated user'"));
711 712
}

Dries's avatar
 
Dries committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
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
731
  drupal_goto(url());
Dries's avatar
 
Dries committed
732 733 734 735 736

}

function user_pass($edit = array()) {

Dries's avatar
 
Dries committed
737 738
  global $base_url;

Kjartan's avatar
Kjartan committed
739
  if ($edit["name"]) {
Dries's avatar
 
Dries committed
740
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM {users} WHERE name = '%s'", $edit["name"]));
Dries's avatar
 
Dries committed
741
    if (!$account) $error = t("Sorry. The username <i>%s</i> is not recognized.", array("%s" => $edit["name"]));
742
  }
Kjartan's avatar
Kjartan committed
743
  else if ($edit["mail"]) {
Dries's avatar
 
Dries committed
744
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM {users} WHERE mail = '%s'", $edit["mail"]));
Dries's avatar
 
Dries committed
745
    if (!$account) $error = t("Sorry. The e-mail address <i>%s</i> is not recognized.", array("%s" => $edit["mail"]));
Kjartan's avatar
Kjartan committed
746 747
  }
  if ($account) {
Dries's avatar
 
Dries committed
748

749
      $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
750 751 752 753 754 755 756 757 758 759 760 761
      $pass = user_password();

      /*
      ** Save new password:
      */

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

      /*
      ** Mail new password:
      */

Dries's avatar
 
Dries committed
762
      $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
763 764
      $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);
765
      $headers = "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from";
Dries's avatar
 
Dries committed
766
      $mail_success = user_mail($account->mail, $subject, $body, $headers);
Dries's avatar
 
Dries committed
767

Dries's avatar
 
Dries committed
768 769 770 771 772 773 774 775
      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
776 777
    }
    else {
778

Kjartan's avatar
Kjartan committed
779 780
    // Display error message if necessary.
    if ($error) {
781
      $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
782 783 784 785 786 787
    }

    /*
    ** Display form:
    */

Dries's avatar
 
Dries committed
788
    $output .= "<p>". sprintf(t("Enter your username %sor%s your e-mail address."), "<b><i>", "</i></b>") ."</p>";
Dries's avatar
 
Dries committed
789 790 791
    $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
792
    $items[] = l(t("Log in"), "user/login");
793
    if (variable_get("user_register", 1)) {
Dries's avatar
 
Dries committed
794
      $items[] = l(t("Create new account"), "user/register");
795
    }
Dries's avatar
 
Dries committed
796
    $output .= theme("theme_item_list", $items);
Dries's avatar
 
Dries committed
797

Dries's avatar
 
Dries committed
798
    return form($output, "post", url("user"));
Dries's avatar
 
Dries committed
799 800 801 802
  }
}

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

Dries's avatar
 
Dries committed
805
  $edit = $_POST["edit"];
806 807 808 809 810
  /*
  ** If we are already logged on, go to the user page instead.
  */

  if ($user->uid) {
Dries's avatar
 
Dries committed
811
    drupal_goto(url("user/edit"));
812
  }
Dries's avatar
 
Dries committed
813 814 815 816 817 818 819 820 821

  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
822
      $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
823 824
    }
    else if (user_deny("mail", $edit["mail"])) {
Dries's avatar
 
Dries committed
825
      $error = t("The e-mail address '%s' has been denied access.", array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
826
    }
Dries's avatar
 
Dries committed
827
    else if (db_num_rows(db_query("SELECT name FROM {users} WHERE LOWER(name) = LOWER('%s')", $edit["name"])) > 0) {
Dries's avatar
 
Dries committed
828
      $error = t("The name '%s' is already taken.", array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
829
    }
Dries's avatar
 
Dries committed
830
    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
831
      $error = t("The e-mail address '%s' is already taken.", array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
832
    }
Dries's avatar
 
Dries committed
833
    else if (variable_get("user_register", 1) == 0) {
Dries's avatar
 
Dries committed
834 835 836
      $error = t("Public registrations have been disabled by the site administrator.");
    }
    else {
Dries's avatar
 
Dries committed
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
      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
852 853 854 855 856
    }
  }

  if ($success) {

857
    $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
858 859
    $pass = user_password();

860
    // create new user account, noting whether administrator approval is required
861 862 863
    user_role_init();
    // TODO: is this necessary? Won't session_write replicate this?
    unset($edit["session"]);
864
    $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
865
    watchdog("user", "new user: '". $edit["name"] ."' &lt;". $edit["mail"] ."&gt;", l(t("edit user"), "admin/user/edit/$account->uid"));
Dries's avatar
 
Dries committed
866

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

Dries's avatar
 
Dries committed
869
    //the first user may login immediately, and receives a customized welcome e-mail.
870
    if ($account->uid == 1) {
Dries's avatar
 
Dries committed
871
      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");
872
      // 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
873
      $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
874
      $output .= form_hidden("destination", url("user/edit"));
875
      $output .= form_hidden("name", $account->name);
876 877 878 879 880
      $output .= form_hidden("pass", $pass);
      $output .= form_submit(t("Log in"));
      return form($output);
    }
    else {
881 882 883 884 885
      if ($account->status) {
        /*
        ** Create new user account, no administrator approval required:
        */

Dries's avatar
 
Dries committed
886 887
        $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);
888 889 890 891 892 893 894
        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
895 896
        $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);
897
        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
898
        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
899
        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.");
900
      }
901
    }
Dries's avatar
 
Dries committed
902 903 904
  }
  else {
    if ($error) {
905
      $output .= theme("theme_error", $error);
Dries's avatar
 
Dries committed
906
    }
907
  }
Dries's avatar
 
Dries committed
908

909
  // display the registration form
910
  $output .= variable_get("user_registration_help", "");
911
  $affiliates = user_auth_help_links();
Dries's avatar
 
Dries committed
912
  if (count($affiliates) > 0) {
913
    $affiliates = implode(", ", $affiliates);
Dries's avatar
 
Dries committed
914
    $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>";
915
  }
Dries's avatar
 
Dries committed
916
  $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."));
917 918 919 920
  $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
921
    }
Dries's avatar
 
Dries committed
922
  }
923
  $output .= form_submit(t("Create new account"));