common.inc 27.1 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

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

99 100 101 102
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

113 114 115
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
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 &
  */
139

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.
 */
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");
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>');
  }
}
190
/* @} */
191

Dries's avatar
Dries committed
192 193 194
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.";
195 196

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
Dries committed
197
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
198 199 200
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
Dries committed
201 202 203 204 205
  }
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Kjartan's avatar
Kjartan committed
206 207
    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
208 209 210 211 212
      die(message_throttle());
    }
  }
}

Dries's avatar
Dries committed
213 214
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
215 216 217
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
218
    $item = stripslashes($item);
219 220 221
  }
}

222 223
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
224
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
225 226 227 228 229 230
    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;
  }
231 232
}

233 234 235 236 237 238 239
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
240 241 242
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
Dries committed
243 244 245 246
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
247
    $object = $array;
Dries's avatar
Dries committed
248 249 250 251 252
  }

  return $object;
}

Dries's avatar
Dries committed
253 254 255
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
Dries committed
256 257 258 259
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
260
    $array = $object;
Dries's avatar
Dries committed
261 262 263 264
  }

  return $array;
}
265
/* @} */
Dries's avatar
Dries committed
266

267 268 269 270 271 272 273
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
Dries committed
274
function message_access() {
Dries's avatar
Dries committed
275
  return t("You are not authorized to access this page.");
Dries's avatar
Dries committed
276 277 278 279 280 281 282 283 284
}

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

287 288
function locale_init() {
  global $languages, $user;
289 290 291 292 293 294
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
295 296
}

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
 * We try to keep strings whole as much as possible and are unafraid of HTML
 * markup within translation strings if necessary. The suggested syntax for
 * a link embedded within a translation string is for example:
 * @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
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
315
function t($string, $args = 0) {
316
  global $languages;
317

318
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
319

320 321
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
322 323
  }
  else {
324 325
    return strtr($string, $args);
  }
326 327
}

328
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
329 330 331 332 333 334 335 336 337

  /*
  ** 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);
338 339
}

340 341 342 343 344 345 346
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
 */

347
/**
348 349
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
350
 *
351 352
 * @param $mail A string containing an email address.
 * @return 
353
 */
354
function valid_email_address($mail) {
355 356 357 358 359
  $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
360
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
361 362
}

363 364 365
/**
 * Verify the syntax of the given URL.
 *
366
 * @param $url an URL
367 368
 */
function valid_url($url) {
Dries's avatar
Dries committed
369
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
370 371
}

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
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
414 415 416
/**
 * Format a single result entry of a search query:
 *
417
 * @param $item a single search result as returned by <i>module</i>_search of
418
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
419 420
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
421
 */
422
function search_item($item, $type) {
Dries's avatar
Dries committed
423 424 425 426 427 428 429 430 431 432

  /*
  ** 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 {
433
    $output = " <strong><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></strong><br />";
434
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
Dries committed
435 436
    $output .= "<br /><br />";
  }
437 438 439 440

  return $output;
}

Kjartan's avatar
Kjartan committed
441 442 443 444
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
445 446 447
 * '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
448
 *
449 450 451 452
 * @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
453
 */
454
function search_form($action = NULL, $keys = NULL, $options = NULL) {
455 456
  $edit = $_POST['edit'];

457
  if (!$action) {
Dries's avatar
Dries committed
458
    $action = url("search");
459 460
  }

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

Dries's avatar
Dries committed
464
  if ($options) {
465 466 467 468 469
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
470
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
471 472 473 474
      }
    }
  }

Kjartan's avatar
Kjartan committed
475 476
  $form .= "<br />";

477 478 479 480
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
481 482
 * Collect the search results:
 */
483
function search_data($keys = NULL) {
484
  $edit = $_POST["edit"];
485

486
  if (isset($keys)) {
487
    foreach (module_list() as $name) {
488
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan's avatar
Kjartan committed
489
        if ($name == "node" || $name == "comment") {
490
          $output .= "<p><strong>". t("Matching %names ranked in order of relevance:", array("%name" => $name)) ."</strong></p>";
Kjartan's avatar
Kjartan committed
491 492
        }
        else {
493
          $output .= "<p><strong>". t("Matching {$name}s") .":</strong></p>";
Kjartan's avatar
Kjartan committed
494
        }
495 496 497 498 499 500 501 502 503 504
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
505 506 507
/**
 * Display the search form and the resulting data.
 *
508 509 510 511 512 513
 * @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
514
 */
515 516
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
517

518
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
519
}
520
/* @} */
521

Dries's avatar
Dries committed
522
function check_form($text) {
523
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
Dries committed
524 525
}

526 527
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
528 529
}

Dries's avatar
Dries committed
530 531 532
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
533
  $output = "<channel>\n";
534 535 536 537
  $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
538
  foreach ($args as $key => $value) {
Dries's avatar
Dries committed
539
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
Dries committed
540
  }
Dries's avatar
Dries committed
541 542 543 544 545 546
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
550
  $output = "<item>\n";
551 552 553
  $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
554
  foreach ($args as $key => $value) {
555
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
Dries committed
556
  }
Dries's avatar
Dries committed
557 558 559 560 561
  $output .= "</item>\n";

  return $output;
}

