common.inc 41 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 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
function drupal_set_content($region = null, $data = null) {
  static $content = array();

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

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

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

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

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

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

  return $breadcrumb;
}

Dries's avatar
Dries committed
100
/**
Dries's avatar
 
Dries committed
101
 * Add output to the head tag of the HTML page.
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";
118
  $output .= theme('stylesheet_import', base_path() .'misc/drupal.css');
Dries's avatar
Dries committed
119 120 121
  return $output . drupal_set_html_head();
}

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

Dries's avatar
Dries committed
129
/**
Dries's avatar
 
Dries committed
130
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
131 132
 */
function drupal_set_header($header = NULL) {
133
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
134
  // Otherwise, header('') could get called when serving the page later, which
135 136
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
137

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

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

Dries's avatar
 
Dries committed
152 153 154
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
155
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
156 157
 */

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/**
 * Parse an array into a valid urlencoded query string.
 *
 * @param $query
 *   The array to be processed e.g. $_GET
 * @param $exclude
 *   The array filled with keys to be excluded. Use parent[child] to exclude nested items.
 * @param $urlencode
 *   If TRUE, the keys and values are both urlencoded.
 * @param $parent
 *   Should not be passed, only used in recursive calls
 * @return
 *   urlencoded string which can be appended to/as the URL query string
 */
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
176
    $key = urlencode($key);
177
    if ($parent) {
178
      $key = $parent .'['. $key .']';
179 180
    }

181
    if (in_array($key, $exclude)) {
182 183 184 185 186 187 188 189 190 191 192 193 194 195
      continue;
    }

    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
      $params[] = $key .'='. urlencode($value);
    }
  }

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

196 197
/**
 * Prepare a destination query string for use in combination with
198 199 200 201 202
 * drupal_goto(). 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.
203 204 205 206
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
207 208 209 210
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
211
    $path = $_GET['q'];
212 213 214
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
      $path .= '?'. $query;
215
    }
216
    return 'destination='. urlencode($path);
217 218 219
  }
}

Kjartan's avatar
Kjartan committed
220
/**
Dries's avatar
 
Dries committed
221
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
222
 *
Dries's avatar
 
Dries committed
223 224
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
225
 *
226 227 228 229 230 231 232 233 234 235
 * Usually the redirected URL is constructed from this function's input
 * parameters.  However you may override that behavior by setting a
 * <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
 * 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
 * a post on the 'admin/node'-page or after having logged on using the
 * 'user login'-block in a sidebar.  The function drupal_get_destination()
 * can be used to help set the destination URL.
 *
Dries's avatar
 
Dries committed
236 237 238 239 240 241 242 243 244 245 246 247 248
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
249 250
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
251
 */
Dries's avatar
 
Dries committed
252
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
253
  if (isset($_REQUEST['destination'])) {
254 255
    extract(parse_url($_REQUEST['destination']));
  }
256
  else if (isset($_REQUEST['edit']['destination'])) {
257 258 259
    extract(parse_url($_REQUEST['edit']['destination']));
  }

260
  $url = url($path, $query, $fragment, TRUE);
Kjartan's avatar
Kjartan committed
261

Dries's avatar
 
Dries committed
262 263 264 265
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries's avatar
 
Dries committed
267 268 269
  // The "Location" header sends a REDIRECT status code to the http
  // daemon. In some cases this can go wrong, so we make sure none
  // of the code below the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
270 271 272
  exit();
}

273
/**
274
 * Generates a site off-line message
275 276
 */
