user.module 55.4 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
<?php
// $Id$

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

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

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

function sess_close() {
  return 1;
}

function sess_read($key) {
  global $user;
  $user = user_load(array("sid" => $key, "status" => 1));

  return $user->session ? $user->session : '';
}

function sess_write($key, $value) {
  global $HTTP_SERVER_VARS;

  db_query("UPDATE users SET hostname = '". check_input($HTTP_SERVER_VARS[REMOTE_ADDR]) ."', session = '". check_query($value) ."', timestamp = '". time() ."' WHERE sid = '$key'");
Dries's avatar
 
Dries committed
28

Dries's avatar
 
Dries committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  return '';
}

function sess_destroy($key) {
  global $HTTP_SERVER_VARS;

  db_query("UPDATE users SET hostname = '". check_input($HTTP_SERVER_VARS[REMOTE_ADDR]) ."', timestamp = '". time() ."', sid = '' WHERE sid = '$key'");
}

function sess_gc($lifetime) {
  return 1;
}

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

function user_external_load($authname) {
  $arr_uid = db_query("SELECT uid FROM authmap WHERE authname = '$authname'");

  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:
  */

  foreach ($array as $key => $value) {
    if ($key == "pass") {
      $query .= "u.$key = '" . md5($value) . "' AND ";
     }
    else {
      $query .= "u.$key = '". addslashes($value) ."' AND ";
    }
  }
  $result = db_query("SELECT u.*, r.perm FROM users u LEFT JOIN role r ON u.role = r.name WHERE $query u.status < 3 LIMIT 1");

  $user = db_fetch_object($result);
Dries's avatar
 
Dries committed
73 74 75 76 77 78 79
  if ($data = unserialize($user->data)) {
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
 
Dries committed
80 81 82 83 84 85 86 87 88 89 90 91

  return $user;

}

function user_save($account, $array = array()) {

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

  if ($account->uid) {
Dries's avatar
 
Dries committed
92
    $data = unserialize(db_result(db_query("SELECT data FROM users WHERE uid = '$account->uid'")));
Dries's avatar
 
Dries committed
93 94 95 96 97
    foreach ($array as $key => $value) {
      if ($key == "pass") {
        $query .= "$key = '". md5($value) ."', ";
      }
      else if (substr($key, 0, 4) !== "auth") {
Dries's avatar
 
Dries committed
98 99 100 101 102 103
        if (in_array($key, user_fields())) {
          $query .= "$key = '". check_query($value) ."', ";
        }
        else {
          $data[$key] = $value;
        }
Dries's avatar
 
Dries committed
104 105
      }
    }
Dries's avatar
 
Dries committed
106
    $query .= "data = '". check_query(serialize($data)) ."', ";
Dries's avatar
 
Dries committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120

    db_query("UPDATE users SET $query timestamp = '". time() ."' WHERE uid = '$account->uid'");

    $user = user_load(array("uid" => $account->uid));
  }
  else {
    $array["timestamp"] = time();

    foreach ($array as $key => $value) {
      if ($key == "pass") {
        $fields[] = check_query($key);
        $values[] = "'". md5($value) ."'";
      }
      else if (substr($key, 0, 4) !== "auth") {
Dries's avatar
 
Dries committed
121 122 123 124 125 126 127
        if (in_array($key, user_fields())) {
          $fields[] = check_query($key);
          $values[] = "'". check_query($value) ."'";
        }
        else {
          $data[$key] = $value;
        }
Dries's avatar
 
Dries committed
128 129 130
      }
    }

Dries's avatar
 
Dries committed
131 132 133
    $fields[] = "data";
    $values[] = "'". serialize($data) ."'";

Dries's avatar
 
Dries committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    db_query("INSERT INTO users (". implode(", ", $fields) .") VALUES (". implode(", ", $values) .")");

    $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:
  */

  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.");
  // if (ereg("[^a-zA-Z0-9@-@]", $name)) return t("The Username contains an illegal character.");
  if (!ereg('^[a-z0-9]+(@[a-z0-9]+)?$', $name)) t("The name contains an illegal character.");
  if (strlen($name) > 56) return t("The Username '$name' is too long: it must be less than 56 characters.");
}

function user_validate_mail($mail) {

  /*
  ** Verify the syntax of the given e-mail address.  Empty e-mail addresses
  ** allowed.
  */

  if ($mail && !eregi("^[_+\.0-9a-z-]+@([0-9a-z][0-9a-z-]+\.)+[a-z]{2,3}$", $mail)) {
    return t("The e-mail address '$mail' is not valid.");
  }
}

function user_validate_authmaps($account, $edit) {
  foreach (module_list() as $module) {
    if (module_hook($module, "auth")) {
      $result = db_query("SELECT COUNT(*) from authmap WHERE uid != '$account->uid' && authname = '". $edit["authname_$module"] . "'");
      if (db_result($result) > 0) {
        $info = module_invoke($module, "info");
        return sprintf(t("The %s ID %s is already taken."), ucfirst($info["name"]), "<i>". $edit["authname_$module"] ."</i>");
      }
    }
  }
}

function user_password($min_length = 6) {

  /*
  ** Generate a human-readable password:
  */

  mt_srand((double)microtime() * 1000000);
  $words = explode(",", variable_get("user_password", "foo,bar,guy,neo,tux,moo,sun,asm,dot,god,axe,geek,nerd,fish,hack,star,mice,warp,moon,hero,cola,girl,fish,java,perl,boss,dark,sith,jedi,drop,mojo"));
  while (strlen($password) < $min_length) $password .= trim($words[mt_rand(0, count($words))]);
  return $password;
}

function user_access($string) {

  global $user;
  static $perm;

  /*
  ** To reduce the number of SQL queries, we cache the user's permissions
  ** in a static variable.
  */

  if (!$perm) {
    if ($user->uid) {
      $perm = db_result(db_query("SELECT perm FROM role WHERE name = '$user->role'"), 0);
    }
    else {
      $perm = db_result(db_query("SELECT perm FROM role WHERE name = 'anonymous user'"), 0);
    }
  }

  if ($user->uid == 1) {
    return 1;
  }
  else {
    return strstr($perm, $string);
  }

}

function user_mail($mail, $subject, $message, $header) {
Dries's avatar
 
Dries committed
241
  // print "<pre>subject: $subject<hr />header: $header<hr />$message</pre>";
Dries's avatar
 
Dries committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
  if (variable_get("smtp_library", "") && file_exists(variable_get("smtp_library", ""))) {
    include_once variable_get("smtp_library", "");
    user_mail_wrapper($mail, $subject, $message, $header);
  }
  else {
    mail($mail, $subject, $message, $header);
  }
}

function user_deny($type, $mask) {

  $allow = db_fetch_object(db_query("SELECT * FROM access WHERE status = '1' AND type = '$type' AND LOWER('$mask') LIKE LOWER(mask)"));

  $deny = db_fetch_object(db_query("SELECT * FROM access WHERE status = '0' AND type = '$type' AND LOWER('$mask') LIKE LOWER(mask)"));

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

}

Dries's avatar
 
Dries committed
266 267 268 269 270 271 272 273 274 275 276 277
function user_fields() {
  static $fields;
  if (!$fields) {
    // is this ANSI? perhaps this should go in the database include...
    $result = db_query("SHOW FIELDS FROM users");
    while ($data = db_fetch_object($result)) {
      $fields[] = $data->Field;
    }
  }
  return $fields;
}

Dries's avatar
 
Dries committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
/*** Module hooks **********************************************************/

function user_help() {
 ?>
  <style type="text/css">
<!--
p {  padding-left: 24px}
-->
</style>
<h3>Introduction</h3>
<p>Drupal offers a powerful and open user system. This system allows users to
  register, login, logout, maintain user profiles, etc. No participant can use
  his own name to post comments until he signs up and submits his e-mail address.
  Those who do not register may participate as anonymous users, but they will
  suffer numerous disadvantages, for example their posts beginning at a lower
  score. </p>
<p>In contrast, those with a user account can use their own name or handle and
  are granted various privileges: the most important are probably the ability
  to moderate new submissions, to rate comments, and to fine-tune the site to
  their personal liking.  Drupal themes make fine tuning quite a pleasure.</p>
<p>Registered users need to authenticate by supplying a username and password.
  Users may authenticate locally or via an external authentication source like
  <a href="http://www.jabber.org/">Jabber</a>, <a href="http://www.delphiforums.com/">Delphi</a>,
  and other <a href="http://www.drupal.org/">Drupal</a> web sites. See <a href="#da">Distributed
  Authentication</a> for more information on this innovative feature. The username
  and password are kept in your database, where the password is hashed so that
  no one can read nor use it. When a username and password needs to be checked
  the system goes down the list of registered users until it finds a matching
  username, and then hashes the password that was supplied and compares it to
  the listed value. If the hashes match, the username and password are correct.
  Once a user authenticated session is started, and until that session is over,
  the user won't have to re-authenticate. To keep track of the individual sessions,
  Drupal relies on <a href="http://www.php.net/manual/en/ref.session.php">PHP's
  session support</a>. A visitor accessing your web site is assigned an unique
  ID, the so-called session ID, which is stored in a cookie. For security's sake,
  the cookie does not contain personal information but acts as a key to retrieve
  the information stored on your server's side. When a visitor accesses your site,
  Drupal will check whether a specific session ID has been sent with the request.
  If this is the case, the prior saved environment is recreated.</p>
<p>Authenticated users can select entirely different appearances for the site,
  utilizing their own preferences for how the pages are structured, how navigation
  lists and other page components are presented and much more. <br />
</p>
<h3>User Administration</h3>
<p>Administrators manage user accounts by clicking on the <i>User Management</i> link in
  their Admin interface. There, you will find several configuration pages and
  reports which help you manage your users. The following pages are available:</p>

<h4>add new user</h4>
<p>If your site blocks is completely private, and doesn't allow registration for
  any old web user (see <a href="#settings">Settings</a> for this feature), then
  you'll need to add new users manually. This web page allows any administrator
  to register a new user.</p>
<h4>access rules<a name="access"></a></h4>
<p>Access rules enable administrators to filter out usernames and e-mail addresses
  which are not allowed in Drupal. An administrator creates a 'mask' against which
  each new registration is checked. Disallowed names and e-mail addresses are denied
  access to the site. Another handy use for this page is to disallow registration
  to your site from an untrusted external authentication server. Just add their
  server address to the username mask section and you've effectively blocked all
  logins from that server.</p>
<p>To do describe access rules you can use the following wild-card characters:</p>
  <ul>
   <li>&nbsp;% : matches any number of characters, including zero characters.</li>
   <li>&nbsp;_ : matches exactly one character.</li>
  </ul>
<p><u>Examples:</u></p>
  <ul>
   <li>E-mail address bans <code>%@hotmail.com</code>, <code>%@altavista.%</code>, <code>%@usa.net</code>, etc.  Used to prevent users from using free e-mail accounts, which might be used to cause trouble.</li>
   <li>Username bans <code>root</code>, <code>webmaster</code>, <code>admin%</code>, etc.  Used to prevent administrator impersonators.</li>
  </ul>
<p>If no access rules are provided, access control is turned off and everybody will be able to access your website.  The 'allow' rules are processed prior to the 'deny' rules and are thus considered to be stronger.</p>
<h4>user accounts</h4>
<p>This page is quite powerful. It allows an administrator to review any user's
  profile. In addition, administrators may block any user, or assign him a <a href="#roles">role</a>,
  using this page.</p>
<h4>user roles<a name="roles"></a></h4>
<p>Roles allow you to fine tune the security and administration of drupal. A role
defines a group of users which have certain privileges. Examples of roles
include: <I>anonymous user</I>, <I>authenticated user</I>, <I>moderator</I>,
<I>administrator</I> and so on. By default, Drupal comes with two commonly used
roles:
<UL>
  <LI>Anonymous user: this role is used for users that don't have a user account
    or that are not authenticated.
  <LI>Registered user: this role is assigned automatically to authenticated users.
    Most users will belong to this user role unless specified otherwise.</LI>
</UL></p>
<p>These common roles will suffice for most sites. However, for a more complex site where you need to give several users different access privileges, you will
  need to add a new role by clicking the "add new role" link. Then define what privileges that role will have by clicking the "permission overview" link and   checking the appropriate boxes to give that role the permissions you desire.
  <p>To attach a specific user to a role, use the "account" section of the drupal Administration. </p>
  <p>Note: If you intend for a user to access certain sections of the administration
  pages, they must have "access administration page" privileges. </p>
<h4>user permissions<a name="permissions"></a></h4>
<p>Each role has certain things that its users are allowed to do, and some that
  are disallowed. For example, authenticated users may usually post a story but
  Anonymous users may not. </p>
<p>Each permission describes a fine-grained logical operation such as <br />
  <i>access administration pages</i> or <i>add and modify user
  accounts</i>. You <br /b>
  could say a permission represents access granted to a user to perform a set
  of <br />
  operations.</p>
<h4>search account</h4>
<p>Search Account enables an admin to query for any username in the user table
  and return users which match that query. For example, one may search for 'br'
  and Drupal might return 'brian', 'brad', and 'brenda'.</p>
<h4>settings<a name="settings"></a></h4>
<p>Administrators may choose to restrict registration to their site. That restriction
  may be accomplished on this page. Also, the list of words which may be included
  in a system geenrated password is also listed on this page. Drupal generates
  passwords by joining small words from the password list until the new password
  is greater than 6 characters.</p>
<h4>active users - report</h4>
<p>All users sorted by most recent login.</p>
<h4> new users - report</h4>
<p>All users sorted by most recent registration</p>
<h4> blocked users - report</h4>
<p>All users who have been blocked (status = 0) sorted by most recent registration</p>
<h4> special users - report</h4>
<p>All users with a <a href="#roles">role</a> other than Authenticated User</p>
<h3>Distributed Authentication<a name="da"> </a></h3>
<p>One of the more tedious moments in visiting a new web site is filling out the
  registration form. The reg form provides helpful information to the web site
  owner, but not much value for the user. The value for the end user is usually
  a the ability to post a messages or receive personalized news, etc. Distributed
  authentication (DA) gives the user what he wants without having to fill out
  the reg form. Removing this obstacle yields more registered and active users
  for the web site.</p>
<p>DA enables a new user to input a username and password into the login box and
  immediately be recognized, even if that user never registered on your site.
  This works because Drupal knows how to communicate with external registration
  databases. For example, lets say that your new user 'Joe' is already a registered
  member of Delphi Forums. If your Drupal has delphi.module installed, then Drupal
  will inform Joe on the registration and login screens that he may login with
  his Delphi ID instead of registering with your Drupal instance. Joe likes that
  idea, and logs in with a username of joe@remote.delphiforums.com and his usual
  Delphi password. Drupal then communicates with remote.delphiforums.com (usually using <a href="http://www.xmlrpc.com/">XML-RPC</a>,
  <a href="http://www.w3.org/Protocols/">HTTP POST</a>, or <a href="http://www.soapware.org/">SOAP</a>) behind
  the scenes and asks &quot;is this password for username=joe? If Delphi replies
  yes, then Drupal will create a new local account for joe and log joe into it.
  Joe may keep on logging into your Drupal instance in the same manner, and he
  will be logged into the same joe@remote.delphiforums.com account.</p>
<p>One key element of DA is the 'authmap' table, which maps a user's authname
  (e.g. joe@remote.delphiforums.com) to his local UID (i.e. universal identification
  number). This map is checked whenever a user successfully logs into an external
  authentication source. Once Drupal knows that the current user is definately
  joe@remote.delphiforums.com (because Delphi says so), he looks up Joe's UID
  and logs Joe into that account.</p>
<p>Drupal is setup so that it is very easy to add support for any external authentication
  source. See the <a href="http://www.drupal.org/">Drupal Handbook</a> for information
  on authoring authentication modules. You currently have the following authentication modules installed ...</p>
  <?
    foreach (module_list() as $module) {
      if (module_hook($module, "auth")) {
        print "<h4>" . module_invoke($module, "info", "name") . "</h4>";
        print module_invoke($module, "auth_help");
      }
    }
  ?>
<h3><br />
  User Preferences</h3>
<p>Coming soonish.</p>
 <?
}

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

function user_search($keys) {
  global $PHP_SELF;
  $result = db_query("SELECT * FROM users WHERE name LIKE '%$keys%' LIMIT 20");
  while ($account = db_fetch_object($result)) {
    $find[$i++] = array("title" => $account->name, "link" => (strstr($PHP_SELF, "admin.php") ? "admin.php?mod=user&op=edit&id=$account->uid" : "module.php?mod=user&op=view&id=$account->uid"), "user" => $account->name);
  }
  return $find;
}

function user_link($type) {
  if ($type == "page") {
Dries's avatar
 
Dries committed
459
    $links[] = "<a href=\"module.php?mod=user\" title=\"". t("Create a user account, request a new password or edit your account settings.") ."\">". t("user account") ."</a>";
Dries's avatar
 
Dries committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
  }

  if ($type == "menu") {
    $links[] = "<a href=\"module.php?mod=user&op=edit\" title=\"". t("View and edit your account information.") ."\">". t("account settings") ."</a>";
    $links[] = "<br /><a href=\"module.php?mod=user&op=logout\" title=\"". t("Logout.") ."\">". t("logout") ."</a>";
  }

  if ($type == "admin" && user_access("administer users")) {
    $links[] = "<a href=\"admin.php?mod=user\">user management</a>";
  }

  return $links ? $links : array();
}

function drupal_login($arguments) {
   // an XML-RPC method called by external clients (usually other Drupal instances)
  $argument = $arguments->getparam(0);
  $username = $argument->scalarval();
  $argument = $arguments->getparam(1);
  $password = $argument->scalarval();

  if ($user = user_load(array(name => "$username", "pass" => $password, "status" => 1))) {
    return new xmlrpcresp(new xmlrpcval($user->uid, "int"));
  }
  else {
    return new xmlrpcresp(new xmlrpcval(0, "int"));
  }
}


function user_xmlrpc() {
  return array("drupal.login" => array("function" => "drupal_login"));
}

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

function user_get_authmaps($account = NULL, $authname = NULL) {

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

  if (!$account) { //called at external login
    $result = db_query("SELECT authname, module FROM authmap WHERE authname = '$authname'");
  }
  else { //called from user_edit, user_view,, admin_user_edit
    $result = db_query("SELECT authname, module FROM authmap WHERE uid = '$account->uid'");
  }

  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) {
      $result = db_query("SELECT COUNT(*) from authmap WHERE uid = '$account->uid' && module = '$module[1]'");
      if (db_result($result) == 0) {
        $result = db_query("INSERT INTO authmap (authname, uid, module) VALUES ('" . check_query($value) . "', '" . check_query($account->uid) . "', '" . check_query($module[1]) . "')");
      }
      else {
        $result = db_query("UPDATE authmap SET authname = '$value' WHERE uid = '$account->uid' && module = '$module[1]'");
      }
    }
    else {
      $result = db_query("DELETE FROM authmap WHERE uid = '$account->uid' && module = '$module[1]'");
    }
  }
  return $result;
}

