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

Dries Buytaert's avatar
   
Dries Buytaert 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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
function drupal_set_content($region = null, $data = null) {
  static $content = array();

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

/**
 * Get assigned content.
 *
 * @param $region
 *   A specified region to fetch content for.  If null, all regions will be returned.
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
function drupal_get_content($region = null, $delimiter = ' ') {
  $content = drupal_set_content();
  if (isset($region)) {
    if (is_array($content[$region])) {
      return implode ($delimiter, $content[$region]);
    }
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
        $content[$region] = implode ($delimiter, $content[$region]);
      }
    }
    return $content;
  }
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
87
88
89
/**
 * Get the breadcrumb trail for the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
90
91
92
93
94
95
96
97
98
99
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
113
114
115
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
116
117
118
function drupal_get_html_head() {
  global $base_url;

Dries Buytaert's avatar
   
Dries Buytaert committed
119
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries Buytaert's avatar
Dries Buytaert committed
120
  $output .= "<base href=\"$base_url/\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
121
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries Buytaert's avatar
Dries Buytaert committed
122
123
124
125

  return $output . drupal_set_html_head();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
126
/**
127
 * Reset the static variable which holds the aliases mapped for this request.
Dries Buytaert's avatar
   
Dries Buytaert committed
128
 */
129
130
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries Buytaert's avatar
   
Dries Buytaert committed
131
}
132

Dries Buytaert's avatar
   
Dries Buytaert committed
133
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
134
 * Given a path alias, return the internal path it represents.
Dries Buytaert's avatar
   
Dries Buytaert committed
135
136
 */
function drupal_get_normal_path($path) {
137
138
139
  //drupal_get_path_alias($path);
  if ($src = drupal_lookup_path('alias', $path)) {
    return $src;
Dries Buytaert's avatar
   
Dries Buytaert committed
140
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
141
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
142
143
144
145
146
147
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
148

Dries Buytaert's avatar
Dries Buytaert committed
149
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
150
 * Set an HTTP response header for the current page.
Dries Buytaert's avatar
Dries Buytaert committed
151
152
 */
function drupal_set_header($header = NULL) {
153
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries Buytaert's avatar
   
Dries Buytaert committed
154
  // Otherwise, header('') could get called when serving the page later, which
155
156
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries Buytaert's avatar
Dries Buytaert committed
157

158
  if (strlen($header)) {
Dries Buytaert's avatar
Dries Buytaert committed
159
    header($header);
160
    $stored_headers[] = $header;
Dries Buytaert's avatar
Dries Buytaert committed
161
  }
162
  return implode("\n", $stored_headers);
Dries Buytaert's avatar
Dries Buytaert committed
163
164
}

Dries Buytaert's avatar
   
Dries Buytaert committed
165
166
167
/**
 * Get the HTTP response headers for the current page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
168
169
170
171
function drupal_get_headers() {
  return drupal_set_header();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
172
173
174
/**
 * @name HTTP handling
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
175
 * Functions to properly handle HTTP responses.
Dries Buytaert's avatar
   
Dries Buytaert committed
176
177
 */

178
179
/**
 * Prepare a destination query string for use in combination with
180
181
182
183
184
 * 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
 * is returned.  As such, a destination can persist across multiple
 * pages.
185
186
187
188
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
189
190
191
192
193
194
195
196
197
198
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
    $destination[] = $_GET['q'];
    $params = array('page', 'sort', 'order');
    foreach ($params as $param) {
      if (isset($_GET[$param])) {
        $destination[] = "$param=". $_GET[$param];
      }
199
    }
200
    return 'destination='. urlencode(implode('&', $destination));
201
202
203
  }
}

204
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
205
 * Send the user to a different Drupal page.
206
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
207
208
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
209
 *
210
211
212
213
214
215
216
217
218
219
 * Usually the redirected URL is constructed from this function's input
 * parameters.  However you may override that behavior by setting a
 * <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
 * 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
 * a post on the 'admin/node'-page or after having logged on using the
 * 'user login'-block in a sidebar.  The function drupal_get_destination()
 * can be used to help set the destination URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
220
221
222
223
224
225
226
227
228
229
230
231
232
 * 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
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
233
234
 *
 * @see drupal_get_destination()
235
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
236
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
237
238
239
240
241
242
243
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

244
  $url = url($path, $query, $fragment, TRUE);
245

Dries Buytaert's avatar
   
Dries Buytaert committed
246
247
  if (ini_get('session.use_trans_sid') && session_id() && !strstr($url, session_id())) {
    $sid = session_name() . '=' . session_id();
Dries Buytaert's avatar
   
Dries Buytaert committed
248

Dries Buytaert's avatar
   
Dries Buytaert committed
249
250
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
251
252
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
253
      $url = $url .'?'. $sid;
254
255
256
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
257
258
259
260
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

  header('Location: '. $url);
261

Dries Buytaert's avatar
   
Dries Buytaert committed
262
263
264
  // 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.
265
266
267
268
269
270
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
271
function drupal_not_found() {
Dries Buytaert's avatar
   
Dries Buytaert committed
272
  header('HTTP/1.0 404 Not Found');
273
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries Buytaert's avatar
   
Dries Buytaert committed
274
275

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
276
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
277
278
  if ($path) {
    menu_set_active_item($path);
279
    $return = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
280
281
  }

282
  if (empty($return)) {
283
    drupal_set_title(t('Page not found'));
Dries Buytaert's avatar
   
Dries Buytaert committed
284
  }
285
  print theme('page', $return);
Dries Buytaert's avatar
   
Dries Buytaert committed
286
}
Dries Buytaert's avatar
   
Dries Buytaert committed
287

Dries Buytaert's avatar
   
Dries Buytaert committed
288
289
290
291
292
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
293
  watchdog('access denied', t('%page denied access.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries Buytaert's avatar
   
Dries Buytaert committed
294
295

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
296
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
297
298
  if ($path) {
    menu_set_active_item($path);
299
    $return = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
300
301
  }

302
  if (empty($return)) {
303
    drupal_set_title(t('Access denied'));
304
    $return = message_access();
Dries Buytaert's avatar
   
Dries Buytaert committed
305
  }
306
  print theme('page', $return);
Dries Buytaert's avatar
   
Dries Buytaert committed
307
308
}

Dries Buytaert's avatar
   
Dries Buytaert committed
309
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
310
 * Perform an HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
311
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 * 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 Buytaert's avatar
   
Dries Buytaert committed
329
330
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries Buytaert's avatar
   
Dries Buytaert committed
331
332
  $result = new StdClass();

Dries Buytaert's avatar
   
Dries Buytaert committed
333
  // Parse the URL, and make sure we can handle the schema.
Dries Buytaert's avatar
   
Dries Buytaert committed
334
335
336
337
338
339
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
Dries Buytaert's avatar
   
Dries Buytaert committed
340
341
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
      $fp = @fsockopen('ssl://'. $uri['host'], ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
Dries Buytaert's avatar
   
Dries Buytaert committed
342
343
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
344
      $result->error = 'invalid schema '. $uri['scheme'];
Dries Buytaert's avatar
   
Dries Buytaert committed
345
346
347
      return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
348
  // Make sure the socket opened properly.
Dries Buytaert's avatar
   
Dries Buytaert committed
349
  if (!$fp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
350
    $result->error = trim($errno .' '. $errstr);
Dries Buytaert's avatar
   
Dries Buytaert committed
351
352
353
    return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
354
  // Construct the path to act on.
Dries Buytaert's avatar
   
Dries Buytaert committed
355
356
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
357
    $path .= '?'. $uri['query'];
Dries Buytaert's avatar
   
Dries Buytaert committed
358
359
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
360
  // Create HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
361
  $defaults = array(
Dries Buytaert's avatar
   
Dries Buytaert committed
362
    'Host' => 'Host: '. $uri['host'],
363
364
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
365
366
367
  );

  foreach ($headers as $header => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
368
    $defaults[$header] = $header .': '. $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
369
370
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
371
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
372
373
374
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries Buytaert's avatar
   
Dries Buytaert committed
375
    $request .= $data ."\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
376
377
378
379
380
381
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
382
  $response = '';
383
  while (!feof($fp) && $data = fread($fp, 1024)) {
384
    $response .= $data;
Dries Buytaert's avatar
   
Dries Buytaert committed
385
386
387
388
  }
  fclose($fp);

  // Parse response.
389
390
391
392
  list($headers, $result->data) = explode("\r\n\r\n", $response, 2);
  $headers = preg_split("/\r\n|\n|\r/", $headers);

  list($protocol, $code, $text) = explode(' ', trim(array_shift($headers)), 3);
Dries Buytaert's avatar
   
Dries Buytaert committed
393
394
395
  $result->headers = array();

  // Parse headers.
396
  while ($line = trim(array_shift($headers))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
397
398
399
400
401
402
403
404
405
406
407
408
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $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 Buytaert's avatar
   
Dries Buytaert committed
409
  // the base code in their class.
Dries Buytaert's avatar
   
Dries Buytaert committed
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
  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 Buytaert's avatar
   
Dries Buytaert committed
437
438
439
/**
 * @} End of "HTTP handling".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
440

Dries Buytaert's avatar
   
Dries Buytaert committed
441
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
442
443
444
445
 * Log errors as defined by administrator
 * Error levels:
 *  1 = Log errors to database.
 *  2 = Log errors to database and to screen.
Dries Buytaert's avatar
   
Dries Buytaert committed
446
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
447
function error_handler($errno, $message, $filename, $line) {
448
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
449
450
    $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 Buytaert's avatar
   
Dries Buytaert committed
451

Dries Buytaert's avatar
   
Dries Buytaert committed
452
    if (variable_get('error_level', 1) == 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
453
      print '<pre>'. $entry .'</pre>';
Dries Buytaert's avatar
Dries Buytaert committed
454
    }
455
456

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

Dries Buytaert's avatar
   
Dries Buytaert committed
460
function _fix_gpc_magic(&$item) {
Dries Buytaert's avatar
Dries Buytaert committed
461
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
462
463
464
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
465
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
466
467
468
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
469
470
471
472
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
473
474
function fix_gpc_magic() {
  static $fixed = false;
Dries Buytaert's avatar
   
Dries Buytaert committed
475
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries Buytaert's avatar
Dries Buytaert committed
476
477
478
479
480
481
    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
482
483
}

484
485
486
487
488
489
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
/**
 * An unchecked checkbox is not present in $_POST so we fix it here by
 * proving a default value of 0.  Also, with form_checkboxes() we expect
 * an array, but HTML does not send the empty array.  This is also taken
 * care off.
 */
function fix_checkboxes() {
  if (isset($_POST['form_array'])) {
    $_POST['edit'] = _fix_checkboxes($_POST['edit'], $_POST['form_array'], array());
  }
  if (isset($_POST['form_zero'])) {
    $_POST['edit'] = _fix_checkboxes($_POST['edit'], $_POST['form_zero'], 0);
  }
}

function _fix_checkboxes($array1, $array2, $value) {
  if (is_array($array2) && count($array2)) {
    foreach ($array2 as $k => $v) {
      if (is_array($v) && count($v)) {
        $array1[$k] = _fix_checkboxes($array1[$k], $v, $value);
      }
      else if (!isset($array1[$k])) {
        $array1[$k] = $value;
      }
    }
  }
  else {
    $array1 = $value;
  }
  return $array1;
}

516
517
518
/**
 * @name Conversion
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
519
 * Converts data structures to different types.
520
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
521
522
523
524

/**
 * Convert an associative array to an anonymous object.
 */
Dries Buytaert's avatar
Dries Buytaert committed
525
526
function array2object($array) {
  if (is_array($array)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
527
    $object = new StdClass();
Dries Buytaert's avatar
Dries Buytaert committed
528
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
529
530
531
532
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
533
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
534
535
536
537
538
  }

  return $object;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
539
540
541
/**
 * Convert an object to an associative array.
 */
Dries Buytaert's avatar
Dries Buytaert committed
542
543
544
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
545
546
547
548
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
549
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
550
551
552
553
  }

  return $array;
}
Dries Buytaert's avatar
   
Dries Buytaert committed
554
555
556
557

/**
 * @} End of "Conversion".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
558

559
560
561
/**
 * @name Messages
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
562
 * Frequently used messages.
563
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
564
565
566
567
568
569
570

/**
 * Return a string with an "access denied" message.
 *
 * Always consider whether to use drupal_access_denied() instead to return a
 * proper (and customizable) 403 error.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
571
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
572
  return t('You are not authorized to access this page.');
Dries Buytaert's avatar
   
Dries Buytaert committed
573
574
}

Dries Buytaert's avatar
   
Dries Buytaert committed
575
576
577
/**
 * Return a string with a "not applicable" message.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
578
function message_na() {
Dries Buytaert's avatar
   
Dries Buytaert committed
579
  return t('n/a');
Dries Buytaert's avatar
   
Dries Buytaert committed
580
581
}

Dries Buytaert's avatar
   
Dries Buytaert committed
582
583
584
/**
 * @} End of "Messages".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
585

Dries Buytaert's avatar
   
Dries Buytaert committed
586
587
588
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
589
590
function locale_initialize() {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
591
592
593
594
595

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

Dries Buytaert's avatar
   
Dries Buytaert committed
596
597
598
599
600
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
601
602
603
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries Buytaert's avatar
   
Dries Buytaert committed
604
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
605
606
607
608
609
610
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
611
612
}

613
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
614
 * Translate strings to the current locale.
615
 *
616
 * When using t(), try to put entire sentences and strings in one t() call.
Dries Buytaert's avatar
   
Dries Buytaert committed
617
618
619
620
 * 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
Dries Buytaert's avatar
   
Dries Buytaert committed
621
622
623
 *   $msg = t('You must log in below or <a href="%url">create a new
 *             account</a> before viewing the next page.', array('%url'
 *             => url('user/register')));
Dries Buytaert's avatar
   
Dries Buytaert committed
624
 * @endcode
625
626
627
 * 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.
628
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
629
 * @param $string
Dries Buytaert's avatar
   
Dries Buytaert committed
630
 *   A string containing the English string to translate.
Dries Buytaert's avatar
   
Dries Buytaert committed
631
632
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries Buytaert's avatar
   
Dries Buytaert committed
633
 *   of any key in this array are replaced with the corresponding value.
Dries Buytaert's avatar
   
Dries Buytaert committed
634
635
 * @return
 *   The translated string.
636
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
637
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
638
639
640
641
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
642

Dries Buytaert's avatar
   
Dries Buytaert committed
643
644
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
645
646
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
647
648
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
649
650
}

Dries Buytaert's avatar
   
Dries Buytaert committed
651
/**
652
 * Encode special characters in a plain-text string for display as HTML.
Dries Buytaert's avatar
   
Dries Buytaert committed
653
 */
654
function check_plain($text) {
655
  return htmlspecialchars($text);
Dries Buytaert's avatar
   
Dries Buytaert committed
656
657
}

658
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
659
 * @defgroup validation Input validation
Dries Buytaert's avatar
   
Dries Buytaert committed
660
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
661
 * Functions to validate user input.
662
663
 */

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
703
704
705
706
707
708
709
710
711
712
/**
 * Validate data input by a user.
 *
 * Ensures that user data cannot be used to perform attacks on the site.
 *
 * @param $data
 *   The input to check.
 * @return
 *   TRUE if the input data is acceptable.
 */
713
714
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
715
    // Form data can contain a number of nested arrays.
716
    foreach ($data as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
717
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
718
        return FALSE;
719
720
721
      }
    }
  }
722
  else if (isset($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
723
    // Detect dangerous input data.
724

725
726
727
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries Buytaert's avatar
   
Dries Buytaert committed
728
729
730
731
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
732

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

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

    if ($match) {
740
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => theme('placeholder', $data))));
Dries Buytaert's avatar
   
Dries Buytaert committed
741
      return FALSE;
742
743
744
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
745
  return TRUE;
746
}
Dries Buytaert's avatar
   
Dries Buytaert committed
747
748
749
/**
 * @} End of "defgroup validation".
 */
750

Dries Buytaert's avatar
   
Dries Buytaert committed
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
/**
 * 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
 *   True if the user did not exceed the hourly threshold.  False otherwise.
 */
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);
}

778
779
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
780
781
}

Dries Buytaert's avatar
   
Dries Buytaert committed
782
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
783
 * @defgroup format Formatting
Dries Buytaert's avatar
   
Dries Buytaert committed
784
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
785
 * Functions to format numbers, strings, dates, etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
786
787
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
788
789
790
791
792
793
/**
 * 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 Buytaert's avatar
   
Dries Buytaert committed
794
795
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
796
  $output = "<channel>\n";
797
798
799
800
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
801
  foreach ($args as $key => $value) {
802
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
803
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
804
805
806
807
808
809
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
810
811
812
813
814
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
815
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
816
  $output = "<item>\n";
817
818
819
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
820
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
        if (is_array($value['attributes'])) {
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
837
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
838
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
839
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
840
841
842
843
844
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
845
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
846
 * Format a string containing a count of items.
Dries Buytaert's avatar
   
Dries Buytaert committed
847
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 * 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,
 *   to ease translation. Use %count in place of the item count, as in "%count
 *   new comments".
 * @return
 *   A translated string.
Dries Buytaert's avatar
   
Dries Buytaert committed
862
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
863
function format_plural($count, $singular, $plural) {
864
  if ($count == 1) return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
865
866

  // get the plural index through the gettext formula
867
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries Buytaert's avatar
   
Dries Buytaert committed
868
869
870
871
872
873
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
874
        return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
875
876
877
878
879
880
      case "1":
        return t($plural, array("%count" => $count));
      default:
        return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count));
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
881
882
}

Dries Buytaert's avatar
   
Dries Buytaert committed
883
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
884
 * Generate a string representation for the given byte count.
Dries Buytaert's avatar
   
Dries Buytaert committed
885
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
886
887
888
889
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries Buytaert's avatar
   
Dries Buytaert committed
890
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
891
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
892
  $suffix = t('bytes');
893
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
894
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
895
    $suffix = t('KB');
Dries Buytaert's avatar
   
Dries Buytaert committed
896
  }
897
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
898
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
899
    $suffix = t('MB');
Dries Buytaert's avatar
   
Dries Buytaert committed
900
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
901
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
902
903
}

Dries Buytaert's avatar
   
Dries Buytaert committed
904
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
905
 * Format a time interval with the requested granularity.
Dries Buytaert's avatar
   
Dries Buytaert committed
906
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
907
908
909
910
911
912
 * @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 Buytaert's avatar
   
Dries Buytaert committed
913
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
914
function format_interval($timestamp, $granularity = 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
915
  $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
916
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
917
  foreach ($units as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
918
    $key = explode('|', $key);
Dries Buytaert's avatar
   
Dries Buytaert committed
919
    if ($timestamp >= $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
920
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries Buytaert's avatar
   
Dries Buytaert committed
921
      $timestamp %= $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
922
923
924
925
926
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
927
928
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
929
  return $output ? $output : t('0 sec');
Dries Buytaert's avatar
   
Dries Buytaert committed
930
931
}

Dries Buytaert's avatar
   
Dries Buytaert committed
932
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
933
934
 * Format a date with the given configured format or a custom format string.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
935
936
937
938
 * 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 Buytaert's avatar
   
Dries Buytaert committed
939
940
941
942
943
944
 * @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
945
946
947
 *   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 Buytaert's avatar
   
Dries Buytaert committed
948
949
950
951
 * @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 Buytaert's avatar
   
Dries Buytaert committed
952
 */
953
954
955
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
956
957
958
959
960
961
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
962
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
963

964
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
965
966

  switch ($type) {
967
968
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
969
      break;
970
971
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
972
      break;
973
    case 'custom':
Dries Buytaert's avatar
   
Dries Buytaert committed
974
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
975
      break;
976
    case 'medium':
Dries Buytaert's avatar
   
Dries Buytaert committed
977
    default:
978
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
979
980
  }

981
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
982
  $date = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
983
984
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
985
    if (strpos('AaDFlM', $c) !== false) {
986
      $date .= t(gmdate($c, $timestamp));
987
    }
988
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
989
990
991
992
      $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
993
    }
994
995
996
997
998
    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
999
    }
1000
    else if ($c == '\\') {
For faster browsing, not all history is shown. View entire blame