user.module 89.6 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[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
71 72 73 74
    $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;
    }
75
    user_module_invoke('load', $array, $user);
76 77
  }
  else {
78
    $user = FALSE;
Dries's avatar
 
Dries committed
79
  }
Dries's avatar
 
Dries committed
80 81 82 83

  return $user;
}

84 85 86 87 88 89 90 91
/**
 * 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');
92
 *   Setting a field to null deletes it from the data column.
93 94 95 96
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
97
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
98
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
99
  $user_fields = user_fields();
Dries's avatar
 
Dries committed
100
  if ($account->uid) {
101
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
 
Dries committed
102

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

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

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

135
      foreach (array_keys($array['roles']) as $rid) {
136 137 138
        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);
        }
139
      }
Dries's avatar
 
Dries committed
140 141
    }

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

147
    // Refresh user object
Dries's avatar
 
Dries committed
148
    $user = user_load(array('uid' => $account->uid));
Dries's avatar
 
Dries committed
149 150
  }
  else {
Dries's avatar
 
Dries committed
151
    $array['created'] = time();
Dries's avatar
Dries committed
152
    $array['uid'] = db_next_id('{users}_uid');
Dries's avatar
 
Dries committed
153

154 155 156
    // 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
157
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
158
      if ($key == 'pass') {
Dries's avatar
 
Dries committed
159
        $fields[] = db_escape_string($key);
Dries's avatar
 
Dries committed
160 161
        $values[] = md5($value);
        $s[] = "'%s'";
Dries's avatar
 
Dries committed
162
      }
Dries's avatar
Dries committed
163
      else if (substr($key, 0, 4) !== 'auth') {
Kjartan's avatar
Kjartan committed
164
        if (in_array($key, $user_fields)) {
Dries's avatar
 
Dries committed
165
          $fields[] = db_escape_string($key);
Dries's avatar
 
Dries committed
166 167
          $values[] = $value;
          $s[] = "'%s'";
Dries's avatar
 
Dries committed
168
        }
Dries's avatar
 
Dries committed
169 170
      }
    }
Dries's avatar
Dries committed
171
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
Dries's avatar
 
Dries committed
172

Dries's avatar
Dries committed
173 174
    // Reload user roles (delete just to be safe).
    db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
175
    foreach ((array)$array['roles'] as $rid) {
Dries's avatar
Dries committed
176
      db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
Dries's avatar
 
Dries committed
177 178
    }

179 180
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
181

182 183 184 185 186
    user_module_invoke('insert', $array, $user, $category);

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
187
      if ((substr($key, 0, 4) !== 'auth') && ($key != 'roles') && (!in_array($key, $user_fields)) && ($value !== null)) {
188 189 190 191 192 193 194
        $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
195 196
  }

197
  // Save distributed authentication mappings
198
  $authmaps = array();
Dries's avatar
 
Dries committed
199
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
200
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
 
Dries committed
201 202 203
      $authmaps[$key] = $value;
    }
  }
204
  if (sizeof($authmaps) > 0) {
Dries's avatar
 
Dries committed
205
    user_set_authmaps($user, $authmaps);
Dries's avatar
 
Dries committed
206 207 208 209 210
  }

  return $user;
}

Dries's avatar
Dries committed
211 212 213
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
214
function user_validate_name($name) {
215
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
216 217 218
  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.');
219
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
220 221 222 223 224 225 226 227 228 229 230
  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
231
  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.');
232
  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
233 234 235
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
236
  if (!$mail) return t('You must enter an e-mail address.');
237
  if (!valid_email_address($mail)) {
238
    return t('The e-mail address %mail is not valid.', array('%mail' => theme('placeholder', $mail)));
Dries's avatar
 
Dries committed
239 240 241
  }
}

Dries's avatar
 
Dries committed
242
function user_validate_picture($file, &$edit, $user) {
243
  global $form_values;
Dries's avatar
Dries committed
244
  // Initialize the picture:
245
  $form_values['picture'] = $user->picture;
Dries's avatar
 
Dries committed
246

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

252
  if (!$info || !$info['extension']) {
Dries's avatar
 
Dries committed
253
    form_set_error('picture', t('The uploaded file was not an image.'));
Dries's avatar
 
Dries committed
254
  }
255 256
  else if (image_get_toolkit()) {
    image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
Dries's avatar
 
Dries committed
257
  }
258 259 260
  else if (filesize($file->filepath) > (variable_get('user_picture_file_size', '30') * 1000)) {
    form_set_error('picture', t('The uploaded image is too large; the maximum file size is %size kB.', array('%size' => variable_get('user_picture_file_size', '30'))));
  }
261 262
  else if ($info['width'] > $maxwidth || $info['height'] > $maxheight) {
    form_set_error('picture', 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
263
  }
264 265 266

  if (!form_get_errors()) {
    if ($file = file_save_upload('picture', variable_get('user_picture_path', 'pictures') .'/picture-'. $user->uid . '.' . $info['extension'], 1)) {
267
      $form_values['picture'] = $file->filepath;
268 269 270 271
    }
    else {
      form_set_error('picture', t("Failed to upload the picture image; the %directory directory doesn't exist.", array('%directory' => '<em>'. variable_get('user_picture_path', 'pictures') .'</em>')));
    }
Dries's avatar
 
Dries committed
272 273 274
  }
}

275
function user_validate_authmap($account, $authname, $module) {
Dries's avatar
 
Dries committed
276
  $result = db_query("SELECT COUNT(*) from {authmap} WHERE uid != %d AND authname = '%s'", $account->uid, $authname);
Dries's avatar
 
Dries committed
277
  if (db_result($result) > 0) {
Dries's avatar
 
Dries committed
278
    $name = module_invoke($module, 'info', 'name');
279
    return t('The %u ID %s is already taken.', array('%u' => $name, '%s' => theme('placeholder', $authname)));
Dries's avatar
 
Dries committed
280
  }
Dries's avatar
 
Dries committed
281 282
}

Dries's avatar
Dries committed
283 284 285
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
286 287 288 289
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
290 291
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
292

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

Dries's avatar
Dries committed
296 297
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
298

Dries's avatar
Dries committed
299
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
300 301 302 303
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
308 309
}

Dries's avatar
Dries committed
310 311 312 313 314
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
315 316
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
317 318
 *
 * @return
319
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
320 321 322 323 324
 *
 * 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
325
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
326
  global $user;
Dries's avatar
 
Dries committed
327
  static $perm = array();
Dries's avatar
 
Dries committed
328

329 330 331 332
  if (is_null($account)) {
    $account = $user;
  }

333
  // User #1 has all privileges:
334
  if ($account->uid == 1) {
335
    return TRUE;
Dries's avatar
 
Dries committed
336 337
  }

Dries's avatar
Dries committed
338 339
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
340 341
  if (!isset($perm[$account->uid]) && count($user->roles)) {
    $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
342

Steven Wittens's avatar
Steven Wittens committed
343
    $perm[$account->uid] = '';
Dries's avatar
 
Dries committed
344
    while ($row = db_fetch_object($result)) {
345
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
346
    }
Dries's avatar
 
Dries committed
347
  }
348

349
  if (isset($perm[$account->uid])) {
350
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
351
  }
352

353
  return FALSE;
Dries's avatar
 
Dries committed
354 355
}

356 357 358 359 360 361 362 363 364 365 366 367
/**
 * 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
368 369 370
/**
 * Send an e-mail message.
 */
