common.inc 57.7 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.
 */

Dries's avatar
 
Dries committed
12
/**
Dries's avatar
 
Dries committed
13
 * Set the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
14
 *
Dries's avatar
 
Dries committed
15 16 17
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
18
 */
Dries's avatar
 
Dries committed
19 20 21 22 23 24 25 26 27
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

Dries's avatar
 
Dries committed
28 29 30
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
 
Dries committed
31 32 33 34 35 36 37 38 39 40
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

Dries's avatar
Dries committed
41
/**
Dries's avatar
 
Dries committed
42
 * Add output to the head tag of the HTML page.
Dries's avatar
 
Dries committed
43
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
44 45
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
46
  static $stored_head = '';
Dries's avatar
Dries committed
47 48

  if (!is_null($data)) {
Dries's avatar
 
Dries committed
49
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
50 51 52 53
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
54 55 56
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
57 58 59
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
60
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
61
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
62
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
63 64 65 66

  return $output . drupal_set_html_head();
}

Dries's avatar
 
Dries committed
67 68 69
/**
 * Regenerate the path map from the information in the database.
 */
Dries's avatar
 
Dries committed
70
function drupal_rebuild_path_map() {
Dries's avatar
 
Dries committed
71
  drupal_get_path_map('rebuild');
Dries's avatar
 
Dries committed
72
}
Kjartan's avatar
Kjartan committed
73

Dries's avatar
 
Dries committed
74
/**
Dries's avatar
 
Dries committed
75
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
76 77 78 79 80
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
Dries's avatar
 
Dries committed
81
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
82 83 84 85 86 87
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
88

Dries's avatar
Dries committed
89
/**
Dries's avatar
 
Dries committed
90
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
91 92
 */
function drupal_set_header($header = NULL) {
93
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
94
  // Otherwise, header('') could get called when serving the page later, which
95 96
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
97

98
  if (strlen($header)) {
Dries's avatar
Dries committed
99
    header($header);
100
    $stored_headers[] = $header;
Dries's avatar
Dries committed
101
  }
102
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
103 104
}

Dries's avatar
 
Dries committed
105 106 107
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
108 109 110 111
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
 
Dries committed
112 113 114
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
115
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
116 117
 */

Kjartan's avatar
Kjartan committed
118
/**
Dries's avatar
 
Dries committed
119
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
120
 *
Dries's avatar
 
Dries committed
121 122
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
123
 *
Dries's avatar
 
Dries committed
124 125 126 127 128 129 130 131 132 133 134 135 136
 * 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
137
 */
Dries's avatar
 
Dries committed
138 139 140
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
141

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

Dries's avatar
 
Dries committed
145 146
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
147 148
    }
    else {
Dries's avatar
 
Dries committed
149
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
150 151 152
    }
  }

Dries's avatar
 
Dries committed
153 154 155 156
  // 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
157

Dries's avatar
 
Dries committed
158 159 160
  // 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
161 162 163 164 165 166
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
167
function drupal_not_found() {
Dries's avatar
 
Dries committed
168
  header('HTTP/1.0 404 Not Found');
169
  watchdog('page not found', t('%page not found.', array('%page' => '<em>'. db_escape_string($_GET['q']) .'</em>')), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
170 171

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
172
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
173 174
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
 
Dries committed
175
    $status = menu_execute_active_handler();
Dries's avatar
 
Dries committed
176 177
  }

Dries's avatar
 
Dries committed
178
  if ($status != MENU_FOUND) {
179 180
    drupal_set_title(t('Page not found'));
    print theme('page', '');
Dries's avatar
 
Dries committed
181 182
  }
}
Dries's avatar
 
Dries committed
183

Dries's avatar
 
Dries committed
184 185 186 187 188
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
Dries's avatar
 
