common.inc 28.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
28
29
30

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

  return "conf";
}

function error_handler($errno, $message, $filename, $line, $variables) {
  $types = array(1 => "error", 2 => "warning", 4 => "parse error", 8 => "notice", 16 => "core error", 32 => "core warning", 64 => "compile error", 128 => "compile warning", 256 => "user error", 512 => "user warning", 1024 => "user notice");
  $entry = $types[$errno] .": $message in $filename on line $line.";
Dries's avatar
   
Dries committed
31
32

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
33
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
34
    print "<pre>$entry</pre>";
Dries's avatar
   
Dries committed
35
36
37
  }
}

Dries's avatar
   
Dries committed
38
function watchdog($type, $message, $link = NULL) {
Dries's avatar
   
Dries committed
39
  global $user;
Dries's avatar
   
Dries committed
40
  db_query("INSERT INTO watchdog (uid, type, message, link, location, hostname, timestamp) VALUES (%d, '%s', '%s', '%s', '%s', '%s', %d)", $user->uid, $type, $message, $link, request_uri(), getenv("REMOTE_ADDR"), time());
Dries's avatar
   
Dries committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
    if ($throttle = db_fetch_object(db_query("SELECT * FROM watchdog WHERE type = '$type' AND hostname = '". getenv("REMOTE_ADDR") ."' AND ". time() ." - timestamp < $rate"))) {
      watchdog("warning", "throttle: '". getenv("REMOTE_ADDR") ."' exceeded submission rate - $throttle->type");
      die(message_throttle());
    }
    else {
      watchdog($type, "throttle");
    }
  }
}

Dries's avatar
   
Dries committed
55
56
function check_php_setting($name, $value) {
  if (ini_get($name) != $value) {
Steven Wittens's avatar
Steven Wittens committed
57
    print "<p>Note that the value of PHP's configuration option <code><b>$name</b></code> is incorrect.  It should be set to '$value' for Drupal to work properly.  Either configure your webserver to support <code>.htaccess</code> files so Drupal's <code>.htaccess</code> file can set it to the proper value, or edit your <code>php.ini</code> file directly.  This message will automatically dissapear when the problem has been fixed.</p>";
Dries's avatar
   
Dries committed
58
59
60
  }
}

Dries's avatar
   
Dries committed
61
62
63
64
65
function arg($index) {

  static $arguments;

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

  return $arguments[$index];
}

Dries's avatar
   
Dries committed
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
function array2object($node) {

  if (is_array($node)) {
    foreach ($node as $key => $value) {
      $object->$key = $value;
    }
  }
  else {
    $object = $node;
  }

  return $object;
}

function object2array($node) {

  if (is_object($node)) {
    foreach ($node as $key => $value) {
      $array[$key] = $value;
    }
  }
  else {
    $array = $node;
  }

  return $array;
}

Dries's avatar
   
Dries committed
100
function request_uri() {
Dries's avatar
   
Dries committed
101
102
103
104
  /*
  ** Since request_uri() is only available on Apache, we generate
  ** equivalent using other environment vars.
  */
Dries's avatar
   
Dries committed
105

Dries's avatar
   
Dries committed
106
107
  if (isset($_SERVER["REQUEST_URI"])) {
    return $_SERVER["REQUEST_URI"];
Dries's avatar
   
Dries committed
108
109
  }
  else {
Dries's avatar
   
Dries committed
110
    return $_SERVER["PHP_SELF"] ."?". $_SERVER["QUERY_STRING"];
Dries's avatar
   
Dries committed
111
  }
Dries's avatar
   
Dries committed
112
113
}

Dries's avatar
   
Dries committed
114
function message_access() {
Dries's avatar
   
Dries committed
115
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
116
117
118
119
120
121
122
123
124
125
}

function message_na() {
  return t("n/a");
}

function message_throttle() {
  return t("You exceeded the maximum submission rate.  Please wait a few minutes and try again.");
}

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

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

Dries's avatar
   
