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

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

7
8
9
10
11
function user_system($field){
  $system["description"] = t("Enables a user registration system.");
  return $system[$field];
}

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

26
  return $user->sid ? $user->sid : '';
Dries's avatar
   
Dries committed
27
28
29
30
31
}

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

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

Dries's avatar
   
Dries committed
34
35
36
37
38
39
  return '';
}

function sess_destroy($key) {
  global $HTTP_SERVER_VARS;

Dries's avatar
   
Dries committed
40
  db_query("UPDATE users SET hostname = '%s', timestamp = '%s', sid = '' WHERE sid = '$key'", $HTTP_SERVER_VARS["REMOTE_ADDR"], time());
Dries's avatar
   
Dries committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
}

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
67
68
  $query = "";

Dries's avatar
   
Dries committed
69
70
  foreach ($array as $key => $value) {
    if ($key == "pass") {
Kjartan's avatar
Kjartan committed
71
      $query .= "u.$key = '". md5($value) ."' AND ";
Dries's avatar
   
Dries committed
72
73
74
75
76
     }
    else {
      $query .= "u.$key = '". addslashes($value) ."' AND ";
    }
  }
77
  $result = db_query("SELECT u.*, r.name AS role FROM users u LEFT JOIN role r ON u.rid = r.rid WHERE $query u.status < 3 LIMIT 1");
Dries's avatar
   
Dries committed
78
79

  $user = db_fetch_object($result);
Dries's avatar
   
Dries committed
80
81
82
83
84
85
86
  if ($data = unserialize($user->data)) {
    foreach ($data as $key => $value) {
      if (!isset($user->$key)) {
        $user->$key = $value;
      }
    }
  }
Dries's avatar
   
Dries committed
87
88
89
90
91
92
93
94
95
96
97

  return $user;
}

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

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

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

Dries's avatar
   
Dries committed
114
    db_query("UPDATE users SET $query timestamp = '%s' WHERE uid = '$account->uid'", time());
Dries's avatar
   
Dries committed
115
116
117
118
119
120
121
122
123
124
125
126

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

Dries's avatar
   
Dries committed
137
138
139
    $fields[] = "data";
    $values[] = "'". serialize($data) ."'";

Dries's avatar
   
Dries committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
    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.");
178
179
  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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
  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.");
  }
}

195
function user_validate_authmap($account, $authname, $module) {
Dries's avatar
   
Dries committed
196
197
198
199
200
  $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 t("The %u ID %s is already taken.", array("%u" => ucfirst($name), "%s" => "<i>$authname</i>"));
  }
Dries's avatar
   
Dries committed
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
}

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

Dries's avatar
   
Dries committed
225
226
  if (!$perm) {
    if ($user->uid) {
Kjartan's avatar
Kjartan committed
227
      $perm = db_result(db_query("SELECT p.perm FROM role r, permission p WHERE r.rid = p.rid AND name = '$user->role'"), 0);
Dries's avatar
   
Dries committed
228
229
    }
    else {
Kjartan's avatar
Kjartan committed
230
      $perm = db_result(db_query("SELECT p.perm FROM role r, permission p WHERE r.rid = p.rid AND name = 'anonymous user'"), 0);
Dries's avatar
   
Dries committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
    }
  }

  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", "");
246
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
   
