common.inc 33.1 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

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

  return "conf";
}

Dries's avatar
   
Dries committed
28
29
30
/**
 * Build the alias/path array
 */
Dries's avatar
   
Dries committed
31
function drupal_get_path_map($action = "") {
Dries's avatar
   
Dries committed
32
33

  static $cache;
Dries's avatar
   
Dries committed
34
35
  static $map;

Dries's avatar
   
Dries committed
36
37
  if ($action == "rebuild") {
    $map = NULL;
Dries's avatar
   
Dries committed
38
    $cache = 0;
Dries's avatar
   
Dries committed
39
40
  }

Dries's avatar
   
Dries committed
41
  if (!$cache) {
Dries's avatar
Dries committed
42
    $result = db_query("SELECT * FROM {path}");
Dries's avatar
   
Dries committed
43
    while ($data = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
44
      $map[$data->dst] = $data->src;
Dries's avatar
   
Dries committed
45
    }
Dries's avatar
   
Dries committed
46
47

    $cache = 1;
Dries's avatar
   
Dries committed
48
49
50
51
52
  }

  return $map;
}

Dries's avatar
   
Dries committed
53
54
55
56
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries's avatar
   
Dries committed
57
58
59
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
60
61

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
62
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
63
    print "<pre>$entry</pre>";
Dries's avatar
   
Dries committed
64
65
66
  }
}

Dries's avatar
   
Dries committed
67
function watchdog($type, $message, $link = NULL) {
Dries's avatar
   
Dries committed
68
  global $user;
Dries's avatar
   
Dries committed
69
  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
70
71
72
73
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries's avatar
   
Dries committed
74
    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
75
76
77
78
79
80
81
82
83
      watchdog("warning", "throttle: '". getenv("REMOTE_ADDR") ."' exceeded submission rate - $throttle->type");
      die(message_throttle());
    }
    else {
      watchdog($type, "throttle");
    }
  }
}

Dries's avatar
   
Dries committed
84
85
function check_php_setting($name, $value) {
  if (ini_get($name) != $value) {
Steven Wittens's avatar
Steven Wittens committed
86
    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
87
88
89
  }
}

Dries's avatar
   
Dries committed
90
91
92
93
94
function arg($index) {

  static $arguments;

  if (empty($arguments)) {
Dries's avatar
   
Dries committed
95
    $arguments = explode("/", $_GET["q"]);
Dries's avatar
   
Dries committed
96
97
98
99
100
  }

  return $arguments[$index];
}

Dries's avatar
   
Dries committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
129
130
131
132
133
134
135
136
137
function referer_uri() {

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

    return check_url($uri);
  }
}

Dries's avatar
   
Dries committed
138
function request_uri() {
Dries's avatar
   
Dries committed
139
140
141
142
  /*
  ** Since request_uri() is only available on Apache, we generate
  ** equivalent using other environment vars.
  */
Dries's avatar
   
Dries committed
143

Dries's avatar
   
Dries committed
144
  if (isset($_SERVER["REQUEST_URI"])) {
145
    $uri = $_SERVER["REQUEST_URI"];
Dries's avatar
   
Dries committed
146
147
  }
  else {
148
    $uri = $_SERVER["PHP_SELF"] ."?". $_SERVER["QUERY_STRING"];
Dries's avatar
   
Dries committed
149
  }
150

Dries's avatar
   
Dries committed
151
  return check_url($uri);
Dries's avatar
   
Dries committed
152
153
}

Dries's avatar
   
Dries committed
154
function message_access() {
Dries's avatar
   
Dries committed
155
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
156
157
158
159
160
161
162
163
164
165
}

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
166
167
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
168
169
170
171
172
173
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
174
175
}

Dries's avatar
   
Dries committed
176
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
177
  global $languages;
178

Dries's avatar
   
Dries committed
179
180
181
182
183
184
185
  /*
  ** 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
186
187
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
   
Dries committed
188
189
  */

190
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
191

Dries's avatar
   
Dries committed
192
193
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
194
195
  }
  else {
Dries's avatar
   
Dries committed
196
197
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
198
199
200
}

