common.inc 31.7 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
/**
Kjartan's avatar
Kjartan committed
5 6 7 8 9 10
 * @defgroup common Core functions
 */

/**
 * @name Page title
 * @ingroup common
Dries's avatar
 
Dries committed
11 12 13 14
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries's avatar
 
Dries committed
15 16 17 18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
 
Dries committed
19
    $stored_title = ucfirst($title);
Dries's avatar
 
Dries committed
20 21 22 23 24 25 26 27 28 29 30 31 32
  }
  return $stored_title;
}

function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}
Kjartan's avatar
Kjartan committed
33
/* @} */
Dries's avatar
 
Dries committed
34

Dries's avatar
 
Dries committed
35
/**
Kjartan's avatar
Kjartan committed
36 37
 * @name Page messages
 * @ingroup common
Dries's avatar
 
Dries committed
38 39 40 41
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries's avatar
 
Dries committed
42
function drupal_set_message($message = NULL, $type = "status") {
Dries's avatar
 
Dries committed
43
  static $stored_message = array();
Dries's avatar
 
Dries committed
44 45

  if (isset($message)) {
Dries's avatar
 
Dries committed
46
    $stored_message[] = array($message, $type);
Dries's avatar
 
Dries committed
47 48 49 50 51
  }

  return $stored_message;
}

Dries's avatar
 
Dries committed
52
function drupal_get_messages() {
Dries's avatar
 
Dries committed
53 54
  return drupal_set_message();
}
Kjartan's avatar
Kjartan committed
55
/* @} */
Dries's avatar
 
Dries committed
56

Dries's avatar
 
Dries committed
57
/**
Kjartan's avatar
Kjartan committed
58 59
 * @name Page breadcrumbs
 * @ingroup common
Dries's avatar
 
Dries committed
60 61 62 63
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
Kjartan's avatar
Kjartan committed
64 65 66 67 68

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries's avatar
 
Dries committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}
Kjartan's avatar
Kjartan committed
88
/* @} */
Dries's avatar
 
Dries committed
89

Dries's avatar
 
Dries committed
90
/**
Kjartan's avatar
Kjartan committed
91 92 93 94
 * @name URL path
 * @ingroup common
 *
 * Function to handle path aliases.
Dries's avatar
 
Dries committed
95
 */
Dries's avatar
 
Dries committed
96
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
97
  static $map = NULL;
Dries's avatar
 
Dries committed
98

Dries's avatar
 
Dries committed
99 100 101 102
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
103
  if (is_null($map)) {
Dries's avatar
 
Dries committed
104
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
 
Dries committed
105
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
106
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
107 108 109 110 111 112
    }
  }

  return $map;
}

Dries's avatar
 
Dries committed
113 114 115
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
/* @} */

/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

/**
 * HTTP redirects. Makes sure the redirected url is formatted correctly and
 * includes the session ID.
 *
 * @note This function ends the request.
 *
 * @param $url A string containing a fully qualified URI.
 */
function drupal_goto($url) {

  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
 
Dries committed
139

Kjartan's avatar
Kjartan committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
  $url = str_replace("&amp;", "&", $url);

  /*
  ** It is advised to use "drupal_goto()" instead of PHP's "header()" as
  ** "drupal_goto()" will append the user's session ID to the URI when PHP
  ** is compiled with "--enable-trans-sid".
  */
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
    header("Location: $url");
  }
  else {
    $sid = session_name() . "=" . session_id();

    if (strstr($url, "?") && !strstr($url, $sid)) {
      header("Location: $url&". $sid);
    }
    else {
      header("Location: $url?". $sid);
    }
  }

  /*
  ** 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/ gets executed when we redirect.
  */

  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
173 174
function drupal_not_found() {
  header("HTTP/1.0 404 Not Found");
Dries's avatar
Dries committed
175
  watchdog("httpd", "404 error: '". check_query($_GET["q"]) ."' not found");
Dries's avatar
 
Dries committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189

  $path = drupal_get_normal_path(variable_get('site_404', ''));

  if ($path) {
    menu_set_active_item($path);
  }

  if ($path && menu_active_handler_exists()) {
    menu_execute_active_handler();
  }
  else {
    print theme("page", '<h1>'. t('Page not found') .'</h1>');
  }
}
Dries's avatar
 
