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

function conf_init() {
Dries's avatar
Dries committed
5
  global $HTTP_HOST, $PHP_SELF;
Dries's avatar
Dries committed
6 7 8 9 10 11 12

  /*
  ** Try finding a matching configuration file by stripping the website's
  ** URI from left to right.  If no configuration file is found, return a
  ** default value 'conf'.
  */

Dries's avatar
Dries committed
13 14 15
  $uri = $PHP_SELF;

  $file = strtolower(strtr($HTTP_HOST . substr($uri, 0, strrpos($uri, "/")), "/:", ".."));
Dries's avatar
Dries committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

  while (strlen($file) > 4) {
    if (file_exists("includes/$file.php")) {
      return $file;
    }
    else {
      $file = substr($file, strpos($file, ".") + 1);
    }
  }

  return "conf";
}

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.";
32
  if (($errno == 1 || $errno == 2 || $errno == 4 || $errno == 256) && error_reporting()) {
Dries's avatar
Dries committed
33
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
34
    print "<pre>$entry</pre>";
Dries's avatar
Dries committed
35 36 37
  }
}

38
function watchdog($type, $message, $link = NULL) {
Dries's avatar
Dries committed
39
  global $user;
Dries's avatar
Dries committed
40
  db_query("INSERT INTO watchdog (uid, type, message, link, location, hostname, timestamp) VALUES ('%d', '%s', '%s', '%s', '%s', '%s', '%s')", $user->uid, $type, $message, $link, request_uri(), getenv("REMOTE_ADDR"), time());
Dries's avatar
Dries committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
    if ($throttle = db_fetch_object(db_query("SELECT * FROM watchdog WHERE type = '$type' AND hostname = '". getenv("REMOTE_ADDR") ."' AND ". time() ." - timestamp < $rate"))) {
      watchdog("warning", "throttle: '". getenv("REMOTE_ADDR") ."' exceeded submission rate - $throttle->type");
      die(message_throttle());
    }
    else {
      watchdog($type, "throttle");
    }
  }
}

55 56
function check_php_setting($name, $value) {
  if (ini_get($name) != $value) {
Steven Wittens's avatar
Steven Wittens committed
57
    print "<p>Note that the value of PHP's configuration option <code><b>$name</b></code> is incorrect.  It should be set to '$value' for Drupal to work properly.  Either configure your webserver to support <code>.htaccess</code> files so Drupal's <code>.htaccess</code> file can set it to the proper value, or edit your <code>php.ini</code> file directly.  This message will automatically dissapear when the problem has been fixed.</p>";
58 59 60
  }
}

Dries's avatar
Dries committed
61 62 63 64 65 66 67 68 69 70 71 72
function arg($index) {

  global $q;
  static $arguments;

  if (empty($arguments)) {
    $arguments = explode("/", $q);
  }

  return $arguments[$index];
}

Dries's avatar
Dries committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
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;
}

101
function request_uri() {
Dries's avatar
Dries committed
102 103 104 105
  // since request_uri() is only available on apache, we generate equivalent using other environment vars.

  global $REQUEST_URI, $PATH_INFO, $QUERY_STRING;

106
  if (isset($REQUEST_URI)) {
Dries's avatar
Dries committed
107 108 109
    return $REQUEST_URI;
  }
  else {
110
    return $PATH_INFO ."?". $QUERY_STRING;
Dries's avatar
Dries committed
111
  }
112 113
}

Dries's avatar
Dries committed
114
function message_access() {
Dries's avatar
Dries committed
115
  return t("You are not authorized to access this page.");
Dries's avatar
Dries committed
116 117 118 119 120 121 122 123 124 125
}

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

126 127
function locale_init() {
  global $languages, $user;
128 129 130 131 132 133
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
134 135
}

136
function t($string, $args = 0) {
137
  global $languages;
138

139 140 141 142 143 144 145
  /*
  ** 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
146 147
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
148 149
  */

150
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
151

152 153
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
154 155
  }
  else {
156 157
    return strtr($string, $args);
  }
158 159 160 161 162 163
}

function variable_init($conf = array()) {
  $result = db_query("SELECT * FROM variable");
  while ($variable = db_fetch_object($result)) {
    if (!isset($conf[$variable->name])) {
164
      $conf[$variable->name] = unserialize($variable->value);
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    }
  }

  return $conf;
}

function variable_get($name, $default, $object = 0) {
  global $conf;

  return isset($conf[$name]) ? $conf[$name] : $default;
}

function variable_set($name, $value) {
  global $conf;

180
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
181
  db_query("INSERT INTO variable (name, value) VALUES ('%s', '%s')", $name, serialize($value));
182 183 184 185 186 187 188

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

189
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
190 191 192 193

  unset($conf[$name]);
}

194
function table_cell($cell, $header = 0) {
195
  if (is_array($cell)) {
196 197 198 199 200 201 202 203 204 205 206
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

207
  if ($header) {
208 209 210 211 212 213 214 215 216 217 218
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

219
  $output = "<table>\n";
220 221 222 223 224

  /*
  ** Emit the table header:
  */

225 226 227 228 229
  if (is_array($header)) {
    $output .= " <tr>";
    foreach ($header as $cell) {
      $output .= table_cell($cell, 1);
    }
230
    $output .= " </tr>\n";
231 232 233 234 235 236
  }

  /*
  ** Emit the table rows:
  */

237 238 239 240 241 242 243 244
  if (is_array($rows)) {
    foreach ($rows as $number => $row) {
      if ($number % 2 == 1) {
        $output .= " <tr class=\"light\">";
      }
      else {
        $output .= " <tr class=\"dark\">";
      }
245

246 247 248
      foreach ($row as $cell) {
        $output .= table_cell($cell, 0);
      }
249
      $output .= " </tr>\n";
250 251 252
    }
  }

253
  $output .= "</table>\n";
254 255 256 257

  return $output;
}

258 259 260 261 262 263
/**
 * 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
 */
264
function valid_email_address($mail) {
265 266 267 268 269 270 271 272 273 274 275 276 277
  $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;
  }
}

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

  /*
  ** 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 {
    $output .= " <b>". $item["count"] ."&nbsp;&nbsp;<u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
    $output .= " <small>$type ". ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
    $output .= "<br /><br />";
  }
301 302 303 304

  return $output;
}

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

  if (!$action) {
Dries's avatar
Dries committed
323
    $action = url("search");
324 325 326 327 328 329
  }

  if (!$query) {
    $query = $keys;
  }

Kjartan's avatar
Kjartan committed
330 331
  $output .= " <br /><input type=\"text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
  $output .= " <input type=\"submit\" value=\"". t("Search") ."\" />\n";
332 333 334 335 336 337 338

  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
339
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
340 341 342 343
      }
    }
  }

Kjartan's avatar
Kjartan committed
344 345
  $form .= "<br />";

346 347 348 349
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
350 351
 * Collect the search results:
 */
352 353 354
function search_data() {
  global $keys, $edit;

355
  if (isset($keys)) {
356 357
    foreach (module_list() as $name) {
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", check_query($keys)))) {
Kjartan's avatar
Kjartan committed
358
        if ($name == "node" || $name == "comment") {
359
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
360 361
        }
        else {
362
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
363
        }
364 365 366 367 368
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
Kjartan's avatar
Kjartan committed
369
    if (!$output) {
370 371 372 373 374 375 376
      $output .= t("Your search yielded no results.");
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
377 378 379
/**
 * Display the search form and the resulting data.
 *
380
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
381
 *                 Otherwise, search all types.
Dries's avatar
Dries committed
382
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
383
 * @param $query   Query string. Defaults to global $keys.
384
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
385 386
 *                 ("Restrict search to", help text, etc).
 */
387 388 389
function search_type($type = 0, $action = 0, $query = 0, $options = 0) {
  global $edit;

390
  if (isset($type)) {
391 392 393 394 395 396
    $edit["type"][$type] = "on";
  }

  return search_form($action, $query, $options) . search_data();
}

397

Dries's avatar
Dries committed
398 399
function drupal_goto($url) {

400 401 402
  /*
  ** Translate &amp; to simply &
  */
403

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

Dries's avatar
Dries committed
406 407 408 409 410
  /*
  ** 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".
  */
411
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
Dries committed
412 413 414
    header("Location: $url");
  }
  else {
415 416 417 418 419 420 421 422
    $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
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
  ** deamon.  In some cases this can go wrong, so we make sure none
  ** of the code /below/ gets executed when we redirect.
  */

  exit();
}

/*
** Stores the referer in a persistent variable:
*/

function referer_save() {
439
  global $referer, $HTTP_REFERER;
Dries's avatar
Dries committed
440

441
  if (!strstr($HTTP_REFERER, request_uri())) {
Dries's avatar
Dries committed
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
    $referer = $HTTP_REFERER;
    session_register("referer");
  }
}

/*
** Restores the referer from a persistent variable:
*/

function referer_load() {
  global $referer;

  if (session_is_registered("referer")) {
    return $referer;
  }
  else {
    return 0;
  }
}

function check_form($text) {
Dries's avatar
Dries committed
463
  return htmlspecialchars($text);
Dries's avatar
Dries committed
464 465
}

466
function check_query($text) {
Dries's avatar
Dries committed
467
  return addslashes($text);
Dries's avatar
Dries committed
468 469
}

470
function check_input($text) {
Dries's avatar
Dries committed
471
  return addslashes($text);
Dries's avatar
Dries committed
472 473 474
}

function filter($text) {
475 476 477 478 479 480 481 482

  foreach (module_list() as $name) {
    if (module_hook($name, "filter")) {
      $text = module_invoke($name, "filter", $text);
    }
  }

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

485 486
function rewrite_old_urls($text) {

487 488 489 490
  global $base_url;

  $end = substr($base_url, 12);

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

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

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

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

    /*
    ** Absolute URLs:
    */

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

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

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

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

    /*
    ** Absolute URLs:
    */

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

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

550 551 552
  return $text;
}

553
function check_output($text) {
554
  if (isset($text)) {
555 556 557 558

    // temporary: for development purpose
    $text = rewrite_old_urls($text);

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

  return $text;
Dries's avatar
Dries committed
568 569 570 571 572 573 574 575 576 577 578
}

function check_file($filename) {
  if (is_uploaded_file($filename)) {
    return 1;
  }
  else {
    return 0;
  }
}

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

  return $output;
}

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

Dries's avatar
Dries committed
599 600 601
  $output .= "<item>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
602
  $output .= " <description>". htmlentities(check_output($description)) ."</description>\n";
Dries's avatar
Dries committed
603
  foreach ($args as $key => $value) {
604
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
Dries committed
605
  }
Dries's avatar
Dries committed
606 607 608 609 610
  $output .= "</item>\n";

  return $output;
}

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

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

642
function cache_get($key) {
643
  $cache = db_fetch_object(db_query("SELECT data, created FROM cache WHERE cid = '%s'", $key));
Dries's avatar
Dries committed
644
  return $cache->data ? $cache : 0;
645 646 647
}

function cache_set($cid, $data, $expire = 0) {
648 649
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
    db_query("UPDATE cache SET data = '%s', created = %d, expire = %d WHERE cid = '%s'", $data, time(), $expire, $cid);
650 651
  }
  else {
Dries's avatar
Dries committed
652
    db_query("INSERT INTO cache (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
653
  }
Dries's avatar
Dries committed
654 655
}

Dries's avatar
Dries committed
656 657
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
658
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries's avatar
Dries committed
659 660
  }
  else {
Dries's avatar
Dries committed
661
    db_query("DELETE FROM cache WHERE cid = '%d'", $cid);
Dries's avatar
Dries committed
662
  }
663 664 665
}

function page_set_cache() {
666
  global $user, $REQUEST_METHOD;
Dries's avatar
Dries committed
667 668

  if (!$user->uid && $REQUEST_METHOD == "GET") {
669
    if ($data = ob_get_contents()) {
Dries's avatar
Dries committed
670
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries's avatar
Dries committed
671 672 673 674
    }
  }
}

675
function page_get_cache() {
676
  global $user, $REQUEST_METHOD;
Dries's avatar
Dries committed
677 678

  if (!$user->uid && $REQUEST_METHOD == "GET") {
679 680 681
    $cache = cache_get(request_uri());

    if (empty($cache)) {
682
      ob_start();
Dries's avatar
Dries committed
683 684
    }
  }
685

Dries's avatar
Dries committed
686
  return $cache;
Dries's avatar
Dries committed
687 688 689
}

function format_interval($timestamp) {
690
  $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
691
  foreach ($units as $key=>$value) {
Dries's avatar
Dries committed
692 693 694 695 696 697
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
698
  return ($output) ? $output : t("0 sec");
Dries's avatar
Dries committed
699 700 701 702 703
}

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

Kjartan's avatar
Kjartan committed
704
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
Dries committed
705 706 707

  switch ($type) {
    case "small":
708
      $date = date(variable_get("date_format_short", "m/d/Y - H:i"), $timestamp);
Dries's avatar
Dries committed
709 710
      break;
    case "medium":
711
      $date = date(variable_get("date_format_medium", "D, m/d/Y - H:i"), $timestamp);
Dries's avatar
Dries committed
712 713
      break;
    case "large":
714
      $date = date(variable_get("date_format_long", "l, F j, Y - H:i"), $timestamp);
Dries's avatar
Dries committed
715 716 717 718
      break;
    case "custom":
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
719
          $date = t(date($c, $timestamp)) . $date;
Dries's avatar
Dries committed
720
        }
721
        else if (strstr("AaBdgGhHiIjLmnOrstTUWYyZz", $c)) {
722
          $date = date($c, $timestamp) . $date;
Dries's avatar
Dries committed
723 724
        }
        else {
Kjartan's avatar
Kjartan committed
725
          $date = $c.$date;
Dries's avatar
Dries committed
726 727 728 729
        }
      }
      break;
    default:
730
      $date = date(variable_get("date_format_medium", "l, m/d/Y - H:i"), $timestamp);
Dries's avatar
Dries committed
731 732 733 734 735 736 737
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
738
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
739
      $output = l($object->name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
740 741
    }
    else {
Dries's avatar
Dries committed
742
      $output = l($object->name, "user/view/$object->uid", array("title" => t("View user profile.")));
743
    }
Dries's avatar
Dries committed
744
  }
745 746 747 748 749 750 751 752 753 754
  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
755
  else {
756
    $output = t(variable_get(anonymous, "Anonymous"));
Dries's avatar
Dries committed
757 758
  }

759
  return $output;
Dries's avatar
Dries committed
760 761 762
}

function form($form, $method = "post", $action = 0, $options = 0) {
763
  return "<form action=\"". ($action ? $action : htmlentities(request_uri())) ."\" method=\"$method\"". ($options ? " $options" : "") .">\n$form</form>\n";
Dries's avatar
Dries committed
764 765 766
}

function form_item($title, $value, $description = 0) {
767
  return "<p>". ($title ? "<b>$title:</b><br />" : "") . $value . ($description ? "<br /><small><i>$description</i></small>" : "") ."</p>\n";
Dries's avatar
Dries committed
768 769
}

770 771 772 773
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0) {
  return form_item(0, "<input type=\"radio\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
}

774
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0) {
775
  return form_hidden($name, 0) . form_item(0, "<input type=\"checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
Dries's avatar
Dries committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789
}

function form_textfield($title, $name, $value, $size, $maxlength, $description = 0) {
  return form_item($title, "<input maxlength=\"$maxlength\" name=\"edit[$name]\" size=\"$size\" value=\"". check_form($value) ."\" />", $description);
}

function form_password($title, $name, $value, $size, $maxlength, $description = 0) {
  return form_item($title, "<input type=\"password\" maxlength=\"$maxlength\" name=\"edit[$name]\" size=\"$size\" value=\"". check_form($value) ."\" />", $description);
}

function form_textarea($title, $name, $value, $cols, $rows, $description = 0) {
  return form_item($title, "<textarea wrap=\"virtual\" cols=\"$cols\" rows=\"$rows\" name=\"edit[$name]\">". check_form($value) ."</textarea>", $description);
}

790
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
Dries committed
791
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
792
    foreach ($options as $key=>$choice) {
793
      $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($value == $key ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
794
    }
Kjartan's avatar
Kjartan committed
795
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
Dries committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
  }
}

function form_file($title, $name, $size, $description = 0) {
  return form_item($title, "<input type=\"file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
}

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

function form_submit($value) {
  return "<input type=\"submit\" name=\"op\" value=\"". check_form($value) ."\" />\n";
}

Dries's avatar
Dries committed
811
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
Dries committed
812
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
Dries committed
813 814 815 816 817 818
    $weights[$n] = $n;
  }

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

819
function url($url = NULL, $query = NULL) {
Dries's avatar
Dries committed
820
  global $base_url;
821

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

Dries's avatar
Dries committed
860
function l($text, $url, $attributes = array(), $query = NULL) {
861

Dries's avatar
Dries committed
862 863 864 865
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Dries's avatar
Dries committed
866 867

  return "<a href=\"". url($url, $query) ."\" ". implode($t, " ") .">$text</a>";
868 869
}

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

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

function link_page() {
Dries's avatar
Dries committed
884
  global $custom_links, $base_url;
885

886 887 888 889
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
890
    $links = module_invoke_all("link", "page");
891
    array_unshift($links, "<a href=\"$base_url/\" title=\"". t("Return to the main page.") ."\">". t("home") ."</a>");
892
    return $links;
Dries's avatar
Dries committed
893
  }
894
}
Dries's avatar
Dries committed
895 896