Dries's avatar
 
Dries committed
371
function user_mail($mail, $subject, $message, $header) {
Dries's avatar
Dries committed
372
  if (variable_get('smtp_library', '') && file_exists(variable_get('smtp_library', ''))) {
373
   include_once './' . variable_get('smtp_library', '');
374
    return user_mail_wrapper($mail, $subject, $message, $header);
Dries's avatar
 
Dries committed
375 376
  }
  else {
377 378
    /*
    ** Note: if you are having problems with sending mail, or mails look wrong
379
    ** when they are received you may have to modify the str_replace to suit
380 381 382 383
    ** 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
384 385 386 387
    **
    ** 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
388
    ** Internet e-mail, with lines of no more than 997 characters (by
Dries's avatar
 
Dries committed
389 390 391 392 393 394 395
    ** 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
    **
396
    */
Dries's avatar
 
Dries committed
397 398
    return mail(
      $mail,
Dries's avatar
 
Dries committed
399
      mime_header_encode($subject),
Dries's avatar
Dries committed
400
      str_replace("\r", '', $message),
Dries's avatar
 
Dries committed
401
      "MIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8; format=flowed\nContent-transfer-encoding: 8Bit\n" . $header
Dries's avatar
 
Dries committed
402
    );
Dries's avatar
 
Dries committed
403 404 405
  }
}

