common.inc 39.7 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 173 174 175 176 177 178
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
    $destination[] = $_GET['q'];
    $params = array('page', 'sort', 'order');
    foreach ($params as $param) {
      if (isset($_GET[$param])) {
        $destination[] = "$param=". $_GET[$param];
      }
179
    }
180
    return 'destination='. urlencode(implode('&', $destination));
181 182 183
  }
}

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

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

Dries's avatar
 
Dries committed
226 227 228 229
  // 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
230

Dries's avatar
 
Dries committed
231 232 233
  // 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
234 235 236
  exit();
}

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

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
255
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
256
    menu_set_active_item($path);
257
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
258 259
  }

260
  if (empty($return)) {
261
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
262
  }
263
  print theme('page', $return);
Dries's avatar
 
Dries committed
264
}
Dries's avatar
 
Dries committed
265

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

  $path = drupal_get_normal_path(variable_get('site_403', ''));
274
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
275
    menu_set_active_item($path);
276
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
277 278
  }

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

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

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

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

Dries's avatar
 
Dries committed
335
  // Construct the path to act on.
Dries's avatar
Dries committed
336 337
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
 
Dries committed
338
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
339 340
  }

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

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
352
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
353 354
  }

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

  fwrite($fp, $request);

  // Fetch response.
366
  $response = '';
367 368
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
 
Dries committed
369 370 371 372
  }
  fclose($fp);

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

376
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
 
Dries committed
377 378 379
  $result->headers = array();

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

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

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

Dries's avatar
 
Dries committed
443
    if (variable_get('error_level', 1) == 1) {
444
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
445
    }
446 447

    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
448 449 450
  }
}

Dries's avatar
 
Dries committed
451
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
452
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
453 454 455
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
456
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
457 458 459
  }
}

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

Kjartan's avatar
Kjartan committed
475 476 477
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
478
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
479
 */
Dries's avatar
 
Dries committed
480 481 482 483

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
484
function message_na() {
Dries's avatar
 
Dries committed
485
  return t('n/a');
Dries's avatar
 
Dries committed
486 487
}

Dries's avatar
 
Dries committed
488 489 490
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
491

Dries's avatar
 
Dries committed
492 493 494
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
495 496
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
497 498 499 500 501

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

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

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

Dries's avatar
 
Dries committed
549 550
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
551 552
  }
  else {
Dries's avatar
 
Dries committed
553 554
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
555 556
}

Kjartan's avatar
Kjartan committed
557
/**
Dries's avatar
 
Dries committed
558
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
559
 * @{
Dries's avatar
 
Dries committed
560
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
561 562
 */

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

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

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

629 630
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
631 632
}

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

Dries's avatar
 
Dries committed
641
/**
Dries's avatar
 
Dries committed
642
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
643
 * @{
Dries's avatar
 
Dries committed
644
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
645 646
 */

Dries's avatar
 
Dries committed
647 648 649 650 651 652
/**
 * 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
653 654
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
655
  $output = "<channel>\n";
656 657 658 659
  $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
660
  foreach ($args as $key => $value) {
661
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
662
  }
Dries's avatar
 
Dries committed
663 664 665 666 667 668
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
696
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
697
    }
Dries's avatar
 
Dries committed
698
  }
Dries's avatar
 
Dries committed
699 700 701 702 703
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
704
/**
Dries's avatar
 
Dries committed
705
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
706
 *
Dries's avatar
 
Dries committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720
 * 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
721
 */
Dries's avatar
 
Dries committed
722
function format_plural($count, $singular, $plural) {
723
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
724 725

  // get the plural index through the gettext formula
726
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
 
Dries committed
727 728 729 730 731 732
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
733
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
734 735 736 737 738 739
      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
740 741
}

Dries's avatar
 
Dries committed
742
/**
Dries's avatar
 
Dries committed
743
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
744
 *
Dries's avatar
 
Dries committed
745 746 747 748
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
749
 */
Dries's avatar
 
Dries committed
750
function format_size($size) {
Dries's avatar
 
Dries committed
751
  $suffix = t('bytes');
752
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
753
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
754
    $suffix = t('KB');
Dries's avatar
 
Dries committed
755
  }
756
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
757
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
758
    $suffix = t('MB');
Dries's avatar
 
Dries committed
759
  }
Dries's avatar
 
Dries committed
760
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
761 762
}

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

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
786 787
    }
  }
Dries's avatar
 
Dries committed
788
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
789 790
}

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

823
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
824 825

  switch ($type) {
826 827
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
828
      break;
829 830
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
831
      break;
832
    case 'custom':
Dries's avatar
 
Dries committed
833
      // No change to format
Dries's avatar
 
Dries committed
834
      break;
835
    case 'medium':
Dries's avatar
 
Dries committed
836
    default:
837
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
838 839
  }

840
  $max = strlen($format);
Dries's avatar
 
Dries committed
841
  $date = '';
Dries's avatar
 
Dries committed
842
  for ($i = 0; $i < $max; $i++) {
843
    $c = $format[$i];
844
    if (strpos('AaDFlM', $c) !== false) {
845
      $date .= t(gmdate($c, $timestamp));
846
    }
847
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
848 849 850 851
      $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
852
    }
853 854 855 856 857
    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
858
    }
859 860 861
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
862
    else {
863
      $date .= $c;
Dries's avatar
 
Dries committed
864
    }
Dries's avatar
 
Dries committed
865
  }
866

Dries's avatar
 
Dries committed
867 868 869
  return $date;
}

Dries's avatar
 
Dries committed
870 871 872
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
873

Dries's avatar
 
Dries committed
874
/**
875
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
Dries's avatar
 
Dries committed
876 877
 *
 * @param $path
878 879
 *   The Drupal path being linked to, such as "admin/node", or an existing URL
 *   like "http://drupal.org/".
Dries's avatar
 
Dries committed
880
 * @param $query
881
 *   A query string to append to the link or URL.
Dries's avatar
 
Dries committed
882
 * @param $fragment
883 884 885
 *   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
886 887
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
888 889
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
Dries's avatar
 
Dries committed
890 891 892 893 894 895 896
 * @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) {
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
  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
918

919
  global $base_url;
Dries's avatar
 
Dries committed
920
  static $script;
921
  static $clean_url;
Dries's avatar
 
Dries committed
922 923

  if (empty($script)) {
Dries's avatar
 
Dries committed
924 925 926
    // 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
927
    $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) ? 'index.php' : '';
Dries's avatar
 
Dries committed
928
  }
929

930
  // Cache the clean_url variable to improve performance.
931 932
  if (!isset($clean_url)) {
    $clean_url = (bool)variable_get('clean_url', '0');
933
  }
Dries's avatar
 
Dries committed
934

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

937 938 939 940 941
  // 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
942
      if (isset($query)) {
943
        return $base . $script .'?q='. $path .'&'. $query . $fragment;
Dries's avatar
 
Dries committed
944 945
      }
      else {
Dries's avatar
 
Dries committed
946
        return $base . $script .'?q='. $path . $fragment;
Dries's avatar
 
Dries committed
947
      }
Dries's avatar
 
Dries committed
948 949
    }
    else {
Dries's avatar
 
Dries committed
950
      if (isset($query)) {
951
        return $base . $path .'?'. $query . $fragment;
Dries's avatar
 
Dries committed
952 953
      }
      else {
954
        return $base . $path . $fragment;
Dries's avatar
 
Dries committed
955
      }
Dries's avatar
 
Dries committed
956 957 958
    }
  }
  else {
959 960
    if (isset($query)) {
      return $base . $script .'?'. $query . $fragment;
Dries's avatar