common.inc 59.6 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.
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
12
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
13
 * Set the breadcrumb trail for the current page.
Dries Buytaert's avatar
   
Dries Buytaert committed
14
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
15
16
17
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
18
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
19
20
21
22
23
24
25
26
27
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
28
29
30
/**
 * Get the breadcrumb trail for the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
31
32
33
34
35
36
37
38
39
40
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
41
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
42
 * Add output to the head tag of the HTML page.
Dries Buytaert's avatar
   
Dries Buytaert committed
43
 * This function can be called as long the headers aren't sent.
Dries Buytaert's avatar
Dries Buytaert committed
44
45
 */
function drupal_set_html_head($data = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
46
  static $stored_head = '';
Dries Buytaert's avatar
Dries Buytaert committed
47
48

  if (!is_null($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
49
    $stored_head .= $data ."\n";
Dries Buytaert's avatar
Dries Buytaert committed
50
51
52
53
  }
  return $stored_head;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
54
55
56
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
57
58
59
function drupal_get_html_head() {
  global $base_url;

Dries Buytaert's avatar
   
Dries Buytaert committed
60
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries Buytaert's avatar
Dries Buytaert committed
61
  $output .= "<base href=\"$base_url/\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
62
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries Buytaert's avatar
Dries Buytaert committed
63
64
65
66

  return $output . drupal_set_html_head();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
67
68
69
/**
 * Regenerate the path map from the information in the database.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
70
function drupal_rebuild_path_map() {
Dries Buytaert's avatar
   
Dries Buytaert committed
71
  drupal_get_path_map('rebuild');
Dries Buytaert's avatar
   
Dries Buytaert committed
72
}
73

Dries Buytaert's avatar
   
Dries Buytaert committed
74
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
75
 * Given a path alias, return the internal path it represents.
Dries Buytaert's avatar
   
Dries Buytaert committed
76
77
78
79
80
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
81
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
82
83
84
85
86
87
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
88

Dries Buytaert's avatar
Dries Buytaert committed
89
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
90
 * Set an HTTP response header for the current page.
Dries Buytaert's avatar
Dries Buytaert committed
91
92
 */
function drupal_set_header($header = NULL) {
93
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries Buytaert's avatar
   
Dries Buytaert committed
94
  // Otherwise, header('') could get called when serving the page later, which
95
96
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries Buytaert's avatar
Dries Buytaert committed
97

98
  if (strlen($header)) {
Dries Buytaert's avatar
Dries Buytaert committed
99
    header($header);
100
    $stored_headers[] = $header;
Dries Buytaert's avatar
Dries Buytaert committed
101
  }
102
  return implode("\n", $stored_headers);
Dries Buytaert's avatar
Dries Buytaert committed
103
104
}

Dries Buytaert's avatar
   
Dries Buytaert committed
105
106
107
/**
 * Get the HTTP response headers for the current page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
108
109
110
111
function drupal_get_headers() {
  return drupal_set_header();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
112
113
114
/**
 * @name HTTP handling
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
115
 * Functions to properly handle HTTP responses.
Dries Buytaert's avatar
   
Dries Buytaert committed
116
117
 */

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/**
 * Prepare a destination query string for use in combination with
 * drupal_goto().  Used to direct the user back to the referring page
 * after completing a form.
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
  $destination[] = $_GET['q'];
  $params = array('from', 'sort', 'order');
  foreach ($params as $param) {
    if (isset($_GET[$param])) {
      $destination[] = "$param=". $_GET[$param];
    }
  }
  return 'destination='. urlencode(implode('&', $destination));
}

136
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
137
 * Send the user to a different Drupal page.
138
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
139
140
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
141
 *
142
143
144
145
146
147
148
149
150
151
 * 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
152
153
154
155
156
157
158
159
160
161
162
163
164
 * 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).
165
166
 *
 * @see drupal_get_destination()
167
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
168
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
169
170
171
172
173
174
175
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
176
177
  // Translate &amp; to simply & in the absolute URL.
  $url = str_replace('&amp;', '&', url($path, $query, $fragment, TRUE));
178

Dries Buytaert's avatar
   
Dries Buytaert committed
179
180
  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
181

Dries Buytaert's avatar
   
Dries Buytaert committed
182
183
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
184
185
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
186
      $url = $url .'?'. $sid;
187
188
189
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
190
191
192
193
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries Buytaert's avatar
   
Dries Buytaert committed
195
196
197
  // 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.
198
199
200
201
202
203
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
204
function drupal_not_found() {
Dries Buytaert's avatar
   
Dries Buytaert committed
205
  header('HTTP/1.0 404 Not Found');
206
  watchdog('page not found', t('%page not found.', array('%page' => '<em>'. db_escape_string($_GET['q']) .'</em>')), WATCHDOG_WARNING);
Dries Buytaert's avatar
   
Dries Buytaert committed
207
208

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
209
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
210
211
  if ($path) {
    menu_set_active_item($path);
Dries Buytaert's avatar
   
Dries Buytaert committed
212
    $status = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
213
214
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
215
  if ($status != MENU_FOUND) {
216
217
    drupal_set_title(t('Page not found'));
    print theme('page', '');
Dries Buytaert's avatar
   
Dries Buytaert committed
218
219
  }
}
Dries Buytaert's avatar
   
Dries Buytaert committed
220

Dries Buytaert's avatar
   
Dries Buytaert committed
221
222
223
224
225
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
Dries Buytaert's avatar
   
Dries Buytaert committed
226
  watchdog('access denied', t('%page denied access.', array('%page' => '<em>'. db_escape_string($_GET['q']) .'</em>')), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries Buytaert's avatar
   
Dries Buytaert committed
227
228

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
229
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
230
231
232
233
234
235
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
236
237
    drupal_set_title(t('Access denied'));
    print theme('page', message_access());
Dries Buytaert's avatar
   
Dries Buytaert committed
238
239
240
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
241
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
242
 * Perform an HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
243
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 * 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
261
262
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries Buytaert's avatar
   
Dries Buytaert committed
263
264
  $result = new StdClass();

Dries Buytaert's avatar
   
Dries Buytaert committed
265
  // Parse the URL, and make sure we can handle the schema.
Dries Buytaert's avatar
   
Dries Buytaert committed
266
267
268
269
270
271
  $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
272
273
      // 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
274
275
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
276
      $result->error = 'invalid schema '. $uri['scheme'];
Dries Buytaert's avatar
   
Dries Buytaert committed
277
278
279
      return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
280
  // Make sure the socket opened properly.
Dries Buytaert's avatar
   
Dries Buytaert committed
281
  if (!$fp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
282
    $result->error = trim($errno .' '. $errstr);
Dries Buytaert's avatar
   
Dries Buytaert committed
283
284
285
    return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
286
  // Construct the path to act on.
Dries Buytaert's avatar
   
Dries Buytaert committed
287
288
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
289
    $path .= '?'. $uri['query'];
Dries Buytaert's avatar
   
Dries Buytaert committed
290
291
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
292
  // Create HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
293
  $defaults = array(
Dries Buytaert's avatar
   
Dries Buytaert committed
294
    'Host' => 'Host: '. $uri['host'],
295
296
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
297
298
299
  );

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

Dries Buytaert's avatar
   
Dries Buytaert committed
303
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
304
305
306
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries Buytaert's avatar
   
Dries Buytaert committed
307
    $request .= $data ."\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
308
309
310
311
312
313
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
314
  $response = '';
315
  while (!feof($fp) && $data = fread($fp, 1024)) {
316
    $response .= $data;
Dries Buytaert's avatar
   
Dries Buytaert committed
317
318
319
320
  }
  fclose($fp);

  // Parse response.
321
322
323
324
  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
325
326
327
  $result->headers = array();

  // Parse headers.
328
  while ($line = trim(array_shift($headers))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
329
330
331
332
333
334
335
336
337
338
339
340
    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
341
  // the base code in their class.
Dries Buytaert's avatar
   
Dries Buytaert committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
  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
369
370
371
/**
 * @} End of "HTTP handling".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
372

Dries Buytaert's avatar
   
Dries Buytaert committed
373
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
374
375
376
377
 * 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
378
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
379
function error_handler($errno, $message, $filename, $line, $variables) {
380
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
381
382
    $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
383

Dries Buytaert's avatar
   
Dries Buytaert committed
384
    if (variable_get('error_level', 1) == 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
385
      print '<pre>'. $entry .'</pre>';
Dries Buytaert's avatar
Dries Buytaert committed
386
    }
387
388

    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
389
390
391
  }
}

Dries Buytaert's avatar
Dries Buytaert committed
392
393
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
394
395
396
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
397
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
398
399
400
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
401
402
403
404
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
405
406
function fix_gpc_magic() {
  static $fixed = false;
Dries Buytaert's avatar
   
Dries Buytaert committed
407
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries Buytaert's avatar
Dries Buytaert committed
408
409
410
411
412
413
    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
414
415
}

416
417
418
/**
 * @name Conversion
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
419
 * Converts data structures to different types.
420
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
421
422
423
424

/**
 * Convert an associative array to an anonymous object.
 */
Dries Buytaert's avatar
Dries Buytaert committed
425
426
function array2object($array) {
  if (is_array($array)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
427
    $object = new StdClass();
Dries Buytaert's avatar
Dries Buytaert committed
428
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
429
430
431
432
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
433
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
434
435
436
437
438
  }

  return $object;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
439
440
441
/**
 * Convert an object to an associative array.
 */
Dries Buytaert's avatar
Dries Buytaert committed
442
443
444
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
445
446
447
448
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
449
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
450
451
452
453
  }

  return $array;
}
Dries Buytaert's avatar
   
Dries Buytaert committed
454
455
456
457

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

459
460
461
/**
 * @name Messages
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
462
 * Frequently used messages.
463
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
464
465
466
467
468
469
470

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

Dries Buytaert's avatar
   
Dries Buytaert committed
475
476
477
/**
 * Return a string with a "not applicable" message.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
478
function message_na() {
Dries Buytaert's avatar
   
Dries Buytaert committed
479
  return t('n/a');
Dries Buytaert's avatar
   
Dries Buytaert committed
480
481
}

Dries Buytaert's avatar
   
Dries Buytaert committed
482
483
484
/**
 * @} End of "Messages".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
485

Dries Buytaert's avatar
   
Dries Buytaert committed
486
487
488
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
489
490
function locale_initialize() {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
491
492
493
494
495

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

Dries Buytaert's avatar
   
Dries Buytaert committed
496
497
498
499
500
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
501
502
503
    // 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
504
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
505
506
507
508
509
510
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
511
512
}

513
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
514
 * Translate strings to the current locale.
515
 *
516
 * When using t(), try to put entire sentences and strings in one t() call.
Dries Buytaert's avatar
   
Dries Buytaert committed
517
518
519
520
 * 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
521
522
523
 *   $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
524
 * @endcode
525
526
527
 * 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.
528
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
529
 * @param $string
Dries Buytaert's avatar
   
Dries Buytaert committed
530
 *   A string containing the English string to translate.
Dries Buytaert's avatar
   
Dries Buytaert committed
531
532
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries Buytaert's avatar
   
Dries Buytaert committed
533
 *   of any key in this array are replaced with the corresponding value.
Dries Buytaert's avatar
   
Dries Buytaert committed
534
535
 * @return
 *   The translated string.
536
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
537
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
538
539
540
541
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
542

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

Dries Buytaert's avatar
   
Dries Buytaert committed
551
552
553
554
555
556
557
558
/**
 * Encode special characters in a string for display as HTML.
 *
 * Note that we'd like to use htmlspecialchars($input, $quotes, 'utf-8')
 * as outlined in the PHP manual, but we can't because there's a bug in
 * PHP < 4.3 that makes it mess up multibyte charsets if we specify the
 * charset. This will be changed later once we make PHP 4.3 a requirement.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
559
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries Buytaert's avatar
   
Dries Buytaert committed
560
  return htmlspecialchars($input, $quotes);
Dries Buytaert's avatar
   
Dries Buytaert committed
561
562
}

563
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
564
 * @defgroup validation Input validation
Dries Buytaert's avatar
   
Dries Buytaert committed
565
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
566
 * Functions to validate user input.
567
568
 */

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

Dries Buytaert's avatar
   
Dries Buytaert committed
588
589
590
/**
 * Verify the syntax of the given URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
591
 * @param $url
Dries Buytaert's avatar
   
Dries Buytaert committed
592
 *   The URL to verify.
Dries Buytaert's avatar
   
Dries Buytaert committed
593
 * @param $absolute
Dries Buytaert's avatar
   
Dries Buytaert committed
594
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries Buytaert's avatar
   
Dries Buytaert committed
595
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
596
 *   TRUE if the URL is in a valid format.
Dries Buytaert's avatar
   
Dries Buytaert committed
597
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
598
function valid_url($url, $absolute = FALSE) {
599
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
600
  if ($absolute) {
601
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
602
603
  }
  else {
604
    return preg_match("/^". $allowed_characters ."+$/i", $url);
605
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
606
607
}

Dries Buytaert's avatar
   
Dries Buytaert committed
608
609
610
611
612
613
614
615
616
617
/**
 * 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.
 */
618
619
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
620
    // Form data can contain a number of nested arrays.
621
    foreach ($data as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
622
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
623
        return FALSE;
624
625
626
      }
    }
  }
