common.inc 271 KB
Newer Older
Dries's avatar
   
Dries committed
1
2
<?php

3
use Drupal\Component\Utility\NestedArray;
4
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
5
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
6
use Drupal\Core\Database\Database;
7

Dries's avatar
   
Dries committed
8
9
10
11
12
13
14
15
/**
 * @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.
 */

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
43
/**
 * @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
 *
44
 * @}
45
46
 */

47
48
49
/**
 * Return status for saving which involved creating a new item.
 */
50
const SAVED_NEW = 1;
51
52
53
54

/**
 * Return status for saving which involved an update to an existing item.
 */
55
const SAVED_UPDATED = 2;
56
57
58
59

/**
 * Return status for saving which deleted an existing item.
 */
60
const SAVED_DELETED = 3;
61

62
/**
63
 * The default group for system CSS files added to the page.
64
 */
65
const CSS_SYSTEM = -100;
66
67

/**
68
 * The default group for module CSS files added to the page.
69
 */
70
const CSS_DEFAULT = 0;
71
72

/**
73
 * The default group for theme CSS files added to the page.
74
 */
75
const CSS_THEME = 100;
76

77
/**
78
 * The default group for JavaScript and jQuery libraries added to the page.
79
 */
80
const JS_LIBRARY = -100;
81
82

/**
83
 * The default group for module JavaScript code added to the page.
84
 */
85
const JS_DEFAULT = 0;
86
87

/**
88
 * The default group for theme JavaScript code added to the page.
89
 */
90
const JS_THEME = 100;
91

92
93
94
/**
 * The default group for JavaScript settings added to the page.
 */
95
const JS_SETTING = 200;
96

97
/**
98
99
100
 * Error code indicating that the request exceeded the specified timeout.
 *
 * @see drupal_http_request()
101
 */
102
const HTTP_REQUEST_TIMEOUT = -1;
103

104
105
106
107
108
109
110
111
112
113
/**
 * 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
 *
114
115
116
117
118
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the 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.
119
120
121
122
123
 *
 * Note that user 1 is excluded from block caching.
 */

/**
124
125
126
127
128
129
130
 * 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.
131
 */
132
const DRUPAL_NO_CACHE = -1;
133
134

/**
135
136
137
138
139
 * 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.
140
 */
141
const DRUPAL_CACHE_CUSTOM = -2;
142
143

/**
144
145
146
147
 * The block or element can change depending on the user's roles.
 *
 * This is the default setting for blocks, used when the block does not specify
 * anything.
148
 */
149
const DRUPAL_CACHE_PER_ROLE = 0x0001;
150
151

/**
152
153
 * The block or element can change depending on the user.
 *
154
155
156
 * 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.
 */
157
const DRUPAL_CACHE_PER_USER = 0x0002;
158
159
160
161

/**
 * The block or element can change depending on the page being viewed.
 */
162
const DRUPAL_CACHE_PER_PAGE = 0x0004;
163
164

/**
165
 * The block or element is the same for every user and page that it is visible.
166
 */
167
const DRUPAL_CACHE_GLOBAL = 0x0008;
168

169
170
171
172
173
174
175
176
177
/**
 * The delimiter used to split plural strings.
 *
 * This is the ETX (End of text) character and is used as a minimal means to
 * separate singular and plural variants in source and translation text. It
 * was found to be the most compatible delimiter for the supported databases.
 */
const LOCALE_PLURAL_DELIMITER = "\03";

178
/**
179
 * Adds content to a specified region.
180
181
 *
 * @param $region
182
 *   Page region the content is added to.
183
 * @param $data
184
 *   Content to be added.
185
 */
186
function drupal_add_region_content($region = NULL, $data = NULL) {
187
188
  static $content = array();

189
  if (isset($region) && isset($data)) {
190
191
192
193
194
195
    $content[$region][] = $data;
  }
  return $content;
}

/**
196
 * Gets assigned content for a given region.
197
198
 *
 * @param $region
199
200
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
201
 * @param $delimiter
202
 *   Content to be inserted between imploded array elements.
203
 */
204
205
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
206
207
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
208
      return implode($delimiter, $content[$region]);
209
    }
210
211
212
213
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
214
        $content[$region] = implode($delimiter, $content[$region]);
215
216
217
218
219
220
      }
    }
    return $content;
  }
}

221
/**
222
 * Gets the name of the currently active install profile.
223
224
225
226
 *
 * 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
227
228
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
229
230
231
232
233
234
235
236
237
238
239
 *
 * @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 {
240
    $profile = variable_get('install_profile', 'standard');
241
242
243
244
245
246
  }

  return $profile;
}


Dries's avatar
   
Dries committed
247
/**
248
 * Sets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
249
 *
Dries's avatar
   
Dries committed
250
251
252
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
253
 */
