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

3 4 5 6 7 8 9 10
/**
 * @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.
 */

11
use Drupal\Component\Serialization\Json;
12 13
use Drupal\Component\Serialization\Yaml;
use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
14
use Drupal\Component\Utility\Bytes;
15
use Drupal\Component\Utility\Crypt;
16
use Drupal\Component\Utility\Html;
17
use Drupal\Component\Utility\Number;
18
use Drupal\Component\Utility\SafeMarkup;
19
use Drupal\Component\Utility\SortArray;
20
use Drupal\Component\Utility\String;
21
use Drupal\Component\Utility\Tags;
22
use Drupal\Component\Utility\UrlHelper;
23
use Drupal\Core\Cache\Cache;
24
use Drupal\Core\Language\LanguageInterface;
25
use Drupal\Core\Site\Settings;
26
use Drupal\Core\Url;
27 28
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
29
use Drupal\Core\PhpStorage\PhpStorageFactory;
30
use Drupal\Component\Utility\NestedArray;
31
use Drupal\Core\Datetime\DrupalDateTime;
32
use Drupal\Core\Routing\GeneratorNotInitializedException;
33
use Drupal\Core\Template\Attribute;
34
use Drupal\Core\Render\Element;
35
use Drupal\Core\Session\AnonymousUserSession;
36

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/**
 * @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
62
 *   $my_substring = Unicode::substr($original_string, 0, 5);
63 64
 * @endcode
 *
65
 * @}
66 67
 */

68 69 70
/**
 * Return status for saving which involved creating a new item.
 */
71
const SAVED_NEW = 1;
72 73 74 75

/**
 * Return status for saving which involved an update to an existing item.
 */
76
const SAVED_UPDATED = 2;
77 78 79 80

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

83
/**
84
 * The default aggregation group for CSS files added to the page.
85
 */
86
const CSS_AGGREGATE_DEFAULT = 0;
87 88

/**
89
 * The default aggregation group for theme CSS files added to the page.
90
 */
91 92 93 94 95 96 97 98 99 100 101 102 103
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;

/**
104
 * The default weight for CSS rules that style design components (and their associated states and themes.)
105 106 107 108 109 110 111 112 113
 */
const CSS_COMPONENT = 0;

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

/**
114
 * The default weight for CSS rules that style themes and are not included with components.
115
 */
116
const CSS_THEME = 200;
117

118 119 120 121 122
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

123
/**
124
 * The default group for JavaScript and jQuery libraries added to the page.
125
 */
126
const JS_LIBRARY = -100;
127 128

/**
129
 * The default group for module JavaScript code added to the page.
130
 */
131
const JS_DEFAULT = 0;
132 133

/**
134
 * The default group for theme JavaScript code added to the page.
135
 */
136
const JS_THEME = 100;
137

138 139 140 141 142 143 144 145 146
/**
 * 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";

Dries's avatar
Dries committed
147
/**
148
 * Adds output to the HEAD tag of the HTML page.
149
 *
150
 * This function can be called as long as the headers aren't sent. Pass no
151 152 153 154 155 156 157 158 159 160 161 162
 * 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.
 *
163
 * @see \Drupal\Core\Render\Element\HtmlTag::preRenderHtmlTag()
164 165 166
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
Dries's avatar
Dries committed
167
 */
168
function _drupal_add_html_head($data = NULL, $key = NULL) {
169
  $stored_head = &drupal_static(__FUNCTION__, array());
170 171 172 173 174 175

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
176 177 178 179
  }
  return $stored_head;
}

180
/**
181
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
182 183 184 185 186 187
 *
 * @param bool $render
 *   If TRUE render the HEAD elements, otherwise return just the elements.
 *
 * @return string|array
 *   Return the rendered HTML head or the elements itself.
188 189 190
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
191
 */
192
function drupal_get_html_head($render = TRUE) {
193
  $elements = _drupal_add_html_head();
194
  \Drupal::moduleHandler()->alter('html_head', $elements);
195 196 197 198 199 200
  if ($render) {
    return drupal_render($elements);
  }
  else {
    return $elements;
  }
Dries's avatar
Dries committed
201 202
}

203
/**
204
 * Prepares a 'destination' URL query parameter for use with url().
205
 *
206 207 208 209
 * 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.
210
 *
211 212 213 214 215
 * @return
 *   An associative array containing the key:
 *   - destination: The path provided via the destination query string or, if
 *     not available, the current path.
 *
216
 * @ingroup form_api
217 218
 */
