common.inc 58.2 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
Dries's avatar
Dries committed
2
/* $Id$ */
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5 6 7 8 9 10 11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

Kjartan's avatar
Kjartan committed
12
/**
Dries's avatar
 
Dries committed
13
 * Set the title of the current page, for display on the page and in the title bar.
Dries's avatar
 
Dries committed
14
 */
Dries's avatar
 
Dries committed
15 16 17 18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
 
Dries committed
19
    $stored_title = $title;
Dries's avatar
 
Dries committed
20 21 22 23
  }
  return $stored_title;
}

Dries's avatar
 
Dries committed
24 25 26
/**
 * Get the title of the current page, for display on the page and in the title bar.
 */
Dries's avatar
 
Dries committed
27 28 29 30 31 32 33 34 35 36 37
function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}

/**
Dries's avatar
 
Dries committed
38
 * Set the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
39
 *
Dries's avatar
 
Dries committed
40 41 42
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
43
 */
Dries's avatar
 
Dries committed
44 45 46 47 48 49 50 51 52
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

  if (isset($breadcrumb)) {
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
 
Dries committed
53 54 55
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
 
Dries committed
56 57 58 59 60 61 62 63 64 65
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

  if (!isset($breadcrumb)) {
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
66
/**
Dries's avatar
 
Dries committed
67
 * Add output to the head tag of the HTML page.
Dries's avatar
Dries committed
68 69
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
70
  static $stored_head = '';
Dries's avatar
Dries committed
71 72

  if (!is_null($data)) {
Dries's avatar
 
Dries committed
73
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
74 75 76 77
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
78 79 80
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
81 82 83
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
84
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
85
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
86
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
87 88 89 90

  return $output . drupal_set_html_head();
}

Dries's avatar
 
Dries committed
91
/**
Dries's avatar
 
Dries committed
92
 * Return an array mapping path aliases to their internal Drupal paths.
Dries's avatar
 
Dries committed
93
 */
Dries's avatar
 
Dries committed
94
function drupal_get_path_map($action = '') {
Dries's avatar
Dries committed
95
  static $map = NULL;
Dries's avatar
 
Dries committed
96

Dries's avatar
 
Dries committed
97
  if ($action == 'rebuild') {
Dries's avatar
 
Dries committed
98 99 100
    $map = NULL;
  }

Dries's avatar
Dries committed
101
  if (is_null($map)) {
Dries's avatar
 
Dries committed
102
    $map = array();  // Make $map non-null in case no aliases are defined.
Dries's avatar
 
Dries committed
103
    $result = db_query('SELECT * FROM {url_alias}');
Dries's avatar
 
Dries committed
104
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
105
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
106 107 108 109 110 111
    }
  }

  return $map;
}

Dries's avatar
 
Dries committed
112 113 114
/**
 * Regenerate the path map from the information in the database.
 */
Dries's avatar
 
Dries committed
115
function drupal_rebuild_path_map() {
Dries's avatar
 
Dries committed
116
  drupal_get_path_map('rebuild');
Dries's avatar
 
Dries committed
117
}
Kjartan's avatar
Kjartan committed
118 119

/**
Dries's avatar
 
Dries committed
120
 * Given an internal Drupal path, return the alias set by the administrator.
Kjartan's avatar
Kjartan committed
121
 */
Dries's avatar
 
Dries committed
122 123 124 125
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
Dries's avatar
 
Dries committed
126
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
127 128
    return conf_url_rewrite($path, 'outgoing');
  }
129 130 131 132
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries's avatar
 
Dries committed
133 134 135
}

/**
Dries's avatar
 
Dries committed
136
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
137 138 139 140 141
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
Dries's avatar
 
Dries committed
142
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
143 144 145 146 147 148
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
149

Dries's avatar
Dries committed
150
/**
Dries's avatar
 
Dries committed
151
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
152 153
 */
function drupal_set_header($header = NULL) {
154
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
155
  // Otherwise, header('') could get called when serving the page later, which
156 157
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
158

159
  if (strlen($header)) {
Dries's avatar
Dries committed
160
    header($header);
161
    $stored_headers[] = $header;
Dries's avatar
Dries committed
162
  }
163
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
164 165
}

