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

3
use Drupal\Component\Utility\Crypt;
4
use Drupal\Core\Cache\Cache;
5
use Symfony\Component\DependencyInjection\Container;
6
use Symfony\Component\Yaml\Parser;
7
use Drupal\Component\PhpStorage\PhpStorageFactory;
8
use Drupal\Component\Utility\NestedArray;
9
use Drupal\Core\Cache\CacheBackendInterface;
10
use Drupal\Core\Datetime\DrupalDateTime;
11
use Drupal\Core\Database\Database;
12
use Drupal\Core\SystemListingInfo;
13
use Drupal\Core\Template\Attribute;
14

Dries's avatar
   
Dries committed
15
16
17
18
19
20
21
22
/**
 * @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.
 */

23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
 * @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
 *
51
 * @}
52
53
 */

54
55
56
/**
 * Return status for saving which involved creating a new item.
 */
57
const SAVED_NEW = 1;
58
59
60
61

/**
 * Return status for saving which involved an update to an existing item.
 */
62
const SAVED_UPDATED = 2;
63
64
65
66

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

69
/**
70
 * The default aggregation group for system CSS files added to the page.
71
 */
72
const CSS_AGGREGATE_SYSTEM = -100;
73
74

/**
75
 * The default aggregation group for CSS files added to the page.
76
 */
77
const CSS_AGGREGATE_DEFAULT = 0;
78
79

/**
80
 * The default aggregation group for theme CSS files added to the page.
81
 */
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
const CSS_AGGREGATE_THEME = 100;

/**
 * The default weight for CSS rules that style HTML elements ("base" styles).
 */
const CSS_BASE = -200;

/**
 * The default weight for CSS rules that layout a page.
 */
const CSS_LAYOUT = -100;

/**
 * The default weight for CSS rules that style design components (and their associated states and skins.)
 */
const CSS_COMPONENT = 0;

/**
 * The default weight for CSS rules that style states and are not included with components.
 */
const CSS_STATE = 100;

/**
 * The default weight for CSS rules that style skins and are not included with components.
 */
const CSS_SKIN = 200;
108

109
110
111
112
113
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

114
/**
115
 * The default group for JavaScript and jQuery libraries added to the page.
116
 */
117
const JS_LIBRARY = -100;
118
119

/**
120
 * The default group for module JavaScript code added to the page.
121
 */
122
const JS_DEFAULT = 0;
123
124

/**
125
 * The default group for theme JavaScript code added to the page.
126
 */
127
const JS_THEME = 100;
128

129
/**
130
131
132
 * @defgroup block_caching Block Caching
 * @{
 * Constants that define each block's caching state.
133
 *
134
135
136
137
138
139
140
141
142
143
 * Modules specify how their blocks can be cached in their hook_block_info()
 * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the
 * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core
 * Block module. If the Block module is managing the cache, you can specify that
 * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that
 * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user
 * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can
 * be combined with a bitwise-binary or operator; for example,
 * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change
 * depending on the user role or page it is on.
144
 *
145
146
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the page cache (node, comment, user, taxonomy
147
 * added or updated...).
148
149
150
151
152
 *
 * Note that user 1 is excluded from block caching.
 */

/**
153
154
155
156
157
158
159
 * 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.
160
 */
161
const DRUPAL_NO_CACHE = -1;
162
163

/**
164
165
 * The block is handling its own caching in its hook_block_view().
 *
166
167
 * This setting is useful when time based expiration is needed or a site uses a
 * node access which invalidates standard block cache.
168
 */
169
const DRUPAL_CACHE_CUSTOM = -2;
170
171

/**
172
173
174
175
 * 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.
176
 */
177
const DRUPAL_CACHE_PER_ROLE = 0x0001;
178
179

/**
180
181
 * The block or element can change depending on the user.
 *
182
183
184
 * 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.
 */
185
const DRUPAL_CACHE_PER_USER = 0x0002;
186
187
188
189

/**
 * The block or element can change depending on the page being viewed.
 */
190
const DRUPAL_CACHE_PER_PAGE = 0x0004;
191
192

/**
193
 * The block or element is the same for every user and page that it is visible.
194
 */
195
const DRUPAL_CACHE_GLOBAL = 0x0008;
196

197
198
199
200
/**
 * @} End of "defgroup block_caching".
 */