627
  else if (isset($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
628
    // Detect dangerous input data.
629

630
631
632
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries Buytaert's avatar
   
Dries Buytaert committed
633
634
635
636
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
637

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

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

    if ($match) {
645
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries Buytaert's avatar
   
Dries Buytaert committed
646
      return FALSE;
647
648
649
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
650
  return TRUE;
651
}
Dries Buytaert's avatar
   
Dries Buytaert committed
652
653
654
/**
 * @} End of "defgroup validation".
 */
655

Dries Buytaert's avatar
   
Dries Buytaert committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
/**
 * 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);
}

Dries Buytaert's avatar
   
Dries Buytaert committed
683
function check_form($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
684
  return drupal_specialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
685
686
}

687
688
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
689
690
}

Dries Buytaert's avatar
   
Dries Buytaert committed
691
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
692
 * @defgroup format Formatting
Dries Buytaert's avatar
   
Dries Buytaert committed
693
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
694
 * Functions to format numbers, strings, dates, etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
695
696
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
697
698
699
700
701
702
/**
 * 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
703
704
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
705
  $output = "<channel>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
706
707
708
709
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= ' <description>'. drupal_specialchars(strip_tags($description)) ."</description>\n";
  $output .= ' <language>'. drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
710
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
711
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
712
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
713
714
715
716
717
718
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
719
720
721
722
723
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
724
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
725
  $output = "<item>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
726
727
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
728
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
729
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
    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 {
      $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
748
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
749
750
751
752
753
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
754
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
755
 * Format a string containing a count of items.
Dries Buytaert's avatar
   
Dries Buytaert committed
756
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 * 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
771
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
772
function format_plural($count, $singular, $plural) {
773
  if ($count == 1) return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
774
775
776
777
778
779
780
781
782

  // get the plural index through the gettext formula
  $index = (function_exists('locale')) ? locale_get_plural($count) : -1;
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
783
        return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
784
785
786
787
788
789
      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
790
791
}

Dries Buytaert's avatar
   
Dries Buytaert committed
792
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
793
 * Generate a string representation for the given byte count.
Dries Buytaert's avatar
   
Dries Buytaert committed
794
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
795
796
797
798
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries Buytaert's avatar
   
Dries Buytaert committed
799
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
800
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
801
  $suffix = t('bytes');
Dries Buytaert's avatar
   
Dries Buytaert committed
802
803
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
804
    $suffix = t('KB');
Dries Buytaert's avatar
   
Dries Buytaert committed
805
806
807
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
808
    $suffix = t('MB');
Dries Buytaert's avatar
   
Dries Buytaert committed
809
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
810
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
811
812
}

Dries Buytaert's avatar
   
Dries Buytaert committed
813
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
814
 * Format a time interval with the requested granularity.
Dries Buytaert's avatar
   
Dries Buytaert committed
815
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
816
817
818
819
820
821
 * @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
822
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
823
function format_interval($timestamp, $granularity = 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
824
  $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
825
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
826
  foreach ($units as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
827
    $key = explode('|', $key);
Dries Buytaert's avatar
   
Dries Buytaert committed
828
    if ($timestamp >= $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
829
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries Buytaert's avatar
   
Dries Buytaert committed
830
      $timestamp %= $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
831
832
833
834
835
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
836
837
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
838
  return $output ? $output : t('0 sec');
Dries Buytaert's avatar
   
Dries Buytaert committed
839
840
}

Dries Buytaert's avatar
   
Dries Buytaert committed
841
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
 * Format a date with the given configured format or a custom format string.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
844
845
846
847
 * 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
848
849
850
851
852
853
 * @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
854
855
856
 *   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
857
858
859
860
 * @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
861
 */
862
863
864
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
865
866
867
868
869
870
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
871
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
872

873
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
874
875

  switch ($type) {
876
877
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
878
      break;
879
880
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
881
      break;
882
    case 'custom':
Dries Buytaert's avatar
   
Dries Buytaert committed
883
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
884
      break;
885
    case 'medium':
Dries Buytaert's avatar
   
Dries Buytaert committed
886
    default:
887
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
888
889
  }

890
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
891
  $date = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
892
893
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
894
    if (strpos('AaDFlM', $c) !== false) {
895
      $date .= t(gmdate($c, $timestamp));
896
    }
897
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
898
899
900
901
      $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
902
    }
903
904
905
906
907
    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
908
    }
