common.inc 118 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
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.
 */

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;
  }
}

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

80
  if (!is_null($breadcrumb)) {
Dries's avatar
 
Dries committed
81 82 83 84 85
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

92
  if (is_null($breadcrumb)) {
Dries's avatar
 
Dries committed
93 94 95 96 97 98
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
99
/**
Dries's avatar
 
Dries committed
100
 * Add output to the head tag of the HTML page.
101
 *
Dries's avatar
 
Dries committed
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) {
Dries's avatar
 
Dries committed
105
  static $stored_head = '';
Dries's avatar
Dries committed
106 107

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

Dries's avatar
 
Dries committed
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() {
Dries's avatar
 
Dries committed
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();
}

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

Dries's avatar
Dries committed
128
/**
Dries's avatar
 
Dries committed
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.
Dries's avatar
 
Dries committed
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
}

Dries's avatar
 
Dries committed
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);
}

Dries's avatar
 
Dries committed
187 188 189
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
190
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
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
  }
}

Kjartan's avatar
Kjartan committed
255
/**
Dries's avatar
 
Dries committed
256
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
257
 *
Dries's avatar
 
Dries committed
258 259
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
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.
Dries's avatar
 
Dries committed
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.
Dries's avatar
 
Dries committed
279
 * @param $query
280
 *   A query string component, if any.
Dries's avatar
 
Dries committed
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()
Kjartan's avatar
Kjartan committed
295
 */
296
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
297

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

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

309
  // Allow modules to react to the end of the page request before redirecting.
310
  // We do not want this while running update.php.
311
  if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
312 313
    module_invoke_all('exit', $url);
  }
Dries's avatar
 
Dries committed
314

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
395
/**
Dries's avatar
 
Dries committed
396
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
397
 *
Dries's avatar
 
Dries committed
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
 * 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,
414
 *   data and redirect status.
Dries's avatar
 
Dries committed
415 416
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
417
  static $self_test = FALSE;
418
  $result = new stdClass();
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
  // 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;
    }
  }
Dries's avatar
 
Dries committed
434

435
  // Parse the URL and make sure we can handle the schema.
Dries's avatar
 
Dries committed
436
  $uri = parse_url($url);
437

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

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

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

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

480 481 482 483 484
  // 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'] : ''));
  }

Dries's avatar
 
Dries committed
485
  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
486
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
487 488
  }

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

  fwrite($fp, $request);

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

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

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

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

  $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'
  );
533 534
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
Dries's avatar
 
Dries committed
535 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
  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
562 563 564
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
565

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

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

    // 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;
        }
      }
    }

Dries's avatar
 
Dries committed
602
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
 
Dries committed
603

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

609
    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
610 611 612
  }
}

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

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

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

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

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

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

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

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

Kjartan's avatar
Kjartan committed
800
/**
Dries's avatar
 
Dries committed
801
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
802
 * @{
Dries's avatar
 
Dries committed
803
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
804 805
 */

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

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

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

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

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

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

Dries's avatar
 
Dries committed
887
/**
Dries's avatar
 
Dries committed
888
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
889
 * @{
Dries's avatar
 
Dries committed
890
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
891 892
 */

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

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

  // 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";
910
  $output .= ' <language>'. check_plain($langcode) ."</language>\n";
911
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
912 913 914 915 916 917
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
918 919 920 921 922
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
923
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
924
  $output = "<item>\n";
925 926 927
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
  $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) {
949
  $output = '';
950 951
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
952 953
      if ($value['key']) {
        $output .= ' <'. $value['key'];
954
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
 
Dries committed
955 956 957
          $output .= drupal_attributes($value['attributes']);
        }

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

Dries's avatar
 
Dries committed
973
/**
Dries's avatar
 
Dries committed
974
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
975
 *
Dries's avatar
 
Dries committed
976
 * This function ensures that the string is pluralized correctly. Since t() is
977 978
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
979
 *
980 981 982 983 984 985 986 987 988 989 990 991 992
 * 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
 *
Dries's avatar
 
Dries committed
993 994 995 996 997
 * @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
998
 *   Do not use @count in the singular string.
Dries's avatar
 
Dries committed
999 1000
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
1001
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries's avatar
 
Dries committed
1002
 *   new comments".
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
 * @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.
1013 1014 1015
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
1016 1017
 * @return
 *   A translated string.
Dries's avatar
 
Dries committed
1018
 */
1019
function format_plural($count, $singular, $plural, $args = array(), $langcode = NULL) {
1020
  $args['@count'] = $count;
1021
  if ($count == 1) {
1022
    return t($singular, $args, $langcode);
1023
  }
Dries's avatar
 
Dries committed
1024

1025
  // Get the plural index through the gettext formula.
1026
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, $langcode) : -1;
1027 1028
  // Backwards compatibility.
  if ($index < 0) {
1029
    return t($plural, $args, $langcode);
Dries's avatar
 
Dries committed
1030 1031 1032 1033
  }
  else {
    switch ($index) {
      case "0":
1034
        return t($singular, $args, $langcode);
Dries's avatar
 
Dries committed
1035
      case "1":
1036
        return t($plural, $args, $langcode);
Dries's avatar
 
Dries committed
1037
      default:
1038 1039
        unset($args['@count']);
        $args['@count['. $index .']'] = $count;
1040
        return t(strtr($plural, array('@count' => '@count['. $index .']')), $args, $langcode);