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

Dries's avatar
 
Dries committed
4
/**
Dries's avatar
 
Dries committed
5 6 7 8 9
 * @name drupal_title
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries's avatar
 
Dries committed
10 11 12 13
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
 
Dries committed
14
    $stored_title = ucfirst($title);
Dries's avatar
 
Dries committed
15 16 17 18 19 20 21 22 23 24 25 26 27
  }
  return $stored_title;
}

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

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

  return $title;
}
28
// @}
Dries's avatar
 
Dries committed
29

Dries's avatar
 
Dries committed
30
/**
Dries's avatar
 
Dries committed
31 32 33 34 35
 * @name drupal_message
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries's avatar
 
Dries committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
function drupal_set_message($message = NULL, $type = "status") {
  static $stored_message;

  if (isset($message)) {
    $stored_message->message = $message;
    $stored_message->type = $type;
  }

  return $stored_message;
}

function drupal_get_message() {
  return drupal_set_message();
}
// @}

Dries's avatar
 
Dries committed
52
/**
Dries's avatar
 
Dries committed
53 54 55 56 57 58 59 60
 * @name drupal_breadcrumb
 *
 * Functions to get and set the breadcrumb trail of the current page.
 *
 * @param $breadcrumb array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 * @{
 */
Dries's avatar
 
Dries committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
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;
}
80
// @}
Dries's avatar
 
Dries committed
81

Dries's avatar
 
Dries committed
82
/**
Dries's avatar
 
Dries committed
83 84
 * Build the alias/path array
 */
Dries's avatar
 
Dries committed
85
function drupal_get_path_map($action = "") {
Dries's avatar
 
Dries committed
86 87

  static $cache;
Dries's avatar
 
Dries committed
88 89
  static $map;

Dries's avatar
 
Dries committed
90 91
  if ($action == "rebuild") {
    $map = NULL;
Dries's avatar
 
Dries committed
92
    $cache = 0;
Dries's avatar
 
Dries committed
93 94
  }

Dries's avatar
 
Dries committed
95
  if (!$cache) {
Dries's avatar
 
Dries committed
96
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
 
Dries committed
97
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
98
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
99
    }
Dries's avatar
 
Dries committed
100 101

    $cache = 1;
Dries's avatar
 
Dries committed
102 103 104 105 106
  }

  return $map;
}

Dries's avatar
 
Dries committed
107 108 109 110
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries's avatar
 
Dries committed
111 112 113
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
114 115

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
 
Dries committed
116
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
117
    print "<pre>$entry</pre>";
Dries's avatar
 
Dries committed
118 119 120
  }
}

Dries's avatar
 
Dries committed
121
function watchdog($type, $message, $link = NULL) {
Dries's avatar
 
Dries committed
122
  global $user;
Dries's avatar
 
Dries committed
123
  db_query("INSERT INTO {watchdog} (uid, type, message, link, location, hostname, timestamp) VALUES (%d, '%s', '%s', '%s', '%s', '%s', %d)", $user->uid, $type, $message, $link, request_uri(), getenv("REMOTE_ADDR"), time());
Dries's avatar
 
Dries committed
124 125 126 127
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries's avatar
 
Dries committed
128
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '$type' AND hostname = '". getenv("REMOTE_ADDR") ."' AND ". time() ." - timestamp < $rate"))) {
Dries's avatar
 
Dries committed
129 130 131 132 133 134
      watchdog("warning", "throttle: '". getenv("REMOTE_ADDR") ."' exceeded submission rate - $throttle->type");
      die(message_throttle());
    }
  }
}

Dries's avatar
 
Dries committed
135 136 137 138
function _fix_gpc_magic_array(&$items) {
  foreach ($items as $k => $i) {
    if (is_array($i)) _fix_gpc_magic_array($items[$k]);
    else $items[$k] = stripslashes($i);
Dries's avatar
 
Dries committed
139 140 141
  }
}

Dries's avatar
 