Dries committed
247
248
  }
  else {
249
    return mail($mail, $subject, $message, $header);
Dries's avatar
   
Dries committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
  }
}

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
267
268
function user_fields() {
  static $fields;
Dries's avatar
   
Dries committed
269

Dries's avatar
   
Dries committed
270
271
272
273
274
275
276
277
278
279
  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
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
/*** 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>
Dries's avatar
   
Dries committed
318
319
<h3>User administration</h3>
<p>Administrators manage user accounts by clicking on the <i>User management</i> link in
Dries's avatar
   
Dries committed
320
321
322
323
  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>
324
<p>If your site is completely private, and doesn't allow registration for
Dries's avatar
   
Dries committed
325
  any old web user (see <a href="#settings">settings</a> for this feature), then
Dries's avatar
   
Dries committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
  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
385
  in a system generated password is also listed on this page. Drupal generates
Dries's avatar
   
Dries committed
386
387
388
389
390
391
392
393
394
395
  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>
Dries's avatar
   
Dries committed
396
<h3>Distributed authentication<a name="da"> </a></h3>
Dries's avatar
   
Dries committed
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
<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 />
Dries's avatar
   
Dries committed
436
  User preferences and profiles</h3>
437
438
439
440
441
442
<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
443
444
445
446
447
448
449
450
451
452
453
 <?
}

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)) {
Dries's avatar
   
Dries committed
454
    $find[$i++] = array("title" => $account->name, "link" => (strstr($PHP_SELF, "admin.php") ? drupal_url(array("mod" => "user", "op" => "edit", "id" => $account->uid), "admin") : drupal_url(array("mod" => "user", "op" => "view", "id" => $account->uid), "module")), "user" => $account->name);
Dries's avatar
   
Dries committed
455
456
457
458
  }
  return $find;
}

459
function user_block() {
Dries's avatar
   
Dries committed
460
  global $user, $edit;
461
462
463
464
465

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

Kjartan's avatar
Kjartan committed
466
    $output = "<div style=\"{ width: 155; }\">\n";
467

Dries's avatar
   
Dries committed
468
469
    $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);
470
471

    $output .= "</div>";
472
    $block[0]["content"] = $output;
473
474
  }
  else {
475
    $block[1]["subject"] = t("Log in");
476

Kjartan's avatar
Kjartan committed
477
    $output = "<div align=\"center\">\n";
478
    $output .= "<form action=\"". drupal_url(array("mod" => "user", "op" => "login"), "module") ."\" method=\"post\">\n";
Dries's avatar
   
Dries committed
479
480
481
    // Save the referer.  We record where the user came from such that we
    // can redirect him after having completed the login form.
    if (!$edit["destination"]) $edit["destination"] = request_uri();
Kjartan's avatar
Kjartan committed
482
    $output .= "<input name=\"edit[destination]\" type=\"hidden\" value=\"" . $edit["destination"] . "\" />";
483
484
    $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";
Kjartan's avatar
Kjartan committed
485
    $output .= "<input name=\"edit[remember_me]\" type=\"checkbox\" />". t("Remember me") ."<br />\n";
Dries's avatar
   
Dries committed
486
    $output .= "<input name=\"edit[op]\" type=\"submit\" value=\"". t("Log in") ."\" /><br />\n";
Kjartan's avatar
Kjartan committed
487
    $output .= "</form></div>\n";
488
    if (variable_get("user_register", 1)) {
489
      $output .= "&raquo; ". lm(t("Register"), array("mod" => "user", "op" => "register"), "", array("title" => t("Create a new user account."))) ."<br />\n";
490
    }
Dries's avatar
   
Dries committed
491
    $output .= "&raquo; ". lm(t("New password"), array("mod" => "user", "op" => "password"), "", array("title" => t("Request new password via e-mail.")));
492

493
    $block[1]["content"] = $output;
494
  }
495

496
  $block[0]["info"] = t("User information");
Dries's avatar
   
Dries committed
497
  $block[0]["link"] = drupal_url(array("mod" => "user"), "module");
498

499
  $block[1]["info"] = t("Log in");
Dries's avatar
   
Dries committed
500
  $block[1]["link"] = drupal_url(array("mod" => "user"), "module");
501

Kjartan's avatar
Kjartan committed
502
503
  // Who's online block
  $time = 60 * 60; // minutes * seconds
Kjartan's avatar
Kjartan committed
504
  $limit = 5; // List the X most recent people
Kjartan's avatar
Kjartan committed
505

Dries's avatar
   
Dries committed
506
  $result = db_query("SELECT uid, name FROM users WHERE timestamp > unix_timestamp() - $time ORDER BY timestamp DESC LIMIT $limit");
Kjartan's avatar
Kjartan committed
507
508

  if (db_num_rows($result)) {
509
    $output = "";
Kjartan's avatar
Kjartan committed
510
    while ($account = db_fetch_object($result)) {
Kjartan's avatar
Kjartan committed
511
      $output .= lm((strlen($account->name) > 15 ? substr($account->name, 0, 15) . '...' : $account->name), array("mod" => "user", "op" => "view", "id" => $account->uid)) ."<br />";
Kjartan's avatar
Kjartan committed
512
    }
513
    $block[2]["content"] = $output;
Kjartan's avatar
Kjartan committed
514
  }
515
516
  $block[2]["subject"] = t("Who's online");
  $block[2]["info"] = t("Who's online");
Dries's avatar
   
Dries committed
517
518
519
  $block[3]["subject"] = t("Who's new");
  $block[3]["info"] = t("Who's new");
  $block[3]["content"] = user_new_users();
Kjartan's avatar
Kjartan committed
520

521
522
523
  return $block;
}

Dries's avatar
   
Dries committed
524
525
526
function user_new_users() {
  $result = db_query("SELECT uid, name FROM users WHERE status != '0' ORDER BY uid DESC LIMIT 5");
  while ($account = db_fetch_object($result)) {
527
    $output .= lm((strlen($account->name) > 15 ? substr($account->name, 0, 15) . '...' : $account->name), array("mod" =>user, "op" => "view", "id" => $account->uid)) ."<br />";
Dries's avatar
   
Dries committed
528
529
530
531
  }
  return $output;
}

Dries's avatar
   
Dries committed
532
533
function user_link($type) {
  if ($type == "page") {
Kjartan's avatar
Kjartan committed
534
    $links[] = lm(t("user account"), array("mod" => "user"), "", array("title" => t("Create a user account, request a new password or edit your account settings.")));
Dries's avatar
   
Dries committed
535
536
  }

Dries's avatar
   
Dries committed
537
  if ($type == "menu.settings") {
Kjartan's avatar
Kjartan committed
538
    $links[] = lm(t("edit account"), array("mod" => "user", "op" => "edit"), "", array("title" => t("View and edit your account information.")));
Dries's avatar
   
Dries committed
539
540
541
542
  }

  if ($type == "menu.misc") {
    if (user_access("access administration pages")) {
Dries's avatar
   
Dries committed
543
      $links[] = la(t("administer %a", array("%a" => variable_get("site_name", "drupal"))));
Dries's avatar
   
Dries committed
544
545
    }

Kjartan's avatar
Kjartan committed
546
    $links[] = lm(t("logout"), array("mod" => "user", "op" => "logout"), "", array("title" => t("Logout.")));
Dries's avatar
   
Dries committed
547
548
549
  }

  if ($type == "admin" && user_access("administer users")) {
Dries's avatar
   
Dries committed
550
    $links[] = la(t("user management"), array("mod" => "user"));
Dries's avatar
   
Dries committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
  }

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

578
function user_get_authname($account, $module) {
Dries's avatar
   
Dries committed
579
580

  /*
581
  **  Called by authentication modules in order to edit/view their authmap information.
Dries's avatar
   
Dries committed
582
583
  */

584
585
586
587
  $result = db_query("SELECT authname FROM authmap WHERE uid = '$account->uid' && module = '$module'");
  return db_result($result);
}

