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

Dries's avatar
   
Dries committed
4
5
6
7
8
9
10
11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

27
28
29
30
31
32
33
34
35
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
36
function drupal_set_content($region = NULL, $data = NULL) {
37
38
39
40
41
42
43
44
45
46
47
48
  static $content = array();

  if (!is_null($region) && !is_null($data)) {
    $content[$region][] = $data;
  }
  return $content;
}

/**
 * Get assigned content.
 *
 * @param $region
49
 *   A specified region to fetch content for. If NULL, all regions will be returned.
50
51
52
53
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
54
function drupal_get_content($region = NULL, $delimiter = ' ') {
55
  $content = drupal_set_content();
56
57
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
58
      return implode($delimiter, $content[$region]);
59
    }
60
61
62
63
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
64
        $content[$region] = implode($delimiter, $content[$region]);
65
66
67
68
69
70
      }
    }
    return $content;
  }
}

Dries's avatar
   
Dries committed
71
/**
Dries's avatar
   
Dries committed
72
 * Set the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
73
 *
Dries's avatar
   
Dries committed
74
75
76
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
77
 */
Dries's avatar
   
Dries committed
78
79
80
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

81
  if (!is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
82
83
84
85
86
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
87
88
89
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
   
Dries committed
90
91
92
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

93
  if (is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
94
95
96
97
98
99
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
100
/**
Dries's avatar
   
Dries committed
101
 * Add output to the head tag of the HTML page.
Dries's avatar
   
Dries committed
102
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
103
104
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
   
Dries committed
105
  static $stored_head = '';
Dries's avatar
Dries committed
106
107

  if (!is_null($data)) {
Dries's avatar
   
Dries committed
108
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
109
110
111
112
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
113
114
115
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
116
function drupal_get_html_head() {
Dries's avatar
   
Dries committed
117
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
118
119
120
  return $output . drupal_set_html_head();
}

Dries's avatar
   
Dries committed
121
/**
122
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
   
Dries committed
123
 */
124
125
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
   
Dries committed
126
}
Kjartan's avatar
Kjartan committed
127

Dries's avatar
Dries committed
128
/**
Dries's avatar
   
Dries committed
129
 * Set an HTTP response header for the current page.
130
131
132
 *
 * Note: when sending a Content-Type header, always include a 'charset' type
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
Dries's avatar
Dries committed
133
134
 */
function drupal_set_header($header = NULL) {
135
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
   
Dries committed
136
  // Otherwise, header('') could get called when serving the page later, which
137
138
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
139

140
  if (strlen($header)) {
Dries's avatar
Dries committed
141
    header($header);
142
    $stored_headers[] = $header;
Dries's avatar
Dries committed
143
  }
144
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
145
146
}

Dries's avatar
   
Dries committed
147
148
149
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
150
151
152
153
function drupal_get_headers() {
  return drupal_set_header();
}

154
/**
155
156
157
158
 * Add a feed URL for the current page.
 *
 * @param $url
 *   The url for the feed
159
160
 * @param $title
 *   The title of the feed
161
 */
162
function drupal_add_feed($url = NULL, $title = '') {
163
164
165
  static $stored_feed_links = array();

  if (!is_null($url)) {
166
167
168
169
170
171
    $stored_feed_links[$url] = theme('feed_icon', $url);

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
 *   The delimiter to split feeds by
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
187
188
189
/**
 * @name HTTP handling
 * @{
Dries's avatar
   
Dries committed
190
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
191
192
 */

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/**
 * Parse an array into a valid urlencoded query string.
 *
 * @param $query
 *   The array to be processed e.g. $_GET
 * @param $exclude
 *   The array filled with keys to be excluded. Use parent[child] to exclude nested items.
 * @param $urlencode
 *   If TRUE, the keys and values are both urlencoded.
 * @param $parent
 *   Should not be passed, only used in recursive calls
 * @return
 *   urlencoded string which can be appended to/as the URL query string
 */
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
211
    $key = drupal_urlencode($key);
212
    if ($parent) {
213
      $key = $parent .'['. $key .']';
214
215
    }

216
    if (in_array($key, $exclude)) {
217
218
219
220
221
222
223
      continue;
    }

    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
224
      $params[] = $key .'='. drupal_urlencode($value);
225
226
227
228
229
230
    }
  }

  return implode('&', $params);
}