201
202
203
204
205
206
207
208
209
/**
 * 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";

210
/**
211
 * Adds content to a specified region.
212
213
 *
 * @param $region
214
 *   Page region the content is added to.
215
 * @param $data
216
 *   Content to be added.
217
 */
218
function drupal_add_region_content($region = NULL, $data = NULL) {
219
220
  static $content = array();

221
  if (isset($region) && isset($data)) {
222
223
224
225
226
227
    $content[$region][] = $data;
  }
  return $content;
}

/**
228
 * Gets assigned content for a given region.
229
230
 *
 * @param $region
231
232
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
233
 * @param $delimiter
234
 *   Content to be inserted between imploded array elements.
235
 */
236
237
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
238
239
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
240
      return implode($delimiter, $content[$region]);
241
    }
242
243
244
245
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
246
        $content[$region] = implode($delimiter, $content[$region]);
247
248
249
250
251
252
      }
    }
    return $content;
  }
}

253
/**
254
 * Gets the name of the currently active installation profile.
255
256
257
258
 *
 * 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
259
260
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
261
262
 *
 * @return $profile
263
 *   The name of the installation profile.
264
265
266
267
268
269
270
271
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
272
    $profile = variable_get('install_profile', 'standard');
273
274
275
276
277
278
  }

  return $profile;
}


Dries's avatar
   
Dries committed
279
/**
280
 * Sets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
281
 *
Dries's avatar
   
Dries committed
282
283
284
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
285
 */
Dries's avatar
   
Dries committed
286
function drupal_set_breadcrumb($breadcrumb = NULL) {
287
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
   
Dries committed
288

289
  if (isset($breadcrumb)) {
Dries's avatar
   
Dries committed
290
291
292
293
294
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
295
/**
296
 * Gets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
297
 */
Dries's avatar
   
Dries committed
298
299
300
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

301
  if (!isset($breadcrumb)) {
Dries's avatar
   
Dries committed
302
303
304
305
306
307
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
308
/**
309
 * Adds output to the HEAD tag of the HTML page.
310
 *
311
 * This function can be called as long as the headers aren't sent. Pass no
312
313
314
315
316
317
318
319
320
321
322
323
324
 * 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
325
 */
326
327
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
328

329
330
331
332
333
334
335
336
337
338
  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
339
340
341
342
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
343
/**
344
345
346
347
348
349
350
351
352
353
 * 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(
354
      'charset' => 'utf-8',
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
    ),
    // 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;
}

/**
376
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
   
Dries committed
377
 */
Dries's avatar
Dries committed
378
function drupal_get_html_head() {
379
380
381
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
382
383
}

384
/**
385
 * Adds a feed URL for the current page.
386
 *
387
388
 * This function can be called as long the HTML header hasn't been sent.
 *
389
 * @param $url
390
 *   An internal system path or a fully qualified external URL of the feed.
391
 * @param $title
392
 *   The title of the feed.
393
 */
394
function drupal_add_feed($url = NULL, $title = '') {
395
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
396

397
  if (isset($url)) {
398
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
399

400
401
402
403
404
405
406
407
    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)),
    ));
408
409
410
411
412
  }
  return $stored_feed_links;
}

/**
413
 * Gets the feed URLs for the current page.
414
415
 *
 * @param $delimiter
416
 *   A delimiter to split feeds by.
417
418
419
420
421
422
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
423
/**
424
 * @defgroup http_handling HTTP handling
Dries's avatar
   
Dries committed
425
 * @{
Dries's avatar
   
Dries committed
426
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
427
428
 */

429
/**
430
 * Processes a URL query parameter array to remove unwanted elements.
431
432
 *
 * @param $query
433
 *   (optional) An array to be processed. Defaults to $_GET.
434
 * @param $exclude
435
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
436
 *   exclude nested items.
437
 * @param $parent
438
439
 *   Internal use only. Used to build the $query array key for nested items.
 *
440
 * @return
441
 *   An array containing query parameters, which can be used for url().
442
 */
443
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
444
445
446
447
448
449
450
451
452
453
454
  // 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);
  }
455

456
  $params = array();
457
  foreach ($query as $key => $value) {
458
459
460
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
461
462
    }

463
464
465
466
467
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
468
    }
469
470
471
472
473
  }

  return $params;
}

474
/**
475
 * Splits a URL-encoded query string into an array.
476
477
478
479
480
 *
 * @param $query
 *   The query string to split.
 *
 * @return
481
 *   An array of URL decoded couples $param_name => $value.
482
483
484
485
486
487
 */
