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

Dries's avatar
 
Dries committed
4 5 6 7 8 9 10 11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

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

Dries's avatar
 
Dries committed
27
/**
Dries's avatar
 
Dries committed
28
 * Set the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
29
 *
Dries's avatar
 
Dries committed
30 31 32
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
33
 */
Dries's avatar
 
Dries committed
34 35 36 37 38 39 40 41 42
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

Dries's avatar
 
Dries committed
43 44 45
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
 
Dries committed
46 47 48 49 50 51 52 53 54 55
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

Dries's avatar
Dries committed
56
/**
Dries's avatar
 
Dries committed
57
 * Add output to the head tag of the HTML page.
Dries's avatar
 
Dries committed
58
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
59 60
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
61
  static $stored_head = '';
Dries's avatar
Dries committed
62 63

  if (!is_null($data)) {
Dries's avatar
 
Dries committed
64
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
65 66 67 68
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
69 70 71
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
72 73 74
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
75
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
76
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
77
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
78 79 80 81

  return $output . drupal_set_html_head();
}

Dries's avatar
 
Dries committed
82
/**
83
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
 
Dries committed
84
 */
85 86
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
 
Dries committed
87
}
Kjartan's avatar
Kjartan committed
88

Dries's avatar
 
Dries committed
89
/**
Dries's avatar
 
Dries committed
90
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
91 92
 */
function drupal_get_normal_path($path) {
93 94 95
  //drupal_get_path_alias($path);
  if ($src = drupal_lookup_path('alias', $path)) {
    return $src;
Dries's avatar
 
Dries committed
96
  }
Dries's avatar
 
Dries committed
97
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
98 99 100 101 102 103
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
104

Dries's avatar
Dries committed
105
/**
Dries's avatar
 
Dries committed
106
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
107 108
 */
function drupal_set_header($header = NULL) {
109
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
110
  // Otherwise, header('') could get called when serving the page later, which
111 112
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
113

114
  if (strlen($header)) {
Dries's avatar
Dries committed
115
    header($header);
116
    $stored_headers[] = $header;
Dries's avatar
Dries committed
117
  }
118
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
119 120
}

Dries's avatar
 
Dries committed
121 122 123
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
124 125 126 127
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
 
Dries committed
128 129 130
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
131
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
132 133
 */

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/**
 * Prepare a destination query string for use in combination with
 * drupal_goto().  Used to direct the user back to the referring page
 * after completing a form.
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
  $destination[] = $_GET['q'];
  $params = array('from', 'sort', 'order');
  foreach ($params as $param) {
    if (isset($_GET[$param])) {
      $destination[] = "$param=". $_GET[$param];
    }
  }
  return 'destination='. urlencode(implode('&', $destination));
}

Kjartan's avatar
Kjartan committed
152
/**
Dries's avatar
 
Dries committed
153
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
154
 *
Dries's avatar
 
Dries committed
155 156
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
157
 *
158 159 160 161 162 163 164 165 166 167
 * 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
168 169 170 171 172 173 174 175 176 177 178 179 180
 * 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).
181 182
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
183
 */
Dries's avatar
 
Dries committed
184
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
185 186 187 188 189 190 191
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

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

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

Dries's avatar
 
Dries committed
197 198
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
199 200
    }
    else {
Dries's avatar
 
Dries committed
201
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
202 203 204
    }
  }

Dries's avatar
 
Dries committed
205 206 207 208
  // 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
209

Dries's avatar
 
Dries committed
210 211 212
  // 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
213 214 215 216 217 218
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
219
function drupal_not_found() {
Dries's avatar
 
Dries committed
220
  header('HTTP/1.0 404 Not Found');
221
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
222 223

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
224
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
225 226
  if ($path) {
    menu_set_active_item($path);
227
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
228 229
  }

230
  if (empty($return)) {
231
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
232
  }
233
  print theme('page', $return);
Dries's avatar
 
Dries committed
234
}
Dries's avatar
 
Dries committed
235

Dries's avatar
 
Dries committed
236 237 238 239 240
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
241
  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
242 243

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
244
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
245 246
  if ($path) {
    menu_set_active_item($path);
247
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
248 249
  }

250
  if (empty($return)) {
251
    drupal_set_title(t('Access denied'));
252
    $return = message_access();
Dries's avatar
 
Dries committed
253
  }
254
  print theme('page', $return);
Dries's avatar
 
Dries committed
255 256
}

Dries's avatar
 
