common.inc 40 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
/**
 * Prepare a destination query string for use in combination with
160 161 162 163 164
 * 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.
165 166 167 168
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
169 170 171 172
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
173 174 175 176 177
    $path = $_GET['q'];
    $params = array();
    foreach ($_GET as $key => $value) {
      if ($key == 'q') {
        continue;
178
      }
179
      $params[] = urlencode($key) .'='. urlencode($value);
180
    }
181 182 183 184
    if (count($params)) {
      $path .= '?';
    }
    return 'destination='. urlencode($path . implode('&', $params));
185 186 187
  }
}

Kjartan's avatar
Kjartan committed
188
/**
Dries's avatar
 
Dries committed
189
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
190
 *
Dries's avatar
 
Dries committed
191 192
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
193
 *
194 195 196 197 198 199 200 201 202 203
 * 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
204 205 206 207 208 209 210 211 212 213 214 215 216
 * 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).
217 218
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
219
 */
Dries's avatar
 
Dries committed
220
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
221
  if (isset($_REQUEST['destination'])) {
222 223
    extract(parse_url($_REQUEST['destination']));
  }
224
  else if (isset($_REQUEST['edit']['destination'])) {
225 226 227
    extract(parse_url($_REQUEST['edit']['destination']));
  }

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

Dries's avatar
 
Dries committed
230 231 232 233
  // 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
234

Dries's avatar
 
Dries committed
235 236 237
  // 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
238 239 240
  exit();
}

241
/**
242
 * Generates a site off-line message
243 244
 */
function drupal_site_offline() {
245
  drupal_set_header('HTTP/1.0 503 Service unavailable');
246
  drupal_set_title(t('Site off-line'));
247
  print theme('maintenance_page', variable_get('site_offline_message',
248
    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'))))));
249 250
}

Kjartan's avatar
Kjartan committed
251 252 253
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
254
function drupal_not_found() {
255
  drupal_set_header('HTTP/1.0 404 Not Found');
256
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
257 258

  $path = drupal_get_normal_path(variable_get('site_404', ''));
259
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
260
    menu_set_active_item($path);
261
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
262 263
  }

264
  if (empty($return)) {
265
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
266
  }
267
  print theme('page', $return);
Dries's avatar
 
Dries committed
268
}
Dries's avatar
 
Dries committed
269

Dries's avatar
 
Dries committed
270 271 272 273
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
274
  drupal_set_header('HTTP/1.0 403 Forbidden');
275
  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
276 277

  $path = drupal_get_normal_path(variable_get('site_403', ''));
278
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
279
    menu_set_active_item($path);
280
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
281 282
  }

283
  if (empty($return)) {
284
    drupal_set_title(t('Access denied'));
285
    $return = t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
286
  }
287
  print theme('page', $return);
Dries's avatar
 
Dries committed
288 289
}

Dries's avatar
 
Dries committed
290
/**
Dries's avatar
 
Dries committed
291
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
292
 *
Dries's avatar
 
Dries committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
 * 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
310 311
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
312 313
  $result = new StdClass();

Dries's avatar
 
Dries committed
314
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
315 316 317
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
318
      $port = isset($uri['port']) ? $uri['port'] : 80;
319
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
320
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
 
Dries committed
321 322
      break;
    case 'https':
Dries's avatar
 
Dries committed
323
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
324
      $port = isset($uri['port']) ? $uri['port'] : 443;
325
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
326
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
 
Dries committed
327 328
      break;
    default:
Dries's avatar
 
Dries committed
329
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
330 331 332
      return $result;
  }

Dries's avatar
 
Dries committed
333
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
334
  if (!$fp) {
Dries's avatar
 
Dries committed
335
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
336 337 338
    return $result;
  }

Dries's avatar
 
Dries committed
339
  // Construct the path to act on.
Dries's avatar
Dries committed
340 341
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
 
Dries committed
342
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
343 344
  }

Dries's avatar
 
Dries committed
345
  // Create HTTP request.
Dries's avatar
 
Dries committed
346
  $defaults = array(
347 348 349 350
    // 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",
351
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
352
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
353 354 355
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
356
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
357 358
  }

Dries's avatar
 
Dries committed
359
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
360 361 362
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
363
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
364 365 366 367 368 369
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
370
  $response = '';
371 372
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
 
Dries committed
373 374 375 376
  }
  fclose($fp);

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

380
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
 
Dries committed
381 382 383
  $result->headers = array();

  // Parse headers.
384
  while ($line = trim(array_shift($split))) {
Dries's avatar
 
Dries committed
385
    list($header, $value) = explode(':', $line, 2);
386 387 388 389 390 391 392 393
    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
394 395 396 397 398 399 400 401 402 403
  }

  $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
404
  // the base code in their class.
Dries's avatar
 
Dries committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
  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
432 433 434
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
435

Dries's avatar
 
Dries committed
436
/**
Dries's avatar
 
Dries committed
437 438
 * Log errors as defined by administrator
 * Error levels:
439 440
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
 
Dries committed
441
 */
Dries's avatar
 