Dries committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233

/**
 * Flexible and powerful HTTP client implementation. Allows to GET, POST, PUT
 * or any other HTTP requests. Handles redirects.
 *
 * @param $url A string containing a fully qualified URI.
 * @param $headers An array containing a 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.
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
  // Parse the URL, and make sure we can handle the schema
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
      // Note: only works for PHP 4.3 compiled with openssl
      $fp = @fsockopen("ssl://$uri[host]", ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
      break;
    default:
      $result->error = "invalid schema $uri[scheme]";
      return $result;
  }

  // Make sure the socket opened properly
  if (!$fp) {
    $result->error = trim("$errno $errstr");
    return $result;
  }

  // Construct the path to act on
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
    $path .= "?$uri[query]";
  }

  // Create http request
  $defaults = array(
234 235 236
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  );

  foreach ($headers as $header => $value) {
    $defaults[$header] = "$header: $value";
  }

  $request = "$method $path HTTP/1.0\r\n";
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
    $request .= "$data\r\n";
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
  while (!feof($fp) && $data = fgets($fp)) {
    $response[] = $data;
  }
  fclose($fp);

  // Parse response.
  list($protocol, $code, $text) = explode(' ', trim(array_shift($response)), 3);
  $result->headers = array();
  $result->data = '';

  // Parse headers.
  while ($line = trim(array_shift($response))) {
    if ($line == '') {
      break;
    }
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $result->data = implode('', $response);

  $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
  // the base code in their class:
  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;
}
Kjartan's avatar
Kjartan committed
311
/* @} */
Dries's avatar
 
Dries committed
312

Dries's avatar
 
Dries committed
313 314 315
function error_handler($errno, $message, $filename, $line, $variables) {
  $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");
  $entry = $types[$errno] .": $message in $filename on line $line.";
Dries's avatar
 
Dries committed
316 317

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
 
Dries committed
318
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
319 320 321
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
 
Dries committed
322 323 324 325 326
  }
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Kjartan's avatar
Kjartan committed
327 328
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '%s' AND hostname = '%s' AND %d - timestamp < %d", $type, $_SERVER['REMOTE_ADDR'], time(), $rate))) {
      watchdog("warning", "throttle: '". $_SERVER['REMOTE_ADDR'] ."' exceeded submission rate - $throttle->type");
Dries's avatar
 
Dries committed
329 330 331 332 333
      die(message_throttle());
    }
  }
}

Dries's avatar
Dries committed
334 335
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
336 337 338
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
339
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
340 341 342
  }
}

Dries's avatar
 
Dries committed
343 344
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
345
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
346 347 348 349 350 351
    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
352 353
}

Kjartan's avatar
Kjartan committed
354 355 356 357 358 359 360
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
361 362 363
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
364 365 366 367
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
368
    $object = $array;
Dries's avatar
 
Dries committed
369 370 371 372 373
  }

  return $object;
}

Dries's avatar
Dries committed
374 375 376
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
377 378 379 380
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
381
    $array = $object;
Dries's avatar
 
Dries committed
382 383 384 385
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
386
/* @} */
Dries's avatar
 
Dries committed
387

Kjartan's avatar
Kjartan committed
388 389 390 391 392 393 394
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
 
Dries committed
395
function message_access() {
Dries's avatar
 
Dries committed
396
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
397 398 399 400 401 402 403 404 405
}

function message_na() {
  return t("n/a");
}

function message_throttle() {
  return t("You exceeded the maximum submission rate.  Please wait a few minutes and try again.");
}
Kjartan's avatar
Kjartan committed
406
/* @} */
Dries's avatar
 
Dries committed
407

Dries's avatar
 
Dries committed
408 409
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
410 411 412 413 414 415
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
416 417
}

Kjartan's avatar
Kjartan committed
418 419 420 421 422
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
423 424 425 426
 * When using t(), try to put entire sentences and strings in one t() call.
 * This makes it easier for translators. We are unafraid of HTML markup within
 * translation strings if necessary. The suggested syntax for a link embedded
 * within a translation string is for example:
