common.inc 23.8 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 ('$user->uid', '%s', '%s', '%s', '%s', '%s', '%s')", $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
110
  if (!$brief) {
    $path = "http://". $path;
  }
  return $path;
Dries's avatar
   
Dries committed
111
112
}

Dries's avatar
   
Dries committed
113
function request_uri() {
Dries's avatar
   
Dries committed
114
115
116
117
  // 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
118
  if (isset($REQUEST_URI)) {
Dries's avatar
   
Dries committed
119
120
121
    return $REQUEST_URI;
  }
  else {
122
    return $PATH_INFO ."?". $QUERY_STRING;
Dries's avatar
   
Dries committed
123
  }
Dries's avatar
   
Dries committed
124
125
}

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

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

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

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

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

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

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

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

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

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

  unset($conf[$name]);
}

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

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

  return $output;
}

function table($header, $rows) {

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

  /*
  ** Emit the table header:
  */

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

  /*
  ** Emit the table rows:
  */

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

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

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

  return $output;
}

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

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

  return $output;
}

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

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

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

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

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

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

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

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

  $keys = check_input($keys);

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

  return $output;
}

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

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

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

Dries's avatar
   
Dries committed
386

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

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

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

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

  /*
  ** 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
429
  global $referer, $HTTP_REFERER;
Dries's avatar
   
Dries committed
430

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

Dries's avatar
   
Dries committed
456
457
function check_query($text) {
  return addslashes(stripslashes($text));
Dries's avatar
   
Dries committed
458
459
}

Dries's avatar
   
Dries committed
460
function check_input($text) {
Dries's avatar
   
Dries committed
461
462
463
464
465
  return addslashes(stripslashes($text));
}

function filter($text) {
  foreach (module_list() as $name) {
Kjartan's avatar
Kjartan committed
466
467
468
    if (module_hook($name, "filter")) {
      $text = module_invoke($name, "filter", $text);
    }
Dries's avatar
   
Dries committed
469
470
471
472
473
  }

  return $text;
}

Dries's avatar
   
Dries committed
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
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
  ** (ie. "on output"), however When these rewrite rules have been tested
  ** enough, we will use them to permanently rewrite the links in node 
  ** and comment bodies.
  */

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

  return $text;
}

Dries's avatar
   
Dries committed
490
function check_output($text) {
Dries's avatar
   
Dries committed
491
  if (isset($text)) {
Dries's avatar
   
Dries committed
492
493
494
495

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

Dries's avatar
   
Dries committed
496
497
    $text = stripslashes($text);

Dries's avatar
   
Dries committed
498
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries's avatar
   
Dries committed
499
500
501
502
503
504
505
506
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries's avatar
   
Dries committed
507
508
509
510
511
512
513
514
515
516
517
}

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

Dries's avatar
   
Dries committed
518
519
520
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
521
522
523
524
525
  $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
526
  foreach ($args as $key => $value) {
527
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
528
  }
Dries's avatar
   
Dries committed
529
530
531
532
533
534
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
   
Dries committed
538
539
540
  $output .= "<item>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
541
  $output .= " <description>". htmlentities(check_output($description)) ."</description>\n";
Dries's avatar
   
Dries committed
542
  foreach ($args as $key => $value) {
543
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
544
  }
Dries's avatar
   
Dries committed
545
546
547
548
549
550
551
552
553
554
  $output .= "</item>\n";

  return $output;
}

function format_plural($count, $singular, $plural) {
  return ($count == 1) ? "$count ". t($singular) : "$count ". t($plural);
}

function format_size($size) {
Dries's avatar
   
Dries committed
555
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
556
557
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
558
    $suffix = t("KB");
Dries's avatar
   
Dries committed
559
560
561
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
562
    $suffix = t("MB");
Dries's avatar
   
Dries committed
563
  }
Dries's avatar
   
Dries committed
564
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
565
566
}

Dries's avatar
   
Dries committed
567
function cache_get($key) {
Dries's avatar
   
Dries committed
568
569
570
  $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
571
572
573
}