909
910
911
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
912
    else {
913
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed
914
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
915
  }
916

Dries Buytaert's avatar
   
Dries Buytaert committed
917
918
919
  return $date;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
920
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
921
 * Format a username.
Dries Buytaert's avatar
   
Dries Buytaert committed
922
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
923
924
925
926
927
 * @param $object
 *   The user object to format, usually returned from user_load().
 * @return
 *   A string containing an HTML link to the user's page if the passed object
 *   suggests that this is a site user. Otherwise, only the username is returned.
Dries Buytaert's avatar
   
Dries Buytaert committed
928
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
929
930
931
function format_name($object) {

  if ($object->uid && $object->name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
932
    // Shorten the name when it is too long or it will break many tables.
933
    if (strlen($object->name) > 20) {
Dries Buytaert's avatar
   
Dries Buytaert committed
934
      $name = truncate_utf8($object->name, 15) .'...';
935
936
937
938
939
    }
    else {
      $name = $object->name;
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
940
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries Buytaert's avatar
   
Dries Buytaert committed
941
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
942
  else if ($object->name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
943
944
945
946
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
Dries Buytaert's avatar
   
Dries Buytaert committed
947
    if ($object->homepage) {
Dries Buytaert's avatar
   
Dries Buytaert committed
948
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries Buytaert's avatar
   
Dries Buytaert committed
949
950
951
952
953
954
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries Buytaert's avatar
   
Dries Buytaert committed
955
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
956
  else {
Dries Buytaert's avatar
Dries Buytaert committed
957
    $output = variable_get('anonymous', 'Anonymous');
Dries Buytaert's avatar
   
Dries Buytaert committed
958
959
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
960
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
961
}
Dries Buytaert's avatar
   
Dries Buytaert committed
962
963
964
/**
 * @} End of "defgroup format".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
965

966
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
967
 * @defgroup form Form generation
968
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
969
 * Functions to enable output of HTML forms and form elements.
970
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
971
972
 * 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
973
 * must be explicitly generated by modules.
974
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990

/**
 * 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
991
  if (!$action) {
992
    $action = request_uri();
Dries Buytaert's avatar
   
Dries Buytaert committed
993
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
994
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
995
996
}

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