231
232
/**
 * Prepare a destination query string for use in combination with
233
234
235
 * drupal_goto(). Used to direct the user back to the referring page
 * after completing a form. By default the current URL is returned.
 * If a destination exists in the previous request, that destination
236
 * is returned. As such, a destination can persist across multiple
237
 * pages.
238
239
240
241
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
242
  if (isset($_REQUEST['destination'])) {
243
244
245
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
246
247
    // Use $_GET here to retrieve the original path in source form.
    $path = isset($_GET['q']) ? $_GET['q'] : '';
248
249
250
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
      $path .= '?'. $query;
251
    }
252
    return 'destination='. urlencode($path);
253
254
255
  }
}

Kjartan's avatar
Kjartan committed
256
/**
Dries's avatar
   
Dries committed
257
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
258
 *
Dries's avatar
   
Dries committed
259
260
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
261
 *
262
 * Usually the redirected URL is constructed from this function's input
263
 * parameters. However you may override that behavior by setting a
264
265
 * <em>destination</em> in either the $_REQUEST-array (i.e. by using
 * the query string of an URI) or the $_REQUEST['edit']-array (i.e. by
266
267
 * using a hidden form field). This is used to direct the user back to
 * the proper page after completing a form. For example, after editing
268
 * a post on the 'admin/content/node'-page or after having logged on using the
269
 * 'user login'-block in a sidebar. The function drupal_get_destination()
270
271
 * can be used to help set the destination URL.
 *
Dries's avatar
   
Dries committed
272
273
274
275
276
277
278
279
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
280
 *   A Drupal path or a full URL.
Dries's avatar
   
Dries committed
281
282
283
284
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
285
286
287
288
289
290
291
292
293
294
295
 * @param $http_response_code
 *   Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
 *   - 301 Moved Permanently (the recommended value for most redirects)
 *   - 302 Found (default in Drupal and PHP, sometimes used for spamming search
 *         engines)
 *   - 303 See Other
 *   - 304 Not Modified
 *   - 305 Use Proxy
 *   - 307 Temporary Redirect (an alternative to "503 Site Down for Maintenance")
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
 *         supported.
296
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
297
 */
298
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
299
  if (isset($_REQUEST['destination'])) {
300
    extract(parse_url(urldecode($_REQUEST['destination'])));
301
  }
302
  else if (isset($_REQUEST['edit']['destination'])) {
303
    extract(parse_url(urldecode($_REQUEST['edit']['destination'])));
304
305
  }

306
  $url = url($path, array('query' => $query, 'fragment' => $fragment, 'absolute' => TRUE));
Kjartan's avatar
Kjartan committed
307

Dries's avatar
   
Dries committed
308
309
310
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

311
  header('Location: '. $url, TRUE, $http_response_code);
Kjartan's avatar
Kjartan committed
312

Dries's avatar
   
Dries committed
313
314
315
  // 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 the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
316
317
318
  exit();
}

319
/**
320
 * Generates a site off-line message
321
322
 */
function drupal_site_offline() {
323
  drupal_set_header('HTTP/1.1 503 Service unavailable');
324
  drupal_set_title(t('Site off-line'));
325
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
326
    t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal'))))));
327
328
}

Kjartan's avatar
Kjartan committed
329
330
331
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
332
function drupal_not_found() {
333
  drupal_set_header('HTTP/1.1 404 Not Found');
334

drumm's avatar
drumm committed
335
  watchdog('page not found', check_plain($_GET['q']), WATCHDOG_WARNING);
336

337
338
339
340
341
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
   
Dries committed
342
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
343
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
344
    menu_set_active_item($path);
345
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
346
  }
347
  else {
348
    // Redirect to a non-existent menu item to make possible tabs disappear.
349
    menu_set_active_item('');
350
  }
Dries's avatar
   
Dries committed
351

drumm's avatar
drumm committed
352
353
  if (empty($return)) {
    drupal_set_title(t('Page not found'));
354
    $return = '';
Dries's avatar
   
Dries committed
355
  }
