common.inc 173 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\Crypt;
15
use Drupal\Component\Utility\Number;
16
use Drupal\Component\Utility\Settings;
17
use Drupal\Component\Utility\SortArray;
18
use Drupal\Component\Utility\String;
19
use Drupal\Component\Utility\Tags;
20
use Drupal\Component\Utility\UrlHelper;
21
use Drupal\Component\Utility\Xss;
22
use Drupal\Core\Cache\Cache;
23
use Drupal\Core\Language\Language;
24 25
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
26
use Drupal\Core\PhpStorage\PhpStorageFactory;
27
use Drupal\Component\Utility\NestedArray;
28
use Drupal\Core\Datetime\DrupalDateTime;
29
use Drupal\Core\EventSubscriber\HtmlViewSubscriber;
30
use Drupal\Core\Routing\GeneratorNotInitializedException;
31
use Drupal\Core\Template\Attribute;
32
use Drupal\Core\Render\Element;
33
use Drupal\Core\Session\AnonymousUserSession;
34

35 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 62
/**
 * @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
 *
63
 * @}
64 65
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

156
  if (isset($region) && isset($data)) {
157 158 159 160 161 162
    $content[$region][] = $data;
  }
  return $content;
}

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

188
/**
189
 * Gets the name of the currently active installation profile.
190 191 192
 *
 * 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
193 194
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
195
 *
196 197 198 199
 * @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.
200 201 202 203
 */
function drupal_get_profile() {
  global $install_state;

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

  return $profile;
}

Dries's avatar
Dries committed
221
/**
222
 * Adds output to the HEAD tag of the HTML page.
223
 *
224
 * This function can be called as long as the headers aren't sent. Pass no
225 226 227 228 229 230 231 232 233 234 235 236
 * 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.
 *
237
 * @see drupal_pre_render_html_tag()
Dries's avatar
Dries committed
238
 */
239 240
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
241

242 243 244 245 246 247 248 249 250 251
  if (!isset($stored_head)) {
    // Make sure the defaults, including Content-Type, come first.
    $stored_head = _drupal_default_html_head();
  }

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

Dries's avatar
 
Dries committed
256
/**
257 258 259 260 261 262 263 264 265 266
 * Returns elements that are always displayed in the HEAD tag of the HTML page.
 */