function drupal_get_destination() {
219 220 221 222 223 224
  $destination = &drupal_static(__FUNCTION__);

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

225
  $query = \Drupal::request()->query;
226 227
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
228 229
  }
  else {
230
    $path = \Drupal::routeMatch()->getRouteName() ? Url::fromRouteMatch(\Drupal::routeMatch())->getInternalPath() : '';
231
    $query = UrlHelper::buildQuery(UrlHelper::filterQueryParameters($query->all()));
232
    if ($query != '') {
233
      $path .= '?' . $query;
234
    }
235 236 237 238 239
    $destination = array('destination' => $path);
  }
  return $destination;
}

Kjartan's avatar
Kjartan committed
240
/**
Dries's avatar
 
Dries committed
241
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
242
 * @{
Dries's avatar
 
Dries committed
243
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
244 245
 */

246
/**
247
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
248
 *
249
 * This uses the
250
 * @link http://php.net/manual/filter.filters.validate.php PHP email validation filter. @endlink
251
 *
Dries's avatar
 
Dries committed
252
 * @param $mail
253
 *   A string containing an email address.
254
 *
Dries's avatar
 
Dries committed
255
 * @return
Dries's avatar
 
Dries committed
256
 *   TRUE if the address is in a valid format.
257
 */
Dries's avatar
 
Dries committed
258
function valid_email_address($mail) {
259
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
260 261
}

262 263 264 265
/**
 * @} End of "defgroup validation".
 */

266 267 268 269
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
270 271 272
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
273 274
 */

275
/**
276
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
277 278 279 280 281 282 283
 *
 * @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
284 285 286
 *   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
287
 *   Drupal\Core\Template\Attribute, call
288
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
289
 *
290
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
291
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
292 293
 */
function check_url($uri) {
294
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
295 296
}

297 298 299 300
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
301
/**
Dries's avatar
 
Dries committed
302
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
303
 * @{
Dries's avatar
 
Dries committed
304
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
305 306
 */

307
/**
308
 * Formats XML elements.
309
 *
310 311 312
 * Note: It is the caller's responsibility to sanitize any input parameters.
 * This function does not perform sanitization.
 *
313
 * @param $array
314
 *   An array where each item represents an element and is either a:
315 316
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
317 318
 *     - 'key': The element name. Element names are not sanitized, so do not
 *       pass user input.
319 320 321 322 323 324 325
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
326
  $output = '';
327 328
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
329
      if ($value['key']) {
330
        $output .= ' <' . $value['key'];
331
        if (isset($value['attributes']) && is_array($value['attributes'])) {
332
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
333 334
        }

335
        if (isset($value['value']) && $value['value'] != '') {
336
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
337 338 339 340 341 342 343
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
344
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
345
    }
Dries's avatar
 
Dries committed
346
  }
347 348 349 350 351
  // @todo This is marking the output string as safe HTML, but we have only
  //   sanitized the attributes and tag values, not the tag names, and we
  //   cannot guarantee the assembled markup is safe. Consider a fix in:
  //   https://www.drupal.org/node/2296885
  return SafeMarkup::set($output);
Dries's avatar
 
Dries committed
352 353
}

Dries's avatar
 
Dries committed
354
/**
355
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
356
 *
Dries's avatar
 
Dries committed
357
 * @param $size
358
 *   A size in bytes.
359
 * @param $langcode
360 361
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
362
 *
Dries's avatar
 
Dries committed
363 364
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
365
 */
366
function format_size($size, $langcode = NULL) {
367
  if ($size < Bytes::KILOBYTE) {
368
    return \Drupal::translation()->formatPlural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
369
  }
370
  else {
371
    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
372
    $units = array(
373 374 375 376 377 378 379 380
      t('@size KB', array(), array('langcode' => $langcode)),
      t('@size MB', array(), array('langcode' => $langcode)),
      t('@size GB', array(), array('langcode' => $langcode)),
      t('@size TB', array(), array('langcode' => $langcode)),
      t('@size PB', array(), array('langcode' => $langcode)),
      t('@size EB', array(), array('langcode' => $langcode)),
      t('@size ZB', array(), array('langcode' => $langcode)),
      t('@size YB', array(), array('langcode' => $langcode)),
381 382
    );
    foreach ($units as $unit) {
383 384
      if (round($size, 2) >= Bytes::KILOBYTE) {
        $size = $size / Bytes::KILOBYTE;
385 386 387 388
      }
      else {
        break;
      }
389
    }
390
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
391 392 393
  }
}

Dries's avatar
 
