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

Dries's avatar
 
Dries committed
4
/**
Dries's avatar
 
Dries committed
5 6 7 8 9
 * @name drupal_title
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries's avatar
 
Dries committed
10 11 12 13
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
 
Dries committed
14
    $stored_title = ucfirst($title);
Dries's avatar
 
Dries committed
15 16 17 18 19 20 21 22 23 24 25 26 27
  }
  return $stored_title;
}

function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}
28
// @}
Dries's avatar
 
Dries committed
29

Dries's avatar
 
Dries committed
30
/**
Dries's avatar
 
Dries committed
31 32 33 34 35
 * @name drupal_message
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries's avatar
 
Dries committed
36
function drupal_set_message($message = NULL, $type = "status") {
Dries's avatar
 
Dries committed
37
  static $stored_message = array();
Dries's avatar
 
Dries committed
38 39

  if (isset($message)) {
Dries's avatar
 
Dries committed
40
    $stored_message[] = array($message, $type);
Dries's avatar
 
Dries committed
41 42 43 44 45
  }

  return $stored_message;
}

Dries's avatar
 
Dries committed
46
function drupal_get_messages() {
Dries's avatar
 
Dries committed
47 48 49 50
  return drupal_set_message();
}
// @}

Dries's avatar
 
Dries committed
51
/**
Dries's avatar
 
Dries committed
52 53 54 55 56 57 58 59
 * @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
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
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;
}
79
// @}
Dries's avatar
 
Dries committed
80

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

Dries's avatar
 
Dries committed
87 88 89 90
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

Dries's avatar
 
Dries committed
101 102 103 104
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries's avatar
 
Dries committed
105 106
function drupal_not_found() {
  header("HTTP/1.0 404 Not Found");
Dries's avatar
Dries committed
107
  watchdog("httpd", "404 error: '". check_query($_GET["q"]) ."' not found");
Dries's avatar
 
Dries committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

  $path = drupal_get_normal_path(variable_get('site_404', ''));

  if ($path) {
    menu_set_active_item($path);
  }

  if ($path && menu_active_handler_exists()) {
    menu_execute_active_handler();
  }
  else {
    print theme("page", '<h1>'. t('Page not found') .'</h1>');
  }
}

Dries's avatar
 
Dries committed
123 124 125
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
126 127

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
 
Dries committed
128
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
129 130 131
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
 
Dries committed
132 133 134 135 136
  }
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Kjartan's avatar
Kjartan committed
137 138
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '%s' AND hostname = '%s' AND %d - timestamp < %d", $type, $_SERVER['REMOTE_ADDR'], time(), $rate))) {
      watchdog("warning", "throttle: '". $_SERVER['REMOTE_ADDR'] ."' exceeded submission rate - $throttle->type");
Dries's avatar
 
Dries committed
139 140 141 142 143
      die(message_throttle());
    }
  }
}

Dries's avatar
Dries committed
144 145
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
146 147 148
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
149
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
150 151 152
  }
}

Dries's avatar
 
Dries committed
153 154
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
155
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
156 157 158 159 160 161
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
Dries's avatar
 
Dries committed
162 163
}

Dries's avatar
Dries committed
164 165 166
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
167 168 169 170
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
171
    $object = $array;
Dries's avatar
 
Dries committed
172 173 174 175 176
  }

  return $object;
}

Dries's avatar
Dries committed
177 178 179
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
180 181 182 183
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
184
    $array = $object;
Dries's avatar
 
Dries committed
185 186 187 188 189
  }

  return $array;
}

Dries's avatar
 
Dries committed
190
function message_access() {
Dries's avatar
 
Dries committed
191
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
192 193 194 195 196 197 198 199 200 201
}

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
202 203
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
204 205 206 207 208 209
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
210 211
}

Dries's avatar
 
Dries committed
212
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
213
  global $languages;
214

Dries's avatar
 
Dries committed
215 216 217 218 219 220 221
  /*
  ** 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
222 223
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
 
Dries committed
224 225
  */