function user_help_da() {
  $site = variable_get("site_name", "this web site");

  $output = "
    <style type=\"text/css\">
    <!--
    p {  padding-left: 24px}
    -->
    </style>
    <br />
    <h3>Distributed Authentication<a name=\"da\"> </a></h3>
  <p>One of the more tedious moments in visiting a new web site is filling out the
    registration form. Here at %s, you do not have to fill out a registration form
    if you are already a member of ";
    $output .= implode(", ", user_auth_help_links());
    $output .= ".  This capability is called <i>Distributed
    Authentication</i>, and is unique to <a href=\"http://www.drupal.org\">Drupal</a>,
    the software which powers %s.</p>
  <p>Distributed Authentication enables a new user to input a username and password into the login box,
    and immediately be recognized, even if that user never registered at %s. This
    works because Drupal knows how to communicate with external registration databases.
    For example, lets say that new user 'Joe' is already a registered member of
    <a href=\"http://www.delphiforums.com\">Delphi Forums</a>. Drupal informs Joe
    on registration and login screens that he may login with his Delphi ID instead
    of registering with %s. Joe likes that idea, and logs in with a username
    of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts
    the <i>remote.delphiforums.com</i> server behind the scenes (usually using <a href=\"http://www.xmlrpc.com\">XML-RPC</a>,
    <a href=\"http://www.w3.org/Protocols/\">HTTP POST</a>, or <a href=\"http://www.soapware.org\">SOAP</a>)
    and asks: \"Is the password for user Joe correct?\".  If Delphi replies yes, then
    we create a new $site account for Joe and log him into it.  Joe may keep
    on logging into %s in the same manner, and he will always be logged into the
    same account.</p>";

  $output = sprintf(t($output), $site, $site, $site, $site, $site, $site);

  foreach (module_list() as $module) {
    if (module_hook($module, "auth")) {
      $output .= "<h4><A NAME=\"$module\"></A>" . module_invoke($module, "info", "name") . "</h4>";
      $output .= module_invoke($module, "auth_help");
    }
  }

  return $output;
}

function user_auth_help_links() {
  foreach (module_list() as $module) {
    if (module_hook($module, "auth_help")) {
      $links[] = "<a href=\"module.php?mod=user&op=help#$module\">". module_invoke($module, "info", "name") ."</a>";
    }
  }
  return $links;
}

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

function user_login($edit = array()) {
  global $user, $HTTP_REFERER;

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

  if ($user->uid) {
    drupal_goto("module.php?mod=user");
  }

  if (user_deny("user", $edit["name"])) {
    $error = sprintf(t("The name '%s' has been denied access."), $edit["name"]);
  }
  else if ($edit["name"] && $edit["pass"]) {

    /*
    ** Try to log on the user locally:
    */

    if (!$user) {
      $name = check_input($edit["name"]);
      $pass = check_input($edit["pass"]);
      $user = user_load(array("name" => $name, "pass" => $pass, "status" => 1));
    }

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

    if ($server = strrchr($edit["name"], "@")) {
      $name = check_input(substr($edit["name"], 0, strlen($edit["name"]) - strlen($server)));
      $server = check_input(substr($server, 1));
      $pass = check_input($edit["pass"]);
    }

    /*
    ** When possible, determine corrosponding external auth source. Invoke source, and login user if successful:
    */

    if (!$user && $server  && $result = user_get_authmaps("", "$name@$server")) {
      if (module_invoke(key($result), "auth", $name, $pass, $server)) {
        $user = user_external_load("$name@$server");
        watchdog("user", "external load: $name@$server, module: " . key($result));
      }
      else {
        $error = sprintf(t("Invalid password for %s."), "<i>$name@$server</i>");
      }
    }

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

    else if (!$user && $server) {
      foreach (module_list() as $module) {
        if (module_hook($module, "auth")) {
          if (module_invoke($module, "auth", $name, $pass, $server)) {
            if (variable_get("user_register", 1) == 1 && !user_load(array("name" => "$name@$server"))) { //register this new user
              watchdog("user", "new user: $name@$server ($module ID)");
              $user = user_save("", array("name" => "$name@$server", "pass" => user_password(), "init" => "$name@$server", "role" => "authenticated user", "status" => 1, "authname_$module" => "$name@$server"));
              break;
            }
          }
        }
      }
    }

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

      /*
      ** Write session ID to database:
      */

      user_save($user, array("sid" => session_id()));

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

      if ($edit["remember_me"]) {
        setcookie(session_name(), session_id(), time() + 3600 * 24 * 365);
Dries's avatar
 
Dries committed
680
      }
Dries's avatar
 
Dries committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
      else {
        setcookie(session_name(), session_id());
      }

      /*
      ** Redirect the user to the page he logged on from or to his personal
      ** information page if we can detect the referer page:
      */

      $url = $HTTP_REFERER ? $HTTP_REFERER : "module.php?mod=user&op=view";
      drupal_goto($url);
    }
    else {
      if (!$error) {
        $error = t("Authentication failed.");
      }
      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) {
    $output .= "<p><font color=\"red\">". check_output($error) ."</font></p>";
  }

  /*
  ** Display login form:
  */

  $output .= form_textfield(t("Username"), "name", $edit["name"], 20, 64, sprintf(t("Enter your %s username, or an ID from one of our affiliates: %s."), variable_get("site_name", "local"), implode(", ", user_auth_help_links())));
  $output .= form_password(t("Password"), "pass", $pass, 20, 64, t("Enter the password that accompanies your username."));
  $output .= form_submit(t("Log in"));

  return form($output);
}

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:
  */

  drupal_goto("index.php");

}

