user.module 67 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
<?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;

Kjartan's avatar
Kjartan committed
27
  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
  return '';
}

function sess_destroy($key) {
  global $HTTP_SERVER_VARS;

Kjartan's avatar
Kjartan committed
35
  db_query("UPDATE users SET hostname = '". check_input($HTTP_SERVER_VARS["REMOTE_ADDR"]) ."', timestamp = '". time() ."', sid = '' WHERE sid = '$key'");
Dries's avatar
 
Dries committed
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
}

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

Dries's avatar
 
Dries committed
62 63
  $query = "";

Dries's avatar
 
Dries committed
64 65
  foreach ($array as $key => $value) {
    if ($key == "pass") {
Kjartan's avatar
Kjartan committed
66
      $query .= "u.$key = '". md5($value) ."' AND ";
Dries's avatar
 
Dries committed
67 68 69 70 71 72 73 74
     }
    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
75 76 77 78 79 80 81
  if ($data = unserialize($user->data)) {
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
 
Dries committed
82 83 84 85 86 87 88 89 90 91 92 93

  return $user;

}

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

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

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

    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
123 124 125 126 127 128 129
        if (in_array($key, user_fields())) {
          $fields[] = check_query($key);
          $values[] = "'". check_query($value) ."'";
        }
        else {
          $data[$key] = $value;
        }
Dries's avatar
 
Dries committed
130 131 132
      }
    }

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

Dries's avatar
 
Dries committed
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
    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.");
174 175
  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.");
  if (!eregi('^[[:print:]]+', $name)) return t("The name contains an illegal character.");
Dries's avatar
 
Dries committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
  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.");
  }
}

191 192 193 194 195
function user_validate_authmap($account, $authname, $module) {
    $result = db_query("SELECT COUNT(*) from authmap WHERE uid != '$account->uid' && authname = '$authname'");
    if (db_result($result) > 0) {
      $name = module_invoke($module, "info", "name");
      return strtr(t("The %u ID %s is already taken."), array("%u" => ucfirst($name), "%s" => "<i>$authname</i>"));
Dries's avatar
 
Dries committed
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 241
    }
}

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) {
  if (variable_get("smtp_library", "") && file_exists(variable_get("smtp_library", ""))) {
    include_once variable_get("smtp_library", "");
242
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
243 244
  }
  else {
245
    return mail($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
  }
}

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
264 265 266 267 268 269 270 271 272 273 274 275
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
276 277 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
/*** Module hooks **********************************************************/

function user_help() {
 ?>
<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>
320
<p>If your site is completely private, and doesn't allow registration for
Dries's avatar
 
Dries committed
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
  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
381
  in a system generated password is also listed on this page. Drupal generates
Dries's avatar
 
Dries committed
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
  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 />
432 433 434 435 436 437 438
  User Preferences and Profile</h3>
<p>Drupal comes with a set of user preferences and profile which a user may edit by
  clicking on the user account link. Of course, a user must be logged into reach those pages.
  There, users will find a page for changing their preferred timezone, language, username, email address, password, theme, signature, homepage, and <a href="#da">distributed authentication</a> names.
  Changes made here take effect immediately. Also, administrators may make profile and preferences changes in the Admin Center on behalf of their users.</p>
  <p>Module developers are provided several hooks for adding custom fields to the user view/edit pages. These hooks are described in the Developer section of the <A href="http://www.drupal.org">Drupal Handbook</a>. For an example, see the <code>jabber_user()</code> function in <i>/modules/jabber.module</i>.
  </p>
Dries's avatar
 
Dries committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
 <?
}

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;
}

455 456 457 458 459 460 461
function user_block() {
  global $user;

  if ($user->uid) {
    // Display account settings:
    $block[0]["subject"] = $user->name;

Dries's avatar
 
Dries committed
462
    $output .= "<div style=\"{ width: 155; }\">\n";
463

Dries's avatar
 
Dries committed
464 465
    $links = array_merge(module_invoke_all("link", "menu.create"), array(""), module_invoke_all("link", "menu.view"), array(""), module_invoke_all("link", "menu.settings"), array(""), module_invoke_all("link", "menu.misc"));
    $output .= @implode("<br />\n", $links);
466 467

    $output .= "</div>";
468
    $block[0]["content"] = $output;
469 470
  }
  else {
471
    $block[1]["subject"] = t("Log in");
472 473

    $output .= "<div align=\"center\">\n";
474 475 476 477 478
    $output .= "<form action=\"module.php?mod=user&op=login\" method=\"post\">\n";
    $output .= "<b>". t("Username") .":</b><br /><input name=\"edit[name]\" size=\"15\" /><br />\n";
    $output .= "<b>". t("Password") .":</b><br /><input name=\"edit[pass]\" size=\"15\" type=\"password\" /><br />\n";
    $output .=  "<input name=\"edit[remember_me]\" type=\"checkbox\" />". t("Remember me") ."<br />\n";
    $output .= "<input type=\"submit\" value=\"". t("Log in") ."\" /><br />\n";
479
    $output .= "</div>\n";
480 481 482 483 484 485
    if (variable_get("account_register", 1)) {
      $output .= "&#187; <a href=\"module.php?mod=user&op=register\" title=\"". t("Create a new user account.") ."\">". t("Register") ."</a>\n";
    }
    $output .= "<br \>&#187; <a href=\"module.php?mod=user&op=password\" title=\"". t("Request new password via e-mail") . "\">" . t("New password") . "</a><br />";
    $output .= "</form>\n";

486
    $block[1]["content"] = $output;
487
  }
488

489 490 491
  $block[0]["info"] = t("User information");
  $block[0]["link"] = "module.php?mod=user";

492 493 494
  $block[1]["info"] = t("Log in");
  $block[1]["link"] = "module.php?mod=user";

Kjartan's avatar
Kjartan committed
495 496
  // Who's online block
  $time = 60 * 60; // minutes * seconds
Kjartan's avatar
Kjartan committed
497
  $limit = 5; // List the X most recent people
Kjartan's avatar
Kjartan committed
498 499 500 501 502 503 504 505 506

  $result = db_query("SELECT uid, name FROM users WHERE timestamp > unix_timestamp() - ($time) ORDER BY timestamp DESC LIMIT $limit");

  if (db_num_rows($result)) {
    $output = "<ol>";
    while ($account = db_fetch_object($result)) {
      $output .= '<li><a href="module.php?mod=user&op=view&id='. $account->uid .'">'. (strlen($account->name) > 10 ? substr($account->name, 0, 10) . '...' : $account->name) .'</a></li>';
    }
    $output .= "</ol>";
507
    $block[2]["content"] = $output;
Kjartan's avatar
Kjartan committed
508
  }
509 510
  $block[2]["subject"] = t("Who's online");
  $block[2]["info"] = t("Who's online");
Kjartan's avatar
Kjartan committed
511

512 513 514
  return $block;
}

Dries's avatar
 
Dries committed
515 516
function user_link($type) {
  if ($type == "page") {
Dries's avatar
 
Dries committed
517
    $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
518 519
  }

Dries's avatar
 
Dries committed
520
  if ($type == "menu.settings") {
521
    $links[] = "<a href=\"module.php?mod=user&op=edit\" title=\"". t("View and edit your account information.") ."\">". t("edit account") ."</a>";
Dries's avatar
 
Dries committed
522 523 524 525 526 527 528 529
  }

  if ($type == "menu.misc") {
    if (user_access("access administration pages")) {
      $links[] = "<a href=\"admin.php\">". strtr(t("administer %a"), array("%a" => variable_get("site_name", "drupal"))) ."</a>";
    }

    $links[] = "<a href=\"module.php?mod=user&op=logout\" title=\"". t("Logout.") ."\">". t("logout") ."</a>";
Dries's avatar
 
Dries committed
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
  }

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

561
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
562 563

  /*
564
  **  Called by authentication modules in order to edit/view their authmap information.
Dries's avatar
 
Dries committed
565 566
  */

567 568 569 570
  $result = db_query("SELECT authname FROM authmap WHERE uid = '$account->uid' && module = '$module'");
  return db_result($result);
}

Dries's avatar
 
Dries committed
571

572 573 574 575 576 577 578 579
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.
  */

  $result = db_query("SELECT authname, module FROM authmap WHERE authname = '$authname'");
Dries's avatar
 
Dries committed
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
  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 = "
Dries's avatar
 
Dries committed
614 615
   <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
Dries's avatar
 
Dries committed
616 617 618 619 620 621
    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>
Dries's avatar
 
Dries committed
622
   <p>Distributed Authentication enables a new user to input a username and password into the login box,
Dries's avatar
 
Dries committed
623 624 625 626 627 628 629 630 631 632 633 634 635 636
    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>";

637
  $output = strtr(t($output), array("%s" => $site));
Dries's avatar
 
Dries committed
638 639 640

  foreach (module_list() as $module) {
    if (module_hook($module, "auth")) {
Dries's avatar
 
Dries committed
641
      $output .= "<h4><a name=\"$module\"></a>" . module_invoke($module, "info", "name") . "</h4>";
Dries's avatar
 
Dries committed
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
      $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"])) {
672
    $error = strtr(t("The name '%s' has been denied access."), array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
  }
  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:
    */

700
    if (!$user && $server  && $result = user_get_authmaps("$name@$server")) {
Dries's avatar
 
Dries committed
701 702 703 704 705
      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 {
706
        $error = strtr(t("Invalid password for %s."), array("%s" => "<i>$name@$server</i>"));
Dries's avatar
 
Dries committed
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
      }
    }

     /*
    ** 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
744
      }
Dries's avatar
 
Dries committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758
      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) {
759
        $error = sprintf(t("Sorry. Unrecognized username or password. Have you %sforgotten your password%s?"), "<a href=\"module.php?mod=user&op=password\">", "</a>");
Dries's avatar
 
Dries committed
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
      }
      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) {
Kjartan's avatar
Kjartan committed
775
    $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
 
Dries committed
776 777 778 779 780 781
  }

  /*
  ** Display login form:
  */

782
  $output .= form_textfield(t("Username"), "name", $edit["name"], 20, 64, strtr(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
783
  $output .= form_password(t("Password"), "pass", $pass, 20, 64, t("Enter the password that accompanies your username."));
784
  $output .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
 
Dries committed
785
  $output .= form_submit(t("Log in"));
786 787
  $output .= "<p>&#187; <a href=\"module.php?mod=user&op=password\">" . t("E-mail new password") . "</a><br />";
  $output .= "&#187; <a href=\"module.php?mod=user&op=register\">" . t("Create new account") . "</a></p>";
Dries's avatar
 
Dries committed
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

  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()) {

Kjartan's avatar
Kjartan committed
816
  if ($edit["name"]) {
817 818 819
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM users WHERE name = '". check_input($edit["name"]) . "'"));
    if (!$account) $error = strtr(t("Sorry. The username <i>%s</i> is not recognized."), array("%s" => $edit["name"]));
  }
Kjartan's avatar
Kjartan committed
820
  else if ($edit["mail"]) {
821 822
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM users WHERE mail = '". check_input($edit["mail"]) ."'"));
    if (!$account) $error = strtr(t("Sorry. The e-mail address <i>%s</i> is not recognized."), array("%s" => $edit["mail"]));
Kjartan's avatar
Kjartan committed
823 824
  }
  if ($account) {
Dries's avatar
 
Dries committed
825

826
      $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
827 828 829 830 831 832 833 834 835 836 837 838
      $pass = user_password();

      /*
      ** Save new password:
      */

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

      /*
      ** Mail new password:
      */

839 840 841
      global $HTTP_HOST;
      $variables = array("%username" => $account->name, "%site" => variable_get("site_name", "drupal"), "%password" => $pass, "%uri" => path_uri(), "%uri_brief" => $HTTP_HOST, "%mailto" => $account->mail);
      $subject = strtr(variable_get("user_mail_pass_subject", t("Replacement login information for %username at %site")), $variables);
Kjartan's avatar
Kjartan committed
842
      $body = strtr(variable_get("user_mail_pass_body", t("%username,\n\nHere is your new password for %site. You may now login to %urimodule.php?mod=login using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %urimodule.php?mod=user&op=edit\n\nYour new %site membership also enables to you to login to other Drupal powered web sites (e.g. http://www.drop.org) without registering. Just use the following Drupal ID and password:\n\nDrupal ID: %username@%uri_brief\npassword: %password\n\n\n--  %site team")), $variables);
843 844
      $headers = "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from";
      user_mail($account->mail, $subject, $body, $headers);
Dries's avatar
 
Dries committed
845

846
      watchdog("user", "mail password: '". $account->name ."' &lt;". $account->mail ."&gt;");
Dries's avatar
 
Dries committed
847 848 849 850

      return t("Your password and further instructions have been sent to your e-mail address.");
    }
    else {
851

Kjartan's avatar
Kjartan committed
852 853 854
    // Display error message if necessary.
    if ($error) {
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
 
Dries committed
855 856 857 858 859 860
    }

    /*
    ** Display form:
    */

861
    $output .= "<p>". sprintf(t("Enter your username %sor%s your email address."), "<b><i>", "</i></b>") ."</p>";
Dries's avatar
 
Dries committed
862 863 864
    $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"));
865 866
    $output .= "<p>&#187; <a href=\"module.php?mod=user&op=login\">" . t("Log in") . "</a><br />";
    $output .= "&#187; <a href=\"module.php?mod=user&op=register\">" . t("Create new account") . "</a></p>";
Dries's avatar
 
Dries committed
867 868 869 870 871 872

    return form($output);
  }
}

function user_register($edit = array()) {
873 874 875 876 877 878 879 880 881
  global $user;

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

  if ($user->uid) {
    drupal_goto("module.php?mod=user&op=edit");
  }
Dries's avatar
 
Dries committed
882 883 884 885 886 887 888 889 890

  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"])) {
891
      $error = strtr(t("The name '%s' has been denied access."), array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
892 893
    }
    else if (user_deny("mail", $edit["mail"])) {
894
      $error = strtr(t("The e-mail address '%s' has been denied access."), array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
895 896
    }
    else if (db_num_rows(db_query("SELECT name FROM users WHERE LOWER(name) = LOWER('". $edit["name"] ."')")) > 0) {
897
      $error = strtr(t("The name '%s' is already taken."), array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
898 899
    }
    else if (db_num_rows(db_query("SELECT mail FROM users WHERE LOWER(mail) = LOWER('". $edit["mail"] ."')")) > 0) {
900
      $error = strtr(t("The e-mail address '%s' is already taken."), array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
901 902 903 904 905
    }
    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
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
      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
921 922 923 924 925 926 927
    }
  }

  if ($success) {

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

928
    $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
 
Dries committed
929 930
    $pass = user_password();

931
    // create new user account, noting whether administrator approval is required
Dries's avatar
 
Dries committed
932
    if (variable_get("user_register", 1) == 1) {
933
      $user = 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
934 935
    }
    else {
936
      $user = 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
937 938
    }

939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    $variables = array("%username" => $edit["name"], "%site" => variable_get("site_name", "drupal"), "%password" => $pass, "%uri" => path_uri(), "%uri_brief" => $HTTP_HOST, "%mailto" => $edit["mail"]);

    //the first user may login immediately, and receives a customized welcome email.
    if ($user->uid == 1) {
      user_mail($edit["mail"], strtr(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\nAfter logging in, you may wish to visit the following pages:\n\nAdministration: %uriadmin.php\nEdit user account: %utimodule.php?mod=user&op=edit\n\n--drupal"), $variables), "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
      // 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
      $output .= "<p>Welcome to Drupal. You are user #1, which gives you full and immediate access. All future registrants will receive their passwords via email, so please configure your email 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>";
      $output .= form_hidden("name", $user->name);
      $output .= form_hidden("pass", $pass);
      $output .= form_submit(t("Log in"));
      return form($output);
    }
    else {
      global $HTTP_HOST;
      $subject = strtr(variable_get("user_mail_welcome_subject", t("User account details for %username at %site")), $variables);
Kjartan's avatar
Kjartan committed
954
      $body = strtr(variable_get("user_mail_welcome_body", t("%username,\n\nThank you for registering at %site. You may now login to %urimodule.php?mod=login using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %urimodule.php?mod=user&op=edit\n\nYour new %site membership also enables to you to login to other Drupal powered web sites (e.g. http://www.drop.org) without registering. Just use the following Drupal ID and password:\n\nDrupal ID: %username@%uri_brief\npassword: %password\n\n\n--  %site team")), $variables);
955 956 957
      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.");
    }
Dries's avatar
 
Dries committed
958 959 960
  }
  else {
    if ($error) {
Kjartan's avatar
Kjartan committed
961
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
 
Dries committed
962
    }
963
  }
Dries's avatar
 
Dries committed
964

965 966 967 968 969 970 971 972 973 974 975
  // display the registration form
  $affiliates = user_auth_help_links();
  if (array_count_values($affiliates) > 1) {
    $affiliates = implode(", ", $affiliates);
    $output .= "<p>" . strtr(t("Note: If you have an account with one of our affiliates (%s), you may <a href=\"\module.php?mod=user&op=login\">login now</a> instead of registering."), array("%s" => $affiliates)) ."</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("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
976
    }
Dries's avatar
 
Dries committed
977
  }
978 979 980
  $output .= form_submit(t("Create new account"));

  return form($output);
Dries's avatar
 
Dries committed
981 982
}

Kjartan's avatar
Kjartan committed
983 984 985

function user_delete() {
  global $edit, $user;
986

Kjartan's avatar
Kjartan committed
987
  if ($edit["confirm"]) {
988
    watchdog(user,"$user->name deactivated her own account.");
Kjartan's avatar
Kjartan committed
989 990 991 992 993 994 995 996 997 998 999 1000
    db_query("UPDATE users SET mail = 'deleted', status='0' WHERE uid = '$user->uid'");
    $output .= t("Your account has been deactivated.");
  }
  else {
    $output .= form_item(t("Confirm Deletion"), t("You are about to deactivate your own user account. In addition, your email address will be removed from the database."));
    $output .= form_hidden("confirm", 1);
    $output .= form_submit(t("Delete account"));
    $output = form($output);
  }
  return $output;
}

Dries's avatar
 
Dries committed
1001
function user_edit($edit = array()) {
1002
  global $themes, $user, $languages;
Dries's avatar
 
Dries committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012

  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) {
1013
        $error = strtr(t("The name '%s' is already taken."), array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
1014 1015
      }
      else if ($edit["mail"] && db_num_rows(db_query("SELECT uid FROM users WHERE uid != '$user->uid' AND LOWER(mail) = LOWER('". $edit["mail"] ."')")) > 0) {
1016
        $error = strtr(t("The e-mail address '%s' is already taken."), array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
1017 1018
      }
      else if ($user->uid) {
Dries's avatar
 
Dries committed
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
        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
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
        /*
        ** 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
1048 1049 1050 1051
        if (!$error) {
          /*
          ** Save user information:
          */
Dries's avatar
 
Dries committed
1052

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

1055
          $output .= t("Your user information changes have been saved.");
Dries's avatar
 
Dries committed
1056
        }
Dries's avatar
 
Dries committed
1057 1058 1059 1060
      }
    }

    if ($error) {
Kjartan's avatar
Kjartan committed
1061
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
 
Dries committed
1062 1063 1064 1065 1066
    }

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

Dries's avatar
 
Dries committed
1067 1068 1069 1070 1071 1072
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "edit_form", $edit, $user);
      }
    }

Dries's avatar
 
Dries committed
1073
    $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://\"."));
1074 1075 1076
    foreach (theme_list() as $key => $value) {
      $options .= "$value[type]<option value=\"$key\"". (($user->theme == $key) ? " selected=\"selected\"" : "") .">$key - $value->description</option>\n";
    }
Dries's avatar
 
Dries committed
1077 1078 1079 1080 1081
    $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", "")));
Dries's avatar
 
Dries committed
1082
    $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."));
Dries's avatar
 
Dries committed
1083
    $output .= form_submit(t("Save user information"));
1084

Dries's avatar
 
Dries committed
1085 1086 1087 1088 1089 1090 1091 1092 1093
    $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>";
Kjartan's avatar
Kjartan committed
1094
  $links[] = "<a href=\"module.php?mod=user&op=delete\">". t("delete account") ."</a>";
Dries's avatar
 
Dries committed
1095 1096 1097 1098 1099

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

function user_view($uid = 0) {
1100
  global $theme, $user;
Dries's avatar
 
Dries committed
1101 1102 1103 1104 1105 1106 1107 1108

  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));
Dries's avatar
 
Dries committed
1109 1110 1111 1112 1113 1114 1115

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

Dries's avatar
 
Dries committed
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
    $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
1128 1129 1130 1131 1132 1133
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "view_public", "", $account);
      }
    }

Dries's avatar
 
Dries committed
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
    $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":
1159
      $output = user_register($edit);
Dries's avatar
 
Dries committed
1160
      $theme->header();
1161
      $theme->box(t("Create new account"), $output);
Dries's avatar
 
Dries committed
1162 1163 1164 1165 1166 1167 1168 1169 1170
      $theme->footer();
      break;
    case t("Log in"):
    case "login":
      $output = user_login($edit);
      $theme->header();
      $theme->box(t("Log in"), $output);
      $theme->footer();
      break;
1171
    case t("Delete account"):
Kjartan's avatar
Kjartan committed
1172 1173 1174 1175 1176 1177 1178
    case t("delete");
      $output = user_delete();
      $theme->header();
      $theme->box(t("User account"), user_menu());
      $theme->box(t("Delete account"), $output);
      $theme->footer();
      break;
1179
    case t("Save user information"):
Dries's avatar
 
Dries committed
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
    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.");
1210
  $output .= form_textfield("Welcome e-mail subject", "user_mail_welcome_subject", variable_get("user_mail_welcome_subject", t("User account details for %username at %site")), 80, 180, "Customize the Subject of your welcome email, which is sent to new members upon registering. Available variables are: %username, %site, %password, %uri, %uri_brief, %mailto");
Kjartan's avatar
Kjartan committed
1211
  $output .= form_textarea("Welcome e-mail body", "user_mail_welcome_body", variable_get("user_mail_welcome_body", t("%username,\n\nThank you for registering at %site. You may now login to %urimodule.php?mod=login using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %urimodule.php?mod=user&op=edit\n\nYour new %site membership also enables to you to login to other Drupal powered web sites (e.g. http://www.drop.org) without registering. Just use the following Drupal ID and password:\n\nDrupal ID: %username@%uri_brief\npassword: %password\n\n\n--  %site team")), 70, 10, "Customize the Body of the welcome email, which is sent to new members upon registering. Available variables are: %username, %site, %password, %uri, %uri_brief, %mailto");
1212
  $output .= form_textfield("Forgotten password e-mail subject", "user_mail_pass_subject", variable_get("user_mail_pass_subject", t("Replacement login information for %username at %site")), 80, 180, "Customize the Subject of your Forgotten Password email. Available variables are: %username, %site, %password, %uri, %uri_brief, %mailto");
Kjartan's avatar
Kjartan committed
1213
  $output .= form_textarea("Forgotten password e-mail body", "user_mail_pass_body", variable_get("user_mail_pass_body", t("%username,\n\nHere is your new password for %site. You may now login to %urimodule.php?mod=login using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %urimodule.php?mod=user&op=edit\n\nYour new %site membership also enables to you to login to other Drupal powered web sites (e.g. http://www.drop.org) without registering. Just use the following Drupal ID and password:\n\nDrupal ID: %username@%uri_brief\npassword: %password\n\n\n--  %site team")), 70, 10, "Customize the Body of the Forgotten Password email. Available variables are: %username, %site, %password, %uri, %uri_brief, %mailto");
Dries's avatar
 
Dries committed
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
  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) {
1254
      $error = strtr(t("The name '%s' is already taken."), array("%s" => $edit["name"]));
Dries's avatar
 
Dries committed
1255 1256
    }
    else if (db_num_rows(db_query("SELECT mail FROM users WHERE LOWER(mail) = LOWER('". $edit["mail"] ."')")) > 0) {
1257
      $error = strtr(t("The e-mail address '%s' is already taken."), array("%s" => $edit["mail"]));
Dries's avatar
 
Dries committed
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
    }
    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) {
Kjartan's avatar
Kjartan committed
1275
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
 
Dries committed
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
    }

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

}

1347
function user_roles($membersonly = 0) {
Dries's avatar
 
Dries committed
1348 1349
  $result = db_query("SELECT * FROM role ORDER BY name");
  while ($role = db_fetch_object($result)) {
1350 1351 1352
    if (!$membersonly || ($membersonly && $role->name != "anonymous user")) {
      $roles[$role->name] = $role->name;
    }
Dries's avatar
 
Dries committed
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
  }
  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) {
Dries's avatar
 
Dries committed
1403
      $output .= "  <td align=\"center\"><input type=\"checkbox\" name=\"edit[$name][$perm]\"". (strstr($value, $perm) ? " checked=\"checked\"" : "") ." /></td>";
Dries's avatar
 
Dries committed
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
    }
    $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()) {
1463
  global $op, $id, $themes;
Dries's avatar
 
Dries committed
1464 1465 1466 1467

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

    if ($op == "Save account") {
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
      foreach (module_list() as $module) {
        if (module_hook($module, "user")) {
          $result = module_invoke($module, "user", "edit_validate", $edit, $account);
        }
        if (is_array($result)) {
          $data = array_merge($data, $result);
        }
        elseif (is_string($result)) {
          $error = $result;
          break;
        }
      }
      // TODO: this display/edit/validate should be moved to a new profile.module implementing the _user hooks
      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 != '$account->uid' AND LOWER(name) = LOWER('". $edit["name"] ."')")) > 0) {
        $error = strtr(t("The name '%s' is already taken."), array("%s" => $edit["name"]));
      }
      else if ($edit["mail"] && db_num_rows(db_query("SELECT uid FROM users WHERE uid != '$account->uid' AND LOWER(mail) = LOWER('". $edit["mail"] ."')")) > 0) {
        $error = strtr(t("The e-mail address '%s' is already taken."), array("%s" => $edit["mail"]));
      }
      if (!$error) {
        $account = user_save($account, $edit);
        $output .= "<p><span style=\"font-style: italic; font-weight: bold\" class=\"status\">" . t("Your user information changes have been saved.") . "</span></p>";
      }
      else {
        $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
      }
Dries's avatar
 
Dries committed
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
    }
    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.";
      }
    }