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

Dries's avatar
   
Dries 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/**
 * @defgroup php_wrappers PHP wrapper functions
 * @{
 * Functions that are wrappers or custom implementations of PHP functions.
 *
 * Certain PHP functions should not be used in Drupal. Instead, Drupal's
 * replacement functions should be used.
 *
 * For example, for improved or more secure UTF8-handling, or RFC-compliant
 * handling of URLs in Drupal.
 *
 * For ease of use and memorizing, all these wrapper functions use the same name
 * as the original PHP function, but prefixed with "drupal_". Beware, however,
 * that not all wrapper functions support the same arguments as the original
 * functions.
 *
 * You should always use these wrapper functions in your code.
 *
 * Wrong:
 * @code
 *   $my_substring = substr($original_string, 0, 5);
 * @endcode
 *
 * Correct:
 * @code
 *   $my_substring = drupal_substr($original_string, 0, 5);
 * @endcode
 *
 * @} End of "defgroup php_wrappers".
 */

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/**
 * Error reporting level: display no errors.
 */
define('ERROR_REPORTING_HIDE', 0);

/**
 * Error reporting level: display errors and warnings.
 */
define('ERROR_REPORTING_DISPLAY_SOME', 1);

/**
 * Error reporting level: display all messages.
 */
define('ERROR_REPORTING_DISPLAY_ALL', 2);

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/**
 * 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);

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**
 * The default weight of system CSS files added to the page.
 */
define('CSS_SYSTEM', -100);

/**
 * The default weight of CSS files added to the page.
 */
define('CSS_DEFAULT', 0);

/**
 * The default weight of theme CSS files added to the page.
 */
define('CSS_THEME', 100);

88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * The weight of JavaScript libraries, settings or jQuery plugins being
 * added to the page.
 */
define('JS_LIBRARY', -100);

/**
 * The default weight of JavaScript being added to the page.
 */
define('JS_DEFAULT', 0);

/**
 * The weight of theme JavaScript code being added to the page.
 */
define('JS_THEME', 100);

104
105
106
107
108
109
/**
 * Error code indicating that the request made by drupal_http_request() exceeded
 * the specified timeout.
 */
define('HTTP_REQUEST_TIMEOUT', 1);

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/**
 * Constants defining cache granularity for blocks and renderable arrays.
 *
 * Modules specify the caching patterns for their blocks using binary
 * combinations of these constants in their hook_block_info():
 *   $block[delta]['cache'] = DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE;
 * DRUPAL_CACHE_PER_ROLE is used as a default when no caching pattern is
 * specified. Use DRUPAL_CACHE_CUSTOM to disable standard block cache and
 * implement
 *
 * The block cache is cleared in cache_clear_all(), and uses the same clearing
 * policy than page cache (node, comment, user, taxonomy added or updated...).
 * Blocks requiring more fine-grained clearing might consider disabling the
 * built-in block cache (DRUPAL_NO_CACHE) and roll their own.
 *
 * Note that user 1 is excluded from block caching.
 */

/**
 * The block should not get cached. This setting should be used:
 * - for simple blocks (notably those that do not perform any db query),
 * where querying the db cache would be more expensive than directly generating
 * the content.
 * - for blocks that change too frequently.
 */
define('DRUPAL_NO_CACHE', -1);

/**
 * The block is handling its own caching in its hook_block_view(). From the
 * perspective of the block cache system, this is equivalent to DRUPAL_NO_CACHE.
 * Useful when time based expiration is needed or a site uses a node access
 * which invalidates standard block cache.
 */
define('DRUPAL_CACHE_CUSTOM', -2);

/**
 * The block or element can change depending on the roles the user viewing the
 * page belongs to. This is the default setting for blocks, used when the block
 * does not specify anything.
 */
define('DRUPAL_CACHE_PER_ROLE', 0x0001);

/**
 * The block or element can change depending on the user viewing the page.
 * This setting can be resource-consuming for sites with large number of users,
 * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
 */
define('DRUPAL_CACHE_PER_USER', 0x0002);

/**
 * The block or element can change depending on the page being viewed.
 */
define('DRUPAL_CACHE_PER_PAGE', 0x0004);

/**
 * The block or element is the same for every user on every page where it is visible.
 */
define('DRUPAL_CACHE_GLOBAL', 0x0008);

169
/**
170
 * Add content to a specified region.
171
172
 *
 * @param $region
173
 *   Page region the content is added to.
174
 * @param $data
175
 *   Content to be added.
176
 */
177
function drupal_add_region_content($region = NULL, $data = NULL) {
178
179
180
181
182
183
184
185
186
  static $content = array();

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

/**
187
 * Get assigned content for a given region.
188
189
 *
 * @param $region
190
191
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
192
 * @param $delimiter
193
 *   Content to be inserted between imploded array elements.
194
 */
195
196
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
197
198
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
199
      return implode($delimiter, $content[$region]);
200
    }
201
202
203
204
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
205
        $content[$region] = implode($delimiter, $content[$region]);
206
207
208
209
210
211
      }
    }
    return $content;
  }
}