Dries committed
394
/**
395
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
396
 *
Dries's avatar
 
Dries committed
397
 * @param $timestamp
398
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
399
 * @param $type
400
 *   (optional) The format to use, one of:
401 402 403
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
404
 *   - The name of a date type defined by a date format config entity.
405 406 407
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
408
 * @param $format
409 410 411
 *   (optional) If $type is 'custom', a PHP date format string suitable for
 *   input to date(). Use a backslash to escape ordinary text, so it does not
 *   get interpreted as date format characters.
Dries's avatar
 
Dries committed
412
 * @param $timezone
413
 *   (optional) Time zone identifier, as described at
414
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
415
 *   display the page.
416
 * @param $langcode
417 418 419
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
420 421
 * @return
 *   A translated date string in the requested format.
422
 *
423
 * @see \Drupal\Core\Datetime\DateFormatter::format()
Dries's avatar
 
Dries committed
424
 */
425
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
426
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
427 428
}

429 430 431 432 433
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
434
 *
435 436 437 438 439 440 441 442 443
 * @return string
 *   An ISO8601 formatted date.
 */
function date_iso8601($date) {
  // The DATE_ISO8601 constant cannot be used here because it does not match
  // date('c') and produces invalid RDF markup.
  return date('c', $date);
}

444
/**
445 446 447
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
 */
function _format_date_callback(array $matches = NULL, $new_langcode = NULL) {
  // We cache translations to avoid redundant and rather costly calls to t().
  static $cache, $langcode;

  if (!isset($matches)) {
    $langcode = $new_langcode;
    return;
  }

  $code = $matches[1];
  $string = $matches[2];

  if (!isset($cache[$langcode][$code][$string])) {
    $options = array(
      'langcode' => $langcode,
    );

    if ($code == 'F') {
      $options['context'] = 'Long month name';
Dries's avatar
 
Dries committed
468
    }
469 470 471

    if ($code == '') {
      $cache[$langcode][$code][$string] = $string;
472
    }
Dries's avatar
 
Dries committed
473
    else {
474
      $cache[$langcode][$code][$string] = t($string, array(), $options);
Dries's avatar
 
Dries committed
475
    }
Dries's avatar
 
Dries committed
476
  }
477
  return $cache[$langcode][$code][$string];
Dries's avatar
 
Dries committed
478 479
}

Dries's avatar
 
Dries committed
480 481 482
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
483

Dries's avatar
 
Dries committed
484
/**
485 486 487 488
 * Generates an internal or external URL.
 *
 * When creating links in modules, consider whether l() could be a better
 * alternative than url().
Dries's avatar
 
Dries committed
489
 *
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
 * @see \Drupal\Core\Url::fromUri()
 * @see \Drupal\Core\Url::fromRoute()
 * @see \Drupal\Core\Url::toString()
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.0.
 *   Use \Drupal\Core\Url::fromRoute() for internal paths served by Drupal
 *   controllers or \Drupal\Core\Url::fromUri() for external paths or
 *   non-controller or sub-domain URIs such as core/install.php. Note that
 *   \Drupal\Core\Url::fromUri() expects a valid URI including the scheme. URIs
 *   from the same sub-domain that are not handled by Drupal controllers should
 *   be prepended with base://. For example:
 * @code
 * $installer_url = \Drupal\Core\Url::fromUri('base://core/install.php')->toString();
 * $external_url = \Drupal\Core\Url::fromUri('http://example.com', ['query' => ['foo' => 'bar']])->toString();
 * $internal_url = \Drupal\Core\Url::fromRoute('system.admin')->toString();
 * @endcode
Dries's avatar
 
Dries committed
506
 */
507
function _url($path = NULL, array $options = array()) {
508
  return \Drupal::urlGenerator()->generateFromPath($path, $options);
Dries's avatar
 
Dries committed
509 510
}

511
/**
512
 * Formats an attribute string for an HTTP header.
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
 *
 * @param $attributes
 *   An associative array of attributes such as 'rel'.
 *
 * @return
 *   A ; separated string ready for insertion in a HTTP header. No escaping is
 *   performed for HTML entities, so this string is not safe to be printed.
 */
function drupal_http_header_attributes(array $attributes = array()) {
  foreach ($attributes as $attribute => &$data) {
    if (is_array($data)) {
      $data = implode(' ', $data);
    }
    $data = $attribute . '="' . $data . '"';
  }
  return $attributes ? ' ' . implode('; ', $attributes) : '';
}

Dries's avatar
 
