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

Dries Buytaert's avatar
   
Dries Buytaert committed
4
5
6
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);

Dries Buytaert's avatar
   
Dries Buytaert committed
27
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
28
 * Set the breadcrumb trail for the current page.
Dries Buytaert's avatar
   
Dries Buytaert committed
29
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
30
31
32
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
33
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
34
35
36
37
38
39
40
41
42
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
43
44
45
/**
 * Get the breadcrumb trail for the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
46
47
48
49
50
51
52
53
54
55
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
56
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
57
 * Add output to the head tag of the HTML page.
Dries Buytaert's avatar
   
Dries Buytaert committed
58
 * This function can be called as long the headers aren't sent.
Dries Buytaert's avatar
Dries Buytaert committed
59
60
 */
function drupal_set_html_head($data = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
61
  static $stored_head = '';
Dries Buytaert's avatar
Dries Buytaert committed
62
63

  if (!is_null($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
64
    $stored_head .= $data ."\n";
Dries Buytaert's avatar
Dries Buytaert committed
65
66
67
68
  }
  return $stored_head;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
69
70
71
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
72
73
74
function drupal_get_html_head() {
  global $base_url;

Dries Buytaert's avatar
   
Dries Buytaert committed
75
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries Buytaert's avatar
Dries Buytaert committed
76
  $output .= "<base href=\"$base_url/\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
77
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries Buytaert's avatar
Dries Buytaert committed
78
79
80
81

  return $output . drupal_set_html_head();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
82
/**
83
 * Reset the static variable which holds the aliases mapped for this request.
Dries Buytaert's avatar
   
Dries Buytaert committed
84
 */
85
86
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries Buytaert's avatar
   
Dries Buytaert committed
87
}
88

Dries Buytaert's avatar
   
Dries Buytaert committed
89
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
90
 * Given a path alias, return the internal path it represents.
Dries Buytaert's avatar
   
Dries Buytaert committed
91
92
 */
function drupal_get_normal_path($path) {
93
94
95
  //drupal_get_path_alias($path);
  if ($src = drupal_lookup_path('alias', $path)) {
    return $src;
Dries Buytaert's avatar
   
Dries Buytaert committed
96
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
97
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
98
99
100
101
102
103
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
104

Dries Buytaert's avatar
Dries Buytaert committed
105
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
106
 * Set an HTTP response header for the current page.
Dries Buytaert's avatar
Dries Buytaert committed
107
108
 */
function drupal_set_header($header = NULL) {
109
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries Buytaert's avatar
   
Dries Buytaert committed
110
  // Otherwise, header('') could get called when serving the page later, which
111
112
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries Buytaert's avatar
Dries Buytaert committed
113

114
  if (strlen($header)) {
Dries Buytaert's avatar
Dries Buytaert committed
115
    header($header);
116
    $stored_headers[] = $header;
Dries Buytaert's avatar
Dries Buytaert committed
117
  }
118
  return implode("\n", $stored_headers);
Dries Buytaert's avatar
Dries Buytaert committed
119
120
}

Dries Buytaert's avatar
   
Dries Buytaert committed
121
122
123
/**
 * Get the HTTP response headers for the current page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
124
125
126
127
function drupal_get_headers() {
  return drupal_set_header();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
128
129
130
/**
 * @name HTTP handling
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
131
 * Functions to properly handle HTTP responses.
Dries Buytaert's avatar
   
Dries Buytaert committed
132
133
 */

134
135
/**
 * Prepare a destination query string for use in combination with
136
137
138
139
140
 * 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.
141
142
143
144
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
145
146
147
148
149
150
151
152
153
154
  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];
      }
155
    }
156
    return 'destination='. urlencode(implode('&', $destination));
157
158
159
  }
}

160
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
161
 * Send the user to a different Drupal page.
162
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
163
164
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
165
 *
166
167
168
169
170
171
172
173
174
175
 * 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
176
177
178
179
180
181
182
183
184
185
186
187
188
 * 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).
189
190
 *
 * @see drupal_get_destination()
191
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
192
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
193
194
195
196
197
198
199
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

200
  $url = url($path, $query, $fragment, TRUE);
201

Dries Buytaert's avatar
   
Dries Buytaert committed
202
203
  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
204

Dries Buytaert's avatar
   
Dries Buytaert committed
205
206
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
207
208
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
209
      $url = $url .'?'. $sid;
210
211
212
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
213
214
215
216
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries Buytaert's avatar
   
Dries Buytaert committed
218
219
220
  // 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.
221
222
223
224
225
226
  exit();
}

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
232
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
233
234
  if ($path) {
    menu_set_active_item($path);
235
    $return = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
236
237
  }

238
  if (empty($return)) {
239
    drupal_set_title(t('Page not found'));
Dries Buytaert's avatar
   
Dries Buytaert committed
240
  }
241
  print theme('page', $return);
Dries Buytaert's avatar
   
Dries Buytaert committed
242
}
Dries Buytaert's avatar
   
Dries Buytaert committed
243

Dries Buytaert's avatar
   
Dries Buytaert committed
244
245
246
247
248
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
249
  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
250
251

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
252
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
253
254
  if ($path) {
    menu_set_active_item($path);
255
    $return = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
256
257
  }

258
  if (empty($return)) {
259
    drupal_set_title(t('Access denied'));
260
    $return = message_access();
Dries Buytaert's avatar
   
Dries Buytaert committed
261
  }
262
  print theme('page', $return);
Dries Buytaert's avatar
   
Dries Buytaert committed
263
264
}

Dries Buytaert's avatar
   
Dries Buytaert committed
265
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
266
 * Perform an HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
267
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 * 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
285
286
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries Buytaert's avatar
   
Dries Buytaert committed
287
288
  $result = new StdClass();

Dries Buytaert's avatar
   
Dries Buytaert committed
289
  // Parse the URL, and make sure we can handle the schema.
Dries Buytaert's avatar
   
Dries Buytaert committed
290
291
292
293
294
295
  $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
296
297
      // 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
298
299
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
300
      $result->error = 'invalid schema '. $uri['scheme'];
Dries Buytaert's avatar
   
Dries Buytaert committed
301
302
303
      return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
304
  // Make sure the socket opened properly.
Dries Buytaert's avatar
   
Dries Buytaert committed
305
  if (!$fp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
306
    $result->error = trim($errno .' '. $errstr);
Dries Buytaert's avatar
   
Dries Buytaert committed
307
308
309
    return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
310
  // Construct the path to act on.
Dries Buytaert's avatar
   
Dries Buytaert committed
311
312
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
313
    $path .= '?'. $uri['query'];
Dries Buytaert's avatar
   
Dries Buytaert committed
314
315
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
316
  // Create HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
317
  $defaults = array(
Dries Buytaert's avatar
   
Dries Buytaert committed
318
    'Host' => 'Host: '. $uri['host'],
319
320
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
321
322
323
  );

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

Dries Buytaert's avatar
   
Dries Buytaert committed
327
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
328
329
330
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries Buytaert's avatar
   
Dries Buytaert committed
331
    $request .= $data ."\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
332
333
334
335
336
337
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
338
  $response = '';
339
  while (!feof($fp) && $data = fread($fp, 1024)) {
340
    $response .= $data;
Dries Buytaert's avatar
   
Dries Buytaert committed
341
342
343
344
  }
  fclose($fp);

  // Parse response.
345
346
347
348
  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
349
350
351
  $result->headers = array();

  // Parse headers.
352
  while ($line = trim(array_shift($headers))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
353
354
355
356
357
358
359
360
361
362
363
364
    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
365
  // the base code in their class.
Dries Buytaert's avatar
   
Dries Buytaert committed
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
  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
393
394
395
/**
 * @} End of "HTTP handling".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
396

Dries Buytaert's avatar
   
Dries Buytaert committed
397
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
398
399
400
401
 * 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
402
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
403
function error_handler($errno, $message, $filename, $line) {
404
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
405
406
    $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
407

Dries Buytaert's avatar
   
Dries Buytaert committed
408
    if (variable_get('error_level', 1) == 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
409
      print '<pre>'. $entry .'</pre>';
Dries Buytaert's avatar
Dries Buytaert committed
410
    }
411
412

    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
413
414
415
  }
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
425
426
427
428
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
429
430
function fix_gpc_magic() {
  static $fixed = false;
Dries Buytaert's avatar
   
Dries Buytaert committed
431
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries Buytaert's avatar
Dries Buytaert committed
432
433
434
435
436
437
    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
438
439
}

440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
/**
 * 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;
}

472
473
474
/**
 * @name Conversion
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
475
 * Converts data structures to different types.
476
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
477
478
479
480

/**
 * Convert an associative array to an anonymous object.
 */
Dries Buytaert's avatar
Dries Buytaert committed
481
482
function array2object($array) {
  if (is_array($array)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
483
    $object = new StdClass();
Dries Buytaert's avatar
Dries Buytaert committed
484
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
485
486
487
488
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
489
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
490
491
492
493
494
  }

  return $object;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
495
496
497
/**
 * Convert an object to an associative array.
 */
Dries Buytaert's avatar
Dries Buytaert committed
498
499
500
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
501
502
503
504
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
505
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
506
507
508
509
  }

  return $array;
}
Dries Buytaert's avatar
   
Dries Buytaert committed
510
511
512
513

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

515
516
517
/**
 * @name Messages
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
518
 * Frequently used messages.
519
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
520
521
522
523
524
525
526

/**
 * 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
527
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
528
  return t('You are not authorized to access this page.');
Dries Buytaert's avatar
   
Dries Buytaert committed
529
530
}

Dries Buytaert's avatar
   
Dries Buytaert committed
531
532
533
/**
 * Return a string with a "not applicable" message.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
534
function message_na() {
Dries Buytaert's avatar
   
Dries Buytaert committed
535
  return t('n/a');
Dries Buytaert's avatar
   
Dries Buytaert committed
536
537
}

Dries Buytaert's avatar
   
Dries Buytaert committed
538
539
540
/**
 * @} End of "Messages".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
541

Dries Buytaert's avatar
   
Dries Buytaert committed
542
543
544
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
545
546
function locale_initialize() {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
547
548
549
550
551

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

Dries Buytaert's avatar
   
Dries Buytaert committed
552
553
554
555
556
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
557
558
559
    // 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
560
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
561
562
563
564
565
566
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
567
568
}

569
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
570
 * Translate strings to the current locale.
571
 *
572
 * When using t(), try to put entire sentences and strings in one t() call.
Dries Buytaert's avatar
   
Dries Buytaert committed
573
574
575
576
 * 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
577
578
579
 *   $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
580
 * @endcode
581
582
583
 * 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.
584
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
585
 * @param $string
Dries Buytaert's avatar
   
Dries Buytaert committed
586
 *   A string containing the English string to translate.
Dries Buytaert's avatar
   
Dries Buytaert committed
587
588
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries Buytaert's avatar
   
Dries Buytaert committed
589
 *   of any key in this array are replaced with the corresponding value.
Dries Buytaert's avatar
   
Dries Buytaert committed
590
591
 * @return
 *   The translated string.
592
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
593
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
594
595
596
597
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
598

Dries Buytaert's avatar
   
Dries Buytaert committed
599
600
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
601
602
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
603
604
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
605
606
}

Dries Buytaert's avatar
   
Dries Buytaert committed
607
/**
608
 * Encode special characters in a plain-text string for display as HTML.
Dries Buytaert's avatar
   
Dries Buytaert committed
609
 */
610
611
function check_plain($text) {
  return htmlspecialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
612
613
}

614
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
615
 * @defgroup validation Input validation
Dries Buytaert's avatar
   
Dries Buytaert committed
616
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
617
 * Functions to validate user input.
618
619
 */

620
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
621
622
623
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
624
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
625
626
 * @param $mail
 *   A string containing an email address.
Dries Buytaert's avatar
   
Dries Buytaert committed
627
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
628
 *   TRUE if the address is in a valid format.
629
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
630
function valid_email_address($mail) {
631
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
632
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
633
634
635
  $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
636
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
637
638
}

Dries Buytaert's avatar
   
Dries Buytaert committed
639
640
641
/**
 * Verify the syntax of the given URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
642
 * @param $url
Dries Buytaert's avatar
   
Dries Buytaert committed
643
 *   The URL to verify.
Dries Buytaert's avatar
   
Dries Buytaert committed
644
 * @param $absolute
Dries Buytaert's avatar
   
Dries Buytaert committed
645
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries Buytaert's avatar
   
Dries Buytaert committed
646
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
647
 *   TRUE if the URL is in a valid format.
Dries Buytaert's avatar
   
Dries Buytaert committed
648
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
649
function valid_url($url, $absolute = FALSE) {
650
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
651
  if ($absolute) {
652
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
653
654
  }
  else {
655
    return preg_match("/^". $allowed_characters ."+$/i", $url);
656
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
657
658
}

Dries Buytaert's avatar
   
Dries Buytaert committed
659
660
661
662
663
664
665
666
667
668
/**
 * 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.
 */
669
670
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
671
    // Form data can contain a number of nested arrays.
672
    foreach ($data as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
673
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
674
        return FALSE;
675
676
677
      }
    }
  }
678
  else if (isset($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
679
    // Detect dangerous input data.
680

681
682
683
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries Buytaert's avatar
   
Dries Buytaert committed
684
685
686
687
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
688

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

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

    if ($match) {
696
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => theme('placeholder', $data))));
Dries Buytaert's avatar
   
Dries Buytaert committed
697
      return FALSE;
698
699
700
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
701
  return TRUE;
702
}
Dries Buytaert's avatar
   