Dries's avatar
 
Dries committed
166 167 168
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
169 170 171 172
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
 
Dries committed
173 174 175
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
176
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
177 178
 */

Kjartan's avatar
Kjartan committed
179
/**
Dries's avatar
 
Dries committed
180
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
181
 *
Dries's avatar
 
Dries committed
182 183
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
184
 *
Dries's avatar
 
Dries committed
185 186 187 188 189 190 191 192 193 194 195 196 197
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
Kjartan's avatar
Kjartan committed
198
 */
Dries's avatar
 
Dries committed
199 200 201
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
  // Translate &amp; to simply & in the absolute URL.
  $url = str_replace('&amp;', '&', url($path, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
202

Dries's avatar
 
Dries committed
203 204
  if (ini_get('session.use_trans_sid') && session_id() && !strstr($url, session_id())) {
    $sid = session_name() . '=' . session_id();
Dries's avatar
 
Dries committed
205

Dries's avatar
 
Dries committed
206 207
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
208 209
    }
    else {
Dries's avatar
 
Dries committed
210
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
211 212 213
    }
  }

Dries's avatar
 
Dries committed
214 215 216 217
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

  header('Location: '. $url);
Kjartan's avatar
Kjartan committed
218

Dries's avatar
 
Dries committed
219 220 221
  // The "Location" header sends a REDIRECT status code to the http
  // daemon. In some cases this can go wrong, so we make sure none
  // of the code below the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
222 223 224 225 226 227
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
228
function drupal_not_found() {
Dries's avatar
 
Dries committed
229
  header('HTTP/1.0 404 Not Found');
Dries's avatar
 
Dries committed
230
  watchdog('httpd', t('404 error: %page not found.', array('%page' => '<em>'. check_query($_GET['q']) .'</em>')));
Dries's avatar
 
Dries committed
231 232

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
233
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
234 235
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
 
Dries committed
236
    $status = menu_execute_active_handler();
Dries's avatar
 
Dries committed
237 238
  }

Dries's avatar
 
Dries committed
239
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
240
    print theme('page', '', t('Page not found'));
Dries's avatar
 
Dries committed
241 242
  }
}
Dries's avatar
 
Dries committed
243

Dries's avatar
 
Dries committed
244 245 246 247 248 249 250
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
251
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
252 253 254 255 256 257 258 259 260 261
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
    print theme('page', message_access(), t('Access denied'));
  }
}

Dries's avatar
 
