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

4
/**
5 6 7 8 9 10
 * @defgroup common Core functions
 */

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

  if (isset($title)) {
19
    $stored_title = ucfirst($title);
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;
}
33
/* @} */
34

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

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

  return $stored_message;
}

52
function drupal_get_messages() {
53 54
  return drupal_set_message();
}
55
/* @} */
56

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

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
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;
}
88
/* @} */
89

Dries's avatar
Dries committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/**
 * @name HTML head contents
 * @ingroup common
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
  static $stored_head;

  if (!is_null($data)) {
    $stored_head .= "$data\n";
  }
  return $stored_head;
}

function drupal_get_html_head() {
  global $base_url;

  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />";
  $output .= "<base href=\"$base_url/\" />\n";
  $output .= "<style type=\"text/css\">\n";
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

  return $output . drupal_set_html_head();
}
/* @} */

120
/**
121 122 123 124
 * @name URL path
 * @ingroup common
 *
 * Function to handle path aliases.
125
 */
126
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
127
  static $map = NULL;
128

129 130 131 132
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
133
  if (is_null($map)) {
134
    $map = array();  // make $map non-null in case no aliases are defined
135
    $result = db_query("SELECT * FROM {url_alias}");
136
    while ($data = db_fetch_object($result)) {
137
      $map[$data->dst] = $data->src;
138 139 140 141 142 143
    }
  }

  return $map;
}

144 145 146
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
147 148 149 150 151 152 153 154 155 156
/* @} */

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

Dries's avatar
Dries committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/**
 * @name HTTP headers
 * @ingroup common
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
  static $stored_headers;

  if (!is_null($header)) {
    header($header);
    $stored_headers .= "$header\n";
  }
  return $stored_headers;
}

function drupal_get_headers() {
  return drupal_set_header();
}
/* @} */

179 180 181 182 183 184 185 186 187 188 189 190 191
/**
 * 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 &
  */
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
  $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.
 */
226 227
function drupal_not_found() {
  header("HTTP/1.0 404 Not Found");
Dries's avatar
Dries committed
228
  watchdog("httpd", "404 error: '". check_query($_GET["q"]) ."' not found");
229 230 231 232 233 234 235 236 237 238 239 240 241 242

  $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>');
  }
}
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

/**
 * 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(
287 288 289
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
  );

  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;
}
364
/* @} */
365

Dries's avatar
Dries committed
366 367 368
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.";
369 370

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
Dries committed
371
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
372 373 374
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
Dries committed
375 376 377 378 379
  }
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Kjartan's avatar
Kjartan committed
380 381
    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
382 383 384 385 386
      die(message_throttle());
    }
  }
}

Dries's avatar
Dries committed
387 388
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
389 390 391
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
392
    $item = stripslashes($item);
393 394 395
  }
}

396 397
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
398
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
399 400 401 402 403 404
    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;
  }
405 406
}

407 408 409 410 411 412 413
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
414 415 416
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
Dries committed
417 418 419 420
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
421
    $object = $array;
Dries's avatar
Dries committed
422 423 424 425 426
  }

  return $object;
}

Dries's avatar
Dries committed
427 428 429
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
Dries committed
430 431 432 433
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
434
    $array = $object;
Dries's avatar
Dries committed
435 436 437 438
  }

  return $array;
}
439
/* @} */
Dries's avatar
Dries committed
440

441 442 443 444 445 446 447
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
Dries committed
448
function message_access() {
Dries's avatar
Dries committed
449
  return t("You are not authorized to access this page.");
Dries's avatar
Dries committed
450 451 452 453 454 455 456 457 458
}

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.");
}
459
/* @} */
Dries's avatar
Dries committed
460

461 462
function locale_init() {
  global $languages, $user;
463 464 465 466 467 468
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
469 470
}

471 472 473 474 475
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
476 477 478 479
 * 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:
480 481 482 483 484
 * @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
485 486 487
 * 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.
488 489 490 491 492
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
493
function t($string, $args = 0) {
494
  global $languages;
495

496
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
497

498 499
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
500 501
  }
  else {
502 503
    return strtr($string, $args);
  }