function drupal_site_offline() {
277
  drupal_set_header('HTTP/1.0 503 Service unavailable');
278
  drupal_set_title(t('Site off-line'));
279 280
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
    t('%site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('%site' => variable_get('site_name', t('This Drupal site')))))));
281 282
}

Kjartan's avatar
Kjartan committed
283 284 285
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
286
function drupal_not_found() {
287
  drupal_set_header('HTTP/1.0 404 Not Found');
288
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
289

290 291 292 293 294
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
 
Dries committed
295
  $path = drupal_get_normal_path(variable_get('site_404', ''));
296
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
297
    menu_set_active_item($path);
298
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
299
  }
300
  else {
301
    // Redirect to a non-existent menu item to make possible tabs disappear.
302
    menu_set_active_item('');
303
  }
Dries's avatar
 
Dries committed
304

305
  if (empty($return)) {
306
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
307
  }
308
  print theme('page', $return);
Dries's avatar
 
Dries committed
309
}
Dries's avatar
 
Dries committed
310

Dries's avatar
 
Dries committed
311 312 313 314
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
315
  drupal_set_header('HTTP/1.0 403 Forbidden');
316
  watchdog('access denied', t('%page denied access.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries's avatar
 
Dries committed
317

318 319 320 321 322
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
 
Dries committed
323
  $path = drupal_get_normal_path(variable_get('site_403', ''));
324
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
325
    menu_set_active_item($path);
326
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
327
  }
328
  else {
329
    // Redirect to a non-existent menu item to make possible tabs disappear.
330
    menu_set_active_item('');
331
  }
Dries's avatar
 
Dries committed
332

333
  if (empty($return)) {
334
    drupal_set_title(t('Access denied'));
335
    $return = t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
336
  }
337
  print theme('page', $return);
Dries's avatar
 
Dries committed
338 339
}

Dries's avatar
 
Dries committed
340
/**
Dries's avatar
 
Dries committed
341
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
342
 *
Dries's avatar
 
Dries committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
 * This is a flexible and powerful HTTP client implementation. Correctly handles
 * GET, POST, PUT or any other HTTP requests. Handles redirects.
 *
 * @param $url
 *   A string containing a fully qualified URI.
 * @param $headers
 *   An array containing an HTTP header => value pair.
 * @param $method
 *   A string defining the HTTP request to use.
 * @param $data
 *   A string containing data to include in the request.
 * @param $retry
 *   An integer representing how many times to retry the request in case of a
 *   redirect.
 * @return
 *   An object containing the HTTP request headers, response code, headers,
 *   data, and redirect status.
Dries's avatar
 
Dries committed
360 361
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
362 363
  $result = new StdClass();

Dries's avatar
 
Dries committed
364
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
365 366 367
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
368
      $port = isset($uri['port']) ? $uri['port'] : 80;
369
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
370
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
 
Dries committed
371 372
      break;
    case 'https':
Dries's avatar
 
Dries committed
373
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
374
      $port = isset($uri['port']) ? $uri['port'] : 443;
375
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
376
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
 
Dries committed
377 378
      break;
    default:
Dries's avatar
 
Dries committed
379
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
380 381 382
      return $result;
  }

Dries's avatar
 
Dries committed
383
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
384
  if (!$fp) {
Dries's avatar
 
Dries committed
385
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
386 387 388
    return $result;
  }

Dries's avatar
 
Dries committed
389
  // Construct the path to act on.
Dries's avatar
Dries committed
390 391
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
 
Dries committed
392
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
393 394
  }

Dries's avatar
 
Dries committed
395
  // Create HTTP request.
Dries's avatar
 
Dries committed
396
  $defaults = array(
397 398 399 400
    // RFC 2616: "non-standard ports MUST, default ports MAY be included".
    // We don't add the port to prevent from breaking rewrite rules checking
    // the host that do not take into account the port number.
    'Host' => "Host: $host",
401
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
402
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
403 404 405
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
406
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
407 408
  }

Dries's avatar
 
Dries committed
409
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
410 411 412
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
413
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
414 415 416 417 418 419
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
420
  $response = '';
421 422
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
 
Dries committed
423 424 425 426
  }
  fclose($fp);

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

430
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
 
Dries committed
431 432 433
  $result->headers = array();

  // Parse headers.
434
  while ($line = trim(array_shift($split))) {
Dries's avatar
 
Dries committed
435
    list($header, $value) = explode(':', $line, 2);
436 437 438 439 440 441 442 443
    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
444 445 446 447 448 449 450 451 452 453
  }

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
Dries's avatar
 
Dries committed
454
  // the base code in their class.
Dries's avatar
 
Dries committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
  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
482 483 484
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
485

Dries's avatar
 
Dries committed
486
/**
Dries's avatar
 
Dries committed
487 488
 * Log errors as defined by administrator
 * Error levels:
489 490
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
 
Dries committed
491
 */
