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

function watchdog($type, $message) {
  global $user;
Dries's avatar
   
Dries 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's avatar
   
Dries 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's avatar
   
Dries 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's avatar
   
Dries committed
81
function path_uri($brief = 0) {
Dries's avatar
   
Dries committed
82
83
  global $HTTP_HOST;
  $path = $HTTP_HOST . substr(request_uri(), 0, strrpos(request_uri(), "/")) ."/";
Dries's avatar
   
Dries committed
84
85
86
87
  if (!$brief) {
    $path = "http://". $path;
  }
  return $path;
Dries's avatar
   
Dries committed
88
89
}

Dries's avatar
   
Dries committed
90
function request_uri() {
Dries's avatar
   
Dries 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's avatar
   
Dries committed
100
  }
Dries's avatar
   
Dries committed
101
102
}

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

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

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

Dries's avatar
   
Dries 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's avatar
   
Dries committed
137
138
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
139
140
  }
  else {
Dries's avatar
   
Dries committed
141
142
    return strtr($string, $args);
  }
Dries's avatar
   
Dries 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's avatar
   
Dries committed
149
      $conf[$variable->name] = unserialize($variable->value);
Dries's avatar
   
Dries 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's avatar
   
Dries committed
165
  db_query("DELETE FROM variable WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
166
  db_query("INSERT INTO variable (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries's avatar
   
Dries committed
167
168
169
170
171
172
173

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

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

  unset($conf[$name]);
}

Kjartan's avatar
Kjartan 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's avatar
   
Dries committed
183
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan's avatar
Kjartan committed
184
185
186
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries's avatar
   
Dries committed
187
function search_item($item, $type) {
Dries's avatar
   
Dries 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's avatar
   
Dries committed
202
203
204
205

  return $output;
}

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

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

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

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

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

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

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

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

  return $output;
}

Kjartan's avatar
Kjartan committed
282
283
284
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
285
 * @param $type    If set, search only nodes of this type.
Kjartan's avatar
Kjartan 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's avatar
   
Dries committed
289
 * @param $options != 0: Render additional form fields/text
Kjartan's avatar
Kjartan committed
290
291
 *                 ("Restrict search to", help text, etc).
 */
Dries's avatar
   
Dries 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's avatar
   
Dries committed
302

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

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

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

Dries's avatar
   
Dries 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's avatar
   
Dries committed
317
318
319
  $sid = session_name() . "=" . session_id();

  if (!session_id() || strstr($url, $sid)) {
Dries's avatar
   
Dries committed
320
321
    header("Location: $url");
  }
Dries's avatar
   
Dries committed
322
323
  else if (strstr($url, "?") && !strstr($url, $sid)) {
    header("Location: $url&". $sid);
Dries's avatar
   
Dries committed
324
325
  }
  else {
Dries's avatar
   
Dries committed
326
    header("Location: $url?". $sid);
Dries's avatar
   
Dries committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  }

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

Dries's avatar
   
Dries committed
345
  if (!strstr($HTTP_REFERER, request_uri())) {
Dries's avatar
   
Dries committed
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
    $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));
}

function check_export($text) {
  return htmlspecialchars(stripslashes($text));
}

function check_code($text) {
  return $text;
}

function check_preview($text) {
  return check_output(check_input($text));
}

function check_query($text) {
  return addslashes(stripslashes($text));
}

function filter($text) {
  foreach (module_list() as $name) {
Kjartan's avatar
Kjartan committed
388
389
390
    if (module_hook($name, "filter")) {
      $text = module_invoke($name, "filter", $text);
    }
Dries's avatar
   
Dries committed
391
392
393
394
395
396
397
398
399
400
  }

  return $text;
}

function check_input($text) {
  return check_query($text);
}

function check_output($text, $nl2br = 0) {
Dries's avatar
   
Dries committed
401
  return ($text) ? ($nl2br ? str_replace("\r", "", str_replace("\n", "<br />", stripslashes($text))) : stripslashes($text)) : message_na();
Dries's avatar
   
Dries committed
402
403
404
405
406
407
408
409
410
411
412
}

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

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

  return $output;
}

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

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

Dries's avatar
   
Dries committed
462
function cache_get($key) {
Dries's avatar
   
Dries committed
463
  $cache = db_fetch_object(db_query("SELECT data FROM cache WHERE cid = '%s'", $key));
Dries's avatar
   
Dries committed
464
465
466
467
  return $cache->data ? $cache->data : 0;
}

function cache_set($cid, $data, $expire = 0) {
Dries's avatar
   
Dries committed
468
469
  if (db_fetch_object(db_query("SELECT cid FROM cache WHERE cid = '%s'", $cid))) {
    db_query("UPDATE cache SET data = '%s' WHERE cid = '%s'", $data, $cid);
Dries's avatar
   
Dries committed
470
471
  }
  else {
Dries's avatar
   
Dries committed
472
    db_query("INSERT INTO cache (cid, data, expire) VALUES('%s', '%s', '%s')", $cid, $data, $expire);
Dries's avatar
   
Dries committed
473
  }
Dries's avatar
   
Dries committed
474
475
}

Dries's avatar
   
Dries committed
476
function cache_del($cid) {
Dries's avatar
   
Dries committed
477
  db_query("DELETE FROM cache WHERE cid = '%s'", $cid);
Dries's avatar
   
Dries committed
478
479
480
481
482
483
484
}

function cache_clear() {
  db_query("DELETE FROM cache WHERE expire < ". time() ." AND expire > 0");
}

function page_set_cache() {
Dries's avatar
   
Dries committed
485
  global $user, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
486
487

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
488
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
489
      cache_set(request_uri(), $data, (time() + variable_get("cache_clear", 30)));
Dries's avatar
   
Dries committed
490
491
492
493
    }
  }
}

Dries's avatar
   
Dries committed
494
function page_get_cache() {
Dries's avatar
   
Dries committed
495
  global $user, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
496
497

  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
498
    if ($cache = cache_get(request_uri())) {
Dries's avatar
   
Dries committed
499
500
501
502
      cache_clear();
    }
    else {
      ob_start();
Dries's avatar
   
Dries committed
503
504
    }
  }
Dries's avatar
   
Dries committed
505
506

  return $cache ? $cache : 0;
Dries's avatar
   
Dries committed
507
508
509
510
}

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
511
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
512
513
514
515
516
517
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
  }
Dries's avatar
   
Dries committed
518
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
519
520
521
522
523
}

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

Kjartan's avatar
Kjartan committed
524
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
525
526
527

  switch ($type) {
    case "small":
Dries's avatar
   
Dries committed
528
      $date = date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
529
530
      break;
    case "medium":
Dries's avatar
   
Dries committed
531
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
532
533
534
535
536
537
538
539
540
541
542
543
544
      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)) {
          $date = t(date($c, $timestamp)).$date;
        }
        else if (strstr("AaBdgGhHiIjLmnrstTUYyZz", $c)) {
          $date = date($c, $timestamp).$date;
        }
        else {
Kjartan's avatar
Kjartan committed
545
          $date = $c.$date;
Dries's avatar
   
Dries committed
546
547
548
549
        }
      }
      break;
    default:
Dries's avatar
   
Dries committed
550
      $date = t(date("l", $timestamp)) .", ". date(variable_get("date_format", "m/d/Y - H:i"), $timestamp);
Dries's avatar
   
Dries committed
551
552
553
554
555
  }
  return $date;
}

function format_name($object) {
Dries's avatar
   
Dries committed
556
  global $PHP_SELF;
Dries's avatar
   
Dries committed
557
558

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
559
    if (strstr($PHP_SELF, "admin.php")) {
560
      $output = la($object->name, array("mod" => "user", "op" => "edit", "id" => $object->uid), "", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
561
562
    }
    else {
563
      $output = lm($object->name, array("mod" => "user", "op" => "view", "id" => $object->uid), "", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
564
    }
Dries's avatar
   
Dries committed
565
566
  }
  else {
Dries's avatar
   
Dries committed
567
    $output = t(variable_get(anonymous, "Anonymous"));
Dries's avatar
   
Dries committed
568
569
  }

Dries's avatar
   
Dries committed
570
  return $output;
Dries's avatar
   
Dries committed
571
572
573
}

function format_tag($link, $text) {
574
  return l(($text ? $text : $link), array("title" => $link));
Dries's avatar
   
Dries committed
575
576
577
}

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

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

585
586
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
}

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
601
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
602
  if (count($options) > 0) {
Kjartan's avatar
Kjartan committed
603
    foreach ($options as $key=>$choice) {
Dries's avatar
   
Dries committed
604
605
      $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
606
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries's avatar
   
Dries committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
  }
}

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
622
/**
Dries's avatar
   
Dries committed
623
624
 * Build an URL; use this functions when you must write an URL
 * for example in a form or a redirect.
Dries's avatar
   
Dries committed
625
626
627
 *
 * @param $args    dictionary of arguments to be passed to the script
 * @param $script  script to be invoked; optional, defaults to node
Kjartan's avatar
Kjartan committed
628
 * @param $anchor  optional, anchor name
Dries's avatar
   
Dries committed
629
 */
Kjartan's avatar
Kjartan committed
630
function drupal_url($args = array(), $script = "node", $anchor = 0) {
Dries's avatar
   
Dries committed
631
  $t = array();
Dries's avatar
   
Dries committed
632
  foreach ($args as $key => $value) {
633
    $t[] = "$key=". urlencode($value);
Dries's avatar
   
Dries committed
634
  }
Dries's avatar
   
Dries committed
635
636
637
638
639
640
  if (count($t)) {
    return "$script.php?". implode("&amp;", $t) . ($anchor ? "#$anchor" : "");
  }
  else {
    return "$script.php". ($anchor ? "#$anchor" : "");
  }
Dries's avatar
   
Dries committed
641
642
643
}

/**
Dries's avatar
   
Dries committed
644
 * Build a HTML link; use this functions when you must write a link
Dries's avatar
   
Dries committed
645
646
647
 * to another drupal page
 *
 * @param $args        dictionary of arguments to be passed to the script
Dries's avatar
   
Dries committed
648
 * @param $text        text of the link
Kjartan's avatar
Kjartan committed
649
 * @param $anchor      optional, anchor name
Dries's avatar
   
Dries committed
650
 * @param $script      script to be invoked; optional, defaults to node
Dries's avatar
   
Dries committed
651
 * @param $attributes  optional, dictionary of attributes for the <a> tag such as 'target', 'name', 'class', etc.
Dries's avatar
   
Dries committed
652
 */
Kjartan's avatar
Kjartan committed
653
function l($text, $args = array(), $script = "node", $anchor = "", $attributes = array()) {
Dries's avatar
   
Dries committed
654
655
656
657
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan's avatar
Kjartan committed
658
  return "<a href=\"". drupal_url($args, $script, $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries's avatar
   
Dries committed
659
660
}

Kjartan's avatar
Kjartan committed
661
function la($text, $args = array(), $anchor = "", $attributes = array()) {
Dries's avatar
   
Dries committed
662
  // we don't call l() to avoid another duplication of the array
Dries's avatar
   
Dries committed
663
664
665
666
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan's avatar
Kjartan committed
667
  return "<a href=\"". drupal_url($args, "admin", $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries's avatar
   
Dries committed
668
669
}

Kjartan's avatar
Kjartan committed
670
function lm($text, $args = array(), $anchor = "", $attributes = array()) {
Dries's avatar
   
Dries committed
671
  // we don't call l() to avoid another duplication of the array
Dries's avatar
   
Dries committed
672
673
674
675
  $t = array();
  foreach ($attributes as $key => $value) {
    $t[] = "$key=\"$value\"";
  }
Kjartan's avatar
Kjartan committed
676
  return "<a href=\"". drupal_url($args, "module", $anchor) ."\" ". implode($t, " ")  .">$text</a>";
Dries's avatar
   
Dries committed
677
678
}

Dries's avatar
   
Dries committed
679
function field_get($string, $name) {
Kjartan's avatar
Kjartan committed
680
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries's avatar
   
Dries committed
681
682
683
684
685
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Kjartan's avatar
Kjartan committed
686
687
688
  if ($value) {
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
689
690
691
692
  return substr($rval, 1);
}

function link_page() {
693
  global $custom_links;
Dries's avatar
   
Dries committed
694

695
696
697
698
  if (is_array($custom_links)) {
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
699
    $links[] = l(t("home"), array(), "index", "", array("title" => t("Return to the main page.")));
Dries's avatar
   
Dries committed
700
    foreach (module_list() as $name) {
701
702
      if (module_hook($name, "link")) {
        $links = array_merge($links, module_invoke($name, "link", "page"));
Dries's avatar
   
Dries committed
703
      }
Dries's avatar
   
Dries committed
704
    }
Dries's avatar
   
Dries committed
705

706
    return $links;
Dries's avatar
   
Dries committed
707
  }
Dries's avatar
   
Dries committed
708
}
Dries's avatar
   
Dries committed
709
710
711
712
713
714
715
716
717
718
719
720
721

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's avatar
   
Dries committed
722
723
  list($usec, $sec) = explode(" ", microtime());
  $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
724
725
726
727
}

function timer_print() {
  global $timer;
Dries's avatar
   
Dries committed
728
729
730
731
  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
732
733
734
735
736
737
738
}

function query_print() {
  global $queries;
  print "<pre>";
  print_r($queries);
  print "</pre>";
Dries's avatar
   
Dries committed
739
740
741
742
743
744
745
746
}

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

  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
747
    if ($data = page_get_cache()) {
Dries's avatar
   
Dries committed
748
749
750
751
752
753
754
755
756
757
758
      print $data;
      exit();
    }
  }
}

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

Dries's avatar
   
Dries committed
759
760
761
762
  if (variable_get("dev_query", 0)) {
    query_print();
  }

Dries's avatar
   
Dries committed
763
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
764
    page_set_cache();
Dries's avatar
   
Dries committed
765
766
767
768
769
770
  }
}

$config = conf_init();

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

Dries's avatar
   
Dries committed
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
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";

// initialize configuration variables:
$conf = variable_init($conf);

// initialize installed modules:
module_init();

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

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

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

?>