Dries committed
142 143 144 145 146 147 148 149 150 151 152 153
function fix_gpc_magic() {
  static $fixed = false;
  if ($fixed) return;
  if (ini_get("magic_quotes_gpc") == 0) return;

  _fix_gpc_magic_array($_GET);
  _fix_gpc_magic_array($_POST);
  _fix_gpc_magic_array($_COOKIE);

  $fixed = true;
}

Dries's avatar
 
Dries committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
function array2object($node) {

  if (is_array($node)) {
    foreach ($node as $key => $value) {
      $object->$key = $value;
    }
  }
  else {
    $object = $node;
  }

  return $object;
}

function object2array($node) {

  if (is_object($node)) {
    foreach ($node as $key => $value) {
      $array[$key] = $value;
    }
  }
  else {
    $array = $node;
  }

  return $array;
}

Dries's avatar
 
Dries committed
182
function message_access() {
Dries's avatar
 
Dries committed
183
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
184 185 186 187 188 189 190 191 192 193
}

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.");
}

Dries's avatar
 
Dries committed
194 195
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
196 197 198 199 200 201
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
202 203
}

Dries's avatar
 
Dries committed
204
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
205
  global $languages;
206

Dries's avatar
 
Dries committed
207 208 209 210 211 212 213
  /*
  ** About the usage of t().  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:
  **
  ** $msg = t("You must login below or <a href=\"%url\">create a new
Dries's avatar
 
Dries committed
214 215
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
 
Dries committed
216 217
  */

218
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
219

Dries's avatar
 
Dries committed
220 221
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
222 223
  }
  else {
Dries's avatar
 
Dries committed
224 225
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
226 227
}

Dries's avatar
 
Dries committed
228
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
229 230 231 232 233 234 235 236 237

  /*
  ** 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
238 239
}

240
/**
Dries's avatar
 
Dries committed
241 242
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
243
 *
Dries's avatar
 
Dries committed
244
 * @param $mail a email address
245
 */
Dries's avatar
 
Dries committed
246
function valid_email_address($mail) {
247 248 249 250 251 252 253 254 255 256 257 258 259
  $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}';

  if (preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail)) {
    return 1;
  }
  else {
    return 0;
  }
}

Dries's avatar
 
Dries committed
260 261 262
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
263
 * @param $url an URL
Dries's avatar
 
Dries committed
264 265 266
 */
function valid_url($url) {

Dries's avatar
 
Dries committed
267
  if (preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url)) {
Dries's avatar
 
Dries committed
268 269 270 271 272 273 274
    return 1;
  }
  else {
    return 0;
  }
}

Kjartan's avatar
Kjartan committed
275 276 277
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
 
Dries committed
278
 * @param $item a single search result as returned by <i>module</i>_search of
279
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
 
Dries committed
280 281
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
282
 */
Dries's avatar
 
Dries committed
283
function search_item($item, $type) {
Dries's avatar
 
Dries committed
284 285 286 287 288 289 290 291 292 293

  /*
  ** 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 {
Dries's avatar
 
Dries committed
294
    $output .= " <b><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
Dries's avatar
 
Dries committed
295
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
 
Dries committed
296 297
    $output .= "<br /><br />";
  }
Dries's avatar
 
Dries committed
298 299 300 301

  return $output;
}

Kjartan's avatar
Kjartan committed
302 303 304 305
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
306 307 308
 * '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
309
 *
Dries's avatar
 
Dries committed
310 311 312 313
 * @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
314
 */
Dries's avatar
 
Dries committed
315
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
316 317

  if (!$action) {
Dries's avatar
 
Dries committed
318
    $action = url("search");
Dries's avatar
 
Dries committed
319 320
  }

Dries's avatar
 
Dries committed
321 322
  $output .= " <br /><input type=\"text\" class=\"form-text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries's avatar
 
Dries committed
323 324 325 326 327 328 329

  if ($options != 0) {
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
330
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
331 332 333 334
      }
    }
  }

Kjartan's avatar
Kjartan committed
335 336
  $form .= "<br />";

Dries's avatar
 
Dries committed
337 338 339 340
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
341 342
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
343
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
344 345

  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
346

Dries's avatar
 
