common.inc 24.4 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
81
function path_uri($brief = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
82
83
  global $HTTP_HOST;
  $path = $HTTP_HOST . substr(request_uri(), 0, strrpos(request_uri(), "/")) ."/";
Dries Buytaert's avatar
   
Dries Buytaert committed
84
85
86
87
  if (!$brief) {
    $path = "http://". $path;
  }
  return $path;
Dries Buytaert's avatar
   
Dries Buytaert committed
88
89
}

Dries Buytaert's avatar
   
Dries Buytaert committed
90
function request_uri() {
Dries Buytaert's avatar
   
Dries Buytaert committed
91
92
93
94
95
96
97
98
  // 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 {
99
    return $PATH_INFO ."?". $QUERY_STRING;
Dries Buytaert's avatar
   
Dries Buytaert committed
100
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
101
102
}

Dries Buytaert's avatar
   
Dries Buytaert committed
103
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
104
  return t("You are not authorized to access this page.");
Dries Buytaert's avatar
   
Dries Buytaert committed
105
106
107
108
109
110
111
112
113
114
}

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
115
116
117
118
119
function locale_init() {
  global $languages, $user;
  return ($languages ? (($user->uid && $user->language) ? $user->language : key($languages)) : 0);
}

Dries Buytaert's avatar
   
Dries Buytaert committed
120
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
121
  global $languages;
122

Dries Buytaert's avatar
   
Dries Buytaert committed
123
124
125
126
127
128
129
130
131
132
133
134
  /*
  ** 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")));
  */

135
136
  $string = ($languages && function_exists("locale") ? locale($string) : $string);

Dries Buytaert's avatar
   
Dries Buytaert committed
137
138
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
139
140
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
141
142
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
143
144
145
146
147
148
}

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
149
      $conf[$variable->name] = unserialize($variable->value);
Dries Buytaert's avatar
   
Dries Buytaert committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    }
  }

  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
165
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries Buytaert's avatar
   
Dries Buytaert committed
166
  db_query("INSERT INTO variable (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries Buytaert's avatar
   
Dries Buytaert committed
167
168
169
170
171
172
173

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries Buytaert's avatar
   
Dries Buytaert committed
174
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries Buytaert's avatar
   
Dries Buytaert committed
175
176
177
178

  unset($conf[$name]);
}