function _drupal_default_html_head() {
  // Add default elements. Make sure the Content-Type comes first because the
  // IE browser may be vulnerable to XSS via encoding attacks from any content
  // that comes before this META tag, such as a TITLE tag.
  $elements['system_meta_content_type'] = array(
    '#type' => 'html_tag',
    '#tag' => 'meta',
    '#attributes' => array(
267
      'charset' => 'utf-8',
268 269 270 271 272 273
    ),
    // Security: This always has to be output first.
    '#weight' => -1000,
  );
  // Show Drupal and the major version number in the META GENERATOR tag.
  // Get the major version.
274
  list($version, ) = explode('.', \Drupal::VERSION);
275 276 277 278 279 280 281 282 283 284 285 286 287 288
  $elements['system_meta_generator'] = array(
    '#type' => 'html_tag',
    '#tag' => 'meta',
    '#attributes' => array(
      'name' => 'Generator',
      'content' => 'Drupal ' . $version . ' (http://drupal.org)',
    ),
  );
  // Also send the generator in the HTTP header.
  $elements['system_meta_generator']['#attached']['drupal_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
  return $elements;
}

/**
289
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
290
  */
Dries's avatar
Dries committed
291
function drupal_get_html_head() {
292
  $elements = drupal_add_html_head();
293
  \Drupal::moduleHandler()->alter('html_head', $elements);
294
  return drupal_render($elements);
Dries's avatar
Dries committed
295 296
}

297
/**
298
 * Adds a feed URL for the current page.
299
 *
300 301
 * This function can be called as long the HTML header hasn't been sent.
 *
302
 * @param $url
303
 *   An internal system path or a fully qualified external URL of the feed.
304
 * @param $title
305
 *   The title of the feed.
306
 */
307
function drupal_add_feed($url = NULL, $title = '') {
308
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
309

310
  if (isset($url)) {
311 312 313 314 315
    $feed_icon = array(
      '#theme' => 'feed_icon',
      '#url' => $url,
      '#title' => $title,
    );
316

317
    $feed_icon['#attached']['drupal_add_html_head_link'][][] = array(
318 319 320 321 322 323
      'rel' => 'alternate',
      'type' => 'application/rss+xml',
      'title' => $title,
      // Force the URL to be absolute, for consistency with other <link> tags
      // output by Drupal.
      'href' => url($url, array('absolute' => TRUE)),
324
    );
325 326

    $stored_feed_links[$url] = drupal_render($feed_icon);
327 328 329 330 331
  }
  return $stored_feed_links;
}

/**
332
 * Gets the feed URLs for the current page.
333 334
 *
 * @param $delimiter
335
 *   A delimiter to split feeds by.
336 337 338 339 340 341
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
 
Dries committed
342
/**
343
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
344
 * @{
Dries's avatar
 
Dries committed
345
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
346 347
 */

348
/**
349
 * Processes a URL query parameter array to remove unwanted elements.
350 351
 *
 * @param $query
352 353
 *   (optional) An array to be processed. Defaults to \Drupal::request()->query
 *   parameters.
354
 * @param $exclude
355
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
356
 *   exclude nested items.
357
 * @param $parent
358 359
 *   Internal use only. Used to build the $query array key for nested items.
 *
360
 * @return
361
 *   An array containing query parameters, which can be used for url().
362
 *
363
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
364
 *   Use \Drupal\Component\Utility\UrlHelper::filterQueryParameters().
365
 */
366
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
367
  if (!isset($query)) {
368
    $query = \Drupal::request()->query->all();
369
  }
370
  return UrlHelper::filterQueryParameters($query, $exclude, $parent);
371 372
}

373
/**
374
 * Parses an array into a valid, rawurlencoded query string.
375 376 377
 *
 * @see drupal_get_query_parameters()
 * @ingroup php_wrappers
378
 *
379
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
380
 *   Use \Drupal\Component\Utility\UrlHelper::buildQuery().
381 382
 */
function drupal_http_build_query(array $query, $parent = '') {
383
  return UrlHelper::buildQuery($query, $parent);
384 385
}

386
/**
387
 * Prepares a 'destination' URL query parameter for use with url().
388
 *
389 390 391 392
 * 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.
393
 *
394 395 396 397 398 399
 * @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()
400 401
 */
function drupal_get_destination() {
402 403 404 405 406 407
  $destination = &drupal_static(__FUNCTION__);

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

408
  $query = \Drupal::request()->query;
409 410
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
411 412
  }
  else {
413
    $path = current_path();
414
    $query = UrlHelper::buildQuery(UrlHelper::filterQueryParameters($query->all()));
415
    if ($query != '') {
416
      $path .= '?' . $query;
417
    }
418 419 420 421 422
    $destination = array('destination' => $path);
  }
  return $destination;
}

Dries's avatar
 
Dries committed
423
/**
424
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
425
 */
Dries's avatar
 
Dries committed
426

Kjartan's avatar
Kjartan committed
427
/**
Dries's avatar
 
Dries committed
428
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
429
 * @{
Dries's avatar
 
Dries committed
430
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
431 432
 */

433
/**
434
 * Verifies the syntax of the given e-mail address.
Dries's avatar
 
Dries committed
435
 *
436 437
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
438
 *
Dries's avatar
 
Dries committed
439
 * @param $mail
440
 *   A string containing an e-mail address.
441
 *
Dries's avatar
 
Dries committed
442
 * @return
Dries's avatar
 
Dries committed
443
 *   TRUE if the address is in a valid format.
444
 */
Dries's avatar
 
Dries committed
445
function valid_email_address($mail) {
446
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
447 448
}

