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

Dries's avatar
   
Dries committed
4
5
6
7
8
/**
 * @file
 * Enables the user registration and login system.
 */

Dries's avatar
Dries committed
9
10
11
/**
 * Invokes hook_user() in every module.
 *
12
 * We cannot use module_invoke() for this, because the arguments need to
Dries's avatar
Dries committed
13
14
 * be passed by reference.
 */
15
function user_module_invoke($type, &$array, &$user, $category = NULL) {
Dries's avatar
   
Dries committed
16
17
  foreach (module_list() as $module) {
    $function = $module .'_user';
18
19
20
    if (function_exists($function)) {
      $function($type, $array, $user, $category);
    }
Dries's avatar
   
Dries committed
21
22
23
  }
}

Dries's avatar
   
Dries committed
24
function user_external_load($authname) {
Dries's avatar
   
Dries committed
25
  $result = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
   
Dries committed
26

Dries's avatar
   
Dries committed
27
28
  if ($user = db_fetch_object($result)) {
    return user_load($user);
Dries's avatar
   
Dries committed
29
30
31
32
33
34
  }
  else {
    return 0;
  }
}

Dries's avatar
Dries committed
35
36
37
38
39
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
40
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
41
42
 *
 * @return
43
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
Dries's avatar
Dries committed
44
 */
Dries's avatar
   
Dries committed
45
function user_load($array = array()) {
Dries's avatar
Dries committed
46
  // Dynamically compose a SQL query:
47
  $query = array();
48
  $params = array();
49

Dries's avatar
   
Dries committed
50
  foreach ($array as $key => $value) {
51
52
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
53
      $params[] = $value;
54
    }
55
56
57
58
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
   
Dries committed
59
    else {
60
      $query[]= "LOWER($key) = LOWER('%s')";
61
      $params[] = $value;
Dries's avatar
   
Dries committed
62
63
    }
  }
64
  $result = db_query('SELECT * FROM {users} u WHERE ' . implode(' AND ', $query), $params);
Dries's avatar
   
Dries committed
65

66
67
68
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
Dries's avatar
   
Dries committed
69

70
    $user->roles = array();
71
72
73
74
75
76
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
77
78
79
80
    $result = db_query('SELECT r.rid, r.name FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d', $user->uid);
    while ($role = db_fetch_object($result)) {
      $user->roles[$role->rid] = $role->name;
    }
81
    user_module_invoke('load', $array, $user);
82
83
  }
  else {
84
    $user = FALSE;
Dries's avatar
   
Dries committed
85
  }
Dries's avatar
   
Dries committed
86
87
88
89

  return $user;
}