226
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
227

Dries's avatar
 
Dries committed
228 229
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
230 231
  }
  else {
Dries's avatar
 
Dries committed
232 233
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
234 235
}

Dries's avatar
 
Dries committed
236
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
237 238 239 240 241 242 243 244 245

  /*
  ** 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
246 247
}

248
/**
Dries's avatar
 
Dries committed
249 250
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
251
 *
Dries's avatar
 
Dries committed
252
 * @param $mail a email address
253
 */
Dries's avatar
 
Dries committed
254
function valid_email_address($mail) {
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}';

Dries's avatar
Dries committed
260
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
261 262
}

Dries's avatar
 
Dries committed
263 264 265
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
266
 * @param $url an URL
Dries's avatar
 
Dries committed
267 268
 */
function valid_url($url) {
Dries's avatar
Dries committed
269
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
Dries's avatar
 
Dries committed
270 271
}

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

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

  return $output;
}

Kjartan's avatar
Kjartan committed
299 300 301 302
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
303 304 305
 * 'site.com/search', but also as a simple seach box (without "Restrict search
 * to", help text, etc) from theme's header etc. This means: provide options to
 * only conditionally render certain parts of this form.
Kjartan's avatar
Kjartan committed
306
 *
Dries's avatar
 
Dries committed
307 308 309 310
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys string containing keywords for the search.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
311
 */
Dries's avatar
 
Dries committed
312
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
313 314
  $edit = $_POST['edit'];

Dries's avatar
 
Dries committed
315
  if (!$action) {
Dries's avatar
 
Dries committed
316
    $action = url("search");
Dries's avatar
 
Dries committed
317 318
  }

Dries's avatar
Dries committed
319
  $output = " <br /><input type=\"text\" class=\"form-text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
Dries's avatar
 
Dries committed
320
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries's avatar
 
Dries committed
321

Dries's avatar
Dries committed
322
  if ($options) {
Dries's avatar
 
Dries committed
323 324 325 326 327
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
328
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
329 330 331 332
      }
    }
  }

Kjartan's avatar
Kjartan committed
333 334
  $form .= "<br />";

Dries's avatar
 
Dries committed
335 336 337 338
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
339 340
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
341
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
342
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
343

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

  return $output;
}

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

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

Dries's avatar
 
Dries committed
379

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

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

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

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

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

  exit();
}

Dries's avatar
 
Dries committed
416
function valid_input_data($data) {
417
  if (is_array($data) || is_object($data)) {
418 419 420 421 422
    /*
    ** Form data can contain a number of nested arrays.
    */

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

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

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

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

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

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

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

457 458
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
459 460
}

Dries's avatar
 
Dries committed
461 462 463
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
464
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
465 466 467 468
  $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
469
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
470
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
471
  }
Dries's avatar
 
Dries committed
472 473 474 475 476 477
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
481
  $output = "<item>\n";
Dries's avatar
 
Dries committed
482 483 484
  $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
485
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
486
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
487
  }
Dries's avatar
 
Dries committed
488 489 490 491 492
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
493 494
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
495 496
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
497
 *
Dries's avatar
 
Dries committed
498 499 500 501 502 503 504
 * @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
505
 */
Dries's avatar
 
Dries committed
506
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
507
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
508 509 510
}

function format_size($size) {
Dries's avatar
 
Dries committed
511
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
512 513
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
514
    $suffix = t("KB");
Dries's avatar
 
Dries committed
515 516 517
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
518
    $suffix = t("MB");
Dries's avatar
 
Dries committed
519
  }
Dries's avatar
 
Dries committed
520
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
521 522 523
}

function format_interval($timestamp) {
Dries's avatar
 
Dries committed
524
  $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);
Dries's avatar
 
Dries committed
525
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
526 527 528 529 530 531
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
 
