common.inc 33.3 KB
Newer Older
Dries Buytaert's avatar
   
Dries Buytaert committed
1
2
3
4
5
6
7
8
9
10
11
<?php
// $Id$

function conf_init() {

  /*
  ** 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
12
  $uri = $_SERVER["PHP_SELF"];
Dries Buytaert's avatar
   
Dries Buytaert committed
13

Dries Buytaert's avatar
   
Dries Buytaert committed
14
  $file = strtolower(strtr($_SERVER["HTTP_HOST"] . substr($uri, 0, strrpos($uri, "/")), "/:", ".."));
Dries Buytaert's avatar
   
Dries Buytaert committed
15
16
17
18
19
20
21
22
23
24
25
26
27

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

  return "conf";
}

Dries Buytaert's avatar
   
Dries Buytaert committed
28
29
30
/**
 * Build the alias/path array
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
31
function drupal_get_path_map($action = "") {
Dries Buytaert's avatar
   
Dries Buytaert committed
32
33

  static $cache;
Dries Buytaert's avatar
   
Dries Buytaert committed
34
35
  static $map;

Dries Buytaert's avatar
   
Dries Buytaert committed
36
37
  if ($action == "rebuild") {
    $map = NULL;
Dries Buytaert's avatar
   
Dries Buytaert committed
38
    $cache = 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
39
40
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
41
  if (!$cache) {
Dries Buytaert's avatar
   
Dries Buytaert committed
42
    $result = db_query("SELECT * FROM {url_alias}");
Dries Buytaert's avatar
   
Dries Buytaert committed
43
    while ($data = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
44
      $map[$data->dst] = $data->src;
Dries Buytaert's avatar
   
Dries Buytaert committed
45
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
46
47

    $cache = 1;
Dries Buytaert's avatar
   
Dries Buytaert committed
48
49
50
51
52
  }

  return $map;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
53
54
55
56
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}

Dries Buytaert's avatar
   
Dries Buytaert committed
57
58
59
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
60
61

  if ($errno & E_ALL ^ E_NOTICE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
62
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
63
    print "<pre>$entry</pre>";
Dries Buytaert's avatar
   
Dries Buytaert committed
64
65
66
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
67
function watchdog($type, $message, $link = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
68
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
69
  db_query("INSERT INTO {watchdog} (uid, type, message, link, location, hostname, timestamp) VALUES (%d, '%s', '%s', '%s', '%s', '%s', %d)", $user->uid, $type, $message, $link, request_uri(), getenv("REMOTE_ADDR"), time());
Dries Buytaert's avatar
   
Dries Buytaert committed
70
71
72
73
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
74
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '$type' AND hostname = '". getenv("REMOTE_ADDR") ."' AND ". time() ." - timestamp < $rate"))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
75
76
77
78
79
80
81
82
83
      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
84
85
86
87
function _fix_gpc_magic_array(&$items) {
  foreach ($items as $k => $i) {
    if (is_array($i)) _fix_gpc_magic_array($items[$k]);
    else $items[$k] = stripslashes($i);
Dries Buytaert's avatar
   
Dries Buytaert committed
88
89
90
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
91
92
93
94
95
96
97
98
99
100
101
102
function fix_gpc_magic() {
  static $fixed = false;
  if ($fixed) return;
  if (ini_get("magic_quotes_gpc") == 0) return;

  _fix_gpc_magic_array($_GET);
  _fix_gpc_magic_array($_POST);
  _fix_gpc_magic_array($_COOKIE);

  $fixed = true;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
103
104
105
106
107
function arg($index) {

  static $arguments;

  if (empty($arguments)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
108
    $arguments = explode("/", $_GET["q"]);
Dries Buytaert's avatar
   
Dries Buytaert committed
109
110
111
112
113
  }

  return $arguments[$index];
}

Dries Buytaert's avatar
   
Dries Buytaert committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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
142
143
144
145
146
147
148
149
150
function referer_uri() {

  if (isset($_SERVER["HTTP_REFERER"])) {
    $uri = $_SERVER["HTTP_REFERER"];

    return check_url($uri);
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
151
function request_uri() {
Dries Buytaert's avatar
   
Dries Buytaert committed
152
153
154
155
  /*
  ** Since request_uri() is only available on Apache, we generate
  ** equivalent using other environment vars.
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
156

Dries Buytaert's avatar
   
Dries Buytaert committed
157
  if (isset($_SERVER["REQUEST_URI"])) {
158
    $uri = $_SERVER["REQUEST_URI"];
Dries Buytaert's avatar
   
Dries Buytaert committed
159
160
  }
  else {
161
    $uri = $_SERVER["PHP_SELF"] ."?". $_SERVER["QUERY_STRING"];
Dries Buytaert's avatar
   
Dries Buytaert committed
162
  }
163

Dries Buytaert's avatar
   
Dries Buytaert committed
164
  return check_url($uri);
Dries Buytaert's avatar
   
Dries Buytaert committed
165
166
}

Dries Buytaert's avatar
   
Dries Buytaert committed
167
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
168
  return t("You are not authorized to access this page.");
Dries Buytaert's avatar
   
Dries Buytaert committed
169
170
171
172
173
174
175
176
177
178
}

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
179
180
function locale_init() {
  global $languages, $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
181
182
183
184
185
186
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
187
188
}

Dries Buytaert's avatar
   
Dries Buytaert committed
189
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
190
  global $languages;
191

Dries Buytaert's avatar
   
Dries Buytaert committed
192
193
194
195
196
197
198
  /*
  ** 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
Dries Buytaert's avatar
   
Dries Buytaert committed
199
200
  **           account</a> before viewing the next page.", array("%url"
  **           => url("user/register")));
Dries Buytaert's avatar
   
Dries Buytaert committed
201
202
  */

203
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
204

Dries Buytaert's avatar
   
Dries Buytaert committed
205
206
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
207
208
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
209
210
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
211
212
213
}