function cache_set($cid, $data, $expire = 0) {
Dries's avatar
   
Dries committed
574
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
Dries's avatar
   
Dries committed
575
    db_query("UPDATE cache SET data = '%s', created = %d, expire = %d WHERE cid = '%s'", $data, time(), $expire, $cid);
Dries's avatar
   
Dries committed
576
577
  }
  else {
Dries's avatar
   
Dries committed
578
    db_query("INSERT INTO cache (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries's avatar
   
Dries committed
579
  }
Dries's avatar
   
Dries committed
580
581
}

Dries's avatar
   
Dries committed
582
583
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries's avatar
   
Dries committed
584
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries's avatar
   
Dries committed
585
586
587
588
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s'", $cid);
  }
Dries's avatar
   
Dries committed
589
590
}

Dries's avatar
   
Dries committed
591
592
593
594
595
596
597
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
598
599
600
}

function page_set_cache() {
Dries's avatar
   
Dries committed
601
  global $user, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
602
603

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
604
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
605
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries's avatar
   
Dries committed
606
607
608
609
    }
  }
}

Dries's avatar
   
Dries committed
610
function page_get_cache() {
Dries's avatar
   
Dries committed
611
  global $user, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
612
613

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
614
    if ($cache = cache_get(request_uri())) {
Dries's avatar
   
Dries committed
615
      cache_clear_old();
Dries's avatar
   
Dries committed
616
617
618
    }
    else {
      ob_start();
Dries's avatar
   
Dries committed
619
620
    }
  }
Dries's avatar
   
Dries committed
621

Dries's avatar
   
Dries committed
622
  return $cache;
Dries's avatar
   
Dries committed
623
624
625
626
}

function format_interval($timestamp) {
  $units = array("year|years" => 31536000, "week|weeks" => 604800, "day|days" => 86400, "hour|hours" => 3600, "min|min" => 60, "sec|sec" => 1);
Kjartan's avatar
Kjartan committed
627
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
628
629
630
631
632
633
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
   
Dries committed
634
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
635
636
637
638
639
}

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

Kjartan's avatar
Kjartan committed
640
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
641
642
643

  switch ($type) {
    case "small":
Dries's avatar
   
Dries committed
644
      $date = date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
645
646
      break;
    case "medium":
Dries's avatar
   
Dries committed
647
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
648
649
650
651
652
653
654
      break;
    case "large":
      $date = t(date("l", $timestamp)) .", ". t(date("F", $timestamp)) ." ". date("d, Y - H:i", $timestamp);
      break;
    case "custom":
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
655
          $date = t(date($c, $timestamp)) . $date;
Dries's avatar
   
Dries committed
656
        }
657
658
        else if (strstr("AaBdgGhHiIjLmnrstTUWYyZz", $c)) {
          $date = date($c, $timestamp) . $date;
Dries's avatar
   
Dries committed
659
660
        }
        else {
Kjartan's avatar
Kjartan committed
661
          $date = $c.$date;
Dries's avatar
   
Dries committed
662
663
664
665
        }
      }
      break;
    default:
Dries's avatar
   
Dries committed
666
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
667
668
669
670
671
  }
  return $date;
}

function format_name($object) {
Dries's avatar
   
Dries committed
672
  global $PHP_SELF;
Dries's avatar
   
Dries committed
673
674

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
675
676
    if (strstr($PHP_SELF, "admin")) {
      $output = l($object->name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
677
678
    }
    else {
Dries's avatar
   
Dries committed
679
      $output = l($object->name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
680
    }
Dries's avatar
   
Dries committed
681
682
  }
  else {
Dries's avatar
   
Dries committed
683
    $output = t(variable_get(anonymous, "Anonymous"));
Dries's avatar
   
Dries committed
684
685
  }

Dries's avatar
   
Dries committed
686
  return $output;
Dries's avatar
   
Dries committed
687
688
689
}

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

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

697
698
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
699
700
701
702
703
704
705
706
707
708
709
710
711
712
}

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
713
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
714
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
715
    foreach ($options as $key=>$choice) {
Dries's avatar
   
Dries committed
716
717
      $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($key == $value ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
    }
Kjartan's avatar
Kjartan committed
718
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
   
Dries committed
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
  }
}

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
734
735
736
737
738
739
740
741
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
742
function url($url = NULL, $query = NULL) {
Dries's avatar
   
Dries committed
743

Dries's avatar
   
Dries committed
744
745
  if (isset($url)) {
    if (isset($query)) {
Dries's avatar
   
Dries committed
746
747
748
749
750
751
752
      return "?q=$url&$query";
    }
    else {
      return "?q=$url";
    }
  }
  else {
Dries's avatar
   
Dries committed
753
    if (isset($query)) {
Dries's avatar
   
Dries committed
754
755
      return "?$query";
    }
Dries's avatar
   
Dries committed
756
757
758
    else {
      return "";
    }
Dries's avatar
   
Dries committed
759
  }
Dries's avatar
   
Dries committed
760
761
}

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

