common.inc 57.6 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.
Dries's avatar
Dries committed
130
131
 */
function drupal_set_header($header = NULL) {
132
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
   
Dries committed
133
  // Otherwise, header('') could get called when serving the page later, which
134
135
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
136

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

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

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

  if (!is_null($url)) {
163
164
165
166
167
168
    $stored_feed_links[$url] = theme('feed_icon', $url);

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
  }
  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
184
185
186
/**
 * @name HTTP handling
 * @{
Dries's avatar
   
Dries committed
187
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
188
189
 */

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/**
 * 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) {
208
    $key = drupal_urlencode($key);
209
    if ($parent) {
210
      $key = $parent .'['. $key .']';
211
212
    }

213
    if (in_array($key, $exclude)) {
214
215
216
217
218
219
220
      continue;
    }

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

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

228
229
/**
 * Prepare a destination query string for use in combination with
230
231
232
 * 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
233
 * is returned. As such, a destination can persist across multiple
234
 * pages.
235
236
237
238
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
239
  if (isset($_REQUEST['destination'])) {
240
241
242
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
243
    // Use $_REQUEST here to retrieve the original path.
244
    $path = isset($_REQUEST['q']) ? drupal_get_path_alias($_REQUEST['q']) : '';
245
246
247
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
      $path .= '?'. $query;
248
    }
249
    return 'destination='. urlencode($path);
250
251
252
  }
}

Kjartan's avatar
Kjartan committed
253
/**
Dries's avatar
   
Dries committed
254
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
255
 *
Dries's avatar
   
Dries committed
256
257
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
258
 *
259
 * Usually the redirected URL is constructed from this function's input
260
 * parameters. However you may override that behavior by setting a
261
262
 * <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
263
264
 * 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
265
 * a post on the 'admin/content/node'-page or after having logged on using the
266
 * 'user login'-block in a sidebar. The function drupal_get_destination()
267
268
 * can be used to help set the destination URL.
 *
Dries's avatar
   
Dries committed
269
270
271
272
273
274
275
276
 * 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
277
 *   A Drupal path or a full URL.
Dries's avatar
   
Dries committed
278
279
280
281
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
282
283
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
284
 */
Dries's avatar
   
Dries committed
285
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
286
  if (isset($_REQUEST['destination'])) {
287
288
    extract(parse_url($_REQUEST['destination']));
  }
289
  else if (isset($_REQUEST['edit']['destination'])) {
290
291
292
    extract(parse_url($_REQUEST['edit']['destination']));
  }

293
  $url = url($path, $query, $fragment, TRUE);
Kjartan's avatar
Kjartan committed
294

Dries's avatar
   
Dries committed
295
296
297
298
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

  header('Location: '. $url);
Kjartan's avatar
Kjartan committed
299

Dries's avatar
   
Dries committed
300
301
302
  // 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
303
304
305
  exit();
}

306
/**
307
 * Generates a site off-line message
308
309
 */
function drupal_site_offline() {
310
  drupal_set_header('HTTP/1.0 503 Service unavailable');
311
  drupal_set_title(t('Site off-line'));
312
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
313
    t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', t('This Drupal site')))))));
314
315
}

Kjartan's avatar
Kjartan committed
316
317
318
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
319
function drupal_not_found() {
320
  drupal_set_header('HTTP/1.0 404 Not Found');
321

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

324
325
326
327
328
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
   
Dries committed
329
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
330
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
331
    menu_set_active_item($path);
332
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
333
  }
334
  else {
335
    // Redirect to a non-existent menu item to make possible tabs disappear.
336
    menu_set_active_item('');
337
  }
Dries's avatar
   
Dries committed
338

drumm's avatar
drumm committed
339
340
  if (empty($return)) {
    drupal_set_title(t('Page not found'));
Dries's avatar
   
Dries committed
341
  }
342
343
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
Dries's avatar
   
Dries committed
344
}
Dries's avatar
   
Dries committed
345

Dries's avatar
   
Dries committed
346
347
348
349
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
350
  drupal_set_header('HTTP/1.0 403 Forbidden');
351
  watchdog('access denied', check_plain($_GET['q']), WATCHDOG_WARNING);
Dries's avatar
   
Dries committed
352

drumm's avatar
drumm committed
353
// Keep old path for reference
354
355
356
357
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
   