Dries's avatar
 
Dries committed
492
function error_handler($errno, $message, $filename, $line) {
493
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
494 495
    $types = array(1 => 'error', 2 => 'warning', 4 => 'parse error', 8 => 'notice', 16 => 'core error', 32 => 'core warning', 64 => 'compile error', 128 => 'compile warning', 256 => 'user error', 512 => 'user warning', 1024 => 'user notice', 2048 => 'strict warning');
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
 
Dries committed
496

497 498
    // Note: force display of error messages in update.php
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
499
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
500
    }
501 502

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

Dries's avatar
 
Dries committed
506
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
507
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
508 509 510
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
511
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
512 513 514
  }
}

Dries's avatar
 
Dries committed
515 516 517 518
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
519 520
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
521
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
522 523 524 525 526 527
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
Dries's avatar
 
Dries committed
528 529
}

Kjartan's avatar
Kjartan committed
530 531 532
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
533
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
534
 */
Dries's avatar
 
Dries committed
535 536 537 538

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
539
function message_na() {
Dries's avatar
 
Dries committed
540
  return t('n/a');
Dries's avatar
 
Dries committed
541 542
}

Dries's avatar
 
Dries committed
543 544 545
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
546

Dries's avatar
 
Dries committed
547 548 549
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
550 551
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
552 553 554 555 556

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

Dries's avatar
 
Dries committed
557 558 559 560 561
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
562 563 564
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries's avatar
 
Dries committed
565
  }
566
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
 
Dries committed
567 568 569 570 571
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
572 573
}

Kjartan's avatar
Kjartan committed
574
/**
Dries's avatar
 
Dries committed
575
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
576
 *
577
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
578 579 580 581
 * This makes it easier for translators. HTML markup within translation strings
 * is acceptable, if necessary. The suggested syntax for a link embedded
 * within a translation string is:
 * @code
Dries's avatar
 
Dries committed
582 583 584
 *   $msg = t('You must log in below or <a href="%url">create a new
 *             account</a> before viewing the next page.', array('%url'
 *             => url('user/register')));
Dries's avatar
 
Dries committed
585
 * @endcode
586 587 588
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
Kjartan's avatar
Kjartan committed
589
 *
Dries's avatar
 
Dries committed
590
 * @param $string
Dries's avatar
 
Dries committed
591
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
592 593
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
594
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
595 596
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
597
 */
Dries's avatar
 
Dries committed
598
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
599 600 601 602
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
603

Dries's avatar
 
Dries committed
604 605
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
606 607
  }
  else {
Dries's avatar
 
Dries committed
608 609
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
610 611
}

Kjartan's avatar
Kjartan committed
612
/**
Dries's avatar
 
Dries committed
613
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
614
 * @{
Dries's avatar
 
Dries committed
615
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
616 617
 */

618
/**
Dries's avatar
 
Dries committed
619 620 621
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
622
 *
Dries's avatar
 
Dries committed
623
 * @param $mail
624
 *   A string containing an e-mail address.
Dries's avatar
 
Dries committed
625
 * @return
Dries's avatar
 
Dries committed
626
 *   TRUE if the address is in a valid format.
627
 */
Dries's avatar
 
Dries committed
628
function valid_email_address($mail) {
629
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
630
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
631 632 633
  $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
634
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
635 636
}

Dries's avatar
 