504 505
}

506
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
507 508 509 510 511 512 513 514 515

  /*
  ** 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);
516 517
}

518 519 520 521 522 523 524
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
 */

525
/**
526 527
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
528
 *
529
 * @param $mail A string containing an email address.
530
 * @return
531
 */
532
function valid_email_address($mail) {
533 534 535 536 537
  $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
538
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
539 540
}

541 542 543
/**
 * Verify the syntax of the given URL.
 *
544
 * @param $url an URL
545 546
 */
function valid_url($url) {
Dries's avatar
Dries committed
547
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
548 549
}

550 551 552 553 554 555 556
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) {
Dries's avatar
Dries committed
557
      if (!valid_input_data($key) || !valid_input_data($value)) {
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
        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
592 593 594
/**
 * Format a single result entry of a search query:
 *
595
 * @param $item a single search result as returned by <i>module</i>_search of
596
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
597 598
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
599
 */
600
function search_item($item, $type) {
Dries's avatar
Dries committed
601 602 603 604 605 606 607 608 609 610

  /*
  ** 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 {
611
    $output = " <strong><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></strong><br />";
612
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
Dries committed
613 614
    $output .= "<br /><br />";
  }
615 616 617 618

  return $output;
}

Kjartan's avatar
Kjartan committed
619 620 621 622
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
623 624 625
 * '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
626
 *
627 628 629 630
 * @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
631
 */
632
function search_form($action = NULL, $keys = NULL, $options = NULL) {
633 634
  $edit = $_POST['edit'];

635
  if (!$action) {
Dries's avatar
Dries committed
636
    $action = url("search");
637 638
  }

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

Dries's avatar
Dries committed
642
  if ($options) {
643 644 645 646 647
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
648
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
649 650 651 652
      }
    }
  }

Kjartan's avatar
Kjartan committed
653 654
  $form .= "<br />";

655 656 657 658
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
659 660
 * Collect the search results:
 */
661
function search_data($keys = NULL) {
662
  $edit = $_POST["edit"];
663

664
  if (isset($keys)) {
665
    foreach (module_list() as $name) {
666
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
667 668
        $output .= "<h2>$result[0]</h2>";
        foreach ($result[1] as $entry) {
669 670 671 672 673 674 675 676 677
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
678 679 680
/**
 * Display the search form and the resulting data.
 *
681 682 683 684 685 686
 * @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
687
 */
688 689
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
690

691
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
692
}
693
/* @} */
694

Dries's avatar
Dries committed
695
function check_form($text) {
696
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
Dries committed
697 698
}

699 700
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
701 702
}

Dries's avatar
Dries committed
703 704 705
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
706
  $output = "<channel>\n";
707 708 709 710
  $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
711
  foreach ($args as $key => $value) {
Dries's avatar
Dries committed
712
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
Dries committed
713
  }
Dries's avatar
Dries committed
714 715 716 717 718 719
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
723
  $output = "<item>\n";
724 725 726
  $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
727
  foreach ($args as $key => $value) {
728
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
Dries committed
729
  }
Dries's avatar
Dries committed
730 731 732 733 734
  $output .= "</item>\n";

  return $output;
}

735 736
/**
 * Formats a string with a count of items so that the string is pluralized
737 738
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
739
 *
740 741 742 743
 * @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").
744
 * @param $plural The string for the plural case. Please make sure it's clear
745 746
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
747
 */
Dries's avatar
Dries committed
748
function format_plural($count, $singular, $plural) {
749
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
Dries committed
750 751 752
}

function format_size($size) {
753
  $suffix = t("bytes");
Dries's avatar
Dries committed
754 755
  if ($size > 1024) {
    $size = round($size / 1024, 2);
756
    $suffix = t("KB");
Dries's avatar
Dries committed
757 758 759
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
760
    $suffix = t("MB");
Dries's avatar
Dries committed
761
  }
762
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
Dries committed
763 764
}

765
function format_interval($timestamp, $granularity = 2) {
766
  $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);
767
  foreach ($units as $key => $value) {
Dries's avatar
Dries committed
768 769 770 771
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
772 773 774 775 776
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
Dries committed
777 778
    }
  }
779
  return ($output) ? $output : t("0 sec");
Dries's avatar
Dries committed
780 781 782 783 784
}

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

Kjartan's avatar
Kjartan committed
785
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
Dries committed
786 787 788

  switch ($type) {
    case "small":
789
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
Dries committed
790 791
      break;
    case "large":
792
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
Dries committed
793 794
      break;
    case "custom":
795
      // No change to format
Dries's avatar
Dries committed
796
      break;
797
    case "medium":
Dries's avatar
Dries committed
798
    default:
799 800 801 802 803 804 805 806 807 808 809 810 811
      $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
812 813 814 815 816 817 818
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
819 820 821 822 823 824 825 826 827 828 829 830
    /*
    ** 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;
    }

831
    if (arg(0) == "admin" and user_access("administer users")) {
832
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
833 834
    }
    else {
835
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
836
    }
Dries's avatar
Dries committed
837
  }
838 839 840 841 842 843 844 845 846 847
  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
848
  else {
849
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
Dries committed
850 851
  }

852
  return $output;
Dries's avatar
Dries committed
853 854
}

855 856 857 858
/**
 * @defgroup from Form generation
 * @{
 */
Dries's avatar
Dries committed
859
function form($form, $method = "post", $action = 0, $options = 0) {
860
  if (!$action) {
861
    $action = request_uri();
862
  }
863
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
Dries committed
864 865
}

866 867
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
Dries committed
868
}
869

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

874
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
875
  return theme("form_element", NULL, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
876 877 878 879 880
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
881
      $choices .= "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice<br />";
882
    }
883
    return theme("form_element", $title, $choices, $description);
884
  }
885 886
}

887
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
888
  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
889 890
}

891
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
892
  $size = $size ? " size=\"$size\"" : "";
893
  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
894 895
}

896
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
897
  $size = $size ? " size=\"$size\"" : "";
898
  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
899 900
}

901
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
902
  $cols = $cols ? " cols=\"$cols\"" : "";
903
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
904
  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
905 906
}

907
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
908 909
  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>";
910
  }
911
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name);
912 913
}

914 915
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
916 917 918 919 920 921
}

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

922
function form_button($value, $name = "op", $type = "submit", $attributes = NULL) {
923 924 925
  return "<input type=\"$type\" class=\"form-$type\" name=\"$name\" value=\"". check_form($value) ."\" ". drupal_attributes($attributes) ." />\n";
}

926
function form_submit($value, $name = "op", $attributes = NULL) {
927
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
Dries committed
928 929
}

930
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
Dries committed
931
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
Dries committed
932 933 934 935 936
    $weights[$n] = $n;
  }

  return form_select($title, $name, $value, $weights, $description, $extra);
}
937
/* @} */
938

939 940 941
/**
 * Given an old url, return the alias.
 */
942
function drupal_get_path_alias($path) {
943 944 945 946 947 948
  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');
  }
949 950 951
}

/**
952
 * Given an alias, return the default url.
953
 */
954
function drupal_get_normal_path($path) {
955 956 957 958 959 960 961 962 963
  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;
  }
964 965
}

966
function url($url = NULL, $query = NULL, $fragment = NULL) {
967
  global $base_url;
Dries's avatar
Dries committed
968

969 970 971 972 973 974 975 976 977 978 979
  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" : "";
  }

980
  if ($alias = drupal_get_path_alias($url)) {
981 982 983
    $url = $alias;
  }

984 985 986 987
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

988
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
Dries committed
989 990
    if (isset($url)) {
      if (isset($query)) {
991
        return "$base_url/$script?q=$url&amp;$query$fragment";
Dries's avatar
Dries committed
992 993
      }
      else {
994
        return "$base_url/$script?q=$url$fragment";
Dries's avatar
Dries committed
995
      }
996 997
    }
    else {
Dries's avatar
Dries committed
998
      if (isset($query)) {
999
        return "$base_url/$script?$query$fragment";
Dries's avatar
Dries committed
1000 1001
      }
      else {
1002
        return "$base_url/$fragment";
Dries's avatar
Dries committed
1003
      }
1004 1005 1006
    }
  }
  else {
Dries's avatar
Dries committed
1007 1008
    if (isset($url)) {
      if (isset($query)) {
1009
        return "$base_url/$url?$query$fragment";
Dries's avatar
Dries committed
1010 1011
      }
      else {
1012
        return "$base_url/$url$fragment";
Dries's avatar
Dries committed
1013
      }
1014
    }
1015
    else {
Dries's avatar
Dries committed
1016
      if (isset($query)) {
1017
        return "$base_url/$script?$query$fragment";
Dries's avatar
Dries committed
1018 1019
      }
      else {
1020
        return "$base_url/$fragment";
Dries's avatar
Dries committed
1021
      }
1022
    }
1023
  }
1024 1025
}

1026
function drupal_attributes($attributes = NULL) {
1027 1028 1029 1030 1031 1032
  if (is_array($attributes)) {
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
    return " ". implode($t, " ");
Dries's avatar
Dries committed
1033
  }
1034
}
Dries's avatar
Dries committed
1035

1036
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL) {
1037 1038 1039 1040 1041 1042 1043 1044 1045
  if ($url == $_GET['q']) {
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
  return "<a href=\"". url($url, $query, $fragment) ."\"". drupal_attributes($attributes) .">$text</a>";
1046 1047
}

Dries's avatar
Dries committed
1048
function field_get($string, $name) {
1049
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries's avatar
Dries committed
1050 1051 1052 1053 1054
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
1055
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
1056 1057
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
Dries committed
1058 1059 1060 1061
  return substr($rval, 1);
}

function link_page() {
1062
  global $custom_links;
1063

1064
  if (is_array($custom_links)) {
1065 1066 1067
    return $custom_links;
  }
  else {
1068
    $links = module_invoke_all("link", "page");
1069
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
1070
    return $links;
Dries's avatar
Dries committed
1071
  }
1072
}
Dries's avatar
Dries committed
1073 1074

function link_node($node, $main = 0) {
1075
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
Dries committed
1076 1077
}

1078
function drupal_page_footer() {
Dries's avatar
Dries committed
1079
  if (variable_get("cache", 0)) {
1080
    page_set_cache();
Dries's avatar
Dries committed
1081
  }
1082

1083 1084 1085 1086 1087
  /*
  ** A hook for modules where modules may take action at the end of a
  ** request good uses include setting a cache, page logging, etc.
  */

1088
  module_invoke_all("exit");
Dries's avatar
Dries committed
1089 1090
}

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
/**
 * 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
1119
include_once "includes/theme.inc";
Dries's avatar
Dries committed
1120
include_once "includes/pager.inc";
1121
include_once "includes/menu.inc";
1122
include_once "includes/xmlrpc.inc";
1123
include_once "includes/tablesort.inc";
1124
include_once "includes/file.inc";
1125

1126 1127 1128
// set error handler:
set_error_handler("error_handler");

1129
// spit out the correct charset http header
1130
header("Content-Type: text/html; charset=utf-8");
1131

1132 1133
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
1134
  $_GET["q"] = drupal_get_normal_path(trim($_GET["q"], "/"));
1135 1136
}
else {
1137
  $_GET["q"] = drupal_get_normal_path(variable_get("site_frontpage", "node"));
1138 1139
}

1140 1141 1142
// initialize installed modules:
module_init();

1143
if ($_REQUEST && !user_access("bypass input data check")) {
1144 1145 1146 1147 1148
  if (!valid_input_data($_REQUEST)) {
    die("terminated request because of suspicious input data");
  }
}

Dries's avatar
Dries committed
1149 1150 1151 1152
// initialize localization system:
$locale = locale_init();

// initialize theme:
1153
$theme = init_theme();
1154

1155
?>