common.inc 143 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\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";

147
/**
148
 * Gets the name of the currently active installation profile.
149 150 151
 *
 * 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
152 153
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
154
 *
155 156 157 158
 * @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.
159 160 161 162
 */
function drupal_get_profile() {
  global $install_state;

163 164 165 166 167 168
  if (drupal_installation_attempted()) {
    // If the profile has been selected return it.
    if (isset($install_state['parameters']['profile'])) {
      $profile = $install_state['parameters']['profile'];
    }
    else {
169
      $profile = NULL;
170
    }
171 172
  }
  else {
173 174
    // Fall back to NULL, if there is no 'install_profile' setting.
    $profile = Settings::get('install_profile');
175 176 177 178 179
  }

  return $profile;
}

Dries's avatar
Dries committed
180
/**
181
 * Adds output to the HEAD tag of the HTML page.
182
 *
183
 * This function can be called as long as the headers aren't sent. Pass no
184 185 186 187 188 189 190 191 192 193 194 195
 * 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.
 *
196
 * @see \Drupal\Core\Render\Element\HtmlTag::preRenderHtmlTag()
197 198 199
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
Dries's avatar
Dries committed
200
 */
201
function _drupal_add_html_head($data = NULL, $key = NULL) {
202
  $stored_head = &drupal_static(__FUNCTION__, array());
203 204 205 206 207 208

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
209 210 211 212
  }
  return $stored_head;
}

213
/**
214
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
215 216 217 218 219 220
 *
 * @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.
221 222 223
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
224
 */
225
function drupal_get_html_head($render = TRUE) {
226
  $elements = _drupal_add_html_head();
227
  \Drupal::moduleHandler()->alter('html_head', $elements);
228 229 230 231 232 233
  if ($render) {
    return drupal_render($elements);
  }
  else {
    return $elements;
  }
Dries's avatar
Dries committed
234 235
}

236
/**
237
 * Prepares a 'destination' URL query parameter for use with url().
238
 *
239 240 241 242
 * 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.
243
 *
244 245 246 247 248 249
 * @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()
250
 * @ingroup form_api
251 252
 */
function drupal_get_destination() {
253 254 255 256 257 258
  $destination = &drupal_static(__FUNCTION__);

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

259
  $query = \Drupal::request()->query;
260 261
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
262 263
  }
  else {
264
    $path = current_path();
265
    $query = UrlHelper::buildQuery(UrlHelper::filterQueryParameters($query->all()));
266
    if ($query != '') {
267
      $path .= '?' . $query;
268
    }
269 270 271 272 273
    $destination = array('destination' => $path);
  }
  return $destination;
}

Kjartan's avatar
Kjartan committed
274
/**
Dries's avatar
 
Dries committed
275
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
276
 * @{
Dries's avatar
 
Dries committed
277
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
278 279
 */

280
/**
281
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
282
 *
283
 * This uses the
284
 * @link http://php.net/manual/filter.filters.validate.php PHP email validation filter. @endlink
285
 *
Dries's avatar
 
Dries committed
286
 * @param $mail
287
 *   A string containing an email address.
288
 *
Dries's avatar
 
Dries committed
289
 * @return
Dries's avatar
 
Dries committed
290
 *   TRUE if the address is in a valid format.
291
 */
Dries's avatar
 
Dries committed
292
function valid_email_address($mail) {
293
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
294 295
}

296 297 298 299
/**
 * @} End of "defgroup validation".
 */

300 301 302 303
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
304 305 306
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
307 308
 */

309
/**
310
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
311 312 313 314 315 316 317
 *
 * @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
318 319 320
 *   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
321
 *   Drupal\Core\Template\Attribute, call
322
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
323
 *
324
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
325
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
326 327
 */
function check_url($uri) {
328
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
329 330
}

331 332 333 334
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
335
/**
Dries's avatar
 
Dries committed
336
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
337
 * @{
Dries's avatar
 
Dries committed
338
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
339 340
 */