function user_pass($edit = array()) {

  if ($edit["name"] && $edit["mail"]) {
    if ($account = db_fetch_object(db_query("SELECT uid FROM users WHERE name = '". check_input($edit["name"]) ."' AND mail = '". check_input($edit["mail"]) ."'"))) {

      $from = variable_get("site_mail", "root@localhost");
      $pass = user_password();

      /*
      ** Save new password:
      */

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

      /*
      ** Mail new password:
      */

      user_mail($edit["mail"], t("user account details"), sprintf(t("%s,\n\nyou requested us to e-mail you a new password for your account at %s.  You can now login using the following username and password:\n\n  username: %s\n  password: %s\n\n\n-- %s team"), $edit["name"], variable_get("site_name", "drupal"), $edit["name"], $pass, variable_get("site_name", "drupal")), "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");

      watchdog("user", "mail password: '". $edit["name"] ."' &lt;". $edit["mail"] ."&gt;");

      return t("Your password and further instructions have been sent to your e-mail address.");
    }
    else {
      watchdog("user", "mail password: '". $edit["name"] ."' and &lt;". $edit["mail"] ."&gt; do not match");

      return t("Could not send password: no match for the specified username and e-mail address.");
    }
  }
  else {

    /*
    ** Display form:
    */

    $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"));

    return form($output);
  }
}