Kjartan's avatar
Kjartan committed
427 428 429 430 431
 * @code
 *   $msg = t("You must login below or \<a href=\"%url\"\>create a new
 *             account\</a\> before viewing the next page.", array("%url"
 *             => url("user/register")));
 * @endcode
432 433 434
 * 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
435 436 437 438 439
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
Dries's avatar
 
Dries committed
440
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
441
  global $languages;
442

443
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
444

Dries's avatar
 
Dries committed
445 446
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
447 448
  }
  else {
Dries's avatar
 
Dries committed
449 450
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
451 452
}

Dries's avatar
 
Dries committed
453
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
454 455 456 457 458 459 460 461 462

  /*
  ** Note that we'd like to go 'htmlspecialchars($input, $quotes, "utf-8")'
  ** like the PHP manual tells us to, but we can't because there's a bug in
  ** PHP <4.3 that makes it mess up multibyte charsets if we specify the
  ** charset.  Change this later once we make PHP 4.3 a requirement.
  */

  return htmlspecialchars($input, $quotes);
Dries's avatar
 
Dries committed
463 464
}

Kjartan's avatar
Kjartan committed
465 466 467 468 469 470 471
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
 */

472
/**
Dries's avatar
 
Dries committed
473 474
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
475
 *
Kjartan's avatar
Kjartan committed
476
 * @param $mail A string containing an email address.
Dries's avatar
 
Dries committed
477
 * @return
478
 */
Dries's avatar
 
Dries committed
479
function valid_email_address($mail) {
480 481 482 483 484
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
  $domain = '(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.?)+';
  $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
485
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
486 487
}

Dries's avatar
 
Dries committed
488 489 490
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
491
 * @param $url an URL
Dries's avatar
 
Dries committed
492 493
 */
function valid_url($url) {
Dries's avatar
Dries committed
494
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
Dries's avatar
 
Dries committed
495 496
}

Kjartan's avatar
Kjartan committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
      if (!valid_input_data($value)) {
        return 0;
      }
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

    // check strings:
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

    // check attributes:
    $match += preg_match("/\W(dynsrc|datasrc|data|lowsrc|on[a-z]+)\s*=[^>]+?>/i", $data);

    // check tags:
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
      return 0;
    }
  }

  return 1;
}
/* @} */

/**
 * @defgroup search Search interface
 * @{
 */
Kjartan's avatar
Kjartan committed
539 540 541
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
 
Dries committed
542
 * @param $item a single search result as returned by <i>module</i>_search of
543
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
 
Dries committed
544 545
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
546
 */
Dries's avatar
 
Dries committed
547
function search_item($item, $type) {
Dries's avatar
 
Dries committed
548 549 550 551 552 553 554 555 556 557

  /*
  ** Modules may implement the "search_item" hook in order to overwrite
  ** the default function to display search results.
  */

  if (module_hook($type, "search_item")) {
    $output = module_invoke($type, "search_item", $item);
  }
  else {
558
    $output = " <strong><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></strong><br />";
Dries's avatar
 
Dries committed
559
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
 
Dries committed
560 561
    $output .= "<br /><br />";
  }
Dries's avatar
 
Dries committed
562 563 564 565

  return $output;
}

Kjartan's avatar
Kjartan committed
566 567 568 569
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
570 571 572
 * 'site.com/search', but also as a simple seach box (without "Restrict search
 * to", help text, etc) from theme's header etc. This means: provide options to
 * only conditionally render certain parts of this form.
Kjartan's avatar
Kjartan committed
573
 *
Dries's avatar
 
Dries committed
574 575 576 577
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys string containing keywords for the search.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
578
 */
Dries's avatar
 
Dries committed
579
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
580 581
  $edit = $_POST['edit'];

Dries's avatar
 
Dries committed
582
  if (!$action) {
Dries's avatar
 
Dries committed
583
    $action = url("search");
Dries's avatar
 
Dries committed
584 585
  }

Dries's avatar
Dries committed
586
  $output = " <br /><input type=\"text\" class=\"form-text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
Dries's avatar
 
Dries committed
587
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries's avatar
 
Dries committed
588

Dries's avatar
Dries committed
589
  if ($options) {
Dries's avatar
 
Dries committed
590 591 592 593 594
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
595
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
596 597 598 599
      }
    }
  }