212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/**
 * Get the name of the currently active install profile.
 *
 * When this function is called during Drupal's initial installation process,
 * the name of the profile that's about to be installed is stored in the global
 * installation state. At all other times, the standard Drupal systems variable
 * table contains the name of the current profile, and we can call variable_get()
 * to determine what one is active.
 *
 * @return $profile
 *   The name of the install profile.
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
    $profile = variable_get('install_profile', 'default');
  }

  return $profile;
}


Dries's avatar
   
Dries committed
238
/**
Dries's avatar
   
Dries committed
239
 * Set the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
240
 *
Dries's avatar
   
Dries committed
241
242
243
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
244
 */
Dries's avatar
   
Dries committed
245
function drupal_set_breadcrumb($breadcrumb = NULL) {
246
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
   
Dries committed
247

248
  if (!is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
249
250
251
252
253
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
254
255
256
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
   
Dries committed
257
258
259
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

260
  if (is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
261
262
263
264
265
266
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

267
/**
268
269
 * Return a string containing RDF namespaces for the <html> tag of an XHTML
 * page.
270
271
272
273
274
275
276
277
278
279
 */
function drupal_get_rdf_namespaces() {
  // Serialize the RDF namespaces used in RDFa annotation.
  $xml_rdf_namespaces = array();
  foreach (module_invoke_all('rdf_namespaces') as $prefix => $uri) {
    $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
  }
  return implode("\n  ", $xml_rdf_namespaces);
}

Dries's avatar
Dries committed
280
/**
Dries's avatar
   
Dries committed
281
 * Add output to the head tag of the HTML page.
282
 *
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 * This function can be called as long the headers aren't sent. Pass no
 * arguments (or NULL for both) to retrieve the currently stored elements.
 *
 * @param $data
 *   A renderable array. If the '#type' key is not set then 'html_tag' will be
 *   added as the default '#type'.
 * @param $key
 *   A unique string key to allow implementations of hook_html_head_alter() to
 *   identify the element in $data. Required if $data is not NULL.
 *
 * @return
 *   An array of all stored HEAD elements.
 *
 * @see theme_html_tag()
Dries's avatar
Dries committed
297
 */
298
299
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
300

301
302
303
304
305
306
307
308
309
310
  if (!isset($stored_head)) {
    // Make sure the defaults, including Content-Type, come first.
    $stored_head = _drupal_default_html_head();
  }

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
311
312
313
314
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
315
/**
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 * Returns elements that are always displayed in the HEAD tag of the HTML page.
 */
function _drupal_default_html_head() {
  // Add default elements. Make sure the Content-Type comes first because the
  // IE browser may be vulnerable to XSS via encoding attacks from any content
  // that comes before this META tag, such as a TITLE tag.
  $elements['system_meta_content_type'] = array(
    '#type' => 'html_tag',
    '#tag' => 'meta',
    '#attributes' => array(
      'http-equiv' => 'Content-Type',
      'content' => 'text/html; charset=utf-8',
    ),
    // Security: This always has to be output first.
    '#weight' => -1000,
  );
  // Show Drupal and the major version number in the META GENERATOR tag.
  // Get the major version.
  list($version, ) = explode('.', VERSION);
  $elements['system_meta_generator'] = array(
    '#type' => 'html_tag',
    '#tag' => 'meta',
    '#attributes' => array(
      'name' => 'Generator',
      'content' => 'Drupal ' . $version . ' (http://drupal.org)',
    ),
  );
  // Also send the generator in the HTTP header.
  $elements['system_meta_generator']['#attached']['drupal_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
  return $elements;
}

/**
 * Retrieve output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
   
Dries committed
350
 */
Dries's avatar
Dries committed
351
function drupal_get_html_head() {
352
353
354
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
355
356
}

Dries's avatar
   
Dries committed
357
/**
358
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
   
Dries committed
359
 */
360
361
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
   
Dries committed
362
}
Kjartan's avatar
Kjartan committed
363

364
/**
365
366
 * Add a feed URL for the current page.
 *
367
368
 * This function can be called as long the HTML header hasn't been sent.
 *
369
 * @param $url
370
 *   A url for the feed.
371
 * @param $title
372
 *   The title of the feed.
373
 */
374
function drupal_add_feed($url = NULL, $title = '') {
375
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
376

377
  if (isset($url)) {
378
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
379

380
    drupal_add_html_head_link(array('rel' => 'alternate',
381
382
383
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
384
385
386
387
388
389
390
391
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
392
 *   A delimiter to split feeds by.
393
394
395
396
397
398
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
399
400
401
/**
 * @name HTTP handling
 * @{
Dries's avatar
   
Dries committed
402
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
403
404
 */

405
/**
406
 * Process a URL query parameter array to remove unwanted elements.
407
408
 *
 * @param $query
409
 *   (optional) An array to be processed. Defaults to $_GET.
410
 * @param $exclude
411
412
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
 *   exclude nested items. Defaults to array('q').
413
 * @param $parent
414
415
 *   Internal use only. Used to build the $query array key for nested items.
 *
416
 * @return
417
 *   An array containing query parameters, which can be used for url().
418
 */
419
420
421
422
423
424
425
426
427
428
429
430
function drupal_get_query_parameters(array $query = NULL, array $exclude = array('q'), $parent = '') {
  // Set defaults, if none given.
  if (!isset($query)) {
    $query = $_GET;
  }
  // If $exclude is empty, there is nothing to filter.
  if (empty($exclude)) {
    return $query;
  }
  elseif (!$parent) {
    $exclude = array_flip($exclude);
  }
431

432
  $params = array();
433
  foreach ($query as $key => $value) {
434
435
436
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
437
438
    }

439
440
441
442
443
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
444
    }
445
446
447
448
449
  }

  return $params;
}

450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
/**
 * Split an URL-encoded query string into an array.
 *
 * @param $query
 *   The query string to split.
 *
 * @return
 *   An array of url decoded couples $param_name => $value.
 */
function drupal_get_query_array($query) {
  $result = array();
  if (!empty($query)) {
    foreach (explode('&', $query) as $param) {
      $param = explode('=', $param);
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
    }
  }
  return $result;
}

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/**
 * Parse an array into a valid, rawurlencoded query string.
 *
 * This differs from http_build_query() as we need to rawurlencode() (instead of
 * urlencode()) all query parameters.
 *
 * @param $query
 *   The query parameter array to be processed, e.g. $_GET.
 * @param $parent
 *   Internal use only. Used to build the $query array key for nested items.
 *
 * @return
 *   A rawurlencoded string which can be used as or appended to the URL query
 *   string.
 *
 * @see drupal_get_query_parameters()
 * @ingroup php_wrappers
 */
function drupal_http_build_query(array $query, $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
    $key = ($parent ? $parent . '[' . rawurlencode($key) . ']' : rawurlencode($key));
493

494
    // Recurse into children.
495
    if (is_array($value)) {
496
497
498
499
500
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
501
502
    }
    else {
503
504
505
      // For better readability of paths in query strings, we decode slashes.
      // @see drupal_encode_path()
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
506
507
508
509
510
511
    }
  }

  return implode('&', $params);
}

512
/**
513
 * Prepare a 'destination' URL query parameter for use in combination with drupal_goto().
514
 *
515
516
517
518
 * 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.
519
520
521
522
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
523
524
525
526
527
528
  $destination = &drupal_static(__FUNCTION__);

  if (isset($destination)) {
    return $destination;
  }

529
  if (isset($_GET['destination'])) {
530
    $destination = array('destination' => $_GET['destination']);
531
532
  }
  else {
533
534
    $path = $_GET['q'];
    $query = drupal_http_build_query(drupal_get_query_parameters());
535
    if ($query != '') {
536
      $path .= '?' . $query;
537
    }
538
539
540
541
542
543
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
544
545
546
547
548
 * Wrapper around parse_url() to parse a system URL string into an associative array, suitable for url().
 *
 * This function should only be used for URLs that have been generated by the
 * system, resp. url(). It should not be used for URLs that come from external
 * sources, or URLs that link to external resources.
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
 *   $options = drupal_parse_url($_GET['destination']);
 *   $my_url = url($options['path'], $options);
 *   $my_link = l('Example link', $options['path'], $options);
 * @endcode
 *
 * This is required, because url() does not support relative URLs containing a
 * query string or fragment in its $path argument. Instead, any query string
 * needs to be parsed into an associative query parameter array in
 * $options['query'] and the fragment into $options['fragment'].
 *
 * @param $url
 *   The URL string to parse, f.e. $_GET['destination'].
 *
 * @return
 *   An associative array containing the keys:
 *   - 'path': The path of the URL. If the given $url is external, this includes
 *     the scheme and host.
 *   - 'query': An array of query parameters of $url, if existent.
 *   - 'fragment': The fragment of $url, if existent.
 *
 * @see url()
 * @see drupal_goto()
 * @ingroup php_wrappers
 */
function drupal_parse_url($url) {
  $options = array(
    'path' => NULL,
    'query' => array(),
    'fragment' => '',
  );

  // External URLs: not using parse_url() here, so we do not have to rebuild
  // the scheme, host, and path without having any use for it.
  if (strpos($url, '://') !== FALSE) {
    // Split off everything before the query string into 'path'.
    $parts = explode('?', $url);
    $options['path'] = $parts[0];
    // If there is a query string, transform it into keyed query parameters.
    if (isset($parts[1])) {
      $query_parts = explode('#', $parts[1]);
      parse_str($query_parts[0], $options['query']);
      // Take over the fragment, if there is any.
      if (isset($query_parts[1])) {
        $options['fragment'] = $query_parts[1];
      }
    }
  }
  // Internal URLs.
  else {
602
603
604
605
606
    // parse_url() does not support relative URLs, so make it absolute. E.g. the
    // relative URL "foo/bar:1" isn't properly parsed.
    $parts = parse_url('http://example.com/' . $url);
    // Strip the leading slash that was just added.
    $options['path'] = substr($parts['path'], 1);
607
608
609
610
611
612
613
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }
614
615
616
617
618
619
620
  // The 'q' parameter contains the path of the current page if clean URLs are
  // disabled. It overrides the 'path' of the URL when present, even if clean
  // URLs are enabled, due to how Apache rewriting rules work.
  if (isset($options['query']['q'])) {
    $options['path'] = $options['query']['q'];
    unset($options['query']['q']);
  }
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656

  return $options;
}

/**
 * Encode a path for usage in a URL.
 *
 * Wrapper around rawurlencode() which avoids Apache quirks. Should be used when
 * placing arbitrary data into the path component of an URL.
 *
 * Do not use this function to pass a path to url(). url() properly handles
 * and encodes paths internally.
 * This function should only be used on paths, not on query string arguments.
 * Otherwise, unwanted double encoding will occur.
 *
 * Notes:
 * - For esthetic reasons, we do not escape slashes. This also avoids a 'feature'
 *   in Apache where it 404s on any path containing '%2F'.
 * - mod_rewrite unescapes %-encoded ampersands, hashes, and slashes when clean
 *   URLs are used, which are interpreted as delimiters by PHP. These
 *   characters are double escaped so PHP will still see the encoded version.
 * - With clean URLs, Apache changes '//' to '/', so every second slash is
 *   double escaped.
 *
 * @param $path
 *   The URL path component to encode.
 */
function drupal_encode_path($path) {
  if (!empty($GLOBALS['conf']['clean_url'])) {
    return str_replace(array('%2F', '%26', '%23', '//'),
                       array('/', '%2526', '%2523', '/%252F'),
                       rawurlencode($path)
    );
  }
  else {
    return str_replace('%2F', '/', rawurlencode($path));
657
658
659
  }
}

Kjartan's avatar
Kjartan committed
660
/**
Dries's avatar
   
Dries committed
661
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
662
 *
Dries's avatar
   
Dries committed
663
664
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
665
 *
666
 * Usually the redirected URL is constructed from this function's input
667
 * parameters. However you may override that behavior by setting a
668
 * destination in either the $_REQUEST-array (i.e. by using
669
 * the query string of an URI) This is used to direct the user back to
670
 * the proper page after completing a form. For example, after editing
671
 * a post on the 'admin/content'-page or after having logged on using the
672
 * 'user login'-block in a sidebar. The function drupal_get_destination()
673
674
 * can be used to help set the destination URL.
 *
675
676
 * Drupal will ensure that messages set by drupal_set_message() and other
 * session data are written to the database before the user is redirected.
Dries's avatar
   
Dries committed
677
 *
678
679
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
680
681
 *
 * @param $path
682
 *   A Drupal path or a full URL.
683
684
 * @param $options
 *   An associative array of additional URL options to pass to url().
685
686
687
688
689
690
691
692
 * @param $http_response_code
 *   Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
 *   - 301 Moved Permanently (the recommended value for most redirects)
 *   - 302 Found (default in Drupal and PHP, sometimes used for spamming search
 *         engines)
 *   - 303 See Other
 *   - 304 Not Modified
 *   - 305 Use Proxy
693
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
694
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
695
 *   supported.
696
 *
697
 * @see drupal_get_destination()
698
 * @see url()
Kjartan's avatar
Kjartan committed
699
 */
700
701
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
702
  if (isset($_GET['destination'])) {
703
704
705
706
    $destination = drupal_parse_url(urldecode($_GET['destination']));
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
707
708
  }

709
710
711
712
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

  // The 'Location' HTTP header must be absolute.
  $options['absolute'] = TRUE;
713

714
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
715

716
  header('Location: ' . $url, TRUE, $http_response_code);
717
718

  // The "Location" header sends a redirect status code to the HTTP daemon. In
719
720
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
721
  drupal_exit($url);
Kjartan's avatar
Kjartan committed
722
723
}

724
/**
725
726
727
728
729
730
 * Deliver a "site is under maintenance" message to the browser.
 *
 * Page callback functions wanting to report a "site offline" message should
 * return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_site_offline().
731
732
 */
function drupal_site_offline() {
733
  drupal_deliver_page(MENU_SITE_OFFLINE);
734
735
}

Kjartan's avatar
Kjartan committed
736
/**
737
738
739
740
741
742
 * Deliver a "page not found" error to the browser.
 *
 * Page callback functions wanting to report a "page not found" message should
 * return MENU_NOT_FOUND instead of calling drupal_not_found(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_not_found().
Kjartan's avatar
Kjartan committed
743
 */
Dries's avatar
   
Dries committed
744
function drupal_not_found() {
745
  drupal_deliver_page(MENU_NOT_FOUND);
Dries's avatar
   
Dries committed
746
}
Dries's avatar
   
Dries committed
747

Dries's avatar
   
Dries committed
748
/**
749
750
751
752
753
754
 * Deliver a "access denied" error to the browser.
 *
 * Page callback functions wanting to report an "access denied" message should
 * return MENU_ACCESS_DENIED instead of calling drupal_access_denied(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_access_denied().
Dries's avatar
   
Dries committed
755
756
 */
function drupal_access_denied() {
757
  drupal_deliver_page(MENU_ACCESS_DENIED);
Dries's avatar
   
Dries committed
758
759
}

Dries's avatar
   
Dries committed
760
/**
Dries's avatar
   
Dries committed
761
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
762
 *
763
764
 * This is a flexible and powerful HTTP client implementation. Correctly
 * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
Dries's avatar
   
Dries committed
765
766
767
 *
 * @param $url
 *   A string containing a fully qualified URI.
768
769
770
771
772
773
774
775
776
777
778
 * @param $options
 *   (optional) An array which can have one or more of following keys:
 *   - headers
 *       An array containing request headers to send as name/value pairs.
 *   - method
 *       A string containing the request method. Defaults to 'GET'.
 *   - data
 *       A string containing the request body. Defaults to NULL.
 *   - max_redirects
 *       An integer representing how many times a redirect may be followed.
 *       Defaults to 3.
779
780
781
782
 *   - timeout
 *       A float representing the maximum number of seconds the function call
 *       may take. The default is 30 seconds. If a timeout occurs, the error
 *       code is set to the HTTP_REQUEST_TIMEOUT constant.
Dries's avatar
   
Dries committed
783
 * @return
784
785
786
787
788
789
 *   An object which can have one or more of the following parameters:
 *   - request
 *       A string containing the request body that was sent.
 *   - code
 *       An integer containing the response status code, or the error code if
 *       an error occurred.
790
 *   - protocol
791
 *       The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
792
 *   - status_message
793
 *       The status message from the response, if a response was received.
794
795
796
797
798
 *   - redirect_code
 *       If redirected, an integer containing the initial response status code.
 *   - redirect_url
 *       If redirected, a string containing the redirection location.
 *   - error
799
 *       If an error occurred, the error message. Otherwise not set.
800
801
802
803
 *   - headers
 *       An array containing the response headers as name/value pairs.
 *   - data
 *       A string containing the response body that was received.
Dries's avatar
   
Dries committed
804
 */
805
function drupal_http_request($url, array $options = array()) {
806
  global $db_prefix;
807

808
  $result = new stdClass();
Dries's avatar
   
Dries committed
809

810
  // Parse the URL and make sure we can handle the schema.
811
  $uri = @parse_url($url);
812

813
814
  if ($uri == FALSE) {
    $result->error = 'unable to parse URL';
815
    $result->code = -1001;
816
817
818
    return $result;
  }

819
820
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
821
    $result->code = -1002;
822
823
824
    return $result;
  }

825
826
827
828
829
830
831
832
833
834
835
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
    'timeout' => 30,
  );

Dries's avatar
   
Dries committed
836
837
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
838
      $port = isset($uri['port']) ? $uri['port'] : 80;
839
      $host = $uri['host'] . ($port != 80 ? ':' . $port : '');
840
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, $options['timeout']);
Dries's avatar
   
Dries committed
841
842
      break;
    case 'https':
843
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
844
      $port = isset($uri['port']) ? $uri['port'] : 443;
845
      $host = $uri['host'] . ($port != 443 ? ':' . $port : '');
846
      $fp = @fsockopen('ssl://' . $uri['host'], $port, $errno, $errstr, $options['timeout']);
Dries's avatar
   
Dries committed
847
848
      break;
    default:
849
      $result->error = 'invalid schema ' . $uri['scheme'];
850
      $result->code = -1003;
Dries's avatar
   
Dries committed
851
852
853
      return $result;
  }

