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

Dries Buytaert's avatar
   
Dries Buytaert committed
4
5
6
7
8
9
10
11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
function drupal_set_content($region = null, $data = null) {
  static $content = array();

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

/**
 * Get assigned content.
 *
 * @param $region
 *   A specified region to fetch content for.  If null, all regions will be returned.
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
54
function drupal_get_content($region = NULL, $delimiter = ' ') {
55
  $content = drupal_set_content();
56
57
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
58
      return implode ($delimiter, $content[$region]);
59
    }
60
61
62
63
64
65
66
67
68
69
70
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
        $content[$region] = implode ($delimiter, $content[$region]);
      }
    }
    return $content;
  }
}

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

81
  if (!is_null($breadcrumb)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
82
83
84
85
86
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

93
  if (is_null($breadcrumb)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
94
95
96
97
98
99
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

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

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

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

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

  return $output . drupal_set_html_head();
}

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

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

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

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

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

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

176
177
/**
 * Prepare a destination query string for use in combination with
178
179
180
181
182
 * drupal_goto(). Used to direct the user back to the referring page
 * after completing a form. By default the current URL is returned.
 * If a destination exists in the previous request, that destination
 * is returned.  As such, a destination can persist across multiple
 * pages.
183
184
185
186
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
187
188
189
190
191
192
193
194
195
196
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
    $destination[] = $_GET['q'];
    $params = array('page', 'sort', 'order');
    foreach ($params as $param) {
      if (isset($_GET[$param])) {
        $destination[] = "$param=". $_GET[$param];
      }
197
    }
198
    return 'destination='. urlencode(implode('&', $destination));
199
200
201
  }
}

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

242
  $url = url($path, $query, $fragment, TRUE);
243

Dries Buytaert's avatar
   
Dries Buytaert committed
244
245
246
247
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries Buytaert's avatar
   
Dries Buytaert committed
249
250
251
  // 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.
252
253
254
  exit();
}

255
256
257
258
259

/**
 * Generates a site offline message
 */
function drupal_site_offline() {
260
  drupal_set_header('HTTP/1.0 503 Service unavailable');
261
262
263
264
265
  drupal_set_title(t('Site offline'));
  print theme('maintenance_page', variable_get('site_offline_message',
    t('%site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('%site' => variable_get('site_name', t('This drupal site'))))));
}

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

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

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

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

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

300
  if (empty($return)) {
301
    drupal_set_title(t('Access denied'));
302
    $return = t('You are not authorized to access this page.');
Dries Buytaert's avatar
   
Dries Buytaert committed
303
  }
304
  print theme('page', $return);
Dries Buytaert's avatar
   
Dries Buytaert committed
305
306
}

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

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
360
  // Create HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
361
  $defaults = array(
362
363
    // RFC 2616: "non-standard ports MUST, default ports MAY be included". We always add it.
    'Host' => "Host: $uri[host]:$port",
364
365
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
366
367
368
  );

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

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

  fwrite($fp, $request);

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

  // Parse response.
390
391
392
393
  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
394
395
396
  $result->headers = array();

  // Parse headers.
397
  while ($line = trim(array_shift($headers))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
398
    list($header, $value) = explode(':', $line, 2);
399
400
401
402
403
404
405
406
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
407
408
409
410
411
412
413
414
415
416
  }

  $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
417
  // the base code in their class.
Dries Buytaert's avatar
   
Dries Buytaert committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
  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
445
446
447
/**
 * @} End of "HTTP handling".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
448

Dries Buytaert's avatar
   
Dries Buytaert committed
449
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
450
451
 * Log errors as defined by administrator
 * Error levels:
452
453
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries Buytaert's avatar
   
Dries Buytaert committed
454
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
455
function error_handler($errno, $message, $filename, $line) {
456
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
457
458
    $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
459

Dries Buytaert's avatar
   
Dries Buytaert committed
460
    if (variable_get('error_level', 1) == 1) {
461
      drupal_set_message($entry, 'error');
Dries Buytaert's avatar
Dries Buytaert committed
462
    }
463
464

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

Dries Buytaert's avatar
   
Dries Buytaert committed
468
function _fix_gpc_magic(&$item) {
Dries Buytaert's avatar
Dries Buytaert committed
469
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
470
471
472
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
473
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
474
475
476
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
477
478
479
480
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
481
482
function fix_gpc_magic() {
  static $fixed = false;
Dries Buytaert's avatar
   
Dries Buytaert committed
483
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries Buytaert's avatar
Dries Buytaert committed
484
485
486
487
488
489
    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
490
491
}

492
493
494
/**
 * @name Conversion
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
495
 * Converts data structures to different types.
496
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
497
498
499
500

/**
 * Convert an associative array to an anonymous object.
 */
Dries Buytaert's avatar
Dries Buytaert committed
501
502
function array2object($array) {
  if (is_array($array)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
503
    $object = new StdClass();
Dries Buytaert's avatar
Dries Buytaert committed
504
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
505
506
507
508
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
509
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
510
511
512
513
514
  }

  return $object;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
515
516
517
/**
 * Convert an object to an associative array.
 */
Dries Buytaert's avatar
Dries Buytaert committed
518
519
520
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
521
522
523
524
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
525
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
526
527
528
529
  }

  return $array;
}
Dries Buytaert's avatar
   
Dries Buytaert committed
530

531

Dries Buytaert's avatar
   
Dries Buytaert committed
532
533
534
/**
 * @} End of "Conversion".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
535

536
537
538
/**
 * @name Messages
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
539
 * Frequently used messages.
540
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
541
542
543
544

/**
 * Return a string with a "not applicable" message.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
545
function message_na() {
Dries Buytaert's avatar
   
Dries Buytaert committed
546
  return t('n/a');
Dries Buytaert's avatar
   
Dries Buytaert committed
547
548
}

Dries Buytaert's avatar
   
Dries Buytaert committed
549
550
551
/**
 * @} End of "Messages".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
552

Dries Buytaert's avatar
   
Dries Buytaert committed
553
554
555
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
556
557
function locale_initialize() {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
558
559
560
561
562

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

Dries Buytaert's avatar
   
Dries Buytaert committed
563
564
565
566
567
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
568
569
570
    // 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
571
  }
572
  if ($user->uid && isset($languages[$user->language])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
573
574
575
576
577
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
578
579
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
610
611
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
612
613
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
614
615
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
616
617
}

618
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
619
 * @defgroup validation Input validation
Dries Buytaert's avatar
   
Dries Buytaert committed
620
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
621
 * Functions to validate user input.
622
623
 */

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
 *   The name of the event.
 */
function flood_register_event($name) {
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, $_SERVER['REMOTE_ADDR'], time());
}

/**
 * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
 * The user is allowed to proceed if he did not trigger the specified event more than
 * $threshold times per hour.
 *
 * @param $name
 *   The name of the event.
 * @param $number
 *   The maximum number of the specified event per hour (per visitor).
 * @return
 *   True if the user did not exceed the hourly threshold.  False otherwise.
 */
function flood_is_allowed($name, $threshold) {
  $number = db_num_rows(db_query("SELECT event FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, $_SERVER['REMOTE_ADDR'], time() - 3600));
  return ($number < $threshold ? TRUE : FALSE);
}

690
691
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
692
693
}

694
695
696
697
698
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
699
  return filter_xss_bad_protocol($uri, FALSE);
700
701
}

Dries Buytaert's avatar
   
Dries Buytaert committed
702
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
703
 * @defgroup format Formatting
Dries Buytaert's avatar
   
Dries Buytaert committed
704
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
705
 * Functions to format numbers, strings, dates, etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
706
707
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
708
709
710
711
712
713
/**
 * 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
714
715
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
716
  $output = "<channel>\n";
717
718
719
720
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
721
  foreach ($args as $key => $value) {
722
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
723
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
724
725
726
727
728
729
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
730
731
732
733
734
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
735
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
736
  $output = "<item>\n";
737
738
739
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
740
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
        if (is_array($value['attributes'])) {
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
757
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
758
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
759
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
760
761
762
763
764
  $output .= "</item>\n";

  return $output;
}

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

  // get the plural index through the gettext formula
787
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries Buytaert's avatar
   
Dries Buytaert committed
788
789
790
791
792
793
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
794
        return t($singular, array("%count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
795
796
797
798
799
800
      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
801
802
}

Dries Buytaert's avatar
   
Dries Buytaert committed
803
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
804
 * Generate a string representation for the given byte count.
Dries Buytaert's avatar
   
Dries Buytaert committed
805
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
806
807
808
809
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries Buytaert's avatar
   
Dries Buytaert committed
810
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
811
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
812
  $suffix = t('bytes');
813
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
814
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
815
    $suffix = t('KB');
Dries Buytaert's avatar
   
Dries Buytaert committed
816
  }
817
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
818
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
819
    $suffix = t('MB');
Dries Buytaert's avatar
   
Dries Buytaert committed
820
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
821
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
822
823
}

Dries Buytaert's avatar
   
Dries Buytaert committed
824
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
825
 * Format a time interval with the requested granularity.
Dries Buytaert's avatar
   
Dries Buytaert committed
826
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
827
828
829
830
831
832
 * @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
833
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
834
function format_interval($timestamp, $granularity = 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
835
  $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
836
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
837
  foreach ($units as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
838
    $key = explode('|', $key);
Dries Buytaert's avatar
   
Dries Buytaert committed
839
    if ($timestamp >= $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
840
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries Buytaert's avatar
   
Dries Buytaert committed
841
      $timestamp %= $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
844
845
846
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
847
848
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
849
  return $output ? $output : t('0 sec');
Dries Buytaert's avatar
   
Dries Buytaert committed
850
851
}

Dries Buytaert's avatar
   
Dries Buytaert committed
852
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
853
854
 * Format a date with the given configured format or a custom format string.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
855
856
857
858
 * 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
859
860
861
862
863
864
 * @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
865
866
867
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries Buytaert's avatar
   
Dries Buytaert committed
868
869
870
871
 * @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
872
 */
873
874
875
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
876
877
878
879
880
881
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
882
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
883

884
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
885
886

  switch ($type) {
887
888
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
889
      break;
890
891
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
892
      break;
893
    case 'custom':
Dries Buytaert's avatar
   
Dries Buytaert committed
894
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
895
      break;
896
    case 'medium':
Dries Buytaert's avatar
   
Dries Buytaert committed
897
    default:
898
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
899
900
  }

901
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
902
  $date = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
903
904
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
905
    if (strpos('AaDFlM', $c) !== false) {
906
      $date .= t(gmdate($c, $timestamp));
907
    }
908
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
909
910
911
912
      $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
913
    }