function variable_init($conf = array()) {
Dries's avatar
   
Dries committed
201
  $result = db_query("SELECT * FROM {variable} ");
Dries's avatar
   
Dries committed
202
203
  while ($variable = db_fetch_object($result)) {
    if (!isset($conf[$variable->name])) {
Dries's avatar
   
Dries committed
204
      $conf[$variable->name] = unserialize($variable->value);
Dries's avatar
   
Dries committed
205
206
207
208
209
210
    }
  }

  return $conf;
}

211
function variable_get($name, $default) {
Dries's avatar
   
Dries committed
212
213
214
215
216
217
218
219
  global $conf;

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

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

Dries's avatar
   
Dries committed
220
221
  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
222
223
224
225
226
227
228

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries's avatar
   
Dries committed
229
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
230
231
232
233

  unset($conf[$name]);
}

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

  /*
  ** 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
244
245
}

Dries's avatar
   
Dries committed
246
function table_cell($cell, $header = 0) {
Dries's avatar
   
Dries committed
247
  if (is_array($cell)) {
Dries's avatar
   
Dries committed
248
249
250
251
252
253
254
255
256
257
258
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

Dries's avatar
   
Dries committed
259
  if ($header) {
Dries's avatar
   
Dries committed
260
261
262
263
264
265
266
267
268
269
270
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

271
  $output = "<table>\n";
Dries's avatar
   
Dries committed
272
273
274
275
276

  /*
  ** Emit the table header:
  */

Dries's avatar
   
Dries committed
277
278
279
  if (is_array($header)) {
    $output .= " <tr>";
    foreach ($header as $cell) {
Dries's avatar
   
Dries committed
280
281
282
      if (is_array($cell) && $cell["field"]) {
        $cell = tablesort($cell, $header);
      }
Dries's avatar
   
Dries committed
283
284
      $output .= table_cell($cell, 1);
    }
Dries's avatar
   
Dries committed
285
    $output .= " </tr>\n";
Dries's avatar
   
Dries committed
286
287
288
289
290
291
  }

  /*
  ** Emit the table rows:
  */

Dries's avatar
   
Dries committed
292
293
294
295
296
297
298
299
  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
300

Dries's avatar
   
Dries committed
301
302
303
      foreach ($row as $cell) {
        $output .= table_cell($cell, 0);
      }
Dries's avatar
   
Dries committed
304
      $output .= " </tr>\n";
Dries's avatar
   
Dries committed
305
306
307
    }
  }

Dries's avatar
   
Dries committed
308
  $output .= "</table>\n";
Dries's avatar
   
Dries committed
309
310
311
312

  return $output;
}

313
314
315
316
317
318
/**
 * 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
319
function valid_email_address($mail) {
320
321
322
323
324
325
326
327
328
329
330
331
332
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
  $domain = '(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.?)+';
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

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

Dries's avatar
   
Dries committed
333
334
335
336
337
338
339
/**
 * Verify the syntax of the given URL.
 *
 * @param $url  an URL
 */
function valid_url($url) {

Dries's avatar
   
Dries committed
340
  if (preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url)) {
Dries's avatar
   
Dries committed
341
342
343
344
345
346
347
    return 1;
  }
  else {
    return 0;
  }
}