Dries's avatar
   
Dries committed
854
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
855
  if (!$fp) {
856
857
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
858
859
    $result->code = -$errno;
    $result->error = trim($errstr);
860
861
862
863
864
865
866

    // Mark that this request failed. This will trigger a check of the web
    // server's ability to make outgoing HTTP requests the next time that
    // requirements checking is performed.
    // @see system_requirements()
    variable_set('drupal_http_request_fails', TRUE);

Dries's avatar
   
Dries committed
867
868
869
    return $result;
  }

Dries's avatar
   
Dries committed
870
  // Construct the path to act on.
Dries's avatar
Dries committed
871
872
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
873
    $path .= '?' . $uri['query'];
Dries's avatar
   
Dries committed
874
875
  }

876
877
878
  // Merge the default headers.
  $options['headers'] += array(
    'User-Agent' => 'Drupal (+http://drupal.org/)',
Dries's avatar
   
Dries committed
879
880
  );

881
882
883
884
885
  // RFC 2616: "non-standard ports MUST, default ports MAY be included".
  // We don't add the standard port to prevent from breaking rewrite rules
  // checking the host that do not take into account the port number.
  $options['headers']['Host'] = $host;

886
887
888
889
  // Only add Content-Length if we actually have any content or if it is a POST
  // or PUT request. Some non-standard servers get confused by Content-Length in
  // at least HEAD/GET requests, and Squid always requires Content-Length in
  // POST/PUT requests.
