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 $map;

Dries's avatar
   
Dries committed
34
35
36
37
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

Dries's avatar
   
Dries committed
48
49
50
51
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries's avatar
   
Dries committed
52
53
54
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
55
56

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
57
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
58
    print "<pre>$entry</pre>";
Dries's avatar
   
Dries committed
59
60
61
  }
}

Dries's avatar
   
Dries committed
62
function watchdog($type, $message, $link = NULL) {
Dries's avatar
   
Dries committed
63
  global $user;
Dries's avatar
   
Dries committed
64
  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
65
66
67
68
}

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

Dries's avatar
   
Dries committed
79
80
function check_php_setting($name, $value) {
  if (ini_get($name) != $value) {
Steven Wittens's avatar
Steven Wittens committed
81
    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
82
83
84
  }
}

Dries's avatar
   
Dries committed
85
86
87
88
89
function arg($index) {

  static $arguments;

  if (empty($arguments)) {
Dries's avatar
   
Dries committed
90
    $arguments = explode("/", $_GET["q"]);
Dries's avatar
   
Dries committed
91
92
93
94
95
  }

  return $arguments[$index];
}

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

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

    return check_url($uri);
  }
}

Dries's avatar
   
Dries committed
133
function request_uri() {
Dries's avatar
   
Dries committed
134
135
136
137
  /*
  ** Since request_uri() is only available on Apache, we generate
  ** equivalent using other environment vars.
  */
Dries's avatar
   
Dries committed
138

Dries's avatar
   
Dries committed
139
  if (isset($_SERVER["REQUEST_URI"])) {
140
    $uri = $_SERVER["REQUEST_URI"];
Dries's avatar
   
Dries committed
141
142
  }
  else {
143
    $uri = $_SERVER["PHP_SELF"] ."?". $_SERVER["QUERY_STRING"];
Dries's avatar
   
Dries committed
144
  }
145

Dries's avatar
   
Dries committed
146
  return check_url($uri);
Dries's avatar
   
Dries committed
147
148
}

Dries's avatar
   
Dries committed
149
function message_access() {
Dries's avatar
   
Dries committed
150
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
151
152
153
154
155
156
157
158
159
160
}

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
161
162
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
163
164
165
166
167
168
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
169
170
}

Dries's avatar
   
Dries committed
171
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
172
  global $languages;
173

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

185
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
186

Dries's avatar
   
Dries committed
187
188
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
189
190
  }
  else {
Dries's avatar
   
Dries committed
191
192
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
193
194
195
}

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

  return $conf;
}

206
function variable_get($name, $default) {
Dries's avatar
   
Dries committed
207
208
209
210
211
212
213
214
  global $conf;

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

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

Dries's avatar
   
Dries committed
215
216
  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
217
218
219
220
221
222
223

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries's avatar
   
Dries committed
224
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
225
226
227
228

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
229
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
230
231
232
233
234
235
236
237
238

  /*
  ** 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
239
240
}

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

Dries's avatar
   
Dries committed
254
  if ($header) {
Dries's avatar
   
Dries committed
255
256
257
258
259
260
261
262
263
264
265
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

266
  $output = "<table>\n";
Dries's avatar
   
Dries committed
267
268
269
270
271

  /*
  ** Emit the table header:
  */

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

  /*
  ** Emit the table rows:
  */

Dries's avatar
   
Dries committed
287
288
289
290
291
292
293
294
  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
295

Dries's avatar
   
Dries committed
296
297
298
      foreach ($row as $cell) {
        $output .= table_cell($cell, 0);
      }
Dries's avatar
   
Dries committed
299
      $output .= " </tr>\n";
Dries's avatar
   
Dries committed
300
301
302
    }
  }

Dries's avatar
   
Dries committed
303
  $output .= "</table>\n";
Dries's avatar
   
Dries committed
304
305
306
307

  return $output;
}

308
309
310
311
312
313
/**
 * 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
314
function valid_email_address($mail) {
315
316
317
318
319
320
321
322
323
324
325
326
327
  $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
328
329
330
331
332
333
334
/**
 * Verify the syntax of the given URL.
 *
 * @param $url  an URL
 */
function valid_url($url) {

Dries's avatar
   
Dries committed
335
  if (preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url)) {
Dries's avatar
   
Dries committed
336
337
338
339
340
341
342
    return 1;
  }
  else {
    return 0;
  }
}

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

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

  return $output;
}

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

  if (!$action) {
Dries's avatar
   
Dries committed
387
    $action = url("search");
Dries's avatar
   
Dries committed
388
389
  }

Kjartan's avatar
Kjartan committed
390
391
  $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
392
393
394
395
396
397
398

  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
399
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
400
401
402
403
      }
    }
  }

Kjartan's avatar
Kjartan committed
404
405
  $form .= "<br />";