Dries committed
262
/**
Dries's avatar
 
Dries committed
263
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
264
 *
Dries's avatar
 
Dries committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
 * This is a flexible and powerful HTTP client implementation. Correctly handles
 * GET, POST, PUT or any other HTTP requests. Handles redirects.
 *
 * @param $url
 *   A string containing a fully qualified URI.
 * @param $headers
 *   An array containing an HTTP header => value pair.
 * @param $method
 *   A string defining the HTTP request to use.
 * @param $data
 *   A string containing data to include in the request.
 * @param $retry
 *   An integer representing how many times to retry the request in case of a
 *   redirect.
 * @return
 *   An object containing the HTTP request headers, response code, headers,
 *   data, and redirect status.
Dries's avatar
 
Dries committed
282 283
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
284
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
285 286 287 288 289 290
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
Dries's avatar
 
Dries committed
291 292
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
      $fp = @fsockopen('ssl://'. $uri['host'], ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
Dries's avatar
 
Dries committed
293 294
      break;
    default:
Dries's avatar
 
Dries committed
295
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
296 297 298
      return $result;
  }

Dries's avatar
 
Dries committed
299
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
300
  if (!$fp) {
Dries's avatar
 
Dries committed
301
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
302 303 304
    return $result;
  }

Dries's avatar
 
Dries committed
305
  // Construct the path to act on.
Dries's avatar
 
Dries committed
306 307
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
308
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
309 310
  }

Dries's avatar
 
Dries committed
311
  // Create HTTP request.
Dries's avatar
 
Dries committed
312
  $defaults = array(
Dries's avatar
 
Dries committed
313
    'Host' => 'Host: '. $uri['host'],
314 315
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
316 317 318
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
319
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
320 321
  }

Dries's avatar
 
Dries committed
322
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
323 324 325
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
326
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
327 328 329 330 331 332
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
333
  $response = '';
334
  while (!feof($fp) && $data = fread($fp, 1024)) {
335
    $response .= $data;
Dries's avatar
 
Dries committed
336 337 338 339
  }
  fclose($fp);

  // Parse response.
340 341 342 343
  list($headers, $result->data) = explode("\r\n\r\n", $response, 2);
  $headers = preg_split("/\r\n|\n|\r/", $headers);

  list($protocol, $code, $text) = explode(' ', trim(array_shift($headers)), 3);
Dries's avatar
 
Dries committed
344 345 346
  $result->headers = array();

  // Parse headers.
347
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
348 349 350 351 352 353 354 355 356 357 358 359
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
Dries's avatar
 
Dries committed
360
  // the base code in their class.
Dries's avatar
 
Dries committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
      $location = $result->headers['Location'];

      if ($retry) {
        $result = drupal_http_request($result->headers['Location'], $headers, $method, $data, --$retry);
        $result->redirect_code = $result->code;
      }
      $result->redirect_url = $location;

      break;
    default:
      $result->error = $text;
  }

  $result->code = $code;
  return $result;
}
Dries's avatar
 
Dries committed
388 389 390
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
391

Dries's avatar
 
Dries committed
392 393 394
/**
 * Log errors in the database rather than displaying them to the user.
 */
Dries's avatar
 
Dries committed
395
function error_handler($errno, $message, $filename, $line, $variables) {
396
  $types = array(1 => 'error', 2 => 'warning', 4 => 'parse error', 8 => 'notice', 16 => 'core error', 32 => 'core warning', 64 => 'compile error', 128 => 'compile warning', 256 => 'user error', 512 => 'user warning', 1024 => 'user notice', 2048 => 'strict warning');
Dries's avatar
 
Dries committed
397
  $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
 
Dries committed
398

399
  if ($errno & (E_ALL ^ E_NOTICE)) {
400
    watchdog('error', t('%error: %message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)));
Dries's avatar
Dries committed
401
    if (error_reporting()) {
Dries's avatar
 
Dries committed
402
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
403
    }
Dries's avatar
 
Dries committed
404 405 406
  }
}

Dries's avatar
Dries committed
407 408
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
409 410 411
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
412
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
413 414 415
  }
}

Dries's avatar
 
Dries committed
416 417 418 419
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
420 421
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
422
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
423 424 425 426 427 428
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
Dries's avatar
 
Dries committed
429 430
}

Kjartan's avatar
Kjartan committed
431 432 433
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
434
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
435
 */
Dries's avatar
 
Dries committed
436 437 438 439

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
440 441
function array2object($array) {
  if (is_array($array)) {
442
    $object = new stdClass();
Dries's avatar
Dries committed
443
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
444 445 446 447
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
448
    $object = $array;
Dries's avatar
 
Dries committed
449 450 451 452 453
  }

  return $object;
}

Dries's avatar
 
Dries committed
454 455 456
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
457 458 459
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
460 461 462 463
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
464
    $array = $object;
Dries's avatar
 
Dries committed
465 466 467 468
  }

  return $array;
}
Dries's avatar
 
Dries committed
469 470 471 472

/**
 * @} End of "Conversion".
 */
Dries's avatar
 
Dries committed
473

Kjartan's avatar
Kjartan committed
474 475 476
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
477
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
478
 */
Dries's avatar
 
Dries committed
479 480 481 482 483 484 485

/**
 * Return a string with an "access denied" message.
 *
 * Always consider whether to use drupal_access_denied() instead to return a
 * proper (and customizable) 403 error.
 */
Dries's avatar
 
Dries committed
486
function message_access() {
Dries's avatar
 
Dries committed
487
  return t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
488 489
}

Dries's avatar
 
Dries committed
490 491 492
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
493
function message_na() {
Dries's avatar
 
Dries committed
494
  return t('n/a');
Dries's avatar
 
Dries committed
495 496
}