890
891
892
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
893
894
895
  }

  // If the server URL has a user then attempt to use basic authentication.
896
  if (isset($uri['user'])) {
897
    $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (!empty($uri['pass']) ? ":" . $uri['pass'] : ''));
898
899
  }

900
901
902
903
904
905
  // If the database prefix is being used by SimpleTest to run the tests in a copied
  // database then set the user-agent header to the database prefix so that any
  // calls to other Drupal pages will run the SimpleTest prefixed database. The
  // user-agent is used to ensure that multiple testing sessions running at the
  // same time won't interfere with each other as they would if the database
  // prefix were stored statically in a file or database variable.
906
907
  if (is_string($db_prefix) && preg_match("/simpletest\d+/", $db_prefix, $matches)) {
    $options['headers']['User-Agent'] = drupal_generate_test_ua($matches[0]);
908
909
  }

910
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
911
  foreach ($options['headers'] as $name => $value) {
912
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
   
Dries committed
913
  }
914
  $request .= "\r\n" . $options['data'];
Dries's avatar
   
Dries committed
915
916
917
918
919
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
920
  $response = '';
921
922
923
924
925
926
927
928
929
930
  while (!feof($fp)) {
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
      $result->code = HTTP_REQUEST_TIMEOUT;
      $result->error = 'request timed out';
      return $result;
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
    $response .= fread($fp, 1024);
Dries's avatar
   
Dries committed
931
932
933
  }
  fclose($fp);

