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

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

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/**
 * Error reporting level: display no errors.
 */
define('ERROR_REPORTING_HIDE', 0);

/**
 * Error reporting level: display errors and warnings.
 */
define('ERROR_REPORTING_DISPLAY_SOME', 1);

/**
 * Error reporting level: display all messages.
 */
define('ERROR_REPORTING_DISPLAY_ALL', 2);

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/**
 * The weight of JavaScript libraries, settings or jQuery plugins being
 * added to the page.
 */
define('JS_LIBRARY', -100);

/**
 * The default weight of JavaScript being added to the page.
 */
define('JS_DEFAULT', 0);

/**
 * The weight of theme JavaScript code being added to the page.
 */
define('JS_THEME', 100);

58 59 60 61 62 63
/**
 * Error code indicating that the request made by drupal_http_request() exceeded
 * the specified timeout.
 */
define('HTTP_REQUEST_TIMEOUT', 1);

64
/**
65
 * Add content to a specified region.
66 67
 *
 * @param $region
68
 *   Page region the content is added to.
69
 * @param $data
70
 *   Content to be added.
71
 */
72
function drupal_add_region_content($region = NULL, $data = NULL) {
73 74 75 76 77 78 79 80 81
  static $content = array();

  if (!is_null($region) && !is_null($data)) {
    $content[$region][] = $data;
  }
  return $content;
}

/**
82
 * Get assigned content for a given region.
83 84
 *
 * @param $region
85 86
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
87 88 89
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
90 91
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
92 93
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
94
      return implode($delimiter, $content[$region]);
95
    }
96 97 98 99
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
100
        $content[$region] = implode($delimiter, $content[$region]);
101 102 103 104 105 106
      }
    }
    return $content;
  }
}

107
/**
108
 * Set the breadcrumb trail for the current page.
109
 *
110 111 112
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
113
 */
114
function drupal_set_breadcrumb($breadcrumb = NULL) {
115
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
116

117
  if (!is_null($breadcrumb)) {
118 119 120 121 122
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

123 124 125
/**
 * Get the breadcrumb trail for the current page.
 */
126 127 128
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

129
  if (is_null($breadcrumb)) {
130 131 132 133 134 135
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

136
/**
137 138
 * Return a string containing RDF namespaces for the <html> tag of an XHTML
 * page.
139 140 141 142 143 144 145 146 147 148
 */
function drupal_get_rdf_namespaces() {
  // Serialize the RDF namespaces used in RDFa annotation.
  $xml_rdf_namespaces = array();
  foreach (module_invoke_all('rdf_namespaces') as $prefix => $uri) {
    $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
  }
  return implode("\n  ", $xml_rdf_namespaces);
}

Dries's avatar
Dries committed
149
/**
150
 * Add output to the head tag of the HTML page.
151
 *
152
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
153
 */
154
function drupal_add_html_head($data = NULL) {
155
  $stored_head = &drupal_static(__FUNCTION__, '');
Dries's avatar
Dries committed
156 157

  if (!is_null($data)) {
158
    $stored_head .= $data . "\n";
Dries's avatar
Dries committed
159 160 161 162
  }
  return $stored_head;
}

163 164 165
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
166
function drupal_get_html_head() {
167
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
168
  return $output . drupal_add_html_head();
Dries's avatar
Dries committed
169 170
}

171
/**
172
 * Reset the static variable which holds the aliases mapped for this request.
173
 */
174 175
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
176
}
177

178
/**
179 180
 * Add a feed URL for the current page.
 *
181 182
 * This function can be called as long the HTML header hasn't been sent.
 *
183
 * @param $url
184
 *   A url for the feed.
185
 * @param $title
186
 *   The title of the feed.
187
 */
188
function drupal_add_feed($url = NULL, $title = '') {
189
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
190

191
  if (!is_null($url) && !isset($stored_feed_links[$url])) {
192
    $stored_feed_links[$url] = theme('feed_icon', $url, $title);
193 194 195 196 197

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
198 199 200 201 202 203 204 205
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
206
 *   A delimiter to split feeds by.
207 208 209 210 211 212
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

213 214 215
/**
 * @name HTTP handling
 * @{
216
 * Functions to properly handle HTTP responses.
217 218
 */

219 220 221 222
/**
 * Parse an array into a valid urlencoded query string.
 *
 * @param $query
223
 *   The array to be processed e.g. $_GET.
224
 * @param $exclude
225 226
 *   The array filled with keys to be excluded. Use parent[child] to exclude
 *   nested items.
227
 * @param $parent
228
 *   Should not be passed, only used in recursive calls.
229
 * @return
230
 *   An urlencoded string which can be appended to/as the URL query string.
231 232 233 234 235
 */
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
236
    $key = rawurlencode($key);
237
    if ($parent) {
238
      $key = $parent . '[' . $key . ']';
239 240
    }

241
    if (in_array($key, $exclude)) {
242 243 244 245 246 247 248
      continue;
    }

    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
249
      $params[] = $key . '=' . rawurlencode($value);
250 251 252 253 254 255
    }
  }

  return implode('&', $params);
}

256
/**
257
 * Prepare a destination query string for use in combination with drupal_goto().
258
 *
259 260 261 262
 * Used to direct the user back to the referring page after completing a form.
 * By default the current URL is returned. If a destination exists in the
 * previous request, that destination is returned. As such, a destination can
 * persist across multiple pages.
263 264 265 266
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
267
  if (isset($_REQUEST['destination'])) {
268
    return 'destination=' . urlencode($_REQUEST['destination']);
269 270
  }
  else {
271 272
    // Use $_GET here to retrieve the original path in source form.
    $path = isset($_GET['q']) ? $_GET['q'] : '';
273 274
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
275
      $path .= '?' . $query;
276
    }
277
    return 'destination=' . urlencode($path);
278 279 280
  }
}

281
/**
282
 * Send the user to a different Drupal page.
283
 *
284 285
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
286
 *
287
 * Usually the redirected URL is constructed from this function's input
288
 * parameters. However you may override that behavior by setting a
289
 * destination in either the $_REQUEST-array (i.e. by using
290
 * the query string of an URI) This is used to direct the user back to
291
 * the proper page after completing a form. For example, after editing
292
 * a post on the 'admin/content/node'-page or after having logged on using the
293
 * 'user login'-block in a sidebar. The function drupal_get_destination()
294 295
 * can be used to help set the destination URL.
 *
296 297
 * Drupal will ensure that messages set by drupal_set_message() and other
 * session data are written to the database before the user is redirected.
298
 *
299
 * This function ends the request; use it instead of a return in your menu callback.
300 301
 *
 * @param $path
302
 *   A Drupal path or a full URL.
303
 * @param $query
304
 *   A query string component, if any.
305
 * @param $fragment
306
 *   A destination fragment identifier (named anchor).
307 308 309 310 311 312 313 314
 * @param $http_response_code
 *   Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
 *   - 301 Moved Permanently (the recommended value for most redirects)
 *   - 302 Found (default in Drupal and PHP, sometimes used for spamming search
 *         engines)
 *   - 303 See Other
 *   - 304 Not Modified
 *   - 305 Use Proxy
315
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
316
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
317
 *   supported.
318
 * @see drupal_get_destination()
319
 */
320
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
321

322
  if (isset($_REQUEST['destination'])) {
323
    extract(parse_url(urldecode($_REQUEST['destination'])));
324 325
  }

326
  $url = url($path, array('query' => $query, 'fragment' => $fragment, 'absolute' => TRUE));
327

328
  // Allow modules to react to the end of the page request before redirecting.
329
  // We do not want this while running update.php.
330
  if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
331 332
    module_invoke_all('exit', $url);
  }
333

334 335 336
  // Commit the session, if necessary. We need all session data written to the
  // database before redirecting.
  drupal_session_commit();
337

338
  header('Location: ' . $url, TRUE, $http_response_code);
339 340

  // The "Location" header sends a redirect status code to the HTTP daemon. In
341 342
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
343 344 345
  exit();
}

346
/**
347
 * Generates a site offline message.
348 349
 */
function drupal_site_offline() {
350
  drupal_maintenance_theme();
351
  drupal_set_header('503 Service unavailable');
352
  drupal_set_title(t('Site offline'));
353
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
354
    t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal'))))));
355 356
}

357 358 359
/**
 * Generates a 404 error if the request can not be handled.
 */
360
function drupal_not_found() {
361
  drupal_set_header('404 Not Found');
362

363
  watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
364

365
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
366
  if ($path && $path != $_GET['q']) {
367 368
    // Custom 404 handler. Set the active item in case there are tabs to
    // display, or other dependencies on the path.
369
    menu_set_active_item($path);
370
    $return = menu_execute_active_handler($path);
371
  }
372

373
  if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
374
    // Standard 404 handler.
drumm's avatar
drumm committed
375
    drupal_set_title(t('Page not found'));
376
    $return = t('The requested page could not be found.');
377
  }
378

379 380
  drupal_set_page_content($return);
  $page = element_info('page');
381 382
  // Optionally omit the blocks to conserve CPU and bandwidth.
  $page['#show_blocks'] = variable_get('site_404_blocks', FALSE);
383 384

  print drupal_render_page($page);
385
}
386

387 388 389 390
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
391
  drupal_set_header('403 Forbidden');
392

393
  watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
394 395

  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
396
  if ($path && $path != $_GET['q']) {
397 398
    // Custom 403 handler. Set the active item in case there are tabs to
    // display or other dependencies on the path.
399
    menu_set_active_item($path);
400
    $return = menu_execute_active_handler($path);
401
  }
402

403
  if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
404
    // Standard 403 handler.
drumm's avatar
drumm committed
405 406
    drupal_set_title(t('Access denied'));
    $return = t('You are not authorized to access this page.');
407
  }
408 409

  print drupal_render_page($return);
410 411
}

412
/**
413
 * Perform an HTTP request.
414
 *
415 416
 * This is a flexible and powerful HTTP client implementation. Correctly
 * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
417 418 419
 *
 * @param $url
 *   A string containing a fully qualified URI.
420 421 422 423 424 425 426 427 428 429 430
 * @param $options
 *   (optional) An array which can have one or more of following keys:
 *   - headers
 *       An array containing request headers to send as name/value pairs.
 *   - method
 *       A string containing the request method. Defaults to 'GET'.
 *   - data
 *       A string containing the request body. Defaults to NULL.
 *   - max_redirects
 *       An integer representing how many times a redirect may be followed.
 *       Defaults to 3.
431 432 433 434
 *   - timeout
 *       A float representing the maximum number of seconds the function call
 *       may take. The default is 30 seconds. If a timeout occurs, the error
 *       code is set to the HTTP_REQUEST_TIMEOUT constant.
435
 * @return
436 437 438 439 440 441
 *   An object which can have one or more of the following parameters:
 *   - request
 *       A string containing the request body that was sent.
 *   - code
 *       An integer containing the response status code, or the error code if
 *       an error occurred.
442
 *   - protocol
443
 *       The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
444
 *   - status_message
445
 *       The status message from the response, if a response was received.
446 447 448 449 450
 *   - redirect_code
 *       If redirected, an integer containing the initial response status code.
 *   - redirect_url
 *       If redirected, a string containing the redirection location.
 *   - error
451
 *       If an error occurred, the error message. Otherwise not set.
452 453 454 455
 *   - headers
 *       An array containing the response headers as name/value pairs.
 *   - data
 *       A string containing the response body that was received.
456
 */
457
function drupal_http_request($url, array $options = array()) {
458
  global $db_prefix;
459

460
  $result = new stdClass();
461

462
  // Parse the URL and make sure we can handle the schema.
463
  $uri = @parse_url($url);
464

465 466
  if ($uri == FALSE) {
    $result->error = 'unable to parse URL';
467 468 469
    return $result;
  }

470 471
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
472 473 474
    return $result;
  }

475 476 477 478 479 480 481 482 483 484 485
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
    'timeout' => 30,
  );

486 487
  switch ($uri['scheme']) {
    case 'http':
488
      $port = isset($uri['port']) ? $uri['port'] : 80;
489
      $host = $uri['host'] . ($port != 80 ? ':' . $port : '');
490
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, $options['timeout']);
491 492
      break;
    case 'https':
493
      // Note: Only works when PHP is compiled with OpenSSL support.
494
      $port = isset($uri['port']) ? $uri['port'] : 443;
495
      $host = $uri['host'] . ($port != 443 ? ':' . $port : '');
496
      $fp = @fsockopen('ssl://' . $uri['host'], $port, $errno, $errstr, $options['timeout']);
497 498
      break;
    default:
499
      $result->error = 'invalid schema ' . $uri['scheme'];
500 501 502
      return $result;
  }

503
  // Make sure the socket opened properly.
504
  if (!$fp) {
505 506
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
507 508
    $result->code = -$errno;
    $result->error = trim($errstr);
509 510 511 512 513 514 515

    // Mark that this request failed. This will trigger a check of the web
    // server's ability to make outgoing HTTP requests the next time that
    // requirements checking is performed.
    // @see system_requirements()
    variable_set('drupal_http_request_fails', TRUE);

516 517 518
    return $result;
  }

519
  // Construct the path to act on.
520 521
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
522
    $path .= '?' . $uri['query'];
523 524
  }

525 526 527
  // Merge the default headers.
  $options['headers'] += array(
    'User-Agent' => 'Drupal (+http://drupal.org/)',
528 529
  );

530 531 532 533 534
  // RFC 2616: "non-standard ports MUST, default ports MAY be included".
  // We don't add the standard port to prevent from breaking rewrite rules
  // checking the host that do not take into account the port number.
  $options['headers']['Host'] = $host;

535 536 537 538
  // Only add Content-Length if we actually have any content or if it is a POST
  // or PUT request. Some non-standard servers get confused by Content-Length in
  // at least HEAD/GET requests, and Squid always requires Content-Length in
  // POST/PUT requests.
539 540 541
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
542 543 544
  }

  // If the server URL has a user then attempt to use basic authentication.
545
  if (isset($uri['user'])) {
546
    $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (!empty($uri['pass']) ? ":" . $uri['pass'] : ''));
547 548
  }

549 550 551 552 553 554
  // If the database prefix is being used by SimpleTest to run the tests in a copied
  // database then set the user-agent header to the database prefix so that any
  // calls to other Drupal pages will run the SimpleTest prefixed database. The
  // user-agent is used to ensure that multiple testing sessions running at the
  // same time won't interfere with each other as they would if the database
  // prefix were stored statically in a file or database variable.
555
  if (is_string($db_prefix) && preg_match("/^simpletest\d+/", $db_prefix, $matches)) {
556
    $options['headers']['User-Agent'] = $matches[0];
557 558
  }

559
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
560
  foreach ($options['headers'] as $name => $value) {
561
    $request .= $name . ': ' . trim($value) . "\r\n";
562
  }
563
  $request .= "\r\n" . $options['data'];
564 565 566 567 568
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
569
  $response = '';
570 571 572 573 574 575 576 577 578 579
  while (!feof($fp)) {
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
      $result->code = HTTP_REQUEST_TIMEOUT;
      $result->error = 'request timed out';
      return $result;
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
    $response .= fread($fp, 1024);
580 581 582
  }
  fclose($fp);

583 584 585
  // Parse response headers from the response body.
  list($response, $result->data) = explode("\r\n\r\n", $response, 2);
  $response = preg_split("/\r\n|\n|\r/", $response);
586

587
  // Parse the response status line.
588 589 590 591
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

592 593
  $result->headers = array();

594 595
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
596
    list($header, $value) = explode(':', $line, 2);
597 598 599
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
600
      $result->headers[$header] .= ',' . trim($value);
601 602 603 604
    }
    else {
      $result->headers[$header] = trim($value);
    }
605 606 607
  }

  $responses = array(
608 609 610 611 612 613 614 615 616 617 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 645 646 647
    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',
648
  );
649 650
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
651 652 653
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
654
  $result->code = $code;
655 656 657 658 659 660 661 662 663

  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'];
664 665 666 667 668 669
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
670 671 672
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
673
        $result->redirect_code = $code;
674 675 676 677
      }
      $result->redirect_url = $location;
      break;
    default:
678
      $result->error = $status_message;
679 680 681 682
  }

  return $result;
}
683 684 685
/**
 * @} End of "HTTP handling".
 */
686

687
/**
688
 * Custom PHP error handler.
689
 *
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
 * @param $error_level
 *   The level of the error raised.
 * @param $message
 *   The error message.
 * @param $filename
 *   The filename that the error was raised in.
 * @param $line
 *   The line number the error was raised at.
 * @param $context
 *   An array that points to the active symbol table at the point the error occurred.
 */
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
  if ($error_level & error_reporting()) {
    // All these constants are documented at http://php.net/manual/en/errorfunc.constants.php
    $types = array(
      E_ERROR => 'Error',
      E_WARNING => 'Warning',
      E_PARSE => 'Parse error',
      E_NOTICE => 'Notice',
      E_CORE_ERROR => 'Core error',
      E_CORE_WARNING => 'Core warning',
      E_COMPILE_ERROR => 'Compile error',
      E_COMPILE_WARNING => 'Compile warning',
      E_USER_ERROR => 'User error',
      E_USER_WARNING => 'User warning',
      E_USER_NOTICE => 'User notice',
      E_STRICT => 'Strict warning',
      E_RECOVERABLE_ERROR => 'Recoverable fatal error'
    );
    $backtrace = debug_backtrace();
720

721 722
    $caller = _drupal_get_last_caller(debug_backtrace());

723
    // We treat recoverable errors as fatal.
724 725 726 727 728 729 730
    _drupal_log_error(array(
      '%type' => isset($types[$error_level]) ? $types[$error_level] : 'Unknown error',
      '%message' => $message,
      '%function' => $caller['function'],
      '%file' => $caller['file'],
      '%line' => $caller['line'],
    ), $error_level == E_RECOVERABLE_ERROR);
731 732 733 734 735 736 737 738 739 740 741 742
  }
}

/**
 * Custom PHP exception handler.
 *
 * Uncaught exceptions are those not enclosed in a try/catch block. They are
 * always fatal: the execution of the script will stop as soon as the exception
 * handler exits.
 *
 * @param $exception
 *   The exception object that was thrown.
743
 */
744
function _drupal_exception_handler($exception) {
745 746 747 748 749 750 751 752 753 754 755 756
  // Log the message to the watchdog and return an error page to the user.
  _drupal_log_error(_drupal_decode_exception($exception), TRUE);
}

/**
 * Decode an exception, especially to retrive the correct caller.
 *
 * @param $exception
 *   The exception object that was thrown.
 * @return An error in the format expected by _drupal_log_error().
 */
function _drupal_decode_exception($exception) {
757 758
  $message = $exception->getMessage();

759 760 761 762 763 764 765 766 767 768 769
  $backtrace = $exception->getTrace();
  // Add the line throwing the exception to the backtrace.
  array_unshift($backtrace, array('line' => $exception->getLine(), 'file' => $exception->getFile()));

  // For PDOException errors, we try to return the initial caller,
  // skipping internal functions of the database layer.
  if ($exception instanceof PDOException) {
    // The first element in the stack is the call, the second element gives us the caller.
    // We skip calls that occurred in one of the classes of the database layer
    // or in one of its global functions.
    $db_functions = array('db_query', 'pager_query', 'db_query_range', 'db_query_temporary', 'update_sql');
770
    while (!empty($backtrace[1]) && ($caller = $backtrace[1]) &&
771
        ((isset($caller['class']) && (strpos($caller['class'], 'Query') !== FALSE || strpos($caller['class'], 'Database') !== FALSE || $caller['class'] == 'PDOStatement')) ||
772
        in_array($caller['function'], $db_functions))) {
773 774 775
      // We remove that call.
      array_shift($backtrace);
    }
776 777 778
    if (isset($exception->query_string, $exception->args)) {
      $message .= ": " . $exception->query_string . "; " . print_r($exception->args, TRUE);
    }
779
  }
780
  $caller = _drupal_get_last_caller($backtrace);
781

782 783
  return array(
    '%type' => get_class($exception),
784
    '%message' => $message,
785 786 787 788
    '%function' => $caller['function'],
    '%file' => $caller['file'],
    '%line' => $caller['line'],
  );
789
}
790

791 792 793
/**
 * Log a PHP error or exception, display an error page in fatal cases.
 *
794 795
 * @param $error
 *   An array with the following keys: %type, %message, %function, %file, %line.
796 797 798
 * @param $fatal
 *   TRUE if the error is fatal.
 */
799
function _drupal_log_error($error, $fatal = FALSE) {
800
  // Initialize a maintenance theme if the boostrap was not complete.
801 802 803
  // Do it early because drupal_set_message() triggers an init_theme().
  if ($fatal && (drupal_get_bootstrap_phase() != DRUPAL_BOOTSTRAP_FULL)) {
    unset($GLOBALS['theme']);
804 805 806
    if (!defined('MAINTENANCE_MODE')) {
      define('MAINTENANCE_MODE', 'error');
    }
807 808
    drupal_maintenance_theme();
  }
809

810 811
  // When running inside the testing framework, we relay the errors
  // to the tested site by the way of HTTP headers.
812
  if (isset($_SERVER['HTTP_USER_AGENT']) && preg_match("/^simpletest\d+$/", $_SERVER['HTTP_USER_AGENT']) && !headers_sent() && (!defined('SIMPLETEST_COLLECT_ERRORS') || SIMPLETEST_COLLECT_ERRORS)) {
813 814
    // $number does not use drupal_static as it should not be reset
    // as it uniquely identifies each PHP error.
815 816
    static $number = 0;
    $assertion = array(
817 818
      $error['%message'],
      $error['%type'],
819 820 821 822 823
      array(
        'function' => $error['%function'],
        'file' => $error['%file'],
        'line' => $error['%line'],
      ),
824 825 826 827 828
    );
    header('X-Drupal-Assertion-' . $number . ': ' . rawurlencode(serialize($assertion)));
    $number++;
  }

829 830 831 832
  try {
    watchdog('php', '%type: %message in %function (line %line of %file).', $error, WATCHDOG_ERROR);
  }
  catch (Exception $e) {
833 834
    // Ignore any additional watchdog exception, as that probably means
    // that the database was not initialized correctly.
835
  }
836

837
  if ($fatal) {
838
    drupal_set_header('500 Service unavailable (with message)');
839 840 841 842 843 844 845
  }

  if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest') {
    if ($fatal) {
      // When called from JavaScript, simply output the error message.
      print t('%type: %message in %function (line %line of %file).', $error);
      exit;
Dries's avatar
Dries committed
846
    }
847 848 849 850 851 852 853 854 855 856 857 858 859 860
  }
  else {
    // Display the message if the current error reporting level allows this type
    // of message to be displayed, and unconditionnaly in update.php.
    $error_level = variable_get('error_level', ERROR_REPORTING_DISPLAY_ALL);
    $display_error = $error_level == ERROR_REPORTING_DISPLAY_ALL || ($error_level == ERROR_REPORTING_DISPLAY_SOME && $error['%type'] != 'Notice');
    if ($display_error || (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'update')) {
      drupal_set_message(t('%type: %message in %function (line %line of %file).', $error), 'error');
    }

    if ($fatal) {
      drupal_set_title(t('Error'));
      // We fallback to a maintenance page at this point, because the page generation
      // itself can generate errors.
861
      print theme('maintenance_page', t('The website encountered an unexpected error. Please try again later.'), FALSE);
862
      exit;
863
    }
Dries's avatar
Dries committed
864 865 866
  }
}

867
/**
868
 * Gets the last caller from a backtrace.
869 870 871 872 873 874 875
 *
 * @param $backtrace
 *   A standard PHP backtrace.
 * @return
 *   An associative array with keys 'file', 'line' and 'function'.
 */
function _drupal_get_last_caller($backtrace) {
876 877 878 879 880 881
  // Errors that occur inside PHP internal functions
  // do not generate information about file and line.
  while ($backtrace && !isset($backtrace[0]['line'])) {
    array_shift($backtrace);
  }

882 883 884
  // The first trace is the call itself.
  // It gives us the line and the file of the last call.
  $call = $backtrace[0];
885

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
  // The second call give us the function where the call originated.
  if (isset($backtrace[1])) {
    if (isset($backtrace[1]['class'])) {
      $call['function'] = $backtrace[1]['class'] . $backtrace[1]['type'] . $backtrace[1]['function'] . '()';
    }
    else {
      $call['function'] = $backtrace[1]['function'] . '()';
    }
  }
  else {
    $call['function'] = 'main()';
  }
  return $call;
}

901
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
902
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
903 904 905
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
906
    $item = stripslashes($item);
907 908 909
  }
}

910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
/**
 * Helper function to strip slashes from $_FILES skipping over the tmp_name keys
 * since PHP generates single backslashes for file paths on Windows systems.
 *
 * tmp_name does not have backslashes added see
 * http://php.net/manual/en/features.file-upload.php#42280
 */
function _fix_gpc_magic_files(&$item, $key) {
  if ($key != 'tmp_name') {
    if (is_array($item)) {
      array_walk($item, '_fix_gpc_magic_files');
    }
    else {
      $item = stripslashes($item);
    }
  }
}

928
/**
929
 * Fix double-escaping problems caused by "magic quotes" in some PHP installations.
930
 */
931
function fix_gpc_magic() {
932
  $fixed = &drupal_static(__FUNCTION__, FALSE);
933
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
934 935 936 937
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
938
    array_walk($_FILES, '_fix_gpc_magic_files');
939
    $fixed = TRUE;
Dries's avatar
Dries committed
940
  }
941 942
}

943
/**
944
 * Translate strings to the page language or a given language.
945
 *
946
 * Human-readable text that will be displayed somewhere within a page should
947
 * be run through the t() function.
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
 *
 * Examples:
 * @code
 *   if (!$info || !$info['extension']) {
 *     form_set_error('picture_upload', t('The uploaded file was not an image.'));
 *   }
 *
 *   $form['submit'] = array(
 *     '#type' => 'submit',
 *     '#value' => t('Log in'),
 *   );
 * @endcode
 *
 * Any text within t() can be extracted by translators and changed into
 * the equivalent text in their native language.
 *
 * Special variables called "placeholders" are used to signal dynamic
 * information in a string which should not be translated. Placeholders
966 967
 * can also be used for text that may change from time to time (such as
 * link paths) to be changed without requiring updates to translations.
968 969 970 971 972 973 974 975 976 977 978 979
 *
 * For example:
 * @code
 *   $output = t('There are currently %members and %visitors online.', array(
 *     '%members' => format_plural($total_users, '1 user', '@count users'),
 *     '%visitors' => format_plural($guests->count, '1 guest', '@count guests')));
 * @endcode
 *
 * There are three styles of placeholders:
 * - !variable, which indicates that the text should be inserted as-is. This is
 *   useful for inserting variables into things like e-mail.
 *   @code
980
 *     $message[] = t("If you don't want to receive such e-mails, you can change your settings at !url.", array('!url' => url("user/$account->uid", array('absolute' => TRUE))));
981 982
 *   @endcode
 *
983 984 985
 * - @variable, which indicates that the text should be run through
 *   check_plain, to escape HTML characters. Use this for any output that's
 *   displayed within a Drupal page.
986
 *   @code
987
 *     drupal_set_title($title = t("@name's blog", array('@name' => $account->name)), PASS_THROUGH);
988 989
 *   @endcode
 *
990 991 992
 * - %variable, which indicates that the string should be HTML escaped and
 *   highlighted with theme_placeholder() which shows up by default as
 *   <em>emphasized</em>.
993
 *   @code
994
 *     $message = t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name));
995 996
 *   @endcode
 *
997
 * When using t(), try to put entire sentences and strings in one t() call.
998 999 1000 1001
 * This makes it easier for translators, as it provides context as to what
 * each word refers to. HTML markup within translation strings is allowed, but
 * should be avoided if possible. The exception are embedded links; link
 * titles add a context for translators, so should be kept in the main string.
1002
 *
1003
 * Here is an example of incorrect usage of t():
1004 1005 1006 1007 1008 1009
 * @code
 *   $output .= t('<p>Go to the @contact-page.</p>', array('@contact-page' => l(t('contact page'), 'contact')));
 * @endcode
 *
 * Here is an example of t() used correctly:
 * @code
1010
 *   $output .= '<p>' . t('Go to the <a href="@contact-page">contact page</a>.', array('@contact-page' => url('contact'))) . '</p>';
1011 1012
 * @endcode
 *
1013
 * Avoid escaping quotation marks wherever possible.
1014 1015 1016 1017 1018 1019 1020
 *
 * Incorrect:
 * @code
 *   $output .= t('Don\'t click me.');
 * @endcode
 *
 * Correct:
1021
 * @code
1022
 *   $output .= t("Don't click me.");
1023
 * @endcode
1024
 *
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
 * Because t() is designed for handling code-based strings, in almost all
 * cases, the actual string and not a variable must be passed through t().
 *
 * Extraction of translations is done based on the strings contained in t()
 * calls. If a variable is passed through t(), the content of the variable
 * cannot be extracted from the file for translation.
 *
 * Incorrect:
 * @code
 *   $message = 'An error occurred.';
 *   drupal_set_message(t($message), 'error');
 *   $output .= t($message);
 * @endcode
 *
 * Correct:
 * @code
 *   $message = t('An error occurred.');
 *   drupal_set_message($message, 'error');
 *   $output .= $message;
 * @endcode
 *
 * The only case in which variables can be passed safely through t() is when
 * code-based versions of the same strings will be passed through t() (or
 * otherwise extracted) elsewhere.
 *
 * In some cases, modules may include strings in code that can't use t()
 * calls. For example, a module may use an external PHP application that
 * produces strings that are loaded into variables in Drupal for output.
 * In these cases, module authors may include a dummy file that passes the
 * relevant strings through t(). This approach will allow the strings to be
 * extracted.
 *
 * Sample external (non-Drupal) code:
 * @code
 *   class Time {
 *     public $yesterday = 'Yesterday';
 *     public $today = 'Today';
 *     public $tomorrow = 'Tomorrow';
 *   }
 * @endcode
 *
1066
 * Sample dummy file.
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
 * @code
 *   // Dummy function included in example.potx.inc.
 *   function example_potx() {
 *     $strings = array(
 *       t('Yesterday'),
 *       t('Today'),
 *       t('Tomorrow'),
 *     );
 *     // No return value needed, since this is a dummy function.
 *   }
 * @endcode
 *
 * Having passed strings through t() in a dummy function, it is then
 * okay to pass variables through t().
 *
 * Correct (if a dummy file was used):
 * @code
 *   $time = new Time();
 *   $output .= t($time->today);
 * @endcode
 *
 * However tempting it is, custom data from user input or other non-code
 * sources should not be passed through t(). Doing so leads to the following
 * problems and errors:
 *  - The t() system doesn't support updates to existing strings. When user
 *    data is updated, the next time it's passed through t() a new record is
 *    created instead of an update. The database bloats over time and any
 *    existing translations are orphaned with each update.
 *  - The t() system assumes any data it receives is in English. User data may
 *    be in another language, producing translation errors.
 *  - The "Built-in interface" text group in the locale system is used to
 *    produce translations for storage in .po files. When non-code strings are
 *    passed through t(), they are added to this text group, which is rendered
 *    inaccurate since it is a mix of actual interface strings and various user
 *    input strings of uncertain origin.
 *
 * Incorrect:
 * @code
 *   $item = item_load();
 *   $output .= check_plain(t($item['title']));
 * @endcode
 *
 * Instead, translation of these data can be done through the locale system,
 * either directly or through helper functions provided by contributed
 * modules.
 * @see hook_locale()
 *
 * During installation, st() is used in place of t(). Code that may be called
 * during installation or during normal operation should use the get_t()
 * helper function.
 * @see st()
1118 1119
 * @see get_t()
 *
1120
 * @param $string
1121
 *   A string containing the English string to translate.
1122 1123
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
1124 1125
 *   of any key in this array are replaced with the corresponding value. Based
 *   on the first character of the key, the value is escaped and/or themed:
1126 1127 1128 1129
 *    - !variable: inserted as is
 *    - @variable: escape plain text to HTML (check_plain)
 *    - %variable: escape text and theme as a placeholder for user-submitted
 *      content (check_plain + theme_placeholder)
1130 1131 1132 1133 1134 1135
 * @param $options
 *   An associative array of additional options, with the following keys:
 *     - 'langcode' (default to the current language) The language code to
 *       translate to a language other than what is used to display the page.
 *     - 'context' (default to the empty context) The context the source string
 *       belongs to.
1136 1137
 * @return
 *   The translated string.
1138
 */
1139
function t($string, array $args = array(), array $options = array()) {
1140
  global $language;
1141
  $custom_strings = &drupal_static(__FUNCTION__);
1142

1143 1144 1145 1146 1147 1148
  // Merge in default.
  if (empty($options['langcode'])) {
    $options['langcode'] = isset($language->language) ? $language->language : 'en';
  }
  if (empty($options['context'])) {
    $options['context'] = '';
1149
  }
1150

1151 1152 1153 1154
  // First, check for an array of customized strings. If present, use the array
  // *instead of* database lookups. This is a high performance way to provide a
  // handful of string replacements. See settings.php for examples.
  // Cache the $custom_strings variable to improve performance.
1155 1156
  if (!isset($custom_strings[$options['langcode']])) {
    $custom_strings[$options['langcode']] = variable_get('locale_custom_strings_' . $options['langcode'], array());
1157 1158
  }
  // Custom strings work for English too, even if locale module is disabled.
1159 1160
  if (isset($custom_strings[$options['langcode']][$options['context']][$string])) {
    $string = $custom_strings[$options['langcode']][$options['context']][$string];
1161 1162
  }
  // Translate with locale module if enabled.
1163 1164 1165
  // We don't use drupal_function_exists() here, because it breaks the testing
  // framework if the locale module is enabled in the parent site (we cannot
  // unload functions in PHP).
1166 1167
  elseif (module_exists('locale') && $options['langcode'] != 'en') {
    $string = locale($string, $options['context'], $options['langcode']);
1168
  }
1169
  if (empty($args)) {
1170
    return $string;
Kjartan's avatar
Kjartan committed
1171 1172
  }
  else {
1173
    // Transform arguments before inserting them.