common.inc 28.1 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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
/**
  @name drupal_message

  Functions to get and set the message of the current page.
  @{
**/
function drupal_set_message($message = NULL, $type = "status") {
  static $stored_message;

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

  return $stored_message;
}

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

Dries's avatar
 
Dries committed
52
/**
Dries's avatar
 
Dries committed
53 54 55 56 57 58 59 60
  @name drupal_breadcrumb

  Functions to get and set the breadcrumb trail of the current page.

  @param   $breadcrumb   array of links, starting with "home" and proceeding
    up to but not including the current page.
  @{
**/
Dries's avatar
 
Dries committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

  if (isset($breadcrumb)) {
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

  if (!isset($breadcrumb)) {
    $breadcrumb = menu_get_active_breadcrumb();
    array_pop($breadcrumb);
  }

  return $breadcrumb;
}
80
// @}
Dries's avatar
 
Dries committed
81

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

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

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

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

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

  return $map;
}

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

Dries's avatar
 
Dries committed
111 112 113
function error_handler($errno, $message, $filename, $line, $variables) {
  $types = array(1 => "error", 2 => "warning", 4 => "parse error", 8 => "notice", 16 => "core error", 32 => "core warning", 64 => "compile error", 128 => "compile warning", 256 => "user error", 512 => "user warning", 1024 => "user notice");
  $entry = $types[$errno] .": $message in $filename on line $line.";
Dries's avatar
 
Dries committed
114 115

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

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

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

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

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

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

  $fixed = true;
}

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

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

  return $object;
}

function object2array($node) {

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

  return $array;
}

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

function message_na() {
  return t("n/a");
}

function message_throttle() {
  return t("You exceeded the maximum submission rate.  Please wait a few minutes and try again.");
}

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

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

Dries's avatar
 
Dries committed
207 208 209 210 211 212 213
  /*
  ** About the usage of t().  We try to keep strings whole as much as
  ** possible and are unafraid of HTML markup within translation strings
  ** if necessary.  The suggested syntax for a link embedded within a
  ** translation string is for example:
  **
  ** $msg = t("You must login below or <a href=\"%url\">create a new
Dries's avatar
 
Dries committed
214 215
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
 
Dries committed
216 217
  */

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

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

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

  /*
  ** Note that we'd like to go 'htmlspecialchars($input, $quotes, "utf-8")'
  ** like the PHP manual tells us to, but we can't because there's a bug in
  ** PHP <4.3 that makes it mess up multibyte charsets if we specify the
  ** charset.  Change this later once we make PHP 4.3 a requirement.
  */

  return htmlspecialchars($input, $quotes);
Dries's avatar
 
Dries committed
238 239
}

240 241 242 243 244 245
/**
 * 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
246
function valid_email_address($mail) {
247 248 249 250 251 252 253 254 255 256 257 258 259
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
  $domain = '(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.?)+';
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

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

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

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

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

  /*
  ** Modules may implement the "search_item" hook in order to overwrite
  ** the default function to display search results.
  */

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

  return $output;
}

Kjartan's avatar
Kjartan committed
302 303 304 305
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
306
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
 
Dries committed
307 308
 * "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
309 310
 * parts of this form.
 *
Dries's avatar
 
Dries committed
311
 * @param $action  Form action. Defaults to 'site.com/search'.
Dries's avatar
 
Dries committed
312
 * @param $keys   string containing keywords for the search.
Dries's avatar
 
Dries committed
313
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
314 315
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
 
Dries committed
316
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
317 318

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

Dries's avatar
 
Dries committed
322 323
  $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
324 325 326 327 328 329 330

  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
331
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
332 333 334 335
      }
    }
  }

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

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

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

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

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

  return $output;
}

Kjartan's avatar
Kjartan committed
367 368 369
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
370
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
371
 *                 Otherwise, search all types.
Dries's avatar
 
Dries committed
372
 * @param $action  Form action. Defaults to 'site.com/search'.
373
 * @param $keys    Query string. Defaults to global $keys.
Dries's avatar
 
Dries committed
374
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
375 376
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
 
Dries committed
377
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
378

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

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

Dries's avatar
 
Dries committed
384

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

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

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

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

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

  exit();
}

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

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

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

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

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

447 448

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

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

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

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

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

Dries's avatar
 
Dries committed
466 467 468 469 470 471 472 473 474 475 476 477 478
  $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
479 480 481 482 483
      $text = module_invoke($name, "filter", $text);
    }
  }

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

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

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

  $end = substr($base_url, 12);

Dries's avatar
 
Dries committed
492 493 494
  /*
  ** 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
495 496
  ** (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
497 498 499
  ** and comment bodies.
  */

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

Dries's avatar
 
Dries committed
520
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
521 522 523
    $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
524 525
  }
  else {
Dries's avatar
 
Dries committed
526 527 528 529
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
    $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
550

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

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

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

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

571

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

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

  return $output;
}

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

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

  return $output;
}

Dries's avatar
 
Dries committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621
/**
 * 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
622
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
623
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
624 625 626
}

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

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

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

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

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

function format_name($object) {

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

Dries's avatar
 
Dries committed
721
  return $output;
Dries's avatar
 
Dries committed
722 723 724
}

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

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

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

Dries's avatar
 
Dries committed
736 737 738
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
739

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

744
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
Dries's avatar
 
Dries committed
745
  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
746 747
}

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

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

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

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

Dries's avatar
 
Dries committed
773 774 775 776 777
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
778
    return theme("form_element", $title, $output, $description);
Dries's avatar
 
Dries committed
779 780 781
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

function link_page() {
909
  global $custom_links;
Dries's avatar
 
Dries committed
910

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
950 951
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
Dries's avatar
 
Dries committed
952
  if ($path = drupal_get_normal_path(trim($_GET["q"], "/"))) {
Dries's avatar
 
Dries committed
953 954 955 956
    $_GET["q"] = $path;
  }
}
else {
Dries's avatar
 
Dries committed
957 958 959 960 961 962
  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
963 964
}

Dries's avatar
 
Dries committed
965 966 967
// initialize installed modules:
module_init();

Dries's avatar
 
Dries committed
968 969 970 971 972 973
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
974 975 976 977
// initialize localization system:
$locale = locale_init();

// initialize theme:
Dries's avatar
 
Dries committed
978
$theme = init_theme();
Dries's avatar
 
Dries committed
979

Dries's avatar
 
Dries committed
980
?>