Dries committed
531
/**
532
 * Formats an internal or external URL link as an HTML anchor tag.
Dries's avatar
 
Dries committed
533
 *
534
 * This function correctly handles aliased paths and adds an 'active' class
535 536 537
 * attribute to links that point to the current page (for theming), so all
 * internal links output by modules should be generated by this function if
 * possible.
Dries's avatar
 
Dries committed
538
 *
539 540 541
 * However, for links enclosed in translatable text you should use t() and
 * embed the HTML anchor tag directly in the translated string. For example:
 * @code
542
 * t('Visit the <a href="@url">settings</a> page', array('@url' => \Drupal::url('system.admin')));
543 544 545 546
 * @endcode
 * This keeps the context of the link title ('settings' in the example) for
 * translators.
 *
547 548 549 550 551 552
 * This function does not support generating links from internal routes. For
 * that use \Drupal\Core\Utility\LinkGenerator::generate(), which is exposed via
 * the 'link_generator' service. It requires an internal route name and does not
 * support external URLs. Using Drupal 7 style system paths should be avoided if
 * possible but l() should still be used when rendering links to external URLs.
 *
553 554
 * @param string|array $text
 *   The link text for the anchor tag as a translated string or render array.
555
 * @param string $path
556 557 558
 *   The internal path or external URL being linked to, such as "node/34" or
 *   "http://example.com/foo". After the url() function is called to construct
 *   the URL from $path and $options, the resulting URL is passed through
559 560 561
 *   \Drupal\Component\Utility\String::checkPlain() before it is inserted into
 *   the HTML anchor tag, to ensure well-formed HTML. See url() for more
 *   information and notes.
562
 * @param array $options
563 564
 *   An associative array of additional options. Defaults to an empty array. It
 *   may contain the following elements.
565
 *   - 'attributes': An associative array of HTML attributes to apply to the
566 567
 *     anchor tag. If element 'class' is included, it must be an array; 'title'
 *     must be a string; other elements are more flexible, as they just need
568 569
 *     to work as an argument for the constructor of the class
 *     Drupal\Core\Template\Attribute($options['attributes']).
570 571 572 573 574
 *   - 'html' (default FALSE): Whether $text is HTML or just plain-text. For
 *     example, to make an image tag into a link, this must be set to TRUE, or
 *     you will see the escaped HTML image tag. $text is not sanitized if
 *     'html' is TRUE. The calling function must ensure that $text is already
 *     safe.
575 576 577 578
 *   - 'language': An optional language object. If the path being linked to is
 *     internal to the site, $options['language'] is used to determine whether
 *     the link is "active", or pointing to the current page (the language as
 *     well as the path must match). This element is also used by url().
579 580 581 582 583 584 585 586 587 588
 *   - 'set_active_class': Whether l() should compare the $path, language and
 *     query options to the current URL to determine whether the link is
 *     "active". Defaults to FALSE. If TRUE, an "active" class will be applied
 *     to the link. It is important to use this sparingly since it is usually
 *     unnecessary and requires extra processing.
 *     For anonymous users, the "active" class will be calculated on the server,
 *     because most sites serve each anonymous user the same cached page anyway.
 *     For authenticated users, the "active" class will be calculated on the
 *     client (through JavaScript), only data- attributes are added to links to
 *     prevent breaking the render cache. The JavaScript is added in
589
 *     system_page_attachments().
590
 *   - Additional $options elements used by the url() function.
591
 *
592
 * @return string
593
 *   An HTML string containing a link to the given path.
594
 *
595
 * @see _url()
596
 * @see system_page_attachments()
597
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.0.
598
 *   Use \Drupal::l($text, $url) where $url is an instance of
599 600 601 602 603 604 605 606 607
 *   \Drupal\Core\Url. To build a \Drupal\Core\Url object for internal paths
 *   served by Drupal controllers use \Drupal\Core\Url::fromRoute(). For
 *   external paths or non-controller or sub-domain URIs such as
 *   core/install.php use \Drupal\Core\Url::fromUri(). Note that
 *   \Drupal\Core\Url::fromUri() expects a valid URI including the scheme. URIs
 *   from the same sub-domain that are not handled by Drupal controllers should
 *   be prepended with base://. For example:
 * @code
 * $installer_url = \Drupal\Core\Url::fromUri('base://core/install.php')->toString();
608
 * $installer_link = \Drupal::l($text, $installer_url);
609
 * $external_url = \Drupal\Core\Url::fromUri('http://example.com', ['query' => ['foo' => 'bar']])->toString();
610
 * $external_link = \Drupal::l($text, $external_url);
611
 * $internal_url = \Drupal\Core\Url::fromRoute('system.admin')->toString();
612
 * $internal_link = \Drupal::l($text, $internal_url);
613
 * @endcode
Dries's avatar
 
Dries committed
614
 */