356
357
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
Dries's avatar
   
Dries committed
358
}
Dries's avatar
   
Dries committed
359

Dries's avatar
   
Dries committed
360
361
362
363
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
364
  drupal_set_header('HTTP/1.1 403 Forbidden');
365
  watchdog('access denied', check_plain($_GET['q']), WATCHDOG_WARNING);
Dries's avatar
   
Dries committed
366

drumm's avatar
drumm committed
367
// Keep old path for reference
368
369
370
371
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
   
Dries committed
372
  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
373
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
374
    menu_set_active_item($path);
375
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
376
  }
377
  else {
378
    // Redirect to a non-existent menu item to make possible tabs disappear.
379
    menu_set_active_item('');
380
  }
Dries's avatar
   
Dries committed
381

drumm's avatar
drumm committed
382
383
384
  if (empty($return)) {
    drupal_set_title(t('Access denied'));
    $return = t('You are not authorized to access this page.');
Dries's avatar
   
Dries committed
385
  }
386
  print theme('page', $return);
Dries's avatar
   
Dries committed
387
388
}

Dries's avatar
   
Dries committed
389
/**
Dries's avatar
   
Dries committed
390
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
391
 *
Dries's avatar
   
Dries committed
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 * This is a flexible and powerful HTTP client implementation. Correctly handles
 * GET, POST, PUT or any other HTTP requests. Handles redirects.
 *
 * @param $url
 *   A string containing a fully qualified URI.
 * @param $headers
 *   An array containing an 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.
Dries's avatar
   
Dries committed
409
410
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
411
  $result = new stdClass();
Dries's avatar
   
Dries committed
412

Dries's avatar
   
Dries committed
413
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
414
415
416
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
417
      $port = isset($uri['port']) ? $uri['port'] : 80;
418
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
419
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
   
Dries committed
420
421
      break;
    case 'https':
Dries's avatar
   
Dries committed
422
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
423
      $port = isset($uri['port']) ? $uri['port'] : 443;
424
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
425
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
   
Dries committed
426
427
      break;
    default:
Dries's avatar
   
Dries committed
428
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
429
430
431
      return $result;
  }

Dries's avatar
   
Dries committed
432
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
433
  if (!$fp) {
Dries's avatar
   
Dries committed
434
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
435
436
437
    return $result;
  }

Dries's avatar
   
Dries committed
438
  // Construct the path to act on.
Dries's avatar
Dries committed
439
440
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
   
Dries committed
441
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
442
443
  }

Dries's avatar
   
Dries committed
444
  // Create HTTP request.
Dries's avatar
   
Dries committed
445
  $defaults = array(
446
447
448
449
    // RFC 2616: "non-standard ports MUST, default ports MAY be included".
    // We don't add the port to prevent from breaking rewrite rules checking
    // the host that do not take into account the port number.
    'Host' => "Host: $host",
450
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
451
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
452
453
454
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
455
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
456
457
  }

458
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
459
460
461
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
462
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
463
464
465
466
467
468
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
469
  $response = '';
470
471
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
   
Dries committed
472
473
474
475
  }
  fclose($fp);

  // Parse response.
476
477
  list($split, $result->data) = explode("\r\n\r\n", $response, 2);
  $split = preg_split("/\r\n|\n|\r/", $split);
478

479
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
   
Dries committed
480
481
482
  $result->headers = array();

  // Parse headers.
483
  while ($line = trim(array_shift($split))) {
Dries's avatar
   
Dries committed
484
    list($header, $value) = explode(':', $line, 2);
485
486
487
488
489
490
491
492
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries's avatar
   
Dries committed
493
494
495
496
497
498
499
500
501
502
  }

  $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
Dries's avatar
   
Dries committed
503
  // the base code in their class.
Dries's avatar
   
Dries committed
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
  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;
}
Dries's avatar
   
Dries committed
531
532
533
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
534

Dries's avatar
   
Dries committed
535
/**
Dries's avatar
   
Dries committed
536
537
 * Log errors as defined by administrator
 * Error levels:
538
539
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
   
Dries committed
540
 */
541
function drupal_error_handler($errno, $message, $filename, $line) {
542
543
544
545
546
  // If the @ error suppression operator was used, error_reporting is temporarily set to 0
  if (error_reporting() == 0) {
    return;
  }

Dries's avatar
Dries committed
547
  if ($errno & (E_ALL)) {
Dries's avatar
   
Dries committed
548
549
    $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', 2048 => 'strict warning');
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
   
Dries committed
550

551
    // Force display of error messages in update.php
552
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
553
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
554
    }
555
556

    watchdog('php', t('%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)), WATCHDOG_ERROR);
Dries's avatar
   
Dries committed
557
558
559
  }
}

Dries's avatar
   
Dries committed
560
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
561
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
562
563
564
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
565
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
566
567
568
  }
}

569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
/**
 * Helper function to strip slashes from $_FILES skipping over the tmp_name keys
 * since PHP generates single backslashes for file paths on Windows systems.
 *
 * tmp_name does not have backslashes added see
 * http://php.net/manual/en/features.file-upload.php#42280
 */
function _fix_gpc_magic_files(&$item, $key) {
  if ($key != 'tmp_name') {
    if (is_array($item)) {
      array_walk($item, '_fix_gpc_magic_files');
    }
    else {
      $item = stripslashes($item);
    }
  }
}

Dries's avatar
   
Dries committed
587
588
589
590
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
591
function fix_gpc_magic() {
592
  static $fixed = FALSE;
Dries's avatar
   
Dries committed
593
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
594
595
596
597
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
598
    array_walk($_FILES, '_fix_gpc_magic_files');
599
    $fixed = TRUE;
Dries's avatar
Dries committed
600
  }
Dries's avatar
   
Dries committed
601
602
}

Kjartan's avatar
Kjartan committed
603
/**
Dries's avatar
   
Dries committed
604
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
605
 *
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 * All human-readable text that will be displayed somewhere within a page should be
 * run through the t() function.
 *
 * Examples:
 * @code
 *   if (!$info || !$info['extension']) {
 *     form_set_error('picture_upload', t('The uploaded file was not an image.'));
 *   }
 *
 *   $form['submit'] = array(
 *     '#type' => 'submit',
 *     '#value' => t('Log in'),
 *   );
 * @endcode
 *
 * Any text within t() can be extracted by translators and changed into
 * the equivalent text in their native language.
 *
 * Special variables called "placeholders" are used to signal dynamic
 * information in a string which should not be translated. Placeholders
drumm's avatar
drumm committed
626
 * can also be used for text that may change from time to time
627
628
629
630
631
632
633
634
635
636
637
638
639
 * (such as link paths) to be changed without requiring updates to translations.
 *
 * For example:
 * @code
 *   $output = t('There are currently %members and %visitors online.', array(
 *     '%members' => format_plural($total_users, '1 user', '@count users'),
 *     '%visitors' => format_plural($guests->count, '1 guest', '@count guests')));
 * @endcode
 *
 * There are three styles of placeholders:
 * - !variable, which indicates that the text should be inserted as-is. This is
 *   useful for inserting variables into things like e-mail.
 *   @code
640
 *     $message[] = t("If you don't want to receive such e-mails, you can change your settings at !url.", array('!url' => url("user/$account->uid", array('absolute' => TRUE))));
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 *   @endcode
 *
 * - @variable, which indicates that the text should be run through check_plain,
 *   to strip out HTML characters. Use this for any output that's displayed within
 *   a Drupal page.
 *   @code
 *     drupal_set_title($title = t("@name's blog", array('@name' => $account->name)));
 *   @endcode
 *
 * - %variable, which indicates that the string should be highlighted with
 *   theme_placeholder() which shows up by default as <em>emphasized</em>.
 *   @code
 *     watchdog('mail', t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name)));
 *   @endcode
 *
656
 * When using t(), try to put entire sentences and strings in one t() call.
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 * This makes it easier for translators, as it provides context as to what
 * each word refers to. HTML markup within translation strings is allowed,
 * but should be avoided if possible. The exception is embedded links; link
 * titles add additional context for translators so should be kept in the main
 * string.
 *
 * Here is an example of an incorrect use if t():
 * @code
 *   $output .= t('<p>Go to the @contact-page.</p>', array('@contact-page' => l(t('contact page'), 'contact')));
 * @endcode
 *
 * Here is an example of t() used correctly:
 * @code
 *   $output .= '<p>'. t('Go to the <a href="@contact-page">contact page</a>.', array('@contact-page' => url('contact'))) .'</p>';
 * @endcode
 *
 * Also avoid escaping quotation marks wherever possible.
 *
 * Incorrect:
 * @code
 *   $output .= t('Don\'t click me.');
 * @endcode
 *
 * Correct:
Dries's avatar
   
Dries committed
681
 * @code
682
 *   $output .= t("Don't click me.");
Dries's avatar
   
Dries committed
683
 * @endcode
Kjartan's avatar
Kjartan committed
684
 *
Dries's avatar
   
Dries committed
685
 * @param $string
Dries's avatar
   
Dries committed
686
 *   A string containing the English string to translate.
Dries's avatar
   
Dries committed
687
688
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
   
Dries committed
689
 *   of any key in this array are replaced with the corresponding value.
690
691
692
693
694
 *   Based on the first character of the key, the value is escaped and/or themed:
 *    - !variable: inserted as is
 *    - @variable: escape plain text to HTML (check_plain)
 *    - %variable: escape text and theme as a placeholder for user-submitted
 *      content (check_plain + theme_placeholder)
Dries's avatar
   
Dries committed
695
696
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
697
 */
Dries's avatar
   
Dries committed
698
function t($string, $args = 0) {
699
700
  global $language;
  if (function_exists('locale') && $language->language != 'en') {
Dries's avatar
   
Dries committed
701
702
    $string = locale($string);
  }
Dries's avatar
   
Dries committed
703
704
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
705
706
  }
  else {
707
    // Transform arguments before inserting them
708
    foreach ($args as $key => $value) {
709
710
711
712
713
714
715
716
717
718
719
720
721
722
      switch ($key[0]) {
        // Escaped only
        case '@':
          $args[$key] = check_plain($value);
        break;
        // Escaped and placeholder
        case '%':
        default:
          $args[$key] = theme('placeholder', $value);
          break;
        // Pass-through
        case '!':
      }
    }
Dries's avatar
   
Dries committed
723
724
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
725
726
}

Kjartan's avatar
Kjartan committed
727
/**
Dries's avatar
   
Dries committed
728
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
729
 * @{
Dries's avatar
   
Dries committed
730
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
731
732
 */

733
/**
Dries's avatar
   
Dries committed
734
735
736
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
737
 *
Dries's avatar
   
Dries committed
738
 * @param $mail
739
 *   A string containing an e-mail address.
Dries's avatar
   
Dries committed
740
 * @return
Dries's avatar
   
Dries committed
741
 *   TRUE if the address is in a valid format.
742
 */
Dries's avatar
   
Dries committed
743
function valid_email_address($mail) {
744
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
745
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
746
747
748
  $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
749
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
750
751
}

Dries's avatar
   
Dries committed
752
753
754
/**
 * Verify the syntax of the given URL.
 *
755
756
757
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
 *
Dries's avatar
   
Dries committed
758
 * @param $url
Dries's avatar
   
Dries committed
759
 *   The URL to verify.
Dries's avatar
   
Dries committed
760
 * @param $absolute
Dries's avatar
   
Dries committed
761
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
762
 * @return
Dries's avatar
   
Dries committed
763
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
764
 */
Dries's avatar
   
Dries committed
765
function valid_url($url, $absolute = FALSE) {
766
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,;~=#&%\+]';
767
  if ($absolute) {
768
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
769
770
  }
  else {
771
    return preg_match("/^". $allowed_characters ."+$/i", $url);
772
  }
Dries's avatar
   
Dries committed
773
774
}

Dries's avatar
   
Dries committed
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
 *   The name of the event.
 */
function flood_register_event($name) {
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, $_SERVER['REMOTE_ADDR'], time());
}

/**
 * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
 * The user is allowed to proceed if he did not trigger the specified event more than
 * $threshold times per hour.
 *
 * @param $name
 *   The name of the event.
 * @param $number
 *   The maximum number of the specified event per hour (per visitor).
 * @return
795
 *   True if the user did not exceed the hourly threshold. False otherwise.
Dries's avatar
   
Dries committed
796
797
798
799
800
801
 */