Kjartan's avatar
Kjartan committed
600 601
  $form .= "<br />";

Dries's avatar
 
Dries committed
602 603 604 605
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
606 607
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
608
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
609
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
610

Dries's avatar
 
Dries committed
611
  if (isset($keys)) {
Dries's avatar
 
Dries committed
612
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
613
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan's avatar
Kjartan committed
614
        if ($name == "node" || $name == "comment") {
615
          $output .= "<p><strong>". t("Matching %names ranked in order of relevance:", array("%name" => $name)) ."</strong></p>";
Kjartan's avatar
Kjartan committed
616 617
        }
        else {
Dries's avatar
 
Dries committed
618
          $output .= "<p><strong>". t("Matching {$name}s") .":</strong></p>";
Kjartan's avatar
Kjartan committed
619
        }
Dries's avatar
 
Dries committed
620 621 622 623 624 625 626 627 628 629
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
630 631 632
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
633 634 635 636 637 638
 * @param $type If set, search only nodes of this type. Otherwise, search all
 *   types.
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys Query string. Defaults to global $keys.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
639
 */
Dries's avatar
 
Dries committed
640 641
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
 
Dries committed
642

Dries's avatar
 
Dries committed
643
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
644
}
Kjartan's avatar
Kjartan committed
645
/* @} */
Dries's avatar
 
Dries committed
646

Dries's avatar
 
Dries committed
647
function check_form($text) {
Dries's avatar
 
Dries committed
648
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
649 650
}

651 652
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
653 654
}

Dries's avatar
 
Dries committed
655 656 657
function format_rss_channel($title, $link, $description, $items, $language = "en", $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
658
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
659 660 661 662
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars($description) ."</description>\n";
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
 
Dries committed
663
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
664
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
665
  }
Dries's avatar
 
Dries committed
666 667 668 669 670 671
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
672 673 674
function format_rss_item($title, $link, $description, $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
675
  $output = "<item>\n";
Dries's avatar
 
Dries committed
676 677 678
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars(check_output($description)) ."</description>\n";
Dries's avatar
 
Dries committed
679
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
680
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
681
  }
Dries's avatar
 
Dries committed
682 683 684 685 686
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
687 688
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
689 690
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
691
 *
Dries's avatar
 
Dries committed
692 693 694 695
 * @param $count The item count to display.
 * @param $singular The string for the singular case. Please make sure it's
 *   clear this is singular, to ease translation. ("1 new comment" instead of "1
 *   new").
Kjartan's avatar
Kjartan committed
696
 * @param $plural The string for the plural case. Please make sure it's clear
Dries's avatar
 
Dries committed
697 698
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
 
Dries committed
699
 */
Dries's avatar
 
Dries committed
700
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
701
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
702 703 704
}

function format_size($size) {
Dries's avatar
 
Dries committed
705
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
706 707
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
708
    $suffix = t("KB");
Dries's avatar
 
Dries committed
709 710 711
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
712
    $suffix = t("MB");
Dries's avatar
 
Dries committed
713
  }
Dries's avatar
 
Dries committed
714
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
715 716 717
}

function format_interval($timestamp) {
Dries's avatar
 
Dries committed
718
  $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
719
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
720 721 722 723 724 725
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
 
Dries committed
726
  return ($output) ? $output : t("0 sec");
Dries's avatar
 
Dries committed
727 728 729 730 731
}

function format_date($timestamp, $type = "medium", $format = "") {
  global $user;

Kjartan's avatar
Kjartan committed
732
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
 
Dries committed
733 734 735

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
736
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
 
Dries committed
737 738
      break;
    case "large":
Dries's avatar
 
Dries committed
739
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
 
Dries committed
740 741
      break;
    case "custom":
Dries's avatar
 
Dries committed
742
      // No change to format
Dries's avatar
 
Dries committed
743
      break;
Dries's avatar
 
Dries committed
744
    case "medium":
Dries's avatar
 
Dries committed
745
    default:
Dries's avatar
 
Dries committed
746 747 748 749 750 751 752 753 754 755 756 757 758
      $format = variable_get("date_format_medium", "D, m/d/Y - H:i");
  }

  for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
    if (strstr("DFlMSw", $c)) {
      $date = t(date($c, $timestamp)) . $date;
    }
    else if (strstr("AaBdgGhHiIjLmnOrstTUWYyZz", $c)) {
      $date = date($c, $timestamp) . $date;
    }
    else {
      $date = $c.$date;
    }