615
function _l($text, $path, array $options = array()) {
616
  // Start building a structured representation of our link to be altered later.
617
  $variables = array(
618
    'text' => is_array($text) ? drupal_render($text) : $text,
619 620 621
    'path' => $path,
    'options' => $options,
  );
622

623 624
  // Merge in default options.
  $variables['options'] += array(
625
    'attributes' => array(),
626
    'query' => array(),
627
    'html' => FALSE,
628
    'language' => NULL,
629
    'set_active_class' => FALSE,
630
  );
631

632 633 634
  // Add a hreflang attribute if we know the language of this link's url and
  // hreflang has not already been set.
  if (!empty($variables['options']['language']) && !isset($variables['options']['attributes']['hreflang'])) {
635
    $variables['options']['attributes']['hreflang'] = $variables['options']['language']->getId();
636 637
  }

638 639 640 641 642 643 644 645 646
  // Set the "active" class if the 'set_active_class' option is not empty.
  if (!empty($variables['options']['set_active_class'])) {
    // Add a "data-drupal-link-query" attribute to let the drupal.active-link
    // library know the query in a standardized manner.
    if (!empty($variables['options']['query'])) {
      $query = $variables['options']['query'];
      ksort($query);
      $variables['options']['attributes']['data-drupal-link-query'] = Json::encode($query);
    }
647

648 649 650
    // Add a "data-drupal-link-system-path" attribute to let the
    // drupal.active-link library know the path in a standardized manner.
    if (!isset($variables['options']['attributes']['data-drupal-link-system-path'])) {
651
      $variables['options']['attributes']['data-drupal-link-system-path'] = \Drupal::service('path.alias_manager')->getPathByAlias($path);
652
    }
653 654 655 656 657 658
  }

  // Remove all HTML and PHP tags from a tooltip, calling expensive strip_tags()
  // only when a quick strpos() gives suspicion tags are present.
  if (isset($variables['options']['attributes']['title']) && strpos($variables['options']['attributes']['title'], '<') !== FALSE) {
    $variables['options']['attributes']['title'] = strip_tags($variables['options']['attributes']['title']);
659
  }
660 661

  // Allow other modules to modify the structure of the link.
662
  \Drupal::moduleHandler()->alter('link', $variables);
663 664 665 666 667

  // Move attributes out of options. url() doesn't need them.
  $attributes = new Attribute($variables['options']['attributes']);
  unset($variables['options']['attributes']);

668 669
  // The result of url() is a plain-text URL. Because we are using it here
  // in an HTML argument context, we need to encode it properly.
670
  $url = String::checkPlain(_url($variables['path'], $variables['options']));
671

672 673
  // Sanitize the link text if necessary.
  $text = $variables['options']['html'] ? $variables['text'] : String::checkPlain($variables['text']);
674
  return SafeMarkup::set('<a href="' . $url . '"' . $attributes . '>' . $text . '</a>');
Dries's avatar
 
Dries committed
675 676
}

677 678 679 680 681 682 683 684
/**
 * Attempts to set the PHP maximum execution time.
 *
 * This function is a wrapper around the PHP function set_time_limit().
 * When called, set_time_limit() restarts the timeout counter from zero.
 * In other words, if the timeout is the default 30 seconds, and 25 seconds
 * into script execution a call such as set_time_limit(20) is made, the
 * script will run for a total of 45 seconds before timing out.
685
 *
686 687 688 689 690
 * If the current time limit is not unlimited it is possible to decrease the
 * total time limit if the sum of the new time limit and the current time spent
 * running the script is inferior to the original time limit. It is inherent to
 * the way set_time_limit() works, it should rather be called with an
 * appropriate value every time you need to allocate a certain amount of time
691
 * to execute a task than only once at the beginning of the script.
692
 *
693 694 695 696 697 698 699 700 701
 * Before calling set_time_limit(), we check if this function is available
 * because it could be disabled by the server administrator. We also hide all
 * the errors that could occur when calling set_time_limit(), because it is
 * not possible to reliably ensure that PHP or a security extension will
 * not issue a warning/error if they prevent the use of this function.
 *
 * @param $time_limit
 *   An integer specifying the new time limit, in seconds. A value of 0
 *   indicates unlimited execution time.
702 703
 *
 * @ingroup php_wrappers
704 705 706
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
707 708
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
709
    if ($current != 0) {
710 711
      @set_time_limit($time_limit);
    }
712 713 714
  }
}

715
/**
716
 * Returns the base URL path (i.e., directory) of the Drupal installation.
717
 *
718 719
 * base_path() adds a "/" to the beginning and end of the returned path if the
 * path is not empty. At the very least, this will return "/".
720
 *
721 722 723
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
724 725
 */
