common.inc 27.8 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
/**
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
  static $map = NULL;
Dries's avatar
 
Dries committed
87

Dries's avatar
 
Dries committed
88 89 90 91
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

Dries's avatar
 
Dries committed
102 103 104 105
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries's avatar
 
Dries committed
106 107 108
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
109 110

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

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries's avatar
Dries committed
120 121
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '%s' AND hostname = '%s' AND %d - timestamp < %d", $type, $_ENV['REMOTE_ADDR'], time(), $rate))) {
      watchdog("warning", "throttle: '". $_ENV['REMOTE_ADDR'] ."' exceeded submission rate - $throttle->type");
Dries's avatar
 
Dries committed
122 123 124 125 126
      die(message_throttle());
    }
  }
}

Dries's avatar
Dries committed
127 128 129
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
    array_walk($item, '_fix_gpc_magic_array');
Dries's avatar
 
Dries committed
130
  }
Dries's avatar
Dries committed
131
  $item = stripslashes($i);
Dries's avatar
 
Dries committed
132 133
}

Dries's avatar
 
Dries committed
134 135
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
Dries committed
136 137 138 139 140 141 142
  if ($fixed && ini_get("magic_quotes_gpc")) {
    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
143 144
}

Dries's avatar
Dries committed
145 146 147
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
148 149 150 151
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
152
    $object = $array;
Dries's avatar
 
Dries committed
153 154 155 156 157
  }

  return $object;
}

Dries's avatar
Dries committed
158 159 160
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
161 162 163 164
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
165
    $array = $object;
Dries's avatar
 
Dries committed
166 167 168 169 170
  }

  return $array;
}

Dries's avatar
 
Dries committed
171
function message_access() {
Dries's avatar
 
Dries committed
172
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
173 174 175 176 177 178 179 180 181 182
}

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
183 184
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
185 186 187 188 189 190
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
191 192
}

Dries's avatar
 
Dries committed
193
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
194
  global $languages;
195

Dries's avatar
 
Dries committed
196 197 198 199 200 201 202
  /*
  ** 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
203 204
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
 
Dries committed
205 206
  */

207
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
208

Dries's avatar
 
Dries committed
209 210
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
211 212
  }
  else {
Dries's avatar
 
Dries committed
213 214
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
215 216
}

Dries's avatar
 
Dries committed
217
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
218 219 220 221 222 223 224 225 226

  /*
  ** 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
227 228
}

229
/**
Dries's avatar
 
Dries committed
230 231
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
232
 *
Dries's avatar
 
Dries committed
233
 * @param $mail a email address
234
 */
Dries's avatar
 
Dries committed
235
function valid_email_address($mail) {
236 237 238 239 240
  $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
241
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
242 243
}

Dries's avatar
 
Dries committed
244 245 246
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
247
 * @param $url an URL
Dries's avatar
 
Dries committed
248 249
 */
function valid_url($url) {
Dries's avatar
Dries committed
250
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
Dries's avatar
 
Dries committed
251 252
}

Kjartan's avatar
Kjartan committed
253 254 255
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
 
Dries committed
256
 * @param $item a single search result as returned by <i>module</i>_search of
257
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
 
Dries committed
258 259
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
260
 */
Dries's avatar
 
Dries committed
261
function search_item($item, $type) {
Dries's avatar
 
Dries committed
262 263 264 265 266 267 268 269 270 271

  /*
  ** 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
272
    $output = " <b><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
Dries's avatar
 
Dries committed
273
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
 
Dries committed
274 275
    $output .= "<br /><br />";
  }
Dries's avatar
 
Dries committed
276 277 278 279

  return $output;
}

Kjartan's avatar
Kjartan committed
280 281 282 283
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
284 285 286
 * '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
287
 *
Dries's avatar
 
Dries committed
288 289 290 291
 * @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
292
 */
Dries's avatar
 
Dries committed
293
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
294
  if (!$action) {
Dries's avatar
 
Dries committed
295
    $action = url("search");
Dries's avatar
 
Dries committed
296 297
  }

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

Dries's avatar
Dries committed
301
  if ($options) {
Dries's avatar
 
Dries committed
302 303 304 305 306
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
307
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
308 309 310 311
      }
    }
  }

Kjartan's avatar
Kjartan committed
312 313
  $form .= "<br />";

Dries's avatar
 
Dries committed
314 315 316 317
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
318 319
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
320
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
321
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
322

Dries's avatar
 
Dries committed
323
  if (isset($keys)) {
Dries's avatar
 
Dries committed
324
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
325
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan's avatar
Kjartan committed
326
        if ($name == "node" || $name == "comment") {
Dries's avatar
 
Dries committed
327
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
328 329
        }
        else {
Dries's avatar
 
Dries committed
330
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
331
        }
Dries's avatar
 
Dries committed
332 333 334 335 336 337 338 339 340 341
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
342 343 344
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
345 346 347 348 349 350
 * @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
351
 */
Dries's avatar
 
Dries committed
352 353
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
 
Dries committed
354

Dries's avatar
 
Dries committed
355
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
356 357
}

Dries's avatar
 
