common.inc 27.9 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 121 122
  }
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries's avatar
 
Dries committed
123
    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
124 125 126 127 128 129
      watchdog("warning", "throttle: '". getenv("REMOTE_ADDR") ."' exceeded submission rate - $throttle->type");
      die(message_throttle());
    }
  }
}

Dries's avatar
 
Dries committed
130 131 132 133
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
134 135 136
  }
}

Dries's avatar
 
Dries committed
137 138 139 140 141 142 143 144 145 146 147 148
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
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
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
177
function message_access() {
Dries's avatar
 
Dries committed
178
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
179 180 181 182 183 184 185 186 187 188
}

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
189 190
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
191 192 193 194 195 196
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
197 198
}

Dries's avatar
 
Dries committed
199
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
200
  global $languages;
201

Dries's avatar
 
Dries committed
202 203 204 205 206 207 208
  /*
  ** 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
209 210
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
 
Dries committed
211 212
  */

213
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
214

Dries's avatar
 
Dries committed
215 216
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
217 218
  }
  else {
Dries's avatar
 
Dries committed
219 220
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
221 222
}

Dries's avatar
 
Dries committed
223
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
224 225 226 227 228 229 230 231 232

  /*
  ** 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
233 234
}

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

Dries's avatar
 
Dries committed
262
  if (preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url)) {
Dries's avatar
 
Dries committed
263 264 265 266 267 268 269
    return 1;
  }
  else {
    return 0;
  }
}

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

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

  return $output;
}

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

  if (!$action) {
Dries's avatar
 
Dries committed
313
    $action = url("search");
Dries's avatar
 
Dries committed
314 315
  }

Dries's avatar
 
Dries committed
316 317
  $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
318 319 320 321 322 323 324

  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
325
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
326 327 328 329
      }
    }
  }

Kjartan's avatar
Kjartan committed
330 331
  $form .= "<br />";

Dries's avatar
 
Dries committed
332 333 334 335
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
336 337
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
338
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
339 340

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

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

  return $output;
}

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

Dries's avatar
 
Dries committed
373
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
 
Dries committed
374

Dries's avatar
 
Dries committed
375
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
376 377
}

Dries's avatar
 
Dries committed
378

Dries's avatar
 
Dries committed
379 380
function drupal_goto($url) {

Dries's avatar
 
Dries committed
381 382 383
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
 
Dries committed
384

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

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

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

  exit();
}

Dries's avatar
 
Dries committed
415
function valid_input_data($data) {
416

417
  if (is_array($data) || is_object($data)) {
418 419 420 421 422
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
423 424 425
      if (!valid_input_data($value)) {
        return 0;
      }
426 427 428 429 430 431 432
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
433
    // check strings:
Dries's avatar
Dries committed
434
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
435 436 437
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

441 442

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries's avatar
 
Dries committed
447
      return 0;
448 449
    }
  }
Dries's avatar
 
Dries committed
450 451

  return 1;
452
}
Dries's avatar
 
Dries committed
453

Dries's avatar
 
Dries committed
454
function check_form($text) {
Dries's avatar
 
Dries committed
455
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
456 457 458
}

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

Dries's avatar
 
Dries committed
460 461 462 463 464 465 466 467 468 469 470 471 472
  $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
473 474 475 476 477
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
 
Dries committed
478 479
}

Dries's avatar
 
Dries committed
480 481
function rewrite_old_urls($text) {

Dries's avatar
 
Dries committed
482 483 484 485
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
 
Dries committed
486 487 488
  /*
  ** 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
489 490
  ** (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
491 492 493
  ** and comment bodies.
  */

Dries's avatar
 
Dries committed
494
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
    /*
    ** 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
511
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
512
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
513

Dries's avatar
 
Dries committed
514
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
515 516 517
    $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
518 519
  }
  else {
Dries's avatar
 
Dries committed
520 521 522 523
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
    $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
544

Dries's avatar
 
Dries committed
545 546 547
  return $text;
}

Dries's avatar
 
Dries committed
548
function check_output($text) {
Dries's avatar
 
Dries committed
549
  if (isset($text)) {
Dries's avatar
 
Dries committed
550 551 552
    // filter content on output:
    $text = filter($text);

Dries's avatar
 
Dries committed
553 554 555 556 557
    /*
    ** 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
558 559 560 561 562 563 564 565
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
 
Dries committed
566 567
}

568

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

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

  return $output;
}

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

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

  return $output;
}

Dries's avatar
 
Dries committed
605 606
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
607 608
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
609
 *
Dries's avatar
 
Dries committed
610 611 612 613 614 615 616
 * @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
617
 */
Dries's avatar
 
Dries committed
618
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
619
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
620 621 622
}

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

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

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

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

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

function format_name($object) {

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

Dries's avatar
 
Dries committed
717
  return $output;
Dries's avatar
 
Dries committed
718 719 720
}

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

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

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

Dries's avatar
 
Dries committed
732 733 734
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
735

736
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
737
  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
738 739
}

740
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
741
  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
742 743
}

744
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
745
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
746
  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
747 748
}

749
function form_password($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
750
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
751
  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
752 753
}

754
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
755
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
756
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
757
  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
758 759
}

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

Dries's avatar
 
Dries committed
769 770 771 772 773
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
774
    return theme("form_element", $title, $output, $description);
Dries's avatar
 
Dries committed
775 776 777
  }
}

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

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

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

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

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

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

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

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

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

  if ($map[$path]) {
    return $map[$path];
  }
  else {
    return $path;
  }
Dries's avatar
 
Dries committed
825 826
}

Dries's avatar
 
Dries committed
827
function url($url = NULL, $query = NULL) {
Dries's avatar
 
Dries committed
828
  global $base_url;
Dries's avatar
 
Dries committed
829

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

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

883 884 885 886 887 888 889
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
890
  }
891
}
Dries's avatar
 
Dries committed
892

893 894
function l($text, $url, $attributes = array(), $query = NULL) {
  return "<a href=\"". url($url, $query) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
895 896
}

Dries's avatar
 
Dries committed
897
function field_get($string, $name) {
898
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
 
Dries committed
899 900 901 902 903
  return $regs[1];
}

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

function link_page() {
911
  global $custom_links;
Dries's avatar
 
Dries committed
912

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

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
924
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
925 926
}

Dries's avatar
 
Dries committed
927
function drupal_page_footer() {
Dries's avatar
 
Dries committed
928
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
929
    page_set_cache();
Dries's avatar
 
Dries committed
930
  }
Dries's avatar
 
Dries committed
931

Dries's avatar
 
Dries committed
932 933 934 935 936
  /*
  ** 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
937
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
938 939 940
}

include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
941
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
942
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
943
include_once "includes/xmlrpc.inc";
Dries's avatar
 
Dries committed
944
include_once "includes/tablesort.inc";
945

Dries's avatar
 
Dries committed
946 947 948
// set error handler:
set_error_handler("error_handler");

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

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

Dries's avatar
 
Dries committed
960 961 962
// initialize installed modules:
module_init();

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

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

// initialize theme:
Dries's avatar
 
Dries committed
973
$theme = init_theme();
Dries's avatar
 
Dries committed
974

Dries's avatar
 
Dries committed
975
?>