Dries committed
637 638 639
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
640
 * @param $url
Dries's avatar
 
Dries committed
641
 *   The URL to verify.
Dries's avatar
 
Dries committed
642
 * @param $absolute
Dries's avatar
 
Dries committed
643
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
644
 * @return
Dries's avatar
 
Dries committed
645
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
646
 */
Dries's avatar
 
Dries committed
647
function valid_url($url, $absolute = FALSE) {
648
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
649
  if ($absolute) {
650
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
651 652
  }
  else {
653
    return preg_match("/^". $allowed_characters ."+$/i", $url);
654
  }
Dries's avatar
 
Dries committed
655 656
}

Dries's avatar
 
Dries committed
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
 *   The name of the event.
 */
function flood_register_event($name) {
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, $_SERVER['REMOTE_ADDR'], time());
}

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

684 685
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
686 687
}

Dries's avatar
Dries committed
688 689 690 691 692
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
693
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
694 695
}

Dries's avatar
 
Dries committed
696
/**
Dries's avatar
 
Dries committed
697
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
698
 * @{
Dries's avatar
 
Dries committed
699
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
700 701
 */

Dries's avatar
 
Dries committed
702 703 704 705 706 707
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
function format_rss_channel($title, $link, $description, $items, $language = 'en', $args = array()) {
Dries's avatar
 
Dries committed
708 709
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
710
  $output = "<channel>\n";
711 712
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
713 714 715 716 717

  // 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";
718
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries's avatar
 
Dries committed
719
  foreach ($args as $key => $value) {
720
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
721
  }
Dries's avatar
 
Dries committed
722 723 724 725 726 727
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
728 729 730 731 732
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
733
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
734
  $output = "<item>\n";
735 736 737
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
Dries's avatar
 
Dries committed
738
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
739 740 741
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
742
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
 
Dries committed
743 744 745 746 747 748 749 750 751 752 753 754
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
755
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
756
    }
Dries's avatar
 
Dries committed
757
  }
Dries's avatar
 
Dries committed
758 759 760 761 762
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
763
/**
Dries's avatar
 
Dries committed
764
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
765
 *
Dries's avatar
 
Dries committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
 *   to ease translation. Use %count in place of the item count, as in "%count
 *   new comments".
 * @return
 *   A translated string.
Dries's avatar
 
Dries committed
780
 */
Dries's avatar
 
Dries committed
781
function format_plural($count, $singular, $plural) {
782
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
783 784

  // get the plural index through the gettext formula
785
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
 
Dries committed
786 787 788 789 790 791
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
792
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
793 794 795 796 797 798
      case "1":
        return t($plural, array("%count" => $count));
      default:
        return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count));
    }
  }
Dries's avatar
 
Dries committed
799 800
}

Dries's avatar
 
Dries committed
801
/**
Dries's avatar
 
Dries committed
802
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
803
 *
Dries's avatar
 
Dries committed
804 805 806 807
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
808
 */
Dries's avatar
 
Dries committed
809
function format_size($size) {
Dries's avatar
 
Dries committed
810
  $suffix = t('bytes');
811
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
812
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
813
    $suffix = t('KB');
Dries's avatar
 
Dries committed
814
  }
815
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
816
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
817
    $suffix = t('MB');
Dries's avatar
 
Dries committed
818
  }
Dries's avatar
 
Dries committed
819
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
820 821
}

Dries's avatar
 
Dries committed
822
/**
Dries's avatar
 
Dries committed
823
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
824
 *
Dries's avatar
 
Dries committed
825 826 827 828 829 830
 * @param $timestamp
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
 * @return
 *   A translated string representation of the interval.
Dries's avatar
 
Dries committed
831
 */
Dries's avatar
 
Dries committed
832
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
833
  $units = array('1 year|%count years' => 31536000, '1 week|%count weeks' => 604800, '1 day|%count days' => 86400, '1 hour|%count hours' => 3600, '1 min|%count min' => 60, '1 sec|%count sec' => 1);