341
/**
342
 * Formats XML elements.
343
 *
344 345 346
 * Note: It is the caller's responsibility to sanitize any input parameters.
 * This function does not perform sanitization.
 *
347
 * @param $array
348
 *   An array where each item represents an element and is either a:
349 350
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
351 352
 *     - 'key': The element name. Element names are not sanitized, so do not
 *       pass user input.
353 354 355 356 357 358 359
 *     - '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) {
360
  $output = '';
361 362
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
363
      if ($value['key']) {
364
        $output .= ' <' . $value['key'];
365
        if (isset($value['attributes']) && is_array($value['attributes'])) {
366
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
367 368
        }

369
        if (isset($value['value']) && $value['value'] != '') {
370
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
371 372 373 374 375 376 377
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
378
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
379
    }
Dries's avatar
 
Dries committed
380
  }
381 382 383 384 385
  // @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
386 387
}

Dries's avatar
 
Dries committed
388
/**
389
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
390
 *
Dries's avatar
 
Dries committed
391
 * This function ensures that the string is pluralized correctly. Since t() is
392 393
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
394
 *
395 396 397 398 399 400 401 402 403 404
 * 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.',
405
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
406 407
 * @endcode
 *
Dries's avatar
 
Dries committed
408 409 410
 * @param $count
 *   The item count to display.
 * @param $singular
411 412 413
 *   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
414
 * @param $plural
415 416 417
 *   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".
418
 * @param $args
419
 *   An associative array of replacements to make after translation. Instances
420
 *   of any key in this array are replaced with the corresponding value.
421 422 423
 *   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.
424
 * @param $options
425 426
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
427 428
 * @return
 *   A translated string.
429 430 431
 *
 * @see t()
 * @see format_string()
432
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
433
 *
434 435
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
Dries's avatar
 
Dries committed
436
 */
437
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
438
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
 
Dries committed
439 440
}

Dries's avatar
 
Dries committed
441
/**
442
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
443
 *
Dries's avatar
 
Dries committed
444
 * @param $size
445
 *   A size in bytes.
446
 * @param $langcode
447 448
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
449
 *
Dries's avatar
 
Dries committed
450 451
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
452
 */
453
function format_size($size, $langcode = NULL) {
454
  if ($size < Bytes::KILOBYTE) {
455
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
456
  }
457
  else {
458
    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
459
    $units = array(
460 461 462 463 464 465 466 467
      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)),
468 469
    );
    foreach ($units as $unit) {
470 471
      if (round($size, 2) >= Bytes::KILOBYTE) {
        $size = $size / Bytes::KILOBYTE;
472 473 474 475
      }
      else {
        break;
      }
476
    }
477
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
478 479 480
  }
}

Dries's avatar
 
Dries committed
481
/**
482
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
483
 *
Dries's avatar
 
Dries committed
484
 * @param $timestamp
485
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
486
 * @param $type
487
 *   (optional) The format to use, one of:
488 489 490
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
491
 *   - The name of a date type defined by a date format config entity.
492 493 494
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
495
 * @param $format
496 497 498
 *   (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
499
 * @param $timezone
500
 *   (optional) Time zone identifier, as described at
501
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
502
 *   display the page.
503
 * @param $langcode
504 505 506
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
507 508
 * @return
 *   A translated date string in the requested format.
509
 *
510
 * @see \Drupal\Component\Datetime\DateFormatter::format()
Dries's avatar
 
Dries committed
511
 */
512
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
513
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
514 515
}

516 517 518 519 520
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
521
 *
522 523 524 525 526 527 528 529 530
 * @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);
}

531
/**
532 533 534
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
 */
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
555
    }
556 557 558

    if ($code == '') {
      $cache[$langcode][$code][$string] = $string;
559
    }
Dries's avatar
 
Dries committed
560
    else {
561
      $cache[$langcode][$code][$string] = t($string, array(), $options);
Dries's avatar
 
Dries committed
562
    }
Dries's avatar
 
Dries committed
563
  }
564
  return $cache[$langcode][$code][$string];
Dries's avatar
 
Dries committed
565 566
}