934
935
936
  // Parse response headers from the response body.
  list($response, $result->data) = explode("\r\n\r\n", $response, 2);
  $response = preg_split("/\r\n|\n|\r/", $response);
937

938
  // Parse the response status line.
939
940
941
942
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
   
Dries committed
943
944
  $result->headers = array();

945
946
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
Dries's avatar
   
Dries committed
947
    list($header, $value) = explode(':', $line, 2);
948
949
950
    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.
951
      $result->headers[$header] .= ',' . trim($value);
952
953
954
955
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries's avatar
   
Dries committed
956
957
958
  }

  $responses = array(
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
    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',
Dries's avatar
   
Dries committed
999
  );
1000
1001
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
Dries's avatar
   
Dries committed
1002
1003
1004
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
1005
  $result->code = $code;
Dries's avatar
   
Dries committed
1006
1007
1008
1009
1010
1011
1012
1013
1014

  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'];
1015
1016
1017
1018
1019
1020
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
1021
1022
1023
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
1024
        $result->redirect_code = $code;
Dries's avatar
   
Dries committed
1025
1026
1027
1028
      }
      $result->redirect_url = $location;
      break;
    default:
1029
      $result->error = $status_message;
Dries's avatar
   
Dries committed
1030
1031
1032
1033
  }

  return $result;
}
Dries's avatar
   