function user_register($edit = array()) {

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

  if ($success) {

    watchdog("user", "new user: '". $edit["name"] ."' &lt;". $edit["mail"] ."&gt;");

    $from = variable_get("site_mail", "root@localhost");
    $pass = user_password();

    if (variable_get("user_register", 1) == 1) {
      /*
      ** Create new user account, no administrator approval required:
      */

Dries's avatar
 
Dries committed
846
      user_save("", array_merge(array("name" => $edit["name"], "pass" => $pass, "init" => $edit["mail"], "mail" => $edit["mail"], "role" => "authenticated user", "status" => 1), $data));
Dries's avatar
 
Dries committed
847 848 849 850 851 852 853 854

      user_mail($edit["mail"], t("user account details"), sprintf(t("%s,\n\nsomoneone signed up for a user account on %s and supplied this e-mail address as their contact.  If it wasn't you, just ignore this mail but if it was you, you can now login using the following username and password:\n\n  username: %s\n  password: %s\n\n\n-- %s team"), $edit["name"], variable_get("site_name", "drupal"), $edit["name"], $pass, variable_get("site_name", "drupal")), "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
    }
    else {
      /*
      ** Create new user account, administrator approval required:
      */

Dries's avatar
 
Dries committed
855
      user_save("", array_merge(array("name" => $edit["name"], "pass" => $pass, "init" => $edit["mail"], "mail" => $edit["mail"], "role" => "authenticated user", "status" => 0), $data));
Dries's avatar
 
Dries committed
856 857 858 859 860 861 862 863 864 865 866 867 868 869

      user_mail($edit["mail"], t("user account details"), sprintf(t("%s,\n\nsomoneone signed up for a user account on %s and supplied this e-mail address as their contact.  If it wasn't you, just ignore this mail but if it was you, you can login as soon a site administrator approved your request using the following username and password:\n\n  username: %s\n  password: %s\n\n\n-- %s team"), $edit["name"], variable_get("site_name", "drupal"), $edit["name"], $pass, variable_get("site_name", "drupal")), "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 {

    if ($error) {
      $output .= "<p><font color=\"red\">". check_output($error) ."</font></p>";
    }

    $output .= form_textfield(t("Username"), "name", $edit["name"], 30, 64, t("Your full name or your prefered username: only letters, numbers and spaces are allowed."));
    $output .= form_textfield(t("E-mail address"), "mail", $edit["mail"], 30, 64, t("Your e-mail address: a password and instructions will be sent to this e-mail address so make sure it is accurate."));
Dries's avatar
 
Dries committed
870 871 872 873 874
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "register_form", $edit, $user);
      }
    }
Dries's avatar
 
Dries committed
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
    $output .= form_submit(t("Create new account"));

    return form($output);
  }
}