Dries committed
532
  return ($output) ? $output : t("0 sec");
Dries's avatar
 
Dries committed
533 534 535 536 537
}

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

Kjartan's avatar
Kjartan committed
538
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
 
Dries committed
539 540 541

  switch ($type) {
    case "small":
Dries's avatar
 
Dries committed
542
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
 
Dries committed
543 544
      break;
    case "large":
Dries's avatar
 
Dries committed
545
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
 
Dries committed
546 547
      break;
    case "custom":
Dries's avatar
 
Dries committed
548
      // No change to format
Dries's avatar
 
Dries committed
549
      break;
Dries's avatar
 
Dries committed
550
    case "medium":
Dries's avatar
 
Dries committed
551
    default:
Dries's avatar
 
Dries committed
552 553 554 555 556 557 558 559 560 561 562 563 564
      $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
565 566 567 568 569 570 571
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
572 573 574 575 576 577 578 579 580 581 582 583
    /*
    ** 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
584
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
585
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
586 587
    }
    else {
Dries's avatar
Dries committed
588
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
589
    }
Dries's avatar
 
Dries committed
590
  }
Dries's avatar
 
Dries committed
591 592 593 594 595 596 597 598 599 600
  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
601
  else {
Dries's avatar
 
Dries committed
602
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
603 604
  }

Dries's avatar
 
Dries committed
605
  return $output;
Dries's avatar
 
Dries committed
606 607 608
}

function form($form, $method = "post", $action = 0, $options = 0) {
Dries's avatar
 
Dries committed
609
  if (!$action) {
610
    $action = request_uri();
Dries's avatar
 
Dries committed
611
  }
612
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
613 614
}

Dries's avatar
 
Dries committed
615 616
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
 
Dries committed
617
}
Dries's avatar
 
Dries committed
618

Dries's avatar
 
Dries committed
619
function form_group($legend, $group, $description = NULL) {
Dries's avatar
 
Dries committed
620 621
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries's avatar
 
Dries committed
622

Dries's avatar
 
Dries committed
623
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
624
  return theme("form_element", NULL, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
 
Dries committed
625 626 627 628 629
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
Dries's avatar
 
Dries committed
630
      $choices .= "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice<br />";
Dries's avatar
 
Dries committed
631
    }
Dries's avatar
 
Dries committed
632
    return theme("form_element", $title, $choices, $description);
Dries's avatar
 
Dries committed
633
  }
Dries's avatar
 
Dries committed
634 635
}

Dries's avatar
 
Dries committed
636
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
637
  return form_hidden($name, 0) . theme("form_element", NULL, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
 
Dries committed
638 639
}

Dries's avatar
 
Dries committed
640
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
641
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
642
  return theme("form_element", $title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
 
Dries committed
643 644
}

Dries's avatar
 
Dries committed
645
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
646
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
647
  return theme("form_element", $title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
 
Dries committed
648 649
}

Dries's avatar
 
Dries committed
650
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
651
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
652
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
653
  return theme("form_element", $title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"$name\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description, $name);
Dries's avatar
 
Dries committed
654 655
}

Dries's avatar
 
Dries committed
656
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
657 658
  foreach ($options as $key => $choice) {
    $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
659
  }
Dries's avatar
 
Dries committed
660
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name);
Dries's avatar
 
Dries committed
661 662
}

Dries's avatar
 
Dries committed
663 664
function form_file($title, $name, $size, $description = NULL) {
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" id=\"$name\" size=\"$size\" />\n", $description, $name);
Dries's avatar
 
Dries committed
665 666 667 668 669 670
}

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

Dries's avatar
 
Dries committed
671
function form_button($value, $name = "op", $type = "submit", $attributes = NULL) {
Dries's avatar
 
Dries committed
672 673 674
  return "<input type=\"$type\" class=\"form-$type\" name=\"$name\" value=\"". check_form($value) ."\" ". drupal_attributes($attributes) ." />\n";
}

Dries's avatar
 
Dries committed
675
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
 
Dries committed
676
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
 
Dries committed
677 678
}

Dries's avatar
 
Dries committed
679
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
 
Dries committed
680
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
681 682 683 684 685 686
    $weights[$n] = $n;
  }

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

Dries's avatar
 
Dries committed
687 688 689 690
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
 
Dries committed
691 692 693
/**
 * Given an old url, return the alias.
 */
Dries's avatar
 
Dries committed
694
function drupal_get_path_alias($path) {
Dries's avatar
 
Dries committed
695 696 697 698 699 700 701 702
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'outgoing');
  }
  else {
    return $path;
Dries's avatar
 
Dries committed
703
  }