Dries committed
189
  watchdog('access denied', t('%page denied access.', array('%page' => '<em>'. db_escape_string($_GET['q']) .'</em>')), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries's avatar
 
Dries committed
190 191

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
192
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
193 194 195 196 197 198
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
199 200
    drupal_set_title(t('Access denied'));
    print theme('page', message_access());
Dries's avatar
 
Dries committed
201 202 203
  }
}

Dries's avatar
 
Dries committed
204
/**
Dries's avatar
 
Dries committed
205
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
206
 *
Dries's avatar
 
Dries committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
 * 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
224 225
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
226 227
  $result = new StdClass();

Dries's avatar
 
Dries committed
228
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
229 230 231 232 233 234
  $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
235 236
      // 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
237 238
      break;
    default:
Dries's avatar
 
Dries committed
239
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
240 241 242
      return $result;
  }

Dries's avatar
 
Dries committed
243
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
244
  if (!$fp) {
Dries's avatar
 
Dries committed
245
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
246 247 248
    return $result;
  }

Dries's avatar
 
Dries committed
249
  // Construct the path to act on.
Dries's avatar
 
Dries committed
250 251
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
252
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
253 254
  }

Dries's avatar
 
Dries committed
255
  // Create HTTP request.
Dries's avatar
 
Dries committed
256
  $defaults = array(
Dries's avatar
 
Dries committed
257
    'Host' => 'Host: '. $uri['host'],
258 259
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
260 261 262
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
263
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
264 265
  }

Dries's avatar
 
Dries committed
266
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
267 268 269
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
270
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
271 272 273 274 275 276
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
277
  $response = '';
278
  while (!feof($fp) && $data = fread($fp, 1024)) {
279
    $response .= $data;
Dries's avatar
 
Dries committed
280 281 282 283
  }
  fclose($fp);

  // Parse response.
284 285 286 287
  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
288 289 290
  $result->headers = array();

  // Parse headers.
291
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
292 293 294 295 296 297 298 299 300 301 302 303
    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
304
  // the base code in their class.
Dries's avatar
 
Dries committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
  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
332 333 334
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
335

Dries's avatar
 
Dries committed
336
/**
Dries's avatar
 
Dries committed
337 338 339 340
 * Log errors as defined by administrator
 * Error levels:
 *  1 = Log errors to database.
 *  2 = Log errors to database and to screen.
Dries's avatar
 
Dries committed
341
 */
Dries's avatar
 
Dries committed
342
function error_handler($errno, $message, $filename, $line, $variables) {
Dries's avatar
 
Dries committed
343 344 345
  if ($errno & E_ALL ^ E_NOTICE) {
    $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');
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
 
Dries committed
346

Dries's avatar
 
Dries committed
347
    if (variable_get('error_level', 1) == 1) {
Dries's avatar
 
Dries committed
348
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
349
    }
350 351

    watchdog('php', t('%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)), WATCHDOG_ERROR);
Dries's avatar
 
Dries committed
352 353 354
  }
}

Dries's avatar
Dries committed
355 356
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
357 358 359
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
360
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
361 362 363
  }
}

Dries's avatar
 
Dries committed
364 365 366 367
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
368 369
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
370
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
371 372 373 374 375 376
    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
377 378
}

Kjartan's avatar
Kjartan committed
379 380 381
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
382
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
383
 */
Dries's avatar
 
Dries committed
384 385 386 387

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
388 389
function array2object($array) {
  if (is_array($array)) {
Dries's avatar
 
Dries committed
390
    $object = new StdClass();
Dries's avatar
Dries committed
391
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
392 393 394 395
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
396
    $object = $array;
Dries's avatar
 
Dries committed
397 398 399 400 401
  }

  return $object;
}

Dries's avatar
 
Dries committed
402 403 404
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
405 406 407
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
408 409 410 411
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
412
    $array = $object;
Dries's avatar
 
Dries committed
413 414 415 416
  }

  return $array;
}
Dries's avatar
 
Dries committed
417 418 419 420

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

Kjartan's avatar
Kjartan committed
422 423 424
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
425
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
426
 */