Dries committed
358

Dries's avatar
 
Dries committed
359 360
function drupal_goto($url) {

Dries's avatar
 
Dries committed
361 362 363
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
 
Dries committed
364

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

Dries's avatar
 
Dries committed
367 368 369 370 371
  /*
  ** 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
372
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
 
Dries committed
373 374 375
    header("Location: $url");
  }
  else {
Dries's avatar
 
Dries committed
376 377 378 379 380 381 382 383
    $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
384 385 386 387
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries's avatar
 
Dries committed
388
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries's avatar
 
Dries committed
389 390 391 392 393 394
  ** of the code /below/ gets executed when we redirect.
  */

  exit();
}

Dries's avatar
 
Dries committed
395
function valid_input_data($data) {
396
  if (is_array($data) || is_object($data)) {
397 398 399 400 401
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
402 403 404
      if (!valid_input_data($value)) {
        return 0;
      }
405 406 407 408 409 410 411
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
412
    // check strings:
Dries's avatar
Dries committed
413
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
414 415 416
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

420 421

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries's avatar
 
Dries committed
426
      return 0;
427 428
    }
  }
Dries's avatar
 
Dries committed
429 430

  return 1;
431
}
Dries's avatar
 
Dries committed
432

Dries's avatar
 
Dries committed
433
function check_form($text) {
Dries's avatar
 
Dries committed
434
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
435 436 437
}

function filter($text) {
Dries's avatar
 
Dries committed
438 439 440 441 442 443 444 445 446 447 448 449 450
  $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
451 452 453 454 455
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
 
Dries committed
456 457
}

Dries's avatar
 
Dries committed
458
function rewrite_old_urls($text) {
Dries's avatar
 
Dries committed
459 460 461 462
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
 
Dries committed
463 464 465
  /*
  ** 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
466 467
  ** (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
468 469 470
  ** and comment bodies.
  */

Dries's avatar
 
Dries committed
471
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
    /*
    ** 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
488
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
489
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
490

Dries's avatar
 
Dries committed
491
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
492 493 494
    $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
495 496
  }
  else {
Dries's avatar
 
Dries committed
497 498 499 500
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
    $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
521

Dries's avatar
 
Dries committed
522 523 524
  return $text;
}

Dries's avatar
 
Dries committed
525
function check_output($text) {
Dries's avatar
 
Dries committed
526
  if (isset($text)) {
Dries's avatar
 
Dries committed
527 528 529
    // filter content on output:
    $text = filter($text);

Dries's avatar
 
Dries committed
530 531 532 533 534
    /*
    ** If only inline elements are used and no block level elements, we
    ** replace all newlines with HTML line breaks.
    */
    if (strip_tags($text, '<a><br><span><bdo><map><object><img><tt><i><b><big><small><em><strong><dfn><code><q><samp><kbd><var><cite><abbr><acronym><sub><sup><input><select><textarea><label><button><ins><del><script>') == $text) {
Dries's avatar
 
Dries committed
535 536 537 538 539 540 541 542
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
 
Dries committed
543 544
}

545

546 547
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
548 549
}

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

  return $output;
}

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

Dries's avatar
Dries committed
570
  $output = "<item>\n";
Dries's avatar
 
Dries committed
571 572 573
  $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
574
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
575
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
576
  }
Dries's avatar
 
Dries committed
577 578 579 580 581
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
582 583
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
584 585
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
586
 *
Dries's avatar
 
Dries committed
587 588 589 590 591 592 593
 * @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
594
 */
Dries's avatar
 
Dries committed
595
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
596
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
597 598 599
}

function format_size($size) {
Dries's avatar
 
Dries committed
600
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
601 602
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
603
    $suffix = t("KB");
Dries's avatar
 
Dries committed
604 605 606
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
607
    $suffix = t("MB");
Dries's avatar
 
Dries committed
608
  }
Dries's avatar
 
Dries committed
609
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
610 611 612
}