Dries's avatar
 
Dries committed
704 705 706
}

/**
Dries's avatar
 
Dries committed
707
 * Given an alias, return the default url.
Dries's avatar
 
Dries committed
708
 */
Dries's avatar
 
Dries committed
709
function drupal_get_normal_path($path) {
Dries's avatar
 
Dries committed
710 711 712 713 714 715 716 717 718
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
Dries's avatar
 
Dries committed
719 720
}

Dries's avatar
 
Dries committed
721
function url($url = NULL, $query = NULL, $fragment = NULL) {
Dries's avatar
 
Dries committed
722
  global $base_url;
Dries's avatar
 
Dries committed
723

Dries's avatar
 
Dries committed
724 725 726 727 728 729 730 731 732 733 734
  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
735
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
736 737 738
    $url = $alias;
  }

Dries's avatar
 
Dries committed
739 740 741 742
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

Dries's avatar
 
Dries committed
743
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
744 745
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
746
        return "$base_url/$script?q=$url&amp;$query$fragment";
Dries's avatar
 
Dries committed
747 748
      }
      else {
Dries's avatar
 
Dries committed
749
        return "$base_url/$script?q=$url$fragment";
Dries's avatar
 
Dries committed
750
      }
Dries's avatar
 
Dries committed
751 752
    }
    else {
Dries's avatar
 
Dries committed
753
      if (isset($query)) {
Dries's avatar
 
Dries committed
754
        return "$base_url/$script?$query$fragment";
Dries's avatar
 
Dries committed
755 756
      }
      else {
Dries's avatar
 
Dries committed
757
        return "$base_url/$fragment";
Dries's avatar
 
Dries committed
758
      }
Dries's avatar
 
Dries committed
759 760 761
    }
  }
  else {
Dries's avatar
 
Dries committed
762 763
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
 
Dries committed
764
        return "$base_url/$url?$query$fragment";
Dries's avatar
 
Dries committed
765 766
      }
      else {
Dries's avatar
 
Dries committed
767
        return "$base_url/$url$fragment";
Dries's avatar
 
Dries committed
768
      }
Dries's avatar
 
Dries committed
769
    }
Dries's avatar
 
Dries committed
770
    else {
Dries's avatar
 
Dries committed
771
      if (isset($query)) {
Dries's avatar
 
Dries committed
772
        return "$base_url/$script?$query$fragment";
Dries's avatar
 
Dries committed
773 774
      }
      else {
Dries's avatar
 
Dries committed
775
        return "$base_url/$fragment";
Dries's avatar
 
Dries committed
776
      }
Dries's avatar
 
Dries committed
777
    }
Dries's avatar
 
Dries committed
778
  }
Dries's avatar
 
Dries committed
779 780
}

Dries's avatar
 
Dries committed
781
function drupal_attributes($attributes = NULL) {
782 783 784 785 786 787
  if (is_array($attributes)) {
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
    return " ". implode($t, " ");
Dries's avatar
 
Dries committed
788
  }
789
}
Dries's avatar
 
Dries committed
790

Dries's avatar
 
Dries committed
791 792
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL) {
  return "<a href=\"". url($url, $query, $fragment) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
793 794
}

