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

function conf_init() {
Dries's avatar
   
Dries committed
5
  global $HTTP_HOST, $PHP_SELF;
Dries's avatar
   
Dries committed
6
7
8
9
10
11
12

  /*
  ** 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
13
14
15
  $uri = $PHP_SELF;

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

  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
32
  if (($errno == 1 || $errno == 2 || $errno == 4 || $errno == 256) && error_reporting()) {
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', '%s')", $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
66
67
68
69
70
71
72
function arg($index) {

  global $q;
  static $arguments;

  if (empty($arguments)) {
    $arguments = explode("/", $q);
  }

  return $arguments[$index];
}

Dries's avatar
   
Dries committed
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
100
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
101
function path_uri($brief = 0) {
Dries's avatar
   
Dries committed
102
103
104
105
106
  global $HTTP_HOST, $PHP_SELF;

  $uri = $PHP_SELF;
  $path = $HTTP_HOST . substr($uri, 0, strrpos($uri, "/")) ."/";

Dries's avatar
   
Dries committed
107
108
109
  if (!$brief) {
    $path = "http://". $path;
  }
Dries's avatar
   
Dries committed
110

Dries's avatar
   
Dries committed
111
  return $path;
Dries's avatar
   
Dries committed
112
113
}

Dries's avatar
   
Dries committed
114
function request_uri() {
Dries's avatar
   
Dries committed
115
116
117
118
  // since request_uri() is only available on apache, we generate equivalent using other environment vars.

  global $REQUEST_URI, $PATH_INFO, $QUERY_STRING;

Dries's avatar
   
Dries committed
119
  if (isset($REQUEST_URI)) {
Dries's avatar
   
Dries committed
120
121
122
    return $REQUEST_URI;
  }
  else {
123
    return $PATH_INFO ."?". $QUERY_STRING;
Dries's avatar
   
Dries committed
124
  }
Dries's avatar
   
Dries committed
125
126
}

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

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
139
140
141
142
143
function locale_init() {
  global $languages, $user;
  return ($languages ? (($user->uid && $user->language) ? $user->language : key($languages)) : 0);
}

Dries's avatar
   
Dries committed
144
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
145
  global $languages;
146

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

158
159
  $string = ($languages && function_exists("locale") ? locale($string) : $string);

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

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
172
      $conf[$variable->name] = unserialize($variable->value);
Dries's avatar
   
Dries committed
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
    }
  }

  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
188
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
189
  db_query("INSERT INTO variable (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries's avatar
   
Dries committed
190
191
192
193
194
195
196

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries's avatar
   
Dries committed
197
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
198
199
200
201

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
202
function table_cell($cell, $header = 0) {
Dries's avatar
   
Dries committed
203
  if (is_array($cell)) {
Dries's avatar
   
Dries committed
204
205
206
207
208
209
210
211
212
213
214
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

Dries's avatar
   
Dries committed
215
  if ($header) {
Dries's avatar
   
Dries committed
216
217
218
219
220
221
222
223
224
225
226
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

Dries's avatar
   
Dries committed
227
  $output .= "<table>\n";
Dries's avatar
   
Dries committed
228
229
230
231
232

  /*
  ** Emit the table header:
  */

Dries's avatar
   
Dries committed
233
234
235
236
237
  if (is_array($header)) {
    $output .= " <tr>";
    foreach ($header as $cell) {
      $output .= table_cell($cell, 1);
    }
Dries's avatar
   
Dries committed
238
    $output .= " </tr>\n";
Dries's avatar
   
Dries committed
239
240
241
242
243
244
  }

  /*
  ** Emit the table rows:
  */

Dries's avatar
   
Dries committed
245
246
247
248
249
250
251
252
  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
253

Dries's avatar
   
Dries committed
254
255
256
      foreach ($row as $cell) {
        $output .= table_cell($cell, 0);
      }
Dries's avatar
   
Dries committed
257
      $output .= " </tr>\n";
Dries's avatar
   
Dries committed
258
259
260
    }
  }

Dries's avatar
   
Dries committed
261
  $output .= "</table>\n";
