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

Dries Buytaert's avatar
   
Dries Buytaert committed
4
/**
5
6
 * @defgroup common Core functions
 */
7
 
8
9
10
/**
 * @name Page title
 * @ingroup common
Dries Buytaert's avatar
   
Dries Buytaert committed
11
12
13
14
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
15
16
17
18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
19
    $stored_title = ucfirst($title);
Dries Buytaert's avatar
   
Dries Buytaert 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;
}
33
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
34

Dries Buytaert's avatar
   
Dries Buytaert committed
35
/**
36
37
 * @name Page messages
 * @ingroup common
Dries Buytaert's avatar
   
Dries Buytaert committed
38
39
40
41
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
42
function drupal_set_message($message = NULL, $type = "status") {
43
44
45
  if (!isset($_SESSION['messages'])) {
    $_SESSION['messages'] = array();
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
46
47

  if (isset($message)) {
48
    $_SESSION['messages'][] = array($message, $type);
Dries Buytaert's avatar
   
Dries Buytaert committed
49
50
  }

51
  return $_SESSION['messages'];
Dries Buytaert's avatar
   
Dries Buytaert committed
52
53
}

Dries Buytaert's avatar
   
Dries Buytaert committed
54
function drupal_get_messages() {
55
56
57
58
  $messages = drupal_set_message();
  $_SESSION['messages'] = array();

  return $messages;
Dries Buytaert's avatar
   
Dries Buytaert committed
59
}
Dries Buytaert's avatar
   
Dries Buytaert committed
60

61
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
62

Dries Buytaert's avatar
   
Dries Buytaert committed
63
/**
64
65
 * @name Page breadcrumbs
 * @ingroup common
Dries Buytaert's avatar
   
Dries Buytaert committed
66
67
68
69
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
70
71
72
73
74

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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();
  }

  return $breadcrumb;
}
93
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
94

Dries Buytaert's avatar
Dries Buytaert committed
95
96
97
98
99
100
101
102
103
/**
 * @name HTML head contents
 * @ingroup common
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
104
  static $stored_head = '';
Dries Buytaert's avatar
Dries Buytaert committed
105
106
107
108
109
110
111
112
113
114

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

function drupal_get_html_head() {
  global $base_url;

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
125
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
126
 * @name URL path alias
127
128
 * @ingroup common
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
129
 * Functions to handle path aliases.
Dries Buytaert's avatar
   
Dries Buytaert committed
130
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
131
function drupal_get_path_map($action = "") {
Dries Buytaert's avatar
Dries Buytaert committed
132
  static $map = NULL;
Dries Buytaert's avatar
   
Dries Buytaert committed
133

Dries Buytaert's avatar
   
Dries Buytaert committed
134
135
136
137
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
149
150
151
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
152
153

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
154
 * Given an old url, return the alias.
155
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
156
157
158
159
160
161
162
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');
  }
163
164
165
166
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
}

/**
 * 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;
  }
}
/* @} */
184

Dries Buytaert's avatar
Dries Buytaert committed
185
186
187
188
189
190
191
192
/**
 * @name HTTP headers
 * @ingroup common
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
193
  static $stored_headers = '';
Dries Buytaert's avatar
Dries Buytaert committed
194
195
196
197
198
199
200
201
202
203
204
205
206

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
207
208
209
210
211
212
213
214
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

215
216
217
218
219
220
/**
 * HTTP redirects. Makes sure the redirected url is formatted correctly and
 * includes the session ID.
 *
 * @note This function ends the request.
 *
Dries Buytaert's avatar
Dries Buytaert committed
221
222
223
 * @param $url A Drupal URL
 * @param $query Query string component
 * @param $fragment Fragment identifier
224
 */
Dries Buytaert's avatar
Dries Buytaert committed
225
function drupal_goto($url = NULL, $query = NULL, $fragment = NULL) {
226
227

  /*
Dries Buytaert's avatar
Dries Buytaert committed
228
  ** Translate &amp; to simply & in the absolute URL
229
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
230

Dries Buytaert's avatar
Dries Buytaert committed
231
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

  /*
  ** 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 Buytaert's avatar
   
Dries Buytaert committed
264
function drupal_not_found() {
Dries Buytaert's avatar
   
Dries Buytaert committed
265
266
  header('HTTP/1.0 404 Not Found');
  watchdog('httpd', '404 error: "'. check_query($_GET['q']) .'" not found');
Dries Buytaert's avatar
   
Dries Buytaert committed
267
268

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
269
  $status = MENU_FALLTHROUGH;
Dries Buytaert's avatar
   
Dries Buytaert committed
270
271
  if ($path) {
    menu_set_active_item($path);
Dries Buytaert's avatar
   
Dries Buytaert committed
272
    $status = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
273
274
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
275
  if ($status != MENU_FOUND) {
Dries Buytaert's avatar
Dries Buytaert committed
276
    print theme('page', '', t('Page not found'));
Dries Buytaert's avatar
   
Dries Buytaert committed
277
278
  }
}
Dries Buytaert's avatar
   
Dries Buytaert committed
279

Dries Buytaert's avatar
   
Dries Buytaert committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');

  $path = drupal_get_normal_path(variable_get('site_403', ''));
  $status = MENU_FALLTHROUGH;
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
    print theme('page', message_access(), t('Access denied'));
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/**
 * 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(
341
342
343
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
  );

  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.
361
  $response = '';
362
  while (!feof($fp) && $data = fread($fp, 1024)) {
363
    $response .= $data;
Dries Buytaert's avatar
   
Dries Buytaert committed
364
365
366
367
  }
  fclose($fp);

  // Parse response.
368
  $response = preg_split("/\r\n|\n|\r/", $response);
Dries Buytaert's avatar
   
Dries Buytaert committed
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
  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;
}
420
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
421

Dries Buytaert's avatar
   
Dries Buytaert committed
422
423
424
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
425
426

  if ($errno & E_ALL ^ E_NOTICE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
427
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries Buytaert's avatar
Dries Buytaert committed
428
429
430
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
431
432
433
  }
}

Dries Buytaert's avatar
Dries Buytaert committed
434
435
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
436
437
438
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
439
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
440
441
442
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
443
444
function fix_gpc_magic() {
  static $fixed = false;
Kjartan Mannes's avatar
Kjartan Mannes committed
445
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries Buytaert's avatar
Dries Buytaert committed
446
447
448
449
450
451
    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 Buytaert's avatar
   
Dries Buytaert committed
452
453
}

454
455
456
457
458
459
460
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries Buytaert's avatar
Dries Buytaert committed
461
462
463
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
464
465
466
467
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
468
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
469
470
471
472
473
  }

  return $object;
}

Dries Buytaert's avatar
Dries Buytaert committed
474
475
476
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
477
478
479
480
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
481
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
482
483
484
485
  }

  return $array;
}
486
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
487

488
489
490
491
492
493
494
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
495
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
496
  return t("You are not authorized to access this page.");
Dries Buytaert's avatar
   
Dries Buytaert committed
497
498
499
500
501
502
}

function message_na() {
  return t("n/a");
}

503
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
504

Dries Buytaert's avatar
   
Dries Buytaert committed
505
506
function locale_init() {
  global $languages, $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
507
508
509
510
511
512
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
513
514
}

515
516
517
518
519
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
520
521
522
523
 * 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:
524
525
526
527
528
 * @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
529
530
531
 * 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.
532
533
534
535
536
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
537
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
538
  global $languages;
539

540
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
541

Dries Buytaert's avatar
   
Dries Buytaert committed
542
543
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
544
545
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
546
547
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
548
549
}

Dries Buytaert's avatar
   
Dries Buytaert committed
550
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries Buytaert's avatar
   
Dries Buytaert committed
551
552
553
554
555
556
557
558
559

  /*
  ** 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
560
561
}

562
563
564
565
566
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries Buytaert's avatar
   
Dries Buytaert committed
567
 * @{
568
569
 */

570
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
571
572
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
573
 *
574
 * @param $mail A string containing an email address.
Dries Buytaert's avatar
   
Dries Buytaert committed
575
 * @return
576
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
577
function valid_email_address($mail) {
578
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
579
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
580
581
582
  $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 Buytaert's avatar
Dries Buytaert committed
583
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
584
585
}

Dries Buytaert's avatar
   
Dries Buytaert committed
586
587
588
/**
 * Verify the syntax of the given URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
589
590
591
592
593
594
 * @param $url
 *   an URL
 * @param $absolute
 *   is the URL to be verified absolute, ie. of the form \<scheme\>://\<hostname\>/...?
 * @return
 *   valid syntax: TRUE; FALSE otherwise
Dries Buytaert's avatar
   
Dries Buytaert committed
595
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
596
function valid_url($url, $absolute = FALSE) {
597
  if ($absolute) {
598
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&]+$/i", $url);
599
600
  }
  else {
601
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
602
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
603
604
}

605
606
607
608
609
610
611
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 Buytaert's avatar
   
Dries Buytaert committed
612
      if (!valid_input_data($key) || !valid_input_data($value)) {
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
        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 Mannes's avatar
Kjartan Mannes committed
647
648
649
/**
 * Format a single result entry of a search query:
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
650
 * @param $item a single search result as returned by <i>module</i>_search of
651
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries Buytaert's avatar
   
Dries Buytaert committed
652
653
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan Mannes's avatar
Kjartan Mannes committed
654
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
655
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
656
657
658
659
660
661
662
663
664
665

  /*
  ** 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 {
666
667
    $output = " <dt class=\"title\"><a href=\"". $item["link"] ."\">". $item["title"] ."</a></dt>";
    $output .= " <dd class=\"small\">" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</dd>";
Dries Buytaert's avatar
   
Dries Buytaert committed
668
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
669
670
671
672

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
673
674
675
676
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries Buytaert's avatar
   
Dries Buytaert committed
677
678
679
 * '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 Mannes's avatar
Kjartan Mannes committed
680
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
681
682
683
684
 * @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 Mannes's avatar
Kjartan Mannes committed
685
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
686
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
687
688
  $edit = $_POST['edit'];

Dries Buytaert's avatar
   
Dries Buytaert committed
689
  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
690
    $action = url("search");
Dries Buytaert's avatar
   
Dries Buytaert committed
691
692
  }

693
  $output = " <div class=\"search-form\"><br /><input type=\"text\" class=\"form-text\" size=\"50\" value=\"". check_form($keys) ."\" name=\"keys\" />";
Dries Buytaert's avatar
   
Dries Buytaert committed
694
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
695

Dries Buytaert's avatar
Dries Buytaert committed
696
  if ($options) {
Dries Buytaert's avatar
   
Dries Buytaert committed
697
698
699
700
701
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan Mannes's avatar
Kjartan Mannes committed
702
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries Buytaert's avatar
   
Dries Buytaert committed
703
704
      }
    }
705
    $output .= "</div>";
Dries Buytaert's avatar
   
Dries Buytaert committed
706
707
708
709
710
711
  }

  return form($output, "post", $action);
}

/*
Kjartan Mannes's avatar
Kjartan Mannes committed
712
713
 * Collect the search results:
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
714
function search_data($keys = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
715
  $edit = $_POST["edit"];
Dries Buytaert's avatar
   
Dries Buytaert committed
716
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
717

Dries Buytaert's avatar
   
Dries Buytaert committed
718
  if (isset($keys)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
719
    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
720
721
722
723
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
724
          $output .= "<dl class=\"search-results\">";
Dries Buytaert's avatar
   
Dries Buytaert committed
725
726
727
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
728
          $output .= "</dl>";
Dries Buytaert's avatar
   
Dries Buytaert committed
729
730
731
732
733
734
735
736
        }
      }
    }
  }

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
737
738
739
/**
 * Display the search form and the resulting data.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
740
741
742
743
744
745
 * @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 Mannes's avatar
Kjartan Mannes committed
746
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
747
748
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries Buytaert's avatar
   
Dries Buytaert committed
749

Dries Buytaert's avatar
   
Dries Buytaert committed
750
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries Buytaert's avatar
   
Dries Buytaert committed
751
}
752
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
753

Dries Buytaert's avatar
   
Dries Buytaert committed
754
function check_form($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
755
  return drupal_specialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
756
757
}

758
759
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
760
761
}

Dries Buytaert's avatar
   
Dries Buytaert committed
762
763
764
765
766
767
768
769
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
770
771
772
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
773
  $output = "<channel>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
774
775
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
776
  $output .= " <description>". drupal_specialchars(strip_tags($description)) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
777
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
778
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
779
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
780
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
781
782
783
784
785
786
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
787
788
789
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
790
  $output = "<item>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
791
792
793
  $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
794
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
795
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
796
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
797
798
799
800
801
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
802
803
/**
 * Formats a string with a count of items so that the string is pluralized
Dries Buytaert's avatar
   
Dries Buytaert committed
804
805
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries Buytaert's avatar
   
Dries Buytaert committed
806
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
807
808
809
810
 * @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").
811
 * @param $plural The string for the plural case. Please make sure it's clear
Dries Buytaert's avatar
   
Dries Buytaert committed
812
813
 *   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
814
 * @return Translated string
Dries Buytaert's avatar
   
Dries Buytaert committed
815
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
816
function format_plural($count, $singular, $plural) {
Dries Buytaert's avatar
   
Dries Buytaert committed
817
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
818
819
}

Dries Buytaert's avatar
   
Dries Buytaert committed
820
821
822
823
824
825
/**
 * Generates a string representation for the given byte count.
 *
 * @param $size The size in bytes
 * @return Translated string representation of the size
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
826
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
827
  $suffix = t("bytes");
Dries Buytaert's avatar
   
Dries Buytaert committed
828
829
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
830
    $suffix = t("KB");
Dries Buytaert's avatar
   
Dries Buytaert committed
831
832
833
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
834
    $suffix = t("MB");
Dries Buytaert's avatar
   
Dries Buytaert committed
835
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
836
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
837
838
}

Dries Buytaert's avatar
   
Dries Buytaert committed
839
840
841
842
843
844
845
/**
 * 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 Buytaert's avatar
   
Dries Buytaert committed
846
function format_interval($timestamp, $granularity = 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
847
  $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 Buytaert's avatar
   
Dries Buytaert committed
848
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
849
  foreach ($units as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
850
851
852
853
    $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
854
855
856
857
858
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
859
860
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
861
  return $output ? $output : t("0 sec");
Dries Buytaert's avatar
   
Dries Buytaert committed
862
863
}

Dries Buytaert's avatar
   
Dries Buytaert committed
864
865
866
867
868
869
870
871
872
873
874
875
/**
 * 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.
876
877
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries Buytaert's avatar
   
Dries Buytaert committed
878
879
 * @return Translated date string in the requested format
 */
880
881
882
883
884
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 Buytaert's avatar
   
Dries Buytaert committed
885

886
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
887
888

  switch ($type) {
889
890
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
891
      break;
892
893
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
894
      break;
895
    case 'custom':
Dries Buytaert's avatar
   
Dries Buytaert committed
896
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
897
      break;
898
    case 'medium':
Dries Buytaert's avatar
   
Dries Buytaert committed
899
    default:
900
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
901
902
  }

903
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
904
  $date = '';
905
906
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
907
      $date .= t(gmdate($c, $timestamp));
908
909
910
911
912
913
    }
    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 Buytaert's avatar
   
