common.inc 30.9 KB
Newer Older
Dries's avatar
   
Dries committed
1
2
3
4
5
6
7
8
9
10
11
<?php
// $Id$

function conf_init() {

  /*
  ** 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
12
  $uri = $_SERVER["PHP_SELF"];
Dries's avatar
   
Dries committed
13

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

  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
31
32

  if ($errno & E_ALL ^ E_NOTICE) {
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', %d)", $user->uid, $type, $message, $link, request_uri(), getenv("REMOTE_ADDR"), time());
Dries's avatar
   
Dries committed
41
42
43
44
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries's avatar
   
Dries committed
45
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '$type' AND hostname = '". getenv("REMOTE_ADDR") ."' AND ". time() ." - timestamp < $rate"))) {
Dries's avatar
   
Dries committed
46
47
48
49
50
51
52
53
54
      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
function arg($index) {

  static $arguments;

  if (empty($arguments)) {
Dries's avatar
   
Dries committed
66
    $arguments = explode("/", $_GET["q"]);
Dries's avatar
   
Dries committed
67
68
69
70
71
  }

  return $arguments[$index];
}

Dries's avatar
   
Dries committed
72
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
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
100
101
102
103
104
105
106
107
108
function referer_uri() {

  if (isset($_SERVER["HTTP_REFERER"])) {
    $uri = $_SERVER["HTTP_REFERER"];

    return check_url($uri);
  }
}

Dries's avatar
   
Dries committed
109
function request_uri() {
Dries's avatar
   
Dries committed
110
111
112
113
  /*
  ** Since request_uri() is only available on Apache, we generate
  ** equivalent using other environment vars.
  */
Dries's avatar
   
Dries committed
114

Dries's avatar
   
Dries committed
115
  if (isset($_SERVER["REQUEST_URI"])) {
116
    $uri = $_SERVER["REQUEST_URI"];
Dries's avatar
   
Dries committed
117
118
  }
  else {
119
    $uri = $_SERVER["PHP_SELF"] ."?". $_SERVER["QUERY_STRING"];
Dries's avatar
   
Dries committed
120
  }
121

Dries's avatar
   
Dries committed
122
  return check_url($uri);
Dries's avatar
   
Dries committed
123
124
}

Dries's avatar
   
Dries committed
125
function message_access() {
Dries's avatar
   
Dries committed
126
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
127
128
129
130
131
132
133
134
135
136
}

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
137
138
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
139
140
141
142
143
144
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
145
146
}

Dries's avatar
   
Dries committed
147
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
148
  global $languages;
149

Dries's avatar
   
Dries committed
150
151
152
153
154
155
156
  /*
  ** 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
157
158
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
   
Dries committed
159
160
  */

161
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
162

Dries's avatar
   
Dries committed
163
164
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
165
166
  }
  else {
Dries's avatar
   
Dries committed
167
168
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
169
170
171
}

function variable_init($conf = array()) {
Dries's avatar
   
Dries committed
172
  $result = db_query("SELECT * FROM {variable} ");
Dries's avatar
   
Dries committed
173
174
  while ($variable = db_fetch_object($result)) {
    if (!isset($conf[$variable->name])) {
Dries's avatar
   
Dries committed
175
      $conf[$variable->name] = unserialize($variable->value);
Dries's avatar
   
Dries committed
176
177
178
179
180
181
    }
  }

  return $conf;
}