449 450 451 452
/**
 * @} End of "defgroup validation".
 */

453 454 455 456
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
457 458 459
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
460 461
 */

462
/**
463
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
464 465 466 467 468 469 470
 *
 * @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
471 472 473
 *   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
474
 *   Drupal\Core\Template\Attribute, call
475
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
476
 *
477
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
478
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
479 480
 */
function check_url($uri) {
481
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
482 483
}

484
/**
485
 * Applies a very permissive XSS/HTML filter for admin-only use.
486 487 488
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
489 490
 * is desired (so \Drupal\Component\Utility\String::checkPlain() is not
 * acceptable).
491 492 493
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
494 495 496 497 498 499 500 501
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
502 503
 */
function filter_xss_admin($string) {
504
  return Xss::filterAdmin($string);
505 506 507
}

/**
508
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
509
 *
510 511
 * Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
 * For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
512 513
 *
 * This code does four things:
514 515 516 517 518
 * - Removes characters and constructs that can trick browsers.
 * - Makes sure all HTML entities are well-formed.
 * - Makes sure all HTML tags and attributes are well-formed.
 * - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
 *   javascript:).
519 520
 *
 * @param $string
521 522
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
523 524
 * @param $allowed_tags
 *   An array of allowed tags.
525 526 527 528 529
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
530
 * @see \Drupal\Component\Utility\Xss::filter()
531 532
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
533
  return Xss::filter($string, $allowed_tags);
534 535 536
}

/**
537
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
538
 *
539
 * @param string $string
540
 *   The string with the attribute value.
541
 *
542
 * @return string
543
 *   Cleaned up and HTML-escaped version of $string.
544
 *
545
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
546
 */
547
function filter_xss_bad_protocol($string) {
548
  return UrlHelper::filterBadProtocol($string);
549 550 551 552 553 554
}

/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
555
/**
Dries's avatar
 
Dries committed
556
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
557
 * @{
Dries's avatar
 
Dries committed
558
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
559 560
 */

Dries's avatar
 
Dries committed
561 562 563 564 565
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
566
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
567
  $langcode = $langcode ? $langcode : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT)->id;
Dries's avatar
 
Dries committed
568

Dries's avatar
Dries committed
569
  $output = "<channel>\n";
570
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
571
  $output .= ' <link>' . check_url($link) . "</link>\n";
572 573 574 575

  // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  // We strip all HTML tags, but need to prevent double encoding from properly
  // escaped source data (such as &amp becoming &amp;amp;).
576 577
  $output .= ' <description>' . String::checkPlain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . String::checkPlain($langcode) . "</language>\n";
578
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
579 580 581 582 583 584
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
585
/**
586
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
587 588 589
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
590
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
591
  $output = "<item>\n";
592
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
593
  $output .= ' <link>' . check_url($link) . "</link>\n";
594
  $output .= ' <description>' . String::checkPlain($description) . "</description>\n";
595 596 597 598 599 600 601
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
602
 * Formats XML elements.
603 604
 *
 * @param $array
605
 *   An array where each item represents an element and is either a:
606 607 608 609 610 611 612 613 614 615
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
 *     - 'key': element name
 *     - '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) {
616
  $output = '';
617 618
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
619
      if ($value['key']) {
620
        $output .= ' <' . $value['key'];
621
        if (isset($value['attributes']) && is_array($value['attributes'])) {
622
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
623 624
        }

625
        if (isset($value['value']) && $value['value'] != '') {
626
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
627 628 629 630 631 632 633
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
634
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
635
    }
Dries's avatar
 
Dries committed
636
  }
Dries's avatar
 
Dries committed
637 638 639
  return $output;
}

Dries's avatar
 
Dries committed
640
/**
641
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
642
 *
Dries's avatar
 
Dries committed
643
 * This function ensures that the string is pluralized correctly. Since t() is
644 645
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
646
 *
647 648 649 650 651 652 653 654 655 656
 * 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.',
657
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
658 659
 * @endcode
 *
Dries's avatar
 
Dries committed
660 661 662
 * @param $count
 *   The item count to display.
 * @param $singular
663 664 665
 *   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
666
 * @param $plural
667 668 669
 *   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".
670
 * @param $args
671
 *   An associative array of replacements to make after translation. Instances
672
 *   of any key in this array are replaced with the corresponding value.
673 674 675
 *   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.
676
 * @param $options
677 678
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
679 680
 * @return
 *   A translated string.
681 682 683
 *
 * @see t()
 * @see format_string()
684
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
685
 *
686 687
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
Dries's avatar
 
Dries committed
688
 */
