common.inc 140 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\Render\RenderStackFrame;
26
use Drupal\Core\Site\Settings;
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\EventSubscriber\HtmlViewSubscriber;
33
use Drupal\Core\Routing\GeneratorNotInitializedException;
34
use Drupal\Core\Template\Attribute;
35
use Drupal\Core\Render\Element;
36
use Drupal\Core\Session\AnonymousUserSession;
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 62 63 64 65
/**
 * @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
 *
66
 * @}
67 68
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

148
/**
149
 * Adds content to a specified region.
150 151
 *
 * @param $region
152
 *   Page region the content is added to.
153
 * @param $data
154
 *   Content to be added.
155
 */
156
function drupal_add_region_content($region = NULL, $data = NULL) {
157 158
  static $content = array();

159
  if (isset($region) && isset($data)) {
160 161 162 163 164 165
    $content[$region][] = $data;
  }
  return $content;
}

/**
166
 * Gets assigned content for a given region.
167 168
 *
 * @param $region
169 170
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
171
 * @param $delimiter
172
 *   Content to be inserted between imploded array elements.
173
 */
174 175
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
176 177
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
178
      return implode($delimiter, $content[$region]);
179
    }
180 181 182 183
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
184
        $content[$region] = implode($delimiter, $content[$region]);
185 186 187 188 189 190
      }
    }
    return $content;
  }
}

191
/**
192
 * Gets the name of the currently active installation profile.
193 194 195
 *
 * 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
196 197
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
198
 *
199 200 201 202
 * @return string|null $profile
 *   The name of the installation profile or NULL if no installation profile is
 *   currently active. This is the case for example during the first steps of
 *   the installer or during unit tests.
203 204 205 206
 */
function drupal_get_profile() {
  global $install_state;

207 208 209 210 211 212
  if (drupal_installation_attempted()) {
    // If the profile has been selected return it.
    if (isset($install_state['parameters']['profile'])) {
      $profile = $install_state['parameters']['profile'];
    }
    else {
213
      $profile = NULL;
214
    }
215 216
  }
  else {
217 218
    // Fall back to NULL, if there is no 'install_profile' setting.
    $profile = Settings::get('install_profile');
219 220 221 222 223
  }

  return $profile;
}

Dries's avatar
Dries committed
224
/**
225
 * Adds output to the HEAD tag of the HTML page.
226
 *
227
 * This function can be called as long as the headers aren't sent. Pass no
228 229 230 231 232 233 234 235 236 237 238 239
 * 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.
 *
240
 * @see \Drupal\Core\Render\Element\HtmlTag::preRenderHtmlTag()
Dries's avatar
Dries committed
241
 */
242
function drupal_add_html_head($data = NULL, $key = NULL) {
243
  $stored_head = &drupal_static(__FUNCTION__, array());
244 245 246 247 248 249

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
250 251 252 253
  }
  return $stored_head;
}

254
/**
255
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
256 257 258 259 260 261
 *
 * @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.
262
 */
263
function drupal_get_html_head($render = TRUE) {
264
  $elements = drupal_add_html_head();
265
  \Drupal::moduleHandler()->alter('html_head', $elements);
266 267 268 269 270 271
  if ($render) {
    return drupal_render($elements);
  }
  else {
    return $elements;
  }
Dries's avatar
Dries committed
272 273
}

274
/**
275
 * Adds a feed URL for the current page.
276
 *
277 278
 * This function can be called as long the HTML header hasn't been sent.
 *
279
 * @param $url
280
 *   An internal system path or a fully qualified external URL of the feed.
281
 * @param $title
282
 *   The title of the feed.
283
 */
284
function drupal_add_feed($url = NULL, $title = '') {
285
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
286

287
  if (isset($url)) {
288
    $stored_feed_links[$url] = array('url' => $url, 'title' => $title);
289 290 291 292 293
  }
  return $stored_feed_links;
}

/**
294
 * Gets the feed URLs for the current page.
295
 */
296
function drupal_get_feeds() {
297
  $feeds = drupal_add_feed();
298
  return $feeds;
299 300
}

301
/**
302
 * Prepares a 'destination' URL query parameter for use with url().
303
 *
304 305 306 307
 * 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.
308
 *
309 310 311 312 313 314
 * @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()
315
 * @ingroup form_api
316 317
 */