Dries's avatar
   
Dries committed
406
407
408
409
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
410
411
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
412
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
413
414

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

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

  return $output;
}

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

Dries's avatar
   
Dries committed
447
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
448

Dries's avatar
   
Dries committed
449
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
450
451
}

Dries's avatar
   
Dries committed
452

Dries's avatar
   
Dries committed
453
454
function drupal_goto($url) {

Dries's avatar
   
Dries committed
455
456
457
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
   
Dries committed
458

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

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

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

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

function referer_load() {
Dries's avatar
   
Dries committed
504
505
  if (isset($_SESSION["referer"])) {
    return $_SESSION["referer"];
Dries's avatar
   
Dries committed
506
507
508
509
510
511
  }
  else {
    return 0;
  }
}

Dries's avatar
   
Dries committed
512
function valid_input_data($data) {
513

514
  if (is_array($data) || is_object($data)) {
515
516
517
518
519
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
   
Dries committed
520
521
522
      if (!valid_input_data($value)) {
        return 0;
      }
523
524
525
526
527
528
529
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries's avatar
Dries committed
530
    // check strings:
Dries's avatar
Dries committed
531
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries's avatar
Dries committed
532
533
534
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

538
539

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries's avatar
   
Dries committed
544
      return 0;
545
546
    }
  }
Dries's avatar
   
Dries committed
547
548

  return 1;
549
}
Dries's avatar
   
Dries committed
550

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

Dries's avatar
   
Dries committed
568
function check_query($text) {
Dries's avatar
   
Dries committed
569
  return addslashes($text);
Dries's avatar
   
Dries committed
570
571
572
}

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

Dries's avatar
   
Dries committed
574
575
576
577
578
579
580
581
582
583
584
585
586
  $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
587
588
589
590
591
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
   
Dries committed
592
593
}

Dries's avatar
   
Dries committed
594
595
function rewrite_old_urls($text) {

Dries's avatar
   
Dries committed
596
597
598
599
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
   
Dries committed
600
601
602
  /*
  ** 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
603
604
  ** (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
605
606
607
  ** and comment bodies.
  */

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

Dries's avatar
   
Dries committed
628
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
629
630
631
    $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
632
633
  }
  else {
Dries's avatar
   
Dries committed
634
635
636
637
    /*
    ** Relative URLs:
    */

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

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

Dries's avatar
   
Dries committed
659
660
661
  return $text;
}

Dries's avatar
   
Dries committed
662
function check_output($text) {
Dries's avatar
   
Dries committed
663
  if (isset($text)) {
Dries's avatar
   
Dries committed
664
665
666
667
    // filter content on output:
    $text = filter($text);

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

  return $text;
Dries's avatar
   
Dries committed
677
678
}

679

680
681
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
682
683
}

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

  return $output;
}

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

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

  return $output;
}

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

function format_size($size) {
Dries's avatar
   
Dries committed
735
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
736
737
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
738
    $suffix = t("KB");
Dries's avatar
   
Dries committed
739
740
741
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
742
    $suffix = t("MB");
Dries's avatar
   
Dries committed
743
  }
Dries's avatar
   
Dries committed
744
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
745
746
}

Dries's avatar
   
Dries committed
747
function cache_get($key) {
Dries's avatar
   
Dries committed
748
  $cache = db_fetch_object(db_query("SELECT data, created FROM {cache} WHERE cid = '%s'", $key));
Dries's avatar
   
Dries committed
749
  return $cache->data ? $cache : 0;
Dries's avatar
   
Dries committed
750
751
752
}

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

Dries's avatar
   
Dries committed
761
762
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
   
Dries committed
763
    db_query("DELETE FROM {cache} WHERE expire <> 0");
Dries's avatar
   
Dries committed
764
765
  }
  else {
Dries's avatar
   
Dries committed
766
    db_query("DELETE FROM {cache} WHERE cid = '%s'", $cid);
Dries's avatar
   
Dries committed
767
  }
Dries's avatar
   
Dries committed
768
769
770
}

function page_set_cache() {
Dries's avatar
   
Dries committed
771
  global $user;
Dries's avatar
   
Dries committed
772

Dries's avatar
   
Dries committed
773
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
774
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
775
      cache_set(request_uri(), $data, 1);
Dries's avatar
   
Dries committed
776
777
778
779
    }
  }
}

Dries's avatar
   
Dries committed
780
function page_get_cache() {
Dries's avatar
   
Dries committed
781
  global $user;
Dries's avatar
   
Dries committed
782

Dries's avatar
   
Dries committed
783
784
  $cache = NULL;

Dries's avatar
   
Dries committed
785
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
786
787
788
    $cache = cache_get(request_uri());

    if (empty($cache)) {
Dries's avatar
   
Dries committed
789
      ob_start();
Dries's avatar
   
Dries committed
790
791
    }
  }