Dries committed
347
  if (isset($keys)) {
Dries's avatar
 
Dries committed
348
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
349
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan's avatar
Kjartan committed
350
        if ($name == "node" || $name == "comment") {
Dries's avatar
 
Dries committed
351
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
352 353
        }
        else {
Dries's avatar
 
Dries committed
354
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
355
        }
Dries's avatar
 
Dries committed
356 357 358 359 360 361 362 363 364 365
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
366 367 368
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
369 370 371 372 373 374
 * @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
375
 */
Dries's avatar
 
Dries committed
376
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
377

Dries's avatar
 
Dries committed
378
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
 
Dries committed
379

Dries's avatar
 
Dries committed
380
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
381 382
}

Dries's avatar
 
Dries committed
383

Dries's avatar
 
Dries committed
384 385
function drupal_goto($url) {

Dries's avatar
 
Dries committed
386 387 388
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
 
Dries committed
389

Dries's avatar
 
Dries committed
390
  $url = str_replace("&amp;", "&", $url);
Dries's avatar
 
Dries committed
391

Dries's avatar
 
Dries committed
392 393 394 395 396
  /*
  ** 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".
  */
Dries's avatar
 
Dries committed
397
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
 
Dries committed
398 399 400
    header("Location: $url");
  }
  else {
Dries's avatar
 
Dries committed
401 402 403 404 405 406 407 408
    $sid = session_name() . "=" . session_id();

    if (strstr($url, "?") && !strstr($url, $sid)) {
      header("Location: $url&". $sid);
    }
    else {
      header("Location: $url?". $sid);
    }
Dries's avatar
 
Dries committed
409 410 411 412
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries's avatar
 
Dries committed
413
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries's avatar
 
Dries committed
414 415 416 417 418 419
  ** of the code /below/ gets executed when we redirect.
  */

  exit();
}

Dries's avatar
 
Dries committed
420
function valid_input_data($data) {
421

422
  if (is_array($data) || is_object($data)) {
423 424 425 426 427
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
428 429 430
      if (!valid_input_data($value)) {
        return 0;
      }
431 432 433 434 435 436 437
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
438
    // check strings:
Dries's avatar
Dries committed
439
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
440 441 442
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

446 447

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries's avatar
 
Dries committed
452
      return 0;
453 454
    }
  }
Dries's avatar
 
Dries committed
455 456

  return 1;
457
}
Dries's avatar
 
Dries committed
458

Dries's avatar
 
Dries committed
459
function check_form($text) {
Dries's avatar
 
Dries committed
460
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
461 462 463
}

function filter($text) {
Dries's avatar
 
Dries committed
464

Dries's avatar
 
Dries committed
465 466 467 468 469 470 471 472 473 474 475 476 477
  $modules = module_list();

  /*
  ** Make sure the HTML filters that are part of the node module
  ** are run first.
  */

  if (in_array("node", $modules)) {
    $text = module_invoke("node", "filter", $text);
  }

  foreach ($modules as $name) {
    if (module_hook($name, "filter") && $name != "node") {
Dries's avatar
 
Dries committed
478 479 480 481 482
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
 
Dries committed
483 484
}

Dries's avatar
 
Dries committed
485 486
function rewrite_old_urls($text) {

Dries's avatar
 
Dries committed
487 488 489 490
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
 
Dries committed
491 492 493
  /*
  ** This is a *temporary* filter to rewrite old-style URLs to new-style
  ** URLs (clean URLs).  Currently, URLs are being rewritten dynamically
Dries's avatar
 
Dries committed
494 495
  ** (ie. "on output"), however when these rewrite rules have been tested
  ** enough, we will use them to permanently rewrite the links in node
Dries's avatar
 
Dries committed
496 497 498
  ** and comment bodies.
  */

Dries's avatar
 
Dries committed
499
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
    /*
    ** Relative URLs:
    */

    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
    $text = eregi_replace("\"(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "\"?q=\\1/view/\\2/\\4", $text);

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"?q=\\2/\\4/\\6" , $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"?q=\\2/\\4", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"?q=\\2", $text);

    /*
    ** Absolute URLs:
    */

Dries's avatar
 
Dries committed
516
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
517
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
518

Dries's avatar
 
Dries committed
519
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
520 521 522
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/?q=\\2/\\4/\\6" , $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/?q=\\2/\\4", $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"$end/?q=\\2", $text);
Dries's avatar
 
Dries committed
523 524
  }
  else {
Dries's avatar
 
Dries committed
525 526 527 528
    /*
    ** Relative URLs:
    */

Dries's avatar
 
Dries committed
529
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
530
    $text = eregi_replace("\"(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "\"\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
531 532

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2/\\4/\\6", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2/\\4", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2", $text);

    /*
    ** Absolute URLs:
    */

    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/\\1/view/\\2/\\4", $text);

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/\\2/\\4/\\6", $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/\\2/\\4", $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/\\2", $text);
}
Dries's avatar
 
Dries committed
549

Dries's avatar
 
Dries committed
550 551 552
  return $text;
}