90
91
92
93
94
95
96
97
/**
 * Save changes to a user account.
 *
 * @param $account
 *   The $user object for the user to modify.
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
98
 *   Setting a field to null deletes it from the data column.
99
100
101
102
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
103
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
104
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
105
  $user_fields = user_fields();
Dries's avatar
   
Dries committed
106
  if ($account->uid) {
107
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
   
Dries committed
108

Dries's avatar
Dries committed
109
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
Dries's avatar
   
Dries committed
110
    foreach ($array as $key => $value) {
111
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
   
Dries committed
112
113
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
   
Dries committed
114
      }
115
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
116
        if (in_array($key, $user_fields)) {
117
          // Save standard fields
Dries's avatar
   
Dries committed
118
119
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
   
Dries committed
120
        }
Dries's avatar
   
Dries committed
121
        else if ($key != 'roles') {
122
          // Roles is a special case: it used below.
123
124
125
126
127
128
          if ($value === null) {
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
   
Dries committed
129
        }
Dries's avatar
   
Dries committed
130
131
      }
    }
132
    $query .= "data = '%s' ";
Dries's avatar
   
Dries committed
133
    $v[] = serialize($data);
Dries's avatar
   
Dries committed
134

135
    db_query("UPDATE {users} SET $query WHERE uid = %d", array_merge($v, array($account->uid)));
Dries's avatar
   
Dries committed
136

137
    // Reload user roles if provided
138
    if (is_array($array['roles'])) {
Dries's avatar
Dries committed
139
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $account->uid);
Dries's avatar
   
Dries committed
140

141
      foreach (array_keys($array['roles']) as $rid) {
142
143
144
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
        }
145
      }
Dries's avatar
   
Dries committed
146
147
    }

148
    // Delete a blocked user's sessions to kick them if they are online.
149
    if (isset($array['status']) && $array['status'] == 0) {
150
      db_query('DELETE FROM {sessions} WHERE uid = %d', $account->uid);
151
152
    }

153
    // Refresh user object
Dries's avatar
   
Dries committed
154
    $user = user_load(array('uid' => $account->uid));
Dries's avatar
   
Dries committed
155
156
  }
  else {
Dries's avatar
   
Dries committed
157
    $array['created'] = time();
Dries's avatar
Dries committed
158
    $array['uid'] = db_next_id('{users}_uid');
Dries's avatar
   
Dries committed
159

160
161
162
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there. We cannot invoke hook_user('insert') here
    // because we don't have a fully initialized user object yet.
Dries's avatar
   
Dries committed
163
    foreach ($array as $key => $value) {
164
165
166
167
      switch($key) {
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
   
Dries committed
168
          $s[] = "'%s'";
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
          break;          
        case 'uid':        case 'mode':     case 'sort':
        case 'threshold':  case 'created':  case 'access':
        case 'login':      case 'status':
          $fields[] = $key;
          $values[] = $value;
          $s[] = "%d";
          break;
        default:
          if (substr($key, 0, 4) !== 'auth' && in_array($key, $user_fields)) {
            $fields[] = $key;
            $values[] = $value;
            $s[] = "'%s'";
          }
          break;
Dries's avatar
   
Dries committed
184
185
      }
    }
Dries's avatar
Dries committed
186
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
Dries's avatar
   
Dries committed
187

Dries's avatar
Dries committed
188
189
    // Reload user roles (delete just to be safe).
    db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
190
    foreach ((array)$array['roles'] as $rid) {
Dries's avatar
Dries committed
191
      db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
Dries's avatar
   
Dries committed
192
193
    }

194
195
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
196

197
198
199
200
201
    user_module_invoke('insert', $array, $user, $category);

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
202
      if ((substr($key, 0, 4) !== 'auth') && ($key != 'roles') && (!in_array($key, $user_fields)) && ($value !== null)) {
203
204
205
206
207
208
209
        $data[$key] = $value;
      }
    }
    db_query("UPDATE {users} SET data = '%s' WHERE uid = %d", serialize($data), $user->uid);

    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
210
211
  }

212
  // Save distributed authentication mappings
213
  $authmaps = array();
Dries's avatar
   
Dries committed
214
  foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
215
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
   
Dries committed
216
217
218
      $authmaps[$key] = $value;
    }
  }
219
  if (sizeof($authmaps) > 0) {
Dries's avatar
   
Dries committed
220
    user_set_authmaps($user, $authmaps);
Dries's avatar
   
Dries committed
221
222
223
224
225
  }

  return $user;
}

Dries's avatar
Dries committed
226
227
228
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
229
function user_validate_name($name) {
230
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
231
232
233
  if (substr($name, 0, 1) == ' ') return t('The username cannot begin with a space.');
  if (substr($name, -1) == ' ') return t('The username cannot end with a space.');
  if (ereg('  ', $name)) return t('The username cannot contain multiple spaces in a row.');
234
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
235
236
237
238
239
240
241
242
243
244
245
  if (preg_match('/[\x{80}-\x{A0}'.          // Non-printable ISO-8859-1 + NBSP
                   '\x{AD}'.                 // Soft-hyphen
                   '\x{2000}-\x{200F}'.      // Various space characters
                   '\x{2028}-\x{202F}'.      // Bidirectional text overrides
                   '\x{205F}-\x{206F}'.      // Various text hinting characters
                   '\x{FEFF}'.               // Byte order mark
                   '\x{FF01}-\x{FF60}'.      // Full-width latin
                   '\x{FFF9}-\x{FFFD}]/u',   // Replacement characters
                   $name)) {
    return t('The username contains an illegal character.');
  }
Dries's avatar
Dries committed
246
  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.');
247
  if (strlen($name) > 56) return t('The username %name is too long: it must be less than 56 characters.', array('%name' => theme('placeholder', $name)));
Dries's avatar
   
Dries committed
248
249
250
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
251
  if (!$mail) return t('You must enter an e-mail address.');
252
  if (!valid_email_address($mail)) {
253
    return t('The e-mail address %mail is not valid.', array('%mail' => theme('placeholder', $mail)));
Dries's avatar
   
Dries committed
254
255
256
  }
}

Dries's avatar
   
Dries committed
257
function user_validate_picture($file, &$edit, $user) {
258
  global $form_values;
Dries's avatar
Dries committed
259
  // Initialize the picture:
260
  $form_values['picture'] = $user->picture;
Dries's avatar
   
Dries committed
261

Dries's avatar
Dries committed
262
263
  // Check that uploaded file is an image, with a maximum file size
  // and maximum height/width.
264
  $info = image_get_info($file->filepath);
Dries's avatar
Dries committed
265
  list($maxwidth, $maxheight) = explode('x', variable_get('user_picture_dimensions', '85x85'));
Dries's avatar
   
Dries committed
266

267
  if (!$info || !$info['extension']) {
268
    form_set_error('picture_upload', t('The uploaded file was not an image.'));
Dries's avatar
   
Dries committed
269
  }
270
271
  else if (image_get_toolkit()) {
    image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
Dries's avatar
   
Dries committed
272
  }
273
  else if (filesize($file->filepath) > (variable_get('user_picture_file_size', '30') * 1000)) {
274
    form_set_error('picture_upload', t('The uploaded image is too large; the maximum file size is %size kB.', array('%size' => variable_get('user_picture_file_size', '30'))));
275
  }
276
  else if ($info['width'] > $maxwidth || $info['height'] > $maxheight) {
277
    form_set_error('picture_upload', t('The uploaded image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => variable_get('user_picture_dimensions', '85x85'))));
Dries's avatar
   
Dries committed
278
  }
279
280

  if (!form_get_errors()) {
281
    if ($file = file_save_upload('picture_upload', variable_get('user_picture_path', 'pictures') .'/picture-'. $user->uid . '.' . $info['extension'], 1)) {
282
      $form_values['picture'] = $file->filepath;
283
284
    }
    else {
285
      form_set_error('picture_upload', t("Failed to upload the picture image; the %directory directory doesn't exist.", array('%directory' => '<em>'. variable_get('user_picture_path', 'pictures') .'</em>')));
286
    }
Dries's avatar
   
Dries committed
287
288
289
  }
}

Dries's avatar
Dries committed
290
291
292
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
   
Dries committed
293
294
295
296
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
  // password.  Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two.  The same is true
297
298
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
299

300
301
  // Zero-based count of characters in the allowable list:
  $len = strlen($allowable_characters) - 1;
Dries's avatar
   
Dries committed
302

Dries's avatar
Dries committed
303
304
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
305

Dries's avatar
Dries committed
306
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
307
308
309
310
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
311
    $pass .= $allowable_characters[mt_rand(0, $len)];
Dries's avatar
   
Dries committed
312
313
314
  }

  return $pass;
Dries's avatar
   
Dries committed
315
316
}

Dries's avatar
Dries committed
317
318
319
320
321
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
322
323
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
324
325
 *
 * @return
326
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
327
328
329
330
331
 *
 * All permission checks in Drupal should go through this function. This
 * way, we guarantee consistent behavior, and ensure that the superuser
 * can perform all actions.
 */