Dries committed
358
  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
359
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
360
    menu_set_active_item($path);
361
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
362
  }
363
  else {
364
    // Redirect to a non-existent menu item to make possible tabs disappear.
365
    menu_set_active_item('');
366
  }
Dries's avatar
   
Dries committed
367

drumm's avatar
drumm committed
368
369
370
  if (empty($return)) {
    drupal_set_title(t('Access denied'));
    $return = t('You are not authorized to access this page.');
Dries's avatar
   
Dries committed
371
  }
372
  print theme('page', $return);
Dries's avatar
   
Dries committed
373
374
}

Dries's avatar
   
Dries committed
375
/**
Dries's avatar
   
Dries committed
376
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
377
 *
Dries's avatar
   
Dries committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 * 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
395
396
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
   
Dries committed
397
398
  $result = new StdClass();

Dries's avatar
   
Dries committed
399
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
400
401
402
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
403
      $port = isset($uri['port']) ? $uri['port'] : 80;
404
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
405
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
   
Dries committed
406
407
      break;
    case 'https':
Dries's avatar
   
Dries committed
408
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
409
      $port = isset($uri['port']) ? $uri['port'] : 443;
410
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
411
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
   
Dries committed
412
413
      break;
    default:
Dries's avatar
   
Dries committed
414
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
415
416
417
      return $result;
  }

Dries's avatar
   
Dries committed
418
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
419
  if (!$fp) {
Dries's avatar
   
Dries committed
420
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
421
422
423
    return $result;
  }

Dries's avatar
   
Dries committed
424
  // Construct the path to act on.
Dries's avatar
Dries committed
425
426
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
   
Dries committed
427
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
428
429
  }

Dries's avatar
   
Dries committed
430
  // Create HTTP request.
Dries's avatar
   
Dries committed
431
  $defaults = array(
432
433
434
435
    // 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",
436
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
437
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
438
439
440
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
441
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
442
443
  }

Dries's avatar
   
Dries committed
444
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
445
446
447
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
448
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
449
450
451
452
453
454
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
455
  $response = '';
456
457
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
   
Dries committed
458
459
460
461
  }
  fclose($fp);

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

465
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
   
Dries committed
466
467
468
  $result->headers = array();

  // Parse headers.
469
  while ($line = trim(array_shift($split))) {
Dries's avatar
   
Dries committed
470
    list($header, $value) = explode(':', $line, 2);
471
472
473
474
475
476
477
478
    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
479
480
481
482
483
484
485
486
487
488
  }

  $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
489
  // the base code in their class.
Dries's avatar
   
Dries committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
  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
517
518
519
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
520

Dries's avatar
   
Dries committed
521
/**
Dries's avatar
   
Dries committed
522
523
 * Log errors as defined by administrator
 * Error levels:
524
525
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
   
Dries committed
526
 */
Dries's avatar
   
Dries committed
527
function error_handler($errno, $message, $filename, $line) {
528
529
530
531
532
  // If the @ error suppression operator was used, error_reporting is temporarily set to 0
  if (error_reporting() == 0) {
    return;
  }

533
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
   
Dries committed
534
535
    $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
536

537
    // Force display of error messages in update.php
538
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
539
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
540
    }
541
542

    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
543
544
545
  }
}

Dries's avatar
   
Dries committed
546
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
547
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
548
549
550
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
551
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
552
553
554
  }
}

Dries's avatar
   
Dries committed
555
556
557
558
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
559
function fix_gpc_magic() {
560
  static $fixed = FALSE;
Dries's avatar
   
Dries committed
561
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
562
563
564
565
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
566
    array_walk($_FILES, '_fix_gpc_magic');
567
    $fixed = TRUE;
Dries's avatar
Dries committed
568
  }
Dries's avatar
   
Dries committed
569
570
}

Dries's avatar
   
Dries committed
571
572
573
/**
 * Initialize the localization system.
 */
Dries's avatar
   
Dries committed
574
575
function locale_initialize() {
  global $user;
Dries's avatar
   
Dries committed
576
577
578
579
580

  if (function_exists('i18n_get_lang')) {
    return i18n_get_lang();
  }

Dries's avatar
   
Dries committed
581
582
583
584
585
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
586
587
588
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries's avatar
   
Dries committed
589
  }
590
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
   
Dries committed
591
592
593
594
595
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
596
597
}

