common.inc 32.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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
/**
 * @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;

Dries's avatar
 
Dries committed
110
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
111
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
112
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
113 114 115 116 117 118 119
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

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

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

Dries's avatar
 
Dries committed
129 130 131 132
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

Dries's avatar
 
Dries committed
144 145 146
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
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();
}
/* @} */

Kjartan's avatar
Kjartan committed
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 &
  */
Dries's avatar
 
Dries committed
192

Kjartan's avatar
Kjartan committed
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.
 */
Dries's avatar
 
Dries committed
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");
Dries's avatar
 
Dries committed
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>');
  }
}
Dries's avatar
 
Dries committed
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)
Dries's avatar
 
Dries committed
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;
}
Kjartan's avatar
Kjartan committed
364
/* @} */
Dries's avatar
 
Dries committed
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.";
Dries's avatar
 
Dries committed
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);
Dries's avatar
 
Dries committed
393 394 395
  }
}

Dries's avatar
 
Dries committed
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;
  }
Dries's avatar
 
Dries committed
405 406
}

Kjartan's avatar
Kjartan committed
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;
}
Kjartan's avatar
Kjartan committed
439
/* @} */
Dries's avatar
 
Dries committed
440

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

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

Kjartan's avatar
Kjartan committed
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:
Kjartan's avatar
Kjartan committed
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.
Kjartan's avatar
Kjartan committed
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.
 */
Dries's avatar
 
Dries committed
493
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
494
  global $languages;
495

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

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

Dries's avatar
 
Dries committed
506
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
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);
Dries's avatar
 
Dries committed
516 517
}

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

525
/**
Dries's avatar
 
Dries committed
526 527
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
528
 *
Kjartan's avatar
Kjartan committed
529
 * @param $mail A string containing an email address.
Dries's avatar
 
Dries committed
530
 * @return
531
 */
Dries's avatar
 
Dries committed
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
}

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

Kjartan's avatar
Kjartan committed
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)) {
Kjartan's avatar
Kjartan committed
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:
 *
Dries's avatar
 
Dries committed
595
 * @param $item a single search result as returned by <i>module</i>_search of
596
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
 
Dries committed
597 598
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
599
 */
Dries's avatar
 
Dries committed
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 />";
Dries's avatar
 
Dries committed
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 />";
  }
Dries's avatar
 
Dries committed
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
Dries's avatar
 
Dries committed
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
 *
Dries's avatar
 
Dries committed
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
 */
Dries's avatar
 
Dries committed
632
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
633 634
  $edit = $_POST['edit'];

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

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

Dries's avatar
Dries committed
642
  if ($options) {
Dries's avatar
 
Dries committed
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);
Dries's avatar
 
Dries committed
649 650 651 652
      }
    }
  }

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

Dries's avatar
 
Dries committed
655 656 657 658
  return form($output, "post", $action);
}

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

Dries's avatar
 
Dries committed
664
  if (isset($keys)) {
Dries's avatar
 
Dries committed
665
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
666 667 668 669 670 671 672
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
Dries's avatar
 
Dries committed
673 674 675 676 677 678 679 680
        }
      }
    }
  }

  return $output;
}

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

Dries's avatar
 
Dries committed
694
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
695
}
Kjartan's avatar
Kjartan committed
696
/* @} */
Dries's avatar
 
Dries committed
697

Dries's avatar
 
Dries committed
698
function check_form($text) {
Dries's avatar
 
Dries committed
699
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
700 701
}

702 703
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
704 705
}

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

  return $output;
}

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

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

  return $output;
}

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

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

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

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

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

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

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
792
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
 
Dries committed
793 794
      break;
    case "large":
Dries's avatar
 
Dries committed
795
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
 
Dries committed
796 797
      break;
    case "custom":
Dries's avatar
 
Dries committed
798
      // No change to format
Dries's avatar
 
Dries committed
799
      break;
Dries's avatar
 
Dries committed
800
    case "medium":
Dries's avatar
 
Dries committed
801
    default:
Dries's avatar
 
Dries committed
802 803 804 805
      $format = variable_get("date_format_medium", "D, m/d/Y - H:i");
  }

  for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
Dries's avatar
 
Dries committed
806
    if (strstr("AaDFlM", $c)) {
Dries's avatar
 
Dries committed
807 808
      $date = t(date($c, $timestamp)) . $date;
    }
Dries's avatar
 
Dries committed
809
    else if (strstr("BdgGhHiIjLmnOrsStTUwWYyZz", $c)) {
Dries's avatar
 
Dries committed
810 811 812 813 814
      $date = date($c, $timestamp) . $date;
    }
    else {
      $date = $c.$date;
    }
Dries's avatar
 
Dries committed
815 816 817 818 819 820 821
  }
  return $date;
}

function format_name($object) {

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

Dries's avatar
 
Dries committed
855
  return $output;
Dries's avatar
 
Dries committed
856 857
}

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

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

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

Dries's avatar
 
Dries committed
877
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
878
  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
879 880 881 882 883
}

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

Dries's avatar
 
Dries committed
890
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
891
  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
892 893
}

Dries's avatar
 
Dries committed
894
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
895
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
896
  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
897 898
}

Dries's avatar
 
Dries committed
899
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
900
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
901
  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
902 903
}

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

Dries's avatar
 
Dries committed
910
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
911 912
  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
913
  }
Dries's avatar
 
Dries committed
914
  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
915 916
}

Dries's avatar
 
Dries committed
917 918
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
919 920 921 922 923 924
}

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

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

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

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

  return form_select($title, $name, $value, $weights, $description, $extra);
}
Kjartan's avatar
Kjartan committed
940
/* @} */
Dries's avatar
 
Dries committed
941

Dries's avatar
 
Dries committed
942 943 944
/**
 * Given an old url, return the alias.
 */
Dries's avatar
 
Dries committed
945
function drupal_get_path_alias($path) {
Dries's avatar
 
Dries committed
946 947 948 949 950 951
  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
952 953 954
}

/**
Dries's avatar
 
Dries committed
955
 * Given an alias, return the default url.
Dries's avatar
 
Dries committed
956
 */
Dries's avatar
 
Dries committed
957
function drupal_get_normal_path($path) {
Dries's avatar
 
Dries committed
958 959 960 961 962 963 964 965 966
  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
967 968
}

Dries's avatar
 
Dries committed
969
function url($url = NULL, $query = NULL, $fragment = NULL) {
Dries's avatar
 
Dries committed
970
  global $base_url;
Dries's avatar
 
Dries committed
971

Dries's avatar
 
Dries committed
972 973 974 975 976 977 978 979 980 981 982
  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
983
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
984 985 986
    $url = $alias;
  }

Dries's avatar
 
Dries committed
987 988 989 990
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

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

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

Dries's avatar
 
Dries committed
1039
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL) {
Dries's avatar
 
Dries committed
1040 1041 1042 1043 1044 1045 1046 1047 1048
  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>";
Dries's avatar
 
Dries committed
1049 1050
}

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

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

function link_page() {
1065
  global $custom_links;
Dries's avatar
 
Dries committed
1066

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

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
1078
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
1079 1080
}

Dries's avatar
 
Dries committed
1081
function drupal_page_footer() {
Dries's avatar
 
Dries committed
1082
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
1083
    page_set_cache();
Dries's avatar
 
Dries committed
1084
  }
Dries's avatar
 
Dries committed
1085

Dries's avatar
 
Dries committed
1086 1087 1088 1089 1090
  /*
  ** 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
1091
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
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 1119 1120 1121
/**
 * 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
1122
include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
1123
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
1124
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
1125
include_once "includes/xmlrpc.inc";