function user_edit($edit = array()) {
  global $HTTP_HOST, $themes, $user, $languages;

  if ($user->uid) {
    if ($edit["name"]) {
      if ($error = user_validate_name($edit["name"])) {
        // do nothing
      }
      else if ($error = user_validate_mail($edit["mail"])) {
        // do nothing
      }
      else if (db_num_rows(db_query("SELECT uid FROM users WHERE uid != '$user->uid' AND LOWER(name) = LOWER('". $edit["name"] ."')")) > 0) {
        $error = sprintf(t("The name '%s' is already taken."), $edit["name"]);
      }
      else if ($edit["mail"] && db_num_rows(db_query("SELECT uid FROM users WHERE uid != '$user->uid' AND LOWER(mail) = LOWER('". $edit["mail"] ."')")) > 0) {
        $error = sprintf(t("The e-mail address '%s' is already taken."), $edit["mail"]);
      }
      else if ($error = user_validate_authmaps($user, $edit)) {
        // do nothing
      }
      else if ($user->uid) {
Dries's avatar
 
Dries committed
902 903 904 905 906 907 908 909 910 911 912 913 914
        foreach (module_list() as $module) {
          if (module_hook($module, "user")) {
            $result = module_invoke($module, "user", "edit_validate", $edit, $user);
          }
          if (is_array($result)) {
            $data = array_merge($data, $result);
          }
          elseif (is_string($result)) {
            $error = $result;
            break;
          }
        }

Dries's avatar
 
Dries committed
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
        /*
        ** If required, check that proposed passwords match.  If so,
        ** add new password to $edit.
        */

        if ($edit["pass1"]) {
          if ($edit["pass1"] == $edit["pass2"]) {
            $edit["pass"] = $edit["pass1"];
          }
          else {
            $error = t("The specified passwords do not match.");
          }
        }

        unset($edit["pass1"], $edit["pass2"]);

Dries's avatar
 
Dries committed
931 932 933 934
        if (!$error) {
          /*
          ** Save user information:
          */
Dries's avatar
 
Dries committed
935

Dries's avatar
 
Dries committed
936
          $user = user_save($user, array_merge($edit, $data));
Dries's avatar
 
Dries committed
937

Dries's avatar
 
Dries committed
938 939 940
          /*
          ** Redirect the user to his personal information page:
          */
Dries's avatar
 
Dries committed
941

Dries's avatar
 
Dries committed
942 943
          drupal_goto("module.php?mod=user&op=view");
        }
Dries's avatar
 
Dries committed
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
      }
    }

    if ($error) {
      $output .= "<p><font color=\"red\">". check_output($error) ."</font></p>";
    }

    $output .= form_textfield(t("Username"), "name", $user->name, 30, 55, t("Your full name or your prefered username: only letters, numbers and spaces are allowed."));
    $output .= form_textfield(t("E-mail address"), "mail", $user->mail, 30, 55, t("Insert a valid e-mail address.  All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail."));

    $result = user_get_authmaps($user);
    foreach (module_list() as $module) {
      if ($module != "drupal" && module_hook($module, "auth")) {
        $output .= form_textfield(module_invoke($module, "info", "name") . " ID", "authname_" . $module, $result[$module], 30, 55, sprintf(t("You may login to %s using a valid %s."), variable_get("site_name", "this web site"), "<a href=\"module.php?mod=user&op=help#$module\">". module_invoke($module, "info", "name") ." ID</a>", ""));
      }
    }

Dries's avatar
 
Dries committed
961 962 963 964 965 966
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "edit_form", $edit, $user);
      }
    }