Dries committed
442
function error_handler($errno, $message, $filename, $line) {
443
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
444 445
    $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
446

Dries's avatar
 
Dries committed
447
    if (variable_get('error_level', 1) == 1) {
448
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
449
    }
450 451

    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
452 453 454
  }
}

Dries's avatar
 
Dries committed
455
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
456
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
457 458 459
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
460
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
461 462 463
  }
}

Dries's avatar
 
Dries committed
464 465 466 467
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
468 469
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
470
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
471 472 473 474 475 476
    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
477 478
}

Kjartan's avatar
Kjartan committed
479 480 481
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
482
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
483
 */
Dries's avatar
 
Dries committed
484 485 486 487

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
488
function message_na() {
Dries's avatar
 
Dries committed
489
  return t('n/a');
Dries's avatar
 
Dries committed
490 491
}

Dries's avatar
 
Dries committed
492 493 494
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
495

Dries's avatar
 
Dries committed
496 497 498
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
499 500
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
501 502 503 504 505

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

Dries's avatar
 
Dries committed
506 507 508 509 510
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
511 512 513
    // 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
514
  }
515
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
 
Dries committed
516 517 518 519 520
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
521 522
}

Kjartan's avatar
Kjartan committed
523
/**
Dries's avatar
 
Dries committed
524
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
525
 *
526
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
527 528 529 530
 * 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
531 532 533
 *   $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
534
 * @endcode
535 536 537
 * 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
538
 *
Dries's avatar
 
Dries committed
539
 * @param $string
Dries's avatar
 
Dries committed
540
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
541 542
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
543
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
544 545
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
546
 */
Dries's avatar
 
Dries committed
547
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
548 549 550 551
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
552

Dries's avatar
 
Dries committed
553 554
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
555 556
  }
  else {
Dries's avatar
 
Dries committed
557 558
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
559 560
}

Kjartan's avatar
Kjartan committed
561
/**
Dries's avatar
 
Dries committed
562
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
563
 * @{
Dries's avatar
 
Dries committed
564
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
565 566
 */

567
/**
Dries's avatar
 
Dries committed
568 569 570
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
571
 *
Dries's avatar
 
Dries committed
572
 * @param $mail
573
 *   A string containing an e-mail address.
Dries's avatar
 
Dries committed
574
 * @return
Dries's avatar
 
Dries committed
575
 *   TRUE if the address is in a valid format.
576
 */
Dries's avatar
 
Dries committed
577
function valid_email_address($mail) {
578
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
579
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
580 581 582
  $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
583
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
584 585
}

Dries's avatar
 
Dries committed
586 587 588
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
589
 * @param $url
Dries's avatar
 
Dries committed
590
 *   The URL to verify.
Dries's avatar
 
Dries committed
591
 * @param $absolute
Dries's avatar
 
Dries committed
592
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
593
 * @return
Dries's avatar
 
Dries committed
594
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
595
 */
Dries's avatar
 
Dries committed
596
function valid_url($url, $absolute = FALSE) {
597
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
598
  if ($absolute) {
599
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
600 601
  }
  else {
602
    return preg_match("/^". $allowed_characters ."+$/i", $url);
603
  }
Dries's avatar
 
Dries committed
604 605
}

Dries's avatar
 
Dries committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
/**
 * 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);
}

633 634
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
635 636
}

Dries's avatar
Dries committed
637 638 639 640 641
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
642
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
643 644
}

Dries's avatar
 
Dries committed
645
/**
Dries's avatar
 
Dries committed
646
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
647
 * @{
Dries's avatar
 
Dries committed
648
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
649 650
 */

Dries's avatar
 
Dries committed
651 652 653 654 655 656
/**
 * 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
657 658
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
659
  $output = "<channel>\n";
660 661
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
662 663 664 665 666

  // 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";
667
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries's avatar
 
Dries committed
668
  foreach ($args as $key => $value) {
669
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
670
  }
Dries's avatar
 
Dries committed
671 672 673 674 675 676
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
677 678 679 680 681
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
682
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
683
  $output = "<item>\n";
684 685 686
  $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
687
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
688 689 690
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
691
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
 
Dries committed
692 693 694 695 696 697 698 699 700 701 702 703
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
704
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
705
    }
Dries's avatar
 
Dries committed
706
  }
Dries's avatar
 
Dries committed
707 708 709 710 711
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
712
/**
Dries's avatar
 
Dries committed
713
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
714
 *
Dries's avatar
 
Dries committed
715 716 717 718 719 720 721 722 723 724 725 726 727 728
 * 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
729
 */
Dries's avatar
 
Dries committed
730
function format_plural($count, $singular, $plural) {
731
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
732 733

  // get the plural index through the gettext formula
734
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
 
Dries committed
735 736 737 738 739 740
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
741
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
742 743 744 745 746 747
      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
748 749
}

Dries's avatar
 
Dries committed
750
/**
Dries's avatar
 
Dries committed
751
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
752
 *
Dries's avatar
 
Dries committed
753 754 755 756
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
757
 */
Dries's avatar
 
Dries committed
758
function format_size($size) {
Dries's avatar
 
Dries committed
759
  $suffix = t('bytes');
760
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
761
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
762
    $suffix = t('KB');
Dries's avatar
 
Dries committed
763
  }
