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

Dries's avatar
 
Dries committed
4 5 6
/**
 * Build the alias/path array
 */
Dries's avatar
 
Dries committed
7
function drupal_get_path_map($action = "") {
Dries's avatar
 
Dries committed
8 9

  static $cache;
Dries's avatar
 
Dries committed
10 11
  static $map;

Dries's avatar
 
Dries committed
12 13
  if ($action == "rebuild") {
    $map = NULL;
Dries's avatar
 
Dries committed
14
    $cache = 0;
Dries's avatar
 
Dries committed
15 16
  }

Dries's avatar
 
Dries committed
17
  if (!$cache) {
Dries's avatar
 
Dries committed
18
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
 
Dries committed
19
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
20
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
21
    }
Dries's avatar
 
Dries committed
22 23

    $cache = 1;
Dries's avatar
 
Dries committed
24 25 26 27 28
  }

  return $map;
}

Dries's avatar
 
Dries committed
29 30 31 32
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries's avatar
 
Dries committed
33 34 35
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
36 37

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
 
Dries committed
38
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
39
    print "<pre>$entry</pre>";
Dries's avatar
 
Dries committed
40 41 42
  }
}

Dries's avatar
 
Dries committed
43
function watchdog($type, $message, $link = NULL) {
Dries's avatar
 
Dries committed
44
  global $user;
Dries's avatar
 
Dries committed
45
  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
46 47 48 49
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries's avatar
 
Dries committed
50
    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
51 52 53 54 55 56 57 58 59
      watchdog("warning", "throttle: '". getenv("REMOTE_ADDR") ."' exceeded submission rate - $throttle->type");
      die(message_throttle());
    }
    else {
      watchdog($type, "throttle");
    }
  }
}

Dries's avatar
 
Dries committed
60 61 62 63
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
64 65 66
  }
}

Dries's avatar
 
Dries committed
67 68 69 70 71 72 73 74 75 76 77 78
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
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
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
107
function message_access() {
Dries's avatar
 
Dries committed
108
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
109 110 111 112 113 114 115 116 117 118
}

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
119 120
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
121 122 123 124 125 126
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
127 128
}

Dries's avatar
 
Dries committed
129
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
130
  global $languages;
131

Dries's avatar
 
Dries committed
132 133 134 135 136 137 138
  /*
  ** 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
139 140
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
 
Dries committed
141 142
  */

143
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
144

Dries's avatar
 
Dries committed
145 146
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
147 148
  }
  else {
Dries's avatar
 
Dries committed
149 150
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
151 152
}

Dries's avatar
 
Dries committed
153
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
154 155 156 157 158 159 160 161 162

  /*
  ** 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
163 164
}

165 166 167 168 169 170
/**
 * Verify the syntax of the given e-mail address.  Empty e-mail addresses
 * are allowed.  See RFC 2822 for details.
 *
 * @param $mail  a email address
 */
Dries's avatar
 
Dries committed
171
function valid_email_address($mail) {
172 173 174 175 176 177 178 179 180 181 182 183 184
  $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
185 186 187 188 189 190 191
/**
 * Verify the syntax of the given URL.
 *
 * @param $url  an URL
 */
function valid_url($url) {

Dries's avatar
 
Dries committed
192
  if (preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url)) {
Dries's avatar
 
Dries committed
193 194 195 196 197 198 199
    return 1;
  }
  else {
    return 0;
  }
}