Dries's avatar
 
Dries committed
553
function check_output($text) {
Dries's avatar
 
Dries committed
554
  if (isset($text)) {
Dries's avatar
 
Dries committed
555 556 557 558
    // filter content on output:
    $text = filter($text);

    // get the line breaks right:
Dries's avatar
 
Dries committed
559
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
 
Dries committed
560 561 562 563 564 565 566 567
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
 
Dries committed
568 569
}

570

571 572
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
573 574
}

Dries's avatar
 
Dries committed
575 576 577
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
578
  $output .= "<channel>\n";
Dries's avatar
 
Dries committed
579 580 581 582
  $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
583
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
584
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
585
  }
Dries's avatar
 
Dries committed
586 587 588 589 590 591
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
 
Dries committed
595
  $output .= "<item>\n";
Dries's avatar
 
Dries committed
596 597 598
  $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
599
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
600
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
601
  }
Dries's avatar
 
Dries committed
602 603 604 605 606
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
607 608
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
609 610
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
611
 *
Dries's avatar
 
Dries committed
612 613 614 615 616 617 618
 * @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").
 * @param $plural The string for the plrual case. Please make sure it's clear
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
 
Dries committed
619
 */
Dries's avatar
 
Dries committed
620
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
621
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
622 623 624
}

function format_size($size) {
Dries's avatar
 
Dries committed
625
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
626 627
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
628
    $suffix = t("KB");
Dries's avatar
 
Dries committed
629 630 631
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
632
    $suffix = t("MB");
Dries's avatar
 
Dries committed
633
  }
Dries's avatar
 
Dries committed
634
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
635 636 637
}

function format_interval($timestamp) {
Dries's avatar
 
Dries committed
638
  $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);
Kjartan's avatar
Kjartan committed
639
  foreach ($units as $key=>$value) {
Dries's avatar
 
Dries committed
640 641 642 643 644 645
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
 
Dries committed
646
  return ($output) ? $output : t("0 sec");
Dries's avatar
 
Dries committed
647 648 649 650 651
}

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

Kjartan's avatar
Kjartan committed
652
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
 
Dries committed
653 654 655

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
656
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
 
Dries committed
657 658
      break;
    case "large":
Dries's avatar
 
Dries committed
659
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
 
Dries committed
660 661
      break;
    case "custom":
Dries's avatar
 
Dries committed
662
      // No change to format
Dries's avatar
 
Dries committed
663
      break;
Dries's avatar
 
Dries committed
664
    case "medium":
Dries's avatar
 
Dries committed
665
    default:
Dries's avatar
 
Dries committed
666 667 668 669 670 671 672 673 674 675 676 677 678
      $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