182
function variable_get($name, $default) {
Dries's avatar
   
Dries committed
183
184
185
186
187
188
189
190
  global $conf;

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

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

Dries's avatar
   
Dries committed
191
192
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries's avatar
   
Dries committed
193
194
195
196
197
198
199

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries's avatar
   
Dries committed
200
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
201
202
203
204

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
205
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
206
207
208
209
210
211
212
213
214

  /*
  ** 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
215
216
}

Dries's avatar
   
Dries committed
217
function table_cell($cell, $header = 0) {
Dries's avatar
   
Dries committed
218
  if (is_array($cell)) {
Dries's avatar
   
Dries committed
219
220
221
222
223
224
225
226
227
228
229
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

Dries's avatar
   
Dries committed
230
  if ($header) {
Dries's avatar
   
Dries committed
231
232
233
234
235
236
237
238
239
240
241
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

242
  $output = "<table>\n";
Dries's avatar
   
Dries committed
243
244
245
246
247

  /*
  ** Emit the table header:
  */

Dries's avatar
   
Dries committed
248
249
250
251
252
  if (is_array($header)) {
    $output .= " <tr>";
    foreach ($header as $cell) {
      $output .= table_cell($cell, 1);
    }
Dries's avatar
   
Dries committed
253
    $output .= " </tr>\n";
Dries's avatar
   
Dries committed
254
255
256
257
258
259
  }

  /*
  ** Emit the table rows:
  */

Dries's avatar
   
Dries committed
260
261
262
263
264
265
266
267
  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
268

Dries's avatar
   
Dries committed
269
270
271
      foreach ($row as $cell) {
        $output .= table_cell($cell, 0);
      }
Dries's avatar
   
Dries committed
272
      $output .= " </tr>\n";
Dries's avatar
   
Dries committed
273
274
275
    }
  }

Dries's avatar
   
Dries committed
276
  $output .= "</table>\n";
Dries's avatar
   
Dries committed
277
278
279
280

  return $output;
}

281
282
283
284
285
286
/**
 * Verify the syntax of the given e-mail address.  Empty e-mail addresses
 * are allowed.  See RFC 2822 for details.
 *
 * @param $mail  a email address
 */
Dries's avatar
   
Dries committed
287
function valid_email_address($mail) {
288
289
290
291
292
293
294
295
296
297
298
299
300
  $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
301
302
303
304
/**
 * 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
305
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
306
307
308
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
   
Dries committed
309
function search_item($item, $type) {
Dries's avatar
   
Dries committed
310
311
312
313
314
315
316
317
318
319

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

  if (module_hook($type, "search_item")) {
    $output = module_invoke($type, "search_item", $item);
  }
  else {
Dries's avatar
   
Dries committed
320
    $output .= " <b><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
Dries's avatar
   
Dries committed
321
322
323
    $output .= " <small>$type ". ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
    $output .= "<br /><br />";
  }
Dries's avatar
   
Dries committed
324
325
326
327

  return $output;
}

Kjartan's avatar
Kjartan committed
328
329
330
331
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
332
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
   
Dries committed
333
334
 * "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
335
336
 * parts of this form.
 *
Dries's avatar
   
Dries committed
337
 * @param $action  Form action. Defaults to 'site.com/search'.
Dries's avatar
   
Dries committed
338
 * @param $keys   string containing keywords for the search.
Dries's avatar
   
Dries committed
339
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
340
341
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries committed
342
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
343
344

  if (!$action) {
Dries's avatar
   
Dries committed
345
    $action = url("search");
Dries's avatar
   
Dries committed
346
347
  }

Kjartan's avatar
Kjartan committed
348
349
  $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
350
351
352
353
354
355
356

  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
357
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
358
359
360
361
      }
    }
  }

Kjartan's avatar
Kjartan committed
362
363
  $form .= "<br />";

Dries's avatar
   
Dries committed
364
365
366
367
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
368
369
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
370
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
371
372

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

Dries's avatar
   
Dries committed
374
  if (isset($keys)) {
Dries's avatar
   
Dries committed
375
376
    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
377
        if ($name == "node" || $name == "comment") {
Dries's avatar
   
Dries committed
378
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
379
380
        }
        else {
Dries's avatar
   
Dries committed
381
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
382
        }
Dries's avatar
   
Dries committed
383
384
385
386
387
388
389
390
391
392
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
393
394
395
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
396
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
397
 *                 Otherwise, search all types.
Dries's avatar
   
Dries committed
398
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
399
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
   
Dries committed
400
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
401
402
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries committed
403
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
404

Dries's avatar
   
Dries committed
405
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
406

Dries's avatar
   
Dries committed
407
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
408
409
}

Dries's avatar
   
Dries committed
410

Dries's avatar
   
Dries committed
411
412
function drupal_goto($url) {

Dries's avatar
   
Dries committed
413
414
415
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
   
Dries committed
416

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

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

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries's avatar
   
Dries committed
440
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries's avatar
   
Dries committed
441
442
443
444
445
446
447
448
449
450
451
  ** 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
452
453
  if (!strstr(referer_uri(), request_uri())) {
    $_SESSION["referer"] = referer_uri();
Dries's avatar
   
Dries committed
454
455
456
457
458
459
460
461
  }
}

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

function referer_load() {
Dries's avatar
   
Dries committed
462
463
  if (isset($_SESSION["referer"])) {
    return $_SESSION["referer"];
Dries's avatar
   
Dries committed
464
465
466
467
468
469
  }
  else {
    return 0;
  }
}

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
function xss_check_input_data($data) {

  if (is_array($data)) {
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
      xss_check_input_data($value);
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
486
    // check strings:
Dries's avatar
Dries committed
487
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
488
489
490
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

494
495

    // check tags:
Dries's avatar
   
Dries committed
496
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);
497
498
499
500
501
502
503

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
      die("terminated request because of suspicious input data");
    }
  }
}
Dries's avatar
   
Dries committed
504

505
function check_url($uri) {
Dries's avatar
   
Dries committed
506
507
508
509
510
511
512
513
514
515
516
517
  $uri = htmlspecialchars($uri, ENT_QUOTES);

  /*
  ** We replace ( and ) with their entity equivalents to prevent XSS
  ** attacks.
  */

  $uri = strtr($uri, array("(" => "&040;", ")" => "&041;"));

  return $uri;
}