Kjartan's avatar
Kjartan committed
200 201 202 203
/**
 * Format a single result entry of a search query:
 *
 * @param $item  a single search result as returned by <module>_search of type
Dries's avatar
 
Dries committed
204
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
205 206 207
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
 
Dries committed
208
function search_item($item, $type) {
Dries's avatar
 
Dries committed
209 210 211 212 213 214 215 216 217 218

  /*
  ** 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
219
    $output .= " <b><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
Dries's avatar
 
Dries committed
220
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
 
Dries committed
221 222
    $output .= "<br /><br />";
  }
Dries's avatar
 
Dries committed
223 224 225 226

  return $output;
}

Kjartan's avatar
Kjartan committed
227 228 229 230
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
231
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
 
Dries committed
232 233
 * "Restrict search to", help text, etc) from theme's header etc.
 * This means: provide options to only conditionally render certain
Kjartan's avatar
Kjartan committed
234 235
 * parts of this form.
 *
Dries's avatar
 
Dries committed
236
 * @param $action  Form action. Defaults to 'site.com/search'.
Dries's avatar
 
Dries committed
237
 * @param $keys   string containing keywords for the search.
Dries's avatar
 
Dries committed
238
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
239 240
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
 
Dries committed
241
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
242 243

  if (!$action) {
Dries's avatar
 
Dries committed
244
    $action = url("search");
Dries's avatar
 
Dries committed
245 246
  }

Dries's avatar
 
Dries committed
247 248
  $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
249 250 251 252 253 254 255

  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
256
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
257 258 259 260
      }
    }
  }

Kjartan's avatar
Kjartan committed
261 262
  $form .= "<br />";

Dries's avatar
 
Dries committed
263 264 265 266
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
267 268
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
269
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
270 271

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

Dries's avatar
 
Dries committed
273
  if (isset($keys)) {
Dries's avatar
 
Dries committed
274
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
275
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan's avatar
Kjartan committed
276
        if ($name == "node" || $name == "comment") {
Dries's avatar
 
Dries committed
277
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
278 279
        }
        else {
Dries's avatar
 
Dries committed
280
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
281
        }
Dries's avatar
 
Dries committed
282 283 284 285 286 287 288 289 290 291
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
292 293 294
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
295
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
296
 *                 Otherwise, search all types.
Dries's avatar
 
Dries committed
297
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
298
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
 
Dries committed
299
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
300 301
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
 
Dries committed
302
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
303

Dries's avatar
 
Dries committed
304
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
 
Dries committed
305

Dries's avatar
 
Dries committed
306
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
307 308
}

Dries's avatar
 
Dries committed
309

Dries's avatar
 
Dries committed
310 311
function drupal_goto($url) {

Dries's avatar
 
Dries committed
312 313 314
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
 
Dries committed
315

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

Dries's avatar
 
Dries committed
318 319 320 321 322
  /*
  ** 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
323
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
 
Dries committed
324 325 326
    header("Location: $url");
  }
  else {
Dries's avatar
 
Dries committed
327 328 329 330 331 332 333 334
    $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
335 336 337 338
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries's avatar
 
Dries committed
339
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries's avatar
 
Dries committed
340 341 342 343 344 345
  ** of the code /below/ gets executed when we redirect.
  */

  exit();
}

Dries's avatar
 
Dries committed
346
function valid_input_data($data) {
347

348
  if (is_array($data) || is_object($data)) {
349 350 351 352 353
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
354 355 356
      if (!valid_input_data($value)) {
        return 0;
      }
357 358 359 360 361 362 363
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
364
    // check strings:
Dries's avatar
Dries committed
365
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
366 367 368
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

372 373

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries's avatar
 
Dries committed
378
      return 0;
379 380
    }
  }
Dries's avatar
 
Dries committed
381 382

  return 1;
383
}
Dries's avatar
 
Dries committed
384

Dries's avatar
 
Dries committed
385
function check_form($text) {
Dries's avatar
 
Dries committed
386
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
387 388 389
}

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

Dries's avatar
 
Dries committed
391 392 393 394 395 396 397 398 399 400 401 402 403
  $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
404 405 406 407 408
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
 
Dries committed
409 410
}

Dries's avatar
 