Dries's avatar
 
Dries committed
834
  $output = '';
Dries's avatar
 
Dries committed
835
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
836
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
837
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
838
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
839
      $timestamp %= $value;
Dries's avatar
 
Dries committed
840 841 842 843 844
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
845 846
    }
  }
Dries's avatar
 
Dries committed
847
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
848 849
}

Dries's avatar
 
Dries committed
850
/**
Dries's avatar
 
Dries committed
851 852
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
853 854 855 856
 * Drupal allows administrators to select formatting strings for 'small',
 * 'medium' and 'large' date formats. This function can handle these formats,
 * as well as any custom format.
 *
Dries's avatar
 
Dries committed
857 858 859 860 861 862
 * @param $timestamp
 *   The exact date to format, as a UNIX timestamp.
 * @param $type
 *   The format to use. Can be "small", "medium" or "large" for the preconfigured
 *   date formats. If "custom" is specified, then $format is required as well.
 * @param $format
863 864 865
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries's avatar
 
Dries committed
866 867 868 869
 * @param $timezone
 *   Time zone offset in seconds; if omitted, the user's time zone is used.
 * @return
 *   A translated date string in the requested format.
Dries's avatar
 
Dries committed
870
 */
871
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
872
  if (!isset($timezone)) {
873
    global $user;
Steven Wittens's avatar
Steven Wittens committed
874 875 876 877 878 879
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
880
  }
Dries's avatar
 
Dries committed
881

882
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
883 884

  switch ($type) {
885 886
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
887
      break;
888 889
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
890
      break;
891
    case 'custom':
Dries's avatar
 
Dries committed
892
      // No change to format
Dries's avatar
 
Dries committed
893
      break;
894
    case 'medium':
Dries's avatar
 
Dries committed
895
    default:
896
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
897 898
  }

899
  $max = strlen($format);
Dries's avatar
 
Dries committed
900
  $date = '';
Dries's avatar
 
Dries committed
901
  for ($i = 0; $i < $max; $i++) {
902
    $c = $format[$i];
903
    if (strpos('AaDFlM', $c) !== false) {
904
      $date .= t(gmdate($c, $timestamp));
905
    }
906
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
907 908 909 910
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
 
Dries committed
911
    }
912 913 914 915 916
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
 
Dries committed
917
    }
918 919 920
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
921
    else {
922
      $date .= $c;
Dries's avatar
 
Dries committed
923
    }
Dries's avatar
 
Dries committed
924
  }
925

Dries's avatar
 
Dries committed
926 927 928
  return $date;
}

Dries's avatar
 
Dries committed
929 930 931
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
932

Dries's avatar
 
Dries committed
933
/**
934
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
Dries's avatar
 
Dries committed
935 936
 *
 * @param $path
937 938
 *   The Drupal path being linked to, such as "admin/node", or an existing URL
 *   like "http://drupal.org/".
Dries's avatar
 
Dries committed
939
 * @param $query
940
 *   A query string to append to the link or URL.
Dries's avatar
 
Dries committed
941
 * @param $fragment
942 943 944
 *   A fragment identifier (named anchor) to append to the link. If an existing
 *   URL with a fragment identifier is used, it will be replaced. Note, do not
 *   include the '#'.
Dries's avatar
 
Dries committed
945 946
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
947 948
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
Dries's avatar
 
Dries committed
949 950 951 952 953 954 955
 * @return
 *   an HTML string containing a link to the given path.
 *
 * When creating links in modules, consider whether l() could be a better
 * alternative than url().
 */
function url($path = NULL, $query = NULL, $fragment = NULL, $absolute = FALSE) {
956 957 958 959 960 961
  if (isset($fragment)) {
    $fragment = '#'. $fragment;
  }

  // Return an external link if $path contains an allowed absolute URL.
  // Only call the slow filter_xss_bad_protocol if $path contains a ':'.