Kjartan's avatar
Kjartan committed
598
/**
Dries's avatar
   
Dries committed
599
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
600
 *
601
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
   
Dries committed
602
603
604
605
 * This makes it easier for translators. HTML markup within translation strings
 * is acceptable, if necessary. The suggested syntax for a link embedded
 * within a translation string is:
 * @code
606
607
 *   $msg = t('You must log in below or <a href="@url">create a new
 *             account</a> before viewing the next page.', array('@url'
Dries's avatar
   
Dries committed
608
 *             => url('user/register')));
Dries's avatar
   
Dries committed
609
 * @endcode
610
611
612
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
Kjartan's avatar
Kjartan committed
613
 *
Dries's avatar
   
Dries committed
614
 * @param $string
Dries's avatar
   
Dries committed
615
 *   A string containing the English string to translate.
Dries's avatar
   
Dries committed
616
617
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
   
Dries committed
618
 *   of any key in this array are replaced with the corresponding value.
619
620
621
622
623
 *   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
624
625
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
626
 */
Dries's avatar
   
Dries committed
627
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
628
629
630
631
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
Dries's avatar
   
Dries committed
632
633
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
634
635
  }
  else {
636
    // Transform arguments before inserting them
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
    foreach($args as $key => $value) {
      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
652
653
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
654
655
}

Kjartan's avatar
Kjartan committed
656
/**
Dries's avatar
   
Dries committed
657
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
658
 * @{
Dries's avatar
   
Dries committed
659
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
660
661
 */

662
/**
Dries's avatar
   
Dries committed
663
664
665
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
666
 *
Dries's avatar
   
Dries committed
667
 * @param $mail
668
 *   A string containing an e-mail address.
Dries's avatar
   
Dries committed
669
 * @return
Dries's avatar
   
Dries committed
670
 *   TRUE if the address is in a valid format.
671
 */
Dries's avatar
   
Dries committed
672
function valid_email_address($mail) {
673
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
674
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
675
676
677
  $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
678
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
679
680
}

Dries's avatar
   
Dries committed
681
682
683
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
684
 * @param $url
Dries's avatar
   
Dries committed
685
 *   The URL to verify.
Dries's avatar
   
Dries committed
686
 * @param $absolute
Dries's avatar
   
Dries committed
687
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
688
 * @return
Dries's avatar
   
Dries committed
689
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
690
 */
Dries's avatar
   
Dries committed
691
function valid_url($url, $absolute = FALSE) {
692
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
693
  if ($absolute) {
694
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
695
696
  }
  else {
697
    return preg_match("/^". $allowed_characters ."+$/i", $url);
698
  }
Dries's avatar
   
Dries committed
699
700
}

Dries's avatar
   
Dries committed
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
/**
 * 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
721
 *   True if the user did not exceed the hourly threshold. False otherwise.
Dries's avatar
   
Dries committed
722
723
724
725
726
727
 */
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);
}

728
729
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
730
731
}

Dries's avatar
Dries committed
732
733
734
735
736
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
737
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
738
739
}

Dries's avatar
   
Dries committed
740
/**
Dries's avatar
   
Dries committed
741
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
742
 * @{
Dries's avatar
   
Dries committed
743
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
744
745
 */

Dries's avatar
   
Dries committed
746
747
748
749
750
751
/**
 * 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
752
753
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
754
  $output = "<channel>\n";
755
756
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
757
758
759
760
761

  // 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";
762
  $output .= ' <language>'. check_plain($language) ."</language>\n";
763
  $output .= format_xml_elements($args);
Dries's avatar
   
Dries committed
764
765
766
767
768
769
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
770
771
772
773
774
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
775
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
776
  $output = "<item>\n";
777
778
779
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
  $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) {
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
   
Dries committed
803
804
      if ($value['key']) {
        $output .= ' <'. $value['key'];
805
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
   
Dries committed
806
807
808
          $output .= drupal_attributes($value['attributes']);
        }

809
        if ($value['value'] != '') {
810
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries's avatar
   
Dries committed
811
812
813
814
815
816
817
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
818
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
819
    }
Dries's avatar
   
Dries committed
820
  }
Dries's avatar
   
Dries committed
821
822
823
  return $output;
}

Dries's avatar
   
Dries committed
824
/**
Dries's avatar
   
Dries committed
825
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
826
 *
Dries's avatar
   
Dries committed
827
828
829
830
831
832
833
834
835
836
 * 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.
 *
 * @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").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
837
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries's avatar
   
Dries committed
838
839
840
 *   new comments".
 * @return
 *   A translated string.
Dries's avatar
   
Dries committed
841
 */