Dries's avatar
 
Dries committed
567 568 569
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
570

Dries's avatar
 
Dries committed
571
/**
572 573 574 575
 * 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
576
 *
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
 * @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
593
 */
594
function _url($path = NULL, array $options = array()) {
595
  return \Drupal::urlGenerator()->generateFromPath($path, $options);
Dries's avatar
 
Dries committed
596 597
}

598
/**
599
 * Formats an attribute string for an HTTP header.
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
 *
 * @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
618
/**
619
 * Formats an internal or external URL link as an HTML anchor tag.
Dries's avatar
 
Dries committed
620
 *
621
 * This function correctly handles aliased paths and adds an 'active' class
622 623 624
 * 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
625
 *
626 627 628
 * 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
629
 * t('Visit the <a href="@url">settings</a> page', array('@url' => \Drupal::url('system.admin')));
630 631 632 633
 * @endcode
 * This keeps the context of the link title ('settings' in the example) for
 * translators.
 *
634 635 636 637 638 639
 * 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.
 *
640 641
 * @param string|array $text
 *   The link text for the anchor tag as a translated string or render array.
642
 * @param string $path
643 644 645
 *   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
646 647 648
 *   \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.
649
 * @param array $options
650 651
 *   An associative array of additional options. Defaults to an empty array. It
 *   may contain the following elements.
652
 *   - 'attributes': An associative array of HTML attributes to apply to the
653 654
 *     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
655 656
 *     to work as an argument for the constructor of the class
 *     Drupal\Core\Template\Attribute($options['attributes']).
657 658
 *   - '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
659 660 661
 *     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.
662 663 664 665
 *   - '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().
666 667 668 669 670 671 672 673 674 675
 *   - '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
676
 *     system_page_attachments().
677
 *   - Additional $options elements used by the url() function.
678
 *
679
 * @return string
680
 *   An HTML string containing a link to the given path.
681
 *
682
 * @see _url()
683
 * @see system_page_attachments()
684
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.0.
685
 *   Use \Drupal::l($text, $url) where $url is an instance of
686 687 688 689 690 691 692 693 694
 *   \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();
695
 * $installer_link = \Drupal::l($text, $installer_url);
696
 * $external_url = \Drupal\Core\Url::fromUri('http://example.com', ['query' => ['foo' => 'bar']])->toString();
697
 * $external_link = \Drupal::l($text, $external_url);
698
 * $internal_url = \Drupal\Core\Url::fromRoute('system.admin')->toString();
699
 * $internal_link = \Drupal::l($text, $internal_url);
700
 * @endcode
Dries's avatar
 
Dries committed
701
 */
702
function _l($text, $path, array $options = array()) {
703
  // Start building a structured representation of our link to be altered later.
704
  $variables = array(
705
    'text' => is_array($text) ? drupal_render($text) : $text,
706 707 708
    'path' => $path,
    'options' => $options,
  );
709

710 711
  // Merge in default options.
  $variables['options'] += array(
712
    'attributes' => array(),
713
    'query' => array(),
714
    'html' => FALSE,
715
    'language' => NULL,
716
    'set_active_class' => FALSE,
717
  );
718

719 720 721
  // 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'])) {
722
    $variables['options']['attributes']['hreflang'] = $variables['options']['language']->getId();
723 724
  }

725 726 727 728 729 730 731 732 733
  // 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);
    }
734

735 736 737
    // 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'])) {
738
      $variables['options']['attributes']['data-drupal-link-system-path'] = \Drupal::service('path.alias_manager')->getPathByAlias($path);
739
    }
740 741 742 743 744 745
  }

  // 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']);
746
  }
747 748

  // Allow other modules to modify the structure of the link.
749
  \Drupal::moduleHandler()->alter('link', $variables);
750 751 752 753 754

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

755 756
  // 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.
757
  $url = String::checkPlain(_url($variables['path'], $variables['options']));
758 759

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

