common.inc 59.1 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
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
13
 * Set the title of the current page, for display on the page and in the title bar.
Dries Buytaert's avatar
   
Dries Buytaert committed
14
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
15
16
17
18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
19
    $stored_title = $title;
Dries Buytaert's avatar
   
Dries Buytaert committed
20
21
22
23
  }
  return $stored_title;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
24
25
26
/**
 * Get the title of the current page, for display on the page and in the title bar.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
27
28
29
30
31
32
33
34
35
36
37
function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
38
 * Set the breadcrumb trail for the current page.
Dries Buytaert's avatar
   
Dries Buytaert committed
39
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
40
41
42
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
43
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
44
45
46
47
48
49
50
51
52
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
53
54
55
/**
 * Get the breadcrumb trail for the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
56
57
58
59
60
61
62
63
64
65
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
66
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
67
 * Add output to the head tag of the HTML page.
Dries Buytaert's avatar
Dries Buytaert committed
68
69
 */
function drupal_set_html_head($data = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
70
  static $stored_head = '';
Dries Buytaert's avatar
Dries Buytaert committed
71
72

  if (!is_null($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
73
    $stored_head .= $data ."\n";
Dries Buytaert's avatar
Dries Buytaert committed
74
75
76
77
  }
  return $stored_head;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
78
79
80
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries Buytaert's avatar
Dries Buytaert committed
81
82
83
function drupal_get_html_head() {
  global $base_url;

Dries Buytaert's avatar
   
Dries Buytaert committed
84
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries Buytaert's avatar
Dries Buytaert committed
85
  $output .= "<base href=\"$base_url/\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
86
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries Buytaert's avatar
Dries Buytaert committed
87
88
89
90

  return $output . drupal_set_html_head();
}

Dries Buytaert's avatar
   
Dries Buytaert committed
91
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
92
 * Return an array mapping path aliases to their internal Drupal paths.
Dries Buytaert's avatar
   
Dries Buytaert committed
93
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
94
function drupal_get_path_map($action = '') {
Dries Buytaert's avatar
Dries Buytaert committed
95
  static $map = NULL;
Dries Buytaert's avatar
   
Dries Buytaert committed
96

Dries Buytaert's avatar
   
Dries Buytaert committed
97
  if ($action == 'rebuild') {
Dries Buytaert's avatar
   
Dries Buytaert committed
98
99
100
    $map = NULL;
  }

Dries Buytaert's avatar
Dries Buytaert committed
101
  if (is_null($map)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
102
    $map = array();  // Make $map non-null in case no aliases are defined.
Dries Buytaert's avatar
   
Dries Buytaert committed
103
    $result = db_query('SELECT * FROM {url_alias}');
Dries Buytaert's avatar
   
Dries Buytaert committed
104
    while ($data = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
105
      $map[$data->dst] = $data->src;
Dries Buytaert's avatar
   
Dries Buytaert committed
106
107
108
109
110
111
    }
  }

  return $map;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
112
113
114
/**
 * Regenerate the path map from the information in the database.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
115
function drupal_rebuild_path_map() {
Dries Buytaert's avatar
   
Dries Buytaert committed
116
  drupal_get_path_map('rebuild');
Dries Buytaert's avatar
   
Dries Buytaert committed
117
}
118
119

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
120
 * Given an internal Drupal path, return the alias set by the administrator.
121
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
122
123
124
125
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
126
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
127
128
    return conf_url_rewrite($path, 'outgoing');
  }
129
130
131
132
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
133
134
135
}

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
136
 * Given a path alias, return the internal path it represents.
Dries Buytaert's avatar
   
Dries Buytaert committed
137
138
139
140
141
 */
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
142
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
143
144
145
146
147
148
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
149

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

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

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

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

179
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
180
 * Send the user to a different Drupal page.
181
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
182
183
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
184
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
185
186
187
188
189
190
191
192
193
194
195
196
197
 * 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).
198
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
199
200
201
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
  // Translate &amp; to simply & in the absolute URL.
  $url = str_replace('&amp;', '&', url($path, $query, $fragment, TRUE));
202

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

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

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

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

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
239
  if ($status != MENU_FOUND) {
Dries Buytaert's avatar
Dries Buytaert committed
240
    print theme('page', '', t('Page not found'));
Dries Buytaert's avatar
   
Dries Buytaert committed
241
242
  }
}
Dries Buytaert's avatar
   
Dries Buytaert committed
243

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

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

  if ($status != MENU_FOUND) {
    print theme('page', message_access(), t('Access denied'));
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
262
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
263
 * Perform an HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
264
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 * 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
282
283
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries Buytaert's avatar
   
Dries Buytaert committed
284
  // Parse the URL, and make sure we can handle the schema.
Dries Buytaert's avatar
   
Dries Buytaert committed
285
286
287
288
289
290
  $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
291
292
      // 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
293
294
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
295
      $result->error = 'invalid schema '. $uri['scheme'];
Dries Buytaert's avatar
   
Dries Buytaert committed
296
297
298
      return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
299
  // Make sure the socket opened properly.
Dries Buytaert's avatar
   
Dries Buytaert committed
300
  if (!$fp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
301
    $result->error = trim($errno .' '. $errstr);
Dries Buytaert's avatar
   
Dries Buytaert committed
302
303
304
    return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
305
  // Construct the path to act on.
Dries Buytaert's avatar
   
Dries Buytaert committed
306
307
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
308
    $path .= '?'. $uri['query'];
Dries Buytaert's avatar
   
Dries Buytaert committed
309
310
  }

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
322
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
323
324
325
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries Buytaert's avatar
   
Dries Buytaert committed
326
    $request .= $data ."\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
327
328
329
330
331
332
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
333
  $response = '';
334
  while (!feof($fp) && $data = fread($fp, 1024)) {
335
    $response .= $data;
Dries Buytaert's avatar
   
Dries Buytaert committed
336
337
338
339
  }
  fclose($fp);

  // Parse response.
340
341
342
343
  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
344
345
346
  $result->headers = array();

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

Dries Buytaert's avatar
   
Dries Buytaert committed
392
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
393
394
395
396
 * 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
397
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
398
function error_handler($errno, $message, $filename, $line, $variables) {
Dries Buytaert's avatar
   
Dries Buytaert committed
399
400
401
  if ($errno & E_ALL ^ E_NOTICE) {
    $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
402

403
    watchdog('error', t('%error: %message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)));
Dries Buytaert's avatar
   
Dries Buytaert committed
404
405

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

Dries Buytaert's avatar
Dries Buytaert committed
411
412
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
413
414
415
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
416
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
417
418
419
  }
}

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

435
436
437
/**
 * @name Conversion
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
438
 * Converts data structures to different types.
439
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
440
441
442
443

/**
 * Convert an associative array to an anonymous object.
 */
Dries Buytaert's avatar
Dries Buytaert committed
444
445
function array2object($array) {
  if (is_array($array)) {
446
    $object = new stdClass();
Dries Buytaert's avatar
Dries Buytaert committed
447
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
448
449
450
451
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
452
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
453
454
455
456
457
  }

  return $object;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
458
459
460
/**
 * Convert an object to an associative array.
 */
Dries Buytaert's avatar
Dries Buytaert committed
461
462
463
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
464
465
466
467
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
468
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
469
470
471
472
  }

  return $array;
}
Dries Buytaert's avatar
   
Dries Buytaert committed
473
474
475
476

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

478
479
480
/**
 * @name Messages
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
481
 * Frequently used messages.
482
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
483
484
485
486
487
488
489

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

Dries Buytaert's avatar
   
Dries Buytaert committed
494
495
496
/**
 * Return a string with a "not applicable" message.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
497
function message_na() {
Dries Buytaert's avatar
   
Dries Buytaert committed
498
  return t('n/a');
Dries Buytaert's avatar
   
Dries Buytaert committed
499
500
}

Dries Buytaert's avatar
   
Dries Buytaert committed
501
502
503
/**
 * @} End of "Messages".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
504

Dries Buytaert's avatar
   
Dries Buytaert committed
505
506
507
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
508
509
function locale_initialize() {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
510
511
512
513
514

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

Dries Buytaert's avatar
   
Dries Buytaert committed
515
516
517
518
519
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
520
521
522
    // 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
523
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
524
525
526
527
528
529
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
530
531
}

532
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
533
 * Translate strings to the current locale.
534
 *
535
 * When using t(), try to put entire sentences and strings in one t() call.
Dries Buytaert's avatar
   
Dries Buytaert committed
536
537
538
539
 * 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
540
541
542
 *   $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
543
 * @endcode
544
545
546
 * 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.
547
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
548
 * @param $string
Dries Buytaert's avatar
   
Dries Buytaert committed
549
 *   A string containing the English string to translate.
Dries Buytaert's avatar
   
Dries Buytaert committed
550
551
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries Buytaert's avatar
   
Dries Buytaert committed
552
 *   of any key in this array are replaced with the corresponding value.
Dries Buytaert's avatar
   
Dries Buytaert committed
553
554
 * @return
 *   The translated string.
555
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
556
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
557
558
559
560
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
561

Dries Buytaert's avatar
   
Dries Buytaert committed
562
563
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
564
565
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
566
567
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
568
569
}

Dries Buytaert's avatar
   
Dries Buytaert committed
570
571
572
573
574
575
576
577
/**
 * 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
578
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries Buytaert's avatar
   
Dries Buytaert committed
579
  return htmlspecialchars($input, $quotes);
Dries Buytaert's avatar
   
Dries Buytaert committed
580
581
}

582
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
583
 * @defgroup validation Input validation
Dries Buytaert's avatar
   
Dries Buytaert committed
584
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
585
 * Functions to validate user input.
586
587
 */

588
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
589
590
591
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
592
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
593
594
 * @param $mail
 *   A string containing an email address.
Dries Buytaert's avatar
   
Dries Buytaert committed
595
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
596
 *   TRUE if the address is in a valid format.
597
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
598
function valid_email_address($mail) {
599
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
600
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
601
602
603
  $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
604
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
605
606
}

Dries Buytaert's avatar
   
Dries Buytaert committed
607
608
609
/**
 * Verify the syntax of the given URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
610
 * @param $url
Dries Buytaert's avatar
   
Dries Buytaert committed
611
 *   The URL to verify.
Dries Buytaert's avatar
   
Dries Buytaert committed
612
 * @param $absolute
Dries Buytaert's avatar
   
Dries Buytaert committed
613
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries Buytaert's avatar
   
Dries Buytaert committed
614
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
615
 *   TRUE if the URL is in a valid format.
Dries Buytaert's avatar
   
Dries Buytaert committed
616
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
617
function valid_url($url, $absolute = FALSE) {
618
  if ($absolute) {
Dries Buytaert's avatar
   
Dries Buytaert committed
619
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&%]+$/i", $url);
620
621
  }
  else {
622
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
623
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
624
625
}

Dries Buytaert's avatar
   
Dries Buytaert committed
626
627
628
629
630
631
632
633
634
635
/**
 * 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.
 */
636
637
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
638
    // Form data can contain a number of nested arrays.
639
    foreach ($data as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
640
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
641
        return FALSE;
642
643
644
645
      }
    }
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
646
    // Detect dangerous input data.
647

Dries Buytaert's avatar
   
Dries Buytaert committed
648
649
650
651
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
652

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

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

    if ($match) {
Dries Buytaert's avatar
   
Dries Buytaert committed
660
      watchdog('warning', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries Buytaert's avatar
   
Dries Buytaert committed
661
      return FALSE;
662
663
664
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
665
  return TRUE;
666
}
Dries Buytaert's avatar
   
Dries Buytaert committed
667
668
669
/**
 * @} End of "defgroup validation".
 */
670
671
672
673

/**
 * @defgroup search Search interface
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
674
675
676
677
678
 * The Drupal search interface manages a global search mechanism.
 *
 * Modules may plug into this system to provide searches of different types of
 * data. Most of the system is handled by search.module, so this must be enabled
 * for all of the search features to work.
679
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
680

Kjartan Mannes's avatar
Kjartan Mannes committed
681
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
682
683
684
685
 * Format a single result entry of a search query.
 *
 * Modules may implement hook_search_item() in order to override this default
 * function to display search results.
Kjartan Mannes's avatar
Kjartan Mannes committed
686
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
687
688
689
690
691
 * @param $item
 *   A single search result as returned by hook_search(). The result should be
 *   an array with keys "count", "link", "title", "user", "date", and "keywords".
 * @param $type
 *   The type of item found, such as "user" or "comment".
Kjartan Mannes's avatar
Kjartan Mannes committed
692
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
693
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
694
695
  if (module_hook($type, 'search_item')) {
    $output = module_invoke($type, 'search_item', $item);
Dries Buytaert's avatar
   
Dries Buytaert committed
696
697
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
698
699
    $output = ' <dt class="title"><a href="'. $item['link'] .'">'. $item['title'] .'</a></dt>';
    $output .= ' <dd class="small">' . t($type) . ($item['user'] ? ' - '. $item['user'] : '') .''. ($item['date'] ? ' - '. format_date($item['date'], 'small') : '') .'</dd>';
Dries Buytaert's avatar
   
Dries Buytaert committed
700
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
701
702
703
704

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
705
706
707
/**
 * Render a generic search form.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
708
709
710
711
 * This form must be usable not only within "http://example.com/search", but also
 * as a simple search box (without "Restrict search to", help text, etc.), in the
 * theme's header, and so forth. This means we must provide options to
 * conditionally render certain parts of this form.
Kjartan Mannes's avatar
Kjartan Mannes committed
712
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
713
714
715
716
717
718
719
720
721
 * @param $action
 *   Form action. Defaults to "search".
 * @param $keys
 *   The search string entered by the user, containing keywords for the search.
 * @param $options
 *   Whether to render the optional form fields and text ("Restrict search
 *   to", help text, etc.).
 * @return
 *   An HTML string containing the search form.
Kjartan Mannes's avatar
Kjartan Mannes committed
722
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
723
function search_form($action = '', $keys = '', $options = FALSE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
724
725
  $edit = $_POST['edit'];

Dries Buytaert's avatar
   
Dries Buytaert committed
726
  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
727
    $action = url('search');
Dries Buytaert's avatar
   
Dries Buytaert committed
728
729
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
730
731
  $output = ' <div class="search-form"><br /><input type="text" class="form-text" size="50" value="'. check_form($keys) .'" name="keys" />';
  $output .= ' <input type="submit" class="form-submit" value="'. t('Search') ."\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
732

Dries Buytaert's avatar
Dries Buytaert committed
733
  if ($options) {
Dries Buytaert's avatar
   
Dries Buytaert committed
734
735
    $output .= '<br />';
    $output .= t('Restrict search to') .': ';
Dries Buytaert's avatar
   
Dries Buytaert committed
736
737

    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
738
739
      if (module_hook($name, 'search')) {
        $output .= ' <input type="checkbox" name="edit[type]['. $name .']" '. ($edit['type'][$name] ? ' checked="checked"' : '') .' /> '. t($name);
Dries Buytaert's avatar
   
Dries Buytaert committed
740
741
742
      }
    }
  }
743
  $output .= '</div>';
Dries Buytaert's avatar
   
Dries Buytaert committed
744

Dries Buytaert's avatar
   
Dries Buytaert committed
745
  return form($output, 'post', $action);
Dries Buytaert's avatar
   
Dries Buytaert committed
746
747
}

Dries Buytaert's avatar
   
Dries Buytaert committed
748
749
/**
 * Perform a global search on the given keys, and return the formatted results.
Kjartan Mannes's avatar
Kjartan Mannes committed
750
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
751
function search_data($keys = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
752
  $edit = $_POST['edit'];
Dries Buytaert's avatar
   
Dries Buytaert committed
753
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
754

Dries Buytaert's avatar
   
Dries Buytaert committed
755
  if (isset($keys)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
756
    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
757
758
      if (module_hook($name, 'search') && (!$edit['type'] || $edit['type'][$name])) {
        list($title, $results) = module_invoke($name, 'search', $keys);
Dries Buytaert's avatar
   
Dries Buytaert committed
759
        if ($results) {
Dries Buytaert's avatar
   
Dries Buytaert committed
760
761
          $output .= '<h2>'. $title .'</h2>';
          $output .= '<dl class="search-results">';
Dries Buytaert's avatar
   
Dries Buytaert committed
762
763
764
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
Dries Buytaert's avatar
   
Dries Buytaert committed
765
          $output .= '</dl>';
Dries Buytaert's avatar
   
Dries Buytaert committed
766
767
768
769
770
771
772
773
        }
      }
    }
  }

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
774
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
775
 * Display a search form for a particular type of data.
Kjartan Mannes's avatar
Kjartan Mannes committed
776
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
777
778
779
780
781
782
783
784
785
786
787
 * @param $type
 *   The type of content to search within.
 * @param $action
 *   Form action. Defaults to "search".
 * @param $keys
 *   The search string entered by the user, containing keywords for the search.
 * @param $options
 *   Whether to render the optional form fields and text ("Restrict search
 *   to", help text, etc.).
 * @return
 *   An HTML string containing the search form and results.
Kjartan Mannes's avatar
Kjartan Mannes committed
788
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
789
function search_type($type, $action = '', $keys = '', $options = FALSE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
790
  $_POST['edit']['type'][$type] = 'on';
Dries Buytaert's avatar
   
Dries Buytaert committed
791

Dries Buytaert's avatar
   
Dries Buytaert committed
792
  return search_form($action, $keys, $options) . '<br />'. search_data($keys);
Dries Buytaert's avatar
   
Dries Buytaert committed
793
}
794
795

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
796
 * @} End of "defgroup search".
797
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
798

Dries Buytaert's avatar
   
Dries Buytaert committed
799
function check_form($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
800
  return drupal_specialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
801
802
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
807
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
808
 * @defgroup format Formatting
Dries Buytaert's avatar
   
Dries Buytaert committed
809
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
810
 * Functions to format numbers, strings, dates, etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
811
812
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
813
814
815
816
817
818
/**
 * 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
819
820
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
821
  $output = "<channel>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
822
823
824
825
  $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
826
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
827
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
828
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
829
830
831
832
833
834
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
835
836
837
838
839
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
840
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
841
  $output = "<item>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
844
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
845
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
846
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
847
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
848
849
850
851
852
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
853
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
854
 * Format a string containing a count of items.
Dries Buytaert's avatar
   
Dries Buytaert committed
855
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 * 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
870
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
871
function format_plural($count, $singular, $plural) {
Dries Buytaert's avatar
   
Dries Buytaert committed
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
  if ($count == 1) return t($singular);

  // 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":
        return t($singular);
      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
889
890
}

Dries Buytaert's avatar
   
Dries Buytaert committed
891
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
892
 * Generate a string representation for the given byte count.
Dries Buytaert's avatar
   
Dries Buytaert committed
893
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
894
895
896
897
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries Buytaert's avatar
   
Dries Buytaert committed
898
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
899
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
900
  $suffix = t('bytes');
Dries Buytaert's avatar
   
Dries Buytaert committed
901
902
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
903
    $suffix = t('KB');
Dries Buytaert's avatar
   
Dries Buytaert committed
904
905
906
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
907
    $suffix = t('MB');
Dries Buytaert's avatar
   
Dries Buytaert committed
908
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
909
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
910
911
}

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

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
935
936
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
937
  return $output ? $output : t('0 sec');
Dries Buytaert's avatar
   
Dries Buytaert committed
938
939
}

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

970
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
971
972

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

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