Dries's avatar
   
Dries committed
254
function drupal_set_breadcrumb($breadcrumb = NULL) {
255
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
   
Dries committed
256

257
  if (isset($breadcrumb)) {
Dries's avatar
   
Dries committed
258
259
260
261
262
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
263
/**
264
 * Gets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
265
 */
Dries's avatar
   
Dries committed
266
267
268
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

269
  if (!isset($breadcrumb)) {
Dries's avatar
   
Dries committed
270
271
272
273
274
275
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
276
/**
277
 * Adds output to the HEAD tag of the HTML page.
278
 *
279
 * This function can be called as long as the headers aren't sent. Pass no
280
281
282
283
284
285
286
287
288
289
290
291
292
 * 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
293
 */
294
295
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
296

297
298
299
300
301
302
303
304
305
306
  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
307
308
309
310
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
311
/**
312
313
314
315
316
317
318
319
320
321
 * 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(
322
      'charset' => 'utf-8',
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
    ),
    // 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;
}

/**
344
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
   
Dries committed
345
 */
Dries's avatar
Dries committed
346
function drupal_get_html_head() {
347
348
349
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
350
351
}

352
/**
353
 * Adds a feed URL for the current page.
354
 *
355
356
 * This function can be called as long the HTML header hasn't been sent.
 *
357
 * @param $url
358
 *   An internal system path or a fully qualified external URL of the feed.
359
 * @param $title
360
 *   The title of the feed.
361
 */
362
function drupal_add_feed($url = NULL, $title = '') {
363
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
364

365
  if (isset($url)) {
366
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
367

368
369
370
371
372
373
374
375
    drupal_add_html_head_link(array(
      'rel' => 'alternate',
      'type' => 'application/rss+xml',
      'title' => $title,
      // Force the URL to be absolute, for consistency with other <link> tags
      // output by Drupal.
      'href' => url($url, array('absolute' => TRUE)),
    ));
376
377
378
379
380
  }
  return $stored_feed_links;
}

/**
381
 * Gets the feed URLs for the current page.
382
383
 *
 * @param $delimiter
384
 *   A delimiter to split feeds by.
385
386
387
388
389
390
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
391
/**
392
 * @defgroup http_handling HTTP handling
Dries's avatar
   
Dries committed
393
 * @{
Dries's avatar
   
Dries committed
394
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
395
396
 */

397
/**
398
 * Processes a URL query parameter array to remove unwanted elements.
399
400
 *
 * @param $query
401
 *   (optional) An array to be processed. Defaults to $_GET.
402
 * @param $exclude
403
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
404
 *   exclude nested items.
405
 * @param $parent
406
407
 *   Internal use only. Used to build the $query array key for nested items.
 *
408
 * @return
409
 *   An array containing query parameters, which can be used for url().
410
 */
411
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
412
413
414
415
416
417
418
419
420
421
422
  // 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);
  }
423

424
  $params = array();
425
  foreach ($query as $key => $value) {
426
427
428
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
429
430
    }

431
432
433
434
435
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
436
    }
437
438
439
440
441
  }

  return $params;
}

442
/**
443
 * Splits a URL-encoded query string into an array.
444
445
446
447
448
449
450
451
452
453
454
455
 *
 * @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);
456
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
457
458
459
460
461
    }
  }
  return $result;
}

462
/**
463
 * Parses an array into a valid, rawurlencoded query string.
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 *
 * 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));
485

486
    // Recurse into children.
487
    if (is_array($value)) {
488
489
490
491
492
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
493
494
    }
    else {
495
496
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
497
498
499
500
501
502
    }
  }

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

503
/**
504
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
505
 *
506
507
508
509
 * 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.
510
511
512
513
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
514
515
516
517
518
519
  $destination = &drupal_static(__FUNCTION__);

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

520
  if (isset($_GET['destination'])) {
521
    $destination = array('destination' => $_GET['destination']);
522
523
  }
  else {
524
    $path = current_path();
525
    $query = drupal_http_build_query(drupal_get_query_parameters());
526
    if ($query != '') {
527
      $path .= '?' . $query;
528
    }
529
530
531
532
533
534
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
535
 * Parses a system URL string into an associative array suitable for url().
536
537
 *
 * This function should only be used for URLs that have been generated by the
538
539
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
540
541
542
543
544
545
546
547
548
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
 *
 * 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 {
593
594
595
596
597
    // 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);
598
599
600
601
602
603
604
605
606
607
608
609
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

/**
610
 * Encodes a Drupal path for use in a URL.
611
 *
612
 * For aesthetic reasons slashes are not escaped.
613
 *
614
615
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
616
617
 *
 * @param $path
618
 *   The Drupal path to encode.
619
620
 */
