common.inc 116 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
/**
 * 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);

27 28 29 30 31 32 33 34
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 * @param $data
 *   Content to be set.
 */
35
function drupal_set_content($region = NULL, $data = NULL) {
36 37 38 39 40 41 42 43 44 45 46 47
  static $content = array();

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

/**
 * Get assigned content.
 *
 * @param $region
48 49
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
50 51 52
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
53
function drupal_get_content($region = NULL, $delimiter = ' ') {
54
  $content = drupal_set_content();
55 56
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
57
      return implode($delimiter, $content[$region]);
58
    }
59 60 61 62
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
63
        $content[$region] = implode($delimiter, $content[$region]);
64 65 66 67 68 69
      }
    }
    return $content;
  }
}

70
/**
71
 * Set the breadcrumb trail for the current page.
72
 *
73 74 75
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
76
 */
77 78 79
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

80
  if (!is_null($breadcrumb)) {
81 82 83 84 85
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

86 87 88
/**
 * Get the breadcrumb trail for the current page.
 */
89 90 91
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

92
  if (is_null($breadcrumb)) {
93 94 95 96 97 98
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
99
/**
100
 * Add output to the head tag of the HTML page.
101
 *
102
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
103 104
 */
function drupal_set_html_head($data = NULL) {
105
  static $stored_head = '';
Dries's avatar
Dries committed
106 107

  if (!is_null($data)) {
108
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
109 110 111 112
  }
  return $stored_head;
}

113 114 115
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
116
function drupal_get_html_head() {
117
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
118 119 120
  return $output . drupal_set_html_head();
}

121
/**
122
 * Reset the static variable which holds the aliases mapped for this request.
123
 */
124 125
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
126
}
127

Dries's avatar
Dries committed
128
/**
129
 * Set an HTTP response header for the current page.
130
 *
131
 * Note: When sending a Content-Type header, always include a 'charset' type,
132
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
Dries's avatar
Dries committed
133 134
 */
function drupal_set_header($header = NULL) {
135
  // We use an array to guarantee there are no leading or trailing delimiters.
136
  // Otherwise, header('') could get called when serving the page later, which
137 138
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
139

140
  if (strlen($header)) {
Dries's avatar
Dries committed
141
    header($header);
142
    $stored_headers[] = $header;
Dries's avatar
Dries committed
143
  }
144
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
145 146
}

147 148 149
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
150 151 152 153
function drupal_get_headers() {
  return drupal_set_header();
}

154
/**
155 156 157
 * Add a feed URL for the current page.
 *
 * @param $url
158
 *   A url for the feed.
159
 * @param $title
160
 *   The title of the feed.
161
 */
162
function drupal_add_feed($url = NULL, $title = '') {
163 164
  static $stored_feed_links = array();

165
  if (!is_null($url) && !isset($stored_feed_links[$url])) {
166
    $stored_feed_links[$url] = theme('feed_icon', $url, $title);
167 168 169 170 171

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
172 173 174 175 176 177 178 179
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
180
 *   A delimiter to split feeds by.
181 182 183 184 185 186
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

187 188 189
/**
 * @name HTTP handling
 * @{
190
 * Functions to properly handle HTTP responses.
191 192
 */

193 194 195 196
/**
 * Parse an array into a valid urlencoded query string.
 *
 * @param $query
197
 *   The array to be processed e.g. $_GET.
198
 * @param $exclude
199 200
 *   The array filled with keys to be excluded. Use parent[child] to exclude
 *   nested items.
201
 * @param $parent
202
 *   Should not be passed, only used in recursive calls.
203
 * @return
204
 *   An urlencoded string which can be appended to/as the URL query string.
205 206 207 208 209
 */
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
210
    $key = drupal_urlencode($key);
211
    if ($parent) {
212
      $key = $parent .'['. $key .']';
213 214
    }

215
    if (in_array($key, $exclude)) {
216 217 218 219 220 221 222
      continue;
    }

    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
223
      $params[] = $key .'='. drupal_urlencode($value);
224 225 226 227 228 229
    }
  }

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

230
/**
231
 * Prepare a destination query string for use in combination with drupal_goto().
232
 *
233 234 235 236
 * 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.
237 238 239 240
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
241
  if (isset($_REQUEST['destination'])) {
242 243 244
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
245 246
    // Use $_GET here to retrieve the original path in source form.
    $path = isset($_GET['q']) ? $_GET['q'] : '';
247 248 249
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
      $path .= '?'. $query;
250
    }
251
    return 'destination='. urlencode($path);
252 253 254
  }
}

255
/**
256
 * Send the user to a different Drupal page.
257
 *
258 259
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
260
 *
261
 * Usually the redirected URL is constructed from this function's input
262
 * parameters. However you may override that behavior by setting a
263 264
 * <em>destination</em> in either the $_REQUEST-array (i.e. by using
 * the query string of an URI) or the $_REQUEST['edit']-array (i.e. by
265 266
 * using a hidden form field). This is used to direct the user back to
 * the proper page after completing a form. For example, after editing
267
 * a post on the 'admin/content/node'-page or after having logged on using the
268
 * 'user login'-block in a sidebar. The function drupal_get_destination()
269 270
 * can be used to help set the destination URL.
 *
271 272
 * Drupal will ensure that messages set by drupal_set_message() and other
 * session data are written to the database before the user is redirected.
273 274 275 276 277
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
278
 *   A Drupal path or a full URL.
279
 * @param $query
280
 *   A query string component, if any.
281
 * @param $fragment
282
 *   A destination fragment identifier (named anchor).
283 284 285 286 287 288 289 290
 * @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
291
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
292
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
293
 *   supported.
294
 * @see drupal_get_destination()
295
 */
296
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
297 298
  global $update_mode;

299
  if (isset($_REQUEST['destination'])) {
300
    extract(parse_url(urldecode($_REQUEST['destination'])));
301
  }
302
  else if (isset($_REQUEST['edit']['destination'])) {
303
    extract(parse_url(urldecode($_REQUEST['edit']['destination'])));
304 305
  }

306
  $url = url($path, array('query' => $query, 'fragment' => $fragment, 'absolute' => TRUE));
307 308
  // Remove newlines from the URL to avoid header injection attacks.
  $url = str_replace(array("\n", "\r"), '', $url);
309

310
  // Allow modules to react to the end of the page request before redirecting.
311 312 313 314
  // We do not want this while running update.php.
  if (empty($update_mode)) {
    module_invoke_all('exit', $url);
  }
315

316
  // Even though session_write_close() is registered as a shutdown function, we
317
  // need all session data written to the database before redirecting.
318
  session_write_close();
319

320 321 322
  header('Location: '. $url, TRUE, $http_response_code);

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

328
/**
329
 * Generates a site off-line message.
330 331
 */
function drupal_site_offline() {
332
  drupal_maintenance_theme();
333
  drupal_set_header('HTTP/1.1 503 Service unavailable');
334
  drupal_set_title(t('Site off-line'));
335
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
336
    t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal'))))));
337 338
}

339 340 341
/**
 * Generates a 404 error if the request can not be handled.
 */
342
function drupal_not_found() {
343
  drupal_set_header('HTTP/1.1 404 Not Found');
344

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

347
  // Keep old path for reference.
348 349 350 351
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

352
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
353
  if ($path && $path != $_GET['q']) {
354 355 356
    // Set the active item in case there are tabs to display, or other
    // dependencies on the path.
    menu_set_active_item($path);
357
    $return = menu_execute_active_handler($path);
358
  }
359

360
  if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
drumm's avatar
drumm committed
361
    drupal_set_title(t('Page not found'));
362
    $return = t('The requested page could not be found.');
363
  }
364

365
  // To conserve CPU and bandwidth, omit the blocks.
366
  print theme('page', $return, FALSE);
367
}
368

369 370 371 372
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
373
  drupal_set_header('HTTP/1.1 403 Forbidden');
374
  watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
375

376
  // Keep old path for reference.
377 378 379 380
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

381
  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
382
  if ($path && $path != $_GET['q']) {
383
    // Set the active item in case there are tabs to display or other
384 385
    // dependencies on the path.
    menu_set_active_item($path);
386
    $return = menu_execute_active_handler($path);
387
  }
388

389
  if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
drumm's avatar
drumm committed
390 391
    drupal_set_title(t('Access denied'));
    $return = t('You are not authorized to access this page.');
392
  }
393
  print theme('page', $return);
394 395
}

396
/**
397
 * Perform an HTTP request.
398
 *
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
 * 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,
415
 *   data and redirect status.
416 417
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
418
  static $self_test = FALSE;
419
  $result = new stdClass();
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
  // Try to clear the drupal_http_request_fails variable if it's set. We
  // can't tie this call to any error because there is no surefire way to
  // tell whether a request has failed, so we add the check to places where
  // some parsing has failed.
  if (!$self_test && variable_get('drupal_http_request_fails', FALSE)) {
    $self_test = TRUE;
    $works = module_invoke('system', 'check_http_request');
    $self_test = FALSE;
    if (!$works) {
      // Do not bother with further operations if we already know that we
      // have no chance.
      $result->error = t("The server can't issue HTTP requests");
      return $result;
    }
  }
435

436
  // Parse the URL and make sure we can handle the schema.
437
  $uri = parse_url($url);
438

439 440
  switch ($uri['scheme']) {
    case 'http':
441
      $port = isset($uri['port']) ? $uri['port'] : 80;
442
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
443
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
444 445
      break;
    case 'https':
446
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
447
      $port = isset($uri['port']) ? $uri['port'] : 443;
448
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
449
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
450 451
      break;
    default:
452
      $result->error = 'invalid schema '. $uri['scheme'];
453 454 455
      return $result;
  }

456
  // Make sure the socket opened properly.
457
  if (!$fp) {
458 459
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
460 461
    $result->code = -$errno;
    $result->error = trim($errstr);
462 463 464
    return $result;
  }

465
  // Construct the path to act on.
466 467
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
468
    $path .= '?'. $uri['query'];
469 470
  }

471
  // Create HTTP request.
472
  $defaults = array(
473
    // RFC 2616: "non-standard ports MUST, default ports MAY be included".
474 475
    // We don't add the port to prevent from breaking rewrite rules checking the
    // host that do not take into account the port number.
476
    'Host' => "Host: $host",
477
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
478
    'Content-Length' => 'Content-Length: '. strlen($data)
479 480
  );

481 482 483 484 485
  // If the server url has a user then attempt to use basic authentication
  if (isset($uri['user'])) {
    $defaults['Authorization'] = 'Authorization: Basic '. base64_encode($uri['user'] . (!empty($uri['pass']) ? ":". $uri['pass'] : ''));
  }

486
  foreach ($headers as $header => $value) {
487
    $defaults[$header] = $header .': '. $value;
488 489
  }

490
  $request = $method .' '. $path ." HTTP/1.0\r\n";
491 492 493
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
494
    $request .= $data ."\r\n";
495 496 497 498 499 500
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
501
  $response = '';
502 503
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
504 505 506 507
  }
  fclose($fp);

  // Parse response.
508 509
  list($split, $result->data) = explode("\r\n\r\n", $response, 2);
  $split = preg_split("/\r\n|\n|\r/", $split);
510

511
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
512 513 514
  $result->headers = array();

  // Parse headers.
515
  while ($line = trim(array_shift($split))) {
516
    list($header, $value) = explode(':', $line, 2);
517 518 519 520 521 522 523 524
    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.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
525 526 527 528 529 530 531 532 533
  }

  $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'
  );
534 535
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
  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;
}
563 564 565
/**
 * @} End of "HTTP handling".
 */
