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

function conf_init() {
Dries Buytaert's avatar
   
Dries Buytaert committed
5
  global $HTTP_HOST;
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
13
  $file = strtolower(strtr($HTTP_HOST . substr(request_uri(), 0, strrpos(request_uri(), "/")), "/:", ".."));
Dries Buytaert's avatar
   
Dries Buytaert committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

  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 Buytaert's avatar
   
Dries Buytaert committed
30
  if (($errno == 1 || $errno == 2 || $errno == 4 || $errno == 256) && error_reporting()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
31
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
32
    print "<pre>$entry</pre>";
Dries Buytaert's avatar
   
Dries Buytaert committed
33
34
35
36
37
  }
}

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

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 Buytaert's avatar
   
Dries Buytaert committed
53
54
55
56
57
58
function check_php_setting($name, $value) {
  if (ini_get($name) != $value) {
    print "<p>Note tat 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 Buytaert's avatar
   
Dries Buytaert committed
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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 Buytaert's avatar
   
Dries Buytaert committed
87
function path_uri($brief = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
88
89
  global $HTTP_HOST;
  $path = $HTTP_HOST . substr(request_uri(), 0, strrpos(request_uri(), "/")) ."/";
Dries Buytaert's avatar
   
Dries Buytaert committed
90
91
92
93
  if (!$brief) {
    $path = "http://". $path;
  }
  return $path;
Dries Buytaert's avatar
   
Dries Buytaert committed
94
95
}

Dries Buytaert's avatar
   
Dries Buytaert committed
96
function request_uri() {
Dries Buytaert's avatar
   
Dries Buytaert committed
97
98
99
100
101
102
103
104
  // since request_uri() is only available on apache, we generate equivalent using other environment vars.

  global $REQUEST_URI, $PATH_INFO, $QUERY_STRING;

  if ($REQUEST_URI) {
    return $REQUEST_URI;
  }
  else {
105
    return $PATH_INFO ."?". $QUERY_STRING;
Dries Buytaert's avatar
   
Dries Buytaert committed
106
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
107
108
}

Dries Buytaert's avatar
   
Dries Buytaert committed
109
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
110
  return t("You are not authorized to access this page.");
Dries Buytaert's avatar
   
Dries Buytaert committed
111
112
113
114
115
116
117
118
119
120
}

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 Buytaert's avatar
   
Dries Buytaert committed
121
122
123
124
125
function locale_init() {
  global $languages, $user;
  return ($languages ? (($user->uid && $user->language) ? $user->language : key($languages)) : 0);
}

Dries Buytaert's avatar
   
Dries Buytaert committed
126
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
127
  global $languages;
128

Dries Buytaert's avatar
   
Dries Buytaert committed
129
130
131
132
133
134
135
136
137
138
139
140
  /*
  ** 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
  **           account</a> before viewing the next page.", array ("%url"
  **           => drupal_url(array ("mod" => "user", "op" => "register"),
  **           "module")));
  */

141
142
  $string = ($languages && function_exists("locale") ? locale($string) : $string);

Dries Buytaert's avatar
   
Dries Buytaert committed
143
144
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
145
146
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
147
148
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
149
150
151
152
153
154
}

function variable_init($conf = array()) {
  $result = db_query("SELECT * FROM variable");
  while ($variable = db_fetch_object($result)) {
    if (!isset($conf[$variable->name])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
155
      $conf[$variable->name] = unserialize($variable->value);
Dries Buytaert's avatar
   
Dries Buytaert committed
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
    }
  }

  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 Buytaert's avatar
   
Dries Buytaert committed
171
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries Buytaert's avatar
   
Dries Buytaert committed
172
  db_query("INSERT INTO variable (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries Buytaert's avatar
   
Dries Buytaert committed
173
174
175
176
177
178
179

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries Buytaert's avatar
   
Dries Buytaert committed
180
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries Buytaert's avatar
   
Dries Buytaert committed
181
182
183
184

  unset($conf[$name]);
}

Dries Buytaert's avatar
   
Dries Buytaert committed
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
function table_cell($cell, $header = 0) {
  if (is_array($cell)) {  
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

  if ($header) {
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

  $output .= "<table>";

  /*
  ** Emit the table header:
  */

  $output .= " <tr>";
  foreach ($header as $cell) {
   $output .= table_cell($cell, 1);
  }
  $output .= " </tr>";

  /*
  ** Emit the table rows:
  */

  foreach ($rows as $number => $row) {
    if ($number % 2 == 1) {
      $output .= " <tr class=\"light\">";
    }
    else {
      $output .= " <tr class=\"dark\">";
    }

    foreach ($row as $cell) {
      $output .= table_cell($cell, 0);
    }
    $output .= " </tr>";
  }

  $output .= "</table>";

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
245
246
247
248
/**
 * Format a single result entry of a search query:
 *
 * @param $item  a single search result as returned by <module>_search of type
Dries Buytaert's avatar
   
Dries Buytaert committed
249
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan Mannes's avatar
Kjartan Mannes committed
250
251
252
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
253
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267

  /*
  ** 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 Buytaert's avatar
   
Dries Buytaert committed
268
269
270
271

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
272
273
274
275
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries Buytaert's avatar
   
Dries Buytaert committed
276
277
278
 * module.php?mod=search, but also as a simple seach box (without
 * "Restrict search to", help text, etc) from theme's header etc.
 * This means: provide options to only conditionally render certain
Kjartan Mannes's avatar
Kjartan Mannes committed
279
280
281
282
 * parts of this form.
 *
 * @param $action  Form action. Defaults to module.php?mod=search.
 * @param $query   Query string. Defaults to global $keys.
Dries Buytaert's avatar
   
Dries Buytaert committed
283
 * @param $options != 0: Render additional form fields/text
Kjartan Mannes's avatar
Kjartan Mannes committed
284
285
 *                 ("Restrict search to", help text, etc).
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
286
287
288
289
function search_form($action = 0, $query = 0, $options = 0) {
  global $keys;

  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
290
    $action = drupal_url(array("mod" => "search"), "module");
Dries Buytaert's avatar
   
Dries Buytaert committed
291
292
293
294
295
296
  }

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

Kjartan Mannes's avatar
Kjartan Mannes committed
297
298
  $output .= " <br /><input type=\"text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
  $output .= " <input type=\"submit\" value=\"". t("Search") ."\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
299
300
301
302
303
304
305

  if ($options != 0) {
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan Mannes's avatar
Kjartan Mannes committed
306
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries Buytaert's avatar
   
Dries Buytaert committed
307
308
      }
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
309
310

    // TODO: (link to) search hints
Dries Buytaert's avatar
   
Dries Buytaert committed
311
312
  }

Kjartan Mannes's avatar
Kjartan Mannes committed
313
314
  $form .= "<br />";

Dries Buytaert's avatar
   
Dries Buytaert committed
315
316
317
318
  return form($output, "post", $action);
}

/*
Kjartan Mannes's avatar
Kjartan Mannes committed
319
320
 * Collect the search results:
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
321
322
323
324
325
326
327
328
function search_data() {
  global $keys, $edit;

  $keys = check_input($keys);

  if ($keys) {
    foreach (module_list() as $name) {
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", check_query($keys)))) {
Kjartan Mannes's avatar
Kjartan Mannes committed
329
        if ($name == "node" || $name == "comment") {
Dries Buytaert's avatar
   
Dries Buytaert committed
330
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan Mannes's avatar
Kjartan Mannes committed
331
332
        }
        else {
Dries Buytaert's avatar
   
Dries Buytaert committed
333
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan Mannes's avatar
Kjartan Mannes committed
334
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
335
336
337
338
339
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
340
    if (!$output) {
Dries Buytaert's avatar
   
Dries Buytaert committed
341
342
343
344
345
346
347
      $output .= t("Your search yielded no results.");
    }
  }

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
348
349
350
/**
 * Display the search form and the resulting data.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
351
 * @param $type    If set, search only nodes of this type.
Kjartan Mannes's avatar
Kjartan Mannes committed
352
353
354
 *                 Otherwise, search all types.
 * @param $action  Form action. Defaults to module.php?mod=search.
 * @param $query   Query string. Defaults to global $keys.
Dries Buytaert's avatar
   
Dries Buytaert committed
355
 * @param $options != 0: Render additional form fields/text
Kjartan Mannes's avatar
Kjartan Mannes committed
356
357
 *                 ("Restrict search to", help text, etc).
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
358
359
360
361
362
363
364
365
366
367
function search_type($type = 0, $action = 0, $query = 0, $options = 0) {
  global $edit;

  if ($type) {
    $edit["type"][$type] = "on";
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
368

Dries Buytaert's avatar
   
Dries Buytaert committed
369
370
function drupal_goto($url) {

Dries Buytaert's avatar
   
Dries Buytaert committed
371
372
373
  /*
  ** Translate &amp; to simply &
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
374

Dries Buytaert's avatar
   
Dries Buytaert committed
375
376
  $url = str_replace ("&amp;", "&", $url);

Dries Buytaert's avatar
   
Dries Buytaert committed
377
378
379
380
381
382
  /*
  ** 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 Buytaert's avatar
   
Dries Buytaert committed
383
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, $sid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
384
385
386
    header("Location: $url");
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
387
388
389
390
391
392
393
394
    $sid = session_name() . "=" . session_id();

    if (strstr($url, "?") && !strstr($url, $sid)) {
      header("Location: $url&". $sid);
    }
    else {
      header("Location: $url?". $sid);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
413
  if (!strstr($HTTP_REFERER, request_uri())) {
Dries Buytaert's avatar
   
Dries Buytaert committed
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
    $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 Buytaert's avatar
   
Dries Buytaert committed
438
439
function check_query($text) {
  return addslashes(stripslashes($text));
Dries Buytaert's avatar
   
Dries Buytaert committed
440
441
}

Dries Buytaert's avatar
   
Dries Buytaert committed
442
function check_input($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
443
444
445
446
447
  return addslashes(stripslashes($text));
}

function filter($text) {
  foreach (module_list() as $name) {
Kjartan Mannes's avatar
Kjartan Mannes committed
448
449
450
    if (module_hook($name, "filter")) {
      $text = module_invoke($name, "filter", $text);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
451
452
453
454
455
456
  }

  return $text;
}

function check_output($text, $nl2br = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
457
458
459
  if ($text) {
    $text = stripslashes($text);

Dries Buytaert's avatar
   
Dries Buytaert committed
460
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
461
462
463
464
465
466
467
468
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries Buytaert's avatar
   
Dries Buytaert committed
469
470
471
472
473
474
475
476
477
478
479
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
480
481
482
function format_rss_channel($title, $link, $description, $items, $language = "en", $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
   
Dries Buytaert committed
483
484
485
486
487
  $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 Buytaert's avatar
   
Dries Buytaert committed
488
  foreach ($args as $key => $value) {
489
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
490
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
491
492
493
494
495
496
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
497
498
499
function format_rss_item($title, $link, $description, $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
   
Dries Buytaert committed
500
501
502
503
  $output .= "<item>\n";
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
  $output .= " <description>". htmlentities($description) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
504
  foreach ($args as $key => $value) {
505
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
506
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
507
508
509
510
511
512
513
514
515
516
  $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 Buytaert's avatar
   
Dries Buytaert committed
517
  $suffix = t("bytes");
Dries Buytaert's avatar
   
Dries Buytaert committed
518
519
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
520
    $suffix = t("KB");
Dries Buytaert's avatar
   
Dries Buytaert committed
521
522
523
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
524
    $suffix = t("MB");
Dries Buytaert's avatar
   
Dries Buytaert committed
525
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
526
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
527
528
}

Dries Buytaert's avatar
   
Dries Buytaert committed
529
function cache_get($key) {
Dries Buytaert's avatar
   
Dries Buytaert committed
530
531
532
  $cache = db_fetch_object(db_query("SELECT data, created FROM cache WHERE cid = '%s'", $key));
  $created = $cache->created;
  return $cache->data ? $cache : 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
533
534
535
}

function cache_set($cid, $data, $expire = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
536
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
537
    db_query("UPDATE cache SET data = '%s', created = %d, expire = %d WHERE cid = '%s'", $data, time(), $expire, $cid);
Dries Buytaert's avatar
   
Dries Buytaert committed
538
539
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
540
    db_query("INSERT INTO cache (cid, data, created, expire) VALUES('%s', '%s', %d, %d)", $cid, $data, time(), $expire);
Dries Buytaert's avatar
   
Dries Buytaert committed
541
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
542
543
}

Dries Buytaert's avatar
   
Dries Buytaert committed
544
545
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
546
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries Buytaert's avatar
   
Dries Buytaert committed
547
548
549
550
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s'", $cid);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
551
552
}

Dries Buytaert's avatar
   
Dries Buytaert committed
553
554
555
556
557
558
559
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 Buytaert's avatar
   
Dries Buytaert committed
560
561
562
}

function page_set_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
563
  global $user, $REQUEST_METHOD;
Dries Buytaert's avatar
   
Dries Buytaert committed
564
565

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries Buytaert's avatar
   
Dries Buytaert committed
566
    if ($data = ob_get_contents()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
567
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries Buytaert's avatar
   
Dries Buytaert committed
568
569
570
571
    }
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
572
function page_get_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
573
  global $user, $REQUEST_METHOD;
Dries Buytaert's avatar
   
Dries Buytaert committed
574
575

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries Buytaert's avatar
   
Dries Buytaert committed
576
    if ($cache = cache_get(request_uri())) {
Dries Buytaert's avatar
   
Dries Buytaert committed
577
      cache_clear_old();
Dries Buytaert's avatar
   
Dries Buytaert committed
578
579
580
    }
    else {
      ob_start();
Dries Buytaert's avatar
   
Dries Buytaert committed
581
582
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
583

Dries Buytaert's avatar
   
Dries Buytaert committed
584
  return $cache;
Dries Buytaert's avatar
   
Dries Buytaert committed
585
586
587
588
}

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 Mannes's avatar
Kjartan Mannes committed
589
  foreach ($units as $key=>$value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
590
591
592
593
594
595
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
596
  return ($output) ? $output : t("0 sec");
Dries Buytaert's avatar
   
Dries Buytaert committed
597
598
599
600
601
}

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

Kjartan Mannes's avatar
Kjartan Mannes committed
602
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
603
604
605

  switch ($type) {
    case "small":
Dries Buytaert's avatar
   
Dries Buytaert committed
606
      $date = date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries Buytaert's avatar
   
Dries Buytaert committed
607
608
      break;
    case "medium":
Dries Buytaert's avatar
   
Dries Buytaert committed
609
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries Buytaert's avatar
   
Dries Buytaert committed
610
611
612
613
614
615
616
      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)) {
617
          $date = t(date($c, $timestamp)) . $date;
Dries Buytaert's avatar
   
Dries Buytaert committed
618
        }
619
620
        else if (strstr("AaBdgGhHiIjLmnrstTUWYyZz", $c)) {
          $date = date($c, $timestamp) . $date;
Dries Buytaert's avatar
   
Dries Buytaert committed
621
622
        }
        else {
Kjartan Mannes's avatar
Kjartan Mannes committed
623
          $date = $c.$date;
Dries Buytaert's avatar
   
Dries Buytaert committed
624
625
626
627
        }
      }
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
628
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries Buytaert's avatar
   
Dries Buytaert committed
629
630
631
632
633
  }
  return $date;
}

function format_name($object) {
Dries Buytaert's avatar
   
Dries Buytaert committed
634
  global $PHP_SELF;
Dries Buytaert's avatar
   
Dries Buytaert committed
635
636

  if ($object->uid && $object->name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
637
    if (strstr($PHP_SELF, "admin.php")) {
638
      $output = la($object->name, array("mod" => "user", "op" => "edit", "id" => $object->uid), "", array("title" => t("Administer user profile.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
639
640
    }
    else {
641
      $output = lm($object->name, array("mod" => "user", "op" => "view", "id" => $object->uid), "", array("title" => t("View user profile.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
642
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
643
644
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
645
    $output = t(variable_get(anonymous, "Anonymous"));
Dries Buytaert's avatar
   
Dries Buytaert committed
646
647
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
648
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
649
650
651
}

function format_tag($link, $text) {
652
  return l(($text ? $text : $link), array("title" => $link));
Dries Buytaert's avatar
   
Dries Buytaert committed
653
654
655
}

function form($form, $method = "post", $action = 0, $options = 0) {
656
  return "<form action=\"". ($action ? $action : htmlentities(request_uri())) ."\" method=\"$method\"". ($options ? " $options" : "") .">\n$form</form>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
657
658
659
}

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

663
664
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 Buytaert's avatar
   
Dries Buytaert committed
665
666
667
668
669
670
671
672
673
674
675
676
677
678
}

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 Buytaert's avatar
   
Dries Buytaert committed
679
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
680
  if (count($options) > 0) {
Kjartan Mannes's avatar
Kjartan Mannes committed
681
    foreach ($options as $key=>$choice) {
Dries Buytaert's avatar
   
Dries Buytaert committed
682
683
      $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($key == $value ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
684
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
  }
}

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 Buytaert's avatar
   
Dries Buytaert committed
700
701
702
703
704
705
706
707
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 Buytaert's avatar
   
Dries Buytaert committed
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
/**
 * Parse an URL; this function must be follow the changes of a clean url implementation
 *
 * @param   string  $url     optional, url to parse; default to request_uri()
 * @return  array   $result  associative array:
 *                             script => index/node/module/admin
 *                             query => GET variables
 *
 */
function drupal_parse_url($url = NULL) {
  global $PHP_SELF;
  static $cache;

  if ($url == NULL) {
    $url = $PHP_SELF ."?". getenv("QUERY_STRING");
  }

  if (!$cache[$url]) {
    $parts = parse_url($url);
    preg_match("/(\w+?)\.php/", $parts["path"], $found);
    $cache[$url]["script"] = $found[1];
    parse_str($parts["query"], $cache[$url]["query"]);
    $cache[$url]["anchor"] = $parts["fragment"];
  }

  return $cache[$url];
}

Dries Buytaert's avatar
   
Dries Buytaert committed
736
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
737
738
 * Build an URL; use this functions when you must write an URL
 * for example in a form or a redirect.
Dries Buytaert's avatar
   
Dries Buytaert committed
739
740
741
 *
 * @param $args    dictionary of arguments to be passed to the script
 * @param $script  script to be invoked; optional, defaults to node
Kjartan Mannes's avatar
Kjartan Mannes committed
742
 * @param $anchor  optional, anchor name
Dries Buytaert's avatar
   
Dries Buytaert committed
743
 */
Kjartan Mannes's avatar
Kjartan Mannes committed
744
function drupal_url($args = array(), $script = "node", $anchor = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
745
746
747
748
749
750
751
752
753
754
755
  static $search, $replace;

  if (!$search) {
    /*
      According to RFC 1738 [3] the special characters "$-_.+!*'()," and the
      reserved characters "/:@#?&=" can be used unencoded within an URL
    */
    $search = array("%24", "%2B", "%21", "%2A", "%27", "%28", "%29", "%2C", "%2F", "%3A", "%40", "%23", "%3F", "%26", "%3D");
    $replace = array("$", "+", "!", "*", "'", "(", ")", ",", "/", ":", "@", "#", "?", "&", "=");
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
756
  $t = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
757
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
758
    $t[] = "$key=". str_replace($search, $replace, urlencode($value));
Dries Buytaert's avatar
   
Dries Buytaert committed
759
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
760
761
762
763
764
765
  if (count($t)) {
    return "$script.php?". implode("&amp;", $t) . ($anchor ? "#$anchor" : "");
  }
  else {
    return "$script.php". ($anchor ? "#$anchor" : "");
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
766
767
768
}

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
769
 * Build a HTML link; use this functions when you must write a link
Dries Buytaert's avatar
   
Dries Buytaert committed
770
771
772
 * to another drupal page
 *
 * @param $args        dictionary of arguments to be passed to the script
Dries Buytaert's avatar
   
Dries Buytaert committed
773
 * @param $text        text of the link
Kjartan Mannes's avatar
Kjartan Mannes committed
774
 * @param $anchor      optional, anchor name
Dries Buytaert's avatar
   
Dries Buytaert committed
775
 * @param $script      script to be invoked; optional, defaults to node
Dries Buytaert's avatar
   
Dries Buytaert committed
776
 * @param $attributes  optional, dictionary of attributes for the <a> tag such as 'target', 'name', 'class', etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
777
 */
Kjartan Mannes's avatar
Kjartan Mannes committed
778
function l($text, $args = array(), $script = "node", $anchor = "", $attributes = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
779
780
781
782
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan Mannes's avatar
Kjartan Mannes committed
783
  return "<a href=\"". drupal_url($args, $script, $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
784
785
}

Kjartan Mannes's avatar
Kjartan Mannes committed
786
function la($text, $args = array(), $anchor = "", $attributes = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
787
  // we don't call l() to avoid another duplication of the array
Dries Buytaert's avatar
   
Dries Buytaert committed
788
789
790
791
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan Mannes's avatar
Kjartan Mannes committed
792
  return "<a href=\"". drupal_url($args, "admin", $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
793
794
}

Kjartan Mannes's avatar
Kjartan Mannes committed
795
function lm($text, $args = array(), $anchor = "", $attributes = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
796
  // we don't call l() to avoid another duplication of the array
Dries Buytaert's avatar
   
Dries Buytaert committed
797
798
799
800
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan Mannes's avatar
Kjartan Mannes committed
801
  return "<a href=\"". drupal_url($args, "module", $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
802
803
}

Dries Buytaert's avatar
   
Dries Buytaert committed
804
function field_get($string, $name) {
Kjartan Mannes's avatar
Kjartan Mannes committed
805
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries Buytaert's avatar
   
Dries Buytaert committed
806
807
808
809
810
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Kjartan Mannes's avatar
Kjartan Mannes committed
811
812
813
  if ($value) {
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
814
815
816
817
  return substr($rval, 1);
}

function link_page() {
818
  global $custom_links;
Dries Buytaert's avatar
   
Dries Buytaert committed
819

820
821
822
823
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
824
    $links[] = l(t("home"), array(), "index", "", array("title" => t("Return to the main page.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
825
    foreach (module_list() as $name) {
826
827
      if (module_hook($name, "link")) {
        $links = array_merge($links, module_invoke($name, "link", "page"));
Dries Buytaert's avatar
   
Dries Buytaert committed
828
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
829
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
830

831
    return $links;
Dries Buytaert's avatar
   
Dries Buytaert committed
832
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
833
}
Dries Buytaert's avatar
   
Dries Buytaert committed
834
835
836
837
838
839
840
841
842
843
844
845
846

function link_node($node, $main = 0) {
  foreach (module_list() as $name) {
    if (module_hook($name, "link")) {
      $links = array_merge($links, module_invoke($name, "link", "node", $node, $main));
    }
  }

  return $links ? $links : array();
}

function timer_start() {
  global $timer;
Dries Buytaert's avatar
   
Dries Buytaert committed
847
848
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries Buytaert's avatar
   
Dries Buytaert committed
849
850
851
852
}

function timer_print() {
  global $timer;
Dries Buytaert's avatar
   
Dries Buytaert committed
853
854
855
856
  list($usec, $sec) = explode(" ", microtime());
  $stop = (float)$usec + (float)$sec;
  $diff = $stop - $timer;
  print "<pre>execution time: $diff sec</pre>";
Dries Buytaert's avatar
   
Dries Buytaert committed
857
858
859
860
861
862
863
}

function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries Buytaert's avatar
   
Dries Buytaert committed
864
865
866
867
868
869
870
871
}

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

  if (variable_get("cache", 0)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
872
873
874
875
876
877
878
879
880
881
882
883
    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 Buytaert's avatar
   
Dries Buytaert committed
884
885
886
887
888
889
890
891
892
893
      exit();
    }
  }
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
894
895
896
897
  if (variable_get("dev_query", 0)) {
    query_print();
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
898
  if (variable_get("cache", 0)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
899
    page_set_cache();
Dries Buytaert's avatar
   
Dries Buytaert committed
900
901
902
903
  }
}

unset($conf);
Dries Buytaert's avatar
   
Dries Buytaert committed
904

905
906
$config = conf_init();

Dries Buytaert's avatar
   
Dries Buytaert committed
907
908
909
910
911
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 Buytaert's avatar
   
Dries Buytaert committed
912
include_once "includes/pager.inc";
Dries Buytaert's avatar
   
Dries Buytaert committed
913
include_once "includes/menu.inc";
Dries Buytaert's avatar
   
Dries Buytaert committed
914

915
916
// initialize configuration variables, using values from conf.php if available:
$conf = variable_init(isset($conf) ? $conf : array());
Dries Buytaert's avatar
   
Dries Buytaert committed
917
918
919
920
921
922
923
924
925
926
927
928
929
930

// initialize installed modules:
module_init();

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

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

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

?>