Dries's avatar
   
Dries committed
262
263
264
265

  return $output;
}

Kjartan's avatar
Kjartan committed
266
267
268
269
/**
 * 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
270
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
271
272
273
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
   
Dries committed
274
function search_item($item, $type) {
Dries's avatar
   
Dries committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288

  /*
  ** 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
289
290
291
292

  return $output;
}

Kjartan's avatar
Kjartan committed
293
294
295
296
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
297
 * 'site.com/search', but also as a simple seach box (without
Dries's avatar
   
Dries committed
298
299
 * "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
300
301
 * parts of this form.
 *
Dries's avatar
   
Dries committed
302
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan's avatar
Kjartan committed
303
 * @param $query   Query string. Defaults to global $keys.
Dries's avatar
   
Dries committed
304
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
305
306
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries committed
307
308
309
310
function search_form($action = 0, $query = 0, $options = 0) {
  global $keys;

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

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

Kjartan's avatar
Kjartan committed
318
319
  $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
320
321
322
323
324
325
326

  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
327
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
328
329
330
331
      }
    }
  }

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

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

/*
Kjartan's avatar
Kjartan committed
338
339
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
340
341
342
function search_data() {
  global $keys, $edit;

Dries's avatar
   
Dries committed
343
  if (isset($keys)) {
Dries's avatar
   
Dries committed
344
345
    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
346
        if ($name == "node" || $name == "comment") {
Dries's avatar
   
Dries committed
347
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan's avatar
Kjartan committed
348
349
        }
        else {
Dries's avatar
   
Dries committed
350
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan's avatar
Kjartan committed
351
        }
Dries's avatar
   
Dries committed
352
353
354
355
356
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
Kjartan's avatar
Kjartan committed
357
    if (!$output) {
Dries's avatar
   
Dries committed
358
359
360
361
362
363
364
      $output .= t("Your search yielded no results.");
    }
  }

  return $output;
}

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

Dries's avatar
   
Dries committed
378
  if (isset($type)) {
Dries's avatar
   
Dries committed
379
380
381
382
383
384
    $edit["type"][$type] = "on";
  }

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

Dries's avatar
   
Dries committed
385

Dries's avatar
   
Dries committed
386
387
function drupal_goto($url) {

Dries's avatar
   
Dries committed
388
389
390
  /*
  ** Translate &amp; to simply &
  */
Dries's avatar
   
Dries committed
391

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

Dries's avatar
   
Dries committed
394
395
396
397
398
  /*
  ** 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
399
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries's avatar
   
Dries committed
400
401
402
    header("Location: $url");
  }
  else {
Dries's avatar
   
Dries committed
403
404
405
406
407
408
409
410
    $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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
  ** deamon.  In some cases this can go wrong, so we make sure none
  ** 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
427
  global $referer, $HTTP_REFERER;
Dries's avatar
   
Dries committed
428

Dries's avatar
   
Dries committed
429
  if (!strstr($HTTP_REFERER, request_uri())) {
Dries's avatar
   
Dries committed
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
    $referer = $HTTP_REFERER;
    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
451
  return htmlspecialchars($text);
Dries's avatar
   
Dries committed
452
453
}

Dries's avatar
   
Dries committed
454
function check_query($text) {
Dries's avatar
   
Dries committed
455
  return addslashes($text);
Dries's avatar
   
Dries committed
456
457
}

Dries's avatar
   
Dries committed
458
function check_input($text) {
Dries's avatar
   
Dries committed
459
  return addslashes($text);
Dries's avatar
   
Dries committed
460
461
462
}

function filter($text) {
Dries's avatar
   
Dries committed
463
464
465
466
467
468
469
470

  foreach (module_list() as $name) {
    if (module_hook($name, "filter")) {
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries's avatar
   
Dries committed
471
472
}

Dries's avatar
   
Dries committed
473
474
475
476
477
function rewrite_old_urls($text) {

  /*
  ** 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
478
479
  ** (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
480
481
482
  ** and comment bodies.
  */

Dries's avatar
   
Dries committed
483
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
484
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
   