566

567
/**
568
 * Log errors as defined by administrator.
569
 *
570
 * Error levels:
571 572
 * - 0 = Log errors to database.
 * - 1 = Log errors to database and to screen.
573
 */
574
function drupal_error_handler($errno, $message, $filename, $line, $context) {
575 576
  // If the @ error suppression operator was used, error_reporting is
  // temporarily set to 0.
577 578 579 580
  if (error_reporting() == 0) {
    return;
  }

Gábor Hojtsy's avatar
Gábor Hojtsy committed
581
  if ($errno & (E_ALL)) {
582
    $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');
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

    // For database errors, we want the line number/file name of the place that
    // the query was originally called, not _db_query().
    if (isset($context[DB_ERROR])) {
      $backtrace = array_reverse(debug_backtrace());

      // List of functions where SQL queries can originate.
      $query_functions = array('db_query', 'pager_query', 'db_query_range', 'db_query_temporary', 'update_sql');

      // Determine where query function was called, and adjust line/file
      // accordingly.
      foreach ($backtrace as $index => $function) {
        if (in_array($function['function'], $query_functions)) {
          $line = $backtrace[$index]['line'];
          $filename = $backtrace[$index]['file'];
          break;
        }
      }
    }

603
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
604

605
    // Force display of error messages in update.php.
606
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['SCRIPT_NAME'], 'update.php')) {
607
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
608
    }
609

610
    watchdog('php', '%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line), WATCHDOG_ERROR);
Dries's avatar
Dries committed
611 612 613
  }
}

614
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
615
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
616 617 618
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
619
    $item = stripslashes($item);