Kjartan's avatar
Kjartan committed
348
349
350
351
/**
 * 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
352
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
353
354
355
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
   
Dries committed
356
function search_item($item, $type) {
Dries's avatar
   
Dries committed
357
358
359
360
361
362
363
364
365
366

  /*
  ** 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
367
    $output .= " <b><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
Dries's avatar
   
Dries committed
368
369
370
    $output .= " <small>$type ". ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
    $output .= "<br /><br />";
  }
Dries's avatar
   
Dries committed
371
372
373
374

  return $output;
}

Kjartan's avatar
Kjartan committed
375
376
377
378
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
379
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
   
Dries committed
380
381
 * "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
382
383
 * parts of this form.
 *
Dries's avatar
   
Dries committed
384
 * @param $action  Form action. Defaults to 'site.com/search'.
Dries's avatar
   
Dries committed
385
 * @param $keys   string containing keywords for the search.
Dries's avatar
   
Dries committed
386
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
387
388
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries committed
389
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
390
391

  if (!$action) {
Dries's avatar
   
Dries committed
392
    $action = url("search");
Dries's avatar
   
Dries committed
393
394
  }

Kjartan's avatar
Kjartan committed
395
396
  $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
397
398
399
400
401
402
403

  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
404
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
405
406
407
408
      }
    }
  }

Kjartan's avatar
Kjartan committed
409
410
  $form .= "<br />";

Dries's avatar
   
Dries committed
411
412
413
414
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
415
416
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
417
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
418
419

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

Dries's avatar
   
Dries committed
421
  if (isset($keys)) {
Dries's avatar
   
Dries committed
422
    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
423
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan's avatar
Kjartan committed
424
        if ($name == "node" || $name == "comment") {
Dries's avatar
   
Dries committed
425
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
426
427
        }
        else {
Dries's avatar
   
Dries committed
428
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
429
        }
Dries's avatar
   
Dries committed
430
431
432
433
434
435
436
437
438
439
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
440
441
442
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
443
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
444
 *                 Otherwise, search all types.
Dries's avatar
   
Dries committed
445
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
446
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
   
Dries committed
447
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
448
449
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries committed
450
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
451

Dries's avatar
   
Dries committed
452
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
453

Dries's avatar
   
Dries committed
454
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
455
456
}

Dries's avatar
   
Dries committed
457

Dries's avatar
   
Dries committed
458
459
function drupal_goto($url) {

Dries's avatar
   
Dries committed
460
461
462
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
   
Dries committed
463

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

Dries's avatar
   
Dries committed
466
467
468
469
470
  /*
  ** 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
471
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
   
Dries committed
472
473
474
    header("Location: $url");
  }
  else {
Dries's avatar
   
Dries committed
475
476
477
478
479
480
481
482
    $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
483
484
485
486
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries's avatar
   
Dries committed
487
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries's avatar
   
Dries committed
488
489
490
491
492
493
494
495
496
497
498
  ** 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
499
500
  if (!strstr(referer_uri(), request_uri())) {
    $_SESSION["referer"] = referer_uri();
Dries's avatar
   
Dries committed
501
502
503
504
505
506
507
508
  }
}

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

function referer_load() {
Dries's avatar
   
Dries committed
509
510
  if (isset($_SESSION["referer"])) {
    return $_SESSION["referer"];
Dries's avatar
   
Dries committed
511
512
513
514
515
516
  }
  else {
    return 0;
  }
}

Dries's avatar
   
Dries committed
517
function valid_input_data($data) {
518

519
  if (is_array($data) || is_object($data)) {
520
521
522
523
524
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
   
Dries committed
525
526
527
      if (!valid_input_data($value)) {
        return 0;
      }
528
529
530
531
532
533
534
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
535
    // check strings:
Dries's avatar
Dries committed
536
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
537
538
539
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

543
544

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries's avatar
   
Dries committed
549
      return 0;
550
551
    }
  }
Dries's avatar
   
Dries committed
552
553

  return 1;
554
}
Dries's avatar
   
Dries committed
555

556
function check_url($uri) {
Dries's avatar
   
Dries committed
557
558
559
560
561
562
563
564
565
566
567
568
  $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
569
function check_form($text) {
Dries's avatar
   
Dries committed
570
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
571
572
}

Dries's avatar
   
Dries committed
573
function check_query($text) {
Dries's avatar
   
Dries committed
574
  return addslashes($text);
Dries's avatar
   
Dries committed
575
576
577
}

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

Dries's avatar
   
Dries committed
579
580
581
582
583
584
585
586
587
588
589
590
591
  $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
592
593
594
595
596
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
   
Dries committed
597
598
}

Dries's avatar
   
Dries committed
599
600
function rewrite_old_urls($text) {

Dries's avatar
   
Dries committed
601
602
603
604
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
   
Dries committed
605
606
607
  /*
  ** 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
608
609
  ** (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
610
611
612
  ** and comment bodies.
  */

Dries's avatar
   