function variable_init($conf = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
214
  $result = db_query("SELECT * FROM {variable} ");
Dries Buytaert's avatar
   
Dries Buytaert committed
215
216
  while ($variable = db_fetch_object($result)) {
    if (!isset($conf[$variable->name])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
217
      $conf[$variable->name] = unserialize($variable->value);
Dries Buytaert's avatar
   
Dries Buytaert committed
218
219
220
221
222
223
    }
  }

  return $conf;
}

224
function variable_get($name, $default) {
Dries Buytaert's avatar
   
Dries Buytaert committed
225
226
227
228
229
230
231
232
  global $conf;

  return isset($conf[$name]) ? $conf[$name] : $default;
}

function variable_set($name, $value) {
  global $conf;

Dries Buytaert's avatar
   
Dries Buytaert committed
233
234
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries Buytaert's avatar
   
Dries Buytaert committed
235
236
237
238
239
240
241

  $conf[$name] = $value;
}

function variable_del($name) {
  global $conf;

Dries Buytaert's avatar
   
Dries Buytaert committed
242
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries Buytaert's avatar
   
Dries Buytaert committed
243
244
245
246

  unset($conf[$name]);
}

Dries Buytaert's avatar
   
Dries Buytaert committed
247
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries Buytaert's avatar
   
Dries Buytaert committed
248
249
250
251
252
253
254
255
256

  /*
  ** Note that we'd like to go 'htmlspecialchars($input, $quotes, "utf-8")'
  ** like the PHP manual tells us to, but we can't because there's a bug in
  ** PHP <4.3 that makes it mess up multibyte charsets if we specify the
  ** charset.  Change this later once we make PHP 4.3 a requirement.
  */

  return htmlspecialchars($input, $quotes);
Dries Buytaert's avatar
   
Dries Buytaert committed
257
258
}

Dries Buytaert's avatar
   