Dries's avatar
   
Dries committed
764
765
766
767
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Dries's avatar
   
Dries committed
768
769

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

Dries's avatar
   
Dries committed
772
function field_get($string, $name) {
Kjartan's avatar
Kjartan committed
773
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries's avatar
   
Dries committed
774
775
776
777
778
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
779
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
780
781
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
782
783
784
785
  return substr($rval, 1);
}

function link_page() {
786
  global $custom_links;
Dries's avatar
   
Dries committed
787

788
789
790
791
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
792
    $links[] = "<a href=\"index.php\" title=\"". t("Return to the main page.") ."\">". t("home") ."</a>";
Dries's avatar
   
Dries committed
793

Dries's avatar
   
Dries committed
794
    foreach (module_list() as $name) {
795
796
      if (module_hook($name, "link")) {
        $links = array_merge($links, module_invoke($name, "link", "page"));
Dries's avatar
   
Dries committed
797
      }
Dries's avatar
   
Dries committed
798
    }
Dries's avatar
   
Dries committed
799

800
    return $links;
Dries's avatar
   
Dries committed
801
  }
Dries's avatar
   
Dries committed
802
}
Dries's avatar
   
Dries committed
803
804

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
805
806
  $links = array();

Dries's avatar
   
Dries committed
807
808
809
810
811
812
  foreach (module_list() as $name) {
    if (module_hook($name, "link")) {
      $links = array_merge($links, module_invoke($name, "link", "node", $node, $main));
    }
  }

Dries's avatar
   
Dries committed
813
  return $links;
Dries's avatar
   
Dries committed
814
815
816
817
}

function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
818
819
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
820
821
822
823
}

function timer_print() {
  global $timer;
Dries's avatar
   
Dries committed
824
825
826
827
  list($usec, $sec) = explode(" ", microtime());
  $stop = (float)$usec + (float)$sec;
  $diff = $stop - $timer;
  print "<pre>execution time: $diff sec</pre>";
Dries's avatar
   
Dries committed
828
829
830
831
832
833
834
}

function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries's avatar
   
Dries committed
835
836
837
838
839
840
841
842
}

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

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
843
844
845
846
847
848
849
850
851
852
853
854
    if ($cache = page_get_cache()) {
      $date = gmdate("D, d M Y H:i:s", $cache->created) ." GMT";
      header("Last-Modified: $date");
      header("ETag: \"$date\"");
      if ($headers = getallheaders()) {
        // NOTE: the above is an Apache-ism so for the time being we don't send 304 headers to IIS servers.
        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
855
856
857
858
859
860
861
862
863
864
      exit();
    }
  }
}

function page_footer() {
  if (variable_get("dev_timer", 0)) {
    timer_print();
  }

Dries's avatar
   
Dries committed
865
866
867
868
  if (variable_get("dev_query", 0)) {
    query_print();
  }

Dries's avatar
   
Dries committed
869
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
870
    page_set_cache();
Dries's avatar
   
Dries committed
871
872
873
874
  }
}

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

876
877
$config = conf_init();

Dries's avatar
   
Dries committed
878
879
880
881
882
include_once "includes/$config.php";
include_once "includes/database.inc";
include_once "includes/xmlrpc.inc";
include_once "includes/module.inc";
include_once "includes/theme.inc";
Dries's avatar
   
Dries committed
883
include_once "includes/pager.inc";
Dries's avatar
   
Dries committed
884
include_once "includes/menu.inc";
Dries's avatar
   
Dries committed
885

886
887
// initialize configuration variables, using values from conf.php if available:
$conf = variable_init(isset($conf) ? $conf : array());
Dries's avatar
   
Dries committed
888
889
890
891
892
893
894
895
896
897
898
899
900
901

// initialize installed modules:
module_init();

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

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

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

?>