Dries committed
613
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
    /*
    ** 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
630
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
   
Dries committed
631
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
   
Dries committed
632

Dries's avatar
   
Dries committed
633
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
634
635
636
    $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
637
638
  }
  else {
Dries's avatar
   
Dries committed
639
640
641
642
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
    $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
663

Dries's avatar
   
Dries committed
664
665
666
  return $text;
}

Dries's avatar
   
Dries committed
667
function check_output($text) {
Dries's avatar
   
Dries committed
668
  if (isset($text)) {
Dries's avatar
   
Dries committed
669
670
671
672
    // filter content on output:
    $text = filter($text);

    // get the line breaks right:
Dries's avatar
   
Dries committed
673
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
   
Dries committed
674
675
676
677
678
679
680
681
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
   
Dries committed
682
683
}

684

685
686
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
687
688
}

Dries's avatar
   
Dries committed
689
690
691
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
692
  $output .= "<channel>\n";
Dries's avatar
   
Dries committed
693
694
695
696
  $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
697
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
698
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
699
  }
Dries's avatar
   
Dries committed
700
701
702
703
704
705
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
   
Dries committed
709
  $output .= "<item>\n";
Dries's avatar
   
Dries committed
710
711
712
  $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
713
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
714
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
715
  }
Dries's avatar
   
Dries committed
716
717
718
719
720
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
721
722
723
724
725
726
727
728
729
730
731
732
733
734
/**
 * 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
735
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
736
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
737
738
739
}

function format_size($size) {
Dries's avatar
   
Dries committed
740
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
741
742
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
743
    $suffix = t("KB");
Dries's avatar
   
Dries committed
744
745
746
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
747
    $suffix = t("MB");
Dries's avatar
   
Dries committed
748
  }
Dries's avatar
   
Dries committed
749
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
750
751
}

Dries's avatar
   
Dries committed
752
function cache_get($key) {
Dries's avatar
   
Dries committed
753
  $cache = db_fetch_object(db_query("SELECT data, created FROM {cache} WHERE cid = '%s'", $key));
Dries's avatar
   
Dries committed
754
  return $cache->data ? $cache : 0;
Dries's avatar
   
Dries committed
755
756
757
}

function cache_set($cid, $data, $expire = 0) {
Dries's avatar
   
Dries committed
758
759
  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
760
761
  }
  else {
Dries's avatar
   
Dries committed
762
    db_query("INSERT INTO {cache} (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries's avatar
   
Dries committed
763
  }
Dries's avatar
   
Dries committed
764
765
}

Dries's avatar
   
Dries committed
766
767
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
   
Dries committed
768
    db_query("DELETE FROM {cache} WHERE expire <> 0");
Dries's avatar
   
Dries committed
769
770
  }
  else {
Dries's avatar
   
Dries committed
771
    db_query("DELETE FROM {cache} WHERE cid = '%s'", $cid);
Dries's avatar
   
Dries committed
772
  }
Dries's avatar
   
Dries committed
773
774
775
}

function page_set_cache() {
Dries's avatar
   
Dries committed
776
  global $user;
Dries's avatar
   
Dries committed
777

Dries's avatar
   
Dries committed
778
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
779
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
780
      cache_set(request_uri(), $data, 1);
Dries's avatar
   
Dries committed
781
782
783
784
    }
  }
}

Dries's avatar
   
Dries committed
785
function page_get_cache() {
Dries's avatar
   
Dries committed
786
  global $user;
Dries's avatar
   
Dries committed
787

Dries's avatar
   
Dries committed
788
789
  $cache = NULL;

Dries's avatar
   
Dries committed
790
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
791
792
793
    $cache = cache_get(request_uri());

    if (empty($cache)) {
Dries's avatar
   
Dries committed
794
      ob_start();
Dries's avatar
   
Dries committed
795
796
    }
  }
Dries's avatar
   
Dries committed
797

Dries's avatar
   
Dries committed
798
  return $cache;
Dries's avatar
   
Dries committed
799
800
801
}

function format_interval($timestamp) {
Dries's avatar
   
Dries committed
802
  $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
803
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
804
805
806
807
808
809
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
   
Dries committed
810
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
811
812
813
814
815
}

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

Kjartan's avatar
Kjartan committed
816
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
817
818
819

  switch ($type) {
    case "small":
Dries's avatar
   
Dries committed
820
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries's avatar
   
Dries committed
821
822
      break;
    case "large":
Dries's avatar
   
Dries committed
823
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries's avatar
   
Dries committed
824
825
      break;
    case "custom":
Dries's avatar
   
Dries committed
826
      // No change to format
Dries's avatar
   
Dries committed
827
      break;
Dries's avatar
   
Dries committed
828
    case "medium":
Dries's avatar
   
Dries committed
829
    default:
Dries's avatar
   
Dries committed
830
831
832
833
834
835
836
837
838
839
840
841
842
      $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
843
844
845
846
847
848
849
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
850
851
852
853
854
855
856
857
858
859
860
861
    /*
    ** 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
862
    if (arg(0) == "admin") {
Dries's avatar
Dries committed
863
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
864
865
    }
    else {
Dries's avatar
Dries committed
866
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
867
    }
Dries's avatar
   
Dries committed
868
  }
Dries's avatar
   
Dries committed
869
870
871
872
873
874
875
876
877
878
  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
879
  else {
Dries's avatar
   
Dries committed
880
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
881
882
  }

Dries's avatar
   
Dries committed
883
  return $output;
Dries's avatar
   
Dries committed
884
885
886
}

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

  if (!$action) {
889
    $action = request_uri();
Dries's avatar
   
Dries committed
890
  }
891
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
892
893
894
}

function form_item($title, $value, $description = 0) {
Dries's avatar
   
Dries committed
895
  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
896
897
}

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

902
903
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
  return form_hidden($name, 0) . form_item(0, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
   
Dries committed
904
905
}

906
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
   
Dries committed
907
  $size = $size ? " size=\"$size\"" : "";
908
  return form_item($title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries's avatar
   
Dries committed
909
910
}

911
function form_password($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
   
Dries committed
912
  $size = $size ? " size=\"$size\"" : "";
913
  return form_item($title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries's avatar
   
Dries committed
914
915
}

916
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries's avatar
   
Dries committed
917
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
918
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
919
  return form_item($title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"edit[$name]\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description);
Dries's avatar
   
Dries committed
920
921
}

Dries's avatar
   
Dries committed
922
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
923
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
924
    foreach ($options as $key=>$choice) {
925
      $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
926
    }
Kjartan's avatar
Kjartan committed
927
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
   
Dries committed
928
929
930
  }
}

Dries's avatar
   
Dries committed
931
932
933
934
935
936
937
938
939
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);
  }
}

940
941
function form_file($title, $name, $size, $description = 0) {
  return form_item($title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries's avatar
   
Dries committed
942
943
944
945
946
947
}

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

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

Dries's avatar
   
Dries committed
952
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
   
Dries committed
953
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
954
955
956
957
958
959
    $weights[$n] = $n;
  }

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

Dries's avatar
   
Dries committed
960
961
962
963
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
   
Dries committed
964
965
966
/**
 * Given an old url, return the alias.
 */