Dries's avatar
   
Dries committed
332
function user_access($string, $account = NULL) {
Dries's avatar
   
Dries committed
333
  global $user;
Dries's avatar
   
Dries committed
334
  static $perm = array();
Dries's avatar
   
Dries committed
335

336
337
338
339
  if (is_null($account)) {
    $account = $user;
  }

340
  // User #1 has all privileges:
341
  if ($account->uid == 1) {
342
    return TRUE;
Dries's avatar
   
Dries committed
343
344
  }

Dries's avatar
Dries committed
345
346
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
347
  if (!isset($perm[$account->uid])) {
348
    $result = db_query("SELECT DISTINCT(p.perm) FROM {role} r INNER JOIN {permission} p ON p.rid = r.rid WHERE r.rid IN (%s)", implode(',', array_keys($account->roles)));
Dries's avatar
   
Dries committed
349

Steven Wittens's avatar
Steven Wittens committed
350
    $perm[$account->uid] = '';
Dries's avatar
   
Dries committed
351
    while ($row = db_fetch_object($result)) {
352
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
   
Dries committed
353
    }
Dries's avatar
   
Dries committed
354
  }
355

356
  if (isset($perm[$account->uid])) {
357
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
358
  }
359

360
  return FALSE;
Dries's avatar
   
Dries committed
361
362
}

