common.inc 11.7 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?
Dries's avatar
 
Dries committed
2

Dries's avatar
   
Dries committed
3
function conf_init() {
4
  global $HTTP_HOST, $REQUEST_URI;
Dries's avatar
   
Dries committed
5
6
7
8
9
10
11

  /*
  ** 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
12
  $file = strtolower(strtr($HTTP_HOST ."". substr($REQUEST_URI, 0, strrpos($REQUEST_URI, "/")), "/:", ".."));
Dries's avatar
   
Dries committed
13
14
15
16
17
18
19
20
21
22
23

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

  return "conf";
24
25
}

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

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

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

Dries's avatar
   
Dries committed
52
53
54
55
56
57
58
59
60
61
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
62
63
function message_access() {
  return t("You are not authorized to access to this page.");
Dries's avatar
   
Dries committed
64
}
Dries's avatar
   
Dries committed
65

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

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

Dries's avatar
CHANGES    
Dries committed
74
75
function check_form($text) {
  return htmlspecialchars(stripslashes($text));
Dries's avatar
   
Dries committed
76
77
}

Dries's avatar
CHANGES    
Dries committed
78
79
function check_export($text) {
  return htmlspecialchars(stripslashes($text));
Dries's avatar
   
Dries committed
80
81
}

Dries's avatar
CHANGES    
Dries committed
82
83
function check_code($text) {
  return $text;
Dries's avatar
   
Dries committed
84
85
}

Dries's avatar
CHANGES    
Dries committed
86
function check_preview($text) {
Dries's avatar
   
Dries committed
87
  return check_output(check_input($text));
Dries's avatar
CHANGES    
Dries committed
88
89
}

Dries's avatar
   
Dries committed
90
91
92
93
function check_query($text) {
  return addslashes(stripslashes($text));
}

Dries's avatar
CHANGES    
Dries committed
94
function check_input($text) {
Dries's avatar
   
Dries committed
95
96
97
  foreach (module_list() as $name) {
    if (module_hook($name, "filter")) $text = module_invoke($name, "filter", $text);
  }
Dries's avatar
CHANGES    
Dries committed
98
99
100
101
  return addslashes(stripslashes(substr($text, 0, variable_get("max_input_size", 10000))));
}

function check_output($text, $nl2br = 0) {
Dries's avatar
   
Dries committed
102
  return ($text) ? ($nl2br ? nl2br(stripslashes($text)) : stripslashes($text)) : message_na();
Dries's avatar
   
Dries committed
103
104
}

Dries's avatar
   
Dries committed
105
106
107
108
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
109
function format_rss_channel($title, $link, $description, $items, $language = "en") {
Dries's avatar
   
Dries committed
110
  $output .= "<channel>\n";
Dries's avatar
   
Dries committed
111
112
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
113
  $output .= " <description>". htmlentities($description) ."</description>\n";
Dries's avatar
   
Dries committed
114
  $output .= " <language>". htmlentities(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
115
116
117
118
119
120
121
122
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

function format_rss_item($title, $link, $description) {
  $output .= "<item>\n";
Dries's avatar
   
Dries committed
123
124
  $output .= " <title>". htmlentities(strip_tags($title)) ."</title>\n";
  $output .= " <link>". htmlentities(strip_tags($link)) ."</link>\n";
Dries's avatar
   
Dries committed
125
126
127
128
129
130
  $output .= " <description>". htmlentities($description) ."</description>\n";
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
131
132
133
134
function format_plural($count, $singular, $plural) {
  return ($count == 1) ? "$count ". t($singular) : "$count ". t($plural);
}

135
136
137
138
139
140
141
142
143
144
145
146
147
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
148
149
150
151
152
153
154
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
155
156
157
158
159
160
161
  if (!$user->id && $REQUEST_METHOD == "GET") {
    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
162
163
  }

Dries's avatar
   
Dries committed
164
  return $cache->data ? $cache->data : 0;
Dries's avatar
   
Dries committed
165
166
167
}

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

Dries's avatar
   
Dries committed
170
171
172
173
174
  if (!$user->id && $REQUEST_METHOD == "GET") {
    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
175
176
}

Dries's avatar
   
Dries committed
177
function format_interval($timestamp) {
Dries's avatar
   
Dries committed
178
  $units = array("year|years" => 31536000, "week|weeks" => 604800, "day|days" => 86400, "hour|hours" => 3600, "min|min" => 60, "sec|sec" => 1);
179
  foreach ($units as $key=>$value) {
Dries's avatar
   
Dries committed
180
    $key = explode("|", $key);
181
182
183
184
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
    }
Dries's avatar
   
Dries committed
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
  }
  return ($output) ? $output : "0 sec";
}

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

  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;

  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
205
206
      for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
        if (strstr("DFlMSw", $c)) {
Dries's avatar
   
Dries committed
207
          $date = t(date($c, $timestamp)).$date;
Dries's avatar
   
Dries committed
208
209
210
211
212
213
214
        }
        else if (strstr("AaBdgGhHiIjLmnrstTUYyZz", $c)) {
          $date = date($c, $timestamp).$date;
        }
        else {
          $date = $c.$date;
        }
215
      }
Dries's avatar
   
Dries committed
216
217
218
219
220
221
222
      break;
    default:
      $date = t(date("l", $timestamp)) .", ". date("m/d/Y - H:i", $timestamp);
  }
  return $date;
}

Dries's avatar
   
Dries committed
223
224
225
226
227
228
229
230
231
232
233
function format_name($username, $realname = "") {
  if ($realname) {
    watchdog("special", "format_name - FIX ME");
    return "<font color=\"red\">FIX ME</font>\n";
  }
  else if ($username) {
    return (user_access("administer users") ? "<a href=\"admin.php?mod=account&op=view&name=". urlencode($username) ."\">". $username ."</a>" : "<a href=\"account.php?op=view&name=". urlencode($username) ."\">$username</a>");
  }
  else {
    return variable_get(anonymous, "Anonymous");
  }
Dries's avatar
   
Dries committed
234
235
236
}

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

Dries's avatar
   
Dries committed
240
function format_url($address, $description = 0) {
Dries's avatar
   
Dries committed
241
  $description = ($description) ? $description : $address;
Dries's avatar
   
Dries committed
242
  return ($address) ? "<a href=\"$address\">". check_output($description) ."</a>" : message_na();
Dries's avatar
   
Dries committed
243
244
245
246
247
248
}

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

Dries's avatar
   
Dries committed
249
function form($action, $form, $method = "post", $options = 0) {
Dries's avatar
   
Dries committed
250
  return "<form action=\"$action\" method=\"$method\"". ($options ? " $options" : "") .">\n$form</form>\n";
Dries's avatar
   
Dries committed
251
252
}

Dries's avatar
   
Dries committed
253
function form_item($title, $value, $description = 0) {
Dries's avatar
   
Dries committed
254
  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
255
256
257
}

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

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

Kjartan's avatar
Changes    
Kjartan committed
265
function form_select($title, $name, $value, $options, $description = 0, $extra = 0) {
266
  if (count($options) > 0) {
Kjartan's avatar
Changes    
Kjartan committed
267
268
    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);
269
  }
Dries's avatar
   
Dries committed
270
271
}

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

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

Dries's avatar
   
Dries committed
280
function form_submit($value) {
Dries's avatar
   
Dries committed
281
  return "<input type=\"submit\" name=\"op\" value=\"". check_form($value) ."\" />\n";
Dries's avatar
   
Dries committed
282
283
}

Dries's avatar
   
Dries committed
284
function field_get($string, $name) {
285
286
  ereg(",$name=([^,]+)", ",$string", $regs);
  return $regs[1];
Dries's avatar
   
Dries committed
287
288
}

Dries's avatar
   
Dries committed
289
function field_set($string, $name, $value) {
290
291
292
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
  if ($value) $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  return substr($rval, 1);
Dries's avatar
   
Dries committed
293
294
}

Dries's avatar
   
Dries committed
295
function field_merge($a, $b) {
296
297
  foreach (explode(",", $b) as $data) {
    $entry = explode("=", $data);
Dries's avatar
   
Dries committed
298
299
300
301
302
    $a = field_set($a, $entry[0], $entry[1]);
  }
  return $a;
}

Dries's avatar
   
Dries committed
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
function link_page() {

  $links[] = "<a href=\"index.php\">". t("home") ."</a>";
  $links[] = "<a href=\"submit.php\">". t("submit") ."</a>";
  $links[] = "<a href=\"account.php\">". t("account") ."</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
320
321
322
323
324
325
326
  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
327
328
}

Dries's avatar
CHANGES    
Dries committed
329
330
331
332
333
334
335
336
337
338
339
340
341
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
342
343
344
345
346
  global $user;

  if (variable_get("dev_timer", 0)) {
    timer_start();
  }
Dries's avatar
   
Dries committed
347
348
349
350
351
352
353

  if (variable_get("cache", 0)) {
    if ($data = cache_get()) {
      print $data;
      exit();
    }
  }
Dries's avatar
CHANGES    
Dries committed
354
355
356
}

function page_footer() {
Dries's avatar
   
Dries committed
357
358
359
  if (variable_get("dev_timer", 0)) {
    timer_print();
  }
Dries's avatar
   
Dries committed
360

Dries's avatar
   
Dries committed
361
362
363
  if (variable_get("cache", 0)) {
    cache_set();
  }
Dries's avatar
CHANGES    
Dries committed
364
365
}

Dries's avatar
   
Dries committed
366
$conf = conf_init();
367

Dries's avatar
   
Dries committed
368
include_once "includes/$conf.php";
Dries's avatar
 
Dries committed
369
include_once "includes/database.inc";
Dries's avatar
   
Dries committed
370
include_once "includes/variable.inc";
Dries's avatar
   
Dries committed
371
include_once "includes/comment.inc";
Dries's avatar
   
Dries committed
372
include_once "includes/module.inc";
Dries's avatar
   
Dries committed
373
374
include_once "includes/locale.inc";
include_once "includes/search.inc";
Dries's avatar
 
Dries committed
375
376
include_once "includes/theme.inc";
include_once "includes/user.inc";
Dries's avatar
   
Dries committed
377
include_once "includes/node.inc";
Dries's avatar
 
Dries committed
378

Dries's avatar
   
Dries committed
379
380
381
// initialize configuration variables:
$conf = variable_init();

Dries's avatar
   
Dries committed
382
// initialize user session:
Dries's avatar
   
Dries committed
383
user_init();
Dries's avatar
   
Dries committed
384
385

// initialize installed modules:
Dries's avatar
   
Dries committed
386
module_init();
Dries's avatar
   
Dries committed
387
388

// initialize localization system:
Dries's avatar
   
Dries committed
389
$locale = locale_init();
Dries's avatar
   
Dries committed
390
391

// initialize theme:
Dries's avatar
   
Dries committed
392
$theme = theme_init();
Dries's avatar
 
Dries committed
393

Dries's avatar
   
Dries committed
394
395
396
// set error handler:
set_error_handler("error_handler");

Dries's avatar
   
Dries committed
397
?>