Dries committed
139
140
141
142
143
144
145
  /*
  ** About the usage of t().  We try to keep strings whole as much as
  ** possible and are unafraid of HTML markup within translation strings
  ** if necessary.  The suggested syntax for a link embedded within a
  ** translation string is for example:
  **
  ** $msg = t("You must login below or <a href=\"%url\">create a new
Dries's avatar
   
Dries committed
146
147
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries's avatar
   
Dries committed
148
149
  */

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

Dries's avatar
   
Dries committed
152
153
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
154
155
  }
  else {
Dries's avatar
   
Dries committed
156
157
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
158
159
160
161
162
163
}

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

  return $conf;
}

function variable_get($name, $default, $object = 0) {
  global $conf;

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

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

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

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

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

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
194
function table_cell($cell, $header = 0) {
Dries's avatar
   
Dries committed
195
  if (is_array($cell)) {
Dries's avatar
   
Dries committed
196
197
198
199
200
201
202
203
204
205
206
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

Dries's avatar
   
Dries committed
207
  if ($header) {
Dries's avatar
   
Dries committed
208
209
210
211
212
213
214
215
216
217
218
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

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

  /*
  ** Emit the table header:
  */

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

  /*
  ** Emit the table rows:
  */

Dries's avatar
   
Dries committed
237
238
239
240
241
242
243
244
  if (is_array($rows)) {
    foreach ($rows as $number => $row) {
      if ($number % 2 == 1) {
        $output .= " <tr class=\"light\">";
      }
      else {
        $output .= " <tr class=\"dark\">";
      }
Dries's avatar
   
Dries committed
245

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

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

  return $output;
}

258
259
260
261
262
263
/**
 * 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
264
function valid_email_address($mail) {
265
266
267
268
269
270
271
272
273
274
275
276
277
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
  $domain = '(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.?)+';
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

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

Kjartan's avatar
Kjartan committed
278
279
280
281
/**
 * 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
282
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
283
284
285
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
   
Dries committed
286
function search_item($item, $type) {
Dries's avatar
   
Dries committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300

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

  if (module_hook($type, "search_item")) {
    $output = module_invoke($type, "search_item", $item);
  }
  else {
    $output .= " <b>". $item["count"] ."&nbsp;&nbsp;<u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
    $output .= " <small>$type ". ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
    $output .= "<br /><br />";
  }
Dries's avatar
   
Dries committed
301
302
303
304

  return $output;
}

Kjartan's avatar
Kjartan committed
305
306
307
308
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
309
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
   
Dries committed
310
311
 * "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
312
313
 * parts of this form.
 *
Dries's avatar
   
Dries committed
314
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
315
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
   
Dries committed
316
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
317
318
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries committed
319
function search_form($action = 0, $query = 0, $options = 0) {
320
  $keys = $_POST["keys"];
Dries's avatar
   
Dries committed
321
322

  if (!$action) {
Dries's avatar
   
Dries committed
323
    $action = url("search");
Dries's avatar
   
Dries committed
324
325
326
327
328
329
  }

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

Kjartan's avatar
Kjartan committed
330
331
  $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
332
333
334
335
336
337
338

  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
339
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
340
341
342
343
      }
    }
  }

Kjartan's avatar
Kjartan committed
344
345
  $form .= "<br />";

Dries's avatar
   
Dries committed
346
347
348
349
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
350
351
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
352
function search_data() {
Dries's avatar
   
Dries committed
353

354
  $keys = $_POST["keys"];
Dries's avatar
   
Dries committed
355
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
356

Dries's avatar
   
Dries committed
357
  if (isset($keys)) {
Dries's avatar
   
Dries committed
358
359
    foreach (module_list() as $name) {
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", check_query($keys)))) {
Kjartan's avatar
Kjartan committed
360
        if ($name == "node" || $name == "comment") {
Dries's avatar
   
Dries committed
361
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
362
363
        }
        else {
Dries's avatar
   
Dries committed
364
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
365
        }
Dries's avatar
   
Dries committed
366
367
368
369
370
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
Kjartan's avatar
Kjartan committed
371
    if (!$output) {
Dries's avatar
   
Dries committed
372
373
374
375
376
377
378
      $output .= t("Your search yielded no results.");
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
379
380
381
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
382
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan committed
383
 *                 Otherwise, search all types.
Dries's avatar
   
Dries committed
384
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
385
 * @param $query   Query string. Defaults to global $keys.
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_type($type = 0, $action = 0, $query = 0, $options = 0) {
Dries's avatar
   
Dries committed
390
391

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

Dries's avatar
   
Dries committed
393
  if (isset($type)) {
Dries's avatar
   
Dries committed
394
395
396
397
398
399
    $edit["type"][$type] = "on";
  }

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

Dries's avatar
   
Dries committed
400

Dries's avatar
   
Dries committed
401
402
function drupal_goto($url) {

Dries's avatar
   
Dries committed
403
404
405
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
   
Dries committed
406

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

Dries's avatar
   
Dries committed
409
410
411
412
413
  /*
  ** 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
414
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
   
Dries committed
415
416
417
    header("Location: $url");
  }
  else {
Dries's avatar
   
Dries committed
418
419
420
421
422
423
424
425
    $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
426
427
428
429
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries's avatar
   
Dries committed
430
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries's avatar
   
Dries committed
431
432
433
434
435
436
437
438
439
440
441
  ** 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
442
  global $referer;
Dries's avatar
   
Dries committed
443

Dries's avatar
   
Dries committed
444
445
  if (!strstr($_SERVER["HTTP_REFERER"], request_uri())) {
    $referer = $_SERVER["HTTP_REFERER"];
Dries's avatar
   
Dries committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
    session_register("referer");
  }
}

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

function referer_load() {
  global $referer;

  if (session_is_registered("referer")) {
    return $referer;
  }
  else {
    return 0;
  }
}

function check_form($text) {
Dries's avatar
   
Dries committed
466
  return htmlspecialchars($text);
Dries's avatar
   
Dries committed
467
468
}

Dries's avatar
   
Dries committed
469
function check_query($text) {
Dries's avatar
   
Dries committed
470
  return addslashes($text);
Dries's avatar
   
Dries committed
471
472
}

Dries's avatar
   
Dries committed
473
function check_input($text) {
Dries's avatar
   
Dries committed
474
  return addslashes($text);
Dries's avatar
   
Dries committed
475
476
477
}

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

Dries's avatar
   
Dries committed
479
480
481
482
483
484
485
486
487
488
489
490
491
  $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
492
493
494
495
496
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
   
Dries committed
497
498
}

Dries's avatar
   
Dries committed
499
500
function rewrite_old_urls($text) {

Dries's avatar
   
Dries committed
501
502
503
504
  global $base_url;

  $end = substr($base_url, 12);

Dries's avatar
   
Dries committed
505
506
507
  /*
  ** 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
508
509
  ** (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
510
511
512
  ** and comment bodies.
  */

Dries's avatar
   
Dries committed
513
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
    /*
    ** 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
530
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
   
Dries committed
531
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries's avatar
   
Dries committed
532

Dries's avatar
   
Dries committed
533
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
534
535
536
    $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
537
538
  }
  else {
Dries's avatar
   
Dries committed
539
540
541
542
    /*
    ** Relative URLs:
    */

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

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
    $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
563

Dries's avatar
   
Dries committed
564
565
566
  return $text;
}

Dries's avatar
   
Dries committed
567
function check_output($text) {
Dries's avatar
   
Dries committed
568
  if (isset($text)) {
Dries's avatar
   
Dries committed
569
570
571
572
    // filter content on output:
    $text = filter($text);

    // get the line breaks right:
Dries's avatar
   
Dries committed
573
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
   
Dries committed
574
575
576
577
578
579
580
581
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
   
Dries committed
582
583
584
585
586
587
588
589
590
591
592
}

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

Dries's avatar
   
Dries committed
593
594
595
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
596
597
598
599
600
  $output .= "<channel>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
  $output .= " <description>". htmlentities($description) ."</description>\n";
  $output .= " <language>". htmlentities(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
601
  foreach ($args as $key => $value) {
602
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
603
  }
Dries's avatar
   
Dries committed
604
605
606
607
608
609
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
   
Dries committed
613
614
615
  $output .= "<item>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
616
  $output .= " <description>". htmlentities(check_output($description)) ."</description>\n";
Dries's avatar
   
Dries committed
617
  foreach ($args as $key => $value) {
618
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
619
  }
Dries's avatar
   
Dries committed
620
621
622
623
624
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
625
626
627
628
629
630
631
632
633
634
635
636
637
638
/**
 * 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
639
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
640
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
641
642
643
}

function format_size($size) {
Dries's avatar
   
Dries committed
644
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
645
646
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
647
    $suffix = t("KB");
Dries's avatar
   
Dries committed
648
649
650
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
651
    $suffix = t("MB");
Dries's avatar
   
Dries committed
652
  }
Dries's avatar
   
Dries committed
653
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
654
655
}

Dries's avatar
   
Dries committed
656
function cache_get($key) {
Dries's avatar
   
Dries committed
657
  $cache = db_fetch_object(db_query("SELECT data, created FROM cache WHERE cid = '%s'", $key));
Dries's avatar
   
Dries committed
658
  return $cache->data ? $cache : 0;
Dries's avatar
   
Dries committed
659
660
661
}

function cache_set($cid, $data, $expire = 0) {
662
663
  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
664
665
  }
  else {
Dries's avatar
   
Dries committed
666
    db_query("INSERT INTO cache (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries's avatar
   
Dries committed
667
  }
Dries's avatar
   
Dries committed
668
669
}

Dries's avatar
   
Dries committed
670
671
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
   
Dries committed
672
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries's avatar
   
Dries committed
673
674
  }
  else {
Dries's avatar
   
Dries committed
675
    db_query("DELETE FROM cache WHERE cid = %d", $cid);
Dries's avatar
   
Dries committed
676
  }
Dries's avatar
   
Dries committed
677
678
679
}

function page_set_cache() {
Dries's avatar
   
Dries committed
680
  global $user;
Dries's avatar
   
Dries committed
681

Dries's avatar
   
Dries committed
682
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
683
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
684
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries's avatar
   
Dries committed
685
686
687
688
    }
  }
}

Dries's avatar
   
Dries committed
689
function page_get_cache() {
Dries's avatar
   
Dries committed
690
  global $user;
Dries's avatar
   
Dries committed
691

Dries's avatar
   
Dries committed
692
693
  $cache = NULL;

Dries's avatar
   
Dries committed
694
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries's avatar
   
Dries committed
695
696
697
    $cache = cache_get(request_uri());

    if (empty($cache)) {
Dries's avatar
   
Dries committed
698
      ob_start();
Dries's avatar
   
Dries committed
699
700
    }
  }
Dries's avatar
   
Dries committed
701

Dries's avatar
   
Dries committed
702
  return $cache;
Dries's avatar
   
Dries committed
703
704
705
}

function format_interval($timestamp) {
Dries's avatar
   
Dries committed
706
  $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
707
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
708
709
710
711
712
713
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
   
Dries committed
714
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
715
716
717
718
719
}

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

Kjartan's avatar
Kjartan committed
720
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
721
722
723

  switch ($type) {
    case "small":
Dries's avatar
   
Dries committed
724
      $date = date(variable_get("date_format_short", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
725
726
      break;
    case "medium":
727
      $date = date(variable_get("date_format_medium", "D, m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
728
729
      break;
    case "large":
730
      $date = date(variable_get("date_format_long", "l, F j, Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
731
732
733
734
      break;
    case "custom":
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
735
          $date = t(date($c, $timestamp)) . $date;
Dries's avatar
   
Dries committed
736
        }
Kjartan's avatar
Kjartan committed
737
        else if (strstr("AaBdgGhHiIjLmnOrstTUWYyZz", $c)) {
738
          $date = date($c, $timestamp) . $date;
Dries's avatar
   
Dries committed
739
740
        }
        else {
Kjartan's avatar
Kjartan committed
741
          $date = $c.$date;
Dries's avatar
   
Dries committed
742
743
744
745
        }
      }
      break;
    default:
746
      $date = date(variable_get("date_format_medium", "l, m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
747
748
749
750
751
752
753
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
754
    if (arg(0) == "admin") {
Dries's avatar
   
Dries committed
755
      $output = l($object->name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
756
757
    }
    else {
Dries's avatar
   
Dries committed
758
      $output = l($object->name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
759
    }
Dries's avatar
   
Dries committed
760
  }
Dries's avatar
   
Dries committed
761
762
763
764
765
766
767
768
769
770
  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
771
  else {
Dries's avatar
   
Dries committed
772
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
773
774
  }

Dries's avatar
   
Dries committed
775
  return $output;
Dries's avatar
   
Dries committed
776
777
778
}

function form($form, $method = "post", $action = 0, $options = 0) {
Dries's avatar
   
Dries committed
779
780
781
782
783

  if (!$action) {
    $action = htmlentities(request_uri());
  }
  return "<form action=\"$action\" method=\"$method\"". ($options ? " $options" : "") .">\n$form</form>\n";
Dries's avatar
   
Dries committed
784
785
786
}

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

Dries's avatar
   
Dries committed
790
791
792
793
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0) {
  return form_item(0, "<input type=\"radio\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
}

794
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0) {
795
  return form_hidden($name, 0) . form_item(0, "<input type=\"checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
Dries's avatar
   
Dries committed
796
797
798
799
800
801
802
803
804
805
806
}

function form_textfield($title, $name, $value, $size, $maxlength, $description = 0) {
  return form_item($title, "<input maxlength=\"$maxlength\" name=\"edit[$name]\" size=\"$size\" value=\"". check_form($value) ."\" />", $description);
}

function form_password($title, $name, $value, $size, $maxlength, $description = 0) {
  return form_item($title, "<input type=\"password\" maxlength=\"$maxlength\" name=\"edit[$name]\" size=\"$size\" value=\"". check_form($value) ."\" />", $description);
}

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

Dries's avatar
   
Dries committed
811
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
812
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
813
    foreach ($options as $key=>$choice) {
814
      $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
815
    }
Kjartan's avatar
Kjartan committed
816
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
   
Dries committed
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
  }
}

function form_file($title, $name, $size, $description = 0) {
  return form_item($title, "<input type=\"file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
}

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

function form_submit($value) {
  return "<input type=\"submit\" name=\"op\" value=\"". check_form($value) ."\" />\n";
}

Dries's avatar
   
Dries committed
832
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries's avatar
   
Dries committed
833
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
834
835
836
837
838
839
    $weights[$n] = $n;
  }

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

Dries's avatar
   
Dries committed
840
function url($url = NULL, $query = NULL) {
Dries's avatar
   
Dries committed
841
  global $base_url;
Dries's avatar
   
Dries committed
842

Dries's avatar
   
Dries committed
843
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
844
845
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
846
        return "$base_url/index.php?q=$url&amp;$query";
Dries's avatar
   
Dries committed
847
848
      }
      else {
Dries's avatar
   
Dries committed
849
        return "$base_url/index.php?q=$url";
Dries's avatar
   
Dries committed
850
      }
Dries's avatar
   
Dries committed
851
852
    }
    else {
Dries's avatar
   
Dries committed
853
      if (isset($query)) {
Dries's avatar
   
Dries committed
854
        return "$base_url/index.php?$query";
Dries's avatar
   
Dries committed
855
856
      }
      else {
Dries's avatar
   
Dries committed
857
        return "$base_url/";
Dries's avatar
   
Dries committed
858
      }
Dries's avatar
   
Dries committed
859
860
861
    }
  }
  else {
Dries's avatar
   
Dries committed
862
863
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
864
        return "$base_url/$url?$query";
Dries's avatar
   
Dries committed
865
866
      }
      else {
Dries's avatar
   
Dries committed
867
        return "$base_url/$url";
Dries's avatar
   
Dries committed
868
      }
Dries's avatar
   
Dries committed
869
    }
Dries's avatar
   
Dries committed
870
    else {
Dries's avatar
   
Dries committed
871
      if (isset($query)) {
Dries's avatar
   
Dries committed
872
        return "$base_url/index.php?$query";
Dries's avatar
   
Dries committed
873
874
      }
      else {
Dries's avatar
   
Dries committed
875
        return "$base_url/";
Dries's avatar
   
Dries committed
876
      }
Dries's avatar
   
Dries committed
877
    }
Dries's avatar
   
Dries committed
878
  }
Dries's avatar
   
Dries committed
879
880
}

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

Dries's avatar
   
Dries committed
883
884
885
886
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Dries's avatar
   
Dries committed
887
888

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

Dries's avatar
   
Dries committed
891
function field_get($string, $name) {
892
  ereg(",?$name=([^,]+)", ", $string", $regs);
Dries's avatar
   
Dries committed
893
894
895
896
897
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
898
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
899
900
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
901
902
903
904
  return substr($rval, 1);
}

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

907
908
909
910
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
911
    $links = module_invoke_all("link", "page");
912
    array_unshift($links, "<a href=\"$base_url/\" title=\"". t("Return to the main page.") ."\">". t("home") ."</a>");
913
    return $links;
Dries's avatar
   
Dries committed
914
  }
Dries's avatar
   
Dries committed
915
}
Dries's avatar
   
Dries committed
916
917

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
918
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
   
Dries committed
919
920
921
922
}

function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
923
924
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
925
926
}

Dries's avatar
   
Dries committed
927
function drupal_page_header() {
Dries's avatar
   
Dries committed
928
929
930
931
932
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
933
934
935
936
    if ($cache = page_get_cache()) {
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
      header("Last-Modified: $date");
      header("ETag: \"$date\"");
937
938
939
940
941
942
      if (function_exists("getallheaders") && $headers = getallheaders()) {
        /*
        ** Notice that the above is an optional Apache-ism so for the
        ** time being we don't send 304 headers when "getallheaders()"
        ** is not supported (eg. on IIS webservers).
        */
Dries's avatar
   
Dries committed
943
944
945
946
947
948
        if ($headers["If-Modified-Since"] == $date && $headers["If-None-Match"] == "\"$date\"") {
          header("HTTP/1.0 304 Not Modified");
          exit();
        }
      }
      print $cache->data;
Dries's avatar
   
Dries committed
949
950
951
952
953
      exit();
    }
  }
}

Dries's avatar
   
Dries committed
954
function drupal_page_footer() {
Dries's avatar
   
Dries committed
955
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
956
    page_set_cache();
Dries's avatar
   
Dries committed
957
  }
Dries's avatar
   
Dries committed
958
959
960
961

  // 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
962
963
964
}

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

966
967
$config = conf_init();

Dries's avatar
   
Dries committed
968
969
970
971
include_once "includes/$config.php";
include_once "includes/database.inc";
include_once "includes/module.inc";
include_once "includes/theme.inc";
Dries's avatar
   
Dries committed
972
include_once "includes/pager.inc";
Dries's avatar
   
Dries committed
973
include_once "includes/menu.inc";
Dries's avatar
   
Dries committed
974
include_once "includes/xmlrpc.inc";
975

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

Dries's avatar
   
Dries committed
979
980
981
// set error handler:
set_error_handler("error_handler");

Dries's avatar
   
Dries committed
982
983
984
// initialize installed modules:
module_init();

Dries's avatar
   
Dries committed
985
986
987
988
989
990
// initialize localization system:
$locale = locale_init();

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

Dries's avatar
   
Dries committed
991
?>