Dries committed
411 412
function rewrite_old_urls($text) {

Dries's avatar
 
Dries committed
413 414 415 416
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
 
Dries committed
417 418 419
  /*
  ** 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
420 421
  ** (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
422 423 424
  ** and comment bodies.
  */

Dries's avatar
 
Dries committed
425
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
    /*
    ** 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
442
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
443
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
444

Dries's avatar
 
Dries committed
445
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
446 447 448
    $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
449 450
  }
  else {
Dries's avatar
 
Dries committed
451 452 453 454
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
    $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
475

Dries's avatar
 
Dries committed
476 477 478
  return $text;
}

Dries's avatar
 
Dries committed
479
function check_output($text) {
Dries's avatar
 
Dries committed
480
  if (isset($text)) {
Dries's avatar
 
Dries committed
481 482 483 484
    // filter content on output:
    $text = filter($text);

    // get the line breaks right:
Dries's avatar
 
Dries committed
485
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
 
Dries committed
486 487 488 489 490 491 492 493
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
 
Dries committed
494 495
}

496

497 498
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
499 500
}

Dries's avatar
 
Dries committed
501 502 503
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
504
  $output .= "<channel>\n";
Dries's avatar
 
Dries committed
505 506 507 508
  $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
509
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
510
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
511
  }
Dries's avatar
 
Dries committed
512 513 514 515 516 517
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
 
Dries committed
521
  $output .= "<item>\n";
Dries's avatar
 
Dries committed
522 523 524
  $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
525
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
526
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
527
  }
Dries's avatar
 
Dries committed
528 529 530 531 532
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546
/**
 * Formats a string with a count of items so that the string is pluralized
 * correctly.
 * format_plural calls t() by itself, make sure not to pass already localized
 * strings to it.
 *
 * @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
547
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
548
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
549 550 551
}

function format_size($size) {
Dries's avatar
 
Dries committed
552
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
553 554
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
555
    $suffix = t("KB");
Dries's avatar
 
Dries committed
556 557 558
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
559
    $suffix = t("MB");
Dries's avatar
 
Dries committed
560
  }
Dries's avatar
 
Dries committed
561
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
562 563 564
}

function format_interval($timestamp) {
Dries's avatar
 
Dries committed
565
  $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
566
  foreach ($units as $key=>$value) {
Dries's avatar
 
Dries committed
567 568 569 570 571 572
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
 
Dries committed
573
  return ($output) ? $output : t("0 sec");
Dries's avatar
 
Dries committed
574 575 576 577 578
}

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

Kjartan's avatar
Kjartan committed
579
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
 
Dries committed
580 581 582

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
583
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
 
Dries committed
584 585
      break;
    case "large":
Dries's avatar
 
Dries committed
586
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
 
Dries committed
587 588
      break;
    case "custom":
Dries's avatar
 
Dries committed
589
      // No change to format
Dries's avatar
 
Dries committed
590
      break;
Dries's avatar
 
Dries committed
591
    case "medium":
Dries's avatar
 
Dries committed
592
    default:
Dries's avatar
 
Dries committed
593 594 595 596 597 598 599 600 601 602 603 604 605
      $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
606 607 608 609 610 611 612
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
613 614 615 616 617 618 619 620 621 622 623 624
    /*
    ** 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
625
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
626
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
627 628
    }
    else {
Dries's avatar
Dries committed
629
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
630
    }
Dries's avatar
 
Dries committed
631
  }
Dries's avatar
 
Dries committed
632 633 634 635 636 637 638 639 640 641
  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
642
  else {
Dries's avatar
 
Dries committed
643
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
644 645
  }

Dries's avatar
 
Dries committed
646
  return $output;
Dries's avatar
 
Dries committed
647 648 649
}

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

  if (!$action) {
652
    $action = request_uri();
Dries's avatar
 
Dries committed
653
  }
654
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
655 656 657
}

function form_item($title, $value, $description = 0) {
Dries's avatar
 
Dries committed
658
  return theme("form_element", $title, $value, $description);
Dries's avatar
 
Dries committed
659
}
Dries's avatar
 
Dries committed
660

Dries's avatar
 
Dries committed
661 662 663
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
664

665
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
666
  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
667 668
}

669
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
670
  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
671 672
}

673
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
674
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
675
  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
676 677
}

678
function form_password($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
679
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
680
  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
681 682
}

683
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
684
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
685
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
686
  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
687 688
}

Dries's avatar
 
Dries committed
689
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
690
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
691
    foreach ($options as $key=>$choice) {
692
      $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
693
    }
Dries's avatar
 
Dries committed
694
    return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
 
Dries committed
695 696 697
  }
}

Dries's avatar
 
Dries committed
698 699 700 701 702
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
703
    return theme("form_element", $title, $output, $description);
Dries's avatar
 
Dries committed
704 705 706
  }
}

707
function form_file($title, $name, $size, $description = 0) {
Dries's avatar
 
Dries committed
708
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries's avatar
 
Dries committed
709 710 711 712 713 714
}

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

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

Dries's avatar
 
Dries committed
719
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
 
Dries committed
720
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
721 722 723 724 725 726
    $weights[$n] = $n;
  }

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

Dries's avatar
 
Dries committed
727 728 729 730
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
 
Dries committed
731 732 733
/**
 * Given an old url, return the alias.
 */
Dries's avatar
 
Dries committed
734 735
function drupal_get_path_alias($path) {
  $map = drupal_get_path_map();
Dries's avatar
 
Dries committed
736

Dries's avatar
 
Dries committed
737 738 739
  if ($map) {
    return array_search($path, $map);
  }
Dries's avatar
 
Dries committed
740 741 742
}

/**
Dries's avatar
 
Dries committed
743
 * Given an alias, return the default url.
Dries's avatar
 
Dries committed
744
 */
Dries's avatar
 
Dries committed
745 746
function drupal_get_normal_path($path) {
  $map = drupal_get_path_map();
Dries's avatar
 
Dries committed
747 748 749
  return $map[$path];
}

Dries's avatar
 
Dries committed
750
function url($url = NULL, $query = NULL) {
Dries's avatar
 
Dries committed
751
  global $base_url;
Dries's avatar
 
Dries committed
752

Dries's avatar
 
Dries committed
753 754 755 756 757 758 759 760 761 762 763
  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
764
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
765 766 767
    $url = $alias;
  }

Dries's avatar
 
Dries committed
768
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
769 770
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
771
        return "$base_url/$script?q=$url&amp;$query";
Dries's avatar
 
Dries committed
772 773
      }
      else {
Dries's avatar
 
Dries committed
774
        return "$base_url/$script?q=$url";
Dries's avatar
 
Dries committed
775
      }