689
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
690
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
 
Dries committed
691 692
}

693
/**
694
 * Parses a given byte count.
695 696
 *
 * @param $size
697 698
 *   A size expressed as a number of bytes with optional SI or IEC binary unit
 *   prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8 bytes, 9mbytes).
699
 *
700
 * @return
701
 *   An integer representation of the size in bytes.
702 703
 */
function parse_size($size) {
704 705 706 707 708 709 710 711
  $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
  $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
  if ($unit) {
    // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
    return round($size * pow(DRUPAL_KILOBYTE, stripos('bkmgtpezy', $unit[0])));
  }
  else {
    return round($size);
712 713 714
  }
}

Dries's avatar
 
Dries committed
715
/**
716
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
717
 *
Dries's avatar
 
Dries committed
718
 * @param $size
719
 *   A size in bytes.
720
 * @param $langcode
721 722
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
723
 *
Dries's avatar
 
Dries committed
724 725
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
726
 */
727
function format_size($size, $langcode = NULL) {
728
  if ($size < DRUPAL_KILOBYTE) {
729
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
730
  }
731
  else {
732
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
733
    $units = array(
734 735 736 737 738 739 740 741
      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)),
742 743
    );
    foreach ($units as $unit) {
744 745
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
746 747 748 749
      }
      else {
        break;
      }
750
    }
751
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
752 753 754
  }
}

Dries's avatar
 
Dries committed
755
/**
756
 * Formats a time interval with the requested granularity.
Dries's avatar
 
Dries committed
757
 *
758
 * @param $interval
Dries's avatar
 
Dries committed
759 760 761
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
762 763 764
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
765
 *
Dries's avatar
 
Dries committed
766 767
 * @return
 *   A translated string representation of the interval.
768
 *
769 770 771 772
 * @see \Drupal\Core\Datetime\Date::formatInterval()
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('date')->formatInterval().
Dries's avatar
 
Dries committed
773
 */
774
function format_interval($interval, $granularity = 2, $langcode = NULL) {
775
  return \Drupal::service('date')->formatInterval($interval, $granularity, $langcode);
Dries's avatar
 
Dries committed
776 777
}

Dries's avatar
 
Dries committed
778
/**
779
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
780
 *
Dries's avatar
 
Dries committed
781
 * @param $timestamp
782
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
783
 * @param $type
784
 *   (optional) The format to use, one of:
785 786 787 788 789
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
 *   - The name of a date type defined by a module in
 *     hook_date_format_types(), if it's been assigned a format.
790 791 792
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
793
 * @param $format
794 795 796
 *   (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
797
 * @param $timezone
798
 *   (optional) Time zone identifier, as described at
799
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
800
 *   display the page.
801
 * @param $langcode
802 803 804
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
805 806
 * @return
 *   A translated date string in the requested format.
807 808
 *
 * @see \Drupal\Component\Datetime\Date::format()
Dries's avatar
 
Dries committed
809
 */
810
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
811
  return \Drupal::service('date')->format($timestamp, $type, $format, $timezone, $langcode);
812 813
}

814 815 816 817 818
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
819
 *
820 821 822 823 824 825 826 827 828
 * @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);
}

829
/**
830 831 832
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
 */
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
853
    }
854 855 856

    if ($code == '') {
      $cache[$langcode][$code][$string] = $string;
857
    }