Dries committed
1034
1035
1036
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
1037

Dries's avatar
   
Dries committed
1038
/**
1039
 * Custom PHP error handler.
1040
 *
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 * @param $error_level
 *   The level of the error raised.
 * @param $message
 *   The error message.
 * @param $filename
 *   The filename that the error was raised in.
 * @param $line
 *   The line number the error was raised at.
 * @param $context
 *   An array that points to the active symbol table at the point the error occurred.
 */
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
  if ($error_level & error_reporting()) {
    // All these constants are documented at http://php.net/manual/en/errorfunc.constants.php
    $types = array(
      E_ERROR => 'Error',
      E_WARNING => 'Warning',
      E_PARSE => 'Parse error',
      E_NOTICE => 'Notice',
      E_CORE_ERROR => 'Core error',
      E_CORE_WARNING => 'Core warning',
      E_COMPILE_ERROR => 'Compile error',
      E_COMPILE_WARNING => 'Compile warning',
      E_USER_ERROR => 'User error',
      E_USER_WARNING => 'User warning',
      E_USER_NOTICE => 'User notice',
      E_STRICT => 'Strict warning',
      E_RECOVERABLE_ERROR => 'Recoverable fatal error'
    );
1070
1071
    $caller = _drupal_get_last_caller(debug_backtrace());

1072
    // We treat recoverable errors as fatal.
1073
1074
1075
1076
1077
1078
1079
    _drupal_log_error(array(
      '%type' => isset($types[$error_level]) ? $types[$error_level] : 'Unknown error',
      '%message' => $message,
      '%function' => $caller['function'],
      '%file' => $caller['file'],
      '%line' => $caller['line'],
    ), $error_level == E_RECOVERABLE_ERROR);
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
  }
}

/**
 * Custom PHP exception handler.
 *
 * Uncaught exceptions are those not enclosed in a try/catch block. They are
 * always fatal: the execution of the script will stop as soon as the exception
 * handler exits.
 *
 * @param $exception
 *   The exception object that was thrown.
Dries's avatar
   
Dries committed
1092
 */
1093
function _drupal_exception_handler($exception) {
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
  // Log the message to the watchdog and return an error page to the user.
  _drupal_log_error(_drupal_decode_exception($exception), TRUE);
}