function format_interval($timestamp) {
Dries's avatar
 
Dries committed
613
  $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
614
  foreach ($units as $key=>$value) {
Dries's avatar
 
Dries committed
615 616 617 618 619 620
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
 
Dries committed
621
  return ($output) ? $output : t("0 sec");
Dries's avatar
 
Dries committed
622 623 624 625 626
}

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

Kjartan's avatar
Kjartan committed
627
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
 
Dries committed
628 629 630

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
631
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
 
Dries committed
632 633
      break;
    case "large":
Dries's avatar
 
Dries committed
634
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
 
Dries committed
635 636
      break;
    case "custom":
Dries's avatar
 
Dries committed
637
      // No change to format
Dries's avatar
 
Dries committed
638
      break;
Dries's avatar
 
Dries committed
639
    case "medium":
Dries's avatar
 
Dries committed
640
    default:
Dries's avatar
 
Dries committed
641 642 643 644 645 646 647 648 649 650 651 652 653
      $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
654 655 656 657 658 659 660
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
661 662 663 664 665 666 667 668 669 670 671 672
    /*
    ** 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
673
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
674
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
675 676
    }
    else {
Dries's avatar
Dries committed
677
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
678
    }
Dries's avatar
 
Dries committed
679
  }
Dries's avatar
 
Dries committed
680 681 682 683 684 685 686 687 688 689
  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
690
  else {
Dries's avatar
 
Dries committed
691
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
692 693
  }

Dries's avatar
 
Dries committed
694
  return $output;
Dries's avatar
 
Dries committed
695 696 697
}

function form($form, $method = "post", $action = 0, $options = 0) {
Dries's avatar
 
Dries committed
698
  if (!$action) {
699
    $action = request_uri();
Dries's avatar
 
Dries committed
700
  }
701
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
702 703 704
}

function form_item($title, $value, $description = 0) {
Dries's avatar
 
Dries committed
705
  return theme("form_element", $title, $value, $description);
Dries's avatar
 
Dries committed
706
}
Dries's avatar
 
Dries committed
707

Dries's avatar
 
Dries committed
708 709 710
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
711

712
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
713
  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
714 715
}

716
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
717
  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
718 719
}

720
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
721
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
722
  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
723 724
}

725
function form_password($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
726
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
727
  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
728 729
}

730
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
731
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
732
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
733
  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
734 735
}

Dries's avatar
 
Dries committed
736
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
737
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
738
    foreach ($options as $key=>$choice) {
739
      $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
740
    }
Dries's avatar
 
Dries committed
741
    return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
 
Dries committed
742 743 744
  }
}

Dries's avatar
 
Dries committed
745 746 747 748 749
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
750
    return theme("form_element", $title, $output, $description);
Dries's avatar
 
Dries committed
751 752 753
  }
}

754
function form_file($title, $name, $size, $description = 0) {
Dries's avatar
 
Dries committed
755
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries's avatar
 
Dries committed
756 757 758 759 760 761
}

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

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

Dries's avatar
 
Dries committed
766
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
 
Dries committed
767
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
768 769 770 771 772 773
    $weights[$n] = $n;
  }

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

Dries's avatar
 
Dries committed
774 775 776 777
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
 
Dries committed
778 779 780
/**
 * Given an old url, return the alias.
 */
Dries's avatar
 
Dries committed
781 782
function drupal_get_path_alias($path) {
  $map = drupal_get_path_map();
Dries's avatar
 
Dries committed
783

Dries's avatar
 
Dries committed
784 785 786
  if ($map) {
    return array_search($path, $map);
  }
Dries's avatar
 
Dries committed
787 788 789
}

/**
Dries's avatar
 
Dries committed
790
 * Given an alias, return the default url.
Dries's avatar
 
Dries committed
791
 */
Dries's avatar
 
Dries committed
792 793
function drupal_get_normal_path($path) {
  $map = drupal_get_path_map();
Dries's avatar
 
Dries committed
794

Dries's avatar
Dries committed
795
  return $map[$path] ? $map[$path] : $path;
Dries's avatar
 
Dries committed
796 797
}

Dries's avatar
 
Dries committed
798
function url($url = NULL, $query = NULL) {
Dries's avatar
 
Dries committed
799
  global $base_url;
Dries's avatar
 
Dries committed
800

Dries's avatar
 
Dries committed
801 802 803 804 805 806 807 808 809 810 811
  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
812
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
813 814 815
    $url = $alias;
  }

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

854 855 856 857 858 859 860
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
861
  }
862
}
Dries's avatar
 
Dries committed
863

864 865
function l($text, $url, $attributes = array(), $query = NULL) {
  return "<a href=\"". url($url, $query) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
866 867
}

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

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

function link_page() {
882
  global $custom_links;
Dries's avatar
 
Dries committed
883

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

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

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

Dries's avatar
 
Dries committed
903 904 905 906 907
  /*
  ** 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
908
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
909 910 911
}

include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
912
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
913
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
914
include_once "includes/xmlrpc.inc";
Dries's avatar
 
Dries committed
915
include_once "includes/tablesort.inc";
916

Dries's avatar
 
Dries committed
917 918 919
// set error handler:
set_error_handler("error_handler");

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

Dries's avatar
 
Dries committed
923 924
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
Dries's avatar
 
Dries committed
925
  $_GET["q"] = drupal_get_normal_path(trim($_GET["q"], "/"));
Dries's avatar
 
Dries committed
926 927
}
else {
Dries's avatar
 
Dries committed
928
  $_GET["q"] = drupal_get_normal_path(variable_get("site_frontpage", "node"));
Dries's avatar
 
Dries committed
929 930
}

Dries's avatar
 
Dries committed
931 932 933
// initialize installed modules:
module_init();

934
if ($_REQUEST && !user_access("bypass input data check")) {
Dries's avatar
 
Dries committed
935 936 937 938 939
  if (!valid_input_data($_REQUEST)) {
    die("terminated request because of suspicious input data");
  }
}

Dries's avatar
 
Dries committed
940 941 942 943
// initialize localization system:
$locale = locale_init();

// initialize theme:
Dries's avatar
 
Dries committed
944
$theme = init_theme();
Dries's avatar
 
Dries committed
945

Dries's avatar
 
Dries committed
946
?>