679 680 681 682 683 684 685
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
686 687 688 689 690 691 692 693 694 695 696 697
    /*
    ** 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
698
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
699
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
700 701
    }
    else {
Dries's avatar
Dries committed
702
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
703
    }
Dries's avatar
 
Dries committed
704
  }
Dries's avatar
 
Dries committed
705 706 707 708 709 710 711 712 713 714
  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
715
  else {
Dries's avatar
 
Dries committed
716
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
717 718
  }

Dries's avatar
 
Dries committed
719
  return $output;
Dries's avatar
 
Dries committed
720 721 722
}

function form($form, $method = "post", $action = 0, $options = 0) {
Dries's avatar
 
Dries committed
723 724

  if (!$action) {
725
    $action = request_uri();
Dries's avatar
 
Dries committed
726
  }
727
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
728 729 730
}

function form_item($title, $value, $description = 0) {
Dries's avatar
 
Dries committed
731
  return theme("form_element", $title, $value, $description);
Dries's avatar
 
Dries committed
732
}
Dries's avatar
 
Dries committed
733

Dries's avatar
 
Dries committed
734 735 736
function form_group($legend, $group, $description = 0) {
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries's avatar
 
Dries committed
737

738
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
739
  return theme("form_element", 0, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
 
Dries committed
740 741
}

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

746
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
747
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
748
  return theme("form_element", $title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries's avatar
 
Dries committed
749 750
}

751
function form_password($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
752
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
753
  return theme("form_element", $title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries's avatar
 
Dries committed
754 755
}

756
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
757
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
758
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
759
  return theme("form_element", $title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"edit[$name]\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description);
Dries's avatar
 
Dries committed
760 761
}

Dries's avatar
 
Dries committed
762
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
763
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
764
    foreach ($options as $key=>$choice) {
765
      $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
766
    }
Dries's avatar
 
Dries committed
767
    return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
 
Dries committed
768 769 770
  }
}

Dries's avatar
 
Dries committed
771 772 773 774 775
function form_radios($title, $name, $value, $options, $description = 0) {
  if (count($options) > 0) {
    foreach ($options as $key=>$choice) {
      $output .= form_radio($choice, $name, $key, ($key == $value));
    }
Dries's avatar
 
Dries committed
776
    return theme("form_element", $title, $output, $description);
Dries's avatar
 
Dries committed
777 778 779
  }
}

780
function form_file($title, $name, $size, $description = 0) {
Dries's avatar
 
Dries committed
781
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries's avatar
 
Dries committed
782 783 784 785 786 787
}

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

788
function form_submit($value, $name = "op", $attributes = 0) {
Dries's avatar
 
Dries committed
789
  return "<input type=\"submit\" class=\"form-submit\" name=\"$name\" value=\"". check_form($value) ."\" />\n";
Dries's avatar
 
Dries committed
790 791
}

Dries's avatar
 
Dries committed
792
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
 
Dries committed
793
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
794 795 796 797 798 799
    $weights[$n] = $n;
  }

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

Dries's avatar
 
Dries committed
800 801 802 803
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
 
Dries committed
804 805 806
/**
 * Given an old url, return the alias.
 */
Dries's avatar
 
Dries committed
807 808
function drupal_get_path_alias($path) {
  $map = drupal_get_path_map();
Dries's avatar
 
Dries committed
809

Dries's avatar
 
Dries committed
810 811 812
  if ($map) {
    return array_search($path, $map);
  }
Dries's avatar
 
Dries committed
813 814 815
}

/**
Dries's avatar
 
Dries committed
816
 * Given an alias, return the default url.
Dries's avatar
 
Dries committed
817
 */
Dries's avatar
 
Dries committed
818 819
function drupal_get_normal_path($path) {
  $map = drupal_get_path_map();
Dries's avatar
 
Dries committed
820 821 822
  return $map[$path];
}

Dries's avatar
 
Dries committed
823
function url($url = NULL, $query = NULL) {
Dries's avatar
 
Dries committed
824
  global $base_url;
Dries's avatar
 
Dries committed
825

Dries's avatar
 
Dries committed
826 827 828 829 830 831 832 833 834 835 836
  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
837
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
838 839 840
    $url = $alias;
  }

Dries's avatar
 
Dries committed
841
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
842 843
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
844
        return "$base_url/$script?q=$url&amp;$query";
Dries's avatar
 
Dries committed
845 846
      }
      else {
Dries's avatar
 
Dries committed
847
        return "$base_url/$script?q=$url";
Dries's avatar
 
Dries committed
848
      }
Dries's avatar
 