620 621 622
  }
}

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
/**
 * 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);
    }
  }
}

641
/**
642
 * Fix double-escaping problems caused by "magic quotes" in some PHP installations.
643
 */
644
function fix_gpc_magic() {
645
  static $fixed = FALSE;
646
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
647 648 649 650
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
651
    array_walk($_FILES, '_fix_gpc_magic_files');
652
    $fixed = TRUE;
Dries's avatar
Dries committed
653
  }
654 655
}

656
/**
657
 * Translate strings to the page language or a given language.
658
 *
659 660
 * All human-readable text that will be displayed somewhere within a page should
 * be run through the t() function.
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
 *
 * 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
drumm's avatar
drumm committed
679
 * can also be used for text that may change from time to time
680 681 682 683 684 685 686 687 688 689 690 691 692
 * (such as link paths) to be changed without requiring updates to translations.
 *
 * 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
693
 *     $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))));
694 695 696
 *   @endcode
 *
 * - @variable, which indicates that the text should be run through check_plain,
697
 *   to escape HTML characters. Use this for any output that's displayed within
698 699 700 701 702
 *   a Drupal page.
 *   @code
 *     drupal_set_title($title = t("@name's blog", array('@name' => $account->name)));
 *   @endcode
 *
703 704 705
 * - %variable, which indicates that the string should be HTML escaped and
 *   highlighted with theme_placeholder() which shows up by default as
 *   <em>emphasized</em>.
706
 *   @code
707
 *     $message = t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name));
708 709
 *   @endcode
 *
710
 * When using t(), try to put entire sentences and strings in one t() call.
711 712 713 714
 * 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.
715
 *
716
 * Here is an example of incorrect usage of t():
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
 * @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
 *   $output .= '<p>'. t('Go to the <a href="@contact-page">contact page</a>.', array('@contact-page' => url('contact'))) .'</p>';
 * @endcode
 *
 * Also avoid escaping quotation marks wherever possible.
 *
 * Incorrect:
 * @code
 *   $output .= t('Don\'t click me.');
 * @endcode
 *
 * Correct:
734
 * @code
735
 *   $output .= t("Don't click me.");
736
 * @endcode
737
 *
738
 * @param $string
739
 *   A string containing the English string to translate.
740 741
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
742
 *   of any key in this array are replaced with the corresponding value.
743 744 745 746 747
 *   Based on the first character of the key, the value is escaped and/or themed:
 *    - !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)
748
 * @param $langcode
749 750
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
751 752
 * @return
 *   The translated string.
753
 */
754
function t($string, $args = array(), $langcode = NULL) {
755
  global $language;
756 757
  static $custom_strings;

758 759
  $langcode = isset($langcode) ? $langcode : $language->language;

760 761 762 763
  // 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.
764 765
  if (!isset($custom_strings[$langcode])) {
    $custom_strings[$langcode] = variable_get('locale_custom_strings_'. $langcode, array());
766 767
  }
  // Custom strings work for English too, even if locale module is disabled.
768 769
  if (isset($custom_strings[$langcode][$string])) {
    $string = $custom_strings[$langcode][$string];
770 771
  }
  // Translate with locale module if enabled.
772 773
  elseif (function_exists('locale') && $langcode != 'en') {
    $string = locale($string, $langcode);
774
  }
775
  if (empty($args)) {
776
    return $string;
Kjartan's avatar
Kjartan committed
777 778
  }
  else {
779
    // Transform arguments before inserting them.
780
    foreach ($args as $key => $value) {
781 782
      switch ($key[0]) {
        case '@':
783
          // Escaped only.
784
          $args[$key] = check_plain($value);
785
          break;
786

787 788
        case '%':
        default:
789
          // Escaped and placeholder.
790 791
          $args[$key] = theme('placeholder', $value);
          break;
792

793
        case '!':
794
          // Pass-through.
795 796
      }
    }
797 798
    return strtr($string, $args);
  }
799 800
}

801
/**
802
 * @defgroup validation Input validation
803
 * @{
804
 * Functions to validate user input.
805 806
 */

807
/**
808 809 810
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
811
 *
812
 * @param $mail
813
 *   A string containing an e-mail address.
814
 * @return
815
 *   TRUE if the address is in a valid format.
816
 */
817
function valid_email_address($mail) {
818
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
819
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
820 821 822
  $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
823
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
824 825
}