Dries's avatar
 
Dries committed
427 428 429 430 431 432 433

/**
 * 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
434
function message_access() {
Dries's avatar
 
Dries committed
435
  return t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
436 437
}

Dries's avatar
 
Dries committed
438 439 440
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
441
function message_na() {
Dries's avatar
 
Dries committed
442
  return t('n/a');
Dries's avatar
 
Dries committed
443 444
}

Dries's avatar
 
Dries committed
445 446 447
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
448

Dries's avatar
 
Dries committed
449 450 451
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
452 453
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
454 455 456 457 458

  if (function_exists('i18n_get_lang')) {
    return i18n_get_lang();
  }

Dries's avatar
 
Dries committed
459 460 461 462 463
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
464 465 466
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries's avatar
 
Dries committed
467
  }
Dries's avatar
 
Dries committed
468 469 470 471 472 473
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
474 475
}

Kjartan's avatar
Kjartan committed
476
/**
Dries's avatar
 
Dries committed
477
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
478
 *
479
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
480 481 482 483
 * 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
484 485 486
 *   $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
487
 * @endcode
488 489 490
 * 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
491
 *
Dries's avatar
 
Dries committed
492
 * @param $string
Dries's avatar
 
Dries committed
493
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
494 495
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
496
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
497 498
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
499
 */
Dries's avatar
 
Dries committed
500
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
501 502 503 504
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
505

Dries's avatar
 
Dries committed
506 507
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
508 509
  }
  else {
Dries's avatar
 
Dries committed
510 511
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
512 513
}

Dries's avatar
 
Dries committed
514 515 516 517 518 519 520 521
/**
 * 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
522
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
523
  return htmlspecialchars($input, $quotes);
Dries's avatar
 
Dries committed
524 525
}

Kjartan's avatar
Kjartan committed
526
/**
Dries's avatar
 
Dries committed
527
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
528
 * @{
Dries's avatar
 
Dries committed
529
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
530 531
 */

532
/**
Dries's avatar
 
Dries committed
533 534 535
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
536
 *
Dries's avatar
 
Dries committed
537 538
 * @param $mail
 *   A string containing an email address.
Dries's avatar
 
Dries committed
539
 * @return
Dries's avatar
 
Dries committed
540
 *   TRUE if the address is in a valid format.
541
 */
Dries's avatar
 
Dries committed
542
function valid_email_address($mail) {
543
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
544
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
545 546 547
  $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
548
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
549 550
}

Dries's avatar
 
Dries committed
551 552 553
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
554
 * @param $url
Dries's avatar
 
Dries committed
555
 *   The URL to verify.
Dries's avatar
 
Dries committed
556
 * @param $absolute
Dries's avatar
 
Dries committed
557
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
558
 * @return
Dries's avatar
 
Dries committed
559
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
560
 */
Dries's avatar
 
Dries committed
561
function valid_url($url, $absolute = FALSE) {
562
  if ($absolute) {
563
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&%\+]+$/i", $url);
564 565
  }
  else {
566
    return preg_match("/^[a-z0-9\/:_\-_\.,\+]+$/i", $url);
567
  }
Dries's avatar
 
Dries committed
568 569
}

Dries's avatar
 
Dries committed
570 571 572 573 574 575 576 577 578 579
/**
 * 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
580 581
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
582
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
583
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
584
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
585
        return FALSE;
Kjartan's avatar
Kjartan committed
586 587 588
      }
    }
  }
Dries's avatar
Dries committed
589
  else if (isset($data)) {
Dries's avatar
 
Dries committed
590
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
591

592 593 594
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries's avatar
 
Dries committed
595 596 597 598
    // 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
599

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

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

    if ($match) {
607
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries's avatar
 
Dries committed
608
      return FALSE;
Kjartan's avatar
Kjartan committed
609 610 611
    }
  }

Dries's avatar
 
Dries committed
612
  return TRUE;
Kjartan's avatar
Kjartan committed
613
}
Dries's avatar
 
Dries committed
614 615 616
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
617

Dries's avatar
 
Dries committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
 *   The name of the event.
 */