Dries committed
849 850
    }
    else {
Dries's avatar
 
Dries committed
851
      if (isset($query)) {
Dries's avatar
 
Dries committed
852
        return "$base_url/$script?$query";
Dries's avatar
 
Dries committed
853 854
      }
      else {
Dries's avatar
 
Dries committed
855
        return "$base_url/";
Dries's avatar
 
Dries committed
856
      }
Dries's avatar
 
Dries committed
857 858 859
    }
  }
  else {
Dries's avatar
 
Dries committed
860 861
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
862
        return "$base_url/$url?$query";
Dries's avatar
 
Dries committed
863 864
      }
      else {
Dries's avatar
 
Dries committed
865
        return "$base_url/$url";
Dries's avatar
 
Dries committed
866
      }
Dries's avatar
 
Dries committed
867
    }
Dries's avatar
 
Dries committed
868
    else {
Dries's avatar
 
Dries committed
869
      if (isset($query)) {
Dries's avatar
 
Dries committed
870
        return "$base_url/$script?$query";
Dries's avatar
 
Dries committed
871 872
      }
      else {
Dries's avatar
 
Dries committed
873
        return "$base_url/";
Dries's avatar
 
Dries committed
874
      }
Dries's avatar
 
Dries committed
875
    }
Dries's avatar
 
Dries committed
876
  }
Dries's avatar
 
Dries committed
877 878
}

879 880 881 882 883 884 885
function drupal_attributes($attributes = 0) {
  if (is_array($attributes)) {
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
    return " ". implode($t, " ");
Dries's avatar
 
Dries committed
886
  }
887
}
Dries's avatar
 
Dries committed
888

889 890
function l($text, $url, $attributes = array(), $query = NULL) {
  return "<a href=\"". url($url, $query) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
891 892
}

Dries's avatar
 
Dries committed
893
function field_get($string, $name) {
894
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
 
Dries committed
895 896 897 898 899
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
 
Dries committed
900
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
901 902
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
 
Dries committed
903 904 905 906
  return substr($rval, 1);
}

function link_page() {
907
  global $custom_links;
Dries's avatar
 
Dries committed
908

909
  if (is_array($custom_links)) {
910 911 912
    return $custom_links;
  }
  else {
Dries's avatar
 
Dries committed
913
    $links = module_invoke_all("link", "page");
914
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
915
    return $links;
Dries's avatar
 
Dries committed
916
  }
Dries's avatar
 
Dries committed
917
}
Dries's avatar
 
Dries committed
918 919

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
920
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
921 922
}

Dries's avatar
 
Dries committed
923
function drupal_page_footer() {
Dries's avatar
 
Dries committed
924
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
925
    page_set_cache();
Dries's avatar
 
Dries committed
926
  }
Dries's avatar
 
Dries committed
927

Dries's avatar
 
Dries committed
928 929 930 931 932
  /*
  ** 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
933
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
934 935 936
}

include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
937
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
938
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
939
include_once "includes/xmlrpc.inc";
Dries's avatar
 
Dries committed
940
include_once "includes/tablesort.inc";
941

Dries's avatar
 
Dries committed
942 943 944
// set error handler:
set_error_handler("error_handler");

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

Dries's avatar
 
Dries committed
948 949
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
Dries's avatar
 
Dries committed
950
  if ($path = drupal_get_normal_path(trim($_GET["q"], "/"))) {
Dries's avatar
 
Dries committed
951 952 953 954
    $_GET["q"] = $path;
  }
}
else {
Dries's avatar
 
Dries committed
955 956 957 958 959 960
  if ($path = drupal_get_normal_path(variable_get("site_frontpage", "node"))) {
    $_GET["q"] = $path;
  }
  else {
    $_GET["q"] = variable_get("site_frontpage", "node");
  }
Dries's avatar
 
Dries committed
961 962
}

Dries's avatar
 
Dries committed
963 964 965
// initialize installed modules:
module_init();

Dries's avatar
 
Dries committed
966 967 968 969 970 971
if (!user_access("bypass input data check")) {
  if (!valid_input_data($_REQUEST)) {
    die("terminated request because of suspicious input data");
  }
}

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

// initialize theme:
Dries's avatar
 
Dries committed
976
$theme = init_theme();
Dries's avatar
 
Dries committed
977

Dries's avatar
 
Dries committed
978
?>