Dries Buytaert committed
914
    }
915
916
917
918
919
    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 Buytaert's avatar
   
Dries Buytaert committed
920
921
    }
    else {
922
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed
923
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
924
  }
925

Dries Buytaert's avatar
   
Dries Buytaert committed
926
927
928
  return $date;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
929
930
931
932
933
934
935
936
/**
 * 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 Buytaert's avatar
   
Dries Buytaert committed
937
938
939
function format_name($object) {

  if ($object->uid && $object->name) {
940
941
942
943
944
945
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
946
      $name = truncate_utf8($object->name, 15) ."...";
947
948
949
950
951
    }
    else {
      $name = $object->name;
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
952
    if (arg(0) == "admin" and user_access("administer users")) {
953
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
954
955
    }
    else {
956
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries Buytaert's avatar
   
Dries Buytaert committed
957
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
958
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
959
960
961
962
963
964
965
966
  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.
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
967
968
969
970
971
972
973
974
    if ($object->homepage) {
      $output = "<a href=\"$object->homepage\">$object->name</a>";
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries Buytaert's avatar
   
Dries Buytaert committed
975
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
976
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
977
    $output = t(variable_get("anonymous", "Anonymous"));
Dries Buytaert's avatar
   
Dries Buytaert committed
978
979
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
980
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
981
}
Dries Buytaert's avatar
   
Dries Buytaert committed
982
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
983

984
985
986
987
/**
 * @defgroup from Form generation
 * @{
 */
988
function form($form, $method = "post", $action = NULL, $attributes = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
989
  if (!$action) {
990
    $action = request_uri();
Dries Buytaert's avatar
   
Dries Buytaert committed
991
  }
992
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($attributes) .">\n$form\n</form>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
993
994
}

Dries Buytaert's avatar
   
Dries Buytaert committed
995
996
997
998
999
1000
/**
 * File an error against the form with the specified name.
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
For faster browsing, not all history is shown. View entire blame