914
915
916
917
918
    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
919
    }
920
921
922
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
923
    else {
924
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed
925
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
926
  }
927

Dries Buytaert's avatar
   
Dries Buytaert committed
928
929
930
  return $date;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
931
932
933
/**
 * @} End of "defgroup format".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
934

Dries Buytaert's avatar
   
Dries Buytaert committed
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
/**
 * Generate an internal Drupal URL.
 *
 * @param $path
 *   The Drupal path being linked to, such as "admin/node".
 * @param $query
 *   A query string to append to the link.
 * @param $fragment
 *   A fragment identifier (named anchor) to append to the link.
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
 *   Useful for links that will be displayed outside the site, such as in an RSS feed.
 * @return
 *   an HTML string containing a link to the given path.
 *
 * When creating links in modules, consider whether l() could be a better
 * alternative than url().
 */
function url($path = NULL, $query = NULL, $fragment = NULL, $absolute = FALSE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
954
  global $base_url;
Dries Buytaert's avatar
   
Dries Buytaert committed
955

Dries Buytaert's avatar
   
Dries Buytaert committed
956
957
958
  static $script;

  if (empty($script)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
959
960
961
    // On some web servers, such as IIS, we can't omit "index.php".  So, we
    // generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    // Apache.
Dries Buytaert's avatar
   
Dries Buytaert committed
962
    $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) ? 'index.php' : '';
Dries Buytaert's avatar
   
Dries Buytaert committed
963
  }