function flood_is_allowed($name, $threshold) {
  $number = db_num_rows(db_query("SELECT event FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, $_SERVER['REMOTE_ADDR'], time() - 3600));
  return ($number < $threshold ? TRUE : FALSE);
}

802
803
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
804
805
}

Dries's avatar
Dries committed
806
807
808
809
810
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
811
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
812
813
}

Dries's avatar
   
Dries committed
814
/**
Dries's avatar
   
Dries committed
815
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
816
 * @{
Dries's avatar
   
Dries committed
817
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
818
819
 */

Dries's avatar
   
Dries committed
820
821
822
823
824
825
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
function format_rss_channel($title, $link, $description, $items, $language = 'en', $args = array()) {
Dries's avatar
   
Dries committed
826
827
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
828
  $output = "<channel>\n";
829
830
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
831
832
833
834
835

  // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  // We strip all HTML tags, but need to prevent double encoding from properly
  // escaped source data (such as &amp becoming &amp;amp;).
  $output .= ' <description>'. check_plain(decode_entities(strip_tags($description))) ."</description>\n";
836
  $output .= ' <language>'. check_plain($language) ."</language>\n";
837
  $output .= format_xml_elements($args);
Dries's avatar
   
Dries committed
838
839
840
841
842
843
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
844
845
846
847
848
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
849
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
850
  $output = "<item>\n";
851
852
853
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
 * Format XML elements.
 *
 * @param $array
 *   An array where each item represent an element and is either a:
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
 *     - 'key': element name
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
875
  $output = '';
876
877
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
   
Dries committed
878
879
      if ($value['key']) {
        $output .= ' <'. $value['key'];
880
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
   
Dries committed
881
882
883
          $output .= drupal_attributes($value['attributes']);
        }

884
        if ($value['value'] != '') {
885
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries's avatar
   
Dries committed
886
887
888
889
890
891
892
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
893
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
894
    }
Dries's avatar
   
Dries committed
895
  }
Dries's avatar
   
Dries committed
896
897
898
  return $output;
}

Dries's avatar
   
Dries committed
899
/**
Dries's avatar
   
Dries committed
900
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
901
 *
Dries's avatar
   
Dries committed
902
903
904
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
905
906
907
908
909
910
911
912
913
914
915
916
917
 * For example:
 * @code
 *   $output = format_plural($node->comment_count, '1 comment', '@count comments');
 * @endcode
 *
 * Example with additional replacements:
 * @code
 *   $output = format_plural($update_count,
 *     'Changed the content type of 1 post from %old-type to %new-type.',
 *     'Changed the content type of @count posts from %old-type to %new-type.',
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type)));
 * @endcode
 *
Dries's avatar
   
Dries committed
918
919
920
921
922
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
923
 *   Do not use @count in the singluar string.
Dries's avatar
   
Dries committed
924
925
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
926
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries's avatar
   
Dries committed
927
 *   new comments".
928
929
930
931
932
933
934
935
936
937
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
 *   of any key in this array are replaced with the corresponding value.
 *   Based on the first character of the key, the value is escaped and/or themed:
 *    - !variable: inserted as is
 *    - @variable: escape plain text to HTML (check_plain)
 *    - %variable: escape text and theme as a placeholder for user-submitted
 *      content (check_plain + theme_placeholder)
 *   Note that you do not need to include @count in this array.
 *   This replacement is done automatically for the plural case.
Dries's avatar
   
Dries committed
938
939
 * @return
 *   A translated string.
Dries's avatar
   
Dries committed
940
 */