function drupal_encode_path($path) {
621
  return str_replace('%2F', '/', rawurlencode($path));
622
623
}

Kjartan's avatar
Kjartan committed
624
/**
625
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
626
 *
Dries's avatar
   
Dries committed
627
628
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
629
 *
630
631
632
633
634
635
 * If a destination was specified in the current request's URI (i.e.,
 * $_GET['destination']) then it will override the $path and $options values
 * passed to this function. This provides the flexibility to build a link to
 * user/login and override the default redirection so that the user is
 * redirected to a specific path after logging in:
 * @code
636
637
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
638
 * @endcode
639
 *
640
641
 * 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
642
 *
643
644
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
645
646
 *
 * @param $path
647
648
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
649
 * @param $options
650
 *   (optional) An associative array of additional URL options to pass to url().
651
 * @param $http_response_code
652
653
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
654
655
656
657
658
659
660
661
662
663
 *   @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
 *   and the
 *   @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
 *   - 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.
 *   - 307: Temporary Redirect.
664
 *
665
 * @see drupal_get_destination()
666
 * @see url()
Kjartan's avatar
Kjartan committed
667
 */
668
669
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
670
671
  // We do not allow absolute URLs to be passed via $_GET, as this can be an attack vector.
  if (isset($_GET['destination']) && !url_is_external($_GET['destination'])) {
672
    $destination = drupal_parse_url($_GET['destination']);
673
674
675
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
676
677
  }

678
679
680
681
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

683
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
684

685
  header('Location: ' . $url, TRUE, $http_response_code);
686
687

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

Dries's avatar
   
Dries committed
693
/**
694
 * Performs an HTTP request.
Dries's avatar
   
Dries committed
695
 *
696
697
 * 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
698
699
700
 *
 * @param $url
 *   A string containing a fully qualified URI.
701
702
703
704
705
706
707
708
709
710
711
712
 * @param array $options
 *   (optional) An array that can have one or more of the following elements:
 *   - 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, formatted as
 *     'param=value&param=value&...'. Defaults to NULL.
 *   - max_redirects: An integer representing how many times a redirect
 *     may be followed. Defaults to 3.
 *   - 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.
 *   - context: A context resource created with stream_context_create().
713
 *
714
715
716
717
718
719
720
721
722
723
 * @return object
 *   An object that can have one or more of the following components:
 *   - 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.
 *   - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
 *   - status_message: The status message from the response, if a response was
 *     received.
 *   - redirect_code: If redirected, an integer containing the initial response
 *     status code.
724
725
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
726
727
728
729
730
 *   - error: If an error occurred, the error message. Otherwise not set.
 *   - headers: An array containing the response headers as name/value pairs.
 *     HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
 *     easy access the array keys are returned in lower case.
 *   - data: A string containing the response body that was received.
Dries's avatar
   
Dries committed
731
 */
732
function drupal_http_request($url, array $options = array()) {
733
  $result = new stdClass();
Dries's avatar
   
Dries committed
734

735
736
737
738
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
739
    $result->error = 'unable to parse URL';
740
    $result->code = -1001;
741
742
743
    return $result;
  }

744
745
746
747
748
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
749

750
751
752
753
754
755
756
757
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
758
759
    'timeout' => 30.0,
    'context' => NULL,
760
  );
761
762
763
764
765
766

  // Merge the default headers.
  $options['headers'] += array(
    'User-Agent' => 'Drupal (+http://drupal.org/)',
  );

767
768
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
769

770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
  // Use a proxy if one is defined and the host is not on the excluded list.
  $proxy_server = variable_get('proxy_server', '');
  if ($proxy_server && _drupal_http_use_proxy($uri['host'])) {
    // Set the scheme so we open a socket to the proxy server.
    $uri['scheme'] = 'proxy';
    // Set the path to be the full URL.
    $uri['path'] = $url;
    // Since the URL is passed as the path, we won't use the parsed query.
    unset($uri['query']);

    // Add in username and password to Proxy-Authorization header if needed.
    if ($proxy_username = variable_get('proxy_username', '')) {
      $proxy_password = variable_get('proxy_password', '');
      $options['headers']['Proxy-Authorization'] = 'Basic ' . base64_encode($proxy_username . (!empty($proxy_password) ? ":" . $proxy_password : ''));
    }
    // Some proxies reject requests with any User-Agent headers, while others
    // require a specific one.
    $proxy_user_agent = variable_get('proxy_user_agent', '');
    // The default value matches neither condition.
    if ($proxy_user_agent === NULL) {
      unset($options['headers']['User-Agent']);
    }
    elseif ($proxy_user_agent) {
      $options['headers']['User-Agent'] = $proxy_user_agent;
    }
  }

