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

Dries's avatar
   
Dries committed
4
/**
Kjartan's avatar
Kjartan committed
5
6
7
8
9
10
 * @defgroup common Core functions
 */

/**
 * @name Page title
 * @ingroup common
Dries's avatar
   
Dries committed
11
12
13
14
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries's avatar
   
Dries committed
15
16
17
18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
   
Dries committed
19
    $stored_title = ucfirst($title);
Dries's avatar
   
Dries committed
20
21
22
23
24
25
26
27
28
29
30
31
32
  }
  return $stored_title;
}

function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}
Kjartan's avatar
Kjartan committed
33
/* @} */
Dries's avatar
   
Dries committed
34

Dries's avatar
   
Dries committed
35
/**
Kjartan's avatar
Kjartan committed
36
37
 * @name Page messages
 * @ingroup common
Dries's avatar
   
Dries committed
38
39
40
41
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries's avatar
   
Dries committed
42
function drupal_set_message($message = NULL, $type = "status") {
Dries's avatar
   
Dries committed
43
  static $stored_message = array();
Dries's avatar
   
Dries committed
44
45

  if (isset($message)) {
Dries's avatar
   
Dries committed
46
    $stored_message[] = array($message, $type);
Dries's avatar
   
Dries committed
47
48
49
50
51
  }

  return $stored_message;
}

Dries's avatar
   
Dries committed
52
function drupal_get_messages() {
Dries's avatar
   
Dries committed
53
54
  return drupal_set_message();
}
Kjartan's avatar
Kjartan committed
55
/* @} */
Dries's avatar
   
Dries committed
56

Dries's avatar
   
Dries committed
57
/**
Kjartan's avatar
Kjartan committed
58
59
 * @name Page breadcrumbs
 * @ingroup common
Dries's avatar
   
Dries committed
60
61
62
63
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
Kjartan's avatar
Kjartan committed
64
65
66
67
68

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries's avatar
   
Dries committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

  if (isset($breadcrumb)) {
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

  if (!isset($breadcrumb)) {
    $breadcrumb = menu_get_active_breadcrumb();
    array_pop($breadcrumb);
  }

  return $breadcrumb;
}
Kjartan's avatar
Kjartan committed
88
/* @} */
Dries's avatar
   
Dries committed
89

Dries's avatar
Dries committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/**
 * @name HTML head contents
 * @ingroup common
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
  static $stored_head;

  if (!is_null($data)) {
    $stored_head .= "$data\n";
  }
  return $stored_head;
}

function drupal_get_html_head() {
  global $base_url;

Dries's avatar
   
Dries committed
110
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
111
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
   
Dries committed
112
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
113
114
115
116
117
118
119
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

  return $output . drupal_set_html_head();
}
/* @} */

Dries's avatar
   
Dries committed
120
/**
Dries's avatar
   
Dries committed
121
 * @name URL path alias
Kjartan's avatar
Kjartan committed
122
123
 * @ingroup common
 *
Dries's avatar
   
Dries committed
124
 * Functions to handle path aliases.
Dries's avatar
   
Dries committed
125
 */
Dries's avatar
   
Dries committed
126
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
127
  static $map = NULL;
Dries's avatar
   
Dries committed
128

Dries's avatar
   
Dries committed
129
130
131
132
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
133
  if (is_null($map)) {
Dries's avatar
   
Dries committed
134
    $map = array();  // make $map non-null in case no aliases are defined
Dries's avatar
   
Dries committed
135
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
   
Dries committed
136
    while ($data = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
137
      $map[$data->dst] = $data->src;
Dries's avatar
   
Dries committed
138
139
140
141
142
143
    }
  }

  return $map;
}

Dries's avatar
   
Dries committed
144
145
146
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
147
148

/**
Dries's avatar
   
Dries committed
149
 * Given an old url, return the alias.
Kjartan's avatar
Kjartan committed
150
 */
Dries's avatar
   
Dries committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'outgoing');
  }
}

/**
 * Given an alias, return the default url.
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
/* @} */
Kjartan's avatar
Kjartan committed
175

Dries's avatar
Dries committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/**
 * @name HTTP headers
 * @ingroup common
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
  static $stored_headers;

  if (!is_null($header)) {
    header($header);
    $stored_headers .= "$header\n";
  }
  return $stored_headers;
}

function drupal_get_headers() {
  return drupal_set_header();
}
/* @} */

Dries's avatar
   
Dries committed
198
199
200
201
202
203
204
205
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

Kjartan's avatar
Kjartan committed
206
207
208
209
210
211
/**
 * HTTP redirects. Makes sure the redirected url is formatted correctly and
 * includes the session ID.
 *
 * @note This function ends the request.
 *
Dries's avatar
Dries committed
212
213
214
 * @param $url A Drupal URL
 * @param $query Query string component
 * @param $fragment Fragment identifier
Kjartan's avatar
Kjartan committed
215
 */
Dries's avatar
Dries committed
216
function drupal_goto($url = NULL, $query = NULL, $fragment = NULL) {
Kjartan's avatar
Kjartan committed
217
218

  /*
Dries's avatar
Dries committed
219
  ** Translate &amp; to simply & in the absolute URL
Kjartan's avatar
Kjartan committed
220
  */
Dries's avatar
   
Dries committed
221

Dries's avatar
Dries committed
222
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

  /*
  ** 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".
  */
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
    header("Location: $url");
  }
  else {
    $sid = session_name() . "=" . session_id();

    if (strstr($url, "?") && !strstr($url, $sid)) {
      header("Location: $url&". $sid);
    }
    else {
      header("Location: $url?". $sid);
    }
  }

  /*
  ** The "Location" header sends a REDIRECT status code to the http
  ** daemon.  In some cases this can go wrong, so we make sure none
  ** of the code /below/ gets executed when we redirect.
  */

  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
255
256
function drupal_not_found() {
  header("HTTP/1.0 404 Not Found");
Dries's avatar
Dries committed
257
  watchdog("httpd", "404 error: '". check_query($_GET["q"]) ."' not found");
Dries's avatar
   
Dries committed
258
259
260
261
262
263
264
265
266
267
268
269
270
271

  $path = drupal_get_normal_path(variable_get('site_404', ''));

  if ($path) {
    menu_set_active_item($path);
  }

  if ($path && menu_active_handler_exists()) {
    menu_execute_active_handler();
  }
  else {
    print theme("page", '<h1>'. t('Page not found') .'</h1>');
  }
}
Dries's avatar
   
Dries committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315

/**
 * Flexible and powerful HTTP client implementation. Allows to GET, POST, PUT
 * or any other HTTP requests. Handles redirects.
 *
 * @param $url A string containing a fully qualified URI.
 * @param $headers An array containing a HTTP header => value pair.
 * @param $method A string defining the HTTP request to use.
 * @param $data A string containing data to include in the request.
 * @param $retry An integer representing how many times to retry the request
 *   in case of a redirect.
 * @return An object containing the HTTP request headers, response code,
 *   headers, data, and redirect status.
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
  // Parse the URL, and make sure we can handle the schema
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
      // Note: only works for PHP 4.3 compiled with openssl
      $fp = @fsockopen("ssl://$uri[host]", ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
      break;
    default:
      $result->error = "invalid schema $uri[scheme]";
      return $result;
  }

  // Make sure the socket opened properly
  if (!$fp) {
    $result->error = trim("$errno $errstr");
    return $result;
  }

  // Construct the path to act on
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
    $path .= "?$uri[query]";
  }

  // Create http request
  $defaults = array(
316
317
318
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
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
388
389
390
391
392
  );

  foreach ($headers as $header => $value) {
    $defaults[$header] = "$header: $value";
  }

  $request = "$method $path HTTP/1.0\r\n";
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
    $request .= "$data\r\n";
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
  while (!feof($fp) && $data = fgets($fp)) {
    $response[] = $data;
  }
  fclose($fp);

  // Parse response.
  list($protocol, $code, $text) = explode(' ', trim(array_shift($response)), 3);
  $result->headers = array();
  $result->data = '';

  // Parse headers.
  while ($line = trim(array_shift($response))) {
    if ($line == '') {
      break;
    }
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $result->data = implode('', $response);

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
  // the base code in their class:
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
      $location = $result->headers['Location'];

      if ($retry) {
        $result = drupal_http_request($result->headers['Location'], $headers, $method, $data, --$retry);
        $result->redirect_code = $result->code;
      }
      $result->redirect_url = $location;

      break;
    default:
      $result->error = $text;
  }

  $result->code = $code;
  return $result;
}
Kjartan's avatar
Kjartan committed
393
/* @} */
Dries's avatar
   
Dries committed
394

Dries's avatar
   
Dries committed
395
396
397
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
398
399

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
400
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
401
402
403
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
   
Dries committed
404
405
406
407
408
  }
}

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
Kjartan's avatar
Kjartan committed
409
410
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '%s' AND hostname = '%s' AND %d - timestamp < %d", $type, $_SERVER['REMOTE_ADDR'], time(), $rate))) {
      watchdog("warning", "throttle: '". $_SERVER['REMOTE_ADDR'] ."' exceeded submission rate - $throttle->type");