Dries's avatar
 
Dries committed
406 407
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
408

Dries's avatar
 
Dries committed
409
  if (!$fields) {
Dries's avatar
Dries committed
410
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
411 412 413
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
414 415
    else {
      // Make sure we return the default fields at least
416
      $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
417
    }
Dries's avatar
 
Dries committed
418
  }
Dries's avatar
 
Dries committed
419

Dries's avatar
 
Dries committed
420
  return $fields;
Dries's avatar
 
Dries committed
421 422
}

Dries's avatar
Dries committed
423 424 425
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
426
function user_perm() {
427
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
 
Dries committed
428 429
}

Dries's avatar
Dries committed
430 431 432 433 434
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
435
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
436
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
437 438
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
439 440 441
  }
}

Dries's avatar
Dries committed
442 443 444
/**
 * Implementation of hook_search().
 */
445 446 447
function user_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
448 449 450
      if (user_access('access user profiles')) {
        return t('users');
      }
451
    case 'search':
452 453 454 455 456 457
      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)) {
458
          $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid));
459 460
        }
        return $find;
461
      }
Dries's avatar
 
Dries committed
462 463 464
  }
}

Dries's avatar
Dries committed
465 466 467
/**
 * Implementation of hook_user().
 */
468
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
469
  if ($type == 'view') {
470
    $form['member'] = array('#type' => 'item', '#title' => t('Member for'), '#value' => format_interval(time() - $user->created));
471
    return array(t('History') => array('history'=> drupal_get_form('member', $form)));
Dries's avatar
Dries committed
472
  }
473 474 475 476 477 478

  if ($type == 'form' && $category == 'account') {
    return user_edit_form(arg(1), $edit);
  }

  if ($type == 'validate' && $category == 'account') {
479
    return _user_edit_validate(arg(1), $edit);
480 481
  }

482 483 484 485
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

486 487 488
  if ($type == 'categories') {
    return array(array('name' => 'account', 'title' => t('account settings'), 'weight' => 1));
  }
Dries's avatar
Dries committed
489 490
}

Dries's avatar
Dries committed
491 492 493
/**
 * Implementation of hook_block().
 */
494
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
495 496
  global $user;

Dries's avatar
Dries committed
497 498 499 500 501
  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');
502

503
     return $blocks;
504
  }
505 506
  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');
507 508
    $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.'));
509

510 511
    //return drupal_get_form('user_block', $form);
    return $form;
512 513 514 515 516 517
  }
  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
518 519
    $block = array();

Dries's avatar
 
Dries committed
520 521
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
522 523
        // For usability's sake, avoid showing two login forms on one page.
        if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
524
          $form['#action'] = url($_GET['q'], drupal_get_destination());
525
          $form['#attributes'] = array('id' => 'user-login-form');