Dries's avatar
   
Dries committed
792

Dries's avatar
   
Dries committed
793
  return $cache;
Dries's avatar
   
Dries committed
794
795
796
}

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

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

Kjartan's avatar
Kjartan committed
811
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
812
813
814

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

function format_name($object) {

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

Dries's avatar
   
Dries committed
878
  return $output;
Dries's avatar
   
Dries committed
879
880
881
}

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

  if (!$action) {
884
    $action = request_uri();
Dries's avatar
   
Dries committed
885
  }
886
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
887
888
889
}

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

893
894
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
895
896
}

897
898
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
899
900
}

901
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries's avatar
   
Dries committed
902
  $size = $size ? " size=\"$size\"" : "";
903
  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
904
905
}

906
function form_password($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=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries's avatar
   
Dries committed
909
910
}

911
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries's avatar
   
Dries committed
912
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
913
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
914
  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
915
916
}

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

Dries's avatar
   
Dries committed
926
927
928
929
930
931
932
933
934
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);
  }
}

935
936
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
937
938
939
940
941
942
}

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

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

Dries's avatar
   
Dries committed
947
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
   
Dries committed
948
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
949
950
951
952
953
954
    $weights[$n] = $n;
  }

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

Dries's avatar
   
Dries committed
955
956
957
958
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries's avatar
   
Dries committed
959
960
961
/**
 * Given an old url, return the alias.
 */
Dries's avatar
   
Dries committed
962
963
function drupal_get_path_alias($path) {
  $map = drupal_get_path_map();
Dries's avatar
   
Dries committed
964

Dries's avatar
   
Dries committed
965
966
967
  if ($map) {
    return array_search($path, $map);
  }
Dries's avatar
   
Dries committed
968
969
970
}

/**
Dries's avatar
   
Dries committed
971
 * Given an alias, return the default url.
Dries's avatar
   
Dries committed
972
 */
Dries's avatar
   
Dries committed
973
974
function drupal_get_normal_path($path) {
  $map = drupal_get_path_map();
Dries's avatar
   
Dries committed
975
976
977
  return $map[$path];
}

Dries's avatar
   
Dries committed
978
function url($url = NULL, $query = NULL) {
Dries's avatar
   
Dries committed
979
  global $base_url;
Dries's avatar
   
Dries committed
980

Dries's avatar
   
Dries committed
981
982
983
984
985
986
987
988
989
990
991
  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
992
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
   
Dries committed
993
994
995
    $url = $alias;
  }

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

1034
1035
1036
1037
1038
1039
1040
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
1041
  }
1042
}
Dries's avatar
   
Dries committed
1043

1044
1045
function l($text, $url, $attributes = array(), $query = NULL) {
  return "<a href=\"". url($url, $query) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
   
Dries committed
1046
1047
}

Dries's avatar
   
Dries committed
1048
function field_get($string, $name) {
1049
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
   
Dries committed
1050
1051
1052
1053
1054
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
1055
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
1056
1057
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
1058
1059
1060
1061
  return substr($rval, 1);
}

function link_page() {
1062
  global $custom_links;
Dries's avatar
   
Dries committed
1063

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

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
1075
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
   
Dries committed
1076
1077
1078
1079
}

function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
1080
1081
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
1082
1083
}

Dries's avatar
   
Dries committed
1084
function drupal_page_header() {
1085

Dries's avatar
   
Dries committed
1086
1087
1088
1089
1090
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
1091
    if ($cache = page_get_cache()) {
Dries's avatar
   
Dries committed
1092
1093

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

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

1101
1102
      // 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
1103
1104
        header("HTTP/1.0 304 Not Modified");
        exit();
Dries's avatar
   
Dries committed
1105
      }
Dries's avatar
   
Dries committed
1106

1107
1108
1109
      // Send appropriate response:
      header("Last-Modified: $date");
      header("ETag: $etag");
Dries's avatar
   
Dries committed
1110
      print $cache->data;
Dries's avatar
   
Dries committed
1111
1112
1113
1114
1115
1116
1117
1118

      /*
      ** 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
1119
1120
1121
      exit();
    }
  }
Dries's avatar
   
Dries committed
1122
1123
1124
1125
1126
1127
1128
1129

  /*
  ** 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
1130
1131
1132
    if (!valid_input_data($_REQUEST)) {
      die("terminated request because of suspicious input data");
    }
Dries's avatar
   
Dries committed
1133
  }
Dries's avatar
   
Dries committed
1134
1135
}

Dries's avatar
   
Dries committed
1136
function drupal_page_footer() {
Dries's avatar
   
Dries committed
1137
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
1138
    page_set_cache();