function base_path() {
726
  return $GLOBALS['base_path'];
727 728
}

729
/**
730
 * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
731
 *
732
 * This function can be called as long the HTML header hasn't been sent, which
733
 * on normal pages is up through the preprocess step of _theme('html'). Adding
734 735
 * a link will overwrite a prior link with the exact same 'rel' and 'href'
 * attributes.
736
 *
737 738 739 740
 * @param $attributes
 *   Associative array of element attributes including 'href' and 'rel'.
 * @param $header
 *   Optional flag to determine if a HTTP 'Link:' header should be sent.
741 742 743
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
744
 */
745
function _drupal_add_html_head_link($attributes, $header = FALSE) {
746 747 748 749 750 751 752 753
  $element = array(
    '#tag' => 'link',
    '#attributes' => $attributes,
  );
  $href = $attributes['href'];

  if ($header) {
    // Also add a HTTP header "Link:".
754
    $href = '<' . String::checkPlain($attributes['href']) . '>;';
755
    unset($attributes['href']);
756
    $element['#attached']['http_header'][] = array('Link',  $href . drupal_http_header_attributes($attributes), TRUE);
757 758
  }

759
  _drupal_add_html_head($element, 'html_head_link:' . $attributes['rel'] . ':' . $href);
760 761
}

762
/**
763 764
 * Adds a cascading stylesheet to the stylesheet queue.
 *
765
 * Calling drupal_static_reset('_drupal_add_css') will clear all cascading
766 767
 * stylesheets added so far.
 *
768 769 770
 * If CSS aggregation/compression is enabled, all cascading style sheets added
 * with $options['preprocess'] set to TRUE will be merged into one aggregate
 * file and compressed by removing all extraneous white space.
771
 * Externally hosted stylesheets are never aggregated or compressed.
772 773
 *
 * The reason for aggregating the files is outlined quite thoroughly here:
774 775 776 777
 * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
 * to request overhead, one bigger file just loads faster than two smaller ones
 * half its size."
 *
778 779 780
 * $options['preprocess'] should be only set to TRUE when a file is required for
 * all typical visitors and most pages of a site. It is critical that all
 * preprocessed files are added unconditionally on every page, even if the
781
 * files do not happen to be needed on a page.
782
 *
783 784
 * Non-preprocessed files should only be added to the page when they are
 * actually needed.
785
 *
786 787 788
 * @param $data
 *   (optional) The stylesheet data to be added, depending on what is passed
 *   through to the $options['type'] parameter:
789 790 791 792 793 794 795
 *   - 'file': The path to the CSS file relative to the base_path(), or a
 *     stream wrapper URI. For example: "modules/devel/devel.css" or
 *     "public://generated_css/stylesheet_1.css". Note that Modules should
 *     always prefix the names of their CSS files with the module name; for
 *     example, system-menus.css rather than simply menus.css. Themes can
 *     override module-supplied CSS files based on their filenames, and this
 *     prefixing helps prevent confusing name collisions for theme developers.
796
 *     See drupal_get_css() where the overrides are performed.
797
 *   - 'external': The absolute path to an external CSS file that is not hosted
798 799
 *     on the local server. These files will not be aggregated if CSS
 *     aggregation is enabled.
800
 * @param $options
801
 *   (optional) A string defining the 'type' of CSS that is being added in the
802 803 804 805
 *   $data parameter ('file' or 'external'), or an array which can have any or
 *   all of the following keys:
 *   - 'type': The type of stylesheet being added. Available options are 'file'
 *     or 'external'. Defaults to 'file'.
806 807 808
 *   - 'basename': Force a basename for the file being added. Modules are
 *     expected to use stylesheets with unique filenames, but integration of
 *     external libraries may make this impossible. The basename of
809 810 811
 *     'core/modules/node/node.css' is 'node.css'. If the external library
 *     "node.js" ships with a 'node.css', then a different, unique basename
 *     would be 'node.js.css'.
812 813 814 815 816 817 818
 *   - 'group': A number identifying the aggregation group in which to add the
 *     stylesheet. Available constants are:
 *     - CSS_AGGREGATE_DEFAULT: (default) Any module-layer CSS.
 *     - CSS_AGGREGATE_THEME: Any theme-layer CSS.
 *     The aggregate group number affects load order and the CSS cascade.
 *     Stylesheets in an aggregate with a lower group number will be output to
 *     the page before stylesheets in an aggregate with a higher group number,
819
 *     so CSS within higher aggregate groups can take precedence over CSS
820
 *     within lower aggregate groups.
821 822 823 824
 *   - 'every_page': For optimal front-end performance when aggregation is
 *     enabled, this should be set to TRUE if the stylesheet is present on every
 *     page of the website for users for whom it is present at all. This
 *     defaults to FALSE. It is set to TRUE for stylesheets added via module and
825
 *     theme .info.yml files. Modules that add stylesheets within
826 827
 *     hook_page_attachments() implementations, or from other code that ensures
 *     that the stylesheet is added to all website pages, should also set this flag
828 829 830 831 832 833
 *     to TRUE. All stylesheets within the same group that have the 'every_page'
 *     flag set to TRUE and do not have 'preprocess' set to FALSE are aggregated
 *     together into a single aggregate file, and that aggregate file can be
 *     reused across a user's entire site visit, leading to faster navigation
 *     between pages.
 *     However, stylesheets that are only needed on pages less frequently
834 835 836 837 838 839 840 841 842 843
 *     visited, can be added by code that only runs for those particular pages,
 *     and that code should not set the 'every_page' flag. This minimizes the
 *     size of the aggregate file that the user needs to download when first
 *     visiting the website. Stylesheets without the 'every_page' flag are
 *     aggregated into a separate aggregate file. This other aggregate file is
 *     likely to change from page to page, and each new aggregate file needs to
 *     be downloaded when first encountered, so it should be kept relatively
 *     small by ensuring that most commonly needed stylesheets are added to
 *     every page.
 *   - 'weight': The weight of the stylesheet specifies the order in which the
844 845 846 847
 *     CSS will appear relative to other stylesheets with the same aggregate
 *     group and 'every_page' flag. The exact ordering of stylesheets is as
 *     follows:
 *     - First by aggregate group.
848 849 850
 *     - Then by the 'every_page' flag, with TRUE coming before FALSE.
 *     - Then by weight.
 *     - Then by the order in which the CSS was added. For example, all else
851
 *       being the same, a stylesheet added by a call to _drupal_add_css() that
852
 *       happened later in the page request gets added to the page after one for
853
 *       which _drupal_add_css() happened earlier in the page request.
854 855 856 857
 *     Available constants are:
 *     - CSS_BASE: Styles for HTML elements ("base" styles).
 *     - CSS_LAYOUT: Styles that layout a page.
 *     - CSS_COMPONENT: Styles for design components (and their associated
858
 *       states and themes.)
859
 *     - CSS_STATE: Styles for states that are not included with components.
860
 *     - CSS_THEME: Styles for themes that are not included with components.
861 862
 *     The weight numbers follow the SMACSS convention of CSS categorization.
 *     See http://drupal.org/node/1887922
863
 *   - 'media': The media type for the stylesheet, e.g., all, print, screen.
864
 *     Defaults to 'all'. It is extremely important to leave this set to 'all'
865
 *     or it will negatively impact front-end performance. Instead add a @media
866
 *     block to the included CSS file.
867
 *   - 'preprocess': If TRUE and CSS aggregation/compression is enabled, the
868
 *     styles will be aggregated and compressed. Defaults to TRUE.
869
 *   - 'browsers': An array containing information specifying which browsers
870 871 872
 *     should load the CSS item. See
 *     \Drupal\Core\Render\Element\HtmlTag::preRenderConditionalComments() for
 *     details.
873
 *
874
 * @return
875
 *   An array of queued cascading stylesheets.
876
 *
877 878
 * @deprecated as of Drupal 8.0. Use the #attached key in render arrays instead.
 *
879
 * @see drupal_get_css()
880
 */