Dries's avatar
   
Dries committed
967
968
function drupal_get_path_alias($path) {
  $map = drupal_get_path_map();
Dries's avatar
   
Dries committed
969

Dries's avatar
   
Dries committed
970
971
972
  if ($map) {
    return array_search($path, $map);
  }
Dries's avatar
   
Dries committed
973
974
975
}

/**
Dries's avatar
   
Dries committed
976
 * Given an alias, return the default url.
Dries's avatar
   
Dries committed
977
 */
Dries's avatar
   
Dries committed
978
979
function drupal_get_normal_path($path) {
  $map = drupal_get_path_map();
Dries's avatar
   
Dries committed
980
981
982
  return $map[$path];
}

Dries's avatar
   
Dries committed
983
function url($url = NULL, $query = NULL) {
Dries's avatar
   
Dries committed
984
  global $base_url;
Dries's avatar
   
Dries committed
985

Dries's avatar
   
Dries committed
986
987
988
989
990
991
992
993
994
995
996
  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
997
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
   
Dries committed
998
999
1000
    $url = $alias;
  }

Dries's avatar
   
Dries committed
1001
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
1002
1003
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
1004
        return "$base_url/$script?q=$url&amp;$query";
Dries's avatar
   
Dries committed
1005
1006
      }
      else {
Dries's avatar
   
Dries committed
1007
        return "$base_url/$script?q=$url";
Dries's avatar
   
Dries committed
1008
      }
Dries's avatar
   
Dries committed
1009
1010
    }
    else {
Dries's avatar
   
Dries committed
1011
      if (isset($query)) {
Dries's avatar
   
Dries committed
1012
        return "$base_url/$script?$query";
Dries's avatar
   
Dries committed
1013
1014
      }
      else {
Dries's avatar
   
Dries committed
1015
        return "$base_url/";
Dries's avatar
   
Dries committed
1016
      }
Dries's avatar
   
Dries committed
1017
1018
1019
    }
  }
  else {
Dries's avatar
   
Dries committed
1020
1021
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
1022
        return "$base_url/$url?$query";
Dries's avatar
   
Dries committed
1023
1024
      }
      else {
Dries's avatar
   
Dries committed
1025
        return "$base_url/$url";
Dries's avatar
   
Dries committed
1026
      }
Dries's avatar
   
Dries committed
1027
    }
Dries's avatar
   
Dries committed
1028
    else {
Dries's avatar
   
Dries committed
1029
      if (isset($query)) {
Dries's avatar
   
Dries committed
1030
        return "$base_url/$script?$query";
Dries's avatar
   
Dries committed
1031
1032
      }
      else {
Dries's avatar
   
Dries committed
1033
        return "$base_url/";
Dries's avatar
   
Dries committed
1034
      }
Dries's avatar
   
Dries committed
1035
    }
Dries's avatar
   
Dries committed
1036
  }
Dries's avatar
   
Dries committed
1037
1038
}

1039
1040
1041
1042
1043
1044
1045
function drupal_attributes($attributes = 0) {
  if (is_array($attributes)) {
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
    return " ". implode($t, " ");
Dries's avatar
   
Dries committed
1046
  }
1047
}
Dries's avatar
   
Dries committed
1048

1049
1050
function l($text, $url, $attributes = array(), $query = NULL) {
  return "<a href=\"". url($url, $query) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
   
Dries committed
1051
1052
}

Dries's avatar
   
Dries committed
1053
function field_get($string, $name) {
1054
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
   
Dries committed
1055
1056
1057
1058
1059
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
1060
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
1061
1062
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
1063
1064
1065
1066
  return substr($rval, 1);
}

function link_page() {
1067
  global $custom_links;
Dries's avatar
   
Dries committed
1068

1069
  if (is_array($custom_links)) {
1070
1071
1072
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
1073
    $links = module_invoke_all("link", "page");
1074
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
1075
    return $links;
Dries's avatar
   
Dries committed
1076
  }
Dries's avatar
   
Dries committed
1077
}
Dries's avatar
   
Dries committed
1078
1079

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
1080
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
   
Dries committed
1081
1082
1083
1084
}

function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
1085
1086
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
1087
1088
}

Dries's avatar
   
Dries committed
1089
function drupal_page_header() {
1090

Dries's avatar
   
Dries committed
1091
1092
1093
1094
1095
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
1096
    if ($cache = page_get_cache()) {
Dries's avatar
   
Dries committed
1097
1098

      // Set default values:
Dries's avatar
   
Dries committed
1099
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
Dries's avatar
   
Dries committed
1100
1101
1102
      $etag = '"'. md5($date) .'"';

      // Check http headers:
1103
      $modified_since = isset($_SERVER["HTTP_IF_MODIFIED_SINCE"]) ? $_SERVER["HTTP_IF_MODIFIED_SINCE"] == $date : NULL;
1104
      $none_match = isset($_SERVER["HTTP_IF_NONE_MATCH"]) ? $_SERVER["HTTP_IF_NONE_MATCH"] == $etag : NULL;
Dries's avatar
   
Dries committed
1105

1106
1107
      // The type checking here is very important, be careful when changing entries.
      if (($modified_since !== NULL || $none_match !== NULL) && $modified_since !== false && $none_match !== false) {
Dries's avatar
   
Dries committed
1108
1109
        header("HTTP/1.0 304 Not Modified");
        exit();
Dries's avatar
   
Dries committed
1110
      }
Dries's avatar
   
Dries committed
1111

1112
1113
1114
      // Send appropriate response:
      header("Last-Modified: $date");
      header("ETag: $etag");
Dries's avatar
   
Dries committed
1115
      print $cache->data;
Dries's avatar
   
Dries committed
1116
1117
1118
1119
1120
1121
1122
1123

      /*
      ** 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
1124
1125
1126
      exit();
    }
  }
Dries's avatar
   
Dries committed
1127
1128
1129
1130
1131
1132
1133
1134

  /*
  ** 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")) {
Dries's avatar
   
Dries committed
1135
1136
1137
    if (!valid_input_data(