Dries committed
257
/**
Dries's avatar
 
Dries committed
258
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
259
 *
Dries's avatar
 
Dries committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
 * 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
277 278
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
279 280
  $result = new StdClass();

Dries's avatar
 
Dries committed
281
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
282 283 284 285 286 287
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
Dries's avatar
 
Dries committed
288 289
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
      $fp = @fsockopen('ssl://'. $uri['host'], ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
Dries's avatar
 
Dries committed
290 291
      break;
    default:
Dries's avatar
 
Dries committed
292
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
293 294 295
      return $result;
  }

Dries's avatar
 
Dries committed
296
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
297
  if (!$fp) {
Dries's avatar
 
Dries committed
298
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
299 300 301
    return $result;
  }

Dries's avatar
 
Dries committed
302
  // Construct the path to act on.
Dries's avatar
 
Dries committed
303 304
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
305
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
306 307
  }

Dries's avatar
 
Dries committed
308
  // Create HTTP request.
Dries's avatar
 
Dries committed
309
  $defaults = array(
Dries's avatar
 
Dries committed
310
    'Host' => 'Host: '. $uri['host'],
311 312
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
313 314 315
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
316
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
317 318
  }

Dries's avatar
 
Dries committed
319
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
320 321 322
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
323
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
324 325 326 327 328 329
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
330
  $response = '';
331
  while (!feof($fp) && $data = fread($fp, 1024)) {
332
    $response .= $data;
Dries's avatar
 
Dries committed
333 334 335 336
  }
  fclose($fp);

  // Parse response.
337 338 339 340
  list($headers, $result->data) = explode("\r\n\r\n", $response, 2);
  $headers = preg_split("/\r\n|\n|\r/", $headers);

  list($protocol, $code, $text) = explode(' ', trim(array_shift($headers)), 3);
Dries's avatar
 
Dries committed
341 342 343
  $result->headers = array();

  // Parse headers.
344
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
345 346 347 348 349 350 351 352 353 354 355 356
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
Dries's avatar
 
Dries committed
357
  // the base code in their class.
Dries's avatar
 
Dries committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
  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
385 386 387
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
388

Dries's avatar
 
Dries committed
389
/**
Dries's avatar
 
Dries committed
390 391 392 393
 * Log errors as defined by administrator
 * Error levels:
 *  1 = Log errors to database.
 *  2 = Log errors to database and to screen.
Dries's avatar
 
Dries committed
394
 */
Dries's avatar
 
Dries committed
395
function error_handler($errno, $message, $filename, $line) {
396
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
397 398
    $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
399

Dries's avatar
 
Dries committed
400
    if (variable_get('error_level', 1) == 1) {
Dries's avatar
 
Dries committed
401
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
402
    }
403 404

    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
405 406 407
  }
}

Dries's avatar
 
Dries committed
408
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
409
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
410 411 412
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
413
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
414 415 416
  }
}

Dries's avatar
 
Dries committed
417 418 419 420
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
421 422
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
423
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
424 425 426 427 428 429
    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
430 431
}

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
/**
 * An unchecked checkbox is not present in $_POST so we fix it here by
 * proving a default value of 0.  Also, with form_checkboxes() we expect
 * an array, but HTML does not send the empty array.  This is also taken
 * care off.
 */
function fix_checkboxes() {
  if (isset($_POST['form_array'])) {
    $_POST['edit'] = _fix_checkboxes($_POST['edit'], $_POST['form_array'], array());
  }
  if (isset($_POST['form_zero'])) {
    $_POST['edit'] = _fix_checkboxes($_POST['edit'], $_POST['form_zero'], 0);
  }
}

function _fix_checkboxes($array1, $array2, $value) {
  if (is_array($array2) && count($array2)) {
    foreach ($array2 as $k => $v) {
      if (is_array($v) && count($v)) {
        $array1[$k] = _fix_checkboxes($array1[$k], $v, $value);
      }
      else if (!isset($array1[$k])) {
        $array1[$k] = $value;
      }
    }
  }
  else {
    $array1 = $value;
  }
  return $array1;
}

Kjartan's avatar
Kjartan committed
464 465 466
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
467
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
468
 */
Dries's avatar
 
Dries committed
469 470 471 472

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
473 474
function array2object($array) {
  if (is_array($array)) {
Dries's avatar
 
Dries committed
475
    $object = new StdClass();
Dries's avatar
Dries committed
476
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
477 478 479 480
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
481
    $object = $array;
Dries's avatar
 
Dries committed
482 483 484 485 486
  }

  return $object;
}

Dries's avatar
 
Dries committed
487 488 489
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
490 491 492
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
493 494 495 496
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
497
    $array = $object;
Dries's avatar
 