Dries Buytaert committed
703
704
705
/**
 * @} End of "defgroup validation".
 */
706

Dries Buytaert's avatar
   
Dries Buytaert committed
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
/**
 * 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);
}

734
735
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
736
737
}

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

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

Dries Buytaert's avatar
Dries Buytaert committed
752
  $output = "<channel>\n";
753
754
755
756
  $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
757
  foreach ($args as $key => $value) {
758
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
759
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
760
761
762
763
764
765
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
766
767
768
769
770
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
771
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
772
  $output = "<item>\n";
773
774
775
  $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
776
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
    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 {
793
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
794
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
795
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
796
797
798
799
800
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
801
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
802
 * Format a string containing a count of items.
Dries Buytaert's avatar
   
Dries Buytaert committed
803
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 * 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
818
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
819
function format_plural($count, $singular, $plural) {
820
  if ($count == 1) return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
821
822

  // get the plural index through the gettext formula
823
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries Buytaert's avatar
   
Dries Buytaert committed
824
825
826
827
828
829
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
830
        return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
831
832
833
834
835
836
      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
837
838
}

Dries Buytaert's avatar
   
Dries Buytaert committed
839
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
840
 * Generate a string representation for the given byte count.
Dries Buytaert's avatar
   
Dries Buytaert committed
841
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
844
845
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries Buytaert's avatar
   
Dries Buytaert committed
846
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
847
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
848
  $suffix = t('bytes');
849
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
850
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
851
    $suffix = t('KB');
Dries Buytaert's avatar
   
Dries Buytaert committed
852
  }
853
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
854
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
855
    $suffix = t('MB');
Dries Buytaert's avatar
   
Dries Buytaert committed
856
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
857
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
858
859
}

Dries Buytaert's avatar
   
Dries Buytaert committed
860
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
861
 * Format a time interval with the requested granularity.
Dries Buytaert's avatar
   
Dries Buytaert committed
862
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
863
864
865
866
867
868
 * @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
869
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
870
function format_interval($timestamp, $granularity = 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
871
  $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
872
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
873
  foreach ($units as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
874
    $key = explode('|', $key);
Dries Buytaert's avatar
   
Dries Buytaert committed
875
    if ($timestamp >= $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
876
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries Buytaert's avatar
   
Dries Buytaert committed
877
      $timestamp %= $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
878
879
880
881
882
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
883
884
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
885
  return $output ? $output : t('0 sec');
Dries Buytaert's avatar
   
Dries Buytaert committed
886
887
}

Dries Buytaert's avatar
   
Dries Buytaert committed
888
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
889
890
 * Format a date with the given configured format or a custom format string.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
891
892
893
894
 * 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
895
896
897
898
899
900
 * @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
901
902
903
 *   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
904
905
906
907
 * @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
908
 */
