common.inc 25.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.";
Dries's avatar
 
Dries committed
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
  }
}

Dries's avatar
 
Dries committed
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");
    }
  }
}

Dries's avatar
 
Dries committed
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>";
Dries's avatar
 
Dries committed
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;
}

Dries's avatar
 
Dries committed
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;

Dries's avatar
 
Dries committed
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
  }
Dries's avatar
 
Dries committed
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.");
}

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

Dries's avatar
 
Dries committed
136
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
137
  global $languages;
138

Dries's avatar
 
Dries committed
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")));
Dries's avatar
 
Dries committed
148 149
  */

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

Dries's avatar
 
Dries committed
152 153
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
154 155
  }
  else {
Dries's avatar
 
Dries committed
156 157
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
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])) {
Dries's avatar
 
Dries committed
164
      $conf[$variable->name] = unserialize($variable->value);
Dries's avatar
 
Dries committed
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;

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

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

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

  unset($conf[$name]);
}

Dries's avatar
 
Dries committed
194
function table_cell($cell, $header = 0) {
Dries's avatar
 
Dries committed
195
  if (is_array($cell)) {
Dries's avatar
 
Dries committed
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;
  }

Dries's avatar
 
Dries committed
207
  if ($header) {
Dries's avatar
 
Dries committed
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) {

Dries's avatar
 
Dries committed
219
  $output .= "<table>\n";
Dries's avatar
 
Dries committed
220 221 222 223 224

  /*
  ** Emit the table header:
  */

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

  /*
  ** Emit the table rows:
  */

Dries's avatar
 
Dries committed
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\">";
      }
Dries's avatar
 
Dries committed
245

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

Dries's avatar
 
Dries committed
253
  $output .= "</table>\n";
Dries's avatar
 
Dries committed
254 255 256 257

  return $output;
}

Kjartan's avatar
Kjartan committed
258 259 260 261
/**
 * 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
262
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
263 264 265
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
 
Dries committed
266
function search_item($item, $type) {
Dries's avatar
 
Dries committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280

  /*
  ** 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 />";
  }
Dries's avatar
 
Dries committed
281 282 283 284

  return $output;
}

Kjartan's avatar
Kjartan committed
285 286 287 288
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
289
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
 
Dries committed
290 291
 * "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
292 293
 * parts of this form.
 *
Dries's avatar
 
Dries committed
294
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
295
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
 
Dries committed
296
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
297 298
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
 
Dries committed
299 300 301 302
function search_form($action = 0, $query = 0, $options = 0) {
  global $keys;

  if (!$action) {
Dries's avatar
 
Dries committed
303
    $action = url("search");
Dries's avatar
 
Dries committed
304 305 306 307 308 309
  }

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

Kjartan's avatar
Kjartan committed
310 311
  $output .= " <br /><input type=\"text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
  $output .= " <input type=\"submit\" value=\"". t("Search") ."\" />\n";
Dries's avatar
 
Dries committed
312 313 314 315 316 317 318

  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
319
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
320 321 322 323
      }
    }
  }

Kjartan's avatar
Kjartan committed
324 325
  $form .= "<br />";

Dries's avatar
 
Dries committed
326 327 328 329
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
330 331
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
332 333 334
function search_data() {
  global $keys, $edit;

Dries's avatar
 
Dries committed
335
  if (isset($keys)) {
Dries's avatar
 
Dries committed
336 337
    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
338
        if ($name == "node" || $name == "comment") {
Dries's avatar
 
Dries committed
339
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
340 341
        }
        else {
Dries's avatar
 
Dries committed
342
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
343
        }
Dries's avatar
 
Dries committed
344 345 346 347 348
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
Kjartan's avatar
Kjartan committed
349
    if (!$output) {
Dries's avatar
 
Dries committed
350 351 352 353 354 355 356
      $output .= t("Your search yielded no results.");
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
357 358 359
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
360
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
361
 *                 Otherwise, search all types.
Dries's avatar
 
Dries committed
362
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
363
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
 
Dries committed
364
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
365 366
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
 
Dries committed
367 368 369
function search_type($type = 0, $action = 0, $query = 0, $options = 0) {
  global $edit;

Dries's avatar
 
Dries committed
370
  if (isset($type)) {
Dries's avatar
 
Dries committed
371 372 373 374 375 376
    $edit["type"][$type] = "on";
  }

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

Dries's avatar
 
Dries committed
377

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

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

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

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

  /*
  ** 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() {
Dries's avatar
 
Dries committed
419
  global $referer, $HTTP_REFERER;
Dries's avatar
 
Dries committed
420

Dries's avatar
 
Dries committed
421
  if (!strstr($HTTP_REFERER, request_uri())) {
Dries's avatar
 
Dries committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    $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
443
  return htmlspecialchars($text);
Dries's avatar
 
Dries committed
444 445
}

Dries's avatar
 
Dries committed
446
function check_query($text) {
Dries's avatar
 
Dries committed
447
  return addslashes($text);
Dries's avatar
 
Dries committed
448 449
}

Dries's avatar
 
Dries committed
450
function check_input($text) {
Dries's avatar
 
Dries committed
451
  return addslashes($text);
Dries's avatar
 
Dries committed
452 453 454
}

function filter($text) {
Dries's avatar
 
Dries committed
455 456 457 458 459 460 461 462

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

  return $text;
Dries's avatar
 
Dries committed
463 464
}

Dries's avatar
 
Dries committed
465 466 467 468 469
function rewrite_old_urls($text) {

  /*
  ** 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
470 471
  ** (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
472 473 474
  ** and comment bodies.
  */

Dries's avatar
 
Dries committed
475
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
476
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
477
    $text = eregi_replace("(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "?q=\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
478

Dries's avatar
 
Dries committed
479
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
480 481 482
    $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);
Dries's avatar
 
Dries committed
483 484 485
  }
  else {
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
 
Dries committed
486
    $text = eregi_replace("(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "\\1/view/\\2/\\4", $text);
Dries's avatar
 
Dries committed
487 488

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
 
Dries committed
489 490 491
    $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);
Dries's avatar
 
Dries committed
492
  }
Dries's avatar
 
Dries committed
493

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

Dries's avatar
 
Dries committed
497
function check_output($text) {
Dries's avatar
 
Dries committed
498
  if (isset($text)) {
Dries's avatar
 
Dries committed
499 500 501 502

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

Dries's avatar
 
Dries committed
503
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
 
Dries committed
504 505 506 507 508 509 510 511
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
 
Dries committed
512 513 514 515 516 517 518 519 520 521 522
}

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

Dries's avatar
 
Dries committed
523 524 525
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
526 527 528 529 530
  $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
531
  foreach ($args as $key => $value) {
532
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
533
  }
Dries's avatar
 
Dries committed
534 535 536 537 538 539
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
 
Dries committed
543 544 545
  $output .= "<item>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
 
Dries committed
546
  $output .= " <description>". htmlentities(check_output($description)) ."</description>\n";
Dries's avatar
 
Dries committed
547
  foreach ($args as $key => $value) {
548
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
549
  }
Dries's avatar
 
Dries committed
550 551 552 553 554
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
555 556 557 558 559 560 561 562 563 564 565 566 567 568
/**
 * 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
569
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
570
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
571 572 573
}

function format_size($size) {
Dries's avatar
 
Dries committed
574
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
575 576
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
577
    $suffix = t("KB");
Dries's avatar
 
Dries committed
578 579 580
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
581
    $suffix = t("MB");
Dries's avatar
 
Dries committed
582
  }
Dries's avatar
 
Dries committed
583
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
584 585
}

Dries's avatar
 
Dries committed
586
function cache_get($key) {
Dries's avatar
 
Dries committed
587 588 589
  $cache = db_fetch_object(db_query("SELECT data, created FROM cache WHERE cid = '%s'", $key));
  $created = $cache->created;
  return $cache->data ? $cache : 0;
Dries's avatar
 
Dries committed
590 591 592
}

function cache_set($cid, $data, $expire = 0) {
Dries's avatar
 
Dries committed
593
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
Dries's avatar
 
Dries committed
594
    db_query("UPDATE cache SET data = '%s', created = %d, expire = %d WHERE cid = '%s'", $data, time(), $expire, $cid);
Dries's avatar
 
Dries committed
595 596
  }
  else {
Dries's avatar
 
Dries committed
597
    db_query("INSERT INTO cache (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries's avatar
 
Dries committed
598
  }
Dries's avatar
 
Dries committed
599 600
}

Dries's avatar
 
Dries committed
601 602
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
 
Dries committed
603
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries's avatar
 
Dries committed
604 605 606 607
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s'", $cid);
  }
Dries's avatar
 
Dries committed
608 609
}

Dries's avatar
 
Dries committed
610 611 612 613 614 615 616
function cache_clear_old($cid = NULL) {
  if (empty($cid)) {
    db_query("DELETE FROM cache WHERE expire < ". time() ." AND expire > 0");
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s' AND expire < %s AND expire > 0", $cid, time());
  }
Dries's avatar
 
Dries committed
617 618 619
}

function page_set_cache() {
Dries's avatar
 
Dries committed
620
  global $user, $REQUEST_METHOD;
Dries's avatar
 
Dries committed
621 622

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
 
Dries committed
623
    if ($data = ob_get_contents()) {
Dries's avatar
 
Dries committed
624
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries's avatar
 
Dries committed
625 626 627 628
    }
  }
}

Dries's avatar
 
Dries committed
629
function page_get_cache() {
Dries's avatar
 
Dries committed
630
  global $user, $REQUEST_METHOD;
Dries's avatar
 
Dries committed
631 632

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
 
Dries committed
633
    if ($cache = cache_get(request_uri())) {
Dries's avatar
 
Dries committed
634
      cache_clear_old();
Dries's avatar
 
Dries committed
635 636 637
    }
    else {
      ob_start();
Dries's avatar
 
Dries committed
638 639
    }
  }
Dries's avatar
 
Dries committed
640

Dries's avatar
 
Dries committed
641
  return $cache;
Dries's avatar
 
Dries committed
642 643 644
}

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

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

Kjartan's avatar
Kjartan committed
659
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
 
Dries committed
660 661 662

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
663
      $date = date(variable_get("date_format_short", "m/d/Y - H:i"), $timestamp);
Dries's avatar
 
Dries committed
664 665
      break;
    case "medium":
666
      $date = date(variable_get("date_format_medium", "D, m/d/Y - H:i"), $timestamp);
Dries's avatar
 
Dries committed
667 668
      break;
    case "large":
669
      $date = date(variable_get("date_format_long", "l, F j, Y - H:i"), $timestamp);
Dries's avatar
 
Dries committed
670 671 672 673
      break;
    case "custom":
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
674
          $date = t(date($c, $timestamp)) . $date;
Dries's avatar
 
Dries committed
675
        }
676 677
        else if (strstr("AaBdgGhHiIjLmnrstTUWYyZz", $c)) {
          $date = date($c, $timestamp) . $date;
Dries's avatar
 
Dries committed
678 679
        }
        else {
Kjartan's avatar
Kjartan committed
680
          $date = $c.$date;
Dries's avatar
 
Dries committed
681 682 683 684
        }
      }
      break;
    default:
685
      $date = date(variable_get("date_format_medium", "l, m/d/Y - H:i"), $timestamp);
Dries's avatar
 
Dries committed
686 687 688 689 690 691 692
  }
  return $date;
}

function format_name($object) {

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

Dries's avatar
 
Dries committed
714
  return $output;
Dries's avatar
 
Dries committed
715 716 717
}

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

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

725
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0) {
726
  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
727 728 729 730 731 732 733 734 735 736 737 738 739 740
}

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

Dries's avatar
 
Dries committed
741
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
742
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
743
    foreach ($options as $key=>$choice) {
744
      $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
745
    }
Kjartan's avatar
Kjartan committed
746
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
 
Dries committed
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
  }
}

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
762 763 764 765 766 767 768 769
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
  for ($n = (-1*$delta); $n <= $delta; $n++) {
    $weights[$n] = $n;
  }

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

Dries's avatar
 
Dries committed
770
function url($url = NULL, $query = NULL) {
Dries's avatar
 
Dries committed
771
  global $base_url;
Dries's avatar
 
Dries committed
772

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

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

Dries's avatar
 
Dries committed
813 814 815 816
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Dries's avatar
 
Dries committed
817 818

  return "<a href=\"". url($url, $query) ."\" ". implode($t, " ") .">$text</a>";
Dries's avatar
 
Dries committed
819 820
}

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

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

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

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

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

function timer_start() {
  global $timer;
Dries's avatar
 
Dries committed
853 854
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
 
Dries committed
855 856
}

Dries's avatar
 
Dries committed
857 858 859 860 861
function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries's avatar
 
Dries committed
862 863 864 865 866 867 868 869
}

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

  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
870 871 872 873
    if ($cache = page_get_cache()) {
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
      header("Last-Modified: $date");
      header("ETag: \"$date\"");
874 875 876 877 878 879
      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
880 881 882 883 884 885
        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
886 887 888 889 890 891
      exit();
    }
  }
}

function page_footer() {
Dries's avatar
 
Dries committed
892

Dries's avatar
 
Dries committed
893
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
894
    page_set_cache();
Dries's avatar
 
Dries committed
895
  }
Dries's avatar
 
Dries committed
896 897 898 899

  // 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
900 901 902
}

unset($conf);
Dries's avatar
 
Dries committed
903

904 905
$config = conf_init();

Dries's avatar
 
Dries committed
906 907 908 909
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
910
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
911
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
912

913 914 915 916
if (!function_exists("xmlrpc_decode")) {
  include_once "includes/xmlrpc.inc";
}

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

Dries's avatar
 
Dries committed
920 921 922
// set error handler:
set_error_handler("error_handler");

Dries's avatar
 
Dries committed
923 924 925 926 927 928
// initialize localization system:
$locale = locale_init();

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

Dries's avatar
 
Dries committed
929 930 931
// initialize installed modules:
module_init();

Dries's avatar
 
Dries committed
932
?>