Dries's avatar
 
Dries committed
497 498 499
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
500

Dries's avatar
 
Dries committed
501 502 503
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
504 505 506 507 508 509 510 511 512
function locale_initialize() {
  global $user;
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
    $languages = array();
  }
Dries's avatar
 
Dries committed
513 514 515 516 517 518
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
519 520
}

Kjartan's avatar
Kjartan committed
521
/**
Dries's avatar
 
Dries committed
522
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
523
 *
524
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
525 526 527 528
 * This makes it easier for translators. HTML markup within translation strings
 * is acceptable, if necessary. The suggested syntax for a link embedded
 * within a translation string is:
 * @code
Dries's avatar
 
Dries committed
529 530 531
 *   $msg = t('You must log in below or <a href="%url">create a new
 *             account</a> before viewing the next page.', array('%url'
 *             => url('user/register')));
Dries's avatar
 
Dries committed
532
 * @endcode
533 534 535
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
Kjartan's avatar
Kjartan committed
536
 *
Dries's avatar
 
Dries committed
537
 * @param $string
Dries's avatar
 
Dries committed
538
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
539 540
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
541
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
542 543
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
544
 */
Dries's avatar
 
Dries committed
545
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
546 547 548 549
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
550

Dries's avatar
 
Dries committed
551 552
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
553 554
  }
  else {
Dries's avatar
 
Dries committed
555 556
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
557 558
}

Dries's avatar
 
Dries committed
559 560 561 562 563 564 565 566
/**
 * Encode special characters in a string for display as HTML.
 *
 * Note that we'd like to use htmlspecialchars($input, $quotes, 'utf-8')
 * as outlined in the PHP manual, but we can't because there's a bug in
 * PHP < 4.3 that makes it mess up multibyte charsets if we specify the
 * charset. This will be changed later once we make PHP 4.3 a requirement.
 */
Dries's avatar
 
Dries committed
567
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
568
  return htmlspecialchars($input, $quotes);
Dries's avatar
 
Dries committed
569 570
}

Kjartan's avatar
Kjartan committed
571
/**
Dries's avatar
 
Dries committed
572
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
573
 * @{
Dries's avatar
 
Dries committed
574
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
575 576
 */

577
/**
Dries's avatar
 
Dries committed
578 579 580
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
581
 *
Dries's avatar
 
Dries committed
582 583
 * @param $mail
 *   A string containing an email address.
Dries's avatar
 
Dries committed
584
 * @return
Dries's avatar
 
Dries committed
585
 *   TRUE if the address is in a valid format.
586
 */
Dries's avatar
 
Dries committed
587
function valid_email_address($mail) {
588
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
589
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
590 591 592
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

Dries's avatar
Dries committed
593
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
594 595
}

Dries's avatar
 
Dries committed
596 597 598
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
599
 * @param $url
Dries's avatar
 
Dries committed
600
 *   The URL to verify.
Dries's avatar
 
Dries committed
601
 * @param $absolute
Dries's avatar
 
Dries committed
602
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
603
 * @return
Dries's avatar
 
Dries committed
604
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
605
 */
Dries's avatar
 
Dries committed
606
function valid_url($url, $absolute = FALSE) {
607
  if ($absolute) {
Dries's avatar
 
Dries committed
608
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&%]+$/i", $url);
609 610
  }
  else {
611
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
612
  }
Dries's avatar
 
Dries committed
613 614
}

Dries's avatar
 
Dries committed
615 616 617 618 619 620 621 622 623 624
/**
 * Validate data input by a user.
 *
 * Ensures that user data cannot be used to perform attacks on the site.
 *
 * @param $data
 *   The input to check.
 * @return
 *   TRUE if the input data is acceptable.
 */
Kjartan's avatar
Kjartan committed
625 626
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
627
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
628
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
629
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
630
        return FALSE;
