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\Cache\CacheBackendInterface;
7
use Drupal\Core\Database\Database;
8
use Drupal\Core\Template\Attribute;
9

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

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

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

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

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

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

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

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

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

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

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

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

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

106
107
108
109
110
111
112
113
114
115
/**
 * 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
 *
116
117
118
119
120
 * 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.
121
122
123
124
125
 *
 * Note that user 1 is excluded from block caching.
 */

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

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

/**
146
147
148
149
 * 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.
150
 */
151
const DRUPAL_CACHE_PER_ROLE = 0x0001;
152
153

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

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

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

171
172
173
174
175
176
177
178
179
/**
 * 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";

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

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

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

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

  return $profile;
}


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

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

370
371
372
373
374
375
376
377
    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)),
    ));
378
379
380
381
382
  }
  return $stored_feed_links;
}

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

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

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

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

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

  return $params;
}

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

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

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

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

505
/**
506
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
507
 *
508
509
510
511
 * 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.
512
 *
513
514
515
516
517
518
 * @return
 *   An associative array containing the key:
 *   - destination: The path provided via the destination query string or, if
 *     not available, the current path.
 *
 * @see current_path()
519
520
521
 * @see drupal_goto()
 */
function drupal_get_destination() {
522
523
524
525
526
527
  $destination = &drupal_static(__FUNCTION__);

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

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

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

  return $options;
}

/**
618
 * Encodes a Drupal path for use in a URL.
619
 *
620
 * For aesthetic reasons slashes are not escaped.
621
 *
622
623
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
624
625
 *
 * @param $path
626
 *   The Drupal path to encode.
627
628
 */
function drupal_encode_path($path) {
629
  return str_replace('%2F', '/', rawurlencode($path));
630
631
}

Kjartan's avatar
Kjartan committed
632
/**
633
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
634
 *
Dries's avatar
   
Dries committed
635
636
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
637
 *
638
639
640
641
642
643
 * 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
644
645
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
646
 * @endcode
647
 *
648
649
 * 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
650
 *
651
652
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
653
654
 *
 * @param $path
655
656
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
657
 * @param $options
658
 *   (optional) An associative array of additional URL options to pass to url().
659
 * @param $http_response_code
660
661
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
662
663
664
665
666
667
668
669
670
671
 *   @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.
672
 *
673
 * @see drupal_get_destination()
674
 * @see url()
Kjartan's avatar
Kjartan committed
675
 */
676
677
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
678
679
  // 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'])) {
680
    $destination = drupal_parse_url($_GET['destination']);
681
682
683
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
684
685
  }

686
687
688
689
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

691
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
692

693
  header('Location: ' . $url, TRUE, $http_response_code);
694
695

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

Dries's avatar
   
Dries committed
701
/**
702
 * Performs an HTTP request.
Dries's avatar
   
Dries committed
703
 *
704
705
 * 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
706
707
708
 *
 * @param $url
 *   A string containing a fully qualified URI.
709
710
711
712
713
714
715
716
717
718
719
720
 * @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().
721
 *
722
723
724
725
726
727
728
729
730
731
 * @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.
732
733
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
734
735
736
737
738
 *   - 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
739
 */
740
function drupal_http_request($url, array $options = array()) {
741
  $result = new stdClass();
Dries's avatar
   
Dries committed
742

743
744
745
746
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
747
    $result->error = 'unable to parse URL';
748
    $result->code = -1001;
749
750
751
    return $result;
  }

752
753
754
755
756
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
757

758
759
760
761
762
763
764
765
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
766
767
    'timeout' => 30.0,
    'context' => NULL,
768
  );
769
770
771
772
773
774

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

775
776
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
777

778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
  // 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
805
  switch ($uri['scheme']) {
806
807
808
809
810
811
812
813
    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
814
    case 'http':
815
    case 'feed':
Dries's avatar
Dries committed
816
      $port = isset($uri['port']) ? $uri['port'] : 80;
817
818
819
820
821
      $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
822
      break;
823

Dries's avatar
   
Dries committed
824
    case 'https':
825
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
826
      $port = isset($uri['port']) ? $uri['port'] : 443;
827
828
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
   
Dries committed
829
      break;
830

Dries's avatar
   
Dries committed
831
    default:
832
      $result->error = 'invalid schema ' . $uri['scheme'];
833
      $result->code = -1003;
Dries's avatar
   
Dries committed
834
835
836
      return $result;
  }

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

Dries's avatar
   
Dries committed
854
  // Construct the path to act on.
Dries's avatar
Dries committed
855
856
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
857
    $path .= '?' . $uri['query'];