764 765 766 767 768 769 770 771
/**
 * 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.
772
 *
773 774 775 776 777
 * 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
778
 * to execute a task than only once at the beginning of the script.
779
 *
780 781 782 783 784 785 786 787 788
 * 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.
789 790
 *
 * @ingroup php_wrappers
791 792 793
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
794 795
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
796
    if ($current != 0) {
797 798
      @set_time_limit($time_limit);
    }
799 800 801
  }
}

Dries's avatar
Dries committed
802 803 804 805
/**
 * Returns the path to a system item (module, theme, etc.).
 *
 * @param $type
806 807
 *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
 *   'theme_engine'.
Dries's avatar
Dries committed
808
 * @param $name
809 810
 *   The name of the item for which the path is requested. Ignored for
 *   $type 'core'.
Dries's avatar
Dries committed
811 812
 *
 * @return
813
 *   The path to the requested item or an empty string if the item is not found.
Dries's avatar
Dries committed
814 815 816 817 818
 */
function drupal_get_path($type, $name) {
  return dirname(drupal_get_filename($type, $name));
}

819
/**
820
 * Returns the base URL path (i.e., directory) of the Drupal installation.
821
 *
822 823
 * 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 "/".
824
 *
825 826 827
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
828 829
 */
function base_path() {
830
  return $GLOBALS['base_path'];
831 832
}

833
/**
834
 * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
835
 *
836
 * This function can be called as long the HTML header hasn't been sent, which
837
 * on normal pages is up through the preprocess step of _theme('html'). Adding
838 839
 * a link will overwrite a prior link with the exact same 'rel' and 'href'
 * attributes.
840
 *
841 842 843 844
 * @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.
845 846 847
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
848
 */
849
function _drupal_add_html_head_link($attributes, $header = FALSE) {
850 851 852 853 854 855 856 857
  $element = array(
    '#tag' => 'link',
    '#attributes' => $attributes,
  );
  $href = $attributes['href'];

  if ($header) {
    // Also add a HTTP header "Link:".
858
    $href = '<' . String::checkPlain($attributes['href']) . '>;';
859
    unset($attributes['href']);
860
    $element['#attached']['http_header'][] = array('Link',  $href . drupal_http_header_attributes($attributes), TRUE);
861 862
  }

863
  _drupal_add_html_head($element, 'html_head_link:' . $attributes['rel'] . ':' . $href);
864 865
}

866
/**
867 868
 * Adds a cascading stylesheet to the stylesheet queue.
 *
869
 * Calling drupal_static_reset('_drupal_add_css') will clear all cascading
870 871
 * stylesheets added so far.
 *
872 873 874 875 876 877 878 879
 * 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:
880 881 882 883
 * 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."
 *
884 885 886
 * $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
887
 * files do not happen to be needed on a page.
888
 *
889 890
 * Non-preprocessed files should only be added to the page when they are
 * actually needed.
891
 *
892 893 894
 * @param $data
 *   (optional) The stylesheet data to be added, depending on what is passed
 *   through to the $options['type'] parameter:
895 896 897 898 899 900 901
 *   - '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.
902
 *     See drupal_get_css() where the overrides are performed.
903
 *   - 'inline': A string of CSS that should be placed in the given scope. Note
904 905
 *     that it is better practice to use 'file' stylesheets, rather than
 *     'inline', as the CSS would then be aggregated and cached.
906
 *   - 'external': The absolute path to an external CSS file that is not hosted
907 908
 *     on the local server. These files will not be aggregated if CSS
 *     aggregation is enabled.
909
 * @param $options
910
 *   (optional) A string defining the 'type' of CSS that is being added in the
911 912
 *   $data parameter ('file', 'inline', or 'external'), or an array which can
 *   have any or all of the following keys:
913 914
 *   - 'type': The type of stylesheet being added. Available options are 'file',
 *     'inline' or 'external'. Defaults to 'file'.
915 916 917
 *   - '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
918 919 920
 *     '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'.
921 922 923 924 925 926 927
 *   - '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,
928
 *     so CSS within higher aggregate groups can take precedence over CSS
929
 *     within lower aggregate groups.