Kjartan's avatar
Kjartan committed
631 632 633 634
      }
    }
  }
  else {
Dries's avatar
 
Dries committed
635
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
636

Dries's avatar
 
Dries committed
637 638 639 640
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
Kjartan's avatar
Kjartan committed
641

Dries's avatar
 
Dries committed
642
    // Check attributes:
Kjartan's avatar
Kjartan committed
643 644
    $match += preg_match("/\W(dynsrc|datasrc|data|lowsrc|on[a-z]+)\s*=[^>]+?>/i", $data);

Dries's avatar
 
Dries committed
645
    // Check tags:
Kjartan's avatar
Kjartan committed
646 647 648
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);

    if ($match) {
Dries's avatar
 
Dries committed
649
      watchdog('warning', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries's avatar
 
Dries committed
650
      return FALSE;
Kjartan's avatar
Kjartan committed
651 652 653
    }
  }

Dries's avatar
 
Dries committed
654
  return TRUE;
Kjartan's avatar
Kjartan committed
655
}
Dries's avatar
 
Dries committed
656 657 658
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
659 660 661 662

/**
 * @defgroup search Search interface
 * @{
Dries's avatar
 
Dries committed
663 664 665 666 667
 * The Drupal search interface manages a global search mechanism.
 *
 * Modules may plug into this system to provide searches of different types of
 * data. Most of the system is handled by search.module, so this must be enabled
 * for all of the search features to work.
Kjartan's avatar
Kjartan committed
668
 */
Dries's avatar
 
Dries committed
669

Kjartan's avatar
Kjartan committed
670
/**
Dries's avatar
 
Dries committed
671 672 673 674
 * Format a single result entry of a search query.
 *
 * Modules may implement hook_search_item() in order to override this default
 * function to display search results.
Kjartan's avatar
Kjartan committed
675
 *
Dries's avatar
 
Dries committed
676 677 678 679 680
 * @param $item
 *   A single search result as returned by hook_search(). The result should be
 *   an array with keys "count", "link", "title", "user", "date", and "keywords".
 * @param $type
 *   The type of item found, such as "user" or "comment".
Kjartan's avatar
Kjartan committed
681
 */
Dries's avatar
 
Dries committed
682
function search_item($item, $type) {
Dries's avatar
 
Dries committed
683 684
  if (module_hook($type, 'search_item')) {
    $output = module_invoke($type, 'search_item', $item);
Dries's avatar
 
Dries committed
685 686
  }
  else {
Dries's avatar
 
Dries committed
687 688
    $output = ' <dt class="title"><a href="'. $item['link'] .'">'. $item['title'] .'</a></dt>';
    $output .= ' <dd class="small">' . t($type) . ($item['user'] ? ' - '. $item['user'] : '') .''. ($item['date'] ? ' - '. format_date($item['date'], 'small') : '') .'</dd>';
Dries's avatar
 
Dries committed
689
  }
Dries's avatar
 
Dries committed
690 691 692 693

  return $output;
}

Kjartan's avatar
Kjartan committed
694 695 696
/**
 * Render a generic search form.
 *
Dries's avatar
 
Dries committed
697 698 699 700
 * This form must be usable not only within "http://example.com/search", but also
 * as a simple search box (without "Restrict search to", help text, etc.), in the
 * theme's header, and so forth. This means we must provide options to
 * conditionally render certain parts of this form.
Kjartan's avatar
Kjartan committed
701
 *
Dries's avatar
 
Dries committed
702 703 704 705 706 707 708 709 710
 * @param $action
 *   Form action. Defaults to "search".
 * @param $keys
 *   The search string entered by the user, containing keywords for the search.
 * @param $options
 *   Whether to render the optional form fields and text ("Restrict search
 *   to", help text, etc.).
 * @return
 *   An HTML string containing the search form.
Kjartan's avatar
Kjartan committed
711
 */
Dries's avatar
 