764
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
765
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
766
    $suffix = t('MB');
Dries's avatar
 
Dries committed
767
  }
Dries's avatar
 
Dries committed
768
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
769 770
}

Dries's avatar
 
Dries committed
771
/**
Dries's avatar
 
Dries committed
772
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
773
 *
Dries's avatar
 
Dries committed
774 775 776 777 778 779
 * @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
780
 */
Dries's avatar
 
Dries committed
781
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
782
  $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
783
  $output = '';
Dries's avatar
 
Dries committed
784
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
785
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
786
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
787
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
788
      $timestamp %= $value;
Dries's avatar
 
Dries committed
789 790 791 792 793
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
794 795
    }
  }
Dries's avatar
 
Dries committed
796
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
797 798
}

Dries's avatar
 
Dries committed
799
/**
Dries's avatar
 
Dries committed
800 801
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
802 803 804 805
 * 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
806 807 808 809 810 811
 * @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
812 813 814
 *   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
815 816 817 818
 * @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
819
 */
820
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
821
  if (!isset($timezone)) {
822
    global $user;
Steven Wittens's avatar
Steven Wittens committed
823 824 825 826 827 828
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
829
  }
Dries's avatar
 
Dries committed
830

831
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
832 833

  switch ($type) {
834 835
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
836
      break;
837 838
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
839
      break;
840
    case 'custom':
Dries's avatar
 
Dries committed
841
      // No change to format
Dries's avatar
 
Dries committed
842
      break;
843
    case 'medium':
Dries's avatar
 
Dries committed
844
    default:
845
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
846 847
  }

848
  $max = strlen($format);
Dries's avatar
 
Dries committed
849
  $date = '';
Dries's avatar
 
Dries committed
850
  for ($i = 0; $i < $max; $i++) {
851
    $c = $format[$i];
852
    if (strpos('AaDFlM', $c) !== false) {
853
      $date .= t(gmdate($c, $timestamp));
854
    }
855
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
856 857 858 859
      $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
860
    }
861 862 863 864 865
    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
866
    }
867 868 869
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
870
    else {
871
      $date .= $c;
Dries's avatar
 
Dries committed
872
    }
Dries's avatar
 
Dries committed
873
  }
874

Dries's avatar
 
Dries committed
875 876 877
  return $date;
}

Dries's avatar
 
Dries committed
878 879 880
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
881

Dries's avatar
 
Dries committed
882
/**
883
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
Dries's avatar
 
Dries committed
884 885
 *
 * @param $path
886 887
 *   The Drupal path being linked to, such as "admin/node", or an existing URL
 *   like "http://drupal.org/".
Dries's avatar
 
Dries committed
888
 * @param $query
889
 *   A query string to append to the link or URL.
Dries's avatar
 
Dries committed
890
 * @param $fragment
891 892 893
 *   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
894 895
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
896 897
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
Dries's avatar
 
Dries committed
898 899 900 901 902 903 904
 * @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) {
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  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 ':'.
  if (strpos($path, ':') !== FALSE && filter_xss_bad_protocol($path) == $path) {
    // Split off the fragment
    if (strpos($path, '#')) {
      list($path, $old_fragment) = explode('#', $path, 2);
      if (isset($old_fragment) && !isset($fragment)) {
        $fragment = '#'. $old_fragment;
      }
    }
    // Append the query
    if (isset($query)) {
      $path .= (strpos($path, '?') ? '&' : '?') . $query;
    }
    // Reassemble
    return $path . $fragment;
  }
Dries's avatar
 
Dries committed
926

927
  global $base_url;
Dries's avatar
 
Dries committed
928
  static $script;
929
  static $clean_url;
Dries's avatar
 
Dries committed
930 931

  if (empty($script)) {
Dries's avatar
 
Dries committed
932 933 934
    // On some web servers, such as IIS, we can't omit "index.php".  So, we
    // generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    // Apache.
Dries's avatar
 
Dries committed
935
    $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) ? 'index.php' : '';
Dries's avatar
 
Dries committed
936
  }
937

938
  // Cache the clean_url variable to improve performance.
939 940
  if (!isset($clean_url)) {
    $clean_url = (bool)variable_get('clean_url', '0');
941
  }
Dries's avatar
 
Dries committed
942

943
  $base = ($absolute ? $base_url . '/' : base_path());
Dries's avatar
Dries committed
944

945 946 947 948 949
  // The special path '<front>' links to the default front page.
  if (isset($path) && $path != '<front>') {
    $path = drupal_get_path_alias($path);
    $path = drupal_urlencode($path);
    if (!$clean_url) {
Dries's avatar
 
Dries committed
950
      if (isset($query)) {
951
        return $base . $script .'?q='. $path .'&'. $query . $fragment;
Dries's avatar
 
Dries committed
952 953
      }
      else {
Dries's avatar
 
Dries committed
954
        return $base . $script .'?q='. $path . $fragment;
Dries's avatar
 
Dries committed
955
      }
Dries's avatar
 
Dries committed
956 957
    }
    else {
Dries's avatar
 
Dries committe