Dries's avatar
 
Dries committed
795
function field_get($string, $name) {
796
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
 
Dries committed
797 798 799 800 801
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
 
Dries committed
802
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
803 804
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
 
Dries committed
805 806 807 808
  return substr($rval, 1);
}

function link_page() {
809
  global $custom_links;
Dries's avatar
 
Dries committed
810

811
  if (is_array($custom_links)) {
812 813 814
    return $custom_links;
  }
  else {
Dries's avatar
 
Dries committed
815
    $links = module_invoke_all("link", "page");
816
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
817
    return $links;
Dries's avatar
 
Dries committed
818
  }
Dries's avatar
 
Dries committed
819
}
Dries's avatar
 
Dries committed
820 821

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
822
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
823 824
}

Dries's avatar
 
Dries committed
825
function drupal_page_footer() {
Dries's avatar
 
Dries committed
826
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
827
    page_set_cache();
Dries's avatar
 
Dries committed
828
  }
Dries's avatar
 
Dries committed
829

Dries's avatar
 
Dries committed
830 831 832 833 834
  /*
  ** 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
835
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
836 837
}

838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
/**
 * Wrapper around xml_parser_create() which extracts the encoding from the XML
 * data first and sets the output encoding to UTF-8. This function should be
 * used instead of xml_parser_create(), because PHP's XML parser doesn't check
 * the input encoding itself.
 *
 * This is also where unsupported encodings should be converted.
 * Callers should take this into account: $data might have been changed after
 * the call.
 *
 * @param $data The XML data which will be parsed later.
 */
function drupal_xml_parser_create(&$data) {
  $encoding = 'utf-8';
  if (ereg('^<\?xml[^>]+encoding="([^"]+)"', $data, $match)) {
    $encoding = $match[1];
  }

  /*
   * Note: unsupported encodings will need to be converted here into UTF-8,
   * and $encoding set to 'utf-8'.
   */

  $xml_parser = xml_parser_create($encoding);
  xml_parser_set_option($xml_parser, XML_OPTION_TARGET_ENCODING, 'utf-8');
  return $xml_parser;
}

Dries's avatar
 
Dries committed
866
include_once "includes/theme.inc";
Dries's avatar
 
Dries committed
867
include_once "includes/pager.inc";
Dries's avatar
 
Dries committed
868
include_once "includes/menu.inc";
Dries's avatar
 
Dries committed
869
include_once "includes/xmlrpc.inc";
Dries's avatar
 
Dries committed
870
include_once "includes/tablesort.inc";
Dries's avatar
 
Dries committed
871
include_once "includes/file.inc";
872

Dries's avatar
 
Dries committed
873 874 875
// set error handler:
set_error_handler("error_handler");

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

Dries's avatar
 
Dries committed
879 880
// initialize the _GET["q"] prior to loading the modules and invoking their 'init' hook:
if (!empty($_GET["q"])) {
Dries's avatar
 
Dries committed
881
  $_GET["q"] = drupal_get_normal_path(trim($_GET["q"], "/"));
Dries's avatar
 
Dries committed
882 883
}
else {
Dries's avatar
 
Dries committed
884
  $_GET["q"] = drupal_get_normal_path(variable_get("site_frontpage", "node"));
Dries's avatar
 
Dries committed
885 886
}

Dries's avatar
 
Dries committed
887 888 889
// initialize installed modules:
module_init();

890
if ($_REQUEST && !user_access("bypass input data check")) {
Dries's avatar
 
Dries committed
891 892 893 894 895
  if (!valid_input_data($_REQUEST)) {
    die("terminated request because of suspicious input data");
  }
}

Dries's avatar
 
Dries committed
896 897 898 899
// initialize localization system:
$locale = locale_init();

// initialize theme:
Dries's avatar
 
Dries committed
900
$theme = init_theme();
Dries's avatar
 
Dries committed
901

Dries's avatar
 
Dries committed
902
?>