Dries committed
712
function search_form($action = '', $keys = '', $options = FALSE) {
Dries's avatar
 
Dries committed
713 714
  $edit = $_POST['edit'];

Dries's avatar
 
Dries committed
715
  if (!$action) {
Dries's avatar
 
Dries committed
716
    $action = url('search');
Dries's avatar
 
Dries committed
717 718
  }

Dries's avatar
 
Dries committed
719 720
  $output = ' <div class="search-form"><br /><input type="text" class="form-text" size="50" value="'. check_form($keys) .'" name="keys" />';
  $output .= ' <input type="submit" class="form-submit" value="'. t('Search') ."\" />\n";
Dries's avatar
 
Dries committed
721

Dries's avatar
Dries committed
722
  if ($options) {
Dries's avatar
 
Dries committed
723 724
    $output .= '<br />';
    $output .= t('Restrict search to') .': ';
Dries's avatar
 
Dries committed
725 726

    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
727 728
      if (module_hook($name, 'search')) {
        $output .= ' <input type="checkbox" name="edit[type]['. $name .']" '. ($edit['type'][$name] ? ' checked="checked"' : '') .' /> '. t($name);
Dries's avatar
 
Dries committed
729 730 731
      }
    }
  }
732
  $output .= '</div>';
Dries's avatar
 
Dries committed
733

Dries's avatar
 
Dries committed
734
  return form($output, 'post', $action);
Dries's avatar
 
Dries committed
735 736
}

Dries's avatar
 
Dries committed
737 738
/**
 * Perform a global search on the given keys, and return the formatted results.
Kjartan's avatar
Kjartan committed
739
 */
Dries's avatar
 
Dries committed
740
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
741
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
742
  $output = '';
Dries's avatar
 
Dries committed
743

Dries's avatar
 
Dries committed
744
  if (isset($keys)) {
Dries's avatar
 
Dries committed
745
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
746 747
      if (module_hook($name, 'search') && (!$edit['type'] || $edit['type'][$name])) {
        list($title, $results) = module_invoke($name, 'search', $keys);
Dries's avatar
 
Dries committed
748
        if ($results) {
Dries's avatar
 
Dries committed
749 750
          $output .= '<h2>'. $title .'</h2>';
          $output .= '<dl class="search-results">';
Dries's avatar
 
Dries committed
751 752 753
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
Dries's avatar
 
Dries committed
754
          $output .= '</dl>';
Dries's avatar
 
Dries committed
755 756 757 758 759 760 761 762
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
763
/**
Dries's avatar
 
Dries committed
764
 * Display a search form for a particular type of data.
Kjartan's avatar
Kjartan committed
765
 *
Dries's avatar
 
Dries committed
766 767 768 769 770 771 772 773 774 775 776
 * @param $type
 *   The type of content to search within.
 * @param $action
 *   Form action. Defaults to "search".
 * @param $keys
 *   The search string entered by the user, containing keywords for the search.
 * @param $options
 *   Whether to render the optional form fields and text ("Restrict search
 *   to", help text, etc.).
 * @return
 *   An HTML string containing the search form and results.
Kjartan's avatar
Kjartan committed
777
 */
Dries's avatar
 
Dries committed
778
function search_type($type, $action = '', $keys = '', $options = FALSE) {
Dries's avatar
 
Dries committed
779
  $_POST['edit']['type'][$type] = 'on';
Dries's avatar
 
Dries committed
780

Dries's avatar
 
Dries committed
781
  return search_form($action, $keys, $options) . '<br />'. search_data($keys);
Dries's avatar
 
Dries committed
782
}
783 784

/**
Dries's avatar
 
Dries committed
785
 * @} End of "defgroup search".
786
 */
Dries's avatar
 
Dries committed
787

Dries's avatar
 
Dries committed
788
function check_form($text) {
Dries's avatar
 
Dries committed
789
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
790 791
}

792 793
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
794 795
}

Dries's avatar
 
Dries committed
796
/**
Dries's avatar
 
Dries committed
797
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
798
 * @{
Dries's avatar
 
Dries committed
799
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
800 801
 */

Dries's avatar
 
Dries committed
802 803 804 805 806 807
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
function format_rss_channel($title, $link, $description, $items, $language = 'en', $args = array()) {
Dries's avatar
 
Dries committed
808 809
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
810
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
811 812 813 814
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= ' <description>'. drupal_specialchars(strip_tags($description)) ."</description>\n";
  $output .= ' <language>'. drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
 
Dries committed
815
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
816
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
817
  }
Dries's avatar
 
Dries committed
818 819 820 821 822 823
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
824 825 826 827 828
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
829
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
830
  $output = "<item>\n";
Dries's avatar
 
Dries committed
831 832
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
833
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries's avatar
 
Dries committed
834
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
835
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
836
  }
Dries's avatar
 
Dries committed
837 838 839 840 841
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
842
/**
Dries's avatar
 
Dries committed
843
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
844
 *
Dries's avatar
 
Dries committed
845 846 847 848 849 850 851 852 853 854 855 856 857 858
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
 *   to ease translation. Use %count in place of the item count, as in "%count
 *   new comments".
 * @return
 *   A translated string.
Dries's avatar
 
Dries committed
859
 */
Dries's avatar
 
Dries committed
860
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
  if ($count == 1) return t($singular);

  // get the plural index through the gettext formula
  $index = (function_exists('locale')) ? locale_get_plural($count) : -1;
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
        return t($singular);
      case "1":
        return t($plural, array("%count" => $count));
      default:
        return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count));
    }
  }