Dries Buytaert committed
259
function table_cell($cell, $header = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
260
  if (is_array($cell)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
261
262
263
264
265
266
267
268
269
270
271
    $data = $cell["data"];
    foreach ($cell as $key => $value) {
      if ($key != "data")  {
        $attributes .= " $key=\"$value\"";
      }
    }
  }
  else {
    $data = $cell;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
272
  if ($header) {
Dries Buytaert's avatar
   
Dries Buytaert committed
273
274
275
276
277
278
279
280
281
282
283
    $output = "<th$attributes>$data</th>";
  }
  else {
    $output = "<td$attributes>$data</td>";
  }

  return $output;
}

function table($header, $rows) {

284
  $output = "<table>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
285
286
287
288
289

  /*
  ** Emit the table header:
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
290
291
292
  if (is_array($header)) {
    $output .= " <tr>";
    foreach ($header as $cell) {
Dries Buytaert's avatar
   
Dries Buytaert committed
293
294
295
      if (is_array($cell) && $cell["field"]) {
        $cell = tablesort($cell, $header);
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
296
297
      $output .= table_cell($cell, 1);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
298
    $output .= " </tr>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
299
300
301
302
303
304
  }

  /*
  ** Emit the table rows:
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
305
306
307
308
309
310
311
312
  if (is_array($rows)) {
    foreach ($rows as $number => $row) {
      if ($number % 2 == 1) {
        $output .= " <tr class=\"light\">";
      }
      else {
        $output .= " <tr class=\"dark\">";
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
313

Dries Buytaert's avatar
   
Dries Buytaert committed
314
315
316
      foreach ($row as $cell) {
        $output .= table_cell($cell, 0);
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
317
      $output .= " </tr>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
318
319
320
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
321
  $output .= "</table>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
322
323
324
325

  return $output;
}

326
327
328
329
330
331
/**
 * Verify the syntax of the given e-mail address.  Empty e-mail addresses
 * are allowed.  See RFC 2822 for details.
 *
 * @param $mail  a email address
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
332
function valid_email_address($mail) {
333
334
335
336
337
338
339
340
341
342
343
344
345
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
  $domain = '(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.?)+';
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

  if (preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail)) {
    return 1;
  }
  else {
    return 0;
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
346
347
348
349
350
351
352
/**
 * Verify the syntax of the given URL.
 *
 * @param $url  an URL
 */
function valid_url($url) {

Dries Buytaert's avatar
   
Dries Buytaert committed
353
  if (preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
354
355
356
357
358
359
360
    return 1;
  }
  else {
    return 0;
  }
}

Kjartan Mannes's avatar
Kjartan Mannes committed
361
362
363
364
/**
 * 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
365
 *               array("count" => ..., "link" => ..., "title" => ...,
Kjartan Mannes's avatar
Kjartan Mannes committed
366
367
368
 *               "user" => ..., "date" => ..., "keywords" => ...)
 * @param $type  module type of this item
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
369
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
370
371
372
373
374
375
376
377
378
379

  /*
  ** 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 {
Dries Buytaert's avatar
   
Dries Buytaert committed
380
    $output .= " <b><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></b><br />";
Dries Buytaert's avatar
   
Dries Buytaert committed
381
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries Buytaert's avatar
   
Dries Buytaert committed
382
383
    $output .= "<br /><br />";
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
384
385
386
387

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
388
389
390
391
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries Buytaert's avatar
   
Dries Buytaert committed
392
 * 'site.com/search', but also as a simple seach box (without
Dries Buytaert's avatar
   
Dries Buytaert committed
393
394
 * "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
395
396
 * parts of this form.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
397
 * @param $action  Form action. Defaults to 'site.com/search'.
Dries Buytaert's avatar
   
Dries Buytaert committed
398
 * @param $keys   string containing keywords for the search.
Dries Buytaert's avatar
   
Dries Buytaert committed
399
 * @param $options != 0: Render additional form fields/text
Kjartan Mannes's avatar
Kjartan Mannes committed
400
401
 *                 ("Restrict search to", help text, etc).
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
402
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
403
404

  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
405
    $action = url("search");
Dries Buytaert's avatar
   
Dries Buytaert committed
406
407
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
408
409
  $output .= " <br /><input type=\"text\" class=\"form-text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
410
411
412
413
414
415
416

  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
417
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries Buytaert's avatar
   
Dries Buytaert committed
418
419
420
421
      }
    }
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
424
425
426
427
  return form($output, "post", $action);
}

/*
Kjartan Mannes's avatar
Kjartan Mannes committed
428
429
 * Collect the search results:
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
430
function search_data($keys = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
431
432

  $edit = $_POST["edit"];
Dries Buytaert's avatar
   
Dries Buytaert committed
433

Dries Buytaert's avatar
   
Dries Buytaert committed
434
  if (isset($keys)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
435
    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
436
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name]) && ($result = module_invoke($name, "search", $keys))) {
Kjartan Mannes's avatar
Kjartan Mannes committed
437
        if ($name == "node" || $name == "comment") {
Dries Buytaert's avatar
   
Dries Buytaert committed
438
          $output .= "<p><b>". t("Matching ". $name ."s ranked in order of relevance") .":</b></p>";
Kjartan Mannes's avatar
Kjartan Mannes committed
439
440
        }
        else {
Dries Buytaert's avatar
   
Dries Buytaert committed
441
          $output .= "<p><b>". t("Matching ". $name ."s") .":</b></p>";
Kjartan Mannes's avatar
Kjartan Mannes committed
442
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
443
444
445
446
447
448
449
450
451
452
        foreach ($result as $entry) {
          $output .= search_item($entry, $name);
        }
      }
    }
  }

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
453
454
455
/**
 * Display the search form and the resulting data.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
456
 * @param $type    If set, search only nodes of this type.
Kjartan Mannes's avatar
Kjartan Mannes committed
457
 *                 Otherwise, search all types.
Dries Buytaert's avatar
   
Dries Buytaert committed
458
 * @param $action  Form action. Defaults to 'site.com/search'.
Kjartan Mannes's avatar
Kjartan Mannes committed
459
 * @param $query   Query string. Defaults to global $keys.
Dries Buytaert's avatar
   
Dries Buytaert committed
460
 * @param $options != 0: Render additional form fields/text
Kjartan Mannes's avatar
Kjartan Mannes committed
461
462
 *                 ("Restrict search to", help text, etc).
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
463
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
464

Dries Buytaert's avatar
   
Dries Buytaert committed
465
  $_POST["edit"]["type"][$type] = "on";
Dries Buytaert's avatar
   
Dries Buytaert committed
466

Dries Buytaert's avatar
   
Dries Buytaert committed
467
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries Buytaert's avatar
   
Dries Buytaert committed
468
469
}

Dries Buytaert's avatar
   
Dries Buytaert committed
470

Dries Buytaert's avatar
   
Dries Buytaert committed
471
472
function drupal_goto($url) {

Dries Buytaert's avatar
   
Dries Buytaert committed
473
474
475
  /*
  ** Translate &amp; to simply &
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
476

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

Dries Buytaert's avatar
   
Dries Buytaert committed
479
480
481
482
483
  /*
  ** 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
484
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
Dries Buytaert's avatar
   
Dries Buytaert committed
485
486
487
    header("Location: $url");
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
488
489
490
491
492
493
494
495
    $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
496
497
498
499
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
Dries Buytaert's avatar
   
Dries Buytaert committed
500
  ** daemon.  In some cases this can go wrong, so we make sure none
Dries Buytaert's avatar
   
Dries Buytaert committed
501
502
503
504
505
506
507
508
509
510
511
  ** 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
512
513
  if (!strstr(referer_uri(), request_uri())) {
    $_SESSION["referer"] = referer_uri();
Dries Buytaert's avatar
   
Dries Buytaert committed
514
515
516
517
518
519
520
521
  }
}

/*
** Restores the referer from a persistent variable:
*/

function referer_load() {
Dries Buytaert's avatar
   
Dries Buytaert committed
522
523
  if (isset($_SESSION["referer"])) {
    return $_SESSION["referer"];
Dries Buytaert's avatar
   
Dries Buytaert committed
524
525
526
527
528
529
  }
  else {
    return 0;
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
530
function valid_input_data($data) {
531

532
  if (is_array($data) || is_object($data)) {
533
534
535
536
537
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
538
539
540
      if (!valid_input_data($value)) {
        return 0;
      }
541
542
543
544
545
546
547
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

Dries Buytaert's avatar
Dries Buytaert committed
548
    // check strings:
Dries Buytaert's avatar
Dries Buytaert committed
549
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
Dries Buytaert's avatar
Dries Buytaert committed
550
551
552
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

553
    // check attributes:
Dries Buytaert's avatar
Dries Buytaert committed
554
    $match += preg_match("/\W(dynsrc|datasrc|data|lowsrc|on[a-z]+)\s*=[^>]+?>/i", $data);
Dries Buytaert's avatar
   
Dries Buytaert committed
555

556
557

    // check tags:
Dries Buytaert's avatar
   
Dries Buytaert committed
558
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);
559
560
561

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
Dries Buytaert's avatar
   
Dries Buytaert committed
562
      return 0;
563
564
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
565
566

  return 1;
567
}
Dries Buytaert's avatar
   
Dries Buytaert committed
568

569
function check_url($uri) {
Dries Buytaert's avatar
   
Dries Buytaert committed
570
571
572
573
574
575
576
577
578
579
580
581
  $uri = htmlspecialchars($uri, ENT_QUOTES);

  /*
  ** We replace ( and ) with their entity equivalents to prevent XSS
  ** attacks.
  */

  $uri = strtr($uri, array("(" => "&040;", ")" => "&041;"));

  return $uri;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
582
function check_form($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
583
  return drupal_specialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
584
585
}

Dries Buytaert's avatar
   
Dries Buytaert committed
586
function check_query($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
587
  return addslashes($text);
Dries Buytaert's avatar
   
Dries Buytaert committed
588
589
590
}

function filter($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
591

Dries Buytaert's avatar
   
Dries Buytaert committed
592
593
594
595
596
597
598
599
600
601
602
603
604
  $modules = module_list();

  /*
  ** Make sure the HTML filters that are part of the node module
  ** are run first.
  */

  if (in_array("node", $modules)) {
    $text = module_invoke("node", "filter", $text);
  }

  foreach ($modules as $name) {
    if (module_hook($name, "filter") && $name != "node") {
Dries Buytaert's avatar
   
Dries Buytaert committed
605
606
607
608
609
      $text = module_invoke($name, "filter", $text);
    }
  }

  return $text;
Dries Buytaert's avatar
   
Dries Buytaert committed
610
611
}

Dries Buytaert's avatar
   
Dries Buytaert committed
612
613
function rewrite_old_urls($text) {

Dries Buytaert's avatar
   
Dries Buytaert committed
614
615
616
617
  global $base_url;

  $end = substr($base_url, 12);

Dries Buytaert's avatar
   
Dries Buytaert committed
618
619
620
  /*
  ** This is a *temporary* filter to rewrite old-style URLs to new-style
  ** URLs (clean URLs).  Currently, URLs are being rewritten dynamically
Dries Buytaert's avatar
   
Dries Buytaert committed
621
622
  ** (ie. "on output"), however when these rewrite rules have been tested
  ** enough, we will use them to permanently rewrite the links in node
Dries Buytaert's avatar
   
Dries Buytaert committed
623
624
625
  ** and comment bodies.
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
626
  if (variable_get("clean_url", "0") == "0") {
Dries Buytaert's avatar
   
Dries Buytaert committed
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
    /*
    ** Relative URLs:
    */

    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
    $text = eregi_replace("\"(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "\"?q=\\1/view/\\2/\\4", $text);

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"?q=\\2/\\4/\\6" , $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"?q=\\2/\\4", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"?q=\\2", $text);

    /*
    ** Absolute URLs:
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
643
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries Buytaert's avatar
   
Dries Buytaert committed
644
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/?q=\\1/view/\\2/\\4", $text);
Dries Buytaert's avatar
   
Dries Buytaert committed
645

Dries Buytaert's avatar
   
Dries Buytaert committed
646
    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries Buytaert's avatar
   
Dries Buytaert committed
647
648
649
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/?q=\\2/\\4/\\6" , $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/?q=\\2/\\4", $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"$end/?q=\\2", $text);
Dries Buytaert's avatar
   
Dries Buytaert committed
650
651
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
652
653
654
655
    /*
    ** Relative URLs:
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
656
    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
Dries Buytaert's avatar
   
Dries Buytaert committed
657
    $text = eregi_replace("\"(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "\"\\1/view/\\2/\\4", $text);
Dries Buytaert's avatar
   
Dries Buytaert committed
658
659

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
Dries Buytaert's avatar
   
Dries Buytaert committed
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2/\\4/\\6", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2/\\4", $text);
    $text = ereg_replace("\"module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "\"\\2", $text);

    /*
    ** Absolute URLs:
    */

    // rewrite 'node.php?id=<number>[&cid=<number>]' style URLs:
    $text = eregi_replace("$end/(node)\.php\?id=([[:digit:]]+)(&cid=)?([[:digit:]]*)", "$end/\\1/view/\\2/\\4", $text);

    // rewrite 'module.php?mod=<name>{&<op>=<value>}' style URLs:
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/\\2/\\4/\\6", $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/\\2/\\4", $text);
    $text = ereg_replace("$end/module\.php\?(&?[[:alpha:]]+=([[:alnum:]]+))", "$end/\\2", $text);
}
Dries Buytaert's avatar
   
Dries Buytaert committed
676

Dries Buytaert's avatar
   
Dries Buytaert committed
677
678
679
  return $text;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
680
function check_output($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
681
  if (isset($text)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
682
683
684
685
    // filter content on output:
    $text = filter($text);

    // get the line breaks right:
Dries Buytaert's avatar
   
Dries Buytaert committed
686
    if (strip_tags($text, "<a><i><b><u><tt><code><cite><strong><img>") == $text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
687
688
689
690
691
692
693
694
      $text = nl2br($text);
    }
  }
  else {
    $text = message_na();
  }

  return $text;
Dries Buytaert's avatar
   
Dries Buytaert committed
695
696
}

697

698
699
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
700
701
}

Dries Buytaert's avatar
   
Dries Buytaert committed
702
703
704
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
705
  $output .= "<channel>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
706
707
708
709
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars($description) ."</description>\n";
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
710
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
711
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
712
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
713
714
715
716
717
718
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
719
720
721
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
722
  $output .= "<item>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
723
724
725
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars(check_output($description)) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
726
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
727
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
728
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
729
730
731
732
733
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
734
735
736
737
738
739
740
741
742
743
744
745
746
747
/**
 * Formats a string with a count of items so that the string is pluralized
 * correctly.
 * format_plural calls t() by itself, make sure not to pass already localized
 * strings to it.
 *
 * @param $count    The item count to display.
 * @param $singular The string for the singular case. Please make sure it's clear
 *                  this is singular, to ease translation. ("1 new comment" instead of
 *                  "1 new").
 * @param $plural   The string for the plrual case. Please make sure it's clear
 *                  this is plural, to ease translation. Use %count in places of the
 *                  item count, as in "%count new comments".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
748
function format_plural($count, $singular, $plural) {
Dries Buytaert's avatar
   
Dries Buytaert committed
749
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
750
751
752
}

function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
753
  $suffix = t("bytes");
Dries Buytaert's avatar
   
Dries Buytaert committed
754
755
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
756
    $suffix = t("KB");
Dries Buytaert's avatar
   
Dries Buytaert committed
757
758
759
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
760
    $suffix = t("MB");
Dries Buytaert's avatar
   
Dries Buytaert committed
761
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
762
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
763
764
}

Dries Buytaert's avatar
   
Dries Buytaert committed
765
function cache_get($key) {
Dries Buytaert's avatar
   
Dries Buytaert committed
766
  $cache = db_fetch_object(db_query("SELECT data, created FROM {cache} WHERE cid = '%s'", $key));
Dries Buytaert's avatar
   
Dries Buytaert committed
767
  return $cache->data ? $cache : 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
768
769
770
}

function cache_set($cid, $data, $expire = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
771
772
  db_query("UPDATE {cache} SET data = '%s', created = %d, expire = %d WHERE cid = '%s'", $data, time(), $expire, $cid);
  if (!db_affected_rows()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
773
    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
774
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
775
776
}

Dries Buytaert's avatar
   
Dries Buytaert committed
777
778
function cache_clear_all($cid = NULL) {
  if (empty($cid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
779
    db_query("DELETE FROM {cache} WHERE expire <> 0");
Dries Buytaert's avatar
   
Dries Buytaert committed
780
781
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
782
    db_query("DELETE FROM {cache} WHERE cid = '%s'", $cid);
Dries Buytaert's avatar
   
Dries Buytaert committed
783
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
784
785
786
}

function page_set_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
787
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
788

Dries Buytaert's avatar
   
Dries Buytaert committed
789
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries Buytaert's avatar
   
Dries Buytaert committed
790
    if ($data = ob_get_contents()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
791
      cache_set(request_uri(), $data, 1);
Dries Buytaert's avatar
   
Dries Buytaert committed
792
793
794
795
    }
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
796
function page_get_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
797
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
798

Dries Buytaert's avatar
   
Dries Buytaert committed
799
800
  $cache = NULL;

Dries Buytaert's avatar
   
Dries Buytaert committed
801
  if (!$user->uid && $_SERVER["REQUEST_METHOD"] == "GET") {
Dries Buytaert's avatar
   
Dries Buytaert committed
802
803
804
    $cache = cache_get(request_uri());

    if (empty($cache)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
805
      ob_start();
Dries Buytaert's avatar
   
Dries Buytaert committed
806
807
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
808

Dries Buytaert's avatar
   
Dries Buytaert committed
809
  return $cache;
Dries Buytaert's avatar
   
Dries Buytaert committed
810
811
812
}

function format_interval($timestamp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
813
  $units = array("1 year|%count years" => 31536000, "1 week|%count weeks" => 604800, "1 day|%count days" => 86400, "1 hour|%count hours" => 3600, "1 min|%count min" => 60, "1 sec|%count sec" => 1);
Kjartan Mannes's avatar
Kjartan Mannes committed
814
  foreach ($units as $key=>$value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
815
816
817
818
819
820
    $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
821
  return ($output) ? $output : t("0 sec");
Dries Buytaert's avatar
   
Dries Buytaert committed
822
823
824
825
826
}

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

Kjartan Mannes's avatar
Kjartan Mannes committed
827
  $timestamp += ($user->timezone) ? $user->timezone - date("Z") : 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
828
829
830

  switch ($type) {
    case "small":
Dries Buytaert's avatar
   
Dries Buytaert committed
831
      $format = variable_get("date_format_short", "m/d/Y - H:i");
Dries Buytaert's avatar
   
Dries Buytaert committed
832
833
      break;
    case "large":
Dries Buytaert's avatar
   
Dries Buytaert committed
834
      $format = variable_get("date_format_long", "l, F j, Y - H:i");
Dries Buytaert's avatar
   
Dries Buytaert committed
835
836
      break;
    case "custom":
Dries Buytaert's avatar
   
Dries Buytaert committed
837
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
838
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
839
    case "medium":
Dries Buytaert's avatar
   
Dries Buytaert committed
840
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
841
842
843
844
845
846
847
848
849
850
851
852
853
      $format = variable_get("date_format_medium", "D, m/d/Y - H:i");
  }

  for ($i = strlen($format); $i >= 0; $c = $format[--$i]) {
    if (strstr("DFlMSw", $c)) {
      $date = t(date($c, $timestamp)) . $date;
    }
    else if (strstr("AaBdgGhHiIjLmnOrstTUWYyZz", $c)) {
      $date = date($c, $timestamp) . $date;
    }
    else {
      $date = $c.$date;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
854
855
856
857
858
859
860
  }
  return $date;
}

function format_name($object) {

  if ($object->uid && $object->name) {
861
862
863
864
865
866
867
868
869
870
871
872
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
      $name = substr($object->name, 0, 15) ."...";
    }
    else {
      $name = $object->name;
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
873
    if (arg(0) == "admin") {
874
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
875
876
    }
    else {
877
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
878
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
879
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
880
881
882
883
884
885
886
887
888
889
  else if ($object->name) {
    /*
    ** Sometimes modules display content composed by people who are
    ** not registers members of the site (i.e. mailing list or news
    ** aggregator modules).  This clause enables modules to display
    ** the true author of the content.
    */

    $output = $object->name;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
890
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
891
    $output = t(variable_get("anonymous", "Anonymous"));
Dries Buytaert's avatar
   
Dries Buytaert committed
892
893
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
894
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
895
896
897
}

function form($form, $method = "post", $action = 0, $options = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
898
899

  if (!$action) {
900
    $action = request_uri();
Dries Buytaert's avatar
   
Dries Buytaert committed
901
  }
902
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
903
904
905
}

function form_item($title, $value, $description = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
906
  return "<div class=\"form-item\">". ($title ? "<div class=\"title\">$title:</div>" : "") . $value . ($description ? "<div class=\"description\">$description</div>" : "") ."</div>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
907
}
Dries Buytaert's avatar
   
Dries Buytaert committed
908
909
910
function form_group($legend, $group, $description = 0) {
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries Buytaert's avatar
   
Dries Buytaert committed
911

912
913
function form_radio($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
  return form_item(0, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
914
915
}

916
917
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = 0, $attributes = 0) {
  return form_hidden($name, 0) . form_item(0, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
918
919
}

920
function form_textfield($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
921
  $size = $size ? " size=\"$size\"" : "";
922
  return form_item($title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
923
924
}

925
function form_password($title, $name, $value, $size, $maxlength, $description = 0, $attributes = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
926
  $size = $size ? " size=\"$size\"" : "";
927
  return form_item($title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
928
929
}

930
function form_textarea($title, $name, $value, $cols, $rows, $description = 0, $attributes = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
931
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries Buytaert's avatar
   
Dries Buytaert committed
932
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
933
  return form_item($title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"edit[$name]\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
934
935
}

Dries Buytaert's avatar
   
Dries Buytaert committed
936
function form_select($title, $name, $value, $options, $description = 0, $extra = 0, $multiple = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
937
  if (count($options) > 0) {
Kjartan Mannes's avatar
Kjartan Mannes committed
938
    foreach ($options as $key=>$choice) {
939
      $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($value == $key ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
Dries Buytaert's avatar
   
Dries Buytaert committed
940
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
941
    return form_item($title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple " : "") . ($extra ? " $extra" : "") .">$select</select>", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
942
943
944
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
945
946
947
948
949
950
951
952
953
function form_radios($title, $name, $value, $options, $description = 0) {
  if (count($options) > 0) {
    foreach ($options as $key=>$choice) {
      $output .= form_radio($choice, $name, $key, ($key == $value));
    }
    return form_item($title, $output, $description);
  }
}

954
955
function form_file($title, $name, $size, $description = 0) {
  return form_item($title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" size=\"$size\" />\n", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
956
957
958
959
960
961
}

function form_hidden($name, $value) {
  return "<input type=\"hidden\" name=\"edit[$name]\" value=\"". check_form($value) ."\" />\n";
}

962
function form_submit($value, $name = "op", $attributes = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
963
  return "<input type=\"submit\" class=\"form-submit\" name=\"$name\" value=\"". check_form($value) ."\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
964
965
}

Dries Buytaert's avatar
   
Dries Buytaert committed
966
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = 0, $extra = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
967
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries Buytaert's avatar
   
Dries Buytaert committed
968
969
970
971
972
973
    $weights[$n] = $n;
  }

  return form_select($title, $name, $value, $weights, $description, $extra);
}

Dries Buytaert's avatar
   
Dries Buytaert committed
974
975
976
977
function form_allowed_tags_text() {
  return variable_get("allowed_html", "") ? (t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", ""))) : "";
}

Dries Buytaert's avatar
   
Dries Buytaert committed
978
979
980
/**
 * Given an old url, return the alias.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
981
982
function drupal_get_path_alias($path) {
  $map = drupal_get_path_map();
Dries Buytaert's avatar
   
Dries Buytaert committed
983

Dries Buytaert's avatar
   
Dries Buytaert committed
984
985
986
  if ($map) {
    return array_search($path, $map);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
987
988
989
}

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
990
 * Given an alias, return the default url.
Dries Buytaert's avatar
   
Dries Buytaert committed
991
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
992
993
function drupal_get_normal_path($path) {
  $map = drupal_get_path_map();
Dries Buytaert's avatar
   
Dries Buytaert committed
994
995
996
  return $map[$path];
}

Dries Buytaert's avatar
   
Dries Buytaert committed
997
function url($url = NULL, $query = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
998
  global $base_url;
Dries Buytaert's avatar
   
Dries Buytaert committed
999

Dries Buytaert's avatar
   
Dries Buytaert committed
1000
  static $script;
For faster browsing, not all history is shown. View entire blame