function drupal_get_query_array($query) {
  $result = array();
  if (!empty($query)) {
    foreach (explode('&', $query) as $param) {
      $param = explode('=', $param);
488
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
489
490
491
492
493
    }
  }
  return $result;
}

494
/**
495
 * Parses an array into a valid, rawurlencoded query string.
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 *
 * 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));
517

518
    // Recurse into children.
519
    if (is_array($value)) {
520
521
522
523
524
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
525
526
    }
    else {
527
528
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
529
530
531
532
533
534
    }
  }

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

535
/**
536
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
537
 *
538
539
540
541
 * 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.
542
 *
543
544
545
546
547
548
 * @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()
549
550
551
 * @see drupal_goto()
 */
function drupal_get_destination() {
552
553
554
555
556
557
  $destination = &drupal_static(__FUNCTION__);

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

558
  if (isset($_GET['destination'])) {
559
    $destination = array('destination' => $_GET['destination']);
560
561
  }
  else {
562
    $path = current_path();
563
    $query = drupal_http_build_query(drupal_get_query_parameters());
564
    if ($query != '') {
565
      $path .= '?' . $query;
566
    }
567
568
569
570
571
572
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
573
 * Parses a system URL string into an associative array suitable for url().
574
575
 *
 * This function should only be used for URLs that have been generated by the
576
577
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 *
 * 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 {
631
632
633
634
635
    // 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);
636
637
638
639
640
641
642
643
644
645
646
647
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

/**
648
 * Encodes a Drupal path for use in a URL.
649
 *
650
 * For aesthetic reasons slashes are not escaped.
651
 *
652
653
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
654
655
 *
 * @param $path
656
 *   The Drupal path to encode.
657
658
 */
function drupal_encode_path($path) {
659
  return str_replace('%2F', '/', rawurlencode($path));
660
661
}

Kjartan's avatar
Kjartan committed
662
/**
663
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
664
 *
Dries's avatar
   
Dries committed
665
666
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
667
 *
668
669
670
671
672
673
 * 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
674
675
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
676
 * @endcode
677
 *
678
679
 * 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
680
 *
681
682
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
683
684
 *
 * @param $path
685
686
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
687
 * @param $options
688
 *   (optional) An associative array of additional URL options to pass to url().
689
 * @param $http_response_code
690
691
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
692
693
694
695
696
697
698
699
700
701
 *   @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.
702
 *
703
 * @see drupal_get_destination()
704
 * @see url()
Kjartan's avatar
Kjartan committed
705
 */
706
707
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
708
709
  // We do not allow absolute URLs to be passed via $_GET, as this can be an
  // attack vector, with the following exception:
710
711
  // - Absolute URLs that point to this site (i.e. same base URL and
  //   base path) are allowed.
712
  if (isset($_GET['destination']) && (!url_is_external($_GET['destination']) || _external_url_is_local($_GET['destination']))) {
713
    $destination = drupal_parse_url($_GET['destination']);
714
715
716
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
717
718
  }

719
720
721
722
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

724
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
725

726
  header('Location: ' . $url, TRUE, $http_response_code);
727
728

  // The "Location" header sends a redirect status code to the HTTP daemon. In
729
730
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
731
  drupal_exit();
Kjartan's avatar
Kjartan committed
732
733
}

734
735
736
737
738
739
740
741
742
743
/**
 * Determines if an external URL points to this Drupal installation.
 *
 * @param $url
 *   A string containing an external URL, such as "http://example.com/foo".
 *
 * @return
 *   TRUE if the URL has the same domain and base path.
 */
function _external_url_is_local($url) {
744
745
  $url_parts = parse_url($url);
  $base_host = parse_url($GLOBALS['base_url'], PHP_URL_HOST);
746

747
748
749
750
  if (!isset($url_parts['path'])) {
    return ($url_parts['host'] == $base_host);
  }
  else {
751
752
753
754
    // When comparing base paths, we need a trailing slash to make sure a
    // partial URL match isn't occuring. Since base_path() always returns with
    // a trailing slash, we don't need to add the trailing slash here.
    return ($url_parts['host'] == $base_host && stripos($url_parts['path'], base_path()) === 0);
755
  }
756
757
}

758
759
760
761
762
763
764
/**
 * 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) {
765
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
766
767
768
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
   
Dries committed
769
/**
770
 * @} End of "defgroup http_handling".
Dries's avatar
   
Dries committed
771
 */
Dries's avatar
   
Dries committed
772

Kjartan's avatar
Kjartan committed
773
/**
Dries's avatar
   
Dries committed
774
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
775
 * @{
Dries's avatar
   
Dries committed
776
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
777
778
 */

779
/**
780
 * Verifies the syntax of the given e-mail address.
Dries's avatar
   
Dries committed
781
 *
782
783
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
784
 *
Dries's avatar
   
Dries committed
785
 * @param $mail
786
 *   A string containing an e-mail address.
787
 *
Dries's avatar
   
Dries committed
788
 * @return
Dries's avatar
   
Dries committed
789
 *   TRUE if the address is in a valid format.
790
 */
Dries's avatar
   
Dries committed
791
function valid_email_address($mail) {
792
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
793
794
}

Dries's avatar
   
Dries committed
795
/**
796
 * Verifies the syntax of the given URL.
Dries's avatar
   
Dries committed
797
 *
798
799
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
800
 * Valid values per RFC 3986.
Dries's avatar
   
Dries committed
801
 * @param $url
Dries's avatar
   
Dries committed
802
 *   The URL to verify.
Dries's avatar
   
Dries committed
803
 * @param $absolute
Dries's avatar
   
Dries committed
804
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
805
 *
Dries's avatar
   
Dries committed
806
 * @return
Dries's avatar
   
Dries committed
807
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
808
 */
Dries's avatar
   
Dries committed
809
function valid_url($url, $absolute = FALSE) {
810
  if ($absolute) {
811
    return (bool)preg_match("
812
      /^                                                      # Start at the beginning of the text
813
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
814
815
816
      (?:                                                     # Userinfo (optional) which is typically
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
817
      )?
818
819
820
821
822
823
      (?:
        (?:[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)
      (?:[\/|\?]
824
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
825
      *)?
826
    $/xi", $url);
827
828
  }
  else {
829
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
830
  }
Dries's avatar
   
Dries committed
831
832
}

833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
/**
 * Verifies that a number is a multiple of a given step.
 *
 * The implementation assumes it is dealing with IEEE 754 double precision
 * floating point numbers that are used by PHP on most systems.
 *
 * This is based on the number/range verification methods of webkit.
 *
 * @param $value
 *   The value that needs to be checked.
 * @param $step
 *   The step scale factor. Must be positive.
 * @param $offset
 *   (optional) An offset, to which the difference must be a multiple of the
 *   given step.
 *
 * @return bool
 *   TRUE if no step mismatch has occured, or FALSE otherwise.
 *
 * @see http://opensource.apple.com/source/WebCore/WebCore-1298/html/NumberInputType.cpp
 */
function valid_number_step($value, $step, $offset = 0.0) {
  $double_value = (double) abs($value - $offset);

  // The fractional part of a double has 53 bits. The greatest number that could
  // be represented with that is 2^53. If the given value is even bigger than
  // $step * 2^53, then dividing by $step will result in a very small remainder.
  // Since that remainder can't even be represented with a single precision
  // float the following computation of the remainder makes no sense and we can
  // safely ignore it instead.
  if ($double_value / pow(2.0, 53) > $step) {
    return TRUE;
  }

  // Now compute that remainder of a division by $step.
  $remainder = (double) abs($double_value - $step * round($double_value / $step));

  // $remainder is a double precision floating point number. Remainders that
  // can't be represented with single precision floats are acceptable. The
  // fractional part of a float has 24 bits. That means remainders smaller than
  // $step * 2^-24 are acceptable.
  $computed_acceptable_error = (double)($step / pow(2.0, 24));

  return $computed_acceptable_error >= $remainder || $remainder >= ($step - $computed_acceptable_error);
}

879
880
881
882
/**
 * @} End of "defgroup validation".
 */

883
884
885
886
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
887
888
889
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
890
891
 */

Dries's avatar
Dries committed
892
/**
893
894
895
896
897
898
 * Strips dangerous protocols (e.g. 'javascript:') from a URI.
 *
 * This function must be called for all URIs within user-entered input prior
 * to being output to an HTML attribute value. It is often called as part of
 * check_url() or filter_xss(), but those functions return an HTML-encoded
 * string, so this function can be called independently when the output needs to
899
900
901
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
 * check_plain() separately.
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   A plain-text URI stripped of dangerous protocols. As with all plain-text
 *   strings, this return value must not be output to an HTML page without
 *   check_plain() being called on it. However, it can be passed to functions
 *   expecting plain-text strings.
 *
 * @see check_url()
 */
function drupal_strip_dangerous_protocols($uri) {
  static $allowed_protocols;

  if (!isset($allowed_protocols)) {
918
919
920
921
    // filter_xss_admin() is called by the installer and update.php, in which
    // case the configuration may not exist (yet). Provide a minimal default set
    // of allowed protocols for these cases.
    $allowed_protocols = array_flip(config('system.filter')->get('protocols') ?: array('http', 'https'));
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
  }

  // Iteratively remove any invalid protocol found.
  do {
    $before = $uri;
    $colonpos = strpos($uri, ':');
    if ($colonpos > 0) {
      // We found a colon, possibly a protocol. Verify.
      $protocol = substr($uri, 0, $colonpos);
      // If a colon is preceded by a slash, question mark or hash, it cannot
      // possibly be part of the URL scheme. This must be a relative URL, which
      // inherits the (safe) protocol of the base document.
      if (preg_match('![/?#]!', $protocol)) {
        break;
      }
      // Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
      // (URI Comparison) scheme comparison must be case-insensitive.
      if (!isset($allowed_protocols[strtolower($protocol)])) {
        $uri = substr($uri, $colonpos + 1);
      }
    }
  } while ($before != $uri);

  return $uri;
}

/**
949
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
950
951
952
953
954
955
956
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   A URI stripped of dangerous protocols and encoded for output to an HTML
 *   attribute value. Because it is already encoded, it should not be set as a
957
958
959
960
961
 *   value within a $attributes array passed to Drupal\Core\Template\Attribute,
 *   because Drupal\Core\Template\Attribute expects those values to be
 *   plain-text strings. To pass a filtered URI to
 *   Drupal\Core\Template\Attribute, call drupal_strip_dangerous_protocols()
 *   instead.
962
963
 *
 * @see drupal_strip_dangerous_protocols()
Dries's avatar
Dries committed
964
965
 */
function check_url($uri) {
966
  return check_plain(drupal_strip_dangerous_protocols($uri));
Dries's avatar
Dries committed
967
968
}

969
/**
970
 * Applies a very permissive XSS/HTML filter for admin-only use.
971
972
973
974
975
976
977
978
979
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
 * is desired (so check_plain() is not acceptable).
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
 */
function filter_xss_admin($string) {
980
  return filter_xss($string, array('a', 'abbr', 'acronym', 'address', 'article', 'aside', 'b', 'bdi', 'bdo', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'command', 'dd', 'del', 'details', 'dfn', 'div', 'dl', 'dt', 'em', 'figcaption', 'figure', 'footer', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header', 'hgroup', 'hr', 'i', 'img', 'ins', 'kbd', 'li', 'mark', 'menu', 'meter', 'nav', 'ol', 'output', 'p', 'pre', 'progress', 'q', 'rp', 'rt', 'ruby', 's', 'samp', 'section', 'small', 'span', 'strong', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'time', 'tr', 'tt', 'u', 'ul', 'var', 'wbr'));
981
982
983
}

/**
984
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
985
 *
986
987
 * Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
 * For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
988
989
 *
 * This code does four things:
990
991
992
993
994
 * - Removes characters and constructs that can trick browsers.
 * - Makes sure all HTML entities are well-formed.
 * - Makes sure all HTML tags and attributes are well-formed.
 * - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
 *   javascript:).
995
996
 *
 * @param $string
997
998
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
999
1000
 * @param $allowed_tags
 *   An array of allowed tags.
1001
1002
1003
1004
1005
1006
1007
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
 * @see drupal_validate_utf8()
 * @ingroup sanitization
1008
1009
1010
1011
1012
1013
1014
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
  // Only operate on valid UTF-8 strings. This is necessary to prevent cross
  // site scripting issues on Internet Explorer 6.
  if (!drupal_validate_utf8($string)) {
    return '';
  }
1015
  // Store the text format.
1016
  _filter_xss_split($allowed_tags, TRUE);
1017
  // Remove NULL characters (ignored by some browsers).
1018
  $string = str_replace(chr(0), '', $string);
1019
  // Remove Netscape 4 JS entities.
1020
1021
  $string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);

1022
  // Defuse all HTML entities.
1023
  $string = str_replace('&', '&amp;', $string);
1024
1025
  // Change back only well-formed entities in our whitelist:
  // Decimal numeric entities.
1026
  $string = preg_replace('/&amp;#([0-9]+;)/', '&#\1', $string);
1027
  // Hexadecimal numeric entities.
1028
  $string = preg_replace('/&amp;#[Xx]0*((?:[0-9A-Fa-f]{2})+;)/', '&#x\1', $string);
1029
  // Named entities.
1030
  $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]*;)/', '&\1', $string);
1031
1032
1033
1034
1035

  return preg_replace_callback('%
    (
    <(?=[^a-zA-Z!/])  # a lone <
    |                 # or
1036
1037
    <!--.*?-->        # a comment
    |                 # or
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
    <[^>]*(>|$)       # a string that starts with a <, up until the > or the end of the string
    |                 # or
    >                 # just a >
    )%x', '_filter_xss_split', $string);
}

/**
 * Processes an HTML tag.
 *
 * @param $m
 *   An array with various meaning depending on the value of $store.
 *   If $store is TRUE then the array contains the allowed tags.
 *   If $store is FALSE then the array has one element, the HTML tag to process.
 * @param $store
 *   Whether to store $m.
1053
 *
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 * @return
 *   If the element isn't allowed, an empty string. Otherwise, the cleaned up
 *   version of the HTML element.
 */
function _filter_xss_split($m, $store = FALSE) {
  static $allowed_html;

  if ($store) {
    $allowed_html = array_flip($m);
    return;
  }

  $string = $m[1];

  if (substr($string, 0, 1) != '<') {
1069
    // We matched a lone ">" character.
1070
1071
1072
    return '&gt;';
  }
  elseif (strlen($string) == 1) {
1073
    // We matched a lone "<" character.
1074
1075
1076
    return '&lt;';
  }

1077
  if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?|(<!--.*?-->)$%', $string, $matches)) {
1078
    // Seriously malformed.
1079
1080
1081
1082
1083
1084
    return '';
  }

  $slash = trim($matches[1]);
  $elem = &$matches[2];
  $attrlist = &$matches[3];
1085
1086
1087
1088
1089
  $comment = &$matches[4];

  if ($comment) {
    $elem = '!--';
  }
1090
1091

  if (!isset($allowed_html[strtolower($elem)])) {
1092
    // Disallowed HTML element.
1093
1094
1095
    return '';
  }

1096
1097
1098
1099
  if ($comment) {
    return $comment;
  }

1100
1101
1102
1103
1104
1105
1106
1107
  if ($slash != '') {
    return "</$elem>";
  }

  // Is there a closing XHTML slash at the end of the attributes?
  $attrlist = preg_replace('%(\s?)/\s*$%', '\1', $attrlist, -1, $count);
  $xhtml_slash = $count ? ' /' : '';

1108
  // Clean up attributes.
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
  $attr2 = implode(' ', _filter_xss_attributes($attrlist));
  $attr2 = preg_replace('/[<>]/', '', $attr2);
  $attr2 = strlen($attr2) ? ' ' . $attr2 : '';

  return "<$elem$attr2$xhtml_slash>";
}

/**
 * Processes a string of HTML attributes.
 *
 * @return
 *   Cleaned up version of the HTML attributes.
 */
function _filter_xss_attributes($attr) {
  $attrarr = array();
  $mode = 0;
  $attrname = '';

  while (strlen($attr) != 0) {
    // Was the last operation successful?
    $working = 0;

    switch ($mode) {
      case 0:
1133
        // Attribute name, href for instance.
1134
1135
1136
1137
1138
1139
1140
1141
1142
        if (preg_match('/^([-a-zA-Z]+)/', $attr, $match)) {
          $attrname = strtolower($match[1]);
          $skip = ($attrname == 'style' || substr($attrname, 0, 2) == 'on');
          $working = $mode = 1;
          $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
        }
        break;

      case 1:
1143
        // Equals sign or valueless ("selected").
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
        if (preg_match('/^\s*=\s*/', $attr)) {
          $working = 1; $mode = 2;
          $attr = preg_replace('/^\s*=\s*/', '', $attr);
          break;
        }

        if (preg_match('/^\s+/', $attr)) {
          $working = 1; $mode = 0;
          if (!$skip) {
            $attrarr[] = $attrname;
          }
          $attr = preg_replace('/^\s+/', '', $attr);
        }
        break;

      case 2: