Commit b1d86208 authored by Dries's avatar Dries
Browse files

- Applied Marco's first "remember me" patch.
parent 3b5c3806
<?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'");
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);
return $user;
}
function user_save($account, $array = array()) {
/*
** Dynamically compose a SQL query:
*/
if ($account->uid) {
foreach ($array as $key => $value) {
if ($key == "pass") {
$query .= "$key = '". md5($value) ."', ";
}
else if (substr($key, 0, 4) !== "auth") {
$query .= "$key = '". addslashes($value) ."', ";
}
}
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") {
$fields[] = check_query($key);
$values[] = "'". check_query($value) ."'";
}
}
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) {
print "<pre>subject: $subject<hr />header: $header<hr />$message</pre>";
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;
}
}
/*** 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") {
$links[] = "<a href=\"module.php?mod=user\" title=\"". t("Create a user account, e-mail a new password or edit your account settings.") ."\">". t("user account") ."</a>";
}
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;
}
}
}