Dries's avatar
 
Dries committed
776 777
    }
    else {
Dries's avatar
 
Dries committed
778
      if (isset($query)) {
Dries's avatar
 
Dries committed
779
        return "$base_url/$script?$query";
Dries's avatar
 
Dries committed
780 781
      }
      else {
Dries's avatar
 
Dries committed
782
        return "$base_url/";
Dries's avatar
 
Dries committed
783
      }
Dries's avatar
 
Dries committed
784 785 786
    }
  }
  else {
Dries's avatar
 
Dries committed
787 788
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
789
        return "$base_url/$url?$query";
Dries's avatar
 
Dries committed
790 791
      }
      else {
Dries's avatar
 
Dries committed
792
        return "$base_url/$url";
Dries's avatar
 
Dries committed
793
      }
Dries's avatar
 
Dries committed
794
    }
Dries's avatar
 
Dries committed
795
    else {
Dries's avatar
 
Dries committed
796
      if (isset($query)) {
Dries's avatar
 
Dries committed
797
        return "$base_url/$script?$query";
Dries's avatar
 
Dries committed
798 799
      }
      else {
Dries's avatar
 
Dries committed
800
        return "$base_url/";
Dries's avatar
 
Dries committed
801
      }
Dries's avatar
 
Dries committed
802
    }
Dries's avatar
 
Dries committed
803
  }
Dries's avatar
 
Dries committed
804 805
}

806 807 808 809 810 811 812
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
813
  }
814
}
Dries's avatar
 
Dries committed
815

816 817
function l($text, $url, $attributes = array(), $query = NULL) {
  return "<a href=\"". url($url, $query) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
818 819
}

Dries's avatar
 
Dries committed
820
function field_get($string, $name) {
821
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
 
Dries committed
822 823 824 825 826
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
 
Dries committed
827
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
828 829
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
 
Dries committed
830 831 832 833
  return substr($rval, 1);
}

function link_page() {
834
  global $custom_links;
Dries's avatar
 
Dries committed
835

836
  if (is_array($custom_links)) {
837 838 839
    return $custom_links;
  }
  else {
Dries's avatar
 
Dries committed
840
    $links = module_invoke_all("link", "page");
841
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
842
    return $links;
Dries's avatar
 
Dries committed
843
  }
Dries's avatar
 
Dries committed
844
}
Dries's avatar
 
Dries committed
845 846

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
847
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
848 849
}

Dries's avatar
 
Dries committed
850
function drupal_page_footer() {
Dries's avatar
 
Dries committed
851
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
852
    page_set_cache();
Dries's avatar
 
Dries committed
853
  }
Dries's avatar
 
Dries committed
854

Dries's avatar
 
Dries committed
855 856 857 858 859
  /*
  ** 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
860
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
861 862 863
}

include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
864
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
865
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
866
include_once "includes/xmlrpc.inc";
Dries's avatar
 
Dries committed
867
include_once "includes/tablesort.inc";
868

Dries's avatar
 
Dries committed
869 870 871
// set error handler:
set_error_handler("error_handler");

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

Dries's avatar
 
Dries committed
875 876
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
Dries's avatar
 
Dries committed
877
  if ($path = drupal_get_normal_path(trim($_GET["q"], "/"))) {
Dries's avatar
 
Dries committed
878 879 880 881
    $_GET["q"] = $path;
  }
}
else {
Dries's avatar
 
Dries committed
882 883 884 885 886 887
  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
888 889
}

Dries's avatar
 
Dries committed
890 891 892
// initialize installed modules:
module_init();

Dries's avatar
 
Dries committed
893 894 895 896 897 898
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
899 900 901 902
// initialize localization system:
$locale = locale_init();

// initialize theme:
Dries's avatar
 
Dries committed
903
$theme = init_theme();
Dries's avatar
 
Dries committed
904

Dries's avatar
 
Dries committed
905
?>