Dries committed
498 499 500 501
  }

  return $array;
}
Dries's avatar
 
Dries committed
502 503 504 505

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

Kjartan's avatar
Kjartan committed
507 508 509
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
510
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
511
 */
Dries's avatar
 
Dries committed
512 513 514 515 516 517 518

/**
 * Return a string with an "access denied" message.
 *
 * Always consider whether to use drupal_access_denied() instead to return a
 * proper (and customizable) 403 error.
 */
Dries's avatar
 
Dries committed
519
function message_access() {
Dries's avatar
 
Dries committed
520
  return t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
521 522
}

Dries's avatar
 
Dries committed
523 524 525
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
526
function message_na() {
Dries's avatar
 
Dries committed
527
  return t('n/a');
Dries's avatar
 
Dries committed
528 529
}

Dries's avatar
 
Dries committed
530 531 532
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
533

Dries's avatar
 
Dries committed
534 535 536
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
537 538
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
539 540 541 542 543

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

Dries's avatar
 
Dries committed
544 545 546 547 548
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
549 550 551
    // 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
552
  }
Dries's avatar
 
Dries committed
553 554 555 556 557 558
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
559 560
}

Kjartan's avatar
Kjartan committed
561
/**
Dries's avatar
 
Dries committed
562
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
563
 *
564
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
565 566 567 568
 * 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
569 570 571
 *   $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
572
 * @endcode
573 574 575
 * 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
576
 *
Dries's avatar
 
Dries committed
577
 * @param $string
Dries's avatar
 
Dries committed
578
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
579 580
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
581
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
582 583
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
584
 */
Dries's avatar
 
Dries committed
585
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
586 587 588 589
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
590

Dries's avatar
 
Dries committed
591 592
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
593 594
  }
  else {
Dries's avatar
 
Dries committed
595 596
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
597 598
}

Dries's avatar
 
Dries committed
599
/**
600
 * Encode special characters in a plain-text string for display as HTML.
Dries's avatar
 
Dries committed
601
 */
602 603
function check_plain($text) {
  return htmlspecialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
604 605
}

Kjartan's avatar
Kjartan committed
606
/**
Dries's avatar
 
Dries committed
607
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
608
 * @{
Dries's avatar
 
Dries committed
609
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
610 611
 */

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

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

Dries's avatar
 
Dries committed
651 652 653 654 655 656 657 658 659 660
/**
 * Validate data input by a user.
 *
 * Ensures that user data cannot be used to perform attacks on the site.
 *
 * @param $data
 *   The input to check.
 * @return
 *   TRUE if the input data is acceptable.
 */
Kjartan's avatar
Kjartan committed
661 662
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
663
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
664
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
665
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
666
        return FALSE;
Kjartan's avatar
Kjartan committed
667 668 669
      }
    }
  }
Dries's avatar
Dries committed
670
  else if (isset($data)) {
Dries's avatar
 
Dries committed
671
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
672

673 674 675
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries's avatar
 
Dries committed
676 677 678 679
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
Kjartan's avatar
Kjartan committed
680

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

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

    if ($match) {
688
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => theme('placeholder', $data))));
Dries's avatar
 
Dries committed
689
      return FALSE;
Kjartan's avatar
Kjartan committed
690 691 692
    }
  }

Dries's avatar
 
Dries committed
693
  return TRUE;
Kjartan's avatar
Kjartan committed
694
}
Dries's avatar
 
Dries committed
695 696 697
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
698

Dries's avatar
 
Dries committed
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
/**
 * 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);
}

726 727
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
728 729
}

Dries's avatar
 
Dries committed
730
/**
Dries's avatar
 
Dries committed
731
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
732
 * @{
Dries's avatar
 
Dries committed
733
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
734 735
 */

Dries's avatar
 
Dries committed
736 737 738 739 740 741
/**
 * 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
742 743
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
744
  $output = "<channel>\n";
745 746 747 748
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries's avatar
 
Dries committed
749
  foreach ($args as $key => $value) {
750
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
751
  }
Dries's avatar
 
Dries committed
752 753 754 755 756 757
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
758 759 760 761 762
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
763
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
764
  $output = "<item>\n";
765 766 767
  $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
768
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
        if (is_array($value['attributes'])) {
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
785
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
786
    }
Dries's avatar
 
Dries committed
787
  }
Dries's avatar
 
Dries committed
788 789 790 791 792
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
793
/**
Dries's avatar
 
Dries committed
794
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
795
 *
Dries's avatar
 
Dries committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809
 * 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
810
 */
Dries's avatar
 