562 563
/**
 * Formats a string with a count of items so that the string is pluralized
564 565
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
566
 *
567 568 569 570
 * @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").
571
 * @param $plural The string for the plural case. Please make sure it's clear
572 573
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
574
 */
Dries's avatar
Dries committed
575
function format_plural($count, $singular, $plural) {
576
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
Dries committed
577 578 579
}

function format_size($size) {
580
  $suffix = t("bytes");
Dries's avatar
Dries committed
581 582
  if ($size > 1024) {
    $size = round($size / 1024, 2);
583
    $suffix = t("KB");
Dries's avatar
Dries committed
584 585 586
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
587
    $suffix = t("MB");
Dries's avatar
Dries committed
588
  }
589
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
Dries committed
590 591 592
}

function format_interval($timestamp) {
593
  $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);
594
  foreach ($units as $key => $value) {
Dries's avatar
Dries committed
595 596 597 598 599 600
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
601
  return ($output) ? $output : t("0 sec");
Dries's avatar
Dries committed
602 603 604 605 606
}

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

Kjartan's avatar
Kjartan committed
607
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
Dries committed
608 609 610

  switch ($type) {
    case "small":
611
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
Dries committed
612 613
      break;
    case "large":
614
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
Dries committed
615 616
      break;
    case "custom":
617
      // No change to format
Dries's avatar
Dries committed
618
      break;
619
    case "medium":
Dries's avatar
Dries committed
620
    default:
621 622 623 624 625 626 627 628 629 630 631 632 633
      $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
634 635 636 637 638 639 640
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
641 642 643 644 645 646 647 648 649 650 651 652
    /*
    ** 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;
    }

653
    if (arg(0) == "admin") {
654
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
655 656
    }
    else {
657
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
658
    }
Dries's avatar
Dries committed
659
  }
660 661 662 663 664 665 666 667 668 669
  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
670
  else {
671
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
Dries committed
672 673
  }

674
  return $output;
Dries's avatar
Dries committed
675 676
}

677 678 679 680
/**
 * @defgroup from Form generation
 * @{
 */
Dries's avatar
Dries committed
681
function form($form, $method = "post", $action = 0, $options = 0) {
682
  if (!$action) {
683
    $action = request_uri();
684
  }
685
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
Dries committed
686 687
}

688 689
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
Dries committed
690
}
691

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

696
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
697
  return theme("form_element", NULL, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
698 699 700 701 702
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
703
      $choices .= "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice<br />";
704
    }
705
    return theme("form_element", $title, $choices, $description);
706
  }
707 708
}

709
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
710
  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
711 712
}

713
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
714
  $size = $size ? " size=\"$size\"" : "";
715
  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
716 717
}

718
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
719
  $size = $size ? " size=\"$size\"" : "";
720
  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
721 722
}

723
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
724
  $cols = $cols ? " cols=\"$cols\"" : "";
725
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
726
  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
727 728
}

729
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
730 731
  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>";
732
  }
733
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name);
734 735
}

736 737
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
738 739 740 741 742 743
}

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

744
function form_button($value, $name = "op", $type = "submit", $attributes = NULL) {
745 746 747
  return "<input type=\"$type\" class=\"form-$type\" name=\"$name\" value=\"". check_form($value) ."\" ". drupal_attributes($attributes) ." />\n";
}

748
function form_submit($value, $name = "op", $attributes = NULL) {
749
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
Dries committed
750 751
}

752
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
Dries committed
753
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
Dries committed
754 755 756 757 758 759
    $weights[$n] = $n;
  }

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

760 761 762
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}
763
/* @} */
764

765 766 767
/**
 * Given an old url, return the alias.
 */
768
function drupal_get_path_alias($path) {
769 770 771 772 773 774 775 776
  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');
  }
  else {
    return $path;
Dries's avatar
Dries committed
777
  }