function drupal_get_destination() {
318 319 320 321 322 323
  $destination = &drupal_static(__FUNCTION__);

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

324
  $query = \Drupal::request()->query;
325 326
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
327 328
  }
  else {
329
    $path = current_path();
330
    $query = UrlHelper::buildQuery(UrlHelper::filterQueryParameters($query->all()));
331
    if ($query != '') {
332
      $path .= '?' . $query;
333
    }
334 335 336 337 338
    $destination = array('destination' => $path);
  }
  return $destination;
}

Kjartan's avatar
Kjartan committed
339
/**
Dries's avatar
 
Dries committed
340
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
341
 * @{
Dries's avatar
 
Dries committed
342
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
343 344
 */

345
/**
346
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
347
 *
348
 * This uses the
349
 * @link http://php.net/manual/filter.filters.validate.php PHP email validation filter. @endlink
350
 *
Dries's avatar
 
Dries committed
351
 * @param $mail
352
 *   A string containing an email address.
353
 *
Dries's avatar
 
Dries committed
354
 * @return
Dries's avatar
 
Dries committed
355
 *   TRUE if the address is in a valid format.
356
 */
Dries's avatar
 
Dries committed
357
function valid_email_address($mail) {
358
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
359 360
}

361 362 363 364
/**
 * @} End of "defgroup validation".
 */

365 366 367 368
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
369 370 371
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
372 373
 */

374
/**
375
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
376 377 378 379 380 381 382
 *
 * @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
383 384 385
 *   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
386
 *   Drupal\Core\Template\Attribute, call
387
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
388
 *
389
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
390
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
391 392
 */
function check_url($uri) {
393
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
394 395
}

396 397 398 399
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
400
/**
Dries's avatar
 
Dries committed
401
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
402
 * @{
Dries's avatar
 
Dries committed
403
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
404 405
 */

406
/**
407
 * Formats XML elements.
408
 *
409 410 411
 * Note: It is the caller's responsibility to sanitize any input parameters.
 * This function does not perform sanitization.
 *
412
 * @param $array
413
 *   An array where each item represents an element and is either a:
414 415
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
416 417
 *     - 'key': The element name. Element names are not sanitized, so do not
 *       pass user input.
418 419 420 421 422 423 424
 *     - '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) {
425
  $output = '';
426 427
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
428
      if ($value['key']) {
429
        $output .= ' <' . $value['key'];
430
        if (isset($value['attributes']) && is_array($value['attributes'])) {
431
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
432 433
        }

434
        if (isset($value['value']) && $value['value'] != '') {
435
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
436 437 438 439 440 441 442
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
443
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
444
    }
Dries's avatar
 
Dries committed
445
  }
446 447 448 449 450
  // @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
451 452
}

Dries's avatar
 
Dries committed
453
/**
454
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
455
 *
Dries's avatar
 
Dries committed
456
 * This function ensures that the string is pluralized correctly. Since t() is
457 458
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
459
 *
460 461 462 463 464 465 466 467 468 469
 * For example:
 * @code
 *   $output = format_plural($node->comment_count, '1 comment', '@count comments');
 * @endcode
 *
 * Example with additional replacements:
 * @code
 *   $output = format_plural($update_count,
 *     'Changed the content type of 1 post from %old-type to %new-type.',
 *     'Changed the content type of @count posts from %old-type to %new-type.',
470
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
471 472
 * @endcode
 *
Dries's avatar
 
Dries committed
473 474 475
 * @param $count
 *   The item count to display.
 * @param $singular
476 477 478
 *   The string for the singular case. Make sure it is clear this is singular,
 *   to ease translation (e.g. use "1 new comment" instead of "1 new"). Do not
 *   use @count in the singular string.
Dries's avatar
 
Dries committed
479
 * @param $plural
480 481 482
 *   The string for the plural case. Make sure it is clear this is plural, to
 *   ease translation. Use @count in place of the item count, as in
 *   "@count new comments".
483
 * @param $args
484
 *   An associative array of replacements to make after translation. Instances
485
 *   of any key in this array are replaced with the corresponding value.
486 487 488
 *   Based on the first character of the key, the value is escaped and/or
 *   themed. See format_string(). Note that you do not need to include @count
 *   in this array; this replacement is done automatically for the plural case.
489
 * @param $options
490 491
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
492 493
 * @return
 *   A translated string.
494 495 496
 *
 * @see t()
 * @see format_string()
497
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
498
 *
499 500
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
Dries's avatar
 
Dries committed
501
 */
502
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
503
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
 
Dries committed
504 505
}

Dries's avatar
 
Dries committed
506
/**
507
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
508
 *
Dries's avatar
 
Dries committed
509
 * @param $size
510
 *   A size in bytes.
511
 * @param $langcode
512 513
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
514
 *
Dries's avatar
 
Dries committed
515 516
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
517
 */
518
function format_size($size, $langcode = NULL) {
519
  if ($size < Bytes::KILOBYTE) {
520
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
521
  }
522
  else {
523
    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
524
    $units = array(
525 526 527 528 529 530 531 532
      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)),
533 534
    );
    foreach ($units as $unit) {
535 536
      if (round($size, 2) >= Bytes::KILOBYTE) {
        $size = $size / Bytes::KILOBYTE;
537 538 539 540
      }
      else {
        break;
      }
541
    }
542
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
543 544 545
  }
}

Dries's avatar
 
Dries committed
546
/**
547
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
548
 *
Dries's avatar
 
Dries committed
549
 * @param $timestamp
550
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
551
 * @param $type
552
 *   (optional) The format to use, one of:
553 554 555
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
556
 *   - The name of a date type defined by a date format config entity.
557 558 559
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
560
 * @param $format
561 562 563
 *   (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
564
 * @param $timezone
565
 *   (optional) Time zone identifier, as described at
566
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
567
 *   display the page.
568
 * @param $langcode
569 570 571
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
572 573
 * @return
 *   A translated date string in the requested format.
574
 *
575
 * @see \Drupal\Component\Datetime\DateFormatter::format()
Dries's avatar
 
Dries committed
576
 */
577
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
578
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
579 580
}

581 582 583 584 585
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
586
 *
587 588 589 590 591 592 593 594 595
 * @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);
}

596
/**
597 598 599
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
 */
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
620
    }
621 622 623

    if ($code == '') {
      $cache[$langcode][$code][$string] = $string;
624
    }
Dries's avatar
 
Dries committed
625
    else {
626
      $cache[$langcode][$code][$string] = t($string, array(), $options);
Dries's avatar
 
Dries committed
627
    }
Dries's avatar
 
Dries committed
628
  }
629
  return $cache[$langcode][$code][$string];
Dries's avatar
 
Dries committed
630 631
}

Dries's avatar
 
Dries committed
632 633 634
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
635

Dries's avatar
 
Dries committed
636
/**
637 638 639 640
 * 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
641
 *
642
 * @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromPath().
Dries's avatar
 
Dries committed
643
 */
644
function url($path = NULL, array $options = array()) {
645
  $generator = \Drupal::urlGenerator();
646 647
  try {
    $url = $generator->generateFromPath($path, $options);
648
  }
649 650 651 652 653 654 655 656 657
  catch (GeneratorNotInitializedException $e) {
    // Fallback to using globals.
    // @todo Remove this once there is no code that calls url() when there is
    //   no request.
    global $base_url, $base_path, $script_path;
    $generator->setBasePath($base_path);
    $generator->setBaseUrl($base_url . '/');
    $generator->setScriptPath($script_path);
    $url = $generator->generateFromPath($path, $options);
658
  }
659
  return $url;
Dries's avatar
 
Dries committed
660 661
}