Dries's avatar
   
Dries committed
588

589
590
591
592
593
594
595
596
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
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) {
Dries's avatar
   
Dries committed
614
        $result = db_query("INSERT INTO authmap (authname, uid, module) VALUES ('%s', '%s', '%s')", $value, $account->uid, $module[1]);
Dries's avatar
   
Dries committed
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
      }
      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
631
   <h3>Distributed authentication<a name=\"da\"></a></h3>
Dries's avatar
   
Dries committed
632
   <p>One of the more tedious moments in visiting a new web site is filling out the
Dries's avatar
   
Dries committed
633
634
635
636
637
638
    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
639
   <p>Distributed Authentication enables a new user to input a username and password into the login box,
Dries's avatar
   
Dries committed
640
641
642
643
644
645
646
647
648
649
650
651
652
653
    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>";

Dries's avatar
   
Dries committed
654
  $output = t($output, array("%s" => $site));
Dries's avatar
   
Dries committed
655
656
657

  foreach (module_list() as $module) {
    if (module_hook($module, "auth")) {
Dries's avatar
   
Dries committed
658
      $output .= "<h4><a name=\"$module\"></a>" . module_invoke($module, "info", "name") . "</h4>";
Dries's avatar
   
Dries committed
659
660
661
662
663
664
665
666
667
668
      $output .= module_invoke($module, "auth_help");
    }
  }

  return $output;
}

function user_auth_help_links() {
  foreach (module_list() as $module) {
    if (module_hook($module, "auth_help")) {
Kjartan's avatar
Kjartan committed
669
      $links[] = lm(module_invoke($module, "info", "name"), array("mod" => "user", "op" => "help"), $module);
Dries's avatar
   
Dries committed
670
671
672
673
674
675
676
    }
  }
  return $links;
}

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

Dries's avatar
   
