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

Dries's avatar
   
Dries committed
4
function conf_init() {
5
  global $HTTP_HOST, $REQUEST_URI;
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

  while (strlen($file) > 4) {
    if (file_exists("includes/$file.php")) {
      return $file;
    }
    else {
      $file = substr($file, strpos($file, ".") + 1);
    }
  }

  return "conf";
25
26
}

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

Dries's avatar
   
Dries committed
36
function watchdog($type, $message) {
Dries's avatar
   
Dries committed
37
  global $user;
Dries's avatar
   
Dries committed
38
  db_query("INSERT INTO watchdog (uid, type, message, location, hostname, timestamp) VALUES ('$user->uid', '". check_input($type) ."', '". check_input($message) ."', '". check_input(getenv("REQUEST_URI")) ."', '". check_input(getenv("REMOTE_ADDR")) ."', '". time() ."')");
Dries's avatar
   
Dries committed
39
40
41
}

function throttle($type, $rate) {
Dries's avatar
   
Dries committed
42
  if (!user_access("access administration pages")) {
Dries's avatar
   
Dries committed
43
44
    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");
Dries's avatar
   
Dries committed
45
      die(message_throttle());
Dries's avatar
   
Dries committed
46
47
    }
    else {
Dries's avatar
   
Dries committed
48
      watchdog($type, "throttle");
Dries's avatar
   
Dries committed
49
50
51
52
    }
  }
}

Dries's avatar
   
Dries committed
53
54
55
56
57
58
59
60
61
62
function path_uri() {
  global $HTTP_HOST, $REQUEST_URI;
  return "http://". $HTTP_HOST . substr($REQUEST_URI, 0, strrpos($REQUEST_URI, "/")) ."/";
}

function path_img() {
  // use "http://your-image-server.com/ if you want to host images on a seperate server.
  return "./images/";
}

Dries's avatar
   
Dries committed
63
64
function message_access() {
  return t("You are not authorized to access to this page.");
Dries's avatar
   
Dries committed
65
}
Dries's avatar
   
Dries committed
66

Dries's avatar
   
Dries committed
67
68
69
70
function message_na() {
  return t("n/a");
}

Dries's avatar
   
Dries committed
71
72
73
74
function message_throttle() {
  return t("You exceeded the submission rate exceeded.  Please wait a few minutes and try again.");
}

Dries's avatar
   
Dries committed
75
function drupal_goto($url) {
Dries's avatar
   
Dries committed
76

Dries's avatar
   
Dries committed
77
  /*
Dries's avatar
   
Dries committed
78
79
  ** 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
Dries's avatar
   
Dries committed
80
81
82
  ** is compiled with "--enable-trans-sid".
  */

Dries's avatar
   
Dries committed
83
84
85
86
  if (SID == "" || strstr($url, SID)) {
    header("Location: $url");
  }
  else if (strstr($url, "?") && !strstr($url, SID)) {
Dries's avatar
Dries committed
87
88
89
90
91
    header("Location: $url&". SID);
  }
  else {
    header("Location: $url?". SID);
  }
Dries's avatar
   
Dries committed
92
93
94
95
96
97
98
99

  /*
  ** 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();
Dries's avatar
   
Dries committed
100
101
}

Dries's avatar
CHANGES    
Dries committed
102
103
function check_form($text) {
  return htmlspecialchars(stripslashes($text));
Dries's avatar
   
Dries committed
104
105
}

Dries's avatar
CHANGES    
Dries committed
106
107
function check_export($text) {
  return htmlspecialchars(stripslashes($text));
Dries's avatar
   
Dries committed
108
109
}

Dries's avatar
CHANGES    
Dries committed
110
111
function check_code($text) {
  return $text;
Dries's avatar
   
Dries committed
112
113
}

Dries's avatar
CHANGES    
Dries committed
114
function check_preview($text) {
Dries's avatar
   
Dries committed
115
  return check_output(check_input($text));
Dries's avatar
CHANGES    
Dries committed
116
117
}

Dries's avatar
   
Dries committed
118
119
120
121
function check_query($text) {
  return addslashes(stripslashes($text));
}

Dries's avatar
CHANGES    
Dries committed
122
function check_input($text) {
Dries's avatar
   
Dries committed
123
124
125
  foreach (module_list() as $name) {
    if (module_hook($name, "filter")) $text = module_invoke($name, "filter", $text);
  }
Dries's avatar
CHANGES    
Dries committed
126
127
128
129
  return addslashes(stripslashes(substr($text, 0, variable_get("max_input_size", 10000))));
}

function check_output($text, $nl2br = 0) {
Dries's avatar
   
Dries committed
130
  return ($text) ? ($nl2br ? nl2br(stripslashes($text)) : stripslashes($text)) : message_na();
Dries's avatar
   
Dries committed
131
132
}

Dries's avatar
   
Dries committed
133
134
135
136
function format_info($body, $block) {
  return "<table><tr><td><table align=\"right\" border=\"1\" width=\"180\"><tr><td>$block</td></tr></table>$body</td></tr></table>\n";
}

Dries's avatar
   
Dries committed
137
function format_rss_channel($title, $link, $description, $items, $language = "en") {
Dries's avatar
   
Dries committed
138
  $output .= "<channel>\n";
Dries's avatar
   
Dries committed
139
140
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
141
  $output .= " <description>". htmlentities($description) ."</description>\n";
Dries's avatar
   
Dries committed
142
  $output .= " <language>". htmlentities(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
143
144
145
146
147
148
149
150
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

function format_rss_item($title, $link, $description) {
  $output .= "<item>\n";
Dries's avatar
   
Dries committed
151
152
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
153
154
155
156
157
158
  $output .= " <description>". htmlentities($description) ."</description>\n";
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
159
160
161
162
function format_plural($count, $singular, $plural) {
  return ($count == 1) ? "$count ". t($singular) : "$count ". t($plural);
}

163
164
165
166
167
168
169
170
171
172
173
174
175
function format_size($size) {
  $suffix = "bytes";
  if ($size > 1024) {
    $size = round($size / 1024, 2);
    $suffix = "KB";
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
    $suffix = "MB";
  }
  return "$size $suffix";
}

Dries's avatar
   
Dries committed
176
177
178
179
180
181
182
function cache_clear($interval = 0) {
  db_query("DELETE FROM cache WHERE ". time() ." - timestamp > $interval");
}

function cache_get() {
  global $user, $REQUEST_URI, $REQUEST_METHOD;

Dries's avatar
   
Dries committed
183
  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
184
185
186
187
188
189
    if ($cache = db_fetch_object(db_query("SELECT * FROM cache WHERE url = '". check_input($REQUEST_URI) ."'"))) {
      cache_clear(variable_get("cache_clear", 30));
    }
    else {
      ob_start();
    }
Dries's avatar
   
Dries committed
190
191
  }

Dries's avatar
   
Dries committed
192
  return $cache->data ? $cache->data : 0;
Dries's avatar
   
Dries committed
193
194
195
}

function cache_set() {
Dries's avatar
   
Dries committed
196
  global $user, $REQUEST_URI, $REQUEST_METHOD;
Dries's avatar
   
Dries committed
197

Dries's avatar
   
Dries committed
198
  if (!$user->uid && $REQUEST_METHOD == "GET") {
Dries's avatar
   
Dries committed
199
200
201
202
    if ($data = ob_get_contents()) {
      db_query("INSERT INTO cache (url, data, timestamp) VALUES('". addslashes($REQUEST_URI) ."', '". addslashes($data) ."', '". time() ."')");
    }
  }
Dries's avatar
   
Dries committed
203
204
}

Dries's avatar
   
Dries committed
205
function format_interval($timestamp) {
Dries's avatar
   
Dries committed
206
  $units = array("year|years" => 31536000, "week|weeks" => 604800, "day|days" => 86400, "hour|hours" => 3600, "min|min" => 60, "sec|sec" => 1);
207
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
208
    $key = explode("|", $key);
209
210
211
212
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
Dries's avatar
   
Dries committed
213
214
215
216
217
218
219
  }
  return ($output) ? $output : "0 sec";
}

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

Dries's avatar
   
Dries committed
220
  // $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries's avatar
   
Dries committed
221
222
223
224
225
226
227
228
229
230
231
232

  switch ($type) {
    case "small":
      $date = date("m/d/y - H:i", $timestamp);
      break;
    case "medium":
      $date = t(date("l", $timestamp)) .", ". date("m/d/Y - H:i", $timestamp);
      break;
    case "large":
      $date = t(date("l", $timestamp)) .", ". t(date("F", $timestamp)) ." ". date("d, Y - H:i", $timestamp);
      break;
    case "custom":
Dries's avatar
   
Dries committed
233
234
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
Dries's avatar
   
Dries committed
235
          $date = t(date($c, $timestamp)).$date;
Dries's avatar
   
Dries committed
236
237
238
239
240
241
242
        }
        else if (strstr("AaBdgGhHiIjLmnrstTUYyZz", $c)) {
          $date = date($c, $timestamp).$date;
        }
        else {
          $date = $c.$date;
        }
243
      }
Dries's avatar
   
Dries committed
244
245
246
247
248
249
250
      break;
    default:
      $date = t(date("l", $timestamp)) .", ". date("m/d/Y - H:i", $timestamp);
  }
  return $date;
}

Dries's avatar
   
Dries committed
251
252
253
254
function format_name($object) {

  if ($object->uid && $object->name) {
    return "<a href=\"module.php?mod=user&op=view&id=$object->uid\">$object->name</a>";
Dries's avatar
   
Dries committed
255
256
257
258
  }
  else {
    return variable_get(anonymous, "Anonymous");
  }
Dries's avatar
Dries committed
259

Dries's avatar
   
Dries committed
260
261
262
}

function format_email($address) {
Dries's avatar
   
Dries committed
263
  return ($address) ? "<a href=\"mailto:$address\">$address</A>" : message_na();
Dries's avatar
   
Dries committed
264
265
}

Dries's avatar
   
Dries committed
266
function format_url($address, $description = 0) {
Dries's avatar
   
Dries committed
267
  $description = ($description) ? $description : $address;
Dries's avatar
   
Dries committed
268
  return ($address) ? "<a href=\"$address\">". check_output($description) ."</a>" : message_na();
Dries's avatar
   
Dries committed
269
270
271
272
273
274
}

function format_tag($link, $text) {
  return "'<a href=\"node.php?title='. urlencode('$link') .'\">'. ('$text' ? '$text' : '$link') .'</a>'";
}

Dries's avatar
   
Dries committed
275
276
277
278
function form($form, $method = "post", $action = 0, $options = 0) {
  global $REQUEST_URI;

  return "<form action=\"". ($action ? $action : $REQUEST_URI) ."\" method=\"$method\"". ($options ? " $options" : "") .">\n$form</form>\n";
Dries's avatar
   
Dries committed
279
280
}

Dries's avatar
   
Dries committed
281
function form_item($title, $value, $description = 0) {
Dries's avatar
   
Dries committed
282
  return ($description) ? "<b>$title:</b><br />$value<br /><small><i>$description</i></small><p />\n" : "<b>$title:</b><br />$value<p />\n";
Dries's avatar
   
Dries committed
283
284
285
}

function form_textfield($title, $name, $value, $size, $maxlength, $description = 0) {
Dries's avatar
   
Dries committed
286
  return form_item($title, "<input maxlength=\"$maxlength\" name=\"edit[$name]\" size=\"$size\" value=\"". check_form($value) ."\" />", $description);
Dries's avatar
   
Dries committed
287
288
}

Dries's avatar
   
Dries committed
289
290
291
292
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);
}

Dries's avatar
   
Dries committed
293
function form_textarea($title, $name, $value, $cols, $rows, $description = 0) {
Dries's avatar
   
Dries committed
294
  return form_item($title, "<textarea wrap=\"virtual\" cols=\"$cols\" rows=\"$rows\" name=\"edit[$name]\">". check_form($value) ."</textarea>", $description);
Dries's avatar
   
Dries committed
295
296
}

Kjartan's avatar
Changes    
Kjartan committed
297
function form_select($title, $name, $value, $options, $description = 0, $extra = 0) {
298
  if (count($options) > 0) {
Kjartan's avatar
Changes    
Kjartan committed
299
300
    foreach ($options as $key=>$choice) $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected" : "") : ($key == $value ? " selected" : "")) .">". check_form($choice) ."</option>";
    return form_item($title, "<select name=\"edit[$name]\"". ($extra ? " $extra" : "") .">$select</select>", $description);
301
  }
Dries's avatar
   
Dries committed
302
303
}

304
function form_file($title, $name, $size, $description = 0) {
Dries's avatar
   
Dries committed
305
  return form_item($title, "<input type=\"file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries's avatar
   
Dries committed
306
307
}

308
function form_hidden($name, $value) {
Dries's avatar
   
Dries committed
309
  return "<input type=\"hidden\" name=\"edit[$name]\" value=\"". check_form($value) ."\" />\n";
310
311
}

Dries's avatar
   
Dries committed
312
function form_submit($value) {
Dries's avatar
   
Dries committed
313
  return "<input type=\"submit\" name=\"op\" value=\"". check_form($value) ."\" />\n";
Dries's avatar
   
Dries committed
314
315
}

Dries's avatar
   
Dries committed
316
function field_get($string, $name) {
317
318
  ereg(",$name=([^,]+)", ",$string", $regs);
  return $regs[1];
Dries's avatar
   
Dries committed
319
320
}

Dries's avatar
   
Dries committed
321
function field_set($string, $name, $value) {
322
323
324
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
  if ($value) $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  return substr($rval, 1);
Dries's avatar
   
Dries committed
325
326
}

Dries's avatar
   
Dries committed
327
function field_merge($a, $b) {
328
329
  foreach (explode(",", $b) as $data) {
    $entry = explode("=", $data);
Dries's avatar
   
Dries committed
330
331
332
333
334
    $a = field_set($a, $entry[0], $entry[1]);
  }
  return $a;
}

Dries's avatar
   
Dries committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
function link_page() {

  $links[] = "<a href=\"index.php\">". t("home") ."</a>";

  foreach (module_list() as $name) {
    if (module_hook($name, "link")) {
      $links = array_merge($links, module_invoke($name, "link", "page"));
    }
  }


  return $links;
}

function link_node($node) {
Dries's avatar
   
Dries committed
350
351
352
353
354
355
356
  foreach (module_list() as $name) {
    if (module_hook($name, "link")) {
      $links = array_merge($links, module_invoke($name, "link", "node", $node));
    }
  }

  return $links ? $links : array();
Dries's avatar
   
Dries committed
357
358
}

Dries's avatar
CHANGES    
Dries committed
359
360
361
362
363
364
365
366
367
368
369
370
371
function timer_start() {
  global $timer;
  $timer = explode(" ", microtime());
}

function timer_print() {
  global $timer;
  $stop = explode(" ", microtime());
  $diff = $stop[0] - $timer[0];
  print "<PRE>execution time: $diff ms</PRE>";
}

function page_header() {
Dries's avatar
   
Dries committed
372
373
374
  if (variable_get("dev_timer", 0)) {
    timer_start();
  }
Dries's avatar
   
Dries committed
375
376
377
378
379
380
381

  if (variable_get("cache", 0)) {
    if ($data = cache_get()) {
      print $data;
      exit();
    }
  }
Dries's avatar
CHANGES    
Dries committed
382
383
384
}

function page_footer() {
Dries's avatar
   
Dries committed
385
386
387
  if (variable_get("dev_timer", 0)) {
    timer_print();
  }
Dries's avatar
   
Dries committed
388

Dries's avatar
   
Dries committed
389
390
391
  if (variable_get("cache", 0)) {
    cache_set();
  }
Dries's avatar
CHANGES    
Dries committed
392
393
}

394
$config = conf_init();
395

396
397
unset($conf);
include_once "includes/$config.php";
Dries's avatar
 
Dries committed
398
include_once "includes/database.inc";
Dries's avatar
   
Dries committed
399
include_once "includes/variable.inc";
Dries's avatar
   
Dries committed
400
include_once "includes/comment.inc";
Dries's avatar
   
Dries committed
401
include_once "includes/xmlrpc.inc";
Dries's avatar
   
Dries committed
402
include_once "includes/module.inc";
Dries's avatar
   
Dries committed
403
404
include_once "includes/locale.inc";
include_once "includes/search.inc";
Dries's avatar
 
Dries committed
405
include_once "includes/theme.inc";
Dries's avatar
   
Dries committed
406
include_once "includes/node.inc";
Dries's avatar
 
Dries committed
407

Dries's avatar
   
Dries committed
408
// initialize configuration variables:
409
$conf = variable_init($conf);
Dries's avatar
   
Dries committed
410

Dries's avatar
   
Dries committed
411
// initialize installed modules:
Dries's avatar
   
Dries committed
412
module_init();
Dries's avatar
   
Dries committed
413
414

// initialize localization system:
Dries's avatar
   
Dries committed
415
$locale = locale_init();
Dries's avatar
   
Dries committed
416
417

// initialize theme:
Dries's avatar
   
Dries committed
418
$theme = theme_init();
Dries's avatar
 
Dries committed
419

Dries's avatar
   
Dries committed
420
421
422
// set error handler:
set_error_handler("error_handler");

Dries's avatar
   
Dries committed
423
?>