function flood_register_event($name) {
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, $_SERVER['REMOTE_ADDR'], time());
}

/**
 * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
 * The user is allowed to proceed if he did not trigger the specified event more than
 * $threshold times per hour.
 *
 * @param $name
 *   The name of the event.
 * @param $number
 *   The maximum number of the specified event per hour (per visitor).
 * @return
 *   True if the user did not exceed the hourly threshold.  False otherwise.
 */
function flood_is_allowed($name, $threshold) {
  $number = db_num_rows(db_query("SELECT event FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, $_SERVER['REMOTE_ADDR'], time() - 3600));
  return ($number < $threshold ? TRUE : FALSE);
}

Dries's avatar
 
Dries committed
645
function check_form($text) {
Dries's avatar
 
Dries committed
646
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
647 648
}

649 650
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
651 652
}

Dries's avatar
 
Dries committed
653
/**
Dries's avatar
 
Dries committed
654
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
655
 * @{
Dries's avatar
 
Dries committed
656
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
657 658
 */

Dries's avatar
 
Dries committed
659 660 661 662 663 664
/**
 * 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
665 666
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
667
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
668 669 670 671
  $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
672
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
673
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
674
  }
Dries's avatar
 
Dries committed
675 676 677 678 679 680
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
681 682 683 684 685
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
686
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
687
  $output = "<item>\n";
Dries's avatar
 
Dries committed
688 689
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
690
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries's avatar
 
Dries committed
691
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
        if (is_array($value['attributes'])) {
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
      $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
    }
Dries's avatar
 
Dries committed
710
  }
Dries's avatar
 
Dries committed
711 712 713 714 715
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
716
/**
Dries's avatar
 
Dries committed
717
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
718
 *
Dries's avatar
 
Dries committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732
 * 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
733
 */
Dries's avatar
 
Dries committed
734
function format_plural($count, $singular, $plural) {
735
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
736 737 738 739 740 741 742 743 744

  // 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":
745
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
746 747 748 749 750 751
      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
752 753
}

Dries's avatar
 
Dries committed
754
/**
Dries's avatar
 
Dries committed
755
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
756
 *
Dries's avatar
 
Dries committed
757 758 759 760
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
761
 */
Dries's avatar
 
Dries committed
762
function format_size($size) {
Dries's avatar
 
Dries committed
763
  $suffix = t('bytes');
Dries's avatar
 
Dries committed
764 765
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
766
    $suffix = t('KB');
Dries's avatar
 
Dries committed
767 768 769
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
770
    $suffix = t('MB');
Dries's avatar
 
Dries committed
771
  }
Dries's avatar
 
Dries committed
772
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
773 774
}

Dries's avatar
 
Dries committed
775
/**
Dries's avatar
 
Dries committed
776
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
777
 *
Dries's avatar
 
Dries committed
778 779 780 781 782 783
 * @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
784
 */
Dries's avatar
 
Dries committed
785
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
786
  $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
787
  $output = '';
Dries's avatar
 
Dries committed
788
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
789
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
790
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
791
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
792
      $timestamp %= $value;
Dries's avatar
 
Dries committed
793 794 795 796 797
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
798 799
    }
  }
Dries's avatar
 
Dries committed
800
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
801 802
}

Dries's avatar
 
Dries committed
803
/**
Dries's avatar
 
Dries committed
804 805
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
806 807 808 809
 * 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
810 811 812 813 814 815
 * @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
816 817 818
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries's avatar
 
Dries committed
819 820 821 822
 * @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
823
 */
824 825 826
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
827 828 829 830 831 832
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
833
  }
Dries's avatar
 
Dries committed
834