826 827 828
/**
 * Verify the syntax of the given URL.
 *
829 830 831
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
 *
832
 * @param $url
833
 *   The URL to verify.
834
 * @param $absolute
835
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
836
 * @return
837
 *   TRUE if the URL is in a valid format.
838
 */
839
function valid_url($url, $absolute = FALSE) {
840
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,;~=#&%\+]';
841
  if ($absolute) {
842
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
843 844
  }
  else {
845
    return preg_match("/^". $allowed_characters ."+$/i", $url);
846
  }
847 848
}

849 850 851 852
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
853
 *   The name of an event.
854 855
 */
function flood_register_event($name) {
856
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, ip_address(), time());
857 858 859 860
}

/**
 * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
861 862 863
 *
 * The user is allowed to proceed if he did not trigger the specified event more
 * than $threshold times per hour.
864 865 866 867 868 869
 *
 * @param $name
 *   The name of the event.
 * @param $number
 *   The maximum number of the specified event per hour (per visitor).
 * @return
870
 *   True if the user did not exceed the hourly threshold. False otherwise.
871 872
 */
function flood_is_allowed($name, $threshold) {
873
  $number = db_result(db_query("SELECT COUNT(*) FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, ip_address(), time() - 3600));
874 875 876
  return ($number < $threshold ? TRUE : FALSE);
}

877 878
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
879 880
}

Dries's avatar
Dries committed
881 882 883 884
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 */
function check_url($uri) {
885
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
886 887
}

888
/**
889
 * @defgroup format Formatting
890
 * @{
891
 * Functions to format numbers, strings, dates, etc.
892 893
 */

894 895 896 897 898
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
899 900 901
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
  global $language;
  $langcode = $langcode ? $langcode : $language->language;
Dries's avatar
Dries committed
902

Dries's avatar
Dries committed
903
  $output = "<channel>\n";
904 905
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
906 907 908 909 910

  // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  // We strip all HTML tags, but need to prevent double encoding from properly
  // escaped source data (such as &amp becoming &amp;amp;).
  $output .= ' <description>'. check_plain(decode_entities(strip_tags($description))) ."</description>\n";
911
  $output .= ' <language>'. check_plain($langcode) ."</language>\n";
912
  $output .= format_xml_elements($args);
Dries's avatar
Dries committed
913 914 915 916 917 918
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

919 920 921 922 923
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
924
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
925
  $output = "<item>\n";
926 927 928
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
 * Format XML elements.
 *
 * @param $array
 *   An array where each item represent an element and is either a:
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
 *     - 'key': element name
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
950
  $output = '';
951 952
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
953 954
      if ($value['key']) {
        $output .= ' <'. $value['key'];
955
        if (isset($value['attributes']) && is_array($value['attributes'])) {
956 957 958
          $output .= drupal_attributes($value['attributes']);
        }

959
        if ($value['value'] != '') {
960
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
961 962 963 964 965 966 967
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
968
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
969
    }
Dries's avatar
Dries committed
970
  }
Dries's avatar
Dries committed
971 972 973
  return $output;
}

974
/**
975
 * Format a string containing a count of items.
976
 *
977
 * This function ensures that the string is pluralized correctly. Since t() is
978 979
 * called by this function, make sure not to pass already-localized strings to
 * it.
980
 *
981 982 983 984 985 986 987 988 989 990 991 992 993
 * For example:
 * @code
 *   $output = format_plural($node->comment_count, '1 comment', '@count comments');
 * @endcode
 *
 * Example with additional replacements:
 * @code
 *   $output = format_plural($update_count,
 *     'Changed the content type of 1 post from %old-type to %new-type.',
 *     'Changed the content type of @count posts from %old-type to %new-type.',
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type)));
 * @endcode
 *
994 995 996 997 998
 * @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").
Dries's avatar
Dries committed
999
 *   Do not use @count in the singular string.
1000 1001
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
1002
 *   to ease translation. Use @count in place of the item count, as in "@count
1003
 *   new comments".
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
 *   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:
 *    - !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)
 *   Note that you do not need to include @count in this array.
 *   This replacement is done automatically for the plural case.
1014 1015 1016
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
1017 1018
 * @return
 *   A translated string.
1019
 */
1020
function format_plural($count, $singular, $plural, $args = array(), $langcode = NULL) {
1021
  $args['@count'] = $count;
1022
  if ($count == 1) {
1023
    return t($singular, $args, $langcode);
1024
  }
1025

1026
  // Get the plural index through the gettext formula.
1027
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, $langcode) : -1;