941
942
943
944
945
function format_plural($count, $singular, $plural, $args = array()) {
  if ($count == 1) {
    return t($singular, $args);
  }
  $args['@count'] = $count;
Dries's avatar
   
Dries committed
946
947

  // get the plural index through the gettext formula
948
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
   
Dries committed
949
  if ($index < 0) { // backward compatibility
950
    return t($plural, $args);
Dries's avatar
   
Dries committed
951
952
953
954
  }
  else {
    switch ($index) {
      case "0":
955
        return t($singular, $args);
Dries's avatar
   
Dries committed
956
      case "1":
957
        return t($plural, $args);
Dries's avatar
   
Dries committed
958
      default:
959
960
961
        unset($args['@count']);
        $args['@count['. $index .']'] = $count;
        return t(strtr($plural, array('@count' => '@count['. $index .']')), $args);
Dries's avatar
   
Dries committed
962
963
    }
  }
Dries's avatar
   
Dries committed
964
965
}

966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
/**
 * Parse a given byte count.
 *
 * @param $size
 *   The size expressed as a number of bytes with optional SI size and unit
 *   suffix (e.g. 2, 3K, 5MB, 10G).
 * @return
 *   An integer representation of the size.
 */
function parse_size($size) {
  $suffixes = array(
    '' => 1,
    'k' => 1024,
    'm' => 1048576, // 1024 * 1024
    'g' => 1073741824, // 1024 * 1024 * 1024
  );
  if (preg_match('/([0-9]+)\s*(k|m|g)?(b?(ytes?)?)/i', $size, $match)) {
    return $match[1] * $suffixes[drupal_strtolower($match[2])];
  }
}

Dries's avatar
   
Dries committed
987
/**
Dries's avatar
   
Dries committed
988
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
989
 *
Dries's avatar
   
Dries committed
990
991
992
993
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
994
 */
Dries's avatar
   
Dries committed
995
function format_size($size) {
996
997
  if ($size < 1024) {
    return format_plural($size, '1 byte', '@count bytes');
Dries's avatar
   
Dries committed
998
  }
999
  else {
Dries's avatar
   
Dries committed
1000
    $size = round($size / 1024, 2);
1001
1002
1003
1004
1005
1006
    $suffix = t('KB');
    if ($size >= 1024) {
      $size = round($size / 1024, 2);
      $suffix = t('MB');
    }
    return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix));
Dries's avatar
   
Dries committed
1007
1008
1009
  }
}

Dries's avatar
   
Dries committed
1010
/**
Dries's avatar
   
Dries committed
1011
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
1012
 *
Dries's avatar
   
Dries committed
1013
1014
1015
1016
1017
1018
 * @param $timestamp
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
 * @return
 *   A translated string representation of the interval.
Dries's avatar
   
Dries committed
1019
 */
Dries's avatar
   
Dries committed
1020
function format_interval($timestamp, $granularity = 2) {
1021
  $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
1022
  $output = '';
Dries's avatar
   
Dries committed
1023
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
1024
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
1025
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
1026
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
1027
      $timestamp %= $value;
Dries's avatar
   
Dries committed
1028
1029
1030
1031
1032
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
1033
1034
    }
  }
Dries's avatar
   
Dries committed
1035
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
1036
1037
}

Dries's avatar
   
Dries committed
1038
/**
Dries's avatar
   
Dries committed
1039
1040
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
1041
1042
1043
1044
 * 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.
 *
Dries's avatar
   
Dries committed
1045
1046
1047
1048
1049
1050
 * @param $timestamp
 *   The exact date to format, as a UNIX timestamp.
 * @param $type
 *   The format to use. Can be "small", "medium" or "large" for the preconfigured
 *   date formats. If "custom" is specified, then $format is required as well.
 * @param $format
1051
1052
1053
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries's avatar
   
Dries committed
1054
1055
1056
1057
 * @param $timezone
 *   Time zone offset in seconds; if omitted, the user's time zone is used.
 * @return
 *   A translated date string in the requested format.
Dries's avatar
   
Dries committed
1058
 */
1059
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
1060
  if (!isset($timezone)) {
1061
    global $user;
Steven Wittens's avatar
Steven Wittens committed
1062
1063
1064
1065
1066
1067
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
1068
  }
Dries's avatar
   
Dries committed
1069

1070
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
1071
1072

  switch ($type) {
1073
1074
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
1075
      break;
1076
1077
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
1078
      break;
1079
    case 'custom':
Dries's avatar
   
Dries committed
1080
      // No change to format
Dries's avatar
   
Dries committed
1081
      break;
1082
    case 'medium':
Dries's avatar