Dries's avatar
   
Dries committed
797
  switch ($uri['scheme']) {
798
799
800
801
802
803
804
805
    case 'proxy':
      // Make the socket connection to a proxy server.
      $socket = 'tcp://' . $proxy_server . ':' . variable_get('proxy_port', 8080);
      // The Host header still needs to match the real request.
      $options['headers']['Host'] = $uri['host'];
      $options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
      break;

Dries's avatar
   
Dries committed
806
    case 'http':
807
    case 'feed':
Dries's avatar
Dries committed
808
      $port = isset($uri['port']) ? $uri['port'] : 80;
809
810
811
812
813
      $socket = 'tcp://' . $uri['host'] . ':' . $port;
      // 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'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
Dries's avatar
   
Dries committed
814
      break;
815

Dries's avatar
   
Dries committed
816
    case 'https':
817
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
818
      $port = isset($uri['port']) ? $uri['port'] : 443;
819
820
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
   
Dries committed
821
      break;
822

Dries's avatar
   
Dries committed
823
    default:
824
      $result->error = 'invalid schema ' . $uri['scheme'];
825
      $result->code = -1003;
Dries's avatar
   
Dries committed
826
827
828
      return $result;
  }

829
830
831
832
833
834
835
836
  if (empty($options['context'])) {
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
  }
  else {
    // Create a stream with context. Allows verification of a SSL certificate.
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
  }

Dries's avatar
   
Dries committed
837
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
838
  if (!$fp) {
839
840
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
841
    $result->code = -$errno;
842
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries's avatar
   
Dries committed
843
844
845
    return $result;
  }

Dries's avatar
   
Dries committed
846
  // Construct the path to act on.
Dries's avatar
Dries committed
847
848
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
849
    $path .= '?' . $uri['query'];
Dries's avatar
   
Dries committed
850
851
  }

852
853
854
855
  // 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.
856
857
858
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
859
860
861
  }

  // If the server URL has a user then attempt to use basic authentication.
862
  if (isset($uri['user'])) {
863
    $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (isset($uri['pass']) ? ':' . $uri['pass'] : ''));
864
865
  }

866
867
868
869
870
871
  // 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.
872
873
874
  $test_info = &$GLOBALS['drupal_test_info'];
  if (!empty($test_info['test_run_id'])) {
    $options['headers']['User-Agent'] = drupal_generate_test_ua($test_info['test_run_id']);
875
876
  }

877
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
878
  foreach ($options['headers'] as $name => $value) {
879
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
   
Dries committed
880
  }
881
  $request .= "\r\n" . $options['data'];
Dries's avatar
   
Dries committed
882
  $result->request = $request;
883
884
885
886
887
888
  // Calculate how much time is left of the original timeout value.
  $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  if ($timeout > 0) {
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
    fwrite($fp, $request);
  }
Dries's avatar
   
Dries committed
889

890
891
892
893
894
  // Fetch response. Due to PHP bugs like http://bugs.php.net/bug.php?id=43782
  // and http://bugs.php.net/bug.php?id=46049 we can't rely on feof(), but
  // instead must invoke stream_get_meta_data() each iteration.
  $info = stream_get_meta_data($fp);
  $alive = !$info['eof'] && !$info['timed_out'];
895
  $response = '';
896
897

  while ($alive) {
898
899
900
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
901
902
      $info['timed_out'] = TRUE;
      break;
903
904
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
905
906
907
908
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
Dries's avatar
   
Dries committed
909
910
911
  }
  fclose($fp);

912
913
914
915
916
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
917
  // Parse response headers from the response body.
918
919
920
  // Be tolerant of malformed HTTP responses that separate header and body with
  // \n\n or \r\r instead of \r\n\r\n.
  list($response, $result->data) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
921
  $response = preg_split("/\r\n|\n|\r/", $response);
922

923
  // Parse the response status line.
924
925
926
927
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
   
Dries committed
928
929
  $result->headers = array();

930
931
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
932
933
934
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
935
936
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
937
      $result->headers[$name] .= ',' . trim($value);
938
939
    }
    else {
940
      $result->headers[$name] = trim($value);
941
    }
Dries's avatar
   
Dries committed
942
943
944
  }

  $responses = array(
945
946
947
948
949
950
951
952
953
954
955
956
957
958
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
    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
985
  );
986
987
  // 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
988
989
990
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
991
  $result->code = $code;
Dries's avatar
   
Dries committed
992
993
994
995
996
997
998
999

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
1000
      $location = $result->headers['location'];