778 779 780
}

/**
781
 * Given an alias, return the default url.
782
 */
783
function drupal_get_normal_path($path) {
784 785 786 787 788 789 790 791 792
  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;
  }
793 794
}

795
function url($url = NULL, $query = NULL, $fragment = NULL) {
Dries's avatar
Dries committed
796
  global $base_url;
797

798 799 800 801 802 803 804 805 806 807 808
  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" : "";
  }

809
  if ($alias = drupal_get_path_alias($url)) {
810 811 812
    $url = $alias;
  }

813 814 815 816
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

817
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
Dries committed
818 819
    if (isset($url)) {
      if (isset($query)) {
820
        return "$base_url/$script?q=$url&amp;$query$fragment";
Dries's avatar
Dries committed
821 822
      }
      else {
823
        return "$base_url/$script?q=$url$fragment";
Dries's avatar
Dries committed
824
      }
825 826
    }
    else {
Dries's avatar
Dries committed
827
      if (isset($query)) {
828
        return "$base_url/$script?$query$fragment";
Dries's avatar
Dries committed
829 830
      }
      else {
831
        return "$base_url/$fragment";
Dries's avatar
Dries committed
832
      }
833 834 835
    }
  }
  else {
Dries's avatar
Dries committed
836 837
    if (isset($url)) {
      if (isset($query)) {
838
        return "$base_url/$url?$query$fragment";
Dries's avatar
Dries committed
839 840
      }
      else {
841
        return "$base_url/$url$fragment";
Dries's avatar
Dries committed
842
      }
843
    }
844
    else {
Dries's avatar
Dries committed
845
      if (isset($query)) {
846
        return "$base_url/$script?$query$fragment";
Dries's avatar
Dries committed
847 848
      }
      else {
849
        return "$base_url/$fragment";
Dries's avatar
Dries committed
850
      }
851
    }
852
  }
853 854
}

855
function drupal_attributes($attributes = NULL) {
856 857 858 859 860 861
  if (is_array($attributes)) {
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
    return " ". implode($t, " ");
Dries's avatar
Dries committed
862
  }
863
}
Dries's avatar
Dries committed
864

865 866
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL) {
  return "<a href=\"". url($url, $query, $fragment) ."\"". drupal_attributes($attributes) .">$text</a>";
867 868
}

Dries's avatar
Dries committed
869
function field_get($string, $name) {
870
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
Dries committed
871 872 873 874 875
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
876
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
877 878
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
Dries committed
879 880 881 882
  return substr($rval, 1);
}

function link_page() {
883
  global $custom_links;
884

885
  if (is_array($custom_links)) {
886 887 888
    return $custom_links;
  }
  else {
889
    $links = module_invoke_all("link", "page");
890
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
891
    return $links;
Dries's avatar
Dries committed
892
  }
893
}
Dries's avatar
Dries committed
894 895

function link_node($node, $main = 0) {
896
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
Dries committed
897 898
}

899
function drupal_page_footer() {
Dries's avatar
Dries committed
900
  if (variable_get("cache", 0)) {
901
    page_set_cache();
Dries's avatar
Dries committed
902
  }
903

904 905 906 907 908
  /*
  ** A hook for modules where modules may take action at the end of a
  ** request good uses include setting a cache, page logging, etc.
  */

909
  module_invoke_all("exit");
Dries's avatar
Dries committed
910 911
}

912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
/**
 * 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
940
include_once "includes/theme.inc";
Dries's avatar
Dries committed
941
include_once "includes/pager.inc";
942
include_once "includes/menu.inc";
943
include_once "includes/xmlrpc.inc";
944
include_once "includes/tablesort.inc";
945
include_once "includes/file.inc";
946

947 948 949
// set error handler:
set_error_handler("error_handler");

950
// spit out the correct charset http header
951
header("Content-Type: text/html; charset=utf-8");
952

953 954
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
955
  $_GET["q"] = drupal_get_normal_path(trim($_GET["q"], "/"));
956 957
}
else {
958
  $_GET["q"] = drupal_get_normal_path(variable_get("site_frontpage", "node"));
959 960
}

961 962 963
// initialize installed modules:
module_init();

964
if ($_REQUEST && !user_access("bypass input data check")) {
965 966 967 968 969
  if (!valid_input_data($_REQUEST)) {
    die("terminated request because of suspicious input data");
  }
}

Dries's avatar
Dries committed
970 971 972 973
// initialize localization system:
$locale = locale_init();

// initialize theme:
974
$theme = init_theme();
975

976
?>