662
/**
663
 * Formats an attribute string for an HTTP header.
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
 *
 * @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.
 *
 * @see drupal_add_http_header()
 */
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
684
/**
685
 * Formats an internal or external URL link as an HTML anchor tag.
Dries's avatar
 
Dries committed
686
 *
687
 * This function correctly handles aliased paths and adds an 'active' class
688 689 690
 * 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
691
 *
692 693 694 695 696 697 698 699
 * 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
 * t('Visit the <a href="@url">settings</a> page', array('@url' => url('admin')));
 * @endcode
 * This keeps the context of the link title ('settings' in the example) for
 * translators.
 *
700 701 702 703 704 705
 * 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.
 *
706 707
 * @param string|array $text
 *   The link text for the anchor tag as a translated string or render array.
708
 * @param string $path
709 710 711
 *   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
712 713 714
 *   \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.
715
 * @param array $options
716 717
 *   An associative array of additional options. Defaults to an empty array. It
 *   may contain the following elements.
718
 *   - 'attributes': An associative array of HTML attributes to apply to the
719 720
 *     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
721 722
 *     to work as an argument for the constructor of the class
 *     Drupal\Core\Template\Attribute($options['attributes']).
723 724
 *   - '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
725 726 727
 *     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.
728 729 730 731
 *   - '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().
732 733 734 735 736 737 738 739 740 741 742
 *   - '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
 *     system_page_build().
743
 *   - Additional $options elements used by the url() function.
744
 *
745
 * @return string
746
 *   An HTML string containing a link to the given path.
747 748
 *
 * @see url()
749
 * @see system_page_build()
Dries's avatar
 
Dries committed
750
 */
751
function l($text, $path, array $options = array()) {
752
  // Start building a structured representation of our link to be altered later.
753
  $variables = array(
754
    'text' => is_array($text) ? drupal_render($text) : $text,
755 756 757
    'path' => $path,
    'options' => $options,
  );
758

759 760
  // Merge in default options.
  $variables['options'] += array(
761
    'attributes' => array(),
762
    'query' => array(),
763
    'html' => FALSE,
764
    'language' => NULL,
765
    'set_active_class' => FALSE,
766
  );
767

768 769 770 771 772 773
  // 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'])) {
    $variables['options']['attributes']['hreflang'] = $variables['options']['language']->id;
  }

774 775 776 777 778 779 780 781 782
  // 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);
    }
783

784 785 786
    // 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'])) {
787
      $variables['options']['attributes']['data-drupal-link-system-path'] = \Drupal::service('path.alias_manager')->getPathByAlias($path);
788
    }
789 790 791 792 793 794
  }

  // 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']);
795
  }
796 797

  // Allow other modules to modify the structure of the link.
798
  \Drupal::moduleHandler()->alter('link', $variables);
799 800 801 802 803

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

804 805
  // 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.
806
  $url = String::checkPlain(url($variables['path'], $variables['options']));
807 808

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

813 814 815 816 817 818 819 820
/**
 * 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.
821
 *
822 823 824 825 826
 * 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
827
 * to execute a task than only once at the beginning of the script.
828
 *
829 830 831 832 833 834 835 836 837
 * 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.
838 839
 *
 * @ingroup php_wrappers
840 841 842
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
843 844
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
845
    if ($current != 0) {
846 847
      @set_time_limit($time_limit);
    }
848 849 850
  }
}

Dries's avatar
Dries committed
851 852 853 854
/**
 * Returns the path to a system item (module, theme, etc.).
 *
 * @param $type
855 856
 *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
 *   'theme_engine'.
Dries's avatar
Dries committed
857
 * @param $name
858 859
 *   The name of the item for which the path is requested. Ignored for
 *   $type 'core'.
Dries's avatar
Dries committed
860 861
 *
 * @return
862
 *   The path to the requested item or an empty string if the item is not found.
Dries's avatar
Dries committed
863 864 865 866 867
 */
function drupal_get_path($type, $name) {
  return dirname(drupal_get_filename($type, $name));
}

868
/**
869
 * Returns the base URL path (i.e., directory) of the Drupal installation.
870
 *
871 872
 * 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 "/".
873
 *
874 875 876
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
877 878
 */
function base_path() {
879
  return $GLOBALS['base_path'];
880 881
}

882
/**
883
 * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
884
 *
885
 * This function can be called as long the HTML header hasn't been sent, which
886
 * on normal pages is up through the preprocess step of _theme('html'). Adding
887 888
 * a link will overwrite a prior link with the exact same 'rel' and 'href'
 * attributes.
889
 *
890 891 892 893 894 895 896 897 898 899 900 901 902 903
 * @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.
 */
function drupal_add_html_head_link($attributes, $header = FALSE) {
  $element = array(
    '#tag' => 'link',
    '#attributes' => $attributes,
  );
  $href = $attributes['href'];

  if ($header) {
    // Also add a HTTP header "Link:".
904
    $href = '<' . String::checkPlain($attributes['href']) . '>;';
905 906 907 908 909
    unset($attributes['href']);
    $element['#attached']['drupal_add_http_header'][] = array('Link',  $href . drupal_http_header_attributes($attributes), TRUE);
  }

  drupal_add_html_head($element, 'drupal_add_html_head_link:' . $attributes['rel'] . ':' . $href);
910 911
}