909
910
911
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
912
913
914
915
916
917
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
918
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
919

920
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
921
922

  switch ($type) {
923
924
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
925
      break;
926
927
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
928
      break;
929
    case 'custom':
Dries Buytaert's avatar
   
Dries Buytaert committed
930
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
931
      break;
932
    case 'medium':
Dries Buytaert's avatar
   
Dries Buytaert committed
933
    default:
934
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
935
936
  }

937
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
938
  $date = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
939
940
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
941
    if (strpos('AaDFlM', $c) !== false) {
942
      $date .= t(gmdate($c, $timestamp));
943
    }
944
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
945
946
947
948
      $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
949
    }
950
951
952
953
954
    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
955
    }
956
957
958
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
959
    else {
960
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed
961
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
962
  }
963

Dries Buytaert's avatar
   
Dries Buytaert committed
964
965
966
  return $date;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
967
968
969
/**
 * @} End of "defgroup format".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
970

971
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
972
 * @defgroup form Form generation
973
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
974
 * Functions to enable output of HTML forms and form elements.
975
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
976
977
 * Drupal uses these functions to achieve consistency in its form presentation,
 * while at the same time simplifying code and reducing the amount of HTML that
978
 * must be explicitly generated by modules.
979
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995

/**
 * Generate a form from a set of form elements.
 *
 * @param $form
 *   An HTML string containing one or more form elements.
 * @param $method
 *   The query method to use ("post" or "get").
 * @param $action
 *   The URL to send the form contents to, if not the current page.
 * @param $attributes
 *   An associative array of attributes to add to the form tag.
 * @result
 *   An HTML string with the contents of $form wrapped in a form tag.
 */
function form($form, $method = 'post', $action = NULL, $attributes = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
996
  if (!$action) {
997
    $action = request_uri();
Dries Buytaert's avatar
   
Dries Buytaert committed
998
  }
999
  // Anonymous div to satisfy XHTML compliancy.
1000
  return '<form action="'. check_url($action) .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n<div>". $form ."\n</div></form>\n";
For faster browsing, not all history is shown. View entire blame