Kjartan Mannes's avatar
Kjartan Mannes committed
179
180
181
182
/**
 * 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
183
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan Mannes's avatar
Kjartan Mannes committed
184
185
186
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
187
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201

  /*
  ** 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
202
203
204
205

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
206
207
208
209
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries Buytaert's avatar
   
Dries Buytaert committed
210
211
212
 * 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
213
214
215
216
 * 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
217
 * @param $options != 0: Render additional form fields/text
Kjartan Mannes's avatar
Kjartan Mannes committed
218
219
 *                 ("Restrict search to", help text, etc).
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
220
221
222
223
function search_form($action = 0, $query = 0, $options = 0) {
  global $keys;

  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
224
    $action = drupal_url(array("mod" => "search"), "module");
Dries Buytaert's avatar
   
Dries Buytaert committed
225
226
227
228
229
230
  }

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

Kjartan Mannes's avatar
Kjartan Mannes committed
231
232
  $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
233
234
235
236
237
238
239

  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
240
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries Buytaert's avatar
   
Dries Buytaert committed
241
242
      }
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
243
244

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
249
250
251
252
  return form($output, "post", $action);
}

/*
Kjartan Mannes's avatar
Kjartan Mannes committed
253
254
 * Collect the search results:
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
255
256
257
258
259
260
261
262
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
263
        if ($name == "node" || $name == "comment") {
Dries Buytaert's avatar
   
Dries Buytaert committed
264
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan Mannes's avatar
Kjartan Mannes committed
265
266
        }
        else {
Dries Buytaert's avatar
   
Dries Buytaert committed
267
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan Mannes's avatar
Kjartan Mannes committed
268
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
269
270
271
272
273
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
274
    if (!$output) {
Dries Buytaert's avatar
   
Dries Buytaert committed
275
276
277
278
279
280
281
      $output .= t("Your search yielded no results.");
    }
  }

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
282
283
284
/**
 * Display the search form and the resulting data.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
285
 * @param $type    If set, search only nodes of this type.
Kjartan Mannes's avatar
Kjartan Mannes committed
286
287
288
 *                 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
289
 * @param $options != 0: Render additional form fields/text
Kjartan Mannes's avatar
Kjartan Mannes committed
290
291
 *                 ("Restrict search to", help text, etc).
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
292
293
294
295
296
297
298
299
300
301
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
302

Dries Buytaert's avatar
   
Dries Buytaert committed
303
304
function drupal_goto($url) {

Dries Buytaert's avatar
   
Dries Buytaert committed
305
306
307
  /*
  ** Translate &amp; to simply &
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
308

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

Dries Buytaert's avatar
   
Dries Buytaert committed
311
312
313
314
315
316
  /*
  ** 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
317
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, $sid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
318
319
320
    header("Location: $url");
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
321
322
323
324
325
326
327
328
    $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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
347
  if (!strstr($HTTP_REFERER, request_uri())) {
Dries Buytaert's avatar
   
Dries Buytaert committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
    $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
372
373
function check_query($text) {
  return addslashes(stripslashes($text));
Dries Buytaert's avatar
   
Dries Buytaert committed
374
375
}

Dries Buytaert's avatar
   
Dries Buytaert committed
376
function check_input($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
377
378
379
380
381
  return addslashes(stripslashes($text));
}

function filter($text) {
  foreach (module_list() as $name) {
Kjartan Mannes's avatar
Kjartan Mannes committed
382
383
384
    if (module_hook($name, "filter")) {
      $text = module_invoke($name, "filter", $text);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
385
386
387
388
389
390
  }

  return $text;
}

function check_output($text, $nl2br = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
391
392
393
  if ($text) {
    $text = stripslashes($text);

Dries Buytaert's avatar
   
Dries Buytaert committed
394
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
395
396
397
398
399
400
401
402
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries Buytaert's avatar
   
Dries Buytaert committed
403
404
405
406
407
408
409
410
411
412
413
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
414
415
416
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
417
418
419
420
421
  $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
422
  foreach ($args as $key => $value) {
423
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
424
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
425
426
427
428
429
430
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
431
432
433
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
434
435
436
437
  $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
438
  foreach ($args as $key => $value) {
439
    $output .= "<$key>". htmlentities(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
440
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
441
442
443
444
445
446
447
448
449
450
  $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
451
  $suffix = t("bytes");
Dries Buytaert's avatar
   
Dries Buytaert committed
452
453
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
454
    $suffix = t("KB");
Dries Buytaert's avatar
   
Dries Buytaert committed
455
456
457
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
458
    $suffix = t("MB");
Dries Buytaert's avatar
   
Dries Buytaert committed
459
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
460
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
461
462
}

Dries Buytaert's avatar
   
Dries Buytaert committed
463
function cache_get($key) {
Dries Buytaert's avatar
   
Dries Buytaert committed
464
465
466
  $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
467
468
469
}

function cache_set($cid, $data, $expire = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
470
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
471
    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
472
473
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
474
    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
475
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
476
477
}

Dries Buytaert's avatar
   
Dries Buytaert committed
478
479
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
480
    db_query("DELETE FROM cache WHERE expire <> 0");
Dries Buytaert's avatar
   
Dries Buytaert committed
481
482
483
484
  }
  else {
    db_query("DELETE FROM cache WHERE cid = '%s'", $cid);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
485
486
}

Dries Buytaert's avatar
   
Dries Buytaert committed
487
488
489
490
491
492
493
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
494
495
496
}

function page_set_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
497
  global $user, $REQUEST_METHOD;
Dries Buytaert's avatar
   
Dries Buytaert committed
498
499

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries Buytaert's avatar
   
Dries Buytaert committed
500
    if ($data = ob_get_contents()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
501
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 120)));
Dries Buytaert's avatar
   
Dries Buytaert committed
502
503
504
505
    }
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
506
function page_get_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
507
  global $user, $REQUEST_METHOD;
Dries Buytaert's avatar
   
Dries Buytaert committed
508
509

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries Buytaert's avatar
   
Dries Buytaert committed
510
    if ($cache = cache_get(request_uri())) {
Dries Buytaert's avatar
   
Dries Buytaert committed
511
      cache_clear_old();
Dries Buytaert's avatar
   
Dries Buytaert committed
512
513
514
    }
    else {
      ob_start();
Dries Buytaert's avatar
   
Dries Buytaert committed
515
516
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
517

Dries Buytaert's avatar
   
Dries Buytaert committed
518
  return $cache;
Dries Buytaert's avatar
   
Dries Buytaert committed
519
520
521
522
}

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
523
  foreach ($units as $key=>$value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
524
525
526
527
528
529
    $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
530
  return ($output) ? $output : t("0 sec");
Dries Buytaert's avatar
   
Dries Buytaert committed
531
532
533
534
535
}

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

Kjartan Mannes's avatar
Kjartan Mannes committed
536
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
537
538
539

  switch ($type) {
    case "small":
Dries Buytaert's avatar
   
Dries Buytaert committed
540
      $date = date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries Buytaert's avatar
   
Dries Buytaert committed
541
542
      break;
    case "medium":
Dries Buytaert's avatar
   
Dries Buytaert committed
543
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries Buytaert's avatar
   
Dries Buytaert committed
544
545
546
547
548
549
550
      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)) {
551
          $date = t(date($c, $timestamp)) . $date;
Dries Buytaert's avatar
   
Dries Buytaert committed
552
        }
553
554
        else if (strstr("AaBdgGhHiIjLmnrstTUWYyZz", $c)) {
          $date = date($c, $timestamp) . $date;
Dries Buytaert's avatar
   
Dries Buytaert committed
555
556
        }
        else {
Kjartan Mannes's avatar
Kjartan Mannes committed
557
          $date = $c.$date;
Dries Buytaert's avatar
   
Dries Buytaert committed
558
559
560
561
        }
      }
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
562
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries Buytaert's avatar
   
Dries Buytaert committed
563
564
565
566
567
  }
  return $date;
}

function format_name($object) {
Dries Buytaert's avatar
   
Dries Buytaert committed
568
  global $PHP_SELF;
Dries Buytaert's avatar
   
Dries Buytaert committed
569
570

  if ($object->uid && $object->name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
571
    if (strstr($PHP_SELF, "admin.php")) {
572
      $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
573
574
    }
    else {
575
      $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
576
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
577
578
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
579
    $output = t(variable_get(anonymous, "Anonymous"));
Dries Buytaert's avatar
   
Dries Buytaert committed
580
581
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
582
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
583
584
585
}

function format_tag($link, $text) {
586
  return l(($text ? $text : $link), array("title" => $link));
Dries Buytaert's avatar
   
Dries Buytaert committed
587
588
589
}

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

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

597
598
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
599
600
601
602
603
604
605
606
607
608
609
610
611
612
}

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
613
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
614
  if (count($options) > 0) {
Kjartan Mannes's avatar
Kjartan Mannes committed
615
    foreach ($options as $key=>$choice) {
Dries Buytaert's avatar
   
Dries Buytaert committed
616
617
      $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
618
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
  }
}

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
634
635
636
637
638
639
640
641
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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
/**
 * 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
670
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
671
672
 * 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
673
674
675
 *
 * @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
676
 * @param $anchor  optional, anchor name
Dries Buytaert's avatar
   
Dries Buytaert committed
677
 */