912
/**
913 914
 * Adds a cascading stylesheet to the stylesheet queue.
 *
915
 * Calling drupal_static_reset('_drupal_add_css') will clear all cascading
916 917
 * stylesheets added so far.
 *
918 919 920 921 922 923 924 925
 * 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.
 * Preprocessed inline stylesheets will not be aggregated into this single file;
 * instead, they are just compressed upon output on the page. Externally hosted
 * stylesheets are never aggregated or compressed.
 *
 * The reason for aggregating the files is outlined quite thoroughly here:
926 927 928 929
 * 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."
 *
930 931 932 933
 * $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
 * files do not happen to be needed on a page. This is normally done by calling
934
 * _drupal_add_css() in a hook_page_build() implementation.
935
 *
936 937
 * Non-preprocessed files should only be added to the page when they are
 * actually needed.
938
 *
939 940 941
 * @param $data
 *   (optional) The stylesheet data to be added, depending on what is passed
 *   through to the $options['type'] parameter:
942 943 944 945 946 947 948
 *   - '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.
949
 *     See drupal_get_css() where the overrides are performed.
950
 *   - 'inline': A string of CSS that should be placed in the given scope. Note
951 952
 *     that it is better practice to use 'file' stylesheets, rather than
 *     'inline', as the CSS would then be aggregated and cached.
953
 *   - 'external': The absolute path to an external CSS file that is not hosted
954 955
 *     on the local server. These files will not be aggregated if CSS
 *     aggregation is enabled.
956
 * @param $options
957
 *   (optional) A string defining the 'type' of CSS that is being added in the
958 959
 *   $data parameter ('file', 'inline', or 'external'), or an array which can
 *   have any or all of the following keys:
960 961
 *   - 'type': The type of stylesheet being added. Available options are 'file',
 *     'inline' or 'external'. Defaults to 'file'.
962 963 964
 *   - '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
965 966 967
 *     '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'.
968 969 970 971 972 973 974
 *   - '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,
975
 *     so CSS within higher aggregate groups can take precedence over CSS
976
 *     within lower aggregate groups.
977 978 979 980
 *   - '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
981 982 983 984 985 986 987 988 989
 *     theme .info.yml files. Modules that add stylesheets within
 *     hook_page_build() implementations, or from other code that ensures that
 *     the stylesheet is added to all website pages, should also set this flag
 *     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
990 991 992 993 994 995 996 997 998 999
 *     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
1000 1001 1002 1003
 *     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.
1004 1005 1006
 *     - 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
1007
 *       being the same, a stylesheet added by a call to _drupal_add_css() that
1008
 *       happened later in the page request gets added to the page after one for
1009
 *       which _drupal_add_css() happened earlier in the page request.
1010 1011 1012 1013
 *     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
1014
 *       states and themes.)
1015
 *     - CSS_STATE: Styles for states that are not included with components.
1016
 *     - CSS_THEME: Styles for themes that are not included with components.
1017 1018
 *     The weight numbers follow the SMACSS convention of CSS categorization.
 *     See http://drupal.org/node/1887922
1019
 *   - 'media': The media type for the stylesheet, e.g., all, print, screen.
1020
 *     Defaults to 'all'. It is extremely important to leave this set to 'all'
1021
 *     or it will negatively impact front-end performance. Instead add a @media
1022
 *     block to the included CSS file.
1023
 *   - 'preprocess': If TRUE and CSS aggregation/compression is enabled, the
1024
 *     styles will be aggregated and compressed. Defaults to TRUE.
1025
 *   - 'browsers': An array containing information specifying which browsers
1026 1027 1028
 *     should load the CSS item. See
 *     \Drupal\Core\Render\Element\HtmlTag::preRenderConditionalComments() for
 *     details.
1029
 *
1030
 * @return
1031
 *   An array of queued cascading stylesheets.
1032
 *
1033 1034
 * @deprecated as of Drupal 8.0. Use the #attached key in render arrays instead.
 *