/**
 * Decode an exception, especially to retrive the correct caller.
 *
 * @param $exception
 *   The exception object that was thrown.
 * @return An error in the format expected by _drupal_log_error().
 */
function _drupal_decode_exception($exception) {
1106
1107
  $message = $exception->getMessage();

1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
  $backtrace = $exception->getTrace();
  // Add the line throwing the exception to the backtrace.
  array_unshift($backtrace, array('line' => $exception->getLine(), 'file' => $exception->getFile()));

  // For PDOException errors, we try to return the initial caller,
  // skipping internal functions of the database layer.
  if ($exception instanceof PDOException) {
    // The first element in the stack is the call, the second element gives us the caller.
    // We skip calls that occurred in one of the classes of the database layer
    // or in one of its global functions.
1118
    $db_functions = array('db_query',  'db_query_range');
1119
    while (!empty($backtrace[1]) && ($caller = $backtrace[1]) &&
1120
        ((isset($caller['class']) && (strpos($caller['class'], 'Query') !== FALSE || strpos($caller['class'], 'Database') !== FALSE || strpos($caller['class'], 'PDO') !== FALSE)) ||
1121
        in_array($caller['function'], $db_functions))) {
1122
1123
1124
      // We remove that call.
      array_shift($backtrace);
    }
1125
1126
1127
    if (isset($exception->query_string, $exception->args)) {
      $message .= ": " . $exception->query_string . "; " . print_r($exception->args, TRUE);
    }
1128
  }
1129
  $caller = _drupal_get_last_caller($backtrace);
1130

1131
1132
  return array(
    '%type' => get_class($exception),
1133
    '%message' => $message,
1134
1135
1136
1137
    '%function' => $caller['function'],
    '%file' => $caller['file'],
    '%line' => $caller['line'],
  );
1138
}
1139

1140
1141
1142
/**
 * Log a PHP error or exception, display an error page in fatal cases.
 *
1143
1144
 * @param $error
 *   An array with the following keys: %type, %message, %function, %file, %line.
1145
1146
1147
 * @param $fatal
 *   TRUE if the error is fatal.
 */
1148
function _drupal_log_error($error, $fatal = FALSE) {
1149
  // Initialize a maintenance theme if the boostrap was not complete.
1150
  // Do it early because drupal_set_message() triggers a drupal_theme_initialize().
1151
1152
  if ($fatal && (drupal_get_bootstrap_phase() != DRUPAL_BOOTSTRAP_FULL)) {
    unset($GLOBALS['theme']);
1153
1154
1155
    if (!defined('MAINTENANCE_MODE')) {
      define('MAINTENANCE_MODE', 'error');
    }
1156
1157
    drupal_maintenance_theme();
  }
1158

1159
1160
  // When running inside the testing framework, we relay the errors
  // to the tested site by the way of HTTP headers.
1161
  if (isset($_SERVER['HTTP_USER_AGENT']) && preg_match("/^simpletest\d+;/", $_SERVER['HTTP_USER_AGENT']) && !headers_sent() && (!defined('SIMPLETEST_COLLECT_ERRORS') || SIMPLETEST_COLLECT_ERRORS)) {
1162
1163
    // $number does not use drupal_static as it should not be reset
    // as it uniquely identifies each PHP error.
1164
1165
    static $number = 0;
    $assertion = array(
1166
1167
      $error['%message'],
      $error['%type'],
1168
1169
1170
1171
1172
      array(
        'function' => $error['%function'],
        'file' => $error['%file'],
        'line' => $error['%line'],
      ),
1173
1174
1175
1176
1177
    );
    header('X-Drupal-Assertion-' . $number . ': ' . rawurlencode(serialize($assertion)));
    $number++;
  }

1178
1179
1180
1181
  try {
    watchdog('php', '%type: %message in %function (line %line of %file).', $error, WATCHDOG_ERROR);
  }
  catch (Exception $e) {
1182
1183
    // Ignore any additional watchdog exception, as that probably means
    // that the database was not initialized correctly.
1184
  }
Dries's avatar
   
Dries committed
1185

1186
  if ($fatal) {
1187
    drupal_add_http_header('500 Service unavailable (with message)');
1188
1189
1190
1191
1192
1193
1194
  }

  if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest') {
    if ($fatal) {
      // When called from JavaScript, simply output the error message.
      print t('%type: %message in %function (line %line of %file).', $error);
      exit;
Dries's avatar
Dries committed
1195
    }
1196
1197
1198
1199
1200
1201
1202
  }
  else {
    // Display the message if the current error reporting level allows this type
    // of message to be displayed, and unconditionnaly in update.php.
    $error_level = variable_get('error_level', ERROR_REPORTING_DISPLAY_ALL);
    $display_error = $error_level == ERROR_REPORTING_DISPLAY_ALL || ($error_level == ERROR_REPORTING_DISPLAY_SOME && $error['%type'] != 'Notice');
    if ($display_error || (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'update')) {
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
      $class = 'error';

      // If error type is 'User notice' then treat it as debug information
      // instead of an error message, see dd().
      if ($error['%type'] == 'User notice') {
        $error['%type'] = 'Debug';
        $class = 'status';
      }

      drupal_set_message(t('%type: %message in %function (line %line of %file).', $error), $class);
1213
1214
1215
1216
1217
1218
    }

    if ($fatal) {
      drupal_set_title(t('Error'));
      // We fallback to a maintenance page at this point, because the page generation
      // itself can generate errors.
1219
      print theme('maintenance_page', array('content' => t('The website encountered an unexpected error. Please try again later.')));
1220
      exit;
1221
    }
Dries's avatar
   
Dries committed
1222
1223
1224
  }
}