Kjartan Mannes's avatar
Kjartan Mannes committed
678
function drupal_url($args = array(), $script = "node", $anchor = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
679
680
681
682
683
684
685
686
687
688
689
  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
690
  $t = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
691
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
692
    $t[] = "$key=". str_replace($search, $replace, urlencode($value));
Dries Buytaert's avatar
   
Dries Buytaert committed
693
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
694
695
696
697
698
699
  if (count($t)) {
    return "$script.php?". implode("&amp;", $t) . ($anchor ? "#$anchor" : "");
  }
  else {
    return "$script.php". ($anchor ? "#$anchor" : "");
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
700
701
702
}

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
703
 * Build a HTML link; use this functions when you must write a link
Dries Buytaert's avatar
   
Dries Buytaert committed
704
705
706
 * to another drupal page
 *
 * @param $args        dictionary of arguments to be passed to the script
Dries Buytaert's avatar
   
Dries Buytaert committed
707
 * @param $text        text of the link
Kjartan Mannes's avatar
Kjartan Mannes committed
708
 * @param $anchor      optional, anchor name
Dries Buytaert's avatar
   
Dries Buytaert committed
709
 * @param $script      script to be invoked; optional, defaults to node
Dries Buytaert's avatar
   
Dries Buytaert committed
710
 * @param $attributes  optional, dictionary of attributes for the <a> tag such as 'target', 'name', 'class', etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
711
 */
Kjartan Mannes's avatar
Kjartan Mannes committed
712
function l($text, $args = array(), $script = "node", $anchor = "", $attributes = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
713
714
715
716
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan Mannes's avatar
Kjartan Mannes committed
717
  return "<a href=\"". drupal_url($args, $script, $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
718
719
}

Kjartan Mannes's avatar
Kjartan Mannes committed
720
function la($text, $args = array(), $anchor = "", $attributes = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
721
  // we don't call l() to avoid another duplication of the array
Dries Buytaert's avatar
   
Dries Buytaert committed
722
723
724
725
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan Mannes's avatar
Kjartan Mannes committed
726
  return "<a href=\"". drupal_url($args, "admin", $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
727
728
}

Kjartan Mannes's avatar
Kjartan Mannes committed
729
function lm($text, $args = array(), $anchor = "", $attributes = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
730
  // we don't call l() to avoid another duplication of the array
Dries Buytaert's avatar
   
Dries Buytaert committed
731
732
733
734
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan Mannes's avatar
Kjartan Mannes committed
735
  return "<a href=\"". drupal_url($args, "module", $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
736
737
}

Dries Buytaert's avatar
   
Dries Buytaert committed
738
function field_get($string, $name) {
Kjartan Mannes's avatar
Kjartan Mannes committed
739
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries Buytaert's avatar
   
Dries Buytaert committed
740
741
742
743
744
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Kjartan Mannes's avatar
Kjartan Mannes committed
745
746
747
  if ($value) {
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
748
749
750
751
  return substr($rval, 1);
}

function link_page() {
752
  global $custom_links;
Dries Buytaert's avatar
   
Dries Buytaert committed
753

754
755
756
757
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
758
    $links[] = l(t("home"), array(), "index", "", array("title" => t("Return to the main page.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
759
    foreach (module_list() as $name) {
760
761
      if (module_hook($name, "link")) {
        $links = array_merge($links, module_invoke($name, "link", "page"));
Dries Buytaert's avatar
   
Dries Buytaert committed
762
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
763
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
764

765
    return $links;
Dries Buytaert's avatar
   
Dries Buytaert committed
766
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
767
}
Dries Buytaert's avatar
   
Dries Buytaert committed
768
769
770
771
772
773
774
775
776
777
778
779
780

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
781
782
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries Buytaert's avatar
   
Dries Buytaert committed
783
784
785
786
}

function timer_print() {
  global $timer;
Dries Buytaert's avatar
   
Dries Buytaert committed
787
788
789
790
  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
791
792
793
794
795
796
797
}

function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries Buytaert's avatar
   
Dries Buytaert committed
798
799
800
801
802
803
804
805
}

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

  if (variable_get("cache", 0)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
806
807
808
809
810
811
812
813
814
815
816
817
    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
818
819
820
821
822
823
824
825
826
827
      exit();
    }
  }
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
828
829
830
831
  if (variable_get("dev_query", 0)) {
    query_print();
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
832
  if (variable_get("cache", 0)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
833
    page_set_cache();
Dries Buytaert's avatar
   
Dries Buytaert committed
834
835
836
837
  }
}

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

839
840
$config = conf_init();

Dries Buytaert's avatar
   
Dries Buytaert committed
841
842
843
844
845
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
846
include_once "includes/pager.inc";
Dries Buytaert's avatar
   
Dries Buytaert committed
847
include_once "includes/menu.inc";
Dries Buytaert's avatar
   
Dries Buytaert committed
848

849
850
// initialize configuration variables, using values from conf.php if available:
$conf = variable_init(isset($conf) ? $conf : array());
Dries Buytaert's avatar
   
Dries Buytaert committed
851
852
853
854
855
856
857
858
859
860
861
862
863
864

// initialize installed modules:
module_init();

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

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

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

?>