363
364
365
366
367
368
369
370
371
372
373
374
/**
 * Checks for usernames blocked by user administration
 *
 * @return boolean true for blocked users, false for active
 */
function user_is_blocked($name) {
  $allow = db_fetch_object(db_query("SELECT * FROM {users} WHERE status = 1 AND name = LOWER('%s')", $name));
  $deny  = db_fetch_object(db_query("SELECT * FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));

  return $deny && !$allow;
}

Dries's avatar
Dries committed
375
376
377
/**
 * Send an e-mail message.
 */
Dries's avatar
   
Dries committed
378
function user_mail($mail, $subject, $message, $header) {
Dries's avatar
Dries committed
379
  if (variable_get('smtp_library', '') && file_exists(variable_get('smtp_library', ''))) {
380
   include_once './' . variable_get('smtp_library', '');
381
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
   
Dries committed
382
383
  }
  else {
384
385
    /*
    ** Note: if you are having problems with sending mail, or mails look wrong
386
    ** when they are received you may have to modify the str_replace to suit
387
388
389
390
    ** your systems.
    **  - \r\n will work under dos and windows.
    **  - \n will work for linux, unix and BSDs.
    **  - \r will work for macs.
Dries's avatar
   
Dries committed
391
392
393
394
    **
    ** According to RFC 2646, it's quite rude to not wrap your e-mails:
    **
    ** "The Text/Plain media type is the lowest common denominator of
395
    ** Internet e-mail, with lines of no more than 997 characters (by
Dries's avatar
   
Dries committed
396
397
398
399
400
401
402
    ** convention usually no more than 80), and where the CRLF sequence
    ** represents a line break [MIME-IMT]."
    **
    ** CRLF === \r\n
    **
    ** http://www.rfc-editor.org/rfc/rfc2646.txt
    **
403
    */
Dries's avatar
   
Dries committed
404
405
    return mail(
      $mail,
Dries's avatar
   
Dries committed
406
      mime_header_encode($subject),
Dries's avatar
Dries committed
407
      str_replace("\r", '', $message),
Dries's avatar
   
Dries committed
408
      "MIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8; format=flowed\nContent-transfer-encoding: 8Bit\n" . $header
Dries's avatar
   
Dries committed
409
    );
Dries's avatar
   
Dries committed
410
411
412
  }
}

Dries's avatar
   
Dries committed
413
414
function user_fields() {
  static $fields;
Dries's avatar
   
Dries committed
415

Dries's avatar
   
Dries committed
416
  if (!$fields) {
Dries's avatar
Dries committed
417
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
418
419
420
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
   
Dries committed
421
422
    else {
      // Make sure we return the default fields at least
423
      $fields = array('uid', 'name', 'pass', 'mail', 'picture', 'mode', 'sort', 'threshold', 'theme', 'signature', 'created', 'access', 'login', 'status', 'timezone', 'language', 'init', 'data');
Dries's avatar
   
Dries committed
424
    }
Dries's avatar
   
Dries committed
425
  }
Dries's avatar
   
Dries committed
426

Dries's avatar
   
Dries committed
427
  return $fields;
Dries's avatar
   
Dries committed
428
429
}

Dries's avatar
Dries committed
430
431
432
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
433
function user_perm() {
434
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
   
Dries committed
435
436
}

Dries's avatar
Dries committed
437
438
439
440
441
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
   
Dries committed
442
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
443
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
444
445
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
   
Dries committed
446
447
448
  }
}

Dries's avatar
Dries committed
449
450
451
/**
 * Implementation of hook_search().
 */
452
453
454
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
455
456
457
      if (user_access('access user profiles')) {
        return t('users');
      }
458
    case 'search':
459
460
461
462
463
464
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
        $result = pager_query("SELECT * FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
        while ($account = db_fetch_object($result)) {
465
          $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid));
466
467
        }
        return $find;
468
      }
Dries's avatar
   
Dries committed
469
470
471
  }
}

Dries's avatar
Dries committed
472
473
474
/**
 * Implementation of hook_user().
 */
475
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
476
  if ($type == 'view') {
477
478
479
480
481
482
    $items[] = array('title' => t('Member for'),
      'value' => format_interval(time() - $user->created),
      'class' => 'member',
    );

    return array(t('History') => $items);
Dries's avatar
Dries committed
483
  }