Dries's avatar
   
Dries committed
411
412
413
414
415
      die(message_throttle());
    }
  }
}

Dries's avatar
Dries committed
416
417
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
418
419
420
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
421
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
422
423
424
  }
}

Dries's avatar
   
Dries committed
425
426
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
427
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
428
429
430
431
432
433
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
Dries's avatar
   
Dries committed
434
435
}

Kjartan's avatar
Kjartan committed
436
437
438
439
440
441
442
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
443
444
445
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
446
447
448
449
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
450
    $object = $array;
Dries's avatar
   
Dries committed
451
452
453
454
455
  }

  return $object;
}

Dries's avatar
Dries committed
456
457
458
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
459
460
461
462
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
463
    $array = $object;
Dries's avatar
   
Dries committed
464
465
466
467
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
468
/* @} */
Dries's avatar
   
Dries committed
469

Kjartan's avatar
Kjartan committed
470
471
472
473
474
475
476
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
   
Dries committed
477
function message_access() {
Dries's avatar
   
Dries committed
478
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
479
480
481
482
483
484
485
486
487
}

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.");
}
Kjartan's avatar
Kjartan committed
488
/* @} */
Dries's avatar
   
Dries committed
489

Dries's avatar
   
Dries committed
490
491
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
492
493
494
495
496
497
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
498
499
}

Kjartan's avatar
Kjartan committed
500
501
502
503
504
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
505
506
507
508
 * When using t(), try to put entire sentences and strings in one t() call.
 * This makes it easier for translators. We are unafraid of HTML markup within
 * translation strings if necessary. The suggested syntax for a link embedded
 * within a translation string is for example:
Kjartan's avatar
Kjartan committed
509
510
511
512
513
 * @code
 *   $msg = t("You must login below or \<a href=\"%url\"\>create a new
 *             account\</a\> before viewing the next page.", array("%url"
 *             => url("user/register")));
 * @endcode
514
515
516
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
Kjartan's avatar
Kjartan committed
517
518
519
520
521
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
Dries's avatar
   
Dries committed
522
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
523
  global $languages;
524

525
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
526

Dries's avatar
   
Dries committed
527
528
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
529
530
  }
  else {
Dries's avatar
   
Dries committed
531
532
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
533
534
}

Dries's avatar
   
Dries committed
535
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
536
537
538
539
540
541
542
543
544

  /*
  ** 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's avatar
   
Dries committed
545
546
}

Kjartan's avatar
Kjartan committed
547
548
549
550
551
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
   
Dries committed
552
 * @{
Kjartan's avatar
Kjartan committed
553
554
 */

555
/**
Dries's avatar
   
Dries committed
556
557
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
558
 *
Kjartan's avatar
Kjartan committed
559
 * @param $mail A string containing an email address.
Dries's avatar
   
Dries committed
560
 * @return
561
 */
Dries's avatar
   
Dries committed
562
function valid_email_address($mail) {
563
564
565
566
567
  $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}';

Dries's avatar
Dries committed
568
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
569
570
}

Dries's avatar
   
Dries committed
571
572
573
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
574
 * @param $url an URL
Dries's avatar
   
Dries committed
575
576
 */
function valid_url($url) {
Dries's avatar
Dries committed
577
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
Dries's avatar
   
Dries committed
578
579
}

Kjartan's avatar
Kjartan committed
580
581
582
583
584
585
586
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
   
Dries committed
587
      if (!valid_input_data($key) || !valid_input_data($value)) {
Kjartan's avatar
Kjartan committed
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
        return 0;
      }
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

    // check strings:
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

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

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

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
      return 0;
    }
  }

  return 1;
}
/* @} */

/**
 * @defgroup search Search interface
 * @{
 */
Kjartan's avatar
Kjartan committed
622
623
624
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
   
Dries committed
625
 * @param $item a single search result as returned by <i>module</i>_search of
626
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
   
Dries committed
627
628
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
629
 */
Dries's avatar
   