Dries's avatar
   
Dries committed
518
function check_form($text) {
Dries's avatar
   
Dries committed
519
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
520
521
}

Dries's avatar
   
Dries committed
522
function check_query($text) {
Dries's avatar
   
Dries committed
523
  return addslashes($text);
Dries's avatar
   
Dries committed
524
525
526
}

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

Dries's avatar
   
Dries committed
528
529
530
531
532
533
534
535
536
537
538
539
540
  $modules = module_list();

  /*
  ** Make sure the HTML filters that are part of the node module
  ** are run first.
  */

  if (in_array("node", $modules)) {
    $text = module_invoke("node", "filter", $text);
  }

  foreach ($modules as $name) {
    if (module_hook($name, "filter") && $name != "node") {
Dries's avatar
   
Dries committed
541
542
543
544
545
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
   
Dries committed
546
547
}

Dries's avatar
   
Dries committed
548
549
function rewrite_old_urls($text) {

Dries's avatar
   
Dries committed
550
551
552
553
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
   
Dries committed
554
555
556
  /*
  ** 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
557
558
  ** (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
559
560
561
  ** and comment bodies.
  */

Dries's avatar
   
Dries committed
562
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
    /*
    ** 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
579
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
   
Dries committed
580
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
   
Dries committed
581

Dries's avatar
   
Dries committed
582
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
583
584
585
    $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
586
587
  }
  else {
Dries's avatar
   
Dries committed
588
589
590
591
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2/\\4/\\6", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2/\\4", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2", $text);

    /*
    ** Absolute URLs:
    */

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

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

Dries's avatar
   
Dries committed
613
614
615
  return $text;
}

Dries's avatar
   
Dries committed
616
function check_output($text) {
Dries's avatar
   
Dries committed
617
  if (isset($text)) {
Dries's avatar
   
Dries committed
618
619
620
621
    // filter content on output:
    $text = filter($text);

    // get the line breaks right:
Dries's avatar
   
Dries committed
622
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
   
Dries committed
623
624
625
626
627
628
629
630
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
   
Dries committed
631
632
633
634
635
636
637
638
639
640
641
}

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

Dries's avatar
   
Dries committed
642
643
644
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
645
  $output .= "<channel>\n";
Dries's avatar
   
Dries committed
646
647
648
649
  $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
650
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
651
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
652
  }
Dries's avatar
   
Dries committed
653
654
655
656
657
658
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
   
Dries committed
662
  $output .= "<item>\n";
Dries's avatar
   
Dries committed
663
664
665
  $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
666
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
667
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
668
  }
Dries's avatar
   
Dries committed
669
670
671
672
673
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
674
675
676
677
678
679
680
681
682
683
684
685
686
687
/**
 * 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
688
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
689
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
690
691
692
}

function format_size($size) {
Dries's avatar
   
Dries committed
693
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
694
695
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
696
    $suffix = t("KB");
Dries's avatar
   
Dries committed
697
698
699
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
700
    $suffix = t("MB");
Dries's avatar
   
Dries committed
701
  }
Dries's avatar
   
Dries committed
702
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
703
704
}

Dries's avatar
   
Dries committed
705
function cache_get($key) {
Dries's avatar
   
Dries committed
706
  $cache = db_fetch_object(db_query("SELECT data, created FROM {cache} WHERE cid = '%s'", $key));
Dries's avatar
   
Dries committed
707
  return $cache->data ? $cache : 0;
Dries's avatar
   
Dries committed
708
709
710
}

function cache_set($cid, $data, $expire = 0) {
Dries's avatar
   
Dries committed
711
712
  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);
Dries's avatar
   
Dries committed
713
714
  }
  else {
Dries's avatar
   
Dries committed
715
    db_query("INSERT INTO {cache} (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries's avatar
   
Dries committed
716
  }
Dries's avatar
   
Dries committed
717
718
}

Dries's avatar
   
Dries committed
719
720
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
   
Dries committed
721
    db_query("DELETE FROM {cache} WHERE expire <> 0");
Dries's avatar
   
Dries committed
722
723
  }
  else {
Dries's avatar
   
Dries committed
724
    db_query("DELETE FROM {cache} WHERE cid = %d", $cid);
Dries's avatar
   
Dries committed
725
  }
Dries's avatar
   
Dries committed
726
727
728
}

function page_set_cache() {
Dries's avatar
   
Dries committed
729
  global $user;
Dries's avatar
   
Dries committed
730

Dries's avatar
   
Dries committed
731
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
732
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
733
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries's avatar
   
Dries committed
734
735
736
737
    }
  }
}

Dries's avatar
   
Dries committed
738
function page_get_cache() {
Dries's avatar
   
Dries committed
739
  global $user;
Dries's avatar
   
Dries committed
740

Dries's avatar
   
Dries committed
741
742
  $cache = NULL;

Dries's avatar
   
Dries committed
743
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
744
745
746
    $cache = cache_get(request_uri());

    if (empty($cache)) {
Dries's avatar
   
Dries committed
747
      ob_start();
Dries's avatar
   
Dries committed
748
749
    }
  }
Dries's avatar
   
Dries committed
750

Dries's avatar
   
Dries committed
751
  return $cache;
Dries's avatar
   
Dries committed
752
753
754
}

function format_interval($timestamp) {
Dries's avatar
   
Dries committed
755
  $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
756
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
757
758
759
760
761
762
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
   
Dries committed
763
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
764
765
766
767
768
}

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

Kjartan's avatar
Kjartan committed
769
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
770
771
772

  switch ($type) {
    case "small":
Dries's avatar
   
Dries committed
773
      $date = date(variable_get("date_format_short", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
774
775
      break;
    case "medium":
776
      $date = date(variable_get("date_format_medium", "D, m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
777
778
      break;
    case "large":
779
      $date = date(variable_get("date_format_long", "l, F j, Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
780
781
782
783
      break;
    case "custom":
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
784
          $date = t(date($c, $timestamp)) . $date;
Dries's avatar
   
Dries committed
785
        }
Kjartan's avatar
Kjartan committed
786
        else if (strstr("AaBdgGhHiIjLmnOrstTUWYyZz", $c)) {
787
          $date = date($c, $timestamp) . $date;
Dries's avatar
   
Dries committed
788
789
        }
        else {
Kjartan's avatar
Kjartan committed
790
          $date = $c.$date;
Dries's avatar
   
Dries committed
791
792
793
794
        }
      }
      break;
    default:
795
      $date = date(variable_get("date_format_medium", "l, m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
796
797
798
799
800
801
802
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
803
    if (arg(0) == "admin") {
Dries's avatar
   
Dries committed
804
      $output = l($object->name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
805
806
    }
    else {
Dries's avatar
   
Dries committed
807
      $output = l($object->name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
808
    }
Dries's avatar
   
Dries committed
809
  }
Dries's avatar
   
Dries committed
810
811
812
813
814
815
816
817
818
819
  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
820
  else {
Dries's avatar
   
Dries committed
821
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
822
823
  }

Dries's avatar
   
Dries committed
824
  return $output;
Dries's avatar
   
Dries committed
825
826
827
}

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

  if (!$action) {
830
    $action = request_uri();
Dries's avatar
   
Dries committed
831
  }
Dries's avatar
   
Dries committed
832
  return "<form action=\"$action\" method=\"$method\"". ($options ? " $options" : "") .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
833
834
835
}

function form_item($title, $value, $description = 0) {
Dries's avatar
   
Dries committed
836
  return "<div class=\"form-item\">". ($title ? "<div class=\"title\">$title:</div>" : "") . $value . ($description ? "<div class=\"description\">$description</div>" : "") ."</div>\n";
Dries's avatar
   
Dries committed
837
838
}

Dries's avatar
   
Dries committed
839
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0) {
840
  return form_item(0, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
Dries's avatar
   
Dries committed
841
842
}

843
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0) {
844
  return form_hidden($name, 0) . form_item(0, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
Dries's avatar
   
Dries committed
845
846
847
}

function form_textfield($title, $name, $value, $size, $maxlength, $description = 0) {
Dries's avatar
   
Dries committed
848
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
849
  return form_item($title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\" />", $description);
Dries's avatar
   
Dries committed
850
851
852
}

function form_password($title, $name, $value, $size, $maxlength, $description = 0) {
Dries's avatar
   
Dries committed
853
854
  $size = $size ? " size=\"$size\"" : "";
  return form_item($title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\" />", $description);
Dries's avatar
   
Dries committed
855
856
857
}

function form_textarea($title, $name, $value, $cols, $rows, $description = 0) {
Dries's avatar
   
Dries committed
858
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
859
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
   
Dries committed
860
  return form_item($title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"edit[$name]\">". check_form($value) ."</textarea>", $description);
Dries's avatar
   
Dries committed
861
862
}

Dries's avatar
   
Dries committed
863
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
864
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
865
    foreach ($options as $key=>$choice) {
866
      $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
867
    }
Kjartan's avatar
Kjartan committed
868
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
   
Dries committed
869
870
871
  }
}

Dries's avatar
   
Dries committed
872
873
874
875
876
877
878
879
880
function form_radios($title, $name, $value, $options, $description = 0) {
  if (count($options) > 0) {
    foreach ($options as $key=>$choice) {
      $output .= form_radio($choice, $name, $key, ($key == $value));
    }
    return form_item($title, $output, $description);
  }
}

Dries's avatar
   
Dries committed
881
function form_file($title, $name, $size, $description = 0) {
882
  return form_item($title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries's avatar
   
Dries committed
883
884
885
886
887
888
}

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

Dries's avatar
   
Dries committed
889
890
function form_submit($value, $name = "op") {
  return "<input type=\"submit\" class=\"form-submit\" name=\"$name\" value=\"". check_form($value) ."\" />\n";
Dries's avatar
   
Dries committed
891
892
}

Dries's avatar
   
Dries committed
893
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
   
Dries committed
894
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
895
896
897
898
899
900
    $weights[$n] = $n;
  }

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

Dries's avatar
   
Dries committed
901
902
903
904
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
   
Dries committed
905
function url($url = NULL, $query = NULL) {
Dries's avatar
   
Dries committed
906
  global $base_url;
Dries's avatar
   
Dries committed
907

Dries's avatar
   
Dries committed
908
909
910
911
912
913
914
915
916
917
918
  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
919
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
920
921
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
922
        return "$base_url/$script?q=$url&amp;$query";
Dries's avatar
   
Dries committed
923
924
      }
      else {
Dries's avatar
   
Dries committed
925
        return "$base_url/$script?q=$url";
Dries's avatar
   
Dries committed
926
      }
Dries's avatar
   
Dries committed
927
928
    }
    else {
Dries's avatar
   
Dries committed
929
      if (isset($query)) {
Dries's avatar
   
Dries committed
930
        return "$base_url/$script?$query";
Dries's avatar
   
Dries committed
931
932
      }
      else {
Dries's avatar
   
Dries committed
933
        return "$base_url/";
Dries's avatar
   
Dries committed
934
      }
Dries's avatar
   
Dries committed
935
936
937
    }
  }
  else {
Dries's avatar
   
Dries committed
938
939
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
940
        return "$base_url/$url?$query";
Dries's avatar
   
Dries committed
941
942
      }
      else {
Dries's avatar
   
Dries committed
943
        return "$base_url/$url";
Dries's avatar
   
Dries committed
944
      }
Dries's avatar
   
Dries committed
945
    }
Dries's avatar
   
Dries committed
946
    else {
Dries's avatar
   
Dries committed
947
      if (isset($query)) {
Dries's avatar
   
Dries committed
948
        return "$base_url/$script?$query";
Dries's avatar
   
Dries committed
949
950
      }
      else {
Dries's avatar
   
Dries committed
951
        return "$base_url/";
Dries's avatar
   
Dries committed
952
      }
Dries's avatar
   
Dries committed
953
    }
Dries's avatar
   
Dries committed
954
  }
Dries's avatar
   
Dries committed
955
956
}

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

Dries's avatar
   
Dries committed
959
960
961
962
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Dries's avatar
   
Dries committed
963
964

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

Dries's avatar
   
Dries committed
967
function field_get($string, $name) {
968
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
   
Dries committed
969
970
971
972
973
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
974
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
975
976
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
977
978
979
980
  return substr($rval, 1);
}

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

983
984
985
986
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
987
    $links = module_invoke_all("link", "page");
988
    array_unshift($links, "<a href=\"$base_url/\" title=\"". t("Return to the main page.") ."\">". t("home") ."</a>");
989
    return $links;
Dries's avatar
   
Dries committed
990
  }
Dries's avatar
   
Dries committed
991
}
Dries's avatar
   
Dries committed
992
993

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
994
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
   
Dries committed
995
996
997
998
}

function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
999
1000
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
1001
1002
}

Dries's avatar
   
Dries committed
1003
function drupal_page_header() {
1004

Dries's avatar
   
Dries committed
1005
1006
1007
1008
1009
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
1010
1011
1012
1013
    if ($cache = page_get_cache()) {
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
      header("Last-Modified: $date");
      header("ETag: \"$date\"");
1014
1015
1016
1017
1018
1019
      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
1020
1021
1022
1023
1024
1025
        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
1026
1027
1028
      exit();
    }
  }
Dries's avatar
   
Dries committed
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038

  /*
  ** Putting the check here avoids SQL query overhead in case we are
  ** serving cached pages.  The downside, however, is that the init
  ** hooks might use unchecked data.
  */

  if (!user_access("bypass input data check")) {
    xss_check_input_data($_REQUEST);
  }
Dries's avatar
   
Dries committed
1039
1040
}

Dries's avatar
   
Dries committed
1041
function drupal_page_footer() {
Dries's avatar
   
Dries committed
1042
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
1043
    page_set_cache();
Dries's avatar
   
Dries committed
1044
  }
Dries's avatar
   
Dries committed
1045
1046
1047
1048

  // 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
1049
1050
1051
}

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

1053
1054
$config = conf_init();

Dries's avatar
   
Dries committed
1055
1056
1057
1058
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
1059
include_once "includes/pager.inc";
Dries's avatar
   
Dries committed
1060
include_once "includes/menu.inc";
Dries's avatar
   
Dries committed
1061
include_once "includes/xmlrpc.inc";
1062

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

Dries's avatar
   
Dries committed
1066
1067
1068
// set error handler:
set_error_handler("error_handler");

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

Dries's avatar
   
Dries committed
1072
1073
1074
// initialize installed modules:
module_init();

Dries's avatar
   
Dries committed
1075
1076
1077
1078
1079
1080
// initialize localization system:
$locale = locale_init();

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

Dries's avatar
   
Dries committed
1081
?>