Dries's avatar
 
Dries committed
759 760 761 762 763 764 765
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
766 767 768 769 770 771 772 773 774 775 776 777
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
      $name = substr($object->name, 0, 15) ."...";
    }
    else {
      $name = $object->name;
    }

Dries's avatar
 
Dries committed
778
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
779
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
780 781
    }
    else {
Dries's avatar
Dries committed
782
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
783
    }
Dries's avatar
 
Dries committed
784
  }
Dries's avatar
 
Dries committed
785 786 787 788 789 790 791 792 793 794
  else if ($object->name) {
    /*
    ** Sometimes modules display content composed by people who are
    ** not registers members of the site (i.e. mailing list or news
    ** aggregator modules).  This clause enables modules to display
    ** the true author of the content.
    */

    $output = $object->name;
  }
Dries's avatar
 
Dries committed
795
  else {
Dries's avatar
 
Dries committed
796
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
797 798
  }

Dries's avatar
 
Dries committed
799
  return $output;
Dries's avatar
 
Dries committed
800 801
}

Kjartan's avatar
Kjartan committed
802 803 804 805
/**
 * @defgroup from Form generation
 * @{
 */
Dries's avatar
 
Dries committed
806
function form($form, $method = "post", $action = 0, $options = 0) {
Dries's avatar
 
Dries committed
807
  if (!$action) {
808
    $action = request_uri();
Dries's avatar
 
Dries committed
809
  }
810
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
811 812
}

Dries's avatar
 
Dries committed
813 814
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
 
Dries committed
815
}
Dries's avatar
 
Dries committed
816

Dries's avatar
 
Dries committed
817
function form_group($legend, $group, $description = NULL) {
Dries's avatar
 
Dries committed
818 819
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries's avatar
 
Dries committed
820

Dries's avatar
 
Dries committed
821
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
822
  return theme("form_element", NULL, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
 
Dries committed
823 824 825 826 827
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
Dries's avatar
 
Dries committed
828
      $choices .= "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice<br />";
Dries's avatar
 
Dries committed
829
    }
Dries's avatar
 
Dries committed
830
    return theme("form_element", $title, $choices, $description);
Dries's avatar
 
Dries committed
831
  }
Dries's avatar
 
Dries committed
832 833
}

Dries's avatar
 
Dries committed
834
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
835
  return form_hidden($name, 0) . theme("form_element", NULL, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
 
Dries committed
836 837
}

Dries's avatar
 
Dries committed
838
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
839
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
840
  return theme("form_element", $title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
 
Dries committed
841 842
}

Dries's avatar
 
Dries committed
843
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
844
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
845
  return theme("form_element", $title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
 
Dries committed
846 847
}

Dries's avatar
 
Dries committed
848
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
849
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
850
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
851
  return theme("form_element", $title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"$name\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description, $name);
Dries's avatar
 
Dries committed
852 853
}

Dries's avatar
 
Dries committed
854
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
855 856
  foreach ($options as $key => $choice) {
    $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($value == $key ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
Dries's avatar
 
Dries committed
857
  }
Dries's avatar
 
Dries committed
858
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name);
Dries's avatar
 
Dries committed
859 860
}

Dries's avatar
 
Dries committed
861 862
function form_file($title, $name, $size, $description = NULL) {
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" id=\"$name\" size=\"$size\" />\n", $description, $name);
Dries's avatar
 
Dries committed
863 864 865 866 867 868
}

function form_hidden($name, $value) {
  return "<input type=\"hidden\" name=\"edit[$name]\" value=\"". check_form($value) ."\" />\n";
}

Dries's avatar
 
Dries committed
869
function form_button($value, $name = "op", $type = "submit", $attributes = NULL) {
Dries's avatar
 
Dries committed
870 871 872
  return "<input type=\"$type\" class=\"form-$type\" name=\"$name\" value=\"". check_form($value) ."\" ". drupal_attributes($attributes) ." />\n";
}

Dries's avatar
 
Dries committed
873
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
 
Dries committed
874
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
 
Dries committed
875 876
}

Dries's avatar
 
Dries committed
877
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
 
Dries committed
878
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
879 880 881 882 883 884
    $weights[$n] = $n;
  }

  return form_select($title, $name, $value, $weights, $description, $extra);
}

Dries's avatar
 
Dries committed
885 886 887
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}
Kjartan's avatar
Kjartan committed
888
/* @} */
Dries's avatar
 
Dries committed
889

Dries's avatar
 
Dries committed
890 891 892
/**
 * Given an old url, return the alias.
 */
Dries's avatar
 
Dries committed
893
function drupal_get_path_alias($path) {
Dries's avatar
 
Dries committed
894 895 896 897 898 899
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'outgoing');
  }
Dries's avatar
 
Dries committed
900 901 902
}

/**
Dries's avatar
 
Dries committed
903
 * Given an alias, return the default url.
Dries's avatar
 
Dries committed
904
 */
Dries's avatar
 
Dries committed
905
function drupal_get_normal_path($path) {
Dries's avatar
 
Dries committed
906 907 908 909 910 911 912 913 914
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
Dries's avatar
 
Dries committed
915 916
}

Dries's avatar
 
Dries committed
917
function url($url = NULL, $query = NULL, $fragment = NULL) {
Dries's avatar
 
Dries committed
918
  global $base_url;
Dries's avatar
 
Dries committed
919

Dries's avatar
 
Dries committed
920 921 922 923 924 925 926 927 928 929 930
  static $script;

  if (empty($script)) {
    /*
    ** On some webservers such as IIS we can't omit "index.php".  As such we
    ** generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    ** Apache.
    */
    $script = (strpos($_SERVER["SERVER_SOFTWARE"], "Apache") === false) ? "index.php" : "";
  }

Dries's avatar
 
Dries committed
931
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
932 933 934
    $url = $alias;
  }

Dries's avatar
 
Dries committed
935 936 937 938
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

Dries's avatar
 
Dries committed
939
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
940 941
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
942
        return "$base_url/$script?q=$url&amp;$query$fragment";
Dries's avatar
 
Dries committed
943 944
      }
      else {
Dries's avatar
 
Dries committed
945
        return "$base_url/$script?q=$url$fragment";
Dries's avatar
 
Dries committed
946
      }
Dries's avatar
 
Dries committed
947 948
    }
    else {
Dries's avatar
 
Dries committed
949
      if (isset($query)) {
Dries's avatar
 
Dries committed
950
        return "$base_url/$script?$query$fragment";
Dries's avatar
 
Dries committed
951 952
      }
      else {
Dries's avatar
 
Dries committed
953
        return "$base_url/$fragment";
Dries's avatar
 
Dries committed
954
      }
Dries's avatar
 
Dries committed
955 956 957
    }
  }
  else {
Dries's avatar
 
Dries committed
958 959
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
960
        return "$base_url/$url?$query$fragment";
Dries's avatar
 
Dries committed
961 962
      }
      else {
Dries's avatar
 
Dries committed
963
        return "$base_url/$url$fragment";
Dries's avatar
 
Dries committed
964
      }
Dries's avatar
 
Dries committed
965
    }
Dries's avatar
 
Dries committed
966
    else {
Dries's avatar
 
Dries committed
967
      if (isset($query)) {
Dries's avatar
 
Dries committed
968
        return "$base_url/$script?$query$fragment";
Dries's avatar
 
Dries committed
969 970
      }
      else {
Dries's avatar
 
Dries committed
971
        return "$base_url/$fragment";
Dries's avatar
 
Dries committed
972
      }
Dries's avatar
 
Dries committed
973
    }
Dries's avatar
 
Dries committed
974
  }
Dries's avatar
 
Dries committed
975 976
}

Dries's avatar
 
Dries committed
977
function drupal_attributes($attributes = NULL) {
978 979 980 981 982 983
  if (is_array($attributes)) {
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
    return " ". implode($t, " ");
Dries's avatar
 
Dries committed
984
  }
985
}
Dries's avatar
 
Dries committed
986

Dries's avatar
 
Dries committed
987
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL) {
Dries's avatar
 
Dries committed
988
  return "<a href=\"". url($url, $query, $fragment) ."\"". ($url == $_GET['q'] ? ' class="active"' : NULL) . drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
989 990
}

Dries's avatar
 
Dries committed
991
function field_get($string, $name) {
992
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
 
Dries committed
993 994 995 996 997
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
 
Dries committed
998
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
999 1000
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
 
Dries committed
1001 1002 1003 1004
  return substr($rval, 1);
}

function link_page() {
1005
  global $custom_links;
Dries's avatar
 
Dries committed
1006

1007
  if (is_array($custom_links)) {
1008 1009 1010
    return $custom_links;
  }
  else {
Dries's avatar
 
Dries committed
1011
    $links = module_invoke_all("link", "page");
1012
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
1013
    return $links;
Dries's avatar
 
Dries committed
1014
  }
Dries's avatar
 
Dries committed
1015
}
Dries's avatar
 
Dries committed
1016 1017

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
1018
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
1019 1020
}

Dries's avatar
 
Dries committed
1021
function drupal_page_footer() {
Dries's avatar
 
Dries committed
1022
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
1023
    page_set_cache();
Dries's avatar
 
Dries committed
1024
  }
Dries's avatar
 
Dries committed
1025

Dries's avatar
 
Dries committed
1026 1027 1028 1029 1030
  /*
  ** A hook for modules where modules may take action at the end of a
  ** request good uses include setting a cache, page logging, etc.
  */

Dries's avatar
 
Dries committed
1031
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
1032 1033
}

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
/**
 * Wrapper around xml_parser_create() which extracts the encoding from the XML
 * data first and sets the output encoding to UTF-8. This function should be
 * used instead of xml_parser_create(), because PHP's XML parser doesn't check
 * the input encoding itself.
 *
 * This is also where unsupported encodings should be converted.
 * Callers should take this into account: $data might have been changed after
 * the call.
 *
 * @param $data The XML data which will be parsed later.
 */
function drupal_xml_parser_create(&$data) {
  $encoding = 'utf-8';
  if (ereg('^<\?xml[^>]+encoding="([^"]+)"', $data, $match)) {
    $encoding = $match[1];
  }

  /*
   * Note: unsupported encodings will need to be converted here into UTF-8,
   * and $encoding set to 'utf-8'.
   */

  $xml_parser = xml_parser_create($encoding);
  xml_parser_set_option($xml_parser, XML_OPTION_TARGET_ENCODING, 'utf-8');
  return $xml_parser;
}

Dries's avatar
 
Dries committed
1062
include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
1063
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
1064
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
1065
include_once "includes/xmlrpc.inc";
Dries's avatar
 
Dries committed
1066
include_once "includes/tablesort.inc";
Dries's avatar
 
Dries committed
1067
include_once "includes/file.inc";
1068

Dries's avatar
 
Dries committed
1069 1070 1071
// set error handler:
set_error_handler("error_handler");

Dries's avatar
 
Dries committed
1072
// spit out the correct charset http header
Dries's avatar
 
Dries committed
1073
header("Content-Type: text/html; charset=utf-8");
Dries's avatar
 
Dries committed
1074

Dries's avatar
 
Dries committed
1075 1076
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
Dries's avatar
 
Dries committed
1077
  $_GET["q"] = drupal_get_normal_path(trim($_GET["q"], "/"));
Dries's avatar
 
Dries committed
1078 1079
}
else {
Dries's avatar
 
Dries committed
1080
  $_GET["q"] = drupal_get_normal_path(variable_get("site_frontpage", "node"));
Dries's avatar
 
Dries committed
1081 1082
}

Dries's avatar
 
Dries committed
1083 1084 1085
// initialize installed modules:
module_init();

1086
if ($_REQUEST && !user_access("bypass input data check")) {
Dries's avatar
 
Dries committed
1087 1088 1089 1090 1091
  if (!valid_input_data($_REQUEST)) {
    die("terminated request because of suspicious input data");
  }
}

Dries's avatar
 
Dries committed
1092 1093 1094 1095
// initialize localization system:
$locale = locale_init();

// initialize theme:
Dries's avatar
 
Dries committed
1096
$theme = init_theme();
Dries's avatar
 
Dries committed
1097