Dries committed
630
function search_item($item, $type) {
Dries's avatar
   
Dries committed
631
632
633
634
635
636
637
638
639
640

  /*
  ** 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 {
641
    $output = " <strong><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></strong><br />";
Dries's avatar
   
Dries committed
642
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
   
Dries committed
643
644
    $output .= "<br /><br />";
  }
Dries's avatar
   
Dries committed
645
646
647
648

  return $output;
}

Kjartan's avatar
Kjartan committed
649
650
651
652
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
653
654
655
 * 'site.com/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 parts of this form.
Kjartan's avatar
Kjartan committed
656
 *
Dries's avatar
   
Dries committed
657
658
659
660
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys string containing keywords for the search.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
661
 */
Dries's avatar
   
Dries committed
662
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
663
664
  $edit = $_POST['edit'];

Dries's avatar
   
Dries committed
665
  if (!$action) {
Dries's avatar
   
Dries committed
666
    $action = url("search");
Dries's avatar
   
Dries committed
667
668
  }

Dries's avatar
Dries committed
669
  $output = " <br /><input type=\"text\" class=\"form-text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
Dries's avatar
   
Dries committed
670
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries's avatar
   
Dries committed
671

Dries's avatar
Dries committed
672
  if ($options) {
Dries's avatar
   
Dries committed
673
674
675
676
677
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
678
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
679
680
681
682
      }
    }
  }

Kjartan's avatar
Kjartan committed
683
684
  $form .= "<br />";

Dries's avatar
   
Dries committed
685
686
687
688
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
689
690
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
691
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
692
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
693

Dries's avatar
   
Dries committed
694
  if (isset($keys)) {
Dries's avatar
   
Dries committed
695
    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
696
697
698
699
700
701
702
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
Dries's avatar
   
Dries committed
703
704
705
706
707
708
709
710
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
711
712
713
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
714
715
716
717
718
719
 * @param $type If set, search only nodes of this type. Otherwise, search all
 *   types.
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys Query string. Defaults to global $keys.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
720
 */
Dries's avatar
   
Dries committed
721
722
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
723

Dries's avatar
   
Dries committed
724
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
725
}
Kjartan's avatar
Kjartan committed
726
/* @} */
Dries's avatar
   
Dries committed
727

Dries's avatar
   
Dries committed
728
function check_form($text) {
Dries's avatar
   
Dries committed
729
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
730
731
}

732
733
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
734
735
}

Dries's avatar
   
Dries committed
736
737
738
739
740
741
742
743
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries's avatar
   
Dries committed
744
745
746
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
747
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
748
749
750
751
  $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's avatar
   
Dries committed
752
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
753
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
754
  }
Dries's avatar
   
Dries committed
755
756
757
758
759
760
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
764
  $output = "<item>\n";
Dries's avatar
   
Dries committed
765
766
767
  $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's avatar
   
Dries committed
768
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
769
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
770
  }
Dries's avatar
   
Dries committed
771
772
773
774
775
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
776
777
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
   
Dries committed
778
779
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
   
Dries committed
780
 *
Dries's avatar
   
Dries committed
781
782
783
784
 * @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").
Kjartan's avatar
Kjartan committed
785
 * @param $plural The string for the plural case. Please make sure it's clear
Dries's avatar
   
Dries committed
786
787
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
   
Dries committed
788
 * @return Translated string
Dries's avatar
   
Dries committed
789
 */
Dries's avatar
   
Dries committed
790
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
791
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
792
793
}

Dries's avatar
   
Dries committed
794
795
796
797
798
799
/**
 * Generates a string representation for the given byte count.
 *
 * @param $size The size in bytes
 * @return Translated string representation of the size
 */
Dries's avatar
   
Dries committed
800
function format_size($size) {
Dries's avatar
   
Dries committed
801
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
802
803
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
804
    $suffix = t("KB");
Dries's avatar
   
Dries committed
805
806
807
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
808
    $suffix = t("MB");
Dries's avatar
   
Dries committed
809
  }
Dries's avatar
   
Dries committed
810
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
811
812
}

Dries's avatar
   
Dries committed
813
814
815
816
817
818
819
/**
 * Formats a time interval with the requested granularity.
 *
 * @param $timestamp The length of the interval in seconds
 * @param $granularity How much units to consider when generating the string
 * @return Translated string representation of the interval
 */
Dries's avatar
   
Dries committed
820
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
821
  $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);
Dries's avatar
   
Dries committed
822
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
823
824
825
826
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
Dries's avatar
   
Dries committed
827
828
829
830
831
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
832
833
    }
  }
Dries's avatar
   
Dries committed
834
  return ($output) ? $output : t("0 sec");
Dries's avatar
   
Dries committed
835
836
}

Dries's avatar
   