484
485
486
487
488
  if ($type == 'form' && $category == 'account') {
    return user_edit_form(arg(1), $edit);
  }

  if ($type == 'validate' && $category == 'account') {
489
    return _user_edit_validate(arg(1), $edit);
490
491
  }

492
493
494
495
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

496
497
498
  if ($type == 'categories') {
    return array(array('name' => 'account', 'title' => t('account settings'), 'weight' => 1));
  }
Dries's avatar
Dries committed
499
500
}

Dries's avatar
Dries committed
501
502
503
/**
 * Implementation of hook_block().
 */
504
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
505
506
  global $user;

Dries's avatar
Dries committed
507
508
509
510
511
  if ($op == 'list') {
     $blocks[0]['info'] = t('User login');
     $blocks[1]['info'] = t('Navigation');
     $blocks[2]['info'] = t('Who\'s new');
     $blocks[3]['info'] = t('Who\'s online');
512

513
     return $blocks;
514
  }
515
516
  else if ($op == 'configure' && $delta == 3) {
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
517
518
    $form['user_block_seconds_online'] = array('#type' => 'select', '#title' => t('User activity'), '#default_value' => variable_get('user_block_seconds_online', 900), '#options' => $period, '#description' => t('A user is considered online for this long after they have last viewed a page.'));
    $form['user_block_max_list_count'] = array('#type' => 'select', '#title' => t('User list length'), '#default_value' => variable_get('user_block_max_list_count', 10), '#options' => drupal_map_assoc(array(0, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100)), '#description' => t('Maximum number of currently online users to display.'));
519

520
    return $form;
521
522
523
524
525
526
  }
  else if ($op == 'save' && $delta == 3) {
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
  else if ($op == 'view') {
Dries's avatar
   
Dries committed
527
528
    $block = array();

Dries's avatar
   
Dries committed
529
530
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
531
532
        // For usability's sake, avoid showing two login forms on one page.
        if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
533
          $form['#action'] = url($_GET['q'], drupal_get_destination());
534
          $form['#id'] = 'user-login-form';
Dries's avatar
Dries committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
          $form['name'] = array('#type' => 'textfield',
            '#title' => t('Username'),
            '#maxlength' => 60,
            '#size' => 15,
            '#required' => TRUE,
          );
          $form['pass'] = array('#type' => 'password',
            '#title' => t('Password'),
            '#size' => 15,
            '#required' => TRUE,
          );
          $form['submit'] = array('#type' => 'submit',
            '#value' => t('Log in'),
          );
549

Dries's avatar
Dries committed
550
551
          if (variable_get('user_register', 1)) {
            $items[] = l(t('Create new account'), 'user/register', array('title' => t('Create a new user account.')));
Dries's avatar
   
Dries committed
552
          }
Dries's avatar
Dries committed
553
          $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
554
          $form['links'] = array('#value' => theme('item_list', $items));
Dries's avatar
   
Dries committed
555

556
          $output .= drupal_get_form('user_login_block', $form, 'user_login');
557

Dries's avatar
Dries committed
558
559
          $block['subject'] = t('User login');
          $block['content'] = $output;
Dries's avatar
   
Dries committed
560
        }
Dries's avatar
Dries committed
561
        return $block;
Dries's avatar
Dries committed
562

563
      case 1:
Dries's avatar
   
Dries committed
564
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
565
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
566
           $block['content'] = $menu;
Dries's avatar
   
Dries committed
567
        }
568
        return $block;
Dries's avatar
Dries committed
569

Dries's avatar
   
Dries committed
570
      case 2:
571
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
572
          // Retrieve a list of new users who have subsequently accessed the site successfully.
573
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', 0, 5);
574
          while ($account = db_fetch_object($result)) {
575
            $items[] = $account;
576
          }
Dries's avatar
Dries committed
577
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
578

Dries's avatar
Dries committed
579
580
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
581
        }
Dries's avatar
Dries committed
582
583
        return $block;

Dries's avatar
   
Dries committed
584
      case 3:
585
        if (user_access('access content')) {
Dries's avatar
Dries committed
586
587
          // Count users with activity in the past defined period.
          $time_period = variable_get('user_block_seconds_online', 2700);
Dries's avatar
   
Dries committed
588

Dries's avatar
Dries committed
589
          // Perform database queries to gather online user lists.
Dries's avatar
   
Dries committed
590
          $guests = db_fetch_object(db_query('SELECT COUNT(sid) AS count FROM {sessions} WHERE timestamp >= %d AND uid = 0', time() - $time_period));
591
          $users = db_query('SELECT uid, name, access FROM {users} WHERE access >= %d AND uid != 0 ORDER BY access DESC', time() - $time_period);
Dries's avatar
   
Dries committed
592
          $total_users = db_num_rows($users);
Dries's avatar
   
Dries committed
593

Dries's avatar
Dries committed
594
          // Format the output with proper grammar.
Dries's avatar
   
Dries committed
595
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
596
            $output = t('There is currently %members and %visitors online.', array('%members' => format_plural($total_users, '1 user', '%count users'), '%visitors' => format_plural($guests->count, '1 guest', '%count guests')));
Dries's avatar
   
Dries committed
597
598
          }
          else {
Dries's avatar
Dries committed
599
            $output = t('There are currently %members and %visitors online.', array('%members' => format_plural($total_users, '1 user', '%count users'), '%visitors' => format_plural($guests->count, '1 guest', '%count guests')));
Dries's avatar
   
Dries committed
600
601
          }

602
603
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
604
605
606
607
608
609
          $items = array();

          while ($max_users-- && $account = db_fetch_object($users)) {
            $items[] = $account;
          }

610
          $output .= theme('user_list', $items, t('Online users'));
611

Dries's avatar
Dries committed
612
613
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
   
Dries committed
614
        }
Dries's avatar
   
Dries committed
615
        return $block;
Dries's avatar
   
Dries committed
616
617
    }
  }
618
619
}

Dries's avatar
   