Dries committed
485
    $text = eregi_replace("(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "?q=\\1/view/\\2/\\4", $text);
Dries's avatar
   
Dries committed
486

Dries's avatar
   
Dries committed
487
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
488
489
490
    $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);
Dries's avatar
   
Dries committed
491
492
493
  }
  else {
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries's avatar
   
Dries committed
494
    $text = eregi_replace("(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "\\1/view/\\2/\\4", $text);
Dries's avatar
   
Dries committed
495
496

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries's avatar
   
Dries committed
497
498
499
    $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);
Dries's avatar
   
Dries committed
500
  }
Dries's avatar
   
Dries committed
501

Dries's avatar
   
Dries committed
502
503
504
  return $text;
}

Dries's avatar
   
Dries committed
505
function check_output($text) {
Dries's avatar
   
Dries committed
506
  if (isset($text)) {
Dries's avatar
   
Dries committed
507
508
509
510

    // temporary: for development purpose
    $text = rewrite_old_urls($text);

Dries's avatar
   
Dries committed
511
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
   
Dries committed
512
513
514
515
516
517
518
519
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
   
Dries committed
520
521
522
523
524
525
526
527
528
529
530
}

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

Dries's avatar
   
Dries committed
531
532
533
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
534
535
536
537
538
  $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
539
  foreach ($args as $key => $value) {
540
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
541
  }
Dries's avatar
   
Dries committed
542
543
544
545
546
547
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
   
Dries committed
551
552
553
  $output .= "<item>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
554
  $output .= " <description>". htmlentities(check_output($description)) ."</description>\n";
Dries's avatar
   
Dries committed
555
  foreach ($args as $key => $value) {
556
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
557
  }
Dries's avatar
   
Dries committed
558
559
560
561
562
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
/**
 * 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
577
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
578
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
579
580
581
}

function format_size($size) {
Dries's avatar
   
Dries committed
582
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
583
584
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
585
    $suffix = t("KB");
Dries's avatar
   
Dries committed
586
587
588
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
589
    $suffix = t("MB");
Dries's avatar
   
Dries committed
590
  }
Dries's avatar
   
Dries committed
591
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
592
593
}

Dries's avatar
   
Dries committed
594
function cache_get($key) {
Dries's avatar
   
Dries committed
595
596
597
  $cache = db_fetch_object(db_query("SELECT data, created FROM cache WHERE cid = '%s'", $key));
  $created = $cache->created;
  return $cache->data ? $cache : 0;
Dries's avatar
   
Dries committed
598
599
600
}

function cache_set($cid, $data, $expire = 0) {
Dries's avatar
   
Dries committed
601
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
Dries's avatar
   
Dries committed
602
    db_query("UPDATE cache SET data = '%s', created = %d, expire = %d WHERE cid = '%s'", $data, time(), $expire, $cid);
Dries's avatar
   
Dries committed
603
604
  }
  else {
Dries's avatar
   
Dries committed
605
    db_query("INSERT INTO cache (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries's avatar
   
Dries committed
606
  }
Dries's avatar
   
Dries committed
607
608
}

Dries's avatar
   
Dries committed
609
610
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
   
Dries committed
611
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries's avatar
   
Dries committed
612
613
614
615
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s'", $cid);
  }
Dries's avatar
   
Dries committed
616
617
}

Dries's avatar
   
Dries committed
618
619
620
621
622
623
624
function cache_clear_old($cid = NULL) {
  if (empty($cid)) {
    db_query("DELETE FROM cache WHERE expire < ". time() ." AND expire > 0");
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s' AND expire < %s AND expire > 0", $cid, time());
  }
Dries's avatar
   
Dries committed
625
626
627
}

function page_set_cache() {
Dries's avatar
   
Dries committed
628
  global $user, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
629
630

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
631
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
632
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries's avatar
   
Dries committed
633
634
635
636
    }
  }
}

Dries's avatar
   
Dries committed
637
function page_get_cache() {
Dries's avatar
   
Dries committed
638
  global $user, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
639
640

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
641
    if ($cache = cache_get(request_uri())) {
Dries's avatar
   
Dries committed
642
      cache_clear_old();
Dries's avatar
   
Dries committed
643
644
645
    }
    else {
      ob_start();
Dries's avatar
   
Dries committed
646
647
    }
  }
Dries's avatar
   
Dries committed
648

Dries's avatar
   
Dries committed
649
  return $cache;
Dries's avatar
   
Dries committed
650
651
652
}

function format_interval($timestamp) {
Dries's avatar
   
Dries committed
653
  $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
654
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
655
656
657
658
659
660
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
   
Dries committed
661
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
662
663
664
665
666
}

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

Kjartan's avatar
Kjartan committed
667
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
668
669
670

  switch ($type) {
    case "small":
Dries's avatar
   
Dries committed
671
      $date = date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
672
673
      break;
    case "medium":
674
      $date = date(variable_get("date_format_medium", "D, m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
675
676
      break;
    case "large":
677
      $date = date(variable_get("date_format_long", "l, F j, Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
678
679
680
681
      break;
    case "custom":
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
682
          $date = t(date($c, $timestamp)) . $date;
Dries's avatar
   
Dries committed
683
        }
684
685
        else if (strstr("AaBdgGhHiIjLmnrstTUWYyZz", $c)) {
          $date = date($c, $timestamp) . $date;
Dries's avatar
   
Dries committed
686
687
        }
        else {
Kjartan's avatar
Kjartan committed
688
          $date = $c.$date;
Dries's avatar
   
Dries committed
689
690
691
692
        }
      }
      break;
    default:
693
      $date = date(variable_get("date_format_medium", "l, m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
694
695
696
697
698
699
700
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
701
    if (arg(0) == "admin") {
Dries's avatar
   
Dries committed
702
      $output = l($object->name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
703
704
    }
    else {
Dries's avatar
   
Dries committed
705
      $output = l($object->name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
706
    }
Dries's avatar
   
Dries committed
707
  }
Dries's avatar
   
Dries committed
708
709
710
711
712
713
714
715
716
717
  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
718
  else {
Dries's avatar
   
Dries committed
719
    $output = t(variable_get(anonymous, "Anonymous"));
Dries's avatar
   
Dries committed
720
721
  }

Dries's avatar
   
Dries committed
722
  return $output;
Dries's avatar
   
Dries committed
723
724
725
}

function form($form, $method = "post", $action = 0, $options = 0) {
726
  return "<form action=\"". ($action ? $action : htmlentities(request_uri())) ."\" method=\"$method\"". ($options ? " $options" : "") .">\n$form</form>\n";
Dries's avatar
   
Dries committed
727
728
729
}

function form_item($title, $value, $description = 0) {
730
  return "<p>". ($title ? "<b>$title:</b><br />" : "") . $value . ($description ? "<br /><small><i>$description</i></small>" : "") ."</p>\n";
Dries's avatar
   
Dries committed
731
732
}

733
734
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0) {
  return form_item(0, "<input type=\"checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") ." /> $title", $description);
Dries's avatar
   
Dries committed
735
736
737
738
739
740
741
742
743
744
745
746
747
748
}

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) {
  return form_item($title, "<textarea wrap=\"virtual\" cols=\"$cols\" rows=\"$rows\" name=\"edit[$name]\">". check_form($value) ."</textarea>", $description);
}

Dries's avatar
   
Dries committed
749
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
750
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
751
    foreach ($options as $key=>$choice) {
752
      $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
753
    }
Kjartan's avatar
Kjartan committed
754
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
   
Dries committed
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
  }
}

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
770
771
772
773
774
775
776
777
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
  for ($n = (-1*$delta); $n <= $delta; $n++) {
    $weights[$n] = $n;
  }

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

Dries's avatar
   
Dries committed
778
function url($url = NULL, $query = NULL) {
Dries's avatar
   
Dries committed
779
  global $base_url;
Dries's avatar
   
Dries committed
780

Dries's avatar
   
Dries committed
781
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
782
783
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
784
        return "?q=$url&amp;$query";
Dries's avatar
   
Dries committed
785
786
      }
      else {
Dries's avatar
   
Dries committed
787
        return "?q=$url";
Dries's avatar
   
Dries committed
788
      }
Dries's avatar
   
Dries committed
789
790
    }
    else {
Dries's avatar
   
Dries committed
791
      if (isset($query)) {
Dries's avatar
   
Dries committed
792
        return "?$query";
Dries's avatar
   
Dries committed
793
794
      }
      else {
Dries's avatar
   
Dries committed
795
        return "";
Dries's avatar
   
Dries committed
796
      }
Dries's avatar
   
Dries committed
797
798
799
    }
  }
  else {
Dries's avatar
   
Dries committed
800
801
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
   
Dries committed
802
        return "$base_url/$url?$query";
Dries's avatar
   
Dries committed
803
804
      }
      else {
Dries's avatar
   
Dries committed
805
        return "$base_url/$url";
Dries's avatar
   
Dries committed
806
      }
Dries's avatar
   
Dries committed
807
    }
Dries's avatar
   
Dries committed
808
    else {
Dries's avatar
   
Dries committed
809
      if (isset($query)) {
Dries's avatar
   
Dries committed
810
        return "$base_url/?$query";
Dries's avatar
   
Dries committed
811
812
      }
      else {
Dries's avatar
   
Dries committed
813
        return "$base_url";
Dries's avatar
   
Dries committed
814
      }
Dries's avatar
   
Dries committed
815
    }
Dries's avatar
   
Dries committed
816
  }
Dries's avatar
   
Dries committed
817
818
}

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

Dries's avatar
   
Dries committed
821
822
823
824
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Dries's avatar
   
Dries committed
825
826

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

Dries's avatar
   
Dries committed
829
function field_get($string, $name) {
Dries's avatar
Dries committed
830
  ereg(",$name=([^,]+)", ", $string", $regs);
Dries's avatar
   
Dries committed
831
832
833
834
835
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
836
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
837
838
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
839
840
841
842
  return substr($rval, 1);
}

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

845
846
847
848
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
849
    $links = module_invoke_all("link", "page");
Dries's avatar
   
Dries committed
850
    array_unshift($links, "<a href=\"$base_url\" title=\"". t("Return to the main page.") ."\">". t("home") ."</a>");
851
    return $links;
Dries's avatar
   
Dries committed
852
  }
Dries's avatar
   
Dries committed
853
}
Dries's avatar
   
Dries committed
854
855

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
856
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
   
Dries committed
857
858
859
860
}

function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
861
862
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
863
864
}

Dries's avatar
   
Dries committed
865
866
867
868
869
function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries's avatar
   
Dries committed
870
871
872
873
874
875
876
877
}

function page_header() {
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
878
879
880
881
    if ($cache = page_get_cache()) {
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
      header("Last-Modified: $date");
      header("ETag: \"$date\"");
882
883
884
885
886
887
      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
888
889
890
891
892
893
        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
894
895
896
897
898
899
      exit();
    }
  }
}

function page_footer() {
Dries's avatar
   
Dries committed
900

Dries's avatar
   
Dries committed
901
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
902
    page_set_cache();
Dries's avatar
   
Dries committed
903
  }
Dries's avatar
   
Dries committed
904
905
906
907

  // 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
908
909
910
}

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

912
913
$config = conf_init();

Dries's avatar
   
Dries committed
914
915
916
917
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
918
include_once "includes/pager.inc";
Dries's avatar
   
Dries committed
919
include_once "includes/menu.inc";
Dries's avatar
   
Dries committed
920

921
922
923
924
if (!function_exists("xmlrpc_decode")) {
  include_once "includes/xmlrpc.inc";
}

925
926
// initialize configuration variables, using values from conf.php if available:
$conf = variable_init(isset($conf) ? $conf : array());
Dries's avatar
   
Dries committed
927
928
929
930
931
932
933
934
935
936
937
938
939
940

// initialize installed modules:
module_init();

// initialize localization system:
$locale = locale_init();

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

// set error handler:
set_error_handler("error_handler");

?>