Dries committed
837
838
839
840
841
842
843
844
845
846
847
848
/**
 * Formats a date with the given configured format or a custom format string.
 * Drupal allows administrators to select formatting strings for 'small',
 * 'medium' and 'large' date formats. This function can handle these formats,
 * as well as any custom format.
 *
 * @param $timestamp The exact date to format
 * @param $type Could be 'small', 'medium' or 'large' for the preconfigured
 *              date formats. If 'custom' is specified, the next parameter
 *              should contain the format string
 * @param $format Format string (as required by the PHP date() function).
 *                Only required if 'custom' date format is requested.
849
850
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries's avatar
   
Dries committed
851
852
 * @return Translated date string in the requested format
 */
853
854
855
856
857
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
    $timezone = $user->uid ? $user->timezone : variable_get('date_default_timezone', 0);
  }
Dries's avatar
   
Dries committed
858

859
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
860
861

  switch ($type) {
862
863
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
864
      break;
865
866
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
867
      break;
868
    case 'custom':
Dries's avatar
   
Dries committed
869
      // No change to format
Dries's avatar
   
Dries committed
870
      break;
871
    case 'medium':
Dries's avatar
   
Dries committed
872
    default:
873
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
874
875
  }

876
877
878
879
880
881
882
883
884
885
  $max = strlen($format);
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
      $date .= gmdate($c, $timestamp);
    }
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c)) {
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
   
Dries committed
886
    }
887
888
889
890
891
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
   
Dries committed
892
893
    }
    else {
894
      $date .= $c;
Dries's avatar
   
Dries committed
895
    }
Dries's avatar
   
Dries committed
896
  }
897

Dries's avatar
   
Dries committed
898
899
900
  return $date;
}

Dries's avatar
   
Dries committed
901
902
903
904
905
906
907
908
/**
 * Formats a username.
 *
 * @param $object User object
 * @return String containing a HTML link to the user's page if the
 *         passed object suggests that this is a site user. Otherwise
 *         only the user name is returned.
 */
Dries's avatar
   
Dries committed
909
910
911
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
912
913
914
915
916
917
918
919
920
921
922
923
    /*
    ** 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's avatar
   
Dries committed
924
    if (arg(0) == "admin" and user_access("administer users")) {
Dries's avatar
Dries committed
925
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
926
927
    }
    else {
Dries's avatar
Dries committed
928
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
929
    }
Dries's avatar
   
Dries committed
930
  }
Dries's avatar
   
Dries committed
931
932
933
934
935
936
937
938
939
940
  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's avatar
   
Dries committed
941
  else {
Dries's avatar
   
Dries committed
942
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
943
944
  }

Dries's avatar
   
Dries committed
945
  return $output;
Dries's avatar
   
Dries committed
946
}
Dries's avatar
   
Dries committed
947
/* @} */
Dries's avatar
   
Dries committed
948

Kjartan's avatar
Kjartan committed
949
950
951
952
/**
 * @defgroup from Form generation
 * @{
 */
Dries's avatar
   
Dries committed
953
function form($form, $method = "post", $action = 0, $options = 0) {
Dries's avatar
   
Dries committed
954
  if (!$action) {
955
    $action = request_uri();
Dries's avatar
   
Dries committed
956
  }
957
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
958
959
}

Dries's avatar
   
Dries committed
960
961
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
   
Dries committed
962
}
Dries's avatar
   
Dries committed
963

Dries's avatar
   
Dries committed
964
function form_group($legend, $group, $description = NULL) {
Dries's avatar
   
Dries committed
965
966
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries's avatar
   
Dries committed
967

Dries's avatar
   
Dries committed
968
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
969
  return theme("form_element", NULL, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
   
Dries committed
970
971
972
973
974
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
Dries's avatar
   
Dries committed
975
      $choices .= "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice<br />";
Dries's avatar
   
Dries committed
976
    }
Dries's avatar
   
Dries committed
977
    return theme("form_element", $title, $choices, $description);
Dries's avatar
   
Dries committed
978
  }
Dries's avatar
   
Dries committed
979
980
}

Dries's avatar
   
Dries committed
981
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
982
  return form_hidden($name, 0) . theme("form_element", NULL, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries's avatar
   
Dries committed
983
984
}

Dries's avatar
   
Dries committed
985
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
986
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
987
  return theme("form_element", $title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
   
Dries committed
988
989
}

Dries's avatar
   
Dries committed
990
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
991
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
992
  return theme("form_element", $title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
   
Dries committed
993
994
}

Dries's avatar
   
Dries committed
995
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
996
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
997
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
   
Dries committed
998
  return theme("form_element", $title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"$name\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description, $name);
Dries's avatar
   
Dries committed
999
1000
}