881
function _drupal_add_css($data = NULL, $options = NULL) {
882
  $css = &drupal_static(__FUNCTION__, array());
883

884 885 886 887 888 889 890 891 892 893
  // Construct the options, taking the defaults into consideration.
  if (isset($options)) {
    if (!is_array($options)) {
      $options = array('type' => $options);
    }
  }
  else {
    $options = array();
  }

894 895
  // Create an array of CSS files for each media type first, since each type needs to be served
  // to the browser differently.
896
  if (isset($data)) {
897
    $options += array(
898
      'type' => 'file',
899
      'group' => CSS_AGGREGATE_DEFAULT,
900 901
      'weight' => 0,
      'every_page' => FALSE,
902
      'media' => 'all',
903
      'preprocess' => TRUE,
904
      'data' => $data,
905 906 907 908 909
      'browsers' => array(),
    );
    $options['browsers'] += array(
      'IE' => TRUE,
      '!IE' => TRUE,
910
    );
911

912 913 914 915 916
    // Files with a query string cannot be preprocessed.
    if ($options['type'] === 'file' && $options['preprocess'] && strpos($options['data'], '?') !== FALSE) {
      $options['preprocess'] = FALSE;
    }

917 918
    // Always add a tiny value to the weight, to conserve the insertion order.
    $options['weight'] += count($css) / 1000;
919

920 921
    // Add the data to the CSS array depending on the type.
    switch ($options['type']) {
922 923 924 925 926 927 928 929 930 931
      case 'file':
        // Local CSS files are keyed by basename; if a file with the same
        // basename is added more than once, it gets overridden.
        // By default, take over the filename as basename.
        if (!isset($options['basename'])) {
          $options['basename'] = drupal_basename($data);
        }
        $css[$options['basename']] = $options;
        break;

932
      default:
933 934
        // External files are keyed by their full URI, so the same CSS file is
        // not added twice.
935
        $css[$data] = $options;
936 937
    }
  }
938

939 940 941 942
  return $css;
}

/**
943
 * Returns a themed representation of all stylesheets to attach to the page.
944
 *
945 946 947 948 949
 * It loads the CSS in order, with 'module' first, then 'theme' afterwards.
 * This ensures proper cascading of styles so themes can easily override
 * module styles through CSS selectors.
 *
 * Themes may replace module-defined CSS files by adding a stylesheet with the
950
 * same filename. For example, themes/bartik/system-menus.css would replace
951 952 953
 * modules/system/system-menus.css. This allows themes to override complete
 * CSS files, rather than specific selectors, when necessary.
 *
954
 * @param $css
955 956
 *   (optional) An array of CSS files. If no array is provided, the default
 *   stylesheets array is used instead.
957
 * @param $skip_alter
958 959 960
 *   (optional) If set to TRUE, this function skips calling
 *   \Drupal::moduleHandler->alter() on $css, useful when the calling function
 *   passes a $css array that has already been altered.
961
 *
962 963
 * @return
 *   A string of XHTML CSS tags.
964
 *
965
 * @see _drupal_add_css()
966
 */
967 968 969
function drupal_get_css($css = NULL, $skip_alter = FALSE, $theme_add_css = TRUE) {
  $theme_info = \Drupal::theme()->getActiveTheme();

970
  if (!isset($css)) {
971
    $css = _drupal_add_css();
972 973
  }

974
  // Allow modules and themes to alter the CSS items.
975
  if (!$skip_alter) {
976
    \Drupal::moduleHandler()->alter('css', $css);
977
    \Drupal::theme()->alter('css', $css);
978
  }
979

980 981
  // Sort CSS items, so that they appear in the correct order.
  uasort($css, 'drupal_sort_css_js');
982

983
  // Allow themes to remove CSS files by basename.
984
  if ($stylesheet_remove = $theme_info->getStyleSheetsRemove()) {
985
    foreach ($css as $key => $options) {
986
      if (isset($options['basename']) && isset($stylesheet_remove[$options['basename']])) {
987 988 989 990 991
        unset($css[$key]);
      }
    }
  }
  // Allow themes to conditionally override CSS files by basename.
992
  if ($stylesheet_override = $theme_info->getStyleSheetsOverride()) {
993
    foreach ($css as $key => $options) {
994 995
      if (isset($options['basename']) && isset($stylesheet_override[$options['basename']])) {
        $css[$key]['data'] = $stylesheet_override[$options['basename']];
996
      }
997 998 999
    }
  }

1000 1001 1002 1003 1004
  // Render the HTML needed to load the CSS.
  $styles = array(
    '#type' => 'styles',
    '#items' => $css,
  );
1005

1006 1007 1008
  return drupal_render($styles);
}

1009
/**
1010 1011 1012 1013 1014
 * Sorts CSS and JavaScript resources.
 *
 * Callback for uasort() within:
 * - drupal_get_css()
 * - drupal_get_js()
1015 1016 1017 1018
 *
 * This sort order helps optimize front-end performance while providing modules
 * and themes with the necessary control for ordering the CSS and JavaScript
 * appearing on a page.
1019 1020 1021
 *
 * @param $a
 *   First item for comparison. The compared items should be associative ar