Dries committed
811
function format_plural($count, $singular, $plural) {
812
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
813 814 815 816 817 818 819 820 821

  // get the plural index through the gettext formula
  $index = (function_exists('locale')) ? locale_get_plural($count) : -1;
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
822
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
823 824 825 826 827 828
      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
829 830
}

Dries's avatar
 
Dries committed
831
/**
Dries's avatar
 
Dries committed
832
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
833
 *
Dries's avatar
 
Dries committed
834 835 836 837
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
838
 */
Dries's avatar
 
Dries committed
839
function format_size($size) {
Dries's avatar
 
Dries committed
840
  $suffix = t('bytes');
841
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
842
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
843
    $suffix = t('KB');
Dries's avatar
 
Dries committed
844
  }
845
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
846
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
847
    $suffix = t('MB');
Dries's avatar
 
Dries committed
848
  }
Dries's avatar
 
Dries committed
849
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
850 851
}

Dries's avatar
 
Dries committed
852
/**
Dries's avatar
 
Dries committed
853
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
854
 *
Dries's avatar
 
Dries committed
855 856 857 858 859 860
 * @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
861
 */
Dries's avatar
 
Dries committed
862
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
863
  $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
864
  $output = '';
Dries's avatar
 
Dries committed
865
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
866
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
867
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
868
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
869
      $timestamp %= $value;
Dries's avatar
 
Dries committed
870 871 872 873 874
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
875 876
    }
  }
Dries's avatar
 
Dries committed
877
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
878 879
}

Dries's avatar
 
Dries committed
880
/**
Dries's avatar
 
Dries committed
881 882
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
883 884 885 886
 * 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
887 888 889 890 891 892
 * @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
893 894 895
 *   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
896 897 898 899
 * @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
900
 */
901 902 903
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
904 905 906 907 908 909
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
910
  }
Dries's avatar
 
Dries committed
911

912
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
913 914

  switch ($type) {
915 916
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
917
      break;
918 919
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
920
      break;
921
    case 'custom':
Dries's avatar
 
Dries committed
922
      // No change to format
Dries's avatar
 
Dries committed
923
      break;
924
    case 'medium':
Dries's avatar
 
Dries committed
925
    default:
926
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
927 928
  }

929
  $max = strlen($format);
Dries's avatar
 
Dries committed
930
  $date = '';
Dries's avatar
 
Dries committed
931 932
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
933
    if (strpos('AaDFlM', $c) !== false) {
934
      $date .= t(gmdate($c, $timestamp));
935
    }
936
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
937 938 939 940
      $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
941
    }
942 943 944 945 946
    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
947
    }
948 949 950
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
951
    else {
952
      $date .= $c;
Dries's avatar
 
Dries committed
953
    }
Dries's avatar
 
Dries committed
954
  }
955

Dries's avatar
 
Dries committed
956 957 958
  return $date;
}

Dries's avatar
 
Dries committed
959
/**
Dries's avatar
 
Dries committed
960
 * Format a username.
Dries's avatar
 
Dries committed
961
 *
Dries's avatar
 
Dries committed
962 963 964 965 966
 * @param $object
 *   The user object to format, usually returned from user_load().
 * @return
 *   A string containing an HTML link to the user's page if the passed object
 *   suggests that this is a site user. Otherwise, only the username is returned.
Dries's avatar
 
Dries committed
967
 */
Dries's avatar
 
Dries committed
968 969 970
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
 
Dries committed
971
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
972
    if (strlen($object->name) > 20) {
Dries's avatar
 
Dries committed
973
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
974 975 976 977 978
    }
    else {
      $name = $object->name;
    }

979 980 981 982 983 984
    if (user_access('access user profiles')) {
      $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
    }
    else {
      $output = $name;
    }
Dries's avatar
 
Dries committed
985
  }
Dries's avatar
 
Dries committed
986
  else if ($object->name) {
Dries's avatar
 
Dries committed
987 988 989 990
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
Dries's avatar
 
Dries committed
991
    if ($object->homepage) {
Dries's avatar
 
Dries committed
992
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
 
Dries committed
993 994 995 996 997 998
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
 
Dries committed
999
  }
Dries's avatar
 
Dries committed
1000
  else {
Dries's avatar
Dries committed
1001
    $output = variable_get('anonymous', 'Anonymous');
Dries's avatar
 
Dries committed
1002 1003
  }

Dries's avatar
 
Dries committed
1004
  return $output;
Dries's avatar
 
Dries committed
1005
}
Dries's avatar
 
Dries committed
1006 1007 1008
/**
 * @} End of "defgroup format".
 */
Dries's avatar