Dries's avatar
 
Dries committed
858
    else {
859
      $cache[$langcode][$code][$string] = t($string, array(), $options);
Dries's avatar
 
Dries committed
860
    }
Dries's avatar
 
Dries committed
861
  }
862
  return $cache[$langcode][$code][$string];
Dries's avatar
 
Dries committed
863 864
}

865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
/**
 * Retrieves the correct datetime format type for this system.
 *
 * This value is sometimes required when the format type needs to be determined
 * before a date can be created.
 *
 * @return string
 *   A string as defined in \DrupalComponent\Datetime\DateTimePlus.php: either
 *   'intl' or 'php', depending on whether IntlDateFormatter is available.
 */
function datetime_default_format_type() {
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['format_type'] = &drupal_static(__FUNCTION__);
  }
  $format_type = &$drupal_static_fast['format_type'];

  if (!isset($format_type)) {
    $date = new DrupalDateTime();
    $format_type = $date->canUseIntl() ? DrupalDateTime::INTL : DrupalDateTime::PHP;
  }
  return $format_type;
}

Dries's avatar
 
Dries committed
889 890 891
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
892

Dries's avatar
 
Dries committed
893
/**
894 895 896 897
 * 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
898
 *
899
 * @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromPath().
Dries's avatar
 
Dries committed
900
 */
901
function url($path = NULL, array $options = array()) {
902
  $generator = \Drupal::urlGenerator();
903 904
  try {
    $url = $generator->generateFromPath($path, $options);
905
  }
906 907 908 909 910 911 912 913 914
  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);
915
  }
916
  return $url;
Dries's avatar
 
Dries committed
917 918
}

919
/**
920
 * Returns TRUE if a path is external to Drupal (e.g. http://example.com).
921 922 923 924 925 926 927
 *
 * If a path cannot be assessed by Drupal's menu handler, then we must
 * treat it as potentially insecure.
 *
 * @param $path
 *   The internal path or external URL being linked to, such as "node/34" or
 *   "http://example.com/foo".
928
 *
929
 * @return
930
 *   Boolean TRUE or FALSE, where TRUE indicates an external path.
931 932
 */
function url_is_external($path) {
933
  return UrlHelper::isExternal($path);
934 935
}

936
/**
937
 * Formats an attribute string for an HTTP header.
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
 *
 * @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
958
/**
959
 * Formats an internal or external URL link as an HTML anchor tag.
Dries's avatar
 
Dries committed
960
 *
961
 * This function correctly handles aliased paths and adds an 'active' class
962 963 964
 * 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
965
 *
966 967 968 969 970 971 972 973
 * 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.
 *
974 975 976 977 978 979
 * 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.
 *
980 981
 * @param string|array $text
 *   The link text for the anchor tag as a translated string or render array.
982
 * @param string $path
983 984 985
 *   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
986 987 988
 *   \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.
989
 * @param array $options
990 991
 *   An associative array of additional options. Defaults to an empty array. It
 *   may contain the following elements.
992
 *   - 'attributes': An associative array of HTML attributes to apply to the
993 994
 *     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
995 996
 *     to work as an argument for the constructor of the class
 *     Drupal\Core\Template\Attribute($options['attributes']).
997 998
 *   - '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
999 1000 1001
 *     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.
1002 1003 1004 1005
 *   - '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().
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
 *   - '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().
1017
 *   - Additional $options elements used by the url() function.
1018
 *
1019
 * @return string
1020
 *   An HTML string containing a link to the given path.
1021 1022
 *
 * @see url()
1023
 * @see system_page_build()
Dries's avatar
 
Dries committed
1024
 */
1025
function l($text, $path, array $options = array()) {
1026
  // Start building a structured representation of our link to be altered later.
1027
  $variables = array(
1028
    'text' => is_array($text) ? drupal_render($text) : $text,
1029 1030 1031
    'path' => $path,
    'options' => $options,
  );
1032