Dries's avatar
   
Dries committed
858
859
  }

860
861
862
863
  // 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.
864
865
866
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
867
868
869
  }

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

874
875
876
877
878
879
  // 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.
880
881
882
  $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']);
883
884
  }

885
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
886
  foreach ($options['headers'] as $name => $value) {
887
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
   
Dries committed
888
  }
889
  $request .= "\r\n" . $options['data'];
Dries's avatar
   
Dries committed
890
  $result->request = $request;
891
892
893
894
895
896
  // 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
897

898
899
900
901
902
  // 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'];
903
  $response = '';
904
905

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

920
921
922
923
924
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
925
  // Parse response headers from the response body.
926
927
928
  // 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);
929
  $response = preg_split("/\r\n|\n|\r/", $response);
930

931
  // Parse the response status line.
932
933
934
935
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
   
Dries committed
936
937
  $result->headers = array();

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

  $responses = array(
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
985
986
987
988
989
990
991
992
    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
993
  );
994
995
  // 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
996
997
998
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
999
  $result->code = $code;
Dries's avatar
   
Dries committed
1000
1001
1002
1003
1004
1005
1006
1007

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
1008
      $location = $result->headers['location'];
1009
1010
1011
1012
1013
1014
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
1015
1016
1017
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
1018
        $result->redirect_code = $code;
Dries's avatar
   
Dries committed
1019
      }
1020
1021
1022
      if (!isset($result->redirect_url)) {
        $result->redirect_url = $location;
      }
Dries's avatar
   
Dries committed
1023
1024
      break;
    default:
1025
      $result->error = $status_message;
Dries's avatar
   
Dries committed
1026
1027
1028
1029
  }

  return $result;
}
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041

/**
 * Helper function for determining hosts excluded from needing a proxy.
 *
 * @return
 *   TRUE if a proxy should be used for this host.
 */
function _drupal_http_use_proxy($host) {
  $proxy_exceptions = variable_get('proxy_exceptions', array('localhost', '127.0.0.1'));
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
   
Dries committed
1042
/**
1043
 * @} End of "defgroup http_handling".
Dries's avatar
   
Dries committed
1044
 */
Dries's avatar
   
Dries committed
1045

Kjartan's avatar
Kjartan committed
1046
/**
Dries's avatar
   
Dries committed
1047
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
1048
 * @{
Dries's avatar
   
Dries committed
1049
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
1050
1051
 */

1052
/**
1053
 * Verifies the syntax of the given e-mail address.
Dries's avatar
   
Dries committed
1054
 *
1055
 * See @link http://tools.ietf.org/html/rfc5321 RFC 5321 @endlink for details.
1056
 *
Dries's avatar
   
Dries committed
1057
 * @param $mail
1058
 *   A string containing an e-mail address.
1059
 *
Dries's avatar
   
Dries committed
1060
 * @return
Dries's avatar
   
Dries committed
1061
 *   TRUE if the address is in a valid format.
1062
 */
Dries's avatar
   
Dries committed
1063
function valid_email_address($mail) {
1064
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1065
1066
}

Dries's avatar
   
Dries committed
1067
/**
1068
 * Verifies the syntax of the given URL.
Dries's avatar
   
Dries committed
1069
 *
1070
1071
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1072
 * Valid values per RFC 3986.
Dries's avatar
   
Dries committed
1073
 * @param $url
Dries's avatar
   
Dries committed
1074
 *   The URL to verify.
Dries's avatar
   
Dries committed
1075
 * @param $absolute
Dries's avatar
   
Dries committed
1076
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
1077
 *
Dries's avatar
   
Dries committed
1078
 * @return
Dries's avatar
   
Dries committed
1079
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
1080
 */
Dries's avatar
   
Dries committed
1081
function valid_url($url, $absolute = FALSE) {
1082
  if ($absolute) {
1083
    return (bool)preg_match("
1084
      /^                                                      # Start at the beginning of the text
1085
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1086
1087
1088
      (?:                                                     # Userinfo (optional) which is typically
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
1089
      )?
1090
1091
1092
1093
1094
1095
      (?:
        (?:[a-z0-9\-\.]|%[0-9a-f]{2})+                        # A domain name or a IPv4 address
        |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\])         # or a well formed IPv6 address
      )
      (?::[0-9]+)?                                            # Server port number (optional)
      (?:[\/|\?]
1096
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
1097
      *)?
1098
    $/xi", $url);
1099
1100
  }
  else {
1101
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
1102
  }
Dries's avatar
   
Dries committed
1103
1104
}

1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
/**
 * Verifies that a number is a m