964

Dries Buytaert's avatar
   
Dries Buytaert committed
965
  $path = drupal_get_path_alias($path);
Dries Buytaert's avatar
   
Dries Buytaert committed
966

Dries Buytaert's avatar
   
Dries Buytaert committed
967
  if (isset($fragment)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
968
    $fragment = '#'. $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
969
970
  }

971
  $base = ($absolute ? $base_url .'/' : '');
Dries Buytaert's avatar
Dries Buytaert committed
972

Dries Buytaert's avatar
   
Dries Buytaert committed
973
974
  if (variable_get('clean_url', '0') == '0') {
    if (isset($path)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
975
      if (isset($query)) {
976
        return $base . $script .'?q='. $path .'&'. $query . $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
977
978
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
979
        return $base . $script .'?q='. $path . $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
980
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
981
982
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
983
      if (isset($query)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
984
        return $base . $script .'?'. $query . $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
985
986
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
987
        return $base . $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
988
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
989
990
991
    }
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
992
    if (isset($path)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
993
      if (isset($query)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
994
        return $base . $path .'?'. $query . $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
995
996
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
997
        return $base . $path . $fragment;
Dries Buytaert's avatar
   
Dries Buytaert committed
998
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
999
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
1000
    else {
For faster browsing, not all history is shown. View entire blame