Dries's avatar
 
Dries committed
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
    $output .= form_textfield(t("Homepage"), "homepage", $user->homepage, 30, 55, t("Optional") .". ". t("Make sure you enter a fully qualified URL: remember to include \"http://\"."));
    foreach ($themes as $key => $value) $options .= "<option value=\"$key\"". (($user->theme == $key) ? " selected=\"selected\"" : "") .">$key - $value[1]</option>\n";
    $output .= form_item(t("Theme"), "<select name=\"edit[theme]\">$options</select>", t("Selecting a different theme will change the look and feel of the site."));
    for ($zone = -43200; $zone <= 46800; $zone += 3600) $zones[$zone] = date("l, F dS, Y - h:i A", time() - date("Z") + $zone) ." (GMT ". $zone / 3600 .")";
    $output .= form_select(t("Timezone"), "timezone", $user->timezone, $zones, t("Select what time you currently have and your timezone settings will be set appropriate."));
    $output .= form_select(t("Language"), "language", $user->language, $languages, t("Selecting a different language will change the language of the site."));
    $output .= form_textarea(t("Signature"), "signature", $user->signature, 70, 3, t("Your signature will be publicly displayed at the end of your comments.") ."<br />". t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", "")));
    $output .= form_item(t("Password"), "<input type=\"password\" name=\"edit[pass1]\" size=\"12\" maxlength=\"24\"> <input type=\"password\" name=\"edit[pass2]\" size=\"12\" maxlength=\"24\">", t("Enter your new password twice if you want to change your current password or leave it blank if you are happy with your current password."));
    $output .= form_submit(t("Save user information"));

    $output = form($output);
  }

  return $output;
}

function user_menu() {
  $links[] = "<a href=\"module.php?mod=user&op=view\">". t("view user information") ."</a>";
  $links[] = "<a href=\"module.php?mod=user&op=edit\">". t("edit user information") ."</a>";

  return "<div align=\"center\">". implode(" &middot; ", $links) ."</div>";
}

function user_view($uid = 0) {
  global $theme, $user, $HTTP_HOST;

  if (!$uid) {
    $uid = $user->uid;
  }

  if ($user->uid && $user->uid == $uid) {
    $output .= form_item(t("Name"), check_output("$user->name ($user->init)"));
    $output .= form_item(t("E-mail address"), check_output($user->mail));
    $result = user_get_authmaps($user);
    foreach (module_list() as $module) {
      if (module_hook($module, "auth")) {
        if ($module != "drupal") {
          $output .= "<a href=\"module.php?mod=user&op=help#$module\">". form_item(module_invoke($module, "info", "name") . " ID</a>", check_output($result[$module]));
        }
        else {
          $output .= "<a href=\"module.php?mod=user&op=help#$module\">". form_item(module_invoke($module, "info", "name") . " ID</a>", check_output($user->name) . "@$HTTP_HOST");
        }
      }
    }
Dries's avatar
 
Dries committed
1011 1012 1013 1014 1015 1016 1017

    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "view_private", "", $user);
      }
    }

Dries's avatar
 
Dries committed
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    $output .= form_item(t("Homepage"), format_url($user->homepage));
    $output .= form_item(t("Signature"), check_output($user->signature, 1));

    $theme->header();
    $theme->box(t("User account"), user_menu());
    $theme->box(t("View user information"), $output);
    $theme->footer();
  }
  else if ($uid && $account = user_load(array("uid" => $uid, "status" => 1))) {
    $output .= form_item(t("Name"), check_output($account->name));
    $output .= form_item(t("Homepage"), format_url($account->homepage));

Dries's avatar
 
Dries committed
1030 1031 1032 1033 1034 1035
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "view_public", "", $account);
      }
    }

Dries's avatar
 
Dries committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
    $theme->header();
    $theme->box(t("View user information"), $output);
    $theme->footer();
  }
  else {
    $theme->header();
    $theme->box(t("Log in"), user_login());
    $theme->box(t("Create new user account"), user_register());
    $theme->box(t("E-mail new password"), user_pass());
    $theme->footer();
  }
}

function user_page() {
  global $edit, $op, $id, $theme;

  switch ($op) {
    case t("E-mail new password");
    case "password":
      $theme->header();
      $theme->box(t("E-mail new password"), user_pass($edit));
      $theme->footer();
      break;
    case t("Create new account"):
    case "register":
      $theme->header();
      $theme->box(t("Create new account"), user_register($edit));
      $theme->footer();
      break;
    case t("Log in"):
    case "login":
      $output = user_login($edit);
      $theme->header();
      $theme->box(t("Log in"), $output);
      $theme->footer();
      break;
    case t("Save user information"):
    case "edit":
      $output = user_edit($edit);
      $theme->header();
      $theme->box(t("User account"), user_menu());
      $theme->box(t("Edit user information"), $output);
      $theme->footer();
      break;
    case "view":
      user_view($id);
      break;
    case t("Logout"):
    case "logout":
      print user_logout();
      break;
    case "help":
      $theme->header();
      $theme->box(t("Distributed Authentication"), user_help_da());
      $theme->footer();
      break;
    default:
      print user_view();
  }

}

/*** Administrative features ***********************************************/

function user_conf_options() {
  $output .= form_select("Public registrations", "user_register", variable_get("user_register", 1), array("Only site administrators can create new user accounts.", "Visitors can create accounts and no administrator approval is required.", "Visitors can create accounts but administrator approval is required."));
  $output .= form_textfield("Password words", "user_password", variable_get("user_password", "foo,bar,guy,neo,tux,moo,sun,asm,dot,god,axe,geek,nerd,fish,hack,star,mice,warp,moon,hero,cola,girl,fish,java,perl,boss,dark,sith,jedi,drop,mojo"), 55, 256, "A comma separated list of short words that can be concatenated to generate human-readable passwords.");
  return $output;
}