835
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
836 837

  switch ($type) {
838 839
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
840
      break;
841 842
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
843
      break;
844
    case 'custom':
Dries's avatar
 
Dries committed
845
      // No change to format
Dries's avatar
 
Dries committed
846
      break;
847
    case 'medium':
Dries's avatar
 
Dries committed
848
    default:
849
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
850 851
  }

852
  $max = strlen($format);
Dries's avatar
 
Dries committed
853
  $date = '';
Dries's avatar
 
Dries committed
854 855
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
856
    if (strpos('AaDFlM', $c) !== false) {
857
      $date .= t(gmdate($c, $timestamp));
858
    }
859
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
860 861 862 863
      $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
864
    }
865 866 867 868 869
    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
870
    }
871 872 873
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
874
    else {
875
      $date .= $c;
Dries's avatar
 
Dries committed
876
    }
Dries's avatar
 
Dries committed
877
  }
878

Dries's avatar
 
Dries committed
879 880 881
  return $date;
}

Dries's avatar
 
Dries committed
882
/**
Dries's avatar
 
Dries committed
883
 * Format a username.
Dries's avatar
 
Dries committed
884
 *
Dries's avatar
 
Dries committed
885 886 887 888 889
 * @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
890
 */
Dries's avatar
 
Dries committed
891 892 893
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
 
Dries committed
894
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
895
    if (strlen($object->name) > 20) {
Dries's avatar
 
Dries committed
896
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
897 898 899 900 901
    }
    else {
      $name = $object->name;
    }

Dries's avatar
 
Dries committed
902
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
 
Dries committed
903
  }
Dries's avatar
 
Dries committed
904
  else if ($object->name) {
Dries's avatar
 
Dries committed
905 906 907 908
    // 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
909
    if ($object->homepage) {
Dries's avatar
 
Dries committed
910
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
 
Dries committed
911 912 913 914 915 916
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
 
Dries committed
917
  }
Dries's avatar
 
Dries committed
918
  else {
Dries's avatar
Dries committed
919
    $output = variable_get('anonymous', 'Anonymous');
Dries's avatar
 
Dries committed
920 921
  }

Dries's avatar
 
Dries committed
922
  return $output;
Dries's avatar
 
Dries committed
923
}
Dries's avatar
 
Dries committed
924 925 926
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
927

Kjartan's avatar
Kjartan committed
928
/**
Dries's avatar
 
Dries committed
929
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
930
 * @{
Dries's avatar
 
Dries committed
931
 * Functions to enable output of HTML forms and form elements.
932
 *
Dries's avatar
 
Dries committed
933 934
 * 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
935
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
936
 */
Dries's avatar
 
Dries committed
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952

/**
 * 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
953
  if (!$action) {
954
    $action = request_uri();
Dries's avatar
 
Dries committed
955
  }
Dries's avatar
 
Dries committed
956
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
 
Dries committed
957 958
}

Dries's avatar
 
Dries committed
959
/**
Dries's avatar
 
Dries committed
960
 * File an error against the form element with the specified name.
Dries's avatar
 
Dries committed
961 962 963 964 965 966 967
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
 
Dries committed
968
 * Return an associative array of all errors.
Dries's avatar
 
Dries committed
969
 */
Dries's avatar
 
Dries committed
970
function form_get_errors() {
971 972 973
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
 
Dries committed
974 975 976 977 978 979
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
 
Dries committed
980 981 982
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
 
Dries committed
983 984 985 986 987 988
}

function _form_get_class($name, $required, $error) {
  return $name. ($required ? ' required' : '') . ($error ? ' error' : '');
}

Dries's avatar
 
Dries committed
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
/**
 * Format a general form item.
 *
 * @param $title
 *   The label for the form item.
 * @param $value
 *   The contents of the form item.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $id
 *   A unique identifier for the form item.
 * @param $required
 *   Whether the user must fill in this form element before submitting the form.
 * @param $error
 *   An error message to display alongside the form element.
 * @return
 *   A themed HTML string representing the form item.
 */
Dries's avatar
 
Dries committed
1007
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE