common.inc 54.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
12
/**
 * @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.
 */

13
14
/**
 * @name Page title
Dries Buytaert's avatar
   
Dries Buytaert committed
15
16
17
18
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
19
20
21
22
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
23
    $stored_title = ucfirst($title);
Dries Buytaert's avatar
   
Dries Buytaert committed
24
25
26
27
28
29
30
31
32
33
34
35
36
  }
  return $stored_title;
}

function drupal_get_title() {
  $title = drupal_set_title();

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

  return $title;
}
37
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
38
39

/**
40
 * @name Page breadcrumbs
Dries Buytaert's avatar
   
Dries Buytaert committed
41
42
43
44
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
45
46
47
48
49

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}
68
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
69

Dries Buytaert's avatar
Dries Buytaert committed
70
71
72
73
74
75
76
77
/**
 * @name HTML head contents
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
78
  static $stored_head = '';
Dries Buytaert's avatar
Dries Buytaert committed
79
80

  if (!is_null($data)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
81
    $stored_head .= $data ."\n";
Dries Buytaert's avatar
Dries Buytaert committed
82
83
84
85
86
87
88
  }
  return $stored_head;
}

function drupal_get_html_head() {
  global $base_url;

Dries Buytaert's avatar
   
Dries Buytaert committed
89
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries Buytaert's avatar
Dries Buytaert committed
90
  $output .= "<base href=\"$base_url/\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
91
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries Buytaert's avatar
Dries Buytaert committed
92
93
94
95
96
97
98
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

  return $output . drupal_set_html_head();
}
/* @} */

Dries Buytaert's avatar
   
Dries Buytaert committed
99
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
100
 * @name URL path alias
101
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
102
 * Functions to handle path aliases.
Dries Buytaert's avatar
   
Dries Buytaert committed
103
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
104
105

function drupal_get_path_map($action = '') {
Dries Buytaert's avatar
Dries Buytaert committed
106
  static $map = NULL;
Dries Buytaert's avatar
   
Dries Buytaert committed
107

Dries Buytaert's avatar
   
Dries Buytaert committed
108
  if ($action == 'rebuild') {
Dries Buytaert's avatar
   
Dries Buytaert committed
109
110
111
    $map = NULL;
  }

Dries Buytaert's avatar
Dries Buytaert committed
112
  if (is_null($map)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
113
    $map = array();  // make $map non-null in case no aliases are defined
Dries Buytaert's avatar
   
Dries Buytaert committed
114
    $result = db_query('SELECT * FROM {url_alias}');
Dries Buytaert's avatar
   
Dries Buytaert committed
115
    while ($data = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
116
      $map[$data->dst] = $data->src;
Dries Buytaert's avatar
   
Dries Buytaert committed
117
118
119
120
121
122
    }
  }

  return $map;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
123
function drupal_rebuild_path_map() {
Dries Buytaert's avatar
   
Dries Buytaert committed
124
  drupal_get_path_map('rebuild');
Dries Buytaert's avatar
   
Dries Buytaert committed
125
}
126
127

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
128
 * Given an internal Drupal path, return the alias set by the administrator.
129
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
130
131
132
133
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
134
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
135
136
    return conf_url_rewrite($path, 'outgoing');
  }
137
138
139
140
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
141
142
143
}

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
144
 * Given a path alias, return the internal path it represents.
Dries Buytaert's avatar
   
Dries Buytaert committed
145
146
147
148
149
 */
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
150
  elseif (function_exists('conf_url_rewrite')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
151
152
153
154
155
156
157
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
/* @} */
158

Dries Buytaert's avatar
Dries Buytaert committed
159
160
161
162
163
164
165
/**
 * @name HTTP headers
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
166
  static $stored_headers = '';
Dries Buytaert's avatar
Dries Buytaert committed
167
168
169

  if (!is_null($header)) {
    header($header);
Dries Buytaert's avatar
   
Dries Buytaert committed
170
    $stored_headers .= $header ."\n";
Dries Buytaert's avatar
Dries Buytaert committed
171
172
173
174
175
176
177
178
179
  }
  return $stored_headers;
}

function drupal_get_headers() {
  return drupal_set_header();
}
/* @} */

Dries Buytaert's avatar
   
Dries Buytaert committed
180
181
182
183
184
185
186
/**
 * @name HTTP handling
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

187
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
188
 * Send the user to a different Drupal page.
189
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
190
191
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
192
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
193
194
195
196
197
198
199
200
201
202
203
204
205
 * 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).
206
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
207
208
209
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));
210

Dries Buytaert's avatar
   
Dries Buytaert committed
211
212
  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
213

Dries Buytaert's avatar
   
Dries Buytaert committed
214
215
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
216
217
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
218
      $url = $url .'?'. $sid;
219
220
221
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
222
223
224
225
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries Buytaert's avatar
   
Dries Buytaert committed
227
228
229
  // 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.
230
231
232
233
234
235
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
236
function drupal_not_found() {
Dries Buytaert's avatar
   
Dries Buytaert committed
237
  header('HTTP/1.0 404 Not Found');
Dries Buytaert's avatar
   
Dries Buytaert committed
238
  watchdog('httpd', t('404 error: "%page" not found', array('%page' => check_query($_GET['q']))));
Dries Buytaert's avatar
   
Dries Buytaert committed
239
240

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries Buytaert's avatar
   
Dries Buytaert committed
241
  $status = MENU_NOT_FOUND;
Dries Buytaert's avatar
   
Dries Buytaert committed
242
243
  if ($path) {
    menu_set_active_item($path);
Dries Buytaert's avatar
   
Dries Buytaert committed
244
    $status = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
245
246
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
247
  if ($status != MENU_FOUND) {
Dries Buytaert's avatar
Dries Buytaert committed
248
    print theme('page', '', t('Page not found'));
Dries Buytaert's avatar
   
Dries Buytaert committed
249
250
  }
}
Dries Buytaert's avatar
   
Dries Buytaert committed
251

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

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

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

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

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

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

  fwrite($fp, $request);

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

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

  // Parse headers.
355
  while ($line = trim(array_shift($headers))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
356
357
358
359
360
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
388
389
390
391
392
393
394
395
    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
  // the base code in their class:
  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;
}
396
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
397

Dries Buytaert's avatar
   
Dries Buytaert committed
398
399
400
/**
 * Log errors in the database rather than displaying them to the user.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
401
function error_handler($errno, $message, $filename, $line, $variables) {
Dries Buytaert's avatar
   
Dries Buytaert committed
402
403
  $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');
  $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries Buytaert's avatar
   
Dries Buytaert committed
404
405

  if ($errno & E_ALL ^ E_NOTICE) {
406
    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
407
    if (error_reporting()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
408
      print '<pre>'. $entry .'</pre>';
Dries Buytaert's avatar
Dries Buytaert committed
409
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
410
411
412
  }
}

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

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

437
438
439
440
441
442
/**
 * @name Conversion
 *
 * Converts data structures to a different type.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
443
444
445
446

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

  return $object;
}

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

  return $array;
}
475
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
476

477
478
479
480
481
482
/**
 * @name Messages
 *
 * Frequently used messages.
 * @{
 */
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
}

501
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
502

Dries Buytaert's avatar
   
Dries Buytaert committed
503
504
505
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
506
507
function locale_init() {
  global $languages, $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
508
509
510
511
512
513
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
514
515
}

516
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
517
 * Translate strings to the current locale.
518
 *
519
520
521
522
 * When using t(), try to put entire sentences and strings in one t() call.
 * This makes it easier for translators. We are unafraid of HTML markup within
 * translation strings if necessary. The suggested syntax for a link embedded
 * within a translation string is for example:
Dries Buytaert's avatar
   
Dries Buytaert committed
523
524
525
526
527
 * @verbatim
 *   $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')));
 * @endverbatim
528
529
530
 * 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.
531
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
532
533
534
535
536
537
538
 * @param $string
 *   A string containing the english string to translate.
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
 *   of any key in this array are replaces with the corresponding value.
 * @return
 *   The translated string.
539
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
540
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
541
  global $languages;
542

Dries Buytaert's avatar
   
Dries Buytaert committed
543
  $string = ($languages && module_exist('locale') ? locale($string) : $string);
544

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

Dries Buytaert's avatar
   
Dries Buytaert committed
553
554
555
556
557
558
559
560
/**
 * 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
561
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries Buytaert's avatar
   
Dries Buytaert committed
562
  return htmlspecialchars($input, $quotes);
Dries Buytaert's avatar
   
Dries Buytaert committed
563
564
}

565
566
567
568
/**
 * @name Validation
 *
 * Functions to validate user input.
Dries Buytaert's avatar
   
Dries Buytaert committed
569
 * @{
570
571
 */

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

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

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

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

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

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

    if ($match) {
644
      watchdog('warning', t('terminated request because of suspicious input data: %data', array('%data' => drupal_specialchars($data))));
Dries Buytaert's avatar
   
Dries Buytaert committed
645
      return FALSE;
646
647
648
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
649
  return TRUE;
650
651
652
653
654
655
656
}
/* @} */

/**
 * @defgroup search Search interface
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
657

Kjartan Mannes's avatar
Kjartan Mannes committed
658
659
660
/**
 * Format a single result entry of a search query:
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
661
 * @param $item a single search result as returned by <i>module</i>_search of
Dries Buytaert's avatar
   
Dries Buytaert committed
662
663
 *   type array('count' => ..., 'link' => ..., 'title' => ..., 'user' => ...,
 *   'date' => ..., 'keywords' => ...)
Dries Buytaert's avatar
   
Dries Buytaert committed
664
 * @param $type module type of this item
Kjartan Mannes's avatar
Kjartan Mannes committed
665
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
666
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
667
668

  /*
Dries Buytaert's avatar
   
Dries Buytaert committed
669
  ** Modules may implement hook_search_item() hook in order to overwrite
Dries Buytaert's avatar
   
Dries Buytaert committed
670
671
672
  ** the default function to display search results.
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
673
674
  if (module_hook($type, 'search_item')) {
    $output = module_invoke($type, 'search_item', $item);
Dries Buytaert's avatar
   
Dries Buytaert committed
675
676
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
677
678
    $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
679
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
680
681
682
683

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
684
685
686
687
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
688
 * 'site.com/search', but also as a simple search box (without "Restrict search
Dries Buytaert's avatar
   
Dries Buytaert committed
689
690
 * to", help text, etc) from theme's header etc. This means: provide options to
 * only conditionally render certain parts of this form.
Kjartan Mannes's avatar
Kjartan Mannes committed
691
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
692
693
694
695
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys string containing keywords for the search.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan Mannes's avatar
Kjartan Mannes committed
696
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
697
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
698
699
  $edit = $_POST['edit'];

Dries Buytaert's avatar
   
Dries Buytaert committed
700
  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
701
    $action = url('search');
Dries Buytaert's avatar
   
Dries Buytaert committed
702
703
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
704
705
  $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
706

Dries Buytaert's avatar
Dries Buytaert committed
707
  if ($options) {
Dries Buytaert's avatar
   
Dries Buytaert committed
708
709
    $output .= '<br />';
    $output .= t('Restrict search to') .': ';
Dries Buytaert's avatar
   
Dries Buytaert committed
710
711

    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
712
713
      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
714
715
      }
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
716
    $output .= '</div>';
Dries Buytaert's avatar
   
Dries Buytaert committed
717
718
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
719
  return form($output, 'post', $action);
Dries Buytaert's avatar
   
Dries Buytaert committed
720
721
722
}

/*
Kjartan Mannes's avatar
Kjartan Mannes committed
723
724
 * Collect the search results:
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
725
function search_data($keys = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
726
  $edit = $_POST['edit'];
Dries Buytaert's avatar
   
Dries Buytaert committed
727
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
728

Dries Buytaert's avatar
   
Dries Buytaert committed
729
  if (isset($keys)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
730
    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
731
732
      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
733
        if ($results) {
Dries Buytaert's avatar
   
Dries Buytaert committed
734
735
          $output .= '<h2>'. $title .'</h2>';
          $output .= '<dl class="search-results">';
Dries Buytaert's avatar
   
Dries Buytaert committed
736
737
738
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
Dries Buytaert's avatar
   
Dries Buytaert committed
739
          $output .= '</dl>';
Dries Buytaert's avatar
   
Dries Buytaert committed
740
741
742
743
744
745
746
747
        }
      }
    }
  }

  return $output;
}

Kjartan Mannes's avatar
Kjartan Mannes committed
748
749
750
/**
 * Display the search form and the resulting data.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
751
752
753
754
755
756
 * @param $type If set, search only nodes of this type. Otherwise, search all
 *   types.
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys Query string. Defaults to global $keys.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan Mannes's avatar
Kjartan Mannes committed
757
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
758
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
759
  $_POST['edit']['type'][$type] = 'on';
Dries Buytaert's avatar
   
Dries Buytaert committed
760

Dries Buytaert's avatar
   
Dries Buytaert committed
761
  return search_form($action, $keys, $options) . '<br />'. search_data($keys);
Dries Buytaert's avatar
   
Dries Buytaert committed
762
}
763
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
764

Dries Buytaert's avatar
   
Dries Buytaert committed
765
function check_form($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
766
  return drupal_specialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
767
768
}

769
770
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
771
772
}

Dries Buytaert's avatar
   
Dries Buytaert committed
773
774
775
776
777
778
779
/**
 * @name Formatting
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
780
781
782
783
784
785
/**
 * 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
786
787
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
788
  $output = "<channel>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
789
790
791
792
  $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
793
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
794
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
795
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
796
797
798
799
800
801
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
802
803
804
805
806
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
807
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
808
  $output = "<item>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
809
810
811
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= ' <description>'. drupal_specialchars(check_output($description)) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
812
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
813
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
814
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
815
816
817
818
819
  $output .= "</item>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
820
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
821
 * Format a string containing a count of items.
Dries Buytaert's avatar
   
Dries Buytaert committed
822
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
 *   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
837
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
838
function format_plural($count, $singular, $plural) {
Dries Buytaert's avatar
   
Dries Buytaert committed
839
  return t($count == 1 ? $singular : $plural, array('%count' => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
840
841
}

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

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

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
886
887
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
888
  return $output ? $output : t('0 sec');
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
893
 * Format a date with the given configured format or a custom format string.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
894
895
896
897
 * 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
898
899
900
901
902
903
904
905
906
907
908
 * @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
909
 */
910
911
912
913
914
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
    $timezone = $user->uid ? $user->timezone : variable_get('date_default_timezone', 0);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
915

916
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
917
918

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

933
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
934
  $date = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
935
936
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
937
    if (strpos('AaDFlM', $c)) {
938
      $date .= t(gmdate($c, $timestamp));
939
940
941
942
943
944
    }
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c)) {
      $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
945
    }
946
947
948
949
950
    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
951
952
    }
    else {
953
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed
954
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
955
  }
956

Dries Buytaert's avatar
   
Dries Buytaert committed
957
958
959
  return $date;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
960
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
961
 * Format a username.
Dries Buytaert's avatar
   
Dries Buytaert committed
962
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
963
964
965
966
967
 * @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
968
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
969
970
971
function format_name($object) {

  if ($object->uid && $object->name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
972
    // Shorten the name when it is too long or it will break many tables.
973
    if (strlen($object->name) > 20) {
Dries Buytaert's avatar
   
Dries Buytaert committed
974
      $name = truncate_utf8($object->name, 15) .'...';
975
976
977
978
979
    }
    else {
      $name = $object->name;
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
980
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries Buytaert's avatar
   
Dries Buytaert committed
981
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
982
  else if ($object->name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
983
984
985
986
    // 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
987
    if ($object->homepage) {
Dries Buytaert's avatar
   
Dries Buytaert committed
988
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries Buytaert's avatar
   
Dries Buytaert committed
989
990
991
992
993
994
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries Buytaert's avatar
   
Dries Buytaert committed
995
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
996
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
997
    $output = t(variable_get('anonymous', 'Anonymous'));
Dries Buytaert's avatar
   
Dries Buytaert committed
998
999
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
1000
  return $output;
For faster browsing, not all history is shown. View entire blame