function user_admin_settings($edit = array()) {
  global $op;

  if ($op == "Save configuration") {
    /*
    ** Save the configuration options:
    */

    foreach ($edit as $name => $value) variable_set($name, $value);
  }

  if ($op == "Reset to defaults") {
    /*
    ** Reset the configuration options to their default value:
    */

    foreach ($edit as $name=>$value) variable_del($name);
  }

  $output .= user_conf_options();
  $output .= form_submit("Save configuration");
  $output .= form_submit("Reset to defaults");

  return form($output);

}

function user_admin_create($edit = array()) {

  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 (db_num_rows(db_query("SELECT name FROM users WHERE LOWER(name) = LOWER('". $edit["name"] ."')")) > 0) {
      $error = sprintf(t("The name '%s' is already taken."), $edit["name"]);
    }
    else if (db_num_rows(db_query("SELECT mail FROM users WHERE LOWER(mail) = LOWER('". $edit["mail"] ."')")) > 0) {
      $error = sprintf(t("The e-mail address '%s' is already taken."), $edit["mail"]);
    }
    else {
      $success = 1;
    }
  }

  if ($success) {

    watchdog("user", "new user: '". $edit["name"] ."' &lt;". $edit["mail"] ."&gt;");

    user_save("", array("name" => $edit["name"], "pass" => $edit["pass"], "init" => $edit["mail"], "mail" => $edit["mail"], "role" => "authenticated user", "status" => 1));

    return "Created a new user '". $edit["name"] ."'.  No e-mail has been sent.";
  }
  else {

    if ($error) {
      $output .= "<p><font color=\"red\">". check_output($error) ."</font></p>";
    }

    $output .= form_textfield("Username", "name", $edit["name"], 30, 55);
    $output .= form_textfield("E-mail address", "mail", $edit["mail"], 30, 55);
    $output .= form_textfield("Password", "pass", $edit["pass"], 30, 55);
    $output .= form_submit("Create account");

    return form($output);
  }
}

function user_admin_access($edit = array()) {
  global $op, $id, $type;

  $output .= "<small><a href=\"admin.php?mod=user&op=access&type=mail\">e-mail rules</a> :: <a href=\"admin.php?mod=user&op=access&type=user\">username rules</a></small><hr />";

  if ($type != "user") {
    $output .= "<h3>E-mail rules</h3>";
    $type = "mail";
  }
  else {
    $output .= "<h3>Username rules</h3>";
  }

  if ($op == "Add rule") {
    db_query("INSERT INTO access (mask, type, status) VALUES ('". check_input($edit["mask"]) ."', '". check_input($type) ."', '". check_input($edit["status"]) ."')");
  }
  else if ($op == "Check") {
    if (user_deny($type, $edit["test"])) {
      $message = "<b>'". $edit["test"] ."' is not allowed.</b><p />";
    }
    else {
      $message = "<b>'". $edit["test"] ."' is allowed.</b><p />";
    }
  }
  else if ($id) {
    db_query("DELETE FROM access WHERE aid = '$id'");
  }

  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
  $output .= " <tr><th>type</th><th>mask</th><th>operations</th></tr>";

  $result = db_query("SELECT * FROM access WHERE type = '". check_input($type) ."' AND status = '1' ORDER BY mask");

  while ($rule = db_fetch_object($result)) {
    $output .= "<tr><td align=\"center\">allow</td><td>". check_output($rule->mask) ."</td><td><a href=\"admin.php?mod=user&op=access&type=$type&id=$rule->aid\">delete rule</a></td></tr>";
  }

  $result = db_query("SELECT * FROM access WHERE type = '". check_input($type) ."' AND status = '0' ORDER BY mask");

  while ($rule = db_fetch_object($result)) {
    $output .= "<tr><td align=\"center\">deny</td><td>". check_output($rule->mask) ."</td><td><a href=\"admin.php?mod=user&op=access&type=$type&id=$rule->aid\">delete rule</a></td></tr>";
  }

  $output .= " <tr><td><select name=\"edit[status]\"><option value=\"1\">allow</option><option value=\"0\">deny</option></select></td><td><input size=\"32\" maxlength=\"64\" name=\"edit[mask]\" /></td><td><input type=\"submit\" name=\"op\" value=\"Add rule\" /></td></tr>";
  $output .= "</table>";
  $output .= "<p><small>%: matches any number of characters, even zero characters.<br />_: matches exactly one character.</small></p>";

  if ($type != "user") {
    $output .= "<h3>Check e-mail address</h3>";
  }
  else {
    $output .= "<h3>Check username</h3>";
  }

  $output .= "$message<input size=\"32\" maxlength=\"64\" name=\"edit[test]\" value=\"". $edit["test"] ."\" /><input type=\"submit\" name=\"op\" value=\"Check\" />";

  return form($output);

}

function user_roles() {
  $result = db_query("SELECT * FROM role ORDER BY name");
  while ($role = db_fetch_object($result)) {
    $roles[$role->name] = $role->name;
  }
  return $roles;
}

function user_admin_perm($edit = array()) {

  if ($edit) {

    /*
    ** Save permissions:
    */

    $result = db_query("SELECT * FROM role");
    while ($role = db_fetch_object($result)) {
      $perm = $edit[$role->name] ? implode(", ", array_keys($edit[$role->name])) : "";
      db_query("UPDATE role SET perm = '$perm' WHERE name = '$role->name'");
    }
  }

  /*
  ** Compile permission array:
  */

  foreach (module_list() as $name) {
    if (module_hook($name, "perm")) {
      $perms = array_merge($perms, module_invoke($name, "perm"));
    }
  }
  asort($perms);

  /*
  ** Compile role array:
  */

  $result = db_query("SELECT * FROM role ORDER BY name");
  $roles = array ();
  while ($role = db_fetch_object($result)) {
    $roles[$role->name] = $role->perm;
  }

  /*
  ** Render roles / permission overview:
  */

  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
  $output .= " <tr><th>&nbsp;</th><th>". implode("</th><th>", array_keys($roles)) ."</th></tr>";
  foreach ($perms as $perm) {
    $output .= " <tr>";
    $output .= "  <td>". check_output($perm) ."</td>";
    foreach ($roles as $name => $value) {
      $output .= "  <td align=\"center\"><input type=\"checkbox\" name=\"edit[$name][$perm]\"". (strstr($value, $perm) ? " checked=\"checked\"" : "") ."></td>";
    }
    $output .= " </tr>";
  }
  $output .= "</table>";
  $output .= form_submit("Save permissions");

  return form($output);

}

function user_admin_role($edit = array()) {
  global $op, $id;

  if ($op == "Save role") {
    db_query("UPDATE role SET name = '". $edit["name"] ."' WHERE rid = '$id'");
  }
  else if ($op == "Delete role") {
    db_query("DELETE FROM role WHERE rid = '$id'");
  }
  else if ($op == "Add role") {
    db_query("INSERT INTO role (name) VALUES ('". $edit["name"] ."')");
  }
  else if ($id) {

    /*
    ** Display role form:
    */

    $role = db_fetch_object(db_query("SELECT * FROM role WHERE rid = '$id'"));

    $output .= form_textfield("Role name", "name", $role->name, 32, 64, "The name for this role.  Example: 'moderator', 'editorial board', 'site architect'.");
    $output .= form_submit("Save role");
    $output .= form_submit("Delete role");

    $output = form($output);
  }

  if (!$output) {
    /*
    ** Render role overview:
    */

    $result = db_query("SELECT * FROM role ORDER BY name");

    $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
    $output .= " <tr><th>name</th><th>operations</th></tr>";
    while ($role = db_fetch_object($result)) {
      $output .= "<tr><td>". check_output($role->name) ."</td><td><a href=\"admin.php?mod=user&op=role&id=$role->rid\">edit role</a></td></tr>";
    }
    $output .= " <tr><td><input size=\"32\" maxlength=\"64\" name=\"edit[name]\" /></td><td><input type=\"submit\" name=\"op\" value=\"Add role\" /></td></tr>";
    $output .= "</table>";

    $output = form($output);
  }

  return $output;
}

function user_admin_edit($edit = array()) {
  global $op, $id, $HTTP_HOST;

  if ($account = user_load(array("uid" => $id))) {

    if ($op == "Save account") {
      $account = user_save($account, $edit);
    }
    else if ($op == "Delete account") {
      if ($edit["status"] == 0) {
        db_query("DELETE FROM users WHERE uid = '$account->uid'");
        db_query("DELETE FROM authmap WHERE uid = '$account->uid'");
        $output .= "The account has been deleted.";
      }
      else {
        $output .= "Failed to delete account: the account has to be blocked first.";
      }
    }

    if (!$output) {

      /*
      ** Display user form:
      */

      $output .= form_item("User ID", check_output($account->uid));
      $output .= form_item(t("Name"), check_output("$account->name ($account->init)"));
      $output .= form_item(t("E-mail address"), format_email($account->mail));
      $result = user_get_authmaps($account);

      foreach (module_list() as $module) {
        if (module_hook($module, "auth")) {
          if ($module != "drupal") {
            $output .= form_item("<a href=\"module.php?mod=user&op=help#$module\">". module_invoke($module, "info", "name") . " ID</a>", check_output($result[$module]));
          }
          else {
            $output .= form_item("<a href=\"module.php?mod=user&op=help#$module\">". module_invoke($module, "info", "name") . " ID</a>", check_output($account->name) ."@$HTTP_HOST");
          }
        }
      }

      $output .= form_item(t("Theme"), check_output("$account->theme"));
      $output .= form_select("Status", "status", $account->status, array("blocked", "active"));
      $output .= form_select("Role", "role", $account->role, user_roles());

      $output .= form_submit("Save account");
      $output .= form_submit("Delete account");

      $output = form($output);
    }
  }
  else {
    $output = "no such user";
  }

  return $output;
}

function user_admin_account() {
  global $query;

  $queries = array(array("ORDER BY timestamp DESC", "active users"), array("ORDER BY uid DESC", "new users"), array("WHERE status = 0 ORDER BY uid DESC", "blocked users"), array("WHERE role != 'authenticated user' ORDER BY uid DESC", "non-regular users"));

  $result = db_query("SELECT uid, name, timestamp FROM users ". $queries[$query ? $query : 0][0] ." LIMIT 50");

  foreach ($queries as $key => $value) {
    $links[] = "<a href=\"admin.php?mod=user&op=account&query=$key\">$value[1]</a>";
  }

  $output .= "<small>". implode(" :: ", $links) ."</small><hr />";

  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
  $output .= " <tr><th>username</th><th>last access</th><th>operations</th></tr>";
  while ($account = db_fetch_object($result)) {
    $output .= " <tr><td>". format_name($account) ."</td><td>". format_date($account->timestamp, "small") ."</td><td align=\"center\"><a href=\"admin.php?mod=user&op=edit&id=$account->uid\">edit account</a></td></tr>";
  }
  $output .= "</table>";

  return $output;

}

function admin_access_init() {
  $role = db_fetch_object(db_query("SELECT * FROM role WHERE name = 'anonymous user'"));
  if (!$role) db_query("INSERT INTO role (name) VALUES ('anonymous user')");

  $role = db_fetch_object(db_query("SELECT * FROM role WHERE name = 'authenticated user'"));
  if (!$role) db_query("INSERT INTO role (name) VALUES ('authenticated user')");
}


function user_admin() {
  global $edit, $id, $op, $user;

  if (user_access("administer users")) {

    /*
    ** Initialize all the roles and permissions:
    */

    admin_access_init();

    /*
    ** Compile a list of the administrative links:
    */

    $links[] = "<a href=\"admin.php?mod=user&op=create\">add new user</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=access\">access rules</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=account\">user accounts</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=role\">user roles</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=permission\">user permissions</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=search\">search account</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=settings\">settings</a>";
    // $links[] = "<a href=\"admin.php?mod=user&op=info\">auth modules</a>";
    $links[] = "<a href=\"admin.php?mod=user&op=help\">help</a>";

    print "<small>". implode(" &middot; ", $links) ."</small><hr />";

    switch ($op) {
      case "help":
        print user_help();
        break;
      case "search":
        print search_type("user", "admin.php?mod=user&op=search");
        break;
      case "Save configuration":
      case "Reset to defaults":
      case "settings":
        print user_admin_settings($edit);
        break;
      case "Add rule":
      case "Check":
      case "access":
        print user_admin_access($edit);
        break;
      case "Save permissions":
      case "permission":
        print user_admin_perm($edit);
        break;
      case "Create account":
      case "create":
        print user_admin_create($edit);
        break;
      case "Add role":
      case "Delete role":
      case "Save role":
      case "role":
        print user_admin_role($edit);
        break;
      case "Delete account":
      case "Save account":
      case "edit":
        print user_admin_edit($edit);
        break;
      default:
        print user_admin_account();
    }
  }
}

?>