Dries committed
677
678
function user_login($edit = array(), $msg = "") {
  global $user, $referer;
Dries's avatar
   
Dries committed
679
680
681
682
683
684

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

  if ($user->uid) {
Dries's avatar
   
Dries committed
685
    drupal_goto(drupal_url(array("mod" => "user"), "module"));
Dries's avatar
   
Dries committed
686
687
688
  }

  if (user_deny("user", $edit["name"])) {
Dries's avatar
   
Dries committed
689
    $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
   
Dries committed
690
691
692
693
  }
  else if ($edit["name"] && $edit["pass"]) {

    /*
Dries's avatar
   
Dries committed
694
    ** Try to log in the user locally:
Dries's avatar
   
Dries committed
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
    */

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

717
    if (!$user && $server && $result = user_get_authmaps("$name@$server")) {
Dries's avatar
   
Dries committed
718
719
720
721
722
      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 {
Dries's avatar
   
Dries committed
723
        $error = t("Invalid password for %s.", array("%s" => "<i>$name@$server</i>"));
Dries's avatar
   
Dries committed
724
725
726
727
728
729
730
731
732
733
734
735
736
      }
    }

     /*
    ** 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)");
737
              $user = user_save("", array("name" => "$name@$server", "pass" => user_password(), "init" => "$name@$server", "rid" => _user_authenticated_id(), "status" => 1, "authname_$module" => "$name@$server"));
Dries's avatar
   
Dries committed
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
              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
761
      }
Dries's avatar
   
Dries committed
762
763
764
765
766
      else {
        setcookie(session_name(), session_id());
      }

      /*
Dries's avatar
   
Dries committed
767
      ** Redirect the user to the page he logged on from.
Dries's avatar
   
Dries committed
768
769
      */

Dries's avatar
   
Dries committed
770
      drupal_goto($edit["destination"]);
Dries's avatar
   
Dries committed
771
772
773
    }
    else {
      if (!$error) {
774
        $error = t("Sorry.  Unrecognized username or password.") ." ". lm(t("Have you forgotten your password?"), array("mod" => "user", "op" => "password"));
Dries's avatar
   
Dries committed
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
      }
      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
790
    $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
   
Dries committed
791
792
  }

Dries's avatar
   
Dries committed
793
794
795
796
797
798
799
800
801
802
  /*
  ** Save the referer.  We record where the user came from such that we
  ** can redirect him after having completed the login form.
  */

  if (!$edit["destination"]) {
    $edit["destination"] = request_uri();
  }
  $output .= form_hidden("destination", $edit["destination"]);

Dries's avatar
   
Dries committed
803
804
805
806
  /*
  ** Display login form:
  */

Dries's avatar
   
Dries committed
807
808
809
  if ($msg) {
    $output .= "<p>$msg</p>";
  }
Dries's avatar
   
Dries committed
810
  $output .= form_textfield(t("Username"), "name", $edit["name"], 20, 64, t("Enter your %s username, or an ID from one of our affiliates: %a.", array("%s" => variable_get("site_name", "local"), "%a" => implode(", ", user_auth_help_links()))));
Dries's avatar
   
Dries committed
811
  $output .= form_password(t("Password"), "pass", $pass, 20, 64, t("Enter the password that accompanies your username."));
812
  $output .= form_checkbox(t("Remember me"), "remember_me", 1, 0, 0);
Dries's avatar
   
Dries committed
813
  $output .= form_submit(t("Log in"));
814
815
816
817
818
  $output .= "<p>&raquo; ". lm(t("E-mail new password"), array("mod" => "user", "op" => "password")). "<br />";
  if (variable_get("user_register", 1)) {
    $output .= "&raquo; ". lm(t("Create new account"), array("mod" => "user", "op" => "register"));
  }
  $output .= "</p>";
Dries's avatar
   
Dries committed
819

Dries's avatar
   
Dries committed
820
  return form($output, "post", drupal_url(array ("mod" => "user"), "module"));
Dries's avatar
   
Dries committed
821
822
}

823
824
825
826
function _user_authenticated_id() {
  return db_result(db_query("SELECT rid FROM role WHERE name = 'authenticated user'"));
}

Dries's avatar
   
Dries committed
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
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
851
  if ($edit["name"]) {
Dries's avatar
   
Dries committed
852
853
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM users WHERE name = '%s'", $edit["name"]));
    if (!$account) $error = t("Sorry. The username <i>%s</i> is not recognized.", array("%s" => $edit["name"]));
854
  }
Kjartan's avatar
Kjartan committed
855
  else if ($edit["mail"]) {
Dries's avatar
   
Dries committed
856
857
    $account = db_fetch_object(db_query("SELECT uid, name, mail FROM users WHERE mail = '%s'", $edit["mail"]));
    if (!$account) $error = t("Sorry. The e-mail address <i>%s</i> is not recognized.", array("%s" => $edit["mail"]));
Kjartan's avatar
Kjartan committed
858
859
  }
  if ($account) {
Dries's avatar
   
Dries committed
860

861
      $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
   
Dries committed
862
863
864
865
866
867
868
869
870
871
872
873
      $pass = user_password();

      /*
      ** Save new password:
      */

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

      /*
      ** Mail new password:
      */

874
      $variables = array("%username" => $account->name, "%site" => variable_get("site_name", "drupal"), "%password" => $pass, "%uri" => path_uri(), "%uri_brief" => path_uri(1), "%mailto" => $account->mail, "%date" => format_date(time()));
875
      $subject = strtr(variable_get("user_mail_pass_subject", t("Replacement login information for %username at %site")), $variables);
876
      $body = strtr(variable_get("user_mail_pass_body", t("%username,\n\nHere is your new password for %site.  You may now login to %uri". drupal_url(array("mod" => "user", "op" => "login"), "module") ." using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %uri". drupal_url(array("mod" => "user", "op" => "edit"), "module") .".\n\nYour new %site membership also enables 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);
877
878
      $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
879

880
      watchdog("user", "mail password: '". $account->name ."' &lt;". $account->mail ."&gt;");
Dries's avatar
   
Dries committed
881
882
883
884

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

Kjartan's avatar
Kjartan committed
886
887
888
    // 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
889
890
891
892
893
894
    }

    /*
    ** Display form:
    */

895
    $output .= "<p>". sprintf(t("Enter your username %sor%s your email address."), "<b><i>", "</i></b>") ."</p>";
Dries's avatar
   
Dries committed
896
897
898
    $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"));
899
900
901
902
903
    $output .= "<p>&raquo; ". lm(t("Log in"), array("mod" =>user, "op" => "login")) ."<br />";
    if (variable_get("user_register", 1)) {
      $output .= "&raquo; ". lm(t("Create new account"), array("mod" => "user", "op" => "register"));
    }
    $output .= "</p>";
Dries's avatar
   
Dries committed
904

Dries's avatar
   
Dries committed
905
    return form($output, "post", drupal_url(array ("mod" => "user"), "module"));
Dries's avatar
   
Dries committed
906
907
908
909
  }
}

function user_register($edit = array()) {
910
911
912
913
914
915
916
  global $user;

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

  if ($user->uid) {
Dries's avatar
   
Dries committed
917
    drupal_goto(drupal_url(array("mod" => "user", "op" => "edit"), "module"));
918
  }
Dries's avatar
   
Dries committed
919
920
921
922
923
924
925
926
927

  if ($edit["name"] && $edit["mail"]) {
    if ($error = user_validate_name($edit["name"])) {
      // do nothing
    }
    else if ($error = user_validate_mail($edit["mail"])) {
      // do nothing
    }
    else if (user_deny("user", $edit["name"])) {
Dries's avatar
   
Dries committed
928
      $error = t("The name '%s' has been denied access.", array("%s" => $edit["name"]));
Dries's avatar
   
Dries committed
929
930
    }
    else if (user_deny("mail", $edit["mail"])) {
Dries's avatar
   
Dries committed
931
      $error = t("The e-mail address '%s' has been denied access.", array("%s" => $edit["mail"]));
Dries's avatar
   
Dries committed
932
    }
Dries's avatar
   
Dries committed
933
934
    else if (db_num_rows(db_query("SELECT name FROM users WHERE LOWER(name) = LOWER('%s')", $edit["name"])) > 0) {
      $error = t("The name '%s' is already taken.", array("%s" => $edit["name"]));
Dries's avatar
   
Dries committed
935
    }
Dries's avatar
   
Dries committed
936
937
    else if (db_num_rows(db_query("SELECT mail FROM users WHERE LOWER(mail) = LOWER('%s')", $edit["mail"])) > 0) {
      $error = t("The e-mail address '%s' is already taken.", array("%s" => $edit["mail"]));
Dries's avatar
   
Dries committed
938
    }
Dries's avatar
   
Dries committed
939
    else if (variable_get("user_register", 1) == 0) {
Dries's avatar
   
Dries committed
940
941
942
      $error = t("Public registrations have been disabled by the site administrator.");
    }
    else {
Dries's avatar
   
Dries committed
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
      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
958
959
960
961
962
963
964
    }
  }

  if ($success) {

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

965
    $from = variable_get("site_mail", ini_get("sendmail_from"));
Dries's avatar
   
Dries committed
966
967
    $pass = user_password();

968
    // create new user account, noting whether administrator approval is required
969
    $account = user_save("", array_merge(array("name" => $edit["name"], "pass" => $pass, "init" => $edit["mail"], "mail" => $edit["mail"], "rid" => _user_authenticated_id(), "status" => (variable_get("user_register", 1) == 1 ? 1 : 0)), $data));
Dries's avatar
   
Dries committed
970

971
    $variables = array("%username" => $edit["name"], "%site" => variable_get("site_name", "drupal"), "%password" => $pass, "%uri" => path_uri(), "%uri_brief" => path_uri(1), "%mailto" => $edit["mail"], "%date" => format_date(time()));
972
973

    //the first user may login immediately, and receives a customized welcome email.
974
    if ($account->uid == 1) {
Kjartan's avatar
Kjartan committed
975
      user_mail($edit["mail"], t("drupal user account details for %s", array("%s" => $edit["name"])), strtr(t("%username,\n\nYou may now login to %uri using the following username and password:\n\n  username: %username\n  password: %password\n\nAfter logging in, you may wish to visit the following pages:\n\nAdministration: %uriadmin.php\nEdit user account: %uri". drupal_url(array("mod" => "user", "op" => "edit"), "module") ."\n\n--drupal"), $variables), "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
976
977
      // 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>";
978
      $output .= form_hidden("name", $account->name);
979
980
981
982
983
      $output .= form_hidden("pass", $pass);
      $output .= form_submit(t("Log in"));
      return form($output);
    }
    else {
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
      if ($account->status) {
        /*
        ** Create new user account, no administrator approval required:
        */

        $subject = strtr(variable_get("user_mail_welcome_subject", t("User account details for %username at %site")), $variables);
        $body = strtr(variable_get("user_mail_welcome_body", t("%username,\n\nThank you for registering at %site. You may now login to %uri". drupal_url(array("mod" => "user", "op" => "login"), "module") ." 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);
        user_mail($edit["mail"], $subject, $body, "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
        return t("Your password and further instructions have been sent to your e-mail address.");
      }
      else {
        /*
        ** Create new user account, administrator approval required:
        */
        $subject = strtr(variable_get("user_mail_welcome_subject", t("User account details for %username at %site")), $variables);
        $body = strtr(variable_get("user_mail_welcome_body", t("%username,\n\nThank you for registering at %site. Your account will have to be approved by the site administrator. You may now login to %uri". drupal_url(array("mod" => "user", "op" => "login"), "module") ." 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);
        user_mail($edit["mail"], $subject, $body, "From: $from\nReply-to: $from\nX-Mailer: Drupal\nReturn-path: $from\nErrors-to: $from");
        user_mail(variable_get("site_mail", ini_get("sendmail_from")), $subject, t("%u has applied for an account.\n\n%uri", array("%u" => $account->name, "%uri" => path_uri() . drupal_url(array("mod" => "user", "op" => "edit", "id" => $account->uid), "admin"))), "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.");
      }
1004
    }
Dries's avatar
   
Dries committed
1005
1006
1007
  }
  else {
    if ($error) {
Kjartan's avatar
Kjartan committed
1008
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
   
Dries committed
1009
    }
1010
  }
Dries's avatar
   
Dries committed
1011

1012
1013
1014
1015
  // display the registration form
  $affiliates = user_auth_help_links();
  if (array_count_values($affiliates) > 1) {
    $affiliates = implode(", ", $affiliates);
1016
    $output .= "<p>" . t("Note: If you have an account with one of our affiliates (%s), you may ". lm("login now", array("mod" => "user", "op" => "login")) ." instead of registering.", array("%s" => $affiliates)) ."</p>";
1017
1018
1019
1020
1021
1022
  }
  $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
1023
    }
Dries's avatar
   
Dries committed
1024
  }
1025
  $output .= form_submit(t("Create new account"));
1026
1027
  $output .= "<p>&raquo; ". lm(t("E-mail new password"), array("mod" => "user", "op" => "password")). "<br />";
  $output .= "&raquo; " .lm(t("Log in"), array("mod" => "user", "op" => "login")). "</p>";
Kjartan's avatar
Kjartan committed
1028

1029
  return form($output);
Dries's avatar
   
Dries committed
1030
1031
}

Kjartan's avatar
Kjartan committed
1032
1033
1034

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

Kjartan's avatar
Kjartan committed
1036
  if ($edit["confirm"]) {
1037
    watchdog(user,"$user->name deactivated her own account.");
Kjartan's avatar
Kjartan committed
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
    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
1050
function user_edit($edit = array()) {
1051
  global $user, $languages;
Dries's avatar
   
Dries committed
1052
1053
1054
1055
1056
1057
1058
1059
1060

  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
      }
Dries's avatar
   
Dries committed
1061
1062
      else if (db_num_rows(db_query("SELECT uid FROM users WHERE uid != '$user->uid' AND LOWER(name) = LOWER('%s')", $edit["name"])) > 0) {
        $error = t("The name '%s' is already taken.", array("%s" => $edit["name"]));
Dries's avatar
   
Dries committed
1063
      }
Dries's avatar
   
Dries committed
1064
1065
      else if ($edit["mail"] && db_num_rows(db_query("SELECT uid FROM users WHERE uid != '$user->uid' AND LOWER(mail) = LOWER('%s')", $edit["mail"])) > 0) {
        $error = t("The e-mail address '%s' is already taken.", array("%s" => $edit["mail"]));
Dries's avatar
   
Dries committed
1066
1067
      }
      else if ($user->uid) {
Dries's avatar
   
Dries committed
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
        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
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
        /*
        ** 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
1097
1098
1099
1100
        if (!$error) {
          /*
          ** Save user information:
          */
Dries's avatar
   
Dries committed
1101

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

1104
          $output .= t("Your user information changes have been saved.");
Dries's avatar
   
Dries committed
1105
        }
Dries's avatar
   
Dries committed
1106
1107
1108
1109
      }
    }

    if ($error) {
Kjartan's avatar
Kjartan committed
1110
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
   
Dries committed
1111
1112
    }

Kjartan's avatar
Kjartan committed
1113
1114
1115
1116
1117
1118
    if (!$edit) {
      $edit = object2array($user);
    }

    $output .= form_textfield(t("Username"), "name", $edit["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", $edit["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
1119

Dries's avatar
   
Dries committed
1120
1121
1122
1123
1124
1125
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "edit_form", $edit, $user);
      }
    }

Kjartan's avatar
Kjartan committed
1126
    $output .= form_textfield(t("Homepage"), "homepage", $edit["homepage"], 30, 55, t("Optional") .". ". t("Make sure you enter a fully qualified URL: remember to include \"http://\"."));
1127
    foreach (theme_list() as $key => $value) {
Kjartan's avatar
Kjartan committed
1128
      $options .= "$value[type]<option value=\"$key\"". (($edit["theme"] == $key) ? " selected=\"selected\"" : "") .">$key - $value->description</option>\n";
1129
    }
Dries's avatar
   
Dries committed
1130
1131
    $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 .")";
Kjartan's avatar
Kjartan committed
1132
1133
1134
    $output .= form_select(t("Timezone"), "timezone", $edit["timezone"], $zones, t("Select what time you currently have and your timezone settings will be set appropriate."));
    $output .= form_select(t("Language"), "language", $edit["language"], $languages, t("Selecting a different language will change the language of the site."));
    $output .= form_textarea(t("Signature"), "signature", $edit["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
1135
    $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
1136
    $output .= form_submit(t("Save user information"));
1137

Dries's avatar
   
Dries committed
1138
1139
    $output = form($output);
  }
Dries's avatar
   
Dries committed
1140
1141
1142
  else {
    $output = user_login();
  }
Dries's avatar
   
Dries committed
1143
1144
1145
1146
1147

  return $output;
}

function user_menu() {
Dries's avatar
   
Dries committed
1148
1149
1150
  $links[] = lm(t("view user information"), array("mod" => "user", "op" => "view"));
  $links[] = lm(t("edit user information"), array("mod" => "user", "op" => "edit"));
  $links[] = lm(t("delete account"), array("mod" => "user", "op" => "delete"));
Dries's avatar
   
Dries committed
1151
1152
1153
1154
1155

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

function user_view($uid = 0) {
1156
  global $theme, $user;
Dries's avatar
   
Dries committed
1157
1158
1159
1160
1161
1162
1163
1164

  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
1165
1166
1167
1168
1169
1170
1171

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

Kjartan's avatar
Kjartan committed
1172
    $output .= form_item(t("Homepage"), "<a href=\"$user->homepage\">$user->homepage</a>");
Dries's avatar
   
Dries committed
1173
1174
1175
1176
1177
1178
1179
1180
1181
    $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));
Kjartan's avatar
Kjartan committed
1182
    $output .= form_item(t("Homepage"), "<a href=\"$account->homepage\">$account->homepage</a>");
Dries's avatar
   
Dries committed
1183

Dries's avatar
   
Dries committed
1184
1185
1186
1187
1188
1189
    foreach (module_list() as $module) {
      if (module_hook($module, "user")) {
        $output .= module_invoke($module, "user", "view_public", "", $account);
      }
    }

Dries's avatar
   
Dries committed
1190
1191
1192
1193
1194
1195
1196
    $theme->header();
    $theme->box(t("View user information"), $output);
    $theme->footer();
  }
  else {
    $theme->header();
    $theme->box(t("Log in"), user_login());
1197
1198
1199
    if (variable_get("user_register", 1)) {
      $theme->box(t("Create new user account"), user_register());
    }
Dries's avatar
   
Dries committed
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
    $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":
1217
      $output = user_register($edit);
Dries's avatar
   
Dries committed
1218
      $theme->header();
1219
1220
1221
1222
1223
1224
      if (variable_get("user_register", 1)) {
        $theme->box(t("Create new account"), $output);
      }
      else {
        print message_access();
      }
Dries's avatar
   
Dries committed
1225
1226
1227
1228
1229
1230
1231
1232
1233
      $theme->footer();
      break;
    case t("Log in"):
    case "login":
      $output = user_login($edit);
      $theme->header();
      $theme->box(t("Log in"), $output);
      $theme->footer();
      break;
1234
    case t("Delete account"):
Kjartan's avatar
Kjartan committed
1235
1236
1237
1238
1239
1240
1241
    case t("delete");
      $output = user_delete();
      $theme->header();
      $theme->box(t("User account"), user_menu());
      $theme->box(t("Delete account"), $output);
      $theme->footer();
      break;
1242
    case t("Save user information"):
Dries's avatar
   
Dries committed
1243
1244
    case "edit":
      $output = user_edit($edit);
Kjartan's avatar
Kjartan committed
1245
      $theme = theme_init();
Dries's avatar
   
Dries committed
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
      $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.");
1274
1275
1276
1277
  $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, %date");
  $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 %uri". drupal_url(array("mod" => "user", "op" => "login"), "module") ." using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %uri". drupal_url(array("mod" => "user", "op" => "edit"), "module") ."\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");
  $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, %date");
  $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 %uri". drupal_url(array("mod" => "user", "op" => "login"), "module") ." using the following username and password:\n\nusername: %username\npassword: %password\n\nAfter logging in, you may wish to change your password at %uri". drupal_url(array("mod" => "user", "op" => "edit"), "module") ."\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
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
  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
    }
Dries's avatar
   
Dries committed
1317
1318
    else if (db_num_rows(db_query("SELECT name FROM users WHERE LOWER(name) = LOWER('%s')", $edit["name"])) > 0) {
      $error = t("The name '%s' is already taken.", array("%s" => $edit["name"]));
Dries's avatar
   
Dries committed
1319
    }
Dries's avatar
   
Dries committed
1320
1321
    else if (db_num_rows(db_query("SELECT mail FROM users WHERE LOWER(mail) = LOWER('%s')", $edit["mail"])) > 0) {
      $error = t("The e-mail address '%s' is already taken.", array("%s" => $edit["mail"]));
Dries's avatar
   
Dries committed
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
    }
    else {
      $success = 1;
    }
  }

  if ($success) {

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

1332
    user_save("", array("name" => $edit["name"], "pass" => $edit["pass"], "init" => $edit["mail"], "mail" => $edit["mail"], "rid" => _user_authenticated_id(), "status" => 1));
Dries's avatar
   
Dries committed
1333
1334
1335
1336
1337
1338

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

    if ($error) {
Kjartan's avatar
Kjartan committed
1339
      $output .= "<p><span style=\"color: red;\" class=\"error\">". check_output($error) ."</span></p>";
Dries's avatar
   
Dries committed
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
    }

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

1354
  $output .= "<small>". la(t("e-mail rules"), array("mod" => "user", "op" => "access", "type" => "mail")) ." :: ". la(t("username rules"), array("mod" => "user", "op" => "access", "type" => "user")) ."</small><hr />";  // irc rules, too!
Dries's avatar
   
Dries committed
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364

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

  if ($op == "Add rule") {
Dries's avatar
   
Dries committed
1365
    db_query("INSE