Dries committed
620
621
622
623
624
625
626
627
628
function theme_user_picture($account) {
  if (variable_get('user_pictures', 0)) {
    if ($account->picture && file_exists($account->picture)) {
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

629
    if (isset($picture)) {
Dries's avatar
Dries committed
630
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
631
      $picture = theme('image', $picture, $alt, $alt, '', false);
632
      if (!empty($account->uid)) {
633
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')), NULL, NULL, FALSE, TRUE);
Dries's avatar
   
Dries committed
634
635
636
637
638
639
640
      }

      return "<div class=\"picture\">$picture</div>";
    }
  }
}

641
642
643
/**
 * Theme a user page
 * @param $account the user object
644
645
646
647
648
 * @param $fields a multidimensional array for the fields, in the form of array (
 *   'category1' => array(item_array1, item_array2), 'category2' => array(item_array3,
 *    .. etc.). Item arrays are formatted as array(array('title' => 'item title',
 * 'value' => 'item value', 'class' => 'class-name'), ... etc.). Module names are incorporated
 * into the CSS class.
649
650
651
 *
 * @ingroup themeable
 */
Dries's avatar
Dries committed
652
function theme_user_profile($account, $fields) {
653
  $output = '<div class="profile">';
Dries's avatar
   
Dries committed
654
  $output .= theme('user_picture', $account);
655
  foreach ($fields as $category => $items) {
656
    if (strlen($category) > 0) {
657
      $output .= '<h2 class="title">'. $category .'</h2>';
658
    }
659
660
    $output .= '<dl>';
    foreach ($items as $item) {
661
      if (isset($item['title'])) {
662
        $output .= '<dt class="'. $item['class'] .'">'. $item['title'] .'</dt>';
663
664
      }
      $output .= '<dd class="'. $item['class'] .'">'. $item['value'] .'</dd>';
665
666
    }
    $output .= '</dl>';
Dries's avatar
Dries committed
667
  }
668
  $output .= '</div>';
Dries's avatar
   
Dries committed
669
670
671
672

  return $output;
}

673
674
675
676
677
678
679
/**
 * Make a list of users.
 * @param $items an array with user objects. Should contain at least the name and uid
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
680
681
682
683
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
684
  }
Dries's avatar
Dries committed
685
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
686
687
}

Dries's avatar
   
Dries committed
688
/**
Dries's avatar
   
Dries committed
689
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
690
 */
Dries's avatar
   
Dries committed
691
function user_menu($may_cache) {
Dries's avatar
   
Dries committed
692
  global $user;
Dries's avatar
   
Dries committed
693

Dries's avatar
   
Dries committed
694
  $items = array();
Dries's avatar
   
Dries committed
695

696
  $admin_access = user_access('administer users');
697
  $access_access = user_access('administer access control');
698
  $view_access = user_access('access user profiles');
Dries's avatar
   
Dries committed
699

Dries's avatar
   
Dries committed
700
  if ($may_cache) {
Dries's avatar
   
Dries committed
701
    $items[] = array('path' => 'user', 'title' => t('user account'),
702
      'callback' => 'user_login', 'access' => TRUE, 'type' => MENU_CALLBACK);
703

Steven Wittens's avatar
Steven Wittens committed
704
    $items[] = array('path' => 'user/autocomplete', 'title' => t('user autocomplete'),
705
      'callback' => 'user_autocomplete', 'access' => $view_access, 'type' => MENU_CALLBACK);
Steven Wittens's avatar
Steven Wittens committed
706

Steven Wittens's avatar
Steven Wittens committed
707
    // Registration and login pages.
Dries's avatar
   
Dries committed
708
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
709
      'callback' => 'user_login', 'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
   
Dries committed
710
    $items[] = array('path' => 'user/register', 'title' => t('register'),
711
      'callback' => 'user_register', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
   
Dries committed
712
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
713
      'callback' => 'user_pass', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
714
    $items[] = array('path' => 'user/reset', 'title' => t('reset password'),
715
      'callback' => 'user_pass_reset', 'access' => TRUE, 'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
716
717
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
718

Steven Wittens's avatar
Steven Wittens committed
719
    // Admin user pages
Dries's avatar
   
Dries committed
720
    $items[] = array('path' => 'admin/user', 'title' => t('users'),
721
      'callback' => 'user_admin', 'access' => $admin_access);
Dries's avatar
   
Dries committed
722
    $items[] = array('path' => 'admin/user/list', 'title' => t('list'),
Dries's avatar
   
Dries committed
723
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
724
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
725
      'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
   
Dries committed
726
      'type' => MENU_LOCAL_TASK);
727
    $items[] = array('path' => 'admin/settings/user', 'title' => t('users'),
728
      'callback' => 'user_configure');
729

Steven Wittens's avatar
Steven Wittens committed
730
    // Admin access pages
731
    $items[] = array('path' => 'admin/access', 'title' => t('access control'),
732
      'callback' => 'user_admin_perm', 'access' => $access_access);
733
    $items[] = array('path' => 'admin/access/permissions', 'title' => t('permissions'),
734
      'callback' => 'user_admin_perm', 'access' => $access_access,
Dries's avatar
   
Dries committed
735
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
736
    $items[] = array('path' => 'admin/access/roles', 'title' => t('roles'),
737
      'callback' => 'user_admin_role', 'access' => $access_access,
Dries's avatar
   
Dries committed
738
      'type' => MENU_LOCAL_TASK);
739
    $items[] = array('path' => 'admin/access/roles/edit', 'title' => t('edit role'),
740
      'callback' => 'user_admin_role', 'access' => $access_access,
741
      'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
742
    $items[] = array('path' => 'admin/access/rules', 'title' => t('access rules'),
743
      'callback' => 'user_admin_access', 'access' => $access_access,
744
745
      'type' => MENU_LOCAL_TASK, 'weight' => 10);
    $items[] = array('path' => 'admin/access/rules/list', 'title' => t('list'),
746
      'access' => $access_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
747
    $items[] = array('path' => 'admin/access/rules/add', 'title' => t('add rule'),
748
      'callback' => 'user_admin_access_add', 'access' => $access_access,
Dries's avatar
   
Dries committed
749
      'type' => MENU_LOCAL_TASK);
750
    $items[] = array('path' => 'admin/access/rules/check', 'title' => t('check rules'),
751
      'callback' => 'user_admin_access_check', 'access' => $access_access,
Dries's avatar
   
Dries committed
752
      'type' => MENU_LOCAL_TASK);
753
    $items[] = array('path' => 'admin/access/rules/edit', 'title' => t('edit rule'),
754
      'callback' => 'user_admin_access_edit', 'access' => $access_access,
755
      'type' => MENU_CALLBACK);
756
    $items[] = array('path' => 'admin/access/rules/delete', 'title' => t('delete rule'),
757
      'callback' => 'user_admin_access_delete', 'access' => $access_access,
758
      'type' => MENU_CALLBACK);
759

Dries's avatar
   
Dries committed
760
761
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
762
        'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
   
Dries committed
763
        'type' => MENU_LOCAL_TASK);
764
    }
Dries's avatar
   
Dries committed
765

Steven Wittens's avatar
Steven Wittens committed
766
    // Your personal page
Dries's avatar
   
Dries committed
767
768
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
769
        'callback' => 'user_view', 'callback arguments' => array(arg(1)), 'access' => TRUE,
770
        'type' => MENU_DYNAMIC_ITEM);
Dries's avatar
   
Dries committed
771
    }
Dries's avatar
   
Dries committed
772
773
774
775
776

    $items[] = array('path' => 'logout', 'title' => t('log out'),
      'access' => $user->uid != 0,
      'callback' => 'user_logout',
      'weight' => 10);
Dries's avatar
   
Dries committed
777
778
  }
  else {
Dries's avatar
   
Dries committed
779
    if (arg(0) == 'user' && is_numeric(arg(1))) {
780
      $account = user_load(array('uid' => arg(1)));
781

782
783
784
785
786
787
788
789
790
      if ($user !== FALSE) {
        // Always let a user view their own account
        $view_access |= $user->uid == arg(1);
        // Only admins can view blocked accounts
        $view_access &= $account->status || $admin_access; 

        $items[] = array('path' => 'user/'. arg(1), 'title' => t('user'),
          'type' => MENU_CALLBACK, 'callback' => 'user_view',
          'callback arguments' => array(arg(1)), 'access' => $view_access);        
791
792
793

        $items[] = array('path' => 'user/'. arg(1) .'/view', 'title' => t('view'),
          'access' => $view_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
794

795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
        $items[] = array('path' => 'user/'. arg(1) .'/edit', 'title' => t('edit'),
          'callback' => 'user_edit', 'access' => $admin_access || $user->uid == arg(1),
          'type' => MENU_LOCAL_TASK);
        $items[] = array('path' => 'user/'. arg(1) .'/delete', 'title' => t('delete'),
          'callback' => 'user_edit', 'access' => $admin_access,
          'type' => MENU_CALLBACK);

        if (arg(2) == 'edit') {
          if (($categories = _user_categories()) && (count($categories) > 1)) {
            foreach ($categories as $key => $category) {
              $items[] = array(
                'path' => 'user/'. arg(1) .'/edit/'. $category['name'],
                'title' => $category['title'],
                'type' => $category['name'] == 'account' ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
                'weight' => $category['weight'],
                'access' => ($admin_access || $user->uid == arg(1)));
            }
Dries's avatar
   
Dries committed
812
813
814
815
          }
        }
      }
    }
Dries's avatar
   
Dries committed
816
  }
Dries's avatar
   
Dries committed
817
818

  return $items;
Dries's avatar
   
Dries committed
819
820
}

Dries's avatar
Dries committed
821
822
823
824
/**
 * Accepts an user object, $account, or a DA name and returns an associative
 * array of modules and DA names. Called at external login.
 */
825
function user_get_authmaps($authname = NULL) {
Dries's avatar
   
Dries committed
826
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
   
Dries committed
827
828
829
830
831
832
833
834
835
836
837
838
839
  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) {
Dries's avatar
Dries committed
840
    $module = explode('_', $key, 2);
Dries's avatar
   
Dries committed
841
    if ($value) {
Dries's avatar
Dries committed
842
      db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module['1']);
Dries's avatar
   
Dries committed
843
844
      if (!db_affected_rows()) {
        db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
Dries's avatar
   
Dries committed
845
846
847
      }
    }
    else {
Dries's avatar
Dries committed
848
      db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module['1']);
Dries's avatar
   
Dries committed
849
850
851
852
853
    }
  }
}

function user_auth_help_links() {
854
  $links = array();
Dries's avatar
   
Dries committed
855
  foreach (module_list() as $module) {
Dries's avatar
Dries committed
856
    if (module_hook($module, 'auth')) {
Dries's avatar
   
Dries committed
857
      $links[] = l(module_invoke($module, 'info', 'name'), "user/help#$module");
Dries's avatar
   
Dries committed
858
859
860
861
862
863
864
    }
  }
  return $links;
}

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

865
866


867
function user_login($msg = '') {
Dries's avatar
   
Dries committed
868
  global $user, $base_url;
Dries's avatar
   
Dries committed
869

Dries's avatar
Dries committed
870
  // If we are already logged on, go to the user page instead.
Dries's avatar
   
Dries committed
871
  if ($user->uid) {
872
    drupal_goto('user/'. $user->uid);
Dries's avatar