function link_node($node, $main = 0) {
897
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
Dries committed
898 899 900 901
}

function timer_start() {
  global $timer;
Dries's avatar
Dries committed
902 903
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
Dries committed
904 905
}

906 907 908 909 910
function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries's avatar
Dries committed
911 912 913 914 915 916 917 918
}

function page_header() {
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }

  if (variable_get("cache", 0)) {
Dries's avatar
Dries committed
919 920 921 922
    if ($cache = page_get_cache()) {
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
      header("Last-Modified: $date");
      header("ETag: \"$date\"");
923 924 925 926 927 928
      if (function_exists("getallheaders") && $headers = getallheaders()) {
        /*
        ** Notice that the above is an optional Apache-ism so for the
        ** time being we don't send 304 headers when "getallheaders()"
        ** is not supported (eg. on IIS webservers).
        */
Dries's avatar
Dries committed
929 930 931 932 933 934
        if ($headers["If-Modified-Since"] == $date && $headers["If-None-Match"] == "\"$date\"") {
          header("HTTP/1.0 304 Not Modified");
          exit();
        }
      }
      print $cache->data;
Dries's avatar
Dries committed
935 936 937 938 939 940
      exit();
    }
  }
}

function page_footer() {
941

Dries's avatar
Dries committed
942
  if (variable_get("cache", 0)) {
943
    page_set_cache();
Dries's avatar
Dries committed
944
  }
945 946 947 948

  // a hook for modules where modules may take action at the end of a request
  // good uses include setting a cache, page logging, etc.
  module_invoke_all("exit");
Dries's avatar
Dries committed
949 950 951
}

unset($conf);
952

953 954
$config = conf_init();

Dries's avatar
Dries committed
955 956 957 958
include_once "includes/$config.php";
include_once "includes/database.inc";
include_once "includes/module.inc";
include_once "includes/theme.inc";
Dries's avatar
Dries committed
959
include_once "includes/pager.inc";
960
include_once "includes/menu.inc";
Dries's avatar
Dries committed
961

962 963 964 965
if (!function_exists("xmlrpc_decode")) {
  include_once "includes/xmlrpc.inc";
}

966 967
// initialize configuration variables, using values from conf.php if available:
$conf = variable_init(isset($conf) ? $conf : array());
Dries's avatar
Dries committed
968

969 970 971
// set error handler:
set_error_handler("error_handler");

972 973 974
// initialize installed modules:
module_init();

Dries's avatar
Dries committed
975 976 977 978 979 980
// initialize localization system:
$locale = locale_init();

// initialize theme:
$theme = theme_init();

981
?>