Dries's avatar
 
Dries committed
878 879
}

Dries's avatar
 
Dries committed
880
/**
Dries's avatar
 
Dries committed
881
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
882
 *
Dries's avatar
 
Dries committed
883 884 885 886
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
887
 */
Dries's avatar
 
Dries committed
888
function format_size($size) {
Dries's avatar
 
Dries committed
889
  $suffix = t('bytes');
Dries's avatar
 
Dries committed
890 891
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
892
    $suffix = t('KB');
Dries's avatar
 
Dries committed
893 894 895
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
896
    $suffix = t('MB');
Dries's avatar
 
Dries committed
897
  }
Dries's avatar
 
Dries committed
898
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
899 900
}

Dries's avatar
 
Dries committed
901
/**
Dries's avatar
 
Dries committed
902
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
903
 *
Dries's avatar
 
Dries committed
904 905 906 907 908 909
 * @param $timestamp
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
 * @return
 *   A translated string representation of the interval.
Dries's avatar
 
Dries committed
910
 */
Dries's avatar
 
Dries committed
911
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
912
  $units = array('1 year|%count years' => 31536000, '1 week|%count weeks' => 604800, '1 day|%count days' => 86400, '1 hour|%count hours' => 3600, '1 min|%count min' => 60, '1 sec|%count sec' => 1);
Dries's avatar
 
Dries committed
913
  $output = '';
Dries's avatar
 
Dries committed
914
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
915
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
916
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
917
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
918
      $timestamp %= $value;
Dries's avatar
 
Dries committed
919 920 921 922 923
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
924 925
    }
  }
Dries's avatar
 
Dries committed
926
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
927 928
}

Dries's avatar
 
Dries committed
929
/**
Dries's avatar
 
Dries committed
930 931
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
932 933 934 935
 * Drupal allows administrators to select formatting strings for 'small',
 * 'medium' and 'large' date formats. This function can handle these formats,
 * as well as any custom format.
 *
Dries's avatar
 
Dries committed
936 937 938 939 940 941 942 943 944 945 946
 * @param $timestamp
 *   The exact date to format, as a UNIX timestamp.
 * @param $type
 *   The format to use. Can be "small", "medium" or "large" for the preconfigured
 *   date formats. If "custom" is specified, then $format is required as well.
 * @param $format
 *   A PHP date format string as required by date().
 * @param $timezone
 *   Time zone offset in seconds; if omitted, the user's time zone is used.
 * @return
 *   A translated date string in the requested format.
Dries's avatar
 
Dries committed
947
 */
948 949 950
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
951 952 953 954 955 956
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
957
  }
Dries's avatar
 
Dries committed
958

959
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
960 961

  switch ($type) {
962 963
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
964
      break;
965 966
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
967
      break;
968
    case 'custom':
Dries's avatar
 
Dries committed
969
      // No change to format
Dries's avatar
 
Dries committed
970
      break;
971
    case 'medium':
Dries's avatar
 
Dries committed
972
    default:
973
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
974 975
  }

976
  $max = strlen($format);