1225
/**
1226
 * Gets the last caller from a backtrace.
1227
1228
1229
1230
1231
1232
1233
 *
 * @param $backtrace
 *   A standard PHP backtrace.
 * @return
 *   An associative array with keys 'file', 'line' and 'function'.
 */
function _drupal_get_last_caller($backtrace) {
1234
1235
1236
1237
1238
  // Errors that occur inside PHP internal functions do not generate
  // information about file and line. Ignore black listed functions.
  $blacklist = array('debug');
  while (($backtrace && !isset($backtrace[0]['line'])) ||
         (isset($backtrace[1]['function']) && in_array($backtrace[1]['function'], $blacklist))) {
1239
1240
1241
    array_shift($backtrace);
  }

1242
1243
1244
  // The first trace is the call itself.
  // It gives us the line and the file of the last call.
  $call = $backtrace[0];
1245

1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
  // The second call give us the function where the call originated.
  if (isset($backtrace[1])) {
    if (isset($backtrace[1]['class'])) {
      $call['function'] = $backtrace[1]['class'] . $backtrace[1]['type'] . $backtrace[1]['function'] . '()';
    }
    else {
      $call['function'] = $backtrace[1]['function'] . '()';
    }
  }
  else {
    $call['function'] = 'main()';
  }
  return $call;
}

Dries's avatar
   
Dries committed
1261
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
1262
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
1263
1264
1265
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
1266
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
1267
1268
1269
  }
}

1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
/**
 * Helper function to strip slashes from $_FILES skipping over the tmp_name keys
 * since PHP generates single backslashes for file paths on Windows systems.
 *
 * tmp_name does not have backslashes added see
 * http://php.net/manual/en/features.file-upload.php#42280
 */
function _fix_gpc_magic_files(&$item, $key) {
  if ($key != 'tmp_name') {
    if (is_array($item)) {
      array_walk($item, '_fix_gpc_magic_files');
    }
    else {
      $item = stripslashes($item);
    }
  }
}

Dries's avatar
   
Dries committed
1288
/**
1289
 * Fix double-escaping problems caused by "magic quotes" in some PHP installations.
Dries's avatar
   
Dries committed
1290
 */
Dries's avatar
   
Dries committed
1291
function fix_gpc_magic() {
1292
  $fixed = &drupal_static(__FUNCTION__, FALSE);
Dries's avatar
   
Dries committed
1293
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
1294
1295
1296
1297
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
1298
    array_walk($_FILES, '_fix_gpc_magic_files');
1299
    $fixed = TRUE;
Dries's avatar
Dries committed
1300
  }
Dries's avatar
   
Dries committed
1301
1302
}

Kjartan's avatar
Kjartan committed
1303
/**
1304
 * Translate strings to the page language or a given language.
Kjartan's avatar
Kjartan committed
1305
 *
1306
 * Human-readable text that will be displayed somewhere within a page should
1307
 * be run through the t() function.
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 *
 * Examples:
 * @code
 *   if (!$info || !$info['extension']) {
 *     form_set_error('picture_upload', t('The uploaded file was not an image.'));
 *   }
 *
 *   $form['submit'] = array(
 *     '#type' => 'submit',
 *     '#value' => t('Log in'),
 *   );
 * @endcode
 *
 * Any text within t() can be extracted by translators and changed into
 * the equivalent text in their native language.
 *
 * Special variables called "placeholders" are used to signal dynamic
 * information in a string which should not be translated. Placeholders
1326
1327
 * can also be used for text that may change from time to time (such as
 * link paths) to be changed without requiring updates to translations.
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 *
 * For example:
 * @code
 *   $output = t('There are currently %members and %visitors online.', array(
 *     '%members' => format_plural($total_users, '1 user', '@count users'),
 *     '%visitors' => format_plural($guests->count, '1 guest', '@count guests')));
 * @endcode
 *
 * There are three styles of placeholders:
 * - !variable, which indicates that the text should be inserted as-is. This is
 *   useful for inserting variables into things like e-mail.
 *   @code
1340
 *     $message[] = t("If you don't want to receive such e-mails, you can change your settings at !url.", array('!url' => url("user/$account->uid", array('absolute' => TRUE))));
1341
1342
 *   @endcode
 *
1343
1344
1345
 * - @variable, which indicates that the text should be run through
 *   check_plain, to escape HTML characters. Use this for any output that's
 *   displayed within a Drupal page.
1346
 *   @code
1347