Dries's avatar
   
Dries committed
842
function format_plural($count, $singular, $plural) {
843
  if ($count == 1) return t($singular, array("@count" => $count));
Dries's avatar
   
Dries committed
844
845

  // get the plural index through the gettext formula
846
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
   
Dries committed
847
  if ($index < 0) { // backward compatibility
848
    return t($plural, array("@count" => $count));
Dries's avatar
   
Dries committed
849
850
851
852
  }
  else {
    switch ($index) {
      case "0":
853
        return t($singular, array("@count" => $count));
Dries's avatar
   
Dries committed
854
      case "1":
855
        return t($plural, array("@count" => $count));
Dries's avatar
   
Dries committed
856
      default:
857
        return t(strtr($plural, array("@count" => '@count['. $index .']')), array('@count['. $index .']' => $count));
Dries's avatar
   
Dries committed
858
859
    }
  }
Dries's avatar
   
Dries committed
860
861
}

Dries's avatar
   
Dries committed
862
/**
Dries's avatar
   
Dries committed
863
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
864
 *
Dries's avatar
   
Dries committed
865
866
867
868
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
869
 */
Dries's avatar
   
Dries committed
870
function format_size($size) {
Dries's avatar
   
Dries committed
871
  $suffix = t('bytes');
872
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
873
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
874
    $suffix = t('KB');
Dries's avatar
   
Dries committed
875
  }
876
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
877
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
878
    $suffix = t('MB');
Dries's avatar
   
Dries committed
879
  }
880
  return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix));
Dries's avatar
   
Dries committed
881
882
}

Dries's avatar
   
Dries committed
883
/**
Dries's avatar
   
Dries committed
884
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
885
 *
Dries's avatar
   
Dries committed
886
887
888
889
890
891
 * @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
892
 */
Dries's avatar
   
Dries committed
893
function format_interval($timestamp, $granularity = 2) {
894
  $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
895
  $output = '';
Dries's avatar
   
Dries committed
896
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
897
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
898
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
899
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
900
      $timestamp %= $value;
Dries's avatar
   
Dries committed
901
902
903
904
905
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
906
907
    }
  }
Dries's avatar
   
Dries committed
908
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
909
910
}

Dries's avatar
   
Dries committed
911
/**
Dries's avatar
   
Dries committed
912
913
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
914
915
916
917
 * 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
918
919
920
921
922
923
 * @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
924
925
926
 *   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
927
928
929
930
 * @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
931
 */
932
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
933
  if (!isset($timezone)) {
934
    global $user;
Steven Wittens's avatar
Steven Wittens committed
935
936
937
938
939
940
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
941
  }
Dries's avatar
   
Dries committed
942

943
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
944
945

  switch ($type) {
946
947
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
948
      break;
949
950
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
951
      break;
952
    case 'custom':
Dries's avatar
   
Dries committed
953
      // No change to format
Dries's avatar
   
Dries committed
954
      break;
955
    case 'medium':
Dries's avatar
   
Dries committed
956
    default:
957
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
958
959
  }

960
  $max = strlen($format);
Dries's avatar
   
Dries committed
961
  $date = '';
Dries's avatar
   
Dries committed
962
  for ($i = 0; $i < $max; $i++) {
963
    $c = $format[$i];
964
    if (strpos('AaDFlM', $c) !== FALSE) {
965
      $date .= t(gmdate($c, $timestamp));
966
    }
967
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== FALSE) {
968
969
970
971
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
   
Dries committed
972
    }
973
974
975
976
977
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
   
Dries committed
978
    }
979
980
981
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
   
Dries committed
982
    else {
983
      $date .= $c;
Dries's avatar
   
Dries committed
984
    }
Dries's avatar
   
Dries committed
985
  }
986

Dries's avatar
   
Dries committed
987
988
989
  return $date;
}

Dries's avatar
   
Dries committed
990
991
992
/**
 * @} End of "defgroup format".
 */
Dries's avatar
   
Dries committed
993

Dries's avatar