Dries's avatar
 
Dries committed
977
  $date = '';
Dries's avatar
 
Dries committed
978 979
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
980
    if (strpos('AaDFlM', $c) !== false) {
981
      $date .= t(gmdate($c, $timestamp));
982
    }
983
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
984 985 986 987
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
 
Dries committed
988
    }
989 990 991 992 993
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
 
Dries committed
994 995
    }
    else {
996
      $date .= $c;
Dries's avatar
 
Dries committed
997
    }
Dries's avatar
 
Dries committed
998
  }
999

Dries's avatar
 
Dries committed
1000 1001 1002
  return $date;
}

Dries's avatar
 
Dries committed
1003
/**
Dries's avatar
 
Dries committed
1004
 * Format a username.
Dries's avatar
 
Dries committed
1005
 *
Dries's avatar
 
Dries committed
1006 1007 1008 1009 1010
 * @param $object
 *   The user object to format, usually returned from user_load().
 * @return
 *   A string containing an HTML link to the user's page if the passed object
 *   suggests that this is a site user. Otherwise, only the username is returned.
Dries's avatar
 
Dries committed
1011
 */
Dries's avatar
 
Dries committed
1012 1013 1014
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
 
Dries committed
1015
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
1016
    if (strlen($object->name) > 20) {
Dries's avatar
 
Dries committed
1017
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
1018 1019 1020 1021 1022
    }
    else {
      $name = $object->name;
    }

Dries's avatar
 
Dries committed
1023
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
 
Dries committed
1024
  }
Dries's avatar
 
Dries committed
1025
  else if ($object->name) {
Dries's avatar
 
Dries committed
1026 1027 1028 1029
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
Dries's avatar
 
Dries committed
1030
    if ($object->homepage) {
Dries's avatar
 
Dries committed
1031
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
 
Dries committed
1032 1033 1034 1035 1036 1037
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
 
Dries committed
1038
  }
Dries's avatar
 
Dries committed
1039
  else {
Dries's avatar
 
Dries committed
1040
    $output = t(variable_get('anonymous', 'Anonymous'));
Dries's avatar
 
Dries committed
1041 1042
  }

Dries's avatar
 
Dries committed
1043
  return $output;
Dries's avatar
 
Dries committed
1044
}
Dries's avatar
 
Dries committed
1045 1046 1047
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
1048

Kjartan's avatar
Kjartan committed
1049
/**
Dries's avatar
 
Dries committed
1050
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
1051
 * @{
Dries's avatar
 
Dries committed
1052
 * Functions to enable output of HTML forms and form elements.
1053
 *
Dries's avatar
 
Dries committed
1054 1055 1056
 * Drupal uses these functions to achieve consistency in its form presentation,
 * while at the same time simplifying code and reducing the amount of HTML that
 * must be explicily generated by modules.
Kjartan's avatar
Kjartan committed
1057
 */
Dries's avatar
 
Dries committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073

/**
 * Generate a form from a set of form elements.
 *
 * @param $form
 *   An HTML string containing one or more form elements.
 * @param $method
 *   The query method to use ("post" or "get").
 * @param $action
 *   The URL to send the form contents to, if not the current page.
 * @param $attributes
 *   An associative array of attributes to add to the form tag.
 * @result
 *   An HTML string with the contents of $form wrapped in a form tag.
 */
function form($form, $method = 'post', $action = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
1074
  if (!$action) {
1075
    $action = request_uri();
Dries's avatar
 
Dries committed
1076
  }
Dries's avatar
 
Dries committed
1077
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
 
Dries committed
1078 1079
}

Dries's avatar
 
Dries committed
1080
/**
Dries's avatar
 
Dries committed
1081
 * File an error against the form element with the specified name.
Dries's avatar
 
Dries committed
1082 1083 1084 1085 1086 1087 1088
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
 
Dries committed
1089
 * Return an associative array of all errors.
Dries's avatar
 
Dries committed
1090
 */
Dries's avatar
 
Dries committed
1091
function form_get_errors() {
1092 1093 1094
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
 
Dries committed
1095 1096 1097 1098 1099 1100
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name