526 527 528
          $form['name'] = array('#type' => 'textfield', '#title' => t('Username'), '#maxlength' => 64, '#size' => 15);
          $form['pass'] = array('#type' => 'password', '#title' => t('Password'), '#maxlength' => 64, '#size' => 15);
          $form['submit'] = array('#type' => 'submit', '#value' => t('Log in'));
529
          $output .= drupal_get_form('user_login_block', $form, 'user_login');
Dries's avatar
Dries committed
530 531
          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
532
          }
Dries's avatar
Dries committed
533
          $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
Dries's avatar
 
Dries committed
534

Dries's avatar
Dries committed
535
          $output .= theme('item_list', $items);
536

Dries's avatar
Dries committed
537 538
          $block['subject'] = t('User login');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
539
        }
Dries's avatar
Dries committed
540
        return $block;
Dries's avatar
Dries committed
541

542
      case 1:
Dries's avatar
 
Dries committed
543
        if ($menu = theme('menu_tree')) {
Dries's avatar
Dries committed
544
           $block['subject'] = $user->uid ? $user->name : t('Navigation');
545
           $block['content'] = $menu;
Dries's avatar
 
Dries committed
546
        }
547
        return $block;
Dries's avatar
Dries committed
548

Dries's avatar
 
Dries committed
549
      case 2:
550
        if (user_access('access content')) {
551 552
          //Retrieve a list of new users who have subsequently accessed the site successfully.
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', 0, 5);
553
          while ($account = db_fetch_object($result)) {
554
            $items[] = $account;
555
          }
Dries's avatar
Dries committed
556
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
557

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

Dries's avatar
 
Dries committed
563
      case 3:
564
        if (user_access('access content')) {
Dries's avatar
Dries committed
565 566
          // Count users with activity in the past defined period.
          $time_period = variable_get('user_block_seconds_online', 2700);
Dries's avatar
 
Dries committed
567

Dries's avatar
Dries committed
568
          // Perform database queries to gather online user lists.
Dries's avatar
 
Dries committed
569
          $guests = db_fetch_object(db_query('SELECT COUNT(sid) AS count FROM {sessions} WHERE timestamp >= %d AND uid = 0', time() - $time_period));
570
          $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
571
          $total_users = db_num_rows($users);
Dries's avatar
 
Dries committed
572

Dries's avatar
Dries committed
573
          // Format the output with proper grammar.
Dries's avatar
 
Dries committed
574
          if ($total_users == 1 && $guests->count == 1) {
Dries's avatar
Dries committed
575
            $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
576 577
          }
          else {
Dries's avatar
Dries committed
578
            $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
579 580
          }

581 582
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
583 584 585 586 587 588
          $items = array();

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

589
          $output .= theme('user_list', $items, t('Online users'));
590

Dries's avatar
Dries committed
591 592
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
593
        }
Dries's avatar
 
Dries committed
594
        return $block;
Dries's avatar
 
Dries committed
595 596
    }
  }
597 598
}

Dries's avatar
 
Dries committed
599 600 601 602 603 604 605 606 607
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', '');
    }

608
    if (isset($picture)) {
Dries's avatar
Dries committed
609
      $alt = t('%user\'s picture', array('%user' => $account->name ? $account->name : variable_get('anonymous', 'Anonymous')));
Steven Wittens's avatar
Steven Wittens committed
610
      $picture = theme('image', $picture, $alt, $alt, '', false);
611
      if (!empty($account->uid)) {
612
        $picture = l($picture, "user/$account->uid", array('title' => t('View user profile.')), NULL, NULL, FALSE, TRUE);
Dries's avatar
 
Dries committed
613 614 615 616 617 618 619
      }

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

620 621 622 623 624 625 626 627 628 629
/**
 * Theme a user page
 * @param $account the user object
 * @param $fields an mulidimensional array for the fields, in the form of
 *                array('category1'=> array('name1' => field1, 'name2' => field2),
 *                      'category2'=> array('name3' => field3, 'name4' => field4, 'name5' => field5),
 *                      .. etc);
 *
 * @ingroup themeable
 */
Dries's avatar
Dries committed
630
function theme_user_profile($account, $fields) {
Dries's avatar
 
Dries committed
631 632
  $output = "<div class=\"profile\">\n";
  $output .= theme('user_picture', $account);
Dries's avatar
Dries committed
633
  foreach ($fields as $category => $value) {
634
    $value = implode('', $value);
635
    $output .= theme('box', $category, $value);
Dries's avatar
Dries committed
636
  }
Dries's avatar
 
Dries committed
637 638 639 640 641
  $output .= "</div>\n";

  return $output;
}

642 643 644 645 646 647 648
/**
 * 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) {
649 650 651 652
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
653
  }
Dries's avatar
Dries committed
654
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
655 656
}

Dries's avatar
 
Dries committed
657
/**
Dries's avatar
 
Dries committed
658
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
659
 */
Dries's avatar
 
Dries committed
660
function user_menu($may_cache) {
Dries's avatar
 
Dries committed
661
  global $user;
Dries's avatar
 
Dries committed
662

Dries's avatar
 
Dries committed
663
  $items = array();
Dries's avatar
 
Dries committed
664

665
  $admin_access = user_access('administer users');
666
  $access_access = user_access('administer access control');
667 668
  // users should always be allowed to see their own user page
  $view_access = (user_access('access user profiles') || ($user->uid == arg(1)));
Dries's avatar
 
Dries committed
669

Dries's avatar
 
Dries committed
670
  if ($may_cache) {
Dries's avatar
 
Dries committed
671
    $items[] = array('path' => 'user', 'title' => t('user account'),
672
      'callback' => 'user_login', 'access' => TRUE, 'type' => MENU_CALLBACK);
673

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

677
    //registration and login pages.
Dries's avatar
 
Dries committed
678
    $items[] = array('path' => 'user/login', 'title' => t('log in'),
679
      'callback' => 'user_login', 'type' => MENU_DEFAULT_LOCAL_TASK);
Dries's avatar
 
Dries committed
680
    $items[] = array('path' => 'user/register', 'title' => t('register'),
681
      'callback' => 'user_register', 'access' => $user->uid == 0 && variable_get('user_register', 1), 'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
682
    $items[] = array('path' => 'user/password', 'title' => t('request new password'),
683
      'callback' => 'user_pass', 'access' => $user->uid == 0, 'type' => MENU_LOCAL_TASK);
684 685
    $items[] = array('path' => 'user/reset', 'title' => t('reset password'),
      'callback' => 'user_pass_reset', 'access' => $user->uid == 0, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
686 687
    $items[] = array('path' => 'user/help', 'title' => t('help'),
      'callback' => 'user_help_page', 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
688

689
    //admin user pages
Dries's avatar
 
Dries committed
690
    $items[] = array('path' => 'admin/user', 'title' => t('users'),
691
      'callback' => 'user_admin', 'access' => $admin_access);
Dries's avatar
 
Dries committed
692
    $items[] = array('path' => 'admin/user/list', 'title' => t('list'),
Dries's avatar
 
Dries committed
693
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
694
    $items[] = array('path' => 'admin/user/create', 'title' => t('add user'),
695
      'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
696
      'type' => MENU_LOCAL_TASK);
697
    $items[] = array('path' => 'admin/settings/user', 'title' => t('users'),
698
      'callback' => 'user_configure');
699 700

    //admin access pages
701
    $items[] = array('path' => 'admin/access', 'title' => t('access control'),
702
      'callback' => 'user_admin_perm', 'access' => $access_access);
703
    $items[] = array('path' => 'admin/access/permissions', 'title' => t('permissions'),
704
      'callback' => 'user_admin_perm', 'access' => $access_access,
Dries's avatar
 
Dries committed
705
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
706
    $items[] = array('path' => 'admin/access/roles', 'title' => t('roles'),
707
      'callback' => 'user_admin_role', 'access' => $access_access,
Dries's avatar
 
Dries committed
708
      'type' => MENU_LOCAL_TASK);
709
    $items[] = array('path' => 'admin/access/roles/edit', 'title' => t('edit role'),
710
      'callback' => 'user_admin_role', 'access' => $access_access,
711
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
712
    $items[] = array('path' => 'admin/access/rules', 'title' => t('access rules'),
713
      'callback' => 'user_admin_access', 'access' => $access_access,
714 715
      'type' => MENU_LOCAL_TASK, 'weight' => 10);
    $items[] = array('path' => 'admin/access/rules/list', 'title' => t('list'),
716
      'access' => $access_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
717
    $items[] = array('path' => 'admin/access/rules/add', 'title' => t('add rule'),
718
      'callback' => 'user_admin_access_add', 'access' => $access_access,
Dries's avatar
 
Dries committed
719
      'type' => MENU_LOCAL_TASK);
720
    $items[] = array('path' => 'admin/access/rules/check', 'title' => t('check rules'),
721
      'callback' => 'user_admin_access_check', 'access' => $access_access,
Dries's avatar
 
Dries committed
722
      'type' => MENU_LOCAL_TASK);
723
    $items[] = array('path' => 'admin/access/rules/edit', 'title' => t('edit rule'),
724
      'callback' => 'user_admin_access_edit', 'access' => $access_access,
725
      'type' => MENU_CALLBACK);
726
    $items[] = array('path' => 'admin/access/rules/delete', 'title' => t('delete rule'),
727
      'callback' => 'user_admin_access_delete', 'access' => $access_access,
728
      'type' => MENU_CALLBACK);
729

Dries's avatar
 
Dries committed
730 731
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/user/search', 'title' => t('search'),
732
        'callback' => 'user_admin', 'access' => $admin_access,
Dries's avatar
 
Dries committed
733
        'type' => MENU_LOCAL_TASK);
734
    }
Dries's avatar
 
Dries committed
735

736
    //Your personal page
Dries's avatar
 
Dries committed
737 738
    if ($user->uid) {
      $items[] = array('path' => 'user/'. $user->uid, 'title' => t('my account'),
739
        'callback' => 'user_view', 'callback arguments' => array(arg(1)), 'access' => TRUE,
740
        'type' => MENU_DYNAMIC_ITEM);
Dries's avatar
 
Dries committed
741
    }
Dries's avatar
 
Dries committed
742 743 744 745 746

    $items[] = array('path' => 'logout', 'title' => t('log out'),
      'access' => $user->uid != 0,
      'callback' => 'user_logout',
      'weight' => 10);
Dries's avatar
 
Dries committed
747 748
  }
  else {
Dries's avatar
 
Dries committed
749
    if (arg(0) == 'user' && is_numeric(arg(1))) {
750 751
      $user_exists = user_load(array('uid' => arg(1), 'status' => 1));

Dries's avatar
 
Dries committed
752
      $items[] = array('path' => 'user/'. arg(1), 'title' => t('user'),
753 754
        'type' => MENU_CALLBACK, 'callback' => 'user_view',
        'callback arguments' => arg(1), 'access' => $view_access);
755

756
      if ($user_exists !== FALSE || $admin_access) {
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
        $items[] = array('path' => 'user/'. arg(1) .'/view', 'title' => t('view'),
          'access' => $view_access, 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
        $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
776 777 778 779
          }
        }
      }
    }
Dries's avatar
 
Dries committed
780
  }
Dries's avatar
 
Dries committed
781 782

  return $items;
Dries's avatar
 
Dries committed
783 784
}

Dries's avatar
Dries committed
785 786 787
/**
 * Called by authentication modules in order to edit/view their authmap information.
 */
788
function user_get_authname($account, $module) {
Dries's avatar
 
Dries committed
789
  $result = db_query("SELECT authname FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module);
790 791 792
  return db_result($result);
}