1. 8.2.x core/includes/common.inc
  2. 8.0.x core/includes/common.inc
  3. 8.1.x core/includes/common.inc
  4. 8.3.x core/includes/common.inc
  5. 4.6.x includes/common.inc
  6. 4.7.x includes/common.inc
  7. 5.x includes/common.inc
  8. 6.x includes/common.inc
  9. 7.x includes/common.inc

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.

File

includes/common.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * Common functions that many Drupal modules will need to reference.
  5. *
  6. * The functions that are critical and need to be available even when serving
  7. * a cached page are instead located in bootstrap.inc.
  8. */
  9. /**
  10. * @defgroup php_wrappers PHP wrapper functions
  11. * @{
  12. * Functions that are wrappers or custom implementations of PHP functions.
  13. *
  14. * Certain PHP functions should not be used in Drupal. Instead, Drupal's
  15. * replacement functions should be used.
  16. *
  17. * For example, for improved or more secure UTF8-handling, or RFC-compliant
  18. * handling of URLs in Drupal.
  19. *
  20. * For ease of use and memorizing, all these wrapper functions use the same name
  21. * as the original PHP function, but prefixed with "drupal_". Beware, however,
  22. * that not all wrapper functions support the same arguments as the original
  23. * functions.
  24. *
  25. * You should always use these wrapper functions in your code.
  26. *
  27. * Wrong:
  28. * @code
  29. * $my_substring = substr($original_string, 0, 5);
  30. * @endcode
  31. *
  32. * Correct:
  33. * @code
  34. * $my_substring = drupal_substr($original_string, 0, 5);
  35. * @endcode
  36. *
  37. * @}
  38. */
  39. /**
  40. * Return status for saving which involved creating a new item.
  41. */
  42. define('SAVED_NEW', 1);
  43. /**
  44. * Return status for saving which involved an update to an existing item.
  45. */
  46. define('SAVED_UPDATED', 2);
  47. /**
  48. * Return status for saving which deleted an existing item.
  49. */
  50. define('SAVED_DELETED', 3);
  51. /**
  52. * The default group for system CSS files added to the page.
  53. */
  54. define('CSS_SYSTEM', -100);
  55. /**
  56. * The default group for module CSS files added to the page.
  57. */
  58. define('CSS_DEFAULT', 0);
  59. /**
  60. * The default group for theme CSS files added to the page.
  61. */
  62. define('CSS_THEME', 100);
  63. /**
  64. * The default group for JavaScript and jQuery libraries added to the page.
  65. */
  66. define('JS_LIBRARY', -100);
  67. /**
  68. * The default group for module JavaScript code added to the page.
  69. */
  70. define('JS_DEFAULT', 0);
  71. /**
  72. * The default group for theme JavaScript code added to the page.
  73. */
  74. define('JS_THEME', 100);
  75. /**
  76. * Error code indicating that the request exceeded the specified timeout.
  77. *
  78. * @see drupal_http_request()
  79. */
  80. define('HTTP_REQUEST_TIMEOUT', -1);
  81. /**
  82. * @defgroup block_caching Block Caching
  83. * @{
  84. * Constants that define each block's caching state.
  85. *
  86. * Modules specify how their blocks can be cached in their hook_block_info()
  87. * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the
  88. * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core
  89. * Block module. If the Block module is managing the cache, you can specify that
  90. * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that
  91. * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user
  92. * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can
  93. * be combined with a bitwise-binary or operator; for example,
  94. * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change
  95. * depending on the user role or page it is on.
  96. *
  97. * The block cache is cleared in cache_clear_all(), and uses the same clearing
  98. * policy than page cache (node, comment, user, taxonomy added or updated...).
  99. * Blocks requiring more fine-grained clearing might consider disabling the
  100. * built-in block cache (DRUPAL_NO_CACHE) and roll their own.
  101. *
  102. * Note that user 1 is excluded from block caching.
  103. */
  104. /**
  105. * The block should not get cached.
  106. *
  107. * This setting should be used:
  108. * - For simple blocks (notably those that do not perform any db query), where
  109. * querying the db cache would be more expensive than directly generating the
  110. * content.
  111. * - For blocks that change too frequently.
  112. */
  113. define('DRUPAL_NO_CACHE', -1);
  114. /**
  115. * The block is handling its own caching in its hook_block_view().
  116. *
  117. * This setting is useful when time based expiration is needed or a site uses a
  118. * node access which invalidates standard block cache.
  119. */
  120. define('DRUPAL_CACHE_CUSTOM', -2);
  121. /**
  122. * The block or element can change depending on the user's roles.
  123. *
  124. * This is the default setting for blocks, used when the block does not specify
  125. * anything.
  126. */
  127. define('DRUPAL_CACHE_PER_ROLE', 0x0001);
  128. /**
  129. * The block or element can change depending on the user.
  130. *
  131. * This setting can be resource-consuming for sites with large number of users,
  132. * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
  133. */
  134. define('DRUPAL_CACHE_PER_USER', 0x0002);
  135. /**
  136. * The block or element can change depending on the page being viewed.
  137. */
  138. define('DRUPAL_CACHE_PER_PAGE', 0x0004);
  139. /**
  140. * The block or element is the same for every user and page that it is visible.
  141. */
  142. define('DRUPAL_CACHE_GLOBAL', 0x0008);
  143. /**
  144. * @} End of "defgroup block_caching".
  145. */
  146. /**
  147. * Adds content to a specified region.
  148. *
  149. * @param $region
  150. * Page region the content is added to.
  151. * @param $data
  152. * Content to be added.
  153. */
  154. function drupal_add_region_content($region = NULL, $data = NULL) {
  155. static $content = array();
  156. if (isset($region) && isset($data)) {
  157. $content[$region][] = $data;
  158. }
  159. return $content;
  160. }
  161. /**
  162. * Gets assigned content for a given region.
  163. *
  164. * @param $region
  165. * A specified region to fetch content for. If NULL, all regions will be
  166. * returned.
  167. * @param $delimiter
  168. * Content to be inserted between imploded array elements.
  169. */
  170. function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  171. $content = drupal_add_region_content();
  172. if (isset($region)) {
  173. if (isset($content[$region]) && is_array($content[$region])) {
  174. return implode($delimiter, $content[$region]);
  175. }
  176. }
  177. else {
  178. foreach (array_keys($content) as $region) {
  179. if (is_array($content[$region])) {
  180. $content[$region] = implode($delimiter, $content[$region]);
  181. }
  182. }
  183. return $content;
  184. }
  185. }
  186. /**
  187. * Gets the name of the currently active installation profile.
  188. *
  189. * When this function is called during Drupal's initial installation process,
  190. * the name of the profile that's about to be installed is stored in the global
  191. * installation state. At all other times, the standard Drupal systems variable
  192. * table contains the name of the current profile, and we can call
  193. * variable_get() to determine what one is active.
  194. *
  195. * @return $profile
  196. * The name of the installation profile.
  197. */
  198. function drupal_get_profile() {
  199. global $install_state;
  200. if (isset($install_state['parameters']['profile'])) {
  201. $profile = $install_state['parameters']['profile'];
  202. }
  203. else {
  204. $profile = variable_get('install_profile', 'standard');
  205. }
  206. return $profile;
  207. }
  208. /**
  209. * Sets the breadcrumb trail for the current page.
  210. *
  211. * @param $breadcrumb
  212. * Array of links, starting with "home" and proceeding up to but not including
  213. * the current page.
  214. */
  215. function drupal_set_breadcrumb($breadcrumb = NULL) {
  216. $stored_breadcrumb = &drupal_static(__FUNCTION__);
  217. if (isset($breadcrumb)) {
  218. $stored_breadcrumb = $breadcrumb;
  219. }
  220. return $stored_breadcrumb;
  221. }
  222. /**
  223. * Gets the breadcrumb trail for the current page.
  224. */
  225. function drupal_get_breadcrumb() {
  226. $breadcrumb = drupal_set_breadcrumb();
  227. if (!isset($breadcrumb)) {
  228. $breadcrumb = menu_get_active_breadcrumb();
  229. }
  230. return $breadcrumb;
  231. }
  232. /**
  233. * Returns a string containing RDF namespace declarations for use in XML and
  234. * XHTML output.
  235. */
  236. function drupal_get_rdf_namespaces() {
  237. $xml_rdf_namespaces = array();
  238. // Serializes the RDF namespaces in XML namespace syntax.
  239. if (function_exists('rdf_get_namespaces')) {
  240. foreach (rdf_get_namespaces() as $prefix => $uri) {
  241. $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
  242. }
  243. }
  244. return count($xml_rdf_namespaces) ? "\n " . implode("\n ", $xml_rdf_namespaces) : '';
  245. }
  246. /**
  247. * Adds output to the HEAD tag of the HTML page.
  248. *
  249. * This function can be called as long as the headers aren't sent. Pass no
  250. * arguments (or NULL for both) to retrieve the currently stored elements.
  251. *
  252. * @param $data
  253. * A renderable array. If the '#type' key is not set then 'html_tag' will be
  254. * added as the default '#type'.
  255. * @param $key
  256. * A unique string key to allow implementations of hook_html_head_alter() to
  257. * identify the element in $data. Required if $data is not NULL.
  258. *
  259. * @return
  260. * An array of all stored HEAD elements.
  261. *
  262. * @see theme_html_tag()
  263. */
  264. function drupal_add_html_head($data = NULL, $key = NULL) {
  265. $stored_head = &drupal_static(__FUNCTION__);
  266. if (!isset($stored_head)) {
  267. // Make sure the defaults, including Content-Type, come first.
  268. $stored_head = _drupal_default_html_head();
  269. }
  270. if (isset($data) && isset($key)) {
  271. if (!isset($data['#type'])) {
  272. $data['#type'] = 'html_tag';
  273. }
  274. $stored_head[$key] = $data;
  275. }
  276. return $stored_head;
  277. }
  278. /**
  279. * Returns elements that are always displayed in the HEAD tag of the HTML page.
  280. */
  281. function _drupal_default_html_head() {
  282. // Add default elements. Make sure the Content-Type comes first because the
  283. // IE browser may be vulnerable to XSS via encoding attacks from any content
  284. // that comes before this META tag, such as a TITLE tag.
  285. $elements['system_meta_content_type'] = array(
  286. '#type' => 'html_tag',
  287. '#tag' => 'meta',
  288. '#attributes' => array(
  289. 'http-equiv' => 'Content-Type',
  290. 'content' => 'text/html; charset=utf-8',
  291. ),
  292. // Security: This always has to be output first.
  293. '#weight' => -1000,
  294. );
  295. // Show Drupal and the major version number in the META GENERATOR tag.
  296. // Get the major version.
  297. list($version, ) = explode('.', VERSION);
  298. $elements['system_meta_generator'] = array(
  299. '#type' => 'html_tag',
  300. '#tag' => 'meta',
  301. '#attributes' => array(
  302. 'name' => 'Generator',
  303. 'content' => 'Drupal ' . $version . ' (http://drupal.org)',
  304. ),
  305. );
  306. // Also send the generator in the HTTP header.
  307. $elements['system_meta_generator']['#attached']['drupal_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
  308. return $elements;
  309. }
  310. /**
  311. * Retrieves output to be displayed in the HEAD tag of the HTML page.
  312. */
  313. function drupal_get_html_head() {
  314. $elements = drupal_add_html_head();
  315. drupal_alter('html_head', $elements);
  316. return drupal_render($elements);
  317. }
  318. /**
  319. * Adds a feed URL for the current page.
  320. *
  321. * This function can be called as long the HTML header hasn't been sent.
  322. *
  323. * @param $url
  324. * An internal system path or a fully qualified external URL of the feed.
  325. * @param $title
  326. * The title of the feed.
  327. */
  328. function drupal_add_feed($url = NULL, $title = '') {
  329. $stored_feed_links = &drupal_static(__FUNCTION__, array());
  330. if (isset($url)) {
  331. $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
  332. drupal_add_html_head_link(array(
  333. 'rel' => 'alternate',
  334. 'type' => 'application/rss+xml',
  335. 'title' => $title,
  336. // Force the URL to be absolute, for consistency with other <link> tags
  337. // output by Drupal.
  338. 'href' => url($url, array('absolute' => TRUE)),
  339. ));
  340. }
  341. return $stored_feed_links;
  342. }
  343. /**
  344. * Gets the feed URLs for the current page.
  345. *
  346. * @param $delimiter
  347. * A delimiter to split feeds by.
  348. */
  349. function drupal_get_feeds($delimiter = "\n") {
  350. $feeds = drupal_add_feed();
  351. return implode($feeds, $delimiter);
  352. }
  353. /**
  354. * @defgroup http_handling HTTP handling
  355. * @{
  356. * Functions to properly handle HTTP responses.
  357. */
  358. /**
  359. * Processes a URL query parameter array to remove unwanted elements.
  360. *
  361. * @param $query
  362. * (optional) An array to be processed. Defaults to $_GET.
  363. * @param $exclude
  364. * (optional) A list of $query array keys to remove. Use "parent[child]" to
  365. * exclude nested items. Defaults to array('q').
  366. * @param $parent
  367. * Internal use only. Used to build the $query array key for nested items.
  368. *
  369. * @return
  370. * An array containing query parameters, which can be used for url().
  371. */
  372. function drupal_get_query_parameters(array $query = NULL, array $exclude = array('q'), $parent = '') {
  373. // Set defaults, if none given.
  374. if (!isset($query)) {
  375. $query = $_GET;
  376. }
  377. // If $exclude is empty, there is nothing to filter.
  378. if (empty($exclude)) {
  379. return $query;
  380. }
  381. elseif (!$parent) {
  382. $exclude = array_flip($exclude);
  383. }
  384. $params = array();
  385. foreach ($query as $key => $value) {
  386. $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
  387. if (isset($exclude[$string_key])) {
  388. continue;
  389. }
  390. if (is_array($value)) {
  391. $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
  392. }
  393. else {
  394. $params[$key] = $value;
  395. }
  396. }
  397. return $params;
  398. }
  399. /**
  400. * Splits a URL-encoded query string into an array.
  401. *
  402. * @param $query
  403. * The query string to split.
  404. *
  405. * @return
  406. * An array of URL decoded couples $param_name => $value.
  407. */
  408. function drupal_get_query_array($query) {
  409. $result = array();
  410. if (!empty($query)) {
  411. foreach (explode('&', $query) as $param) {
  412. $param = explode('=', $param, 2);
  413. $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
  414. }
  415. }
  416. return $result;
  417. }
  418. /**
  419. * Parses an array into a valid, rawurlencoded query string.
  420. *
  421. * This differs from http_build_query() as we need to rawurlencode() (instead of
  422. * urlencode()) all query parameters.
  423. *
  424. * @param $query
  425. * The query parameter array to be processed, e.g. $_GET.
  426. * @param $parent
  427. * Internal use only. Used to build the $query array key for nested items.
  428. *
  429. * @return
  430. * A rawurlencoded string which can be used as or appended to the URL query
  431. * string.
  432. *
  433. * @see drupal_get_query_parameters()
  434. * @ingroup php_wrappers
  435. */
  436. function drupal_http_build_query(array $query, $parent = '') {
  437. $params = array();
  438. foreach ($query as $key => $value) {
  439. $key = ($parent ? $parent . '[' . rawurlencode($key) . ']' : rawurlencode($key));
  440. // Recurse into children.
  441. if (is_array($value)) {
  442. $params[] = drupal_http_build_query($value, $key);
  443. }
  444. // If a query parameter value is NULL, only append its key.
  445. elseif (!isset($value)) {
  446. $params[] = $key;
  447. }
  448. else {
  449. // For better readability of paths in query strings, we decode slashes.
  450. $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
  451. }
  452. }
  453. return implode('&', $params);
  454. }
  455. /**
  456. * Prepares a 'destination' URL query parameter for use with drupal_goto().
  457. *
  458. * Used to direct the user back to the referring page after completing a form.
  459. * By default the current URL is returned. If a destination exists in the
  460. * previous request, that destination is returned. As such, a destination can
  461. * persist across multiple pages.
  462. *
  463. * @return
  464. * An associative array containing the key:
  465. * - destination: The path provided via the destination query string or, if
  466. * not available, the current path.
  467. *
  468. * @see current_path()
  469. * @see drupal_goto()
  470. */
  471. function drupal_get_destination() {
  472. $destination = &drupal_static(__FUNCTION__);
  473. if (isset($destination)) {
  474. return $destination;
  475. }
  476. if (isset($_GET['destination'])) {
  477. $destination = array('destination' => $_GET['destination']);
  478. }
  479. else {
  480. $path = $_GET['q'];
  481. $query = drupal_http_build_query(drupal_get_query_parameters());
  482. if ($query != '') {
  483. $path .= '?' . $query;
  484. }
  485. $destination = array('destination' => $path);
  486. }
  487. return $destination;
  488. }
  489. /**
  490. * Parses a URL string into its path, query, and fragment components.
  491. *
  492. * This function splits both internal paths like @code node?b=c#d @endcode and
  493. * external URLs like @code https://example.com/a?b=c#d @endcode into their
  494. * component parts. See
  495. * @link http://tools.ietf.org/html/rfc3986#section-3 RFC 3986 @endlink for an
  496. * explanation of what the component parts are.
  497. *
  498. * Note that, unlike the RFC, when passed an external URL, this function
  499. * groups the scheme, authority, and path together into the path component.
  500. *
  501. * @param string $url
  502. * The internal path or external URL string to parse.
  503. *
  504. * @return array
  505. * An associative array containing:
  506. * - path: The path component of $url. If $url is an external URL, this
  507. * includes the scheme, authority, and path.
  508. * - query: An array of query parameters from $url, if they exist.
  509. * - fragment: The fragment component from $url, if it exists.
  510. *
  511. * @see drupal_goto()
  512. * @see l()
  513. * @see url()
  514. * @see http://tools.ietf.org/html/rfc3986
  515. *
  516. * @ingroup php_wrappers
  517. */
  518. function drupal_parse_url($url) {
  519. $options = array(
  520. 'path' => NULL,
  521. 'query' => array(),
  522. 'fragment' => '',
  523. );
  524. // External URLs: not using parse_url() here, so we do not have to rebuild
  525. // the scheme, host, and path without having any use for it.
  526. if (strpos($url, '://') !== FALSE) {
  527. // Split off everything before the query string into 'path'.
  528. $parts = explode('?', $url);
  529. $options['path'] = $parts[0];
  530. // If there is a query string, transform it into keyed query parameters.
  531. if (isset($parts[1])) {
  532. $query_parts = explode('#', $parts[1]);
  533. parse_str($query_parts[0], $options['query']);
  534. // Take over the fragment, if there is any.
  535. if (isset($query_parts[1])) {
  536. $options['fragment'] = $query_parts[1];
  537. }
  538. }
  539. }
  540. // Internal URLs.
  541. else {
  542. // parse_url() does not support relative URLs, so make it absolute. E.g. the
  543. // relative URL "foo/bar:1" isn't properly parsed.
  544. $parts = parse_url('http://example.com/' . $url);
  545. // Strip the leading slash that was just added.
  546. $options['path'] = substr($parts['path'], 1);
  547. if (isset($parts['query'])) {
  548. parse_str($parts['query'], $options['query']);
  549. }
  550. if (isset($parts['fragment'])) {
  551. $options['fragment'] = $parts['fragment'];
  552. }
  553. }
  554. // The 'q' parameter contains the path of the current page if clean URLs are
  555. // disabled. It overrides the 'path' of the URL when present, even if clean
  556. // URLs are enabled, due to how Apache rewriting rules work.
  557. if (isset($options['query']['q'])) {
  558. $options['path'] = $options['query']['q'];
  559. unset($options['query']['q']);
  560. }
  561. return $options;
  562. }
  563. /**
  564. * Encodes a Drupal path for use in a URL.
  565. *
  566. * For aesthetic reasons slashes are not escaped.
  567. *
  568. * Note that url() takes care of calling this function, so a path passed to that
  569. * function should not be encoded in advance.
  570. *
  571. * @param $path
  572. * The Drupal path to encode.
  573. */
  574. function drupal_encode_path($path) {
  575. return str_replace('%2F', '/', rawurlencode($path));
  576. }
  577. /**
  578. * Sends the user to a different page.
  579. *
  580. * This issues an on-site HTTP redirect. The function makes sure the redirected
  581. * URL is formatted correctly.
  582. *
  583. * Usually the redirected URL is constructed from this function's input
  584. * parameters. However you may override that behavior by setting a
  585. * destination in either the $_REQUEST-array (i.e. by using
  586. * the query string of an URI) This is used to direct the user back to
  587. * the proper page after completing a form. For example, after editing
  588. * a post on the 'admin/content'-page or after having logged on using the
  589. * 'user login'-block in a sidebar. The function drupal_get_destination()
  590. * can be used to help set the destination URL.
  591. *
  592. * Drupal will ensure that messages set by drupal_set_message() and other
  593. * session data are written to the database before the user is redirected.
  594. *
  595. * This function ends the request; use it instead of a return in your menu
  596. * callback.
  597. *
  598. * @param $path
  599. * (optional) A Drupal path or a full URL, which will be passed to url() to
  600. * compute the redirect for the URL.
  601. * @param $options
  602. * (optional) An associative array of additional URL options to pass to url().
  603. * @param $http_response_code
  604. * (optional) The HTTP status code to use for the redirection, defaults to
  605. * 302. The valid values for 3xx redirection status codes are defined in
  606. * @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
  607. * and the
  608. * @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
  609. * - 301: Moved Permanently (the recommended value for most redirects).
  610. * - 302: Found (default in Drupal and PHP, sometimes used for spamming search
  611. * engines).
  612. * - 303: See Other.
  613. * - 304: Not Modified.
  614. * - 305: Use Proxy.
  615. * - 307: Temporary Redirect.
  616. *
  617. * @see drupal_get_destination()
  618. * @see url()
  619. */
  620. function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  621. // A destination in $_GET always overrides the function arguments.
  622. // We do not allow absolute URLs to be passed via $_GET, as this can be an attack vector.
  623. if (isset($_GET['destination']) && !url_is_external($_GET['destination'])) {
  624. $destination = drupal_parse_url($_GET['destination']);
  625. $path = $destination['path'];
  626. $options['query'] = $destination['query'];
  627. $options['fragment'] = $destination['fragment'];
  628. }
  629. // In some cases modules call drupal_goto(current_path()). We need to ensure
  630. // that such a redirect is not to an external URL.
  631. if ($path === current_path() && empty($options['external']) && url_is_external($path)) {
  632. // Force url() to generate a non-external URL.
  633. $options['external'] = FALSE;
  634. }
  635. drupal_alter('drupal_goto', $path, $options, $http_response_code);
  636. // The 'Location' HTTP header must be absolute.
  637. $options['absolute'] = TRUE;
  638. $url = url($path, $options);
  639. header('Location: ' . $url, TRUE, $http_response_code);
  640. // The "Location" header sends a redirect status code to the HTTP daemon. In
  641. // some cases this can be wrong, so we make sure none of the code below the
  642. // drupal_goto() call gets executed upon redirection.
  643. drupal_exit($url);
  644. }
  645. /**
  646. * Delivers a "site is under maintenance" message to the browser.
  647. *
  648. * Page callback functions wanting to report a "site offline" message should
  649. * return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However,
  650. * functions that are invoked in contexts where that return value might not
  651. * bubble up to menu_execute_active_handler() should call drupal_site_offline().
  652. */
  653. function drupal_site_offline() {
  654. drupal_deliver_page(MENU_SITE_OFFLINE);
  655. }
  656. /**
  657. * Delivers a "page not found" error to the browser.
  658. *
  659. * Page callback functions wanting to report a "page not found" message should
  660. * return MENU_NOT_FOUND instead of calling drupal_not_found(). However,
  661. * functions that are invoked in contexts where that return value might not
  662. * bubble up to menu_execute_active_handler() should call drupal_not_found().
  663. */
  664. function drupal_not_found() {
  665. drupal_deliver_page(MENU_NOT_FOUND);
  666. }
  667. /**
  668. * Delivers an "access denied" error to the browser.
  669. *
  670. * Page callback functions wanting to report an "access denied" message should
  671. * return MENU_ACCESS_DENIED instead of calling drupal_access_denied(). However,
  672. * functions that are invoked in contexts where that return value might not
  673. * bubble up to menu_execute_active_handler() should call
  674. * drupal_access_denied().
  675. */
  676. function drupal_access_denied() {
  677. drupal_deliver_page(MENU_ACCESS_DENIED);
  678. }
  679. /**
  680. * Performs an HTTP request.
  681. *
  682. * This is a flexible and powerful HTTP client implementation. Correctly
  683. * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
  684. *
  685. * @param $url
  686. * A string containing a fully qualified URI.
  687. * @param array $options
  688. * (optional) An array that can have one or more of the following elements:
  689. * - headers: An array containing request headers to send as name/value pairs.
  690. * - method: A string containing the request method. Defaults to 'GET'.
  691. * - data: A string containing the request body, formatted as
  692. * 'param=value&param=value&...'; to generate this, use http_build_query().
  693. * Defaults to NULL.
  694. * - max_redirects: An integer representing how many times a redirect
  695. * may be followed. Defaults to 3.
  696. * - timeout: A float representing the maximum number of seconds the function
  697. * call may take. The default is 30 seconds. If a timeout occurs, the error
  698. * code is set to the HTTP_REQUEST_TIMEOUT constant.
  699. * - context: A context resource created with stream_context_create().
  700. *
  701. * @return object
  702. * An object that can have one or more of the following components:
  703. * - request: A string containing the request body that was sent.
  704. * - code: An integer containing the response status code, or the error code
  705. * if an error occurred.
  706. * - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
  707. * - status_message: The status message from the response, if a response was
  708. * received.
  709. * - redirect_code: If redirected, an integer containing the initial response
  710. * status code.
  711. * - redirect_url: If redirected, a string containing the URL of the redirect
  712. * target.
  713. * - error: If an error occurred, the error message. Otherwise not set.
  714. * - headers: An array containing the response headers as name/value pairs.
  715. * HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
  716. * easy access the array keys are returned in lower case.
  717. * - data: A string containing the response body that was received.
  718. *
  719. * @see http_build_query()
  720. */
  721. function drupal_http_request($url, array $options = array()) {
  722. // Allow an alternate HTTP client library to replace Drupal's default
  723. // implementation.
  724. $override_function = variable_get('drupal_http_request_function', FALSE);
  725. if (!empty($override_function) && function_exists($override_function)) {
  726. return $override_function($url, $options);
  727. }
  728. $result = new stdClass();
  729. // Parse the URL and make sure we can handle the schema.
  730. $uri = @parse_url($url);
  731. if ($uri == FALSE) {
  732. $result->error = 'unable to parse URL';
  733. $result->code = -1001;
  734. return $result;
  735. }
  736. if (!isset($uri['scheme'])) {
  737. $result->error = 'missing schema';
  738. $result->code = -1002;
  739. return $result;
  740. }
  741. timer_start(__FUNCTION__);
  742. // Merge the default options.
  743. $options += array(
  744. 'headers' => array(),
  745. 'method' => 'GET',
  746. 'data' => NULL,
  747. 'max_redirects' => 3,
  748. 'timeout' => 30.0,
  749. 'context' => NULL,
  750. );
  751. // Merge the default headers.
  752. $options['headers'] += array(
  753. 'User-Agent' => 'Drupal (+http://drupal.org/)',
  754. );
  755. // stream_socket_client() requires timeout to be a float.
  756. $options['timeout'] = (float) $options['timeout'];
  757. // Use a proxy if one is defined and the host is not on the excluded list.
  758. $proxy_server = variable_get('proxy_server', '');
  759. if ($proxy_server && _drupal_http_use_proxy($uri['host'])) {
  760. // Set the scheme so we open a socket to the proxy server.
  761. $uri['scheme'] = 'proxy';
  762. // Set the path to be the full URL.
  763. $uri['path'] = $url;
  764. // Since the URL is passed as the path, we won't use the parsed query.
  765. unset($uri['query']);
  766. // Add in username and password to Proxy-Authorization header if needed.
  767. if ($proxy_username = variable_get('proxy_username', '')) {
  768. $proxy_password = variable_get('proxy_password', '');
  769. $options['headers']['Proxy-Authorization'] = 'Basic ' . base64_encode($proxy_username . (!empty($proxy_password) ? ":" . $proxy_password : ''));
  770. }
  771. // Some proxies reject requests with any User-Agent headers, while others
  772. // require a specific one.
  773. $proxy_user_agent = variable_get('proxy_user_agent', '');
  774. // The default value matches neither condition.
  775. if ($proxy_user_agent === NULL) {
  776. unset($options['headers']['User-Agent']);
  777. }
  778. elseif ($proxy_user_agent) {
  779. $options['headers']['User-Agent'] = $proxy_user_agent;
  780. }
  781. }
  782. switch ($uri['scheme']) {
  783. case 'proxy':
  784. // Make the socket connection to a proxy server.
  785. $socket = 'tcp://' . $proxy_server . ':' . variable_get('proxy_port', 8080);
  786. // The Host header still needs to match the real request.
  787. $options['headers']['Host'] = $uri['host'];
  788. $options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
  789. break;
  790. case 'http':
  791. case 'feed':
  792. $port = isset($uri['port']) ? $uri['port'] : 80;
  793. $socket = 'tcp://' . $uri['host'] . ':' . $port;
  794. // RFC 2616: "non-standard ports MUST, default ports MAY be included".
  795. // We don't add the standard port to prevent from breaking rewrite rules
  796. // checking the host that do not take into account the port number.
  797. $options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
  798. break;
  799. case 'https':
  800. // Note: Only works when PHP is compiled with OpenSSL support.
  801. $port = isset($uri['port']) ? $uri['port'] : 443;
  802. $socket = 'ssl://' . $uri['host'] . ':' . $port;
  803. $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
  804. break;
  805. default:
  806. $result->error = 'invalid schema ' . $uri['scheme'];
  807. $result->code = -1003;
  808. return $result;
  809. }
  810. if (empty($options['context'])) {
  811. $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
  812. }
  813. else {
  814. // Create a stream with context. Allows verification of a SSL certificate.
  815. $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
  816. }
  817. // Make sure the socket opened properly.
  818. if (!$fp) {
  819. // When a network error occurs, we use a negative number so it does not
  820. // clash with the HTTP status codes.
  821. $result->code = -$errno;
  822. $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
  823. // Mark that this request failed. This will trigger a check of the web
  824. // server's ability to make outgoing HTTP requests the next time that
  825. // requirements checking is performed.
  826. // See system_requirements().
  827. variable_set('drupal_http_request_fails', TRUE);
  828. return $result;
  829. }
  830. // Construct the path to act on.
  831. $path = isset($uri['path']) ? $uri['path'] : '/';
  832. if (isset($uri['query'])) {
  833. $path .= '?' . $uri['query'];
  834. }
  835. // Only add Content-Length if we actually have any content or if it is a POST
  836. // or PUT request. Some non-standard servers get confused by Content-Length in
  837. // at least HEAD/GET requests, and Squid always requires Content-Length in
  838. // POST/PUT requests.
  839. $content_length = strlen($options['data']);
  840. if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
  841. $options['headers']['Content-Length'] = $content_length;
  842. }
  843. // If the server URL has a user then attempt to use basic authentication.
  844. if (isset($uri['user'])) {
  845. $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (isset($uri['pass']) ? ':' . $uri['pass'] : ':'));
  846. }
  847. // If the database prefix is being used by SimpleTest to run the tests in a copied
  848. // database then set the user-agent header to the database prefix so that any
  849. // calls to other Drupal pages will run the SimpleTest prefixed database. The
  850. // user-agent is used to ensure that multiple testing sessions running at the
  851. // same time won't interfere with each other as they would if the database
  852. // prefix were stored statically in a file or database variable.
  853. $test_info = &$GLOBALS['drupal_test_info'];
  854. if (!empty($test_info['test_run_id'])) {
  855. $options['headers']['User-Agent'] = drupal_generate_test_ua($test_info['test_run_id']);
  856. }
  857. $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
  858. foreach ($options['headers'] as $name => $value) {
  859. $request .= $name . ': ' . trim($value) . "\r\n";
  860. }
  861. $request .= "\r\n" . $options['data'];
  862. $result->request = $request;
  863. // Calculate how much time is left of the original timeout value.
  864. $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  865. if ($timeout > 0) {
  866. stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
  867. fwrite($fp, $request);
  868. }
  869. // Fetch response. Due to PHP bugs like http://bugs.php.net/bug.php?id=43782
  870. // and http://bugs.php.net/bug.php?id=46049 we can't rely on feof(), but
  871. // instead must invoke stream_get_meta_data() each iteration.
  872. $info = stream_get_meta_data($fp);
  873. $alive = !$info['eof'] && !$info['timed_out'];
  874. $response = '';
  875. while ($alive) {
  876. // Calculate how much time is left of the original timeout value.
  877. $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  878. if ($timeout <= 0) {
  879. $info['timed_out'] = TRUE;
  880. break;
  881. }
  882. stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
  883. $chunk = fread($fp, 1024);
  884. $response .= $chunk;
  885. $info = stream_get_meta_data($fp);
  886. $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
  887. }
  888. fclose($fp);
  889. if ($info['timed_out']) {
  890. $result->code = HTTP_REQUEST_TIMEOUT;
  891. $result->error = 'request timed out';
  892. return $result;
  893. }
  894. // Parse response headers from the response body.
  895. // Be tolerant of malformed HTTP responses that separate header and body with
  896. // \n\n or \r\r instead of \r\n\r\n.
  897. list($response, $result->data) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
  898. $response = preg_split("/\r\n|\n|\r/", $response);
  899. // Parse the response status line.
  900. $response_status_array = _drupal_parse_response_status(trim(array_shift($response)));
  901. $result->protocol = $response_status_array['http_version'];
  902. $result->status_message = $response_status_array['reason_phrase'];
  903. $code = $response_status_array['response_code'];
  904. $result->headers = array();
  905. // Parse the response headers.
  906. while ($line = trim(array_shift($response))) {
  907. list($name, $value) = explode(':', $line, 2);
  908. $name = strtolower($name);
  909. if (isset($result->headers[$name]) && $name == 'set-cookie') {
  910. // RFC 2109: the Set-Cookie response header comprises the token Set-
  911. // Cookie:, followed by a comma-separated list of one or more cookies.
  912. $result->headers[$name] .= ',' . trim($value);
  913. }
  914. else {
  915. $result->headers[$name] = trim($value);
  916. }
  917. }
  918. $responses = array(
  919. 100 => 'Continue',
  920. 101 => 'Switching Protocols',
  921. 200 => 'OK',
  922. 201 => 'Created',
  923. 202 => 'Accepted',
  924. 203 => 'Non-Authoritative Information',
  925. 204 => 'No Content',
  926. 205 => 'Reset Content',
  927. 206 => 'Partial Content',
  928. 300 => 'Multiple Choices',
  929. 301 => 'Moved Permanently',
  930. 302 => 'Found',
  931. 303 => 'See Other',
  932. 304 => 'Not Modified',
  933. 305 => 'Use Proxy',
  934. 307 => 'Temporary Redirect',
  935. 400 => 'Bad Request',
  936. 401 => 'Unauthorized',
  937. 402 => 'Payment Required',
  938. 403 => 'Forbidden',
  939. 404 => 'Not Found',
  940. 405 => 'Method Not Allowed',
  941. 406 => 'Not Acceptable',
  942. 407 => 'Proxy Authentication Required',
  943. 408 => 'Request Time-out',
  944. 409 => 'Conflict',
  945. 410 => 'Gone',
  946. 411 => 'Length Required',
  947. 412 => 'Precondition Failed',
  948. 413 => 'Request Entity Too Large',
  949. 414 => 'Request-URI Too Large',
  950. 415 => 'Unsupported Media Type',
  951. 416 => 'Requested range not satisfiable',
  952. 417 => 'Expectation Failed',
  953. 500 => 'Internal Server Error',
  954. 501 => 'Not Implemented',
  955. 502 => 'Bad Gateway',
  956. 503 => 'Service Unavailable',
  957. 504 => 'Gateway Time-out',
  958. 505 => 'HTTP Version not supported',
  959. );
  960. // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  961. // base code in their class.
  962. if (!isset($responses[$code])) {
  963. $code = floor($code / 100) * 100;
  964. }
  965. $result->code = $code;
  966. switch ($code) {
  967. case 200: // OK
  968. case 201: // Created
  969. case 202: // Accepted
  970. case 203: // Non-Authoritative Information
  971. case 204: // No Content
  972. case 205: // Reset Content
  973. case 206: // Partial Content
  974. case 304: // Not modified
  975. break;
  976. case 301: // Moved permanently
  977. case 302: // Moved temporarily
  978. case 307: // Moved temporarily
  979. $location = $result->headers['location'];
  980. $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
  981. if ($options['timeout'] <= 0) {
  982. $result->code = HTTP_REQUEST_TIMEOUT;
  983. $result->error = 'request timed out';
  984. }
  985. elseif ($options['max_redirects']) {
  986. // Redirect to the new location.
  987. $options['max_redirects']--;
  988. $result = drupal_http_request($location, $options);
  989. $result->redirect_code = $code;
  990. }
  991. if (!isset($result->redirect_url)) {
  992. $result->redirect_url = $location;
  993. }
  994. break;
  995. default:
  996. $result->error = $result->status_message;
  997. }
  998. return $result;
  999. }
  1000. /**
  1001. * Splits an HTTP response status line into components.
  1002. *
  1003. * See the @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html status line definition @endlink
  1004. * in RFC 2616.
  1005. *
  1006. * @param string $respone
  1007. * The response status line, for example 'HTTP/1.1 500 Internal Server Error'.
  1008. *
  1009. * @return array
  1010. * Keyed array containing the component parts. If the response is malformed,
  1011. * all possible parts will be extracted. 'reason_phrase' could be empty.
  1012. * Possible keys:
  1013. * - 'http_version'
  1014. * - 'response_code'
  1015. * - 'reason_phrase'
  1016. */
  1017. function _drupal_parse_response_status($response) {
  1018. $response_array = explode(' ', trim($response), 3);
  1019. // Set up empty values.
  1020. $result = array(
  1021. 'reason_phrase' => '',
  1022. );
  1023. $result['http_version'] = $response_array[0];
  1024. $result['response_code'] = $response_array[1];
  1025. if (isset($response_array[2])) {
  1026. $result['reason_phrase'] = $response_array[2];
  1027. }
  1028. return $result;
  1029. }
  1030. /**
  1031. * Helper function for determining hosts excluded from needing a proxy.
  1032. *
  1033. * @return
  1034. * TRUE if a proxy should be used for this host.
  1035. */
  1036. function _drupal_http_use_proxy($host) {
  1037. $proxy_exceptions = variable_get('proxy_exceptions', array('localhost', '127.0.0.1'));
  1038. return !in_array(strtolower($host), $proxy_exceptions, TRUE);
  1039. }
  1040. /**
  1041. * @} End of "HTTP handling".
  1042. */
  1043. /**
  1044. * Strips slashes from a string or array of strings.
  1045. *
  1046. * Callback for array_walk() within fix_gpx_magic().
  1047. *
  1048. * @param $item
  1049. * An individual string or array of strings from superglobals.
  1050. */
  1051. function _fix_gpc_magic(&$item) {
  1052. if (is_array($item)) {
  1053. array_walk($item, '_fix_gpc_magic');
  1054. }
  1055. else {
  1056. $item = stripslashes($item);
  1057. }
  1058. }
  1059. /**
  1060. * Strips slashes from $_FILES items.
  1061. *
  1062. * Callback for array_walk() within fix_gpc_magic().
  1063. *
  1064. * The tmp_name key is skipped keys since PHP generates single backslashes for
  1065. * file paths on Windows systems.
  1066. *
  1067. * @param $item
  1068. * An item from $_FILES.
  1069. * @param $key
  1070. * The key for the item within $_FILES.
  1071. *
  1072. * @see http://php.net/manual/features.file-upload.php#42280
  1073. */
  1074. function _fix_gpc_magic_files(&$item, $key) {
  1075. if ($key != 'tmp_name') {
  1076. if (is_array($item)) {
  1077. array_walk($item, '_fix_gpc_magic_files');
  1078. }
  1079. else {
  1080. $item = stripslashes($item);
  1081. }
  1082. }
  1083. }
  1084. /**
  1085. * Fixes double-escaping caused by "magic quotes" in some PHP installations.
  1086. *
  1087. * @see _fix_gpc_magic()
  1088. * @see _fix_gpc_magic_files()
  1089. */
  1090. function fix_gpc_magic() {
  1091. static $fixed = FALSE;
  1092. if (!$fixed && ini_get('magic_quotes_gpc')) {
  1093. array_walk($_GET, '_fix_gpc_magic');
  1094. array_walk($_POST, '_fix_gpc_magic');
  1095. array_walk($_COOKIE, '_fix_gpc_magic');
  1096. array_walk($_REQUEST, '_fix_gpc_magic');
  1097. array_walk($_FILES, '_fix_gpc_magic_files');
  1098. }
  1099. $fixed = TRUE;
  1100. }
  1101. /**
  1102. * @defgroup validation Input validation
  1103. * @{
  1104. * Functions to validate user input.
  1105. */
  1106. /**
  1107. * Verifies the syntax of the given e-mail address.
  1108. *
  1109. * This uses the
  1110. * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
  1111. *
  1112. * @param $mail
  1113. * A string containing an e-mail address.
  1114. *
  1115. * @return
  1116. * TRUE if the address is in a valid format.
  1117. */
  1118. function valid_email_address($mail) {
  1119. return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
  1120. }
  1121. /**
  1122. * Verifies the syntax of the given URL.
  1123. *
  1124. * This function should only be used on actual URLs. It should not be used for
  1125. * Drupal menu paths, which can contain arbitrary characters.
  1126. * Valid values per RFC 3986.
  1127. * @param $url
  1128. * The URL to verify.
  1129. * @param $absolute
  1130. * Whether the URL is absolute (beginning with a scheme such as "http:").
  1131. *
  1132. * @return
  1133. * TRUE if the URL is in a valid format.
  1134. */
  1135. function valid_url($url, $absolute = FALSE) {
  1136. if ($absolute) {
  1137. return (bool)preg_match("
  1138. /^ # Start at the beginning of the text
  1139. (?:ftp|https?|feed):\/\/ # Look for ftp, http, https or feed schemes
  1140. (?: # Userinfo (optional) which is typically
  1141. (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)* # a username or a username and password
  1142. (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@ # combination
  1143. )?
  1144. (?:
  1145. (?:[a-z0-9\-\.]|%[0-9a-f]{2})+ # A domain name or a IPv4 address
  1146. |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\]) # or a well formed IPv6 address
  1147. )
  1148. (?::[0-9]+)? # Server port number (optional)
  1149. (?:[\/|\?]
  1150. (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2}) # The path and query (optional)
  1151. *)?
  1152. $/xi", $url);
  1153. }
  1154. else {
  1155. return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
  1156. }
  1157. }
  1158. /**
  1159. * @} End of "defgroup validation".
  1160. */
  1161. /**
  1162. * Registers an event for the current visitor to the flood control mechanism.
  1163. *
  1164. * @param $name
  1165. * The name of an event.
  1166. * @param $window
  1167. * Optional number of seconds before this event expires. Defaults to 3600 (1
  1168. * hour). Typically uses the same value as the flood_is_allowed() $window
  1169. * parameter. Expired events are purged on cron run to prevent the flood table
  1170. * from growing indefinitely.
  1171. * @param $identifier
  1172. * Optional identifier (defaults to the current user's IP address).
  1173. */
  1174. function flood_register_event($name, $window = 3600, $identifier = NULL) {
  1175. if (!isset($identifier)) {
  1176. $identifier = ip_address();
  1177. }
  1178. db_insert('flood')
  1179. ->fields(array(
  1180. 'event' => $name,
  1181. 'identifier' => $identifier,
  1182. 'timestamp' => REQUEST_TIME,
  1183. 'expiration' => REQUEST_TIME + $window,
  1184. ))
  1185. ->execute();
  1186. }
  1187. /**
  1188. * Makes the flood control mechanism forget an event for the current visitor.
  1189. *
  1190. * @param $name
  1191. * The name of an event.
  1192. * @param $identifier
  1193. * Optional identifier (defaults to the current user's IP address).
  1194. */
  1195. function flood_clear_event($name, $identifier = NULL) {
  1196. if (!isset($identifier)) {
  1197. $identifier = ip_address();
  1198. }
  1199. db_delete('flood')
  1200. ->condition('event', $name)
  1201. ->condition('identifier', $identifier)
  1202. ->execute();
  1203. }
  1204. /**
  1205. * Checks whether a user is allowed to proceed with the specified event.
  1206. *
  1207. * Events can have thresholds saying that each user can only do that event
  1208. * a certain number of times in a time window. This function verifies that the
  1209. * current user has not exceeded this threshold.
  1210. *
  1211. * @param $name
  1212. * The unique name of the event.
  1213. * @param $threshold
  1214. * The maximum number of times each user can do this event per time window.
  1215. * @param $window
  1216. * Number of seconds in the time window for this event (default is 3600
  1217. * seconds, or 1 hour).
  1218. * @param $identifier
  1219. * Unique identifier of the current user. Defaults to their IP address.
  1220. *
  1221. * @return
  1222. * TRUE if the user is allowed to proceed. FALSE if they have exceeded the
  1223. * threshold and should not be allowed to proceed.
  1224. */
  1225. function flood_is_allowed($name, $threshold, $window = 3600, $identifier = NULL) {
  1226. if (!isset($identifier)) {
  1227. $identifier = ip_address();
  1228. }
  1229. $number = db_query("SELECT COUNT(*) FROM {flood} WHERE event = :event AND identifier = :identifier AND timestamp > :timestamp", array(
  1230. ':event' => $name,
  1231. ':identifier' => $identifier,
  1232. ':timestamp' => REQUEST_TIME - $window))
  1233. ->fetchField();
  1234. return ($number < $threshold);
  1235. }
  1236. /**
  1237. * @defgroup sanitization Sanitization functions
  1238. * @{
  1239. * Functions to sanitize values.
  1240. *
  1241. * See http://drupal.org/writing-secure-code for information
  1242. * on writing secure code.
  1243. */
  1244. /**
  1245. * Strips dangerous protocols (e.g. 'javascript:') from a URI.
  1246. *
  1247. * This function must be called for all URIs within user-entered input prior
  1248. * to being output to an HTML attribute value. It is often called as part of
  1249. * check_url() or filter_xss(), but those functions return an HTML-encoded
  1250. * string, so this function can be called independently when the output needs to
  1251. * be a plain-text string for passing to t(), l(), drupal_attributes(), or
  1252. * another function that will call check_plain() separately.
  1253. *
  1254. * @param $uri
  1255. * A plain-text URI that might contain dangerous protocols.
  1256. *
  1257. * @return
  1258. * A plain-text URI stripped of dangerous protocols. As with all plain-text
  1259. * strings, this return value must not be output to an HTML page without
  1260. * check_plain() being called on it. However, it can be passed to functions
  1261. * expecting plain-text strings.
  1262. *
  1263. * @see check_url()
  1264. */
  1265. function drupal_strip_dangerous_protocols($uri) {
  1266. static $allowed_protocols;
  1267. if (!isset($allowed_protocols)) {
  1268. $allowed_protocols = array_flip(variable_get('filter_allowed_protocols', array('ftp', 'http', 'https', 'irc', 'mailto', 'news', 'nntp', 'rtsp', 'sftp', 'ssh', 'tel', 'telnet', 'webcal')));
  1269. }
  1270. // Iteratively remove any invalid protocol found.
  1271. do {
  1272. $before = $uri;
  1273. $colonpos = strpos($uri, ':');
  1274. if ($colonpos > 0) {
  1275. // We found a colon, possibly a protocol. Verify.
  1276. $protocol = substr($uri, 0, $colonpos);
  1277. // If a colon is preceded by a slash, question mark or hash, it cannot
  1278. // possibly be part of the URL scheme. This must be a relative URL, which
  1279. // inherits the (safe) protocol of the base document.
  1280. if (preg_match('![/?#]!', $protocol)) {
  1281. break;
  1282. }
  1283. // Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
  1284. // (URI Comparison) scheme comparison must be case-insensitive.
  1285. if (!isset($allowed_protocols[strtolower($protocol)])) {
  1286. $uri = substr($uri, $colonpos + 1);
  1287. }
  1288. }
  1289. } while ($before != $uri);
  1290. return $uri;
  1291. }
  1292. /**
  1293. * Strips dangerous protocols from a URI and encodes it for output to HTML.
  1294. *
  1295. * @param $uri
  1296. * A plain-text URI that might contain dangerous protocols.
  1297. *
  1298. * @return
  1299. * A URI stripped of dangerous protocols and encoded for output to an HTML
  1300. * attribute value. Because it is already encoded, it should not be set as a
  1301. * value within a $attributes array passed to drupal_attributes(), because
  1302. * drupal_attributes() expects those values to be plain-text strings. To pass
  1303. * a filtered URI to drupal_attributes(), call
  1304. * drupal_strip_dangerous_protocols() instead.
  1305. *
  1306. * @see drupal_strip_dangerous_protocols()
  1307. */
  1308. function check_url($uri) {
  1309. return check_plain(drupal_strip_dangerous_protocols($uri));
  1310. }
  1311. /**
  1312. * Applies a very permissive XSS/HTML filter for admin-only use.
  1313. *
  1314. * Use only for fields where it is impractical to use the
  1315. * whole filter system, but where some (mainly inline) mark-up
  1316. * is desired (so check_plain() is not acceptable).
  1317. *
  1318. * Allows all tags that can be used inside an HTML body, save
  1319. * for scripts and styles.
  1320. */
  1321. function filter_xss_admin($string) {
  1322. return filter_xss($string, array('a', 'abbr', 'acronym', 'address', 'article', 'aside', 'b', 'bdi', 'bdo', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'command', 'dd', 'del', 'details', 'dfn', 'div', 'dl', 'dt', 'em', 'figcaption', 'figure', 'footer', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header', 'hgroup', 'hr', 'i', 'img', 'ins', 'kbd', 'li', 'mark', 'menu', 'meter', 'nav', 'ol', 'output', 'p', 'pre', 'progress', 'q', 'rp', 'rt', 'ruby', 's', 'samp', 'section', 'small', 'span', 'strong', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'time', 'tr', 'tt', 'u', 'ul', 'var', 'wbr'));
  1323. }
  1324. /**
  1325. * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
  1326. *
  1327. * Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
  1328. * For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
  1329. *
  1330. * This code does four things:
  1331. * - Removes characters and constructs that can trick browsers.
  1332. * - Makes sure all HTML entities are well-formed.
  1333. * - Makes sure all HTML tags and attributes are well-formed.
  1334. * - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
  1335. * javascript:).
  1336. *
  1337. * @param $string
  1338. * The string with raw HTML in it. It will be stripped of everything that can
  1339. * cause an XSS attack.
  1340. * @param $allowed_tags
  1341. * An array of allowed tags.
  1342. *
  1343. * @return
  1344. * An XSS safe version of $string, or an empty string if $string is not
  1345. * valid UTF-8.
  1346. *
  1347. * @see drupal_validate_utf8()
  1348. */
  1349. function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
  1350. // Only operate on valid UTF-8 strings. This is necessary to prevent cross
  1351. // site scripting issues on Internet Explorer 6.
  1352. if (!drupal_validate_utf8($string)) {
  1353. return '';
  1354. }
  1355. // Store the text format.
  1356. _filter_xss_split($allowed_tags, TRUE);
  1357. // Remove NULL characters (ignored by some browsers).
  1358. $string = str_replace(chr(0), '', $string);
  1359. // Remove Netscape 4 JS entities.
  1360. $string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
  1361. // Defuse all HTML entities.
  1362. $string = str_replace('&', '&amp;', $string);
  1363. // Change back only well-formed entities in our whitelist:
  1364. // Decimal numeric entities.
  1365. $string = preg_replace('/&amp;#([0-9]+;)/', '&#\1', $string);
  1366. // Hexadecimal numeric entities.
  1367. $string = preg_replace('/&amp;#[Xx]0*((?:[0-9A-Fa-f]{2})+;)/', '&#x\1', $string);
  1368. // Named entities.
  1369. $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]*;)/', '&\1', $string);
  1370. return preg_replace_callback('%
  1371. (
  1372. <(?=[^a-zA-Z!/]) # a lone <
  1373. | # or
  1374. <!--.*?--> # a comment
  1375. | # or
  1376. <[^>]*(>|$) # a string that starts with a <, up until the > or the end of the string
  1377. | # or
  1378. > # just a >
  1379. )%x', '_filter_xss_split', $string);
  1380. }
  1381. /**
  1382. * Processes an HTML tag.
  1383. *
  1384. * @param $m
  1385. * An array with various meaning depending on the value of $store.
  1386. * If $store is TRUE then the array contains the allowed tags.
  1387. * If $store is FALSE then the array has one element, the HTML tag to process.
  1388. * @param $store
  1389. * Whether to store $m.
  1390. *
  1391. * @return
  1392. * If the element isn't allowed, an empty string. Otherwise, the cleaned up
  1393. * version of the HTML element.
  1394. */
  1395. function _filter_xss_split($m, $store = FALSE) {
  1396. static $allowed_html;
  1397. if ($store) {
  1398. $allowed_html = array_flip($m);
  1399. return;
  1400. }
  1401. $string = $m[1];
  1402. if (substr($string, 0, 1) != '<') {
  1403. // We matched a lone ">" character.
  1404. return '&gt;';
  1405. }
  1406. elseif (strlen($string) == 1) {
  1407. // We matched a lone "<" character.
  1408. return '&lt;';
  1409. }
  1410. if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9\-]+)([^>]*)>?|(<!--.*?-->)$%', $string, $matches)) {
  1411. // Seriously malformed.
  1412. return '';
  1413. }
  1414. $slash = trim($matches[1]);
  1415. $elem = &$matches[2];
  1416. $attrlist = &$matches[3];
  1417. $comment = &$matches[4];
  1418. if ($comment) {
  1419. $elem = '!--';
  1420. }
  1421. if (!isset($allowed_html[strtolower($elem)])) {
  1422. // Disallowed HTML element.
  1423. return '';
  1424. }
  1425. if ($comment) {
  1426. return $comment;
  1427. }
  1428. if ($slash != '') {
  1429. return "</$elem>";
  1430. }
  1431. // Is there a closing XHTML slash at the end of the attributes?
  1432. $attrlist = preg_replace('%(\s?)/\s*$%', '\1', $attrlist, -1, $count);
  1433. $xhtml_slash = $count ? ' /' : '';
  1434. // Clean up attributes.
  1435. $attr2 = implode(' ', _filter_xss_attributes($attrlist));
  1436. $attr2 = preg_replace('/[<>]/', '', $attr2);
  1437. $attr2 = strlen($attr2) ? ' ' . $attr2 : '';
  1438. return "<$elem$attr2$xhtml_slash>";
  1439. }
  1440. /**
  1441. * Processes a string of HTML attributes.
  1442. *
  1443. * @return
  1444. * Cleaned up version of the HTML attributes.
  1445. */
  1446. function _filter_xss_attributes($attr) {
  1447. $attrarr = array();
  1448. $mode = 0;
  1449. $attrname = '';
  1450. while (strlen($attr) != 0) {
  1451. // Was the last operation successful?
  1452. $working = 0;
  1453. switch ($mode) {
  1454. case 0:
  1455. // Attribute name, href for instance.
  1456. if (preg_match('/^([-a-zA-Z]+)/', $attr, $match)) {
  1457. $attrname = strtolower($match[1]);
  1458. $skip = ($attrname == 'style' || substr($attrname, 0, 2) == 'on');
  1459. $working = $mode = 1;
  1460. $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
  1461. }
  1462. break;
  1463. case 1:
  1464. // Equals sign or valueless ("selected").
  1465. if (preg_match('/^\s*=\s*/', $attr)) {
  1466. $working = 1; $mode = 2;
  1467. $attr = preg_replace('/^\s*=\s*/', '', $attr);
  1468. break;
  1469. }
  1470. if (preg_match('/^\s+/', $attr)) {
  1471. $working = 1; $mode = 0;
  1472. if (!$skip) {
  1473. $attrarr[] = $attrname;
  1474. }
  1475. $attr = preg_replace('/^\s+/', '', $attr);
  1476. }
  1477. break;
  1478. case 2:
  1479. // Attribute value, a URL after href= for instance.
  1480. if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) {
  1481. $thisval = filter_xss_bad_protocol($match[1]);
  1482. if (!$skip) {
  1483. $attrarr[] = "$attrname=\"$thisval\"";
  1484. }
  1485. $working = 1;
  1486. $mode = 0;
  1487. $attr = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
  1488. break;
  1489. }
  1490. if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) {
  1491. $thisval = filter_xss_bad_protocol($match[1]);
  1492. if (!$skip) {
  1493. $attrarr[] = "$attrname='$thisval'";
  1494. }
  1495. $working = 1; $mode = 0;
  1496. $attr = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
  1497. break;
  1498. }
  1499. if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) {
  1500. $thisval = filter_xss_bad_protocol($match[1]);
  1501. if (!$skip) {
  1502. $attrarr[] = "$attrname=\"$thisval\"";
  1503. }
  1504. $working = 1; $mode = 0;
  1505. $attr = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
  1506. }
  1507. break;
  1508. }
  1509. if ($working == 0) {
  1510. // Not well formed; remove and try again.
  1511. $attr = preg_replace('/
  1512. ^
  1513. (
  1514. "[^"]*("|$) # - a string that starts with a double quote, up until the next double quote or the end of the string
  1515. | # or
  1516. \'[^\']*(\'|$)| # - a string that starts with a quote, up until the next quote or the end of the string
  1517. | # or
  1518. \S # - a non-whitespace character
  1519. )* # any number of the above three
  1520. \s* # any number of whitespaces
  1521. /x', '', $attr);
  1522. $mode = 0;
  1523. }
  1524. }
  1525. // The attribute list ends with a valueless attribute like "selected".
  1526. if ($mode == 1 && !$skip) {
  1527. $attrarr[] = $attrname;
  1528. }
  1529. return $attrarr;
  1530. }
  1531. /**
  1532. * Processes an HTML attribute value and strips dangerous protocols from URLs.
  1533. *
  1534. * @param $string
  1535. * The string with the attribute value.
  1536. * @param $decode
  1537. * (deprecated) Whether to decode entities in the $string. Set to FALSE if the
  1538. * $string is in plain text, TRUE otherwise. Defaults to TRUE. This parameter
  1539. * is deprecated and will be removed in Drupal 8. To process a plain-text URI,
  1540. * call drupal_strip_dangerous_protocols() or check_url() instead.
  1541. *
  1542. * @return
  1543. * Cleaned up and HTML-escaped version of $string.
  1544. */
  1545. function filter_xss_bad_protocol($string, $decode = TRUE) {
  1546. // Get the plain text representation of the attribute value (i.e. its meaning).
  1547. // @todo Remove the $decode parameter in Drupal 8, and always assume an HTML
  1548. // string that needs decoding.
  1549. if ($decode) {
  1550. if (!function_exists('decode_entities')) {
  1551. require_once DRUPAL_ROOT . '/includes/unicode.inc';
  1552. }
  1553. $string = decode_entities($string);
  1554. }
  1555. return check_plain(drupal_strip_dangerous_protocols($string));
  1556. }
  1557. /**
  1558. * @} End of "defgroup sanitization".
  1559. */
  1560. /**
  1561. * @defgroup format Formatting
  1562. * @{
  1563. * Functions to format numbers, strings, dates, etc.
  1564. */
  1565. /**
  1566. * Formats an RSS channel.
  1567. *
  1568. * Arbitrary elements may be added using the $args associative array.
  1569. */
  1570. function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
  1571. global $language_content;
  1572. $langcode = $langcode ? $langcode : $language_content->language;
  1573. $output = "<channel>\n";
  1574. $output .= ' <title>' . check_plain($title) . "</title>\n";
  1575. $output .= ' <link>' . check_url($link) . "</link>\n";
  1576. // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  1577. // We strip all HTML tags, but need to prevent double encoding from properly
  1578. // escaped source data (such as &amp becoming &amp;amp;).
  1579. $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  1580. $output .= ' <language>' . check_plain($langcode) . "</language>\n";
  1581. $output .= format_xml_elements($args);
  1582. $output .= $items;
  1583. $output .= "</channel>\n";
  1584. return $output;
  1585. }
  1586. /**
  1587. * Formats a single RSS item.
  1588. *
  1589. * Arbitrary elements may be added using the $args associative array.
  1590. */
  1591. function format_rss_item($title, $link, $description, $args = array()) {
  1592. $output = "<item>\n";
  1593. $output .= ' <title>' . check_plain($title) . "</title>\n";
  1594. $output .= ' <link>' . check_url($link) . "</link>\n";
  1595. $output .= ' <description>' . check_plain($description) . "</description>\n";
  1596. $output .= format_xml_elements($args);
  1597. $output .= "</item>\n";
  1598. return $output;
  1599. }
  1600. /**
  1601. * Formats XML elements.
  1602. *
  1603. * @param $array
  1604. * An array where each item represents an element and is either a:
  1605. * - (key => value) pair (<key>value</key>)
  1606. * - Associative array with fields:
  1607. * - 'key': element name
  1608. * - 'value': element contents
  1609. * - 'attributes': associative array of element attributes
  1610. * - 'encoded': TRUE if 'value' is already encoded
  1611. *
  1612. * In both cases, 'value' can be a simple string, or it can be another array
  1613. * with the same format as $array itself for nesting.
  1614. *
  1615. * If 'encoded' is TRUE it is up to the caller to ensure that 'value' is either
  1616. * entity-encoded or CDATA-escaped. Using this option is not recommended when
  1617. * working with untrusted user input, since failing to escape the data
  1618. * correctly has security implications.
  1619. */
  1620. function format_xml_elements($array) {
  1621. $output = '';
  1622. foreach ($array as $key => $value) {
  1623. if (is_numeric($key)) {
  1624. if ($value['key']) {
  1625. $output .= ' <' . $value['key'];
  1626. if (isset($value['attributes']) && is_array($value['attributes'])) {
  1627. $output .= drupal_attributes($value['attributes']);
  1628. }
  1629. if (isset($value['value']) && $value['value'] != '') {
  1630. $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : (!empty($value['encoded']) ? $value['value'] : check_plain($value['value']))) . '</' . $value['key'] . ">\n";
  1631. }
  1632. else {
  1633. $output .= " />\n";
  1634. }
  1635. }
  1636. }
  1637. else {
  1638. $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
  1639. }
  1640. }
  1641. return $output;
  1642. }
  1643. /**
  1644. * Formats a string containing a count of items.
  1645. *
  1646. * This function ensures that the string is pluralized correctly. Since t() is
  1647. * called by this function, make sure not to pass already-localized strings to
  1648. * it.
  1649. *
  1650. * For example:
  1651. * @code
  1652. * $output = format_plural($node->comment_count, '1 comment', '@count comments');
  1653. * @endcode
  1654. *
  1655. * Example with additional replacements:
  1656. * @code
  1657. * $output = format_plural($update_count,
  1658. * 'Changed the content type of 1 post from %old-type to %new-type.',
  1659. * 'Changed the content type of @count posts from %old-type to %new-type.',
  1660. * array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
  1661. * @endcode
  1662. *
  1663. * @param $count
  1664. * The item count to display.
  1665. * @param $singular
  1666. * The string for the singular case. Make sure it is clear this is singular,
  1667. * to ease translation (e.g. use "1 new comment" instead of "1 new"). Do not
  1668. * use @count in the singular string.
  1669. * @param $plural
  1670. * The string for the plural case. Make sure it is clear this is plural, to
  1671. * ease translation. Use @count in place of the item count, as in
  1672. * "@count new comments".
  1673. * @param $args
  1674. * An associative array of replacements to make after translation. Instances
  1675. * of any key in this array are replaced with the corresponding value.
  1676. * Based on the first character of the key, the value is escaped and/or
  1677. * themed. See format_string(). Note that you do not need to include @count
  1678. * in this array; this replacement is done automatically for the plural case.
  1679. * @param $options
  1680. * An associative array of additional options. See t() for allowed keys.
  1681. *
  1682. * @return
  1683. * A translated string.
  1684. *
  1685. * @see t()
  1686. * @see format_string()
  1687. */
  1688. function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
  1689. $args['@count'] = $count;
  1690. if ($count == 1) {
  1691. return t($singular, $args, $options);
  1692. }
  1693. // Get the plural index through the gettext formula.
  1694. $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
  1695. // If the index cannot be computed, use the plural as a fallback (which
  1696. // allows for most flexiblity with the replaceable @count value).
  1697. if ($index < 0) {
  1698. return t($plural, $args, $options);
  1699. }
  1700. else {
  1701. switch ($index) {
  1702. case "0":
  1703. return t($singular, $args, $options);
  1704. case "1":
  1705. return t($plural, $args, $options);
  1706. default:
  1707. unset($args['@count']);
  1708. $args['@count[' . $index . ']'] = $count;
  1709. return t(strtr($plural, array('@count' => '@count[' . $index . ']')), $args, $options);
  1710. }
  1711. }
  1712. }
  1713. /**
  1714. * Parses a given byte count.
  1715. *
  1716. * @param $size
  1717. * A size expressed as a number of bytes with optional SI or IEC binary unit
  1718. * prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8 bytes, 9mbytes).
  1719. *
  1720. * @return
  1721. * An integer representation of the size in bytes.
  1722. */
  1723. function parse_size($size) {
  1724. $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
  1725. $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
  1726. if ($unit) {
  1727. // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
  1728. return round($size * pow(DRUPAL_KILOBYTE, stripos('bkmgtpezy', $unit[0])));
  1729. }
  1730. else {
  1731. return round($size);
  1732. }
  1733. }
  1734. /**
  1735. * Generates a string representation for the given byte count.
  1736. *
  1737. * @param $size
  1738. * A size in bytes.
  1739. * @param $langcode
  1740. * Optional language code to translate to a language other than what is used
  1741. * to display the page.
  1742. *
  1743. * @return
  1744. * A translated string representation of the size.
  1745. */
  1746. function format_size($size, $langcode = NULL) {
  1747. if ($size < DRUPAL_KILOBYTE) {
  1748. return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
  1749. }
  1750. else {
  1751. $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
  1752. $units = array(
  1753. t('@size KB', array(), array('langcode' => $langcode)),
  1754. t('@size MB', array(), array('langcode' => $langcode)),
  1755. t('@size GB', array(), array('langcode' => $langcode)),
  1756. t('@size TB', array(), array('langcode' => $langcode)),
  1757. t('@size PB', array(), array('langcode' => $langcode)),
  1758. t('@size EB', array(), array('langcode' => $langcode)),
  1759. t('@size ZB', array(), array('langcode' => $langcode)),
  1760. t('@size YB', array(), array('langcode' => $langcode)),
  1761. );
  1762. foreach ($units as $unit) {
  1763. if (round($size, 2) >= DRUPAL_KILOBYTE) {
  1764. $size = $size / DRUPAL_KILOBYTE;
  1765. }
  1766. else {
  1767. break;
  1768. }
  1769. }
  1770. return str_replace('@size', round($size, 2), $unit);
  1771. }
  1772. }
  1773. /**
  1774. * Formats a time interval with the requested granularity.
  1775. *
  1776. * @param $interval
  1777. * The length of the interval in seconds.
  1778. * @param $granularity
  1779. * How many different units to display in the string.
  1780. * @param $langcode
  1781. * Optional language code to translate to a language other than
  1782. * what is used to display the page.
  1783. *
  1784. * @return
  1785. * A translated string representation of the interval.
  1786. */
  1787. function format_interval($interval, $granularity = 2, $langcode = NULL) {
  1788. $units = array(
  1789. '1 year|@count years' => 31536000,
  1790. '1 month|@count months' => 2592000,
  1791. '1 week|@count weeks' => 604800,
  1792. '1 day|@count days' => 86400,
  1793. '1 hour|@count hours' => 3600,
  1794. '1 min|@count min' => 60,
  1795. '1 sec|@count sec' => 1
  1796. );
  1797. $output = '';
  1798. foreach ($units as $key => $value) {
  1799. $key = explode('|', $key);
  1800. if ($interval >= $value) {
  1801. $output .= ($output ? ' ' : '') . format_plural(floor($interval / $value), $key[0], $key[1], array(), array('langcode' => $langcode));
  1802. $interval %= $value;
  1803. $granularity--;
  1804. }
  1805. if ($granularity == 0) {
  1806. break;
  1807. }
  1808. }
  1809. return $output ? $output : t('0 sec', array(), array('langcode' => $langcode));
  1810. }
  1811. /**
  1812. * Formats a date, using a date type or a custom date format string.
  1813. *
  1814. * @param $timestamp
  1815. * A UNIX timestamp to format.
  1816. * @param $type
  1817. * (optional) The format to use, one of:
  1818. * - 'short', 'medium', or 'long' (the corresponding built-in date formats).
  1819. * - The name of a date type defined by a module in hook_date_format_types(),
  1820. * if it's been assigned a format.
  1821. * - The machine name of an administrator-defined date format.
  1822. * - 'custom', to use $format.
  1823. * Defaults to 'medium'.
  1824. * @param $format
  1825. * (optional) If $type is 'custom', a PHP date format string suitable for
  1826. * input to date(). Use a backslash to escape ordinary text, so it does not
  1827. * get interpreted as date format characters.
  1828. * @param $timezone
  1829. * (optional) Time zone identifier, as described at
  1830. * http://php.net/manual/timezones.php Defaults to the time zone used to
  1831. * display the page.
  1832. * @param $langcode
  1833. * (optional) Language code to translate to. Defaults to the language used to
  1834. * display the page.
  1835. *
  1836. * @return
  1837. * A translated date string in the requested format.
  1838. */
  1839. function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
  1840. // Use the advanced drupal_static() pattern, since this is called very often.
  1841. static $drupal_static_fast;
  1842. if (!isset($drupal_static_fast)) {
  1843. $drupal_static_fast['timezones'] = &drupal_static(__FUNCTION__);
  1844. }
  1845. $timezones = &$drupal_static_fast['timezones'];
  1846. if (!isset($timezone)) {
  1847. $timezone = date_default_timezone_get();
  1848. }
  1849. // Store DateTimeZone objects in an array rather than repeatedly
  1850. // constructing identical objects over the life of a request.
  1851. if (!isset($timezones[$timezone])) {
  1852. $timezones[$timezone] = timezone_open($timezone);
  1853. }
  1854. // Use the default langcode if none is set.
  1855. global $language;
  1856. if (empty($langcode)) {
  1857. $langcode = isset($language->language) ? $language->language : 'en';
  1858. }
  1859. switch ($type) {
  1860. case 'short':
  1861. $format = variable_get('date_format_short', 'm/d/Y - H:i');
  1862. break;
  1863. case 'long':
  1864. $format = variable_get('date_format_long', 'l, F j, Y - H:i');
  1865. break;
  1866. case 'custom':
  1867. // No change to format.
  1868. break;
  1869. case 'medium':
  1870. default:
  1871. // Retrieve the format of the custom $type passed.
  1872. if ($type != 'medium') {
  1873. $format = variable_get('date_format_' . $type, '');
  1874. }
  1875. // Fall back to 'medium'.
  1876. if ($format === '') {
  1877. $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
  1878. }
  1879. break;
  1880. }
  1881. // Create a DateTime object from the timestamp.
  1882. $date_time = date_create('@' . $timestamp);
  1883. // Set the time zone for the DateTime object.
  1884. date_timezone_set($date_time, $timezones[$timezone]);
  1885. // Encode markers that should be translated. 'A' becomes '\xEF\AA\xFF'.
  1886. // xEF and xFF are invalid UTF-8 sequences, and we assume they are not in the
  1887. // input string.
  1888. // Paired backslashes are isolated to prevent errors in read-ahead evaluation.
  1889. // The read-ahead expression ensures that A matches, but not \A.
  1890. $format = preg_replace(array('/\\\\\\\\/', '/(?<!\\\\)([AaeDlMTF])/'), array("\xEF\\\\\\\\\xFF", "\xEF\\\\\$1\$1\xFF"), $format);
  1891. // Call date_format().
  1892. $format = date_format($date_time, $format);
  1893. // Pass the langcode to _format_date_callback().
  1894. _format_date_callback(NULL, $langcode);
  1895. // Translate the marked sequences.
  1896. return preg_replace_callback('/\xEF([AaeDlMTF]?)(.*?)\xFF/', '_format_date_callback', $format);
  1897. }
  1898. /**
  1899. * Returns an ISO8601 formatted date based on the given date.
  1900. *
  1901. * Callback for use within hook_rdf_mapping() implementations.
  1902. *
  1903. * @param $date
  1904. * A UNIX timestamp.
  1905. *
  1906. * @return string
  1907. * An ISO8601 formatted date.
  1908. */
  1909. function date_iso8601($date) {
  1910. // The DATE_ISO8601 constant cannot be used here because it does not match
  1911. // date('c') and produces invalid RDF markup.
  1912. return date('c', $date);
  1913. }
  1914. /**
  1915. * Translates a formatted date string.
  1916. *
  1917. * Callback for preg_replace_callback() within format_date().
  1918. */
  1919. function _format_date_callback(array $matches = NULL, $new_langcode = NULL) {
  1920. // We cache translations to avoid redundant and rather costly calls to t().
  1921. static $cache, $langcode;
  1922. if (!isset($matches)) {
  1923. $langcode = $new_langcode;
  1924. return;
  1925. }
  1926. $code = $matches[1];
  1927. $string = $matches[2];
  1928. if (!isset($cache[$langcode][$code][$string])) {
  1929. $options = array(
  1930. 'langcode' => $langcode,
  1931. );
  1932. if ($code == 'F') {
  1933. $options['context'] = 'Long month name';
  1934. }
  1935. if ($code == '') {
  1936. $cache[$langcode][$code][$string] = $string;
  1937. }
  1938. else {
  1939. $cache[$langcode][$code][$string] = t($string, array(), $options);
  1940. }
  1941. }
  1942. return $cache[$langcode][$code][$string];
  1943. }
  1944. /**
  1945. * Format a username.
  1946. *
  1947. * This is also the label callback implementation of
  1948. * callback_entity_info_label() for user_entity_info().
  1949. *
  1950. * By default, the passed-in object's 'name' property is used if it exists, or
  1951. * else, the site-defined value for the 'anonymous' variable. However, a module
  1952. * may override this by implementing hook_username_alter(&$name, $account).
  1953. *
  1954. * @see hook_username_alter()
  1955. *
  1956. * @param $account
  1957. * The account object for the user whose name is to be formatted.
  1958. *
  1959. * @return
  1960. * An unsanitized string with the username to display. The code receiving
  1961. * this result must ensure that check_plain() is called on it before it is
  1962. * printed to the page.
  1963. */
  1964. function format_username($account) {
  1965. $name = !empty($account->name) ? $account->name : variable_get('anonymous', t('Anonymous'));
  1966. drupal_alter('username', $name, $account);
  1967. return $name;
  1968. }
  1969. /**
  1970. * @} End of "defgroup format".
  1971. */
  1972. /**
  1973. * Generates an internal or external URL.
  1974. *
  1975. * When creating links in modules, consider whether l() could be a better
  1976. * alternative than url().
  1977. *
  1978. * @param $path
  1979. * (optional) The internal path or external URL being linked to, such as
  1980. * "node/34" or "http://example.com/foo". The default value is equivalent to
  1981. * passing in '<front>'. A few notes:
  1982. * - If you provide a full URL, it will be considered an external URL.
  1983. * - If you provide only the path (e.g. "node/34"), it will be
  1984. * considered an internal link. In this case, it should be a system URL,
  1985. * and it will be replaced with the alias, if one exists. Additional query
  1986. * arguments for internal paths must be supplied in $options['query'], not
  1987. * included in $path.
  1988. * - If you provide an internal path and $options['alias'] is set to TRUE, the
  1989. * path is assumed already to be the correct path alias, and the alias is
  1990. * not looked up.
  1991. * - The special string '<front>' generates a link to the site's base URL.
  1992. * - If your external URL contains a query (e.g. http://example.com/foo?a=b),
  1993. * then you can either URL encode the query keys and values yourself and
  1994. * include them in $path, or use $options['query'] to let this function
  1995. * URL encode them.
  1996. * @param $options
  1997. * (optional) An associative array of additional options, with the following
  1998. * elements:
  1999. * - 'query': An array of query key/value-pairs (without any URL-encoding) to
  2000. * append to the URL.
  2001. * - 'fragment': A fragment identifier (named anchor) to append to the URL.
  2002. * Do not include the leading '#' character.
  2003. * - 'absolute': Defaults to FALSE. Whether to force the output to be an
  2004. * absolute link (beginning with http:). Useful for links that will be
  2005. * displayed outside the site, such as in an RSS feed.
  2006. * - 'alias': Defaults to FALSE. Whether the given path is a URL alias
  2007. * already.
  2008. * - 'external': Whether the given path is an external URL.
  2009. * - 'language': An optional language object. If the path being linked to is
  2010. * internal to the site, $options['language'] is used to look up the alias
  2011. * for the URL. If $options['language'] is omitted, the global $language_url
  2012. * will be used.
  2013. * - 'https': Whether this URL should point to a secure location. If not
  2014. * defined, the current scheme is used, so the user stays on HTTP or HTTPS
  2015. * respectively. TRUE enforces HTTPS and FALSE enforces HTTP, but HTTPS can
  2016. * only be enforced when the variable 'https' is set to TRUE.
  2017. * - 'base_url': Only used internally, to modify the base URL when a language
  2018. * dependent URL requires so.
  2019. * - 'prefix': Only used internally, to modify the path when a language
  2020. * dependent URL requires so.
  2021. * - 'script': The script filename in Drupal's root directory to use when
  2022. * clean URLs are disabled, such as 'index.php'. Defaults to an empty
  2023. * string, as most modern web servers automatically find 'index.php'. If
  2024. * clean URLs are disabled, the value of $path is appended as query
  2025. * parameter 'q' to $options['script'] in the returned URL. When deploying
  2026. * Drupal on a web server that cannot be configured to automatically find
  2027. * index.php, then hook_url_outbound_alter() can be implemented to force
  2028. * this value to 'index.php'.
  2029. * - 'entity_type': The entity type of the object that called url(). Only
  2030. * set if url() is invoked by entity_uri().
  2031. * - 'entity': The entity object (such as a node) for which the URL is being
  2032. * generated. Only set if url() is invoked by entity_uri().
  2033. *
  2034. * @return
  2035. * A string containing a URL to the given path.
  2036. */
  2037. function url($path = NULL, array $options = array()) {
  2038. // Merge in defaults.
  2039. $options += array(
  2040. 'fragment' => '',
  2041. 'query' => array(),
  2042. 'absolute' => FALSE,
  2043. 'alias' => FALSE,
  2044. 'prefix' => ''
  2045. );
  2046. if (!isset($options['external'])) {
  2047. $options['external'] = url_is_external($path);
  2048. }
  2049. // Preserve the original path before altering or aliasing.
  2050. $original_path = $path;
  2051. // Allow other modules to alter the outbound URL and options.
  2052. drupal_alter('url_outbound', $path, $options, $original_path);
  2053. if (isset($options['fragment']) && $options['fragment'] !== '') {
  2054. $options['fragment'] = '#' . $options['fragment'];
  2055. }
  2056. if ($options['external']) {
  2057. // Split off the fragment.
  2058. if (strpos($path, '#') !== FALSE) {
  2059. list($path, $old_fragment) = explode('#', $path, 2);
  2060. // If $options contains no fragment, take it over from the path.
  2061. if (isset($old_fragment) && !$options['fragment']) {
  2062. $options['fragment'] = '#' . $old_fragment;
  2063. }
  2064. }
  2065. // Append the query.
  2066. if ($options['query']) {
  2067. $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . drupal_http_build_query($options['query']);
  2068. }
  2069. if (isset($options['https']) && variable_get('https', FALSE)) {
  2070. if ($options['https'] === TRUE) {
  2071. $path = str_replace('http://', 'https://', $path);
  2072. }
  2073. elseif ($options['https'] === FALSE) {
  2074. $path = str_replace('https://', 'http://', $path);
  2075. }
  2076. }
  2077. // Reassemble.
  2078. return $path . $options['fragment'];
  2079. }
  2080. // Strip leading slashes from internal paths to prevent them becoming external
  2081. // URLs without protocol. /example.com should not be turned into
  2082. // //example.com.
  2083. $path = ltrim($path, '/');
  2084. global $base_url, $base_secure_url, $base_insecure_url;
  2085. // The base_url might be rewritten from the language rewrite in domain mode.
  2086. if (!isset($options['base_url'])) {
  2087. if (isset($options['https']) && variable_get('https', FALSE)) {
  2088. if ($options['https'] === TRUE) {
  2089. $options['base_url'] = $base_secure_url;
  2090. $options['absolute'] = TRUE;
  2091. }
  2092. elseif ($options['https'] === FALSE) {
  2093. $options['base_url'] = $base_insecure_url;
  2094. $options['absolute'] = TRUE;
  2095. }
  2096. }
  2097. else {
  2098. $options['base_url'] = $base_url;
  2099. }
  2100. }
  2101. // The special path '<front>' links to the default front page.
  2102. if ($path == '<front>') {
  2103. $path = '';
  2104. }
  2105. elseif (!empty($path) && !$options['alias']) {
  2106. $language = isset($options['language']) && isset($options['language']->language) ? $options['language']->language : '';
  2107. $alias = drupal_get_path_alias($original_path, $language);
  2108. if ($alias != $original_path) {
  2109. $path = $alias;
  2110. }
  2111. }
  2112. $base = $options['absolute'] ? $options['base_url'] . '/' : base_path();
  2113. $prefix = empty($path) ? rtrim($options['prefix'], '/') : $options['prefix'];
  2114. // With Clean URLs.
  2115. if (!empty($GLOBALS['conf']['clean_url'])) {
  2116. $path = drupal_encode_path($prefix . $path);
  2117. if ($options['query']) {
  2118. return $base . $path . '?' . drupal_http_build_query($options['query']) . $options['fragment'];
  2119. }
  2120. else {
  2121. return $base . $path . $options['fragment'];
  2122. }
  2123. }
  2124. // Without Clean URLs.
  2125. else {
  2126. $path = $prefix . $path;
  2127. $query = array();
  2128. if (!empty($path)) {
  2129. $query['q'] = $path;
  2130. }
  2131. if ($options['query']) {
  2132. // We do not use array_merge() here to prevent overriding $path via query
  2133. // parameters.
  2134. $query += $options['query'];
  2135. }
  2136. $query = $query ? ('?' . drupal_http_build_query($query)) : '';
  2137. $script = isset($options['script']) ? $options['script'] : '';
  2138. return $base . $script . $query . $options['fragment'];
  2139. }
  2140. }
  2141. /**
  2142. * Returns TRUE if a path is external to Drupal (e.g. http://example.com).
  2143. *
  2144. * If a path cannot be assessed by Drupal's menu handler, then we must
  2145. * treat it as potentially insecure.
  2146. *
  2147. * @param $path
  2148. * The internal path or external URL being linked to, such as "node/34" or
  2149. * "http://example.com/foo".
  2150. *
  2151. * @return
  2152. * Boolean TRUE or FALSE, where TRUE indicates an external path.
  2153. */
  2154. function url_is_external($path) {
  2155. $colonpos = strpos($path, ':');
  2156. // Some browsers treat \ as / so normalize to forward slashes.
  2157. $path = str_replace('\\', '/', $path);
  2158. // If the path starts with 2 slashes then it is always considered an external
  2159. // URL without an explicit protocol part.
  2160. return (strpos($path, '//') === 0)
  2161. // Leading control characters may be ignored or mishandled by browsers, so
  2162. // assume such a path may lead to an external location. The \p{C} character
  2163. // class matches all UTF-8 control, unassigned, and private characters.
  2164. || (preg_match('/^\p{C}/u', $path) !== 0)
  2165. // Avoid calling drupal_strip_dangerous_protocols() if there is any slash
  2166. // (/), hash (#) or question_mark (?) before the colon (:) occurrence - if
  2167. // any - as this would clearly mean it is not a URL.
  2168. || ($colonpos !== FALSE
  2169. && !preg_match('![/?#]!', substr($path, 0, $colonpos))
  2170. && drupal_strip_dangerous_protocols($path) == $path);
  2171. }
  2172. /**
  2173. * Formats an attribute string for an HTTP header.
  2174. *
  2175. * @param $attributes
  2176. * An associative array of attributes such as 'rel'.
  2177. *
  2178. * @return
  2179. * A ; separated string ready for insertion in a HTTP header. No escaping is
  2180. * performed for HTML entities, so this string is not safe to be printed.
  2181. *
  2182. * @see drupal_add_http_header()
  2183. */
  2184. function drupal_http_header_attributes(array $attributes = array()) {
  2185. foreach ($attributes as $attribute => &$data) {
  2186. if (is_array($data)) {
  2187. $data = implode(' ', $data);
  2188. }
  2189. $data = $attribute . '="' . $data . '"';
  2190. }
  2191. return $attributes ? ' ' . implode('; ', $attributes) : '';
  2192. }
  2193. /**
  2194. * Converts an associative array to an XML/HTML tag attribute string.
  2195. *
  2196. * Each array key and its value will be formatted into an attribute string.
  2197. * If a value is itself an array, then its elements are concatenated to a single
  2198. * space-delimited string (for example, a class attribute with multiple values).
  2199. *
  2200. * Attribute values are sanitized by running them through check_plain().
  2201. * Attribute names are not automatically sanitized. When using user-supplied
  2202. * attribute names, it is strongly recommended to allow only white-listed names,
  2203. * since certain attributes carry security risks and can be abused.
  2204. *
  2205. * Examples of security aspects when using drupal_attributes:
  2206. * @code
  2207. * // By running the value in the following statement through check_plain,
  2208. * // the malicious script is neutralized.
  2209. * drupal_attributes(array('title' => t('<script>steal_cookie();</script>')));
  2210. *
  2211. * // The statement below demonstrates dangerous use of drupal_attributes, and
  2212. * // will return an onmouseout attribute with JavaScript code that, when used
  2213. * // as attribute in a tag, will cause users to be redirected to another site.
  2214. * //
  2215. * // In this case, the 'onmouseout' attribute should not be whitelisted --
  2216. * // you don't want users to have the ability to add this attribute or others
  2217. * // that take JavaScript commands.
  2218. * drupal_attributes(array('onmouseout' => 'window.location="http://malicious.com/";')));
  2219. * @endcode
  2220. *
  2221. * @param $attributes
  2222. * An associative array of key-value pairs to be converted to attributes.
  2223. *
  2224. * @return
  2225. * A string ready for insertion in a tag (starts with a space).
  2226. *
  2227. * @ingroup sanitization
  2228. */
  2229. function drupal_attributes(array $attributes = array()) {
  2230. foreach ($attributes as $attribute => &$data) {
  2231. $data = implode(' ', (array) $data);
  2232. $data = $attribute . '="' . check_plain($data) . '"';
  2233. }
  2234. return $attributes ? ' ' . implode(' ', $attributes) : '';
  2235. }
  2236. /**
  2237. * Formats an internal or external URL link as an HTML anchor tag.
  2238. *
  2239. * This function correctly handles aliased paths and adds an 'active' class
  2240. * attribute to links that point to the current page (for theming), so all
  2241. * internal links output by modules should be generated by this function if
  2242. * possible.
  2243. *
  2244. * However, for links enclosed in translatable text you should use t() and
  2245. * embed the HTML anchor tag directly in the translated string. For example:
  2246. * @code
  2247. * t('Visit the <a href="@url">settings</a> page', array('@url' => url('admin')));
  2248. * @endcode
  2249. * This keeps the context of the link title ('settings' in the example) for
  2250. * translators.
  2251. *
  2252. * @param string $text
  2253. * The translated link text for the anchor tag.
  2254. * @param string $path
  2255. * The internal path or external URL being linked to, such as "node/34" or
  2256. * "http://example.com/foo". After the url() function is called to construct
  2257. * the URL from $path and $options, the resulting URL is passed through
  2258. * check_plain() before it is inserted into the HTML anchor tag, to ensure
  2259. * well-formed HTML. See url() for more information and notes.
  2260. * @param array $options
  2261. * An associative array of additional options. Defaults to an empty array. It
  2262. * may contain the following elements.
  2263. * - 'attributes': An associative array of HTML attributes to apply to the
  2264. * anchor tag. If element 'class' is included, it must be an array; 'title'
  2265. * must be a string; other elements are more flexible, as they just need
  2266. * to work in a call to drupal_attributes($options['attributes']).
  2267. * - 'html' (default FALSE): Whether $text is HTML or just plain-text. For
  2268. * example, to make an image tag into a link, this must be set to TRUE, or
  2269. * you will see the escaped HTML image tag. $text is not sanitized if
  2270. * 'html' is TRUE. The calling function must ensure that $text is already
  2271. * safe.
  2272. * - 'language': An optional language object. If the path being linked to is
  2273. * internal to the site, $options['language'] is used to determine whether
  2274. * the link is "active", or pointing to the current page (the language as
  2275. * well as the path must match). This element is also used by url().
  2276. * - Additional $options elements used by the url() function.
  2277. *
  2278. * @return string
  2279. * An HTML string containing a link to the given path.
  2280. *
  2281. * @see url()
  2282. */
  2283. function l($text, $path, array $options = array()) {
  2284. global $language_url;
  2285. static $use_theme = NULL;
  2286. // Merge in defaults.
  2287. $options += array(
  2288. 'attributes' => array(),
  2289. 'html' => FALSE,
  2290. );
  2291. // Append active class.
  2292. if (($path == $_GET['q'] || ($path == '<front>' && drupal_is_front_page())) &&
  2293. (empty($options['language']) || $options['language']->language == $language_url->language)) {
  2294. $options['attributes']['class'][] = 'active';
  2295. }
  2296. // Remove all HTML and PHP tags from a tooltip. For best performance, we act only
  2297. // if a quick strpos() pre-check gave a suspicion (because strip_tags() is expensive).
  2298. if (isset($options['attributes']['title']) && strpos($options['attributes']['title'], '<') !== FALSE) {
  2299. $options['attributes']['title'] = strip_tags($options['attributes']['title']);
  2300. }
  2301. // Determine if rendering of the link is to be done with a theme function
  2302. // or the inline default. Inline is faster, but if the theme system has been
  2303. // loaded and a module or theme implements a preprocess or process function
  2304. // or overrides the theme_link() function, then invoke theme(). Preliminary
  2305. // benchmarks indicate that invoking theme() can slow down the l() function
  2306. // by 20% or more, and that some of the link-heavy Drupal pages spend more
  2307. // than 10% of the total page request time in the l() function.
  2308. if (!isset($use_theme) && function_exists('theme')) {
  2309. // Allow edge cases to prevent theme initialization and force inline link
  2310. // rendering.
  2311. if (variable_get('theme_link', TRUE)) {
  2312. drupal_theme_initialize();
  2313. $registry = theme_get_registry(FALSE);
  2314. // We don't want to duplicate functionality that's in theme(), so any
  2315. // hint of a module or theme doing anything at all special with the 'link'
  2316. // theme hook should simply result in theme() being called. This includes
  2317. // the overriding of theme_link() with an alternate function or template,
  2318. // the presence of preprocess or process functions, or the presence of
  2319. // include files.
  2320. $use_theme = !isset($registry['link']['function']) || ($registry['link']['function'] != 'theme_link');
  2321. $use_theme = $use_theme || !empty($registry['link']['preprocess functions']) || !empty($registry['link']['process functions']) || !empty($registry['link']['includes']);
  2322. }
  2323. else {
  2324. $use_theme = FALSE;
  2325. }
  2326. }
  2327. if ($use_theme) {
  2328. return theme('link', array('text' => $text, 'path' => $path, 'options' => $options));
  2329. }
  2330. // The result of url() is a plain-text URL. Because we are using it here
  2331. // in an HTML argument context, we need to encode it properly.
  2332. return '<a href="' . check_plain(url($path, $options)) . '"' . drupal_attributes($options['attributes']) . '>' . ($options['html'] ? $text : check_plain($text)) . '</a>';
  2333. }
  2334. /**
  2335. * Delivers a page callback result to the browser in the appropriate format.
  2336. *
  2337. * This function is most commonly called by menu_execute_active_handler(), but
  2338. * can also be called by error conditions such as drupal_not_found(),
  2339. * drupal_access_denied(), and drupal_site_offline().
  2340. *
  2341. * When a user requests a page, index.php calls menu_execute_active_handler(),
  2342. * which calls the 'page callback' function registered in hook_menu(). The page
  2343. * callback function can return one of:
  2344. * - NULL: to indicate no content.
  2345. * - An integer menu status constant: to indicate an error condition.
  2346. * - A string of HTML content.
  2347. * - A renderable array of content.
  2348. * Returning a renderable array rather than a string of HTML is preferred,
  2349. * because that provides modules with more flexibility in customizing the final
  2350. * result.
  2351. *
  2352. * When the page callback returns its constructed content to
  2353. * menu_execute_active_handler(), this function gets called. The purpose of
  2354. * this function is to determine the most appropriate 'delivery callback'
  2355. * function to route the content to. The delivery callback function then
  2356. * sends the content to the browser in the needed format. The default delivery
  2357. * callback is drupal_deliver_html_page(), which delivers the content as an HTML
  2358. * page, complete with blocks in addition to the content. This default can be
  2359. * overridden on a per menu router item basis by setting 'delivery callback' in
  2360. * hook_menu() or hook_menu_alter(), and can also be overridden on a per request
  2361. * basis in hook_page_delivery_callback_alter().
  2362. *
  2363. * For example, the same page callback function can be used for an HTML
  2364. * version of the page and an Ajax version of the page. The page callback
  2365. * function just needs to decide what content is to be returned and the
  2366. * delivery callback function will send it as an HTML page or an Ajax
  2367. * response, as appropriate.
  2368. *
  2369. * In order for page callbacks to be reusable in different delivery formats,
  2370. * they should not issue any "print" or "echo" statements, but instead just
  2371. * return content.
  2372. *
  2373. * Also note that this function does not perform access checks. The delivery
  2374. * callback function specified in hook_menu(), hook_menu_alter(), or
  2375. * hook_page_delivery_callback_alter() will be called even if the router item
  2376. * access checks fail. This is intentional (it is needed for JSON and other
  2377. * purposes), but it has security implications. Do not call this function
  2378. * directly unless you understand the security implications, and be careful in
  2379. * writing delivery callbacks, so that they do not violate security. See
  2380. * drupal_deliver_html_page() for an example of a delivery callback that
  2381. * respects security.
  2382. *
  2383. * @param $page_callback_result
  2384. * The result of a page callback. Can be one of:
  2385. * - NULL: to indicate no content.
  2386. * - An integer menu status constant: to indicate an error condition.
  2387. * - A string of HTML content.
  2388. * - A renderable array of content.
  2389. * @param $default_delivery_callback
  2390. * (Optional) If given, it is the name of a delivery function most likely
  2391. * to be appropriate for the page request as determined by the calling
  2392. * function (e.g., menu_execute_active_handler()). If not given, it is
  2393. * determined from the menu router information of the current page.
  2394. *
  2395. * @see menu_execute_active_handler()
  2396. * @see hook_menu()
  2397. * @see hook_menu_alter()
  2398. * @see hook_page_delivery_callback_alter()
  2399. */
  2400. function drupal_deliver_page($page_callback_result, $default_delivery_callback = NULL) {
  2401. if (!isset($default_delivery_callback) && ($router_item = menu_get_item())) {
  2402. $default_delivery_callback = $router_item['delivery_callback'];
  2403. }
  2404. $delivery_callback = !empty($default_delivery_callback) ? $default_delivery_callback : 'drupal_deliver_html_page';
  2405. // Give modules a chance to alter the delivery callback used, based on
  2406. // request-time context (e.g., HTTP request headers).
  2407. drupal_alter('page_delivery_callback', $delivery_callback);
  2408. if (function_exists($delivery_callback)) {
  2409. $delivery_callback($page_callback_result);
  2410. }
  2411. else {
  2412. // If a delivery callback is specified, but doesn't exist as a function,
  2413. // something is wrong, but don't print anything, since it's not known
  2414. // what format the response needs to be in.
  2415. watchdog('delivery callback not found', 'callback %callback not found: %q.', array('%callback' => $delivery_callback, '%q' => $_GET['q']), WATCHDOG_ERROR);
  2416. }
  2417. }
  2418. /**
  2419. * Packages and sends the result of a page callback to the browser as HTML.
  2420. *
  2421. * @param $page_callback_result
  2422. * The result of a page callback. Can be one of:
  2423. * - NULL: to indicate no content.
  2424. * - An integer menu status constant: to indicate an error condition.
  2425. * - A string of HTML content.
  2426. * - A renderable array of content.
  2427. *
  2428. * @see drupal_deliver_page()
  2429. */
  2430. function drupal_deliver_html_page($page_callback_result) {
  2431. // Emit the correct charset HTTP header, but not if the page callback
  2432. // result is NULL, since that likely indicates that it printed something
  2433. // in which case, no further headers may be sent, and not if code running
  2434. // for this page request has already set the content type header.
  2435. if (isset($page_callback_result) && is_null(drupal_get_http_header('Content-Type'))) {
  2436. drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
  2437. }
  2438. // Send appropriate HTTP-Header for browsers and search engines.
  2439. global $language;
  2440. drupal_add_http_header('Content-Language', $language->language);
  2441. // By default, do not allow the site to be rendered in an iframe on another
  2442. // domain, but provide a variable to override this. If the code running for
  2443. // this page request already set the X-Frame-Options header earlier, don't
  2444. // overwrite it here.
  2445. $frame_options = variable_get('x_frame_options', 'SAMEORIGIN');
  2446. if ($frame_options && is_null(drupal_get_http_header('X-Frame-Options'))) {
  2447. drupal_add_http_header('X-Frame-Options', $frame_options);
  2448. }
  2449. // Menu status constants are integers; page content is a string or array.
  2450. if (is_int($page_callback_result)) {
  2451. // @todo: Break these up into separate functions?
  2452. switch ($page_callback_result) {
  2453. case MENU_NOT_FOUND:
  2454. // Print a 404 page.
  2455. drupal_add_http_header('Status', '404 Not Found');
  2456. watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
  2457. // Check for and return a fast 404 page if configured.
  2458. drupal_fast_404();
  2459. // Keep old path for reference, and to allow forms to redirect to it.
  2460. if (!isset($_GET['destination'])) {
  2461. // Make sure that the current path is not interpreted as external URL.
  2462. if (!url_is_external($_GET['q'])) {
  2463. $_GET['destination'] = $_GET['q'];
  2464. }
  2465. }
  2466. $path = drupal_get_normal_path(variable_get('site_404', ''));
  2467. if ($path && $path != $_GET['q']) {
  2468. // Custom 404 handler. Set the active item in case there are tabs to
  2469. // display, or other dependencies on the path.
  2470. menu_set_active_item($path);
  2471. $return = menu_execute_active_handler($path, FALSE);
  2472. }
  2473. if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
  2474. // Standard 404 handler.
  2475. drupal_set_title(t('Page not found'));
  2476. $return = t('The requested page "@path" could not be found.', array('@path' => request_uri()));
  2477. }
  2478. drupal_set_page_content($return);
  2479. $page = element_info('page');
  2480. print drupal_render_page($page);
  2481. break;
  2482. case MENU_ACCESS_DENIED:
  2483. // Print a 403 page.
  2484. drupal_add_http_header('Status', '403 Forbidden');
  2485. watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
  2486. // Keep old path for reference, and to allow forms to redirect to it.
  2487. if (!isset($_GET['destination'])) {
  2488. // Make sure that the current path is not interpreted as external URL.
  2489. if (!url_is_external($_GET['q'])) {
  2490. $_GET['destination'] = $_GET['q'];
  2491. }
  2492. }
  2493. $path = drupal_get_normal_path(variable_get('site_403', ''));
  2494. if ($path && $path != $_GET['q']) {
  2495. // Custom 403 handler. Set the active item in case there are tabs to
  2496. // display or other dependencies on the path.
  2497. menu_set_active_item($path);
  2498. $return = menu_execute_active_handler($path, FALSE);
  2499. }
  2500. if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
  2501. // Standard 403 handler.
  2502. drupal_set_title(t('Access denied'));
  2503. $return = t('You are not authorized to access this page.');
  2504. }
  2505. print drupal_render_page($return);
  2506. break;
  2507. case MENU_SITE_OFFLINE:
  2508. // Print a 503 page.
  2509. drupal_maintenance_theme();
  2510. drupal_add_http_header('Status', '503 Service unavailable');
  2511. drupal_set_title(t('Site under maintenance'));
  2512. print theme('maintenance_page', array('content' => filter_xss_admin(variable_get('maintenance_mode_message',
  2513. t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal')))))));
  2514. break;
  2515. }
  2516. }
  2517. elseif (isset($page_callback_result)) {
  2518. // Print anything besides a menu constant, assuming it's not NULL or
  2519. // undefined.
  2520. print drupal_render_page($page_callback_result);
  2521. }
  2522. // Perform end-of-request tasks.
  2523. drupal_page_footer();
  2524. }
  2525. /**
  2526. * Performs end-of-request tasks.
  2527. *
  2528. * This function sets the page cache if appropriate, and allows modules to
  2529. * react to the closing of the page by calling hook_exit().
  2530. */
  2531. function drupal_page_footer() {
  2532. global $user;
  2533. module_invoke_all('exit');
  2534. // Commit the user session, if needed.
  2535. drupal_session_commit();
  2536. if (variable_get('cache', 0) && ($cache = drupal_page_set_cache())) {
  2537. drupal_serve_page_from_cache($cache);
  2538. }
  2539. else {
  2540. ob_flush();
  2541. }
  2542. _registry_check_code(REGISTRY_WRITE_LOOKUP_CACHE);
  2543. drupal_cache_system_paths();
  2544. module_implements_write_cache();
  2545. drupal_file_scan_write_cache();
  2546. system_run_automated_cron();
  2547. }
  2548. /**
  2549. * Performs end-of-request tasks.
  2550. *
  2551. * In some cases page requests need to end without calling drupal_page_footer().
  2552. * In these cases, call drupal_exit() instead. There should rarely be a reason
  2553. * to call exit instead of drupal_exit();
  2554. *
  2555. * @param $destination
  2556. * If this function is called from drupal_goto(), then this argument
  2557. * will be a fully-qualified URL that is the destination of the redirect.
  2558. * This should be passed along to hook_exit() implementations.
  2559. */
  2560. function drupal_exit($destination = NULL) {
  2561. if (drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL) {
  2562. if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
  2563. module_invoke_all('exit', $destination);
  2564. }
  2565. drupal_session_commit();
  2566. }
  2567. exit;
  2568. }
  2569. /**
  2570. * Forms an associative array from a linear array.
  2571. *
  2572. * This function walks through the provided array and constructs an associative
  2573. * array out of it. The keys of the resulting array will be the values of the
  2574. * input array. The values will be the same as the keys unless a function is
  2575. * specified, in which case the output of the function is used for the values
  2576. * instead.
  2577. *
  2578. * @param $array
  2579. * A linear array.
  2580. * @param $function
  2581. * A name of a function to apply to all values before output.
  2582. *
  2583. * @return
  2584. * An associative array.
  2585. */
  2586. function drupal_map_assoc($array, $function = NULL) {
  2587. // array_combine() fails with empty arrays:
  2588. // http://bugs.php.net/bug.php?id=34857.
  2589. $array = !empty($array) ? array_combine($array, $array) : array();
  2590. if (is_callable($function)) {
  2591. $array = array_map($function, $array);
  2592. }
  2593. return $array;
  2594. }
  2595. /**
  2596. * Attempts to set the PHP maximum execution time.
  2597. *
  2598. * This function is a wrapper around the PHP function set_time_limit().
  2599. * When called, set_time_limit() restarts the timeout counter from zero.
  2600. * In other words, if the timeout is the default 30 seconds, and 25 seconds
  2601. * into script execution a call such as set_time_limit(20) is made, the
  2602. * script will run for a total of 45 seconds before timing out.
  2603. *
  2604. * If the current time limit is not unlimited it is possible to decrease the
  2605. * total time limit if the sum of the new time limit and the current time spent
  2606. * running the script is inferior to the original time limit. It is inherent to
  2607. * the way set_time_limit() works, it should rather be called with an
  2608. * appropriate value every time you need to allocate a certain amount of time
  2609. * to execute a task than only once at the beginning of the script.
  2610. *
  2611. * Before calling set_time_limit(), we check if this function is available
  2612. * because it could be disabled by the server administrator. We also hide all
  2613. * the errors that could occur when calling set_time_limit(), because it is
  2614. * not possible to reliably ensure that PHP or a security extension will
  2615. * not issue a warning/error if they prevent the use of this function.
  2616. *
  2617. * @param $time_limit
  2618. * An integer specifying the new time limit, in seconds. A value of 0
  2619. * indicates unlimited execution time.
  2620. *
  2621. * @ingroup php_wrappers
  2622. */
  2623. function drupal_set_time_limit($time_limit) {
  2624. if (function_exists('set_time_limit')) {
  2625. $current = ini_get('max_execution_time');
  2626. // Do not set time limit if it is currently unlimited.
  2627. if ($current != 0) {
  2628. @set_time_limit($time_limit);
  2629. }
  2630. }
  2631. }
  2632. /**
  2633. * Returns the path to a system item (module, theme, etc.).
  2634. *
  2635. * @param $type
  2636. * The type of the item (i.e. theme, theme_engine, module, profile).
  2637. * @param $name
  2638. * The name of the item for which the path is requested.
  2639. *
  2640. * @return
  2641. * The path to the requested item or an empty string if the item is not found.
  2642. */
  2643. function drupal_get_path($type, $name) {
  2644. return dirname(drupal_get_filename($type, $name));
  2645. }
  2646. /**
  2647. * Returns the base URL path (i.e., directory) of the Drupal installation.
  2648. *
  2649. * base_path() adds a "/" to the beginning and end of the returned path if the
  2650. * path is not empty. At the very least, this will return "/".
  2651. *
  2652. * Examples:
  2653. * - http://example.com returns "/" because the path is empty.
  2654. * - http://example.com/drupal/folder returns "/drupal/folder/".
  2655. */
  2656. function base_path() {
  2657. return $GLOBALS['base_path'];
  2658. }
  2659. /**
  2660. * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
  2661. *
  2662. * This function can be called as long the HTML header hasn't been sent, which
  2663. * on normal pages is up through the preprocess step of theme('html'). Adding
  2664. * a link will overwrite a prior link with the exact same 'rel' and 'href'
  2665. * attributes.
  2666. *
  2667. * @param $attributes
  2668. * Associative array of element attributes including 'href' and 'rel'.
  2669. * @param $header
  2670. * Optional flag to determine if a HTTP 'Link:' header should be sent.
  2671. */
  2672. function drupal_add_html_head_link($attributes, $header = FALSE) {
  2673. $element = array(
  2674. '#tag' => 'link',
  2675. '#attributes' => $attributes,
  2676. );
  2677. $href = $attributes['href'];
  2678. if ($header) {
  2679. // Also add a HTTP header "Link:".
  2680. $href = '<' . check_plain($attributes['href']) . '>;';
  2681. unset($attributes['href']);
  2682. $element['#attached']['drupal_add_http_header'][] = array('Link', $href . drupal_http_header_attributes($attributes), TRUE);
  2683. }
  2684. drupal_add_html_head($element, 'drupal_add_html_head_link:' . $attributes['rel'] . ':' . $href);
  2685. }
  2686. /**
  2687. * Adds a cascading stylesheet to the stylesheet queue.
  2688. *
  2689. * Calling drupal_static_reset('drupal_add_css') will clear all cascading
  2690. * stylesheets added so far.
  2691. *
  2692. * If CSS aggregation/compression is enabled, all cascading style sheets added
  2693. * with $options['preprocess'] set to TRUE will be merged into one aggregate
  2694. * file and compressed by removing all extraneous white space.
  2695. * Preprocessed inline stylesheets will not be aggregated into this single file;
  2696. * instead, they are just compressed upon output on the page. Externally hosted
  2697. * stylesheets are never aggregated or compressed.
  2698. *
  2699. * The reason for aggregating the files is outlined quite thoroughly here:
  2700. * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
  2701. * to request overhead, one bigger file just loads faster than two smaller ones
  2702. * half its size."
  2703. *
  2704. * $options['preprocess'] should be only set to TRUE when a file is required for
  2705. * all typical visitors and most pages of a site. It is critical that all
  2706. * preprocessed files are added unconditionally on every page, even if the
  2707. * files do not happen to be needed on a page. This is normally done by calling
  2708. * drupal_add_css() in a hook_init() implementation.
  2709. *
  2710. * Non-preprocessed files should only be added to the page when they are
  2711. * actually needed.
  2712. *
  2713. * @param $data
  2714. * (optional) The stylesheet data to be added, depending on what is passed
  2715. * through to the $options['type'] parameter:
  2716. * - 'file': The path to the CSS file relative to the base_path(), or a
  2717. * stream wrapper URI. For example: "modules/devel/devel.css" or
  2718. * "public://generated_css/stylesheet_1.css". Note that Modules should
  2719. * always prefix the names of their CSS files with the module name; for
  2720. * example, system-menus.css rather than simply menus.css. Themes can
  2721. * override module-supplied CSS files based on their filenames, and this
  2722. * prefixing helps prevent confusing name collisions for theme developers.
  2723. * See drupal_get_css() where the overrides are performed. Also, if the
  2724. * direction of the current language is right-to-left (Hebrew, Arabic,
  2725. * etc.), the function will also look for an RTL CSS file and append it to
  2726. * the list. The name of this file should have an '-rtl.css' suffix. For
  2727. * example, a CSS file called 'mymodule-name.css' will have a
  2728. * 'mymodule-name-rtl.css' file added to the list, if exists in the same
  2729. * directory. This CSS file should contain overrides for properties which
  2730. * should be reversed or otherwise different in a right-to-left display.
  2731. * - 'inline': A string of CSS that should be placed in the given scope. Note
  2732. * that it is better practice to use 'file' stylesheets, rather than
  2733. * 'inline', as the CSS would then be aggregated and cached.
  2734. * - 'external': The absolute path to an external CSS file that is not hosted
  2735. * on the local server. These files will not be aggregated if CSS
  2736. * aggregation is enabled.
  2737. * @param $options
  2738. * (optional) A string defining the 'type' of CSS that is being added in the
  2739. * $data parameter ('file', 'inline', or 'external'), or an array which can
  2740. * have any or all of the following keys:
  2741. * - 'type': The type of stylesheet being added. Available options are 'file',
  2742. * 'inline' or 'external'. Defaults to 'file'.
  2743. * - 'basename': Force a basename for the file being added. Modules are
  2744. * expected to use stylesheets with unique filenames, but integration of
  2745. * external libraries may make this impossible. The basename of
  2746. * 'modules/node/node.css' is 'node.css'. If the external library "node.js"
  2747. * ships with a 'node.css', then a different, unique basename would be
  2748. * 'node.js.css'.
  2749. * - 'group': A number identifying the group in which to add the stylesheet.
  2750. * Available constants are:
  2751. * - CSS_SYSTEM: Any system-layer CSS.
  2752. * - CSS_DEFAULT: (default) Any module-layer CSS.
  2753. * - CSS_THEME: Any theme-layer CSS.
  2754. * The group number serves as a weight: the markup for loading a stylesheet
  2755. * within a lower weight group is output to the page before the markup for
  2756. * loading a stylesheet within a higher weight group, so CSS within higher
  2757. * weight groups take precendence over CSS within lower weight groups.
  2758. * - 'every_page': For optimal front-end performance when aggregation is
  2759. * enabled, this should be set to TRUE if the stylesheet is present on every
  2760. * page of the website for users for whom it is present at all. This
  2761. * defaults to FALSE. It is set to TRUE for stylesheets added via module and
  2762. * theme .info files. Modules that add stylesheets within hook_init()
  2763. * implementations, or from other code that ensures that the stylesheet is
  2764. * added to all website pages, should also set this flag to TRUE. All
  2765. * stylesheets within the same group that have the 'every_page' flag set to
  2766. * TRUE and do not have 'preprocess' set to FALSE are aggregated together
  2767. * into a single aggregate file, and that aggregate file can be reused
  2768. * across a user's entire site visit, leading to faster navigation between
  2769. * pages. However, stylesheets that are only needed on pages less frequently
  2770. * visited, can be added by code that only runs for those particular pages,
  2771. * and that code should not set the 'every_page' flag. This minimizes the
  2772. * size of the aggregate file that the user needs to download when first
  2773. * visiting the website. Stylesheets without the 'every_page' flag are
  2774. * aggregated into a separate aggregate file. This other aggregate file is
  2775. * likely to change from page to page, and each new aggregate file needs to
  2776. * be downloaded when first encountered, so it should be kept relatively
  2777. * small by ensuring that most commonly needed stylesheets are added to
  2778. * every page.
  2779. * - 'weight': The weight of the stylesheet specifies the order in which the
  2780. * CSS will appear relative to other stylesheets with the same group and
  2781. * 'every_page' flag. The exact ordering of stylesheets is as follows:
  2782. * - First by group.
  2783. * - Then by the 'every_page' flag, with TRUE coming before FALSE.
  2784. * - Then by weight.
  2785. * - Then by the order in which the CSS was added. For example, all else
  2786. * being the same, a stylesheet added by a call to drupal_add_css() that
  2787. * happened later in the page request gets added to the page after one for
  2788. * which drupal_add_css() happened earlier in the page request.
  2789. * - 'media': The media type for the stylesheet, e.g., all, print, screen.
  2790. * Defaults to 'all'.
  2791. * - 'preprocess': If TRUE and CSS aggregation/compression is enabled, the
  2792. * styles will be aggregated and compressed. Defaults to TRUE.
  2793. * - 'browsers': An array containing information specifying which browsers
  2794. * should load the CSS item. See drupal_pre_render_conditional_comments()
  2795. * for details.
  2796. *
  2797. * @return
  2798. * An array of queued cascading stylesheets.
  2799. *
  2800. * @see drupal_get_css()
  2801. */
  2802. function drupal_add_css($data = NULL, $options = NULL) {
  2803. $css = &drupal_static(__FUNCTION__, array());
  2804. $count = &drupal_static(__FUNCTION__ . '_count', 0);
  2805. // If the $css variable has been reset with drupal_static_reset(), there is
  2806. // no longer any CSS being tracked, so set the counter back to 0 also.
  2807. if (count($css) === 0) {
  2808. $count = 0;
  2809. }
  2810. // Construct the options, taking the defaults into consideration.
  2811. if (isset($options)) {
  2812. if (!is_array($options)) {
  2813. $options = array('type' => $options);
  2814. }
  2815. }
  2816. else {
  2817. $options = array();
  2818. }
  2819. // Create an array of CSS files for each media type first, since each type needs to be served
  2820. // to the browser differently.
  2821. if (isset($data)) {
  2822. $options += array(
  2823. 'type' => 'file',
  2824. 'group' => CSS_DEFAULT,
  2825. 'weight' => 0,
  2826. 'every_page' => FALSE,
  2827. 'media' => 'all',
  2828. 'preprocess' => TRUE,
  2829. 'data' => $data,
  2830. 'browsers' => array(),
  2831. );
  2832. $options['browsers'] += array(
  2833. 'IE' => TRUE,
  2834. '!IE' => TRUE,
  2835. );
  2836. // Files with a query string cannot be preprocessed.
  2837. if ($options['type'] === 'file' && $options['preprocess'] && strpos($options['data'], '?') !== FALSE) {
  2838. $options['preprocess'] = FALSE;
  2839. }
  2840. // Always add a tiny value to the weight, to conserve the insertion order.
  2841. $options['weight'] += $count / 1000;
  2842. $count++;
  2843. // Add the data to the CSS array depending on the type.
  2844. switch ($options['type']) {
  2845. case 'inline':
  2846. // For inline stylesheets, we don't want to use the $data as the array
  2847. // key as $data could be a very long string of CSS.
  2848. $css[] = $options;
  2849. break;
  2850. default:
  2851. // Local and external files must keep their name as the associative key
  2852. // so the same CSS file is not be added twice.
  2853. $css[$data] = $options;
  2854. }
  2855. }
  2856. return $css;
  2857. }
  2858. /**
  2859. * Returns a themed representation of all stylesheets to attach to the page.
  2860. *
  2861. * It loads the CSS in order, with 'module' first, then 'theme' afterwards.
  2862. * This ensures proper cascading of styles so themes can easily override
  2863. * module styles through CSS selectors.
  2864. *
  2865. * Themes may replace module-defined CSS files by adding a stylesheet with the
  2866. * same filename. For example, themes/bartik/system-menus.css would replace
  2867. * modules/system/system-menus.css. This allows themes to override complete
  2868. * CSS files, rather than specific selectors, when necessary.
  2869. *
  2870. * If the original CSS file is being overridden by a theme, the theme is
  2871. * responsible for supplying an accompanying RTL CSS file to replace the
  2872. * module's.
  2873. *
  2874. * @param $css
  2875. * (optional) An array of CSS files. If no array is provided, the default
  2876. * stylesheets array is used instead.
  2877. * @param $skip_alter
  2878. * (optional) If set to TRUE, this function skips calling drupal_alter() on
  2879. * $css, useful when the calling function passes a $css array that has already
  2880. * been altered.
  2881. *
  2882. * @return
  2883. * A string of XHTML CSS tags.
  2884. *
  2885. * @see drupal_add_css()
  2886. */
  2887. function drupal_get_css($css = NULL, $skip_alter = FALSE) {
  2888. if (!isset($css)) {
  2889. $css = drupal_add_css();
  2890. }
  2891. // Allow modules and themes to alter the CSS items.
  2892. if (!$skip_alter) {
  2893. drupal_alter('css', $css);
  2894. }
  2895. // Sort CSS items, so that they appear in the correct order.
  2896. uasort($css, 'drupal_sort_css_js');
  2897. // Provide the page with information about the individual CSS files used,
  2898. // information not otherwise available when CSS aggregation is enabled. The
  2899. // setting is attached later in this function, but is set here, so that CSS
  2900. // files removed below are still considered "used" and prevented from being
  2901. // added in a later AJAX request.
  2902. // Skip if no files were added to the page or jQuery.extend() will overwrite
  2903. // the Drupal.settings.ajaxPageState.css object with an empty array.
  2904. if (!empty($css)) {
  2905. // Cast the array to an object to be on the safe side even if not empty.
  2906. $setting['ajaxPageState']['css'] = (object) array_fill_keys(array_keys($css), 1);
  2907. }
  2908. // Remove the overridden CSS files. Later CSS files override former ones.
  2909. $previous_item = array();
  2910. foreach ($css as $key => $item) {
  2911. if ($item['type'] == 'file') {
  2912. // If defined, force a unique basename for this file.
  2913. $basename = isset($item['basename']) ? $item['basename'] : drupal_basename($item['data']);
  2914. if (isset($previous_item[$basename])) {
  2915. // Remove the previous item that shared the same base name.
  2916. unset($css[$previous_item[$basename]]);
  2917. }
  2918. $previous_item[$basename] = $key;
  2919. }
  2920. }
  2921. // Render the HTML needed to load the CSS.
  2922. $styles = array(
  2923. '#type' => 'styles',
  2924. '#items' => $css,
  2925. );
  2926. if (!empty($setting)) {
  2927. $styles['#attached']['js'][] = array('type' => 'setting', 'data' => $setting);
  2928. }
  2929. return drupal_render($styles);
  2930. }
  2931. /**
  2932. * Sorts CSS and JavaScript resources.
  2933. *
  2934. * Callback for uasort() within:
  2935. * - drupal_get_css()
  2936. * - drupal_get_js()
  2937. *
  2938. * This sort order helps optimize front-end performance while providing modules
  2939. * and themes with the necessary control for ordering the CSS and JavaScript
  2940. * appearing on a page.
  2941. *
  2942. * @param $a
  2943. * First item for comparison. The compared items should be associative arrays
  2944. * of member items from drupal_add_css() or drupal_add_js().
  2945. * @param $b
  2946. * Second item for comparison.
  2947. *
  2948. * @see drupal_add_css()
  2949. * @see drupal_add_js()
  2950. */
  2951. function drupal_sort_css_js($a, $b) {
  2952. // First order by group, so that, for example, all items in the CSS_SYSTEM
  2953. // group appear before items in the CSS_DEFAULT group, which appear before
  2954. // all items in the CSS_THEME group. Modules may create additional groups by
  2955. // defining their own constants.
  2956. if ($a['group'] < $b['group']) {
  2957. return -1;
  2958. }
  2959. elseif ($a['group'] > $b['group']) {
  2960. return 1;
  2961. }
  2962. // Within a group, order all infrequently needed, page-specific files after
  2963. // common files needed throughout the website. Separating this way allows for
  2964. // the aggregate file generated for all of the common files to be reused
  2965. // across a site visit without being cut by a page using a less common file.
  2966. elseif ($a['every_page'] && !$b['every_page']) {
  2967. return -1;
  2968. }
  2969. elseif (!$a['every_page'] && $b['every_page']) {
  2970. return 1;
  2971. }
  2972. // Finally, order by weight.
  2973. elseif ($a['weight'] < $b['weight']) {
  2974. return -1;
  2975. }
  2976. elseif ($a['weight'] > $b['weight']) {
  2977. return 1;
  2978. }
  2979. else {
  2980. return 0;
  2981. }
  2982. }
  2983. /**
  2984. * Default callback to group CSS items.
  2985. *
  2986. * This function arranges the CSS items that are in the #items property of the
  2987. * styles element into groups. Arranging the CSS items into groups serves two
  2988. * purposes. When aggregation is enabled, files within a group are aggregated
  2989. * into a single file, significantly improving page loading performance by
  2990. * minimizing network traffic overhead. When aggregation is disabled, grouping
  2991. * allows multiple files to be loaded from a single STYLE tag, enabling sites
  2992. * with many modules enabled or a complex theme being used to stay within IE's
  2993. * 31 CSS inclusion tag limit: http://drupal.org/node/228818.
  2994. *
  2995. * This function puts multiple items into the same group if they are groupable
  2996. * and if they are for the same 'media' and 'browsers'. Items of the 'file' type
  2997. * are groupable if their 'preprocess' flag is TRUE, items of the 'inline' type
  2998. * are always groupable, and items of the 'external' type are never groupable.
  2999. * This function also ensures that the process of grouping items does not change
  3000. * their relative order. This requirement may result in multiple groups for the
  3001. * same type, media, and browsers, if needed to accommodate other items in
  3002. * between.
  3003. *
  3004. * @param $css
  3005. * An array of CSS items, as returned by drupal_add_css(), but after
  3006. * alteration performed by drupal_get_css().
  3007. *
  3008. * @return
  3009. * An array of CSS groups. Each group contains the same keys (e.g., 'media',
  3010. * 'data', etc.) as a CSS item from the $css parameter, with the value of
  3011. * each key applying to the group as a whole. Each group also contains an
  3012. * 'items' key, which is the subset of items from $css that are in the group.
  3013. *
  3014. * @see drupal_pre_render_styles()
  3015. * @see system_element_info()
  3016. */
  3017. function drupal_group_css($css) {
  3018. $groups = array();
  3019. // If a group can contain multiple items, we track the information that must
  3020. // be the same for each item in the group, so that when we iterate the next
  3021. // item, we can determine if it can be put into the current group, or if a
  3022. // new group needs to be made for it.
  3023. $current_group_keys = NULL;
  3024. // When creating a new group, we pre-increment $i, so by initializing it to
  3025. // -1, the first group will have index 0.
  3026. $i = -1;
  3027. foreach ($css as $item) {
  3028. // The browsers for which the CSS item needs to be loaded is part of the
  3029. // information that determines when a new group is needed, but the order of
  3030. // keys in the array doesn't matter, and we don't want a new group if all
  3031. // that's different is that order.
  3032. ksort($item['browsers']);
  3033. // If the item can be grouped with other items, set $group_keys to an array
  3034. // of information that must be the same for all items in its group. If the
  3035. // item can't be grouped with other items, set $group_keys to FALSE. We
  3036. // put items into a group that can be aggregated together: whether they will
  3037. // be aggregated is up to the _drupal_css_aggregate() function or an
  3038. // override of that function specified in hook_css_alter(), but regardless
  3039. // of the details of that function, a group represents items that can be
  3040. // aggregated. Since a group may be rendered with a single HTML tag, all
  3041. // items in the group must share the same information that would need to be
  3042. // part of that HTML tag.
  3043. switch ($item['type']) {
  3044. case 'file':
  3045. // Group file items if their 'preprocess' flag is TRUE.
  3046. // Help ensure maximum reuse of aggregate files by only grouping
  3047. // together items that share the same 'group' value and 'every_page'
  3048. // flag. See drupal_add_css() for details about that.
  3049. $group_keys = $item['preprocess'] ? array($item['type'], $item['group'], $item['every_page'], $item['media'], $item['browsers']) : FALSE;
  3050. break;
  3051. case 'inline':
  3052. // Always group inline items.
  3053. $group_keys = array($item['type'], $item['media'], $item['browsers']);
  3054. break;
  3055. case 'external':
  3056. // Do not group external items.
  3057. $group_keys = FALSE;
  3058. break;
  3059. }
  3060. // If the group keys don't match the most recent group we're working with,
  3061. // then a new group must be made.
  3062. if ($group_keys !== $current_group_keys) {
  3063. $i++;
  3064. // Initialize the new group with the same properties as the first item
  3065. // being placed into it. The item's 'data' and 'weight' properties are
  3066. // unique to the item and should not be carried over to the group.
  3067. $groups[$i] = $item;
  3068. unset($groups[$i]['data'], $groups[$i]['weight']);
  3069. $groups[$i]['items'] = array();
  3070. $current_group_keys = $group_keys ? $group_keys : NULL;
  3071. }
  3072. // Add the item to the current group.
  3073. $groups[$i]['items'][] = $item;
  3074. }
  3075. return $groups;
  3076. }
  3077. /**
  3078. * Default callback to aggregate CSS files and inline content.
  3079. *
  3080. * Having the browser load fewer CSS files results in much faster page loads
  3081. * than when it loads many small files. This function aggregates files within
  3082. * the same group into a single file unless the site-wide setting to do so is
  3083. * disabled (commonly the case during site development). To optimize download,
  3084. * it also compresses the aggregate files by removing comments, whitespace, and
  3085. * other unnecessary content. Additionally, this functions aggregates inline
  3086. * content together, regardless of the site-wide aggregation setting.
  3087. *
  3088. * @param $css_groups
  3089. * An array of CSS groups as returned by drupal_group_css(). This function
  3090. * modifies the group's 'data' property for each group that is aggregated.
  3091. *
  3092. * @see drupal_group_css()
  3093. * @see drupal_pre_render_styles()
  3094. * @see system_element_info()
  3095. */
  3096. function drupal_aggregate_css(&$css_groups) {
  3097. $preprocess_css = (variable_get('preprocess_css', FALSE) && (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update'));
  3098. // For each group that needs aggregation, aggregate its items.
  3099. foreach ($css_groups as $key => $group) {
  3100. switch ($group['type']) {
  3101. // If a file group can be aggregated into a single file, do so, and set
  3102. // the group's data property to the file path of the aggregate file.
  3103. case 'file':
  3104. if ($group['preprocess'] && $preprocess_css) {
  3105. $css_groups[$key]['data'] = drupal_build_css_cache($group['items']);
  3106. }
  3107. break;
  3108. // Aggregate all inline CSS content into the group's data property.
  3109. case 'inline':
  3110. $css_groups[$key]['data'] = '';
  3111. foreach ($group['items'] as $item) {
  3112. $css_groups[$key]['data'] .= drupal_load_stylesheet_content($item['data'], $item['preprocess']);
  3113. }
  3114. break;
  3115. }
  3116. }
  3117. }
  3118. /**
  3119. * #pre_render callback to add the elements needed for CSS tags to be rendered.
  3120. *
  3121. * For production websites, LINK tags are preferable to STYLE tags with @import
  3122. * statements, because:
  3123. * - They are the standard tag intended for linking to a resource.
  3124. * - On Firefox 2 and perhaps other browsers, CSS files included with @import
  3125. * statements don't get saved when saving the complete web page for offline
  3126. * use: http://drupal.org/node/145218.
  3127. * - On IE, if only LINK tags and no @import statements are used, all the CSS
  3128. * files are downloaded in parallel, resulting in faster page load, but if
  3129. * @import statements are used and span across multiple STYLE tags, all the
  3130. * ones from one STYLE tag must be downloaded before downloading begins for
  3131. * the next STYLE tag. Furthermore, IE7 does not support media declaration on
  3132. * the @import statement, so multiple STYLE tags must be used when different
  3133. * files are for different media types. Non-IE browsers always download in
  3134. * parallel, so this is an IE-specific performance quirk:
  3135. * http://www.stevesouders.com/blog/2009/04/09/dont-use-import/.
  3136. *
  3137. * However, IE has an annoying limit of 31 total CSS inclusion tags
  3138. * (http://drupal.org/node/228818) and LINK tags are limited to one file per
  3139. * tag, whereas STYLE tags can contain multiple @import statements allowing
  3140. * multiple files to be loaded per tag. When CSS aggregation is disabled, a
  3141. * Drupal site can easily have more than 31 CSS files that need to be loaded, so
  3142. * using LINK tags exclusively would result in a site that would display
  3143. * incorrectly in IE. Depending on different needs, different strategies can be
  3144. * employed to decide when to use LINK tags and when to use STYLE tags.
  3145. *
  3146. * The strategy employed by this function is to use LINK tags for all aggregate
  3147. * files and for all files that cannot be aggregated (e.g., if 'preprocess' is
  3148. * set to FALSE or the type is 'external'), and to use STYLE tags for groups
  3149. * of files that could be aggregated together but aren't (e.g., if the site-wide
  3150. * aggregation setting is disabled). This results in all LINK tags when
  3151. * aggregation is enabled, a guarantee that as many or only slightly more tags
  3152. * are used with aggregation disabled than enabled (so that if the limit were to
  3153. * be crossed with aggregation enabled, the site developer would also notice the
  3154. * problem while aggregation is disabled), and an easy way for a developer to
  3155. * view HTML source while aggregation is disabled and know what files will be
  3156. * aggregated together when aggregation becomes enabled.
  3157. *
  3158. * This function evaluates the aggregation enabled/disabled condition on a group
  3159. * by group basis by testing whether an aggregate file has been made for the
  3160. * group rather than by testing the site-wide aggregation setting. This allows
  3161. * this function to work correctly even if modules have implemented custom
  3162. * logic for grouping and aggregating files.
  3163. *
  3164. * @param $element
  3165. * A render array containing:
  3166. * - '#items': The CSS items as returned by drupal_add_css() and altered by
  3167. * drupal_get_css().
  3168. * - '#group_callback': A function to call to group #items to enable the use
  3169. * of fewer tags by aggregating files and/or using multiple @import
  3170. * statements within a single tag.
  3171. * - '#aggregate_callback': A function to call to aggregate the items within
  3172. * the groups arranged by the #group_callback function.
  3173. *
  3174. * @return
  3175. * A render array that will render to a string of XHTML CSS tags.
  3176. *
  3177. * @see drupal_get_css()
  3178. */
  3179. function drupal_pre_render_styles($elements) {
  3180. // Group and aggregate the items.
  3181. if (isset($elements['#group_callback'])) {
  3182. $elements['#groups'] = $elements['#group_callback']($elements['#items']);
  3183. }
  3184. if (isset($elements['#aggregate_callback'])) {
  3185. $elements['#aggregate_callback']($elements['#groups']);
  3186. }
  3187. // A dummy query-string is added to filenames, to gain control over
  3188. // browser-caching. The string changes on every update or full cache
  3189. // flush, forcing browsers to load a new copy of the files, as the
  3190. // URL changed.
  3191. $query_string = variable_get('css_js_query_string', '0');
  3192. // For inline CSS to validate as XHTML, all CSS containing XHTML needs to be
  3193. // wrapped in CDATA. To make that backwards compatible with HTML 4, we need to
  3194. // comment out the CDATA-tag.
  3195. $embed_prefix = "\n<!--/*--><![CDATA[/*><!--*/\n";
  3196. $embed_suffix = "\n/*]]>*/-->\n";
  3197. // Defaults for LINK and STYLE elements.
  3198. $link_element_defaults = array(
  3199. '#type' => 'html_tag',
  3200. '#tag' => 'link',
  3201. '#attributes' => array(
  3202. 'type' => 'text/css',
  3203. 'rel' => 'stylesheet',
  3204. ),
  3205. );
  3206. $style_element_defaults = array(
  3207. '#type' => 'html_tag',
  3208. '#tag' => 'style',
  3209. '#attributes' => array(
  3210. 'type' => 'text/css',
  3211. ),
  3212. );
  3213. // Loop through each group.
  3214. foreach ($elements['#groups'] as $group) {
  3215. switch ($group['type']) {
  3216. // For file items, there are three possibilites.
  3217. // - The group has been aggregated: in this case, output a LINK tag for
  3218. // the aggregate file.
  3219. // - The group can be aggregated but has not been (most likely because
  3220. // the site administrator disabled the site-wide setting): in this case,
  3221. // output as few STYLE tags for the group as possible, using @import
  3222. // statement for each file in the group. This enables us to stay within
  3223. // IE's limit of 31 total CSS inclusion tags.
  3224. // - The group contains items not eligible for aggregation (their
  3225. // 'preprocess' flag has been set to FALSE): in this case, output a LINK
  3226. // tag for each file.
  3227. case 'file':
  3228. // The group has been aggregated into a single file: output a LINK tag
  3229. // for the aggregate file.
  3230. if (isset($group['data'])) {
  3231. $element = $link_element_defaults;
  3232. $element['#attributes']['href'] = file_create_url($group['data']);
  3233. $element['#attributes']['media'] = $group['media'];
  3234. $element['#browsers'] = $group['browsers'];
  3235. $elements[] = $element;
  3236. }
  3237. // The group can be aggregated, but hasn't been: combine multiple items
  3238. // into as few STYLE tags as possible.
  3239. elseif ($group['preprocess']) {
  3240. $import = array();
  3241. foreach ($group['items'] as $item) {
  3242. // A theme's .info file may have an entry for a file that doesn't
  3243. // exist as a way of overriding a module or base theme CSS file from
  3244. // being added to the page. Normally, file_exists() calls that need
  3245. // to run for every page request should be minimized, but this one
  3246. // is okay, because it only runs when CSS aggregation is disabled.
  3247. // On a server under heavy enough load that file_exists() calls need
  3248. // to be minimized, CSS aggregation should be enabled, in which case
  3249. // this code is not run. When aggregation is enabled,
  3250. // drupal_load_stylesheet() checks file_exists(), but only when
  3251. // building the aggregate file, which is then reused for many page
  3252. // requests.
  3253. if (file_exists($item['data'])) {
  3254. // The dummy query string needs to be added to the URL to control
  3255. // browser-caching. IE7 does not support a media type on the
  3256. // @import statement, so we instead specify the media for the
  3257. // group on the STYLE tag.
  3258. $import[] = '@import url("' . check_plain(file_create_url($item['data']) . '?' . $query_string) . '");';
  3259. }
  3260. }
  3261. // In addition to IE's limit of 31 total CSS inclusion tags, it also
  3262. // has a limit of 31 @import statements per STYLE tag.
  3263. while (!empty($import)) {
  3264. $import_batch = array_slice($import, 0, 31);
  3265. $import = array_slice($import, 31);
  3266. $element = $style_element_defaults;
  3267. // This simplifies the JavaScript regex, allowing each line
  3268. // (separated by \n) to be treated as a completely different string.
  3269. // This means that we can use ^ and $ on one line at a time, and not
  3270. // worry about style tags since they'll never match the regex.
  3271. $element['#value'] = "\n" . implode("\n", $import_batch) . "\n";
  3272. $element['#attributes']['media'] = $group['media'];
  3273. $element['#browsers'] = $group['browsers'];
  3274. $elements[] = $element;
  3275. }
  3276. }
  3277. // The group contains items ineligible for aggregation: output a LINK
  3278. // tag for each file.
  3279. else {
  3280. foreach ($group['items'] as $item) {
  3281. $element = $link_element_defaults;
  3282. // We do not check file_exists() here, because this code runs for
  3283. // files whose 'preprocess' is set to FALSE, and therefore, even
  3284. // when aggregation is enabled, and we want to avoid needlessly
  3285. // taxing a server that may be under heavy load. The file_exists()
  3286. // performed above for files whose 'preprocess' is TRUE is done for
  3287. // the benefit of theme .info files, but code that deals with files
  3288. // whose 'preprocess' is FALSE is responsible for ensuring the file
  3289. // exists.
  3290. // The dummy query string needs to be added to the URL to control
  3291. // browser-caching.
  3292. $query_string_separator = (strpos($item['data'], '?') !== FALSE) ? '&' : '?';
  3293. $element['#attributes']['href'] = file_create_url($item['data']) . $query_string_separator . $query_string;
  3294. $element['#attributes']['media'] = $item['media'];
  3295. $element['#browsers'] = $group['browsers'];
  3296. $elements[] = $element;
  3297. }
  3298. }
  3299. break;
  3300. // For inline content, the 'data' property contains the CSS content. If
  3301. // the group's 'data' property is set, then output it in a single STYLE
  3302. // tag. Otherwise, output a separate STYLE tag for each item.
  3303. case 'inline':
  3304. if (isset($group['data'])) {
  3305. $element = $style_element_defaults;
  3306. $element['#value'] = $group['data'];
  3307. $element['#value_prefix'] = $embed_prefix;
  3308. $element['#value_suffix'] = $embed_suffix;
  3309. $element['#attributes']['media'] = $group['media'];
  3310. $element['#browsers'] = $group['browsers'];
  3311. $elements[] = $element;
  3312. }
  3313. else {
  3314. foreach ($group['items'] as $item) {
  3315. $element = $style_element_defaults;
  3316. $element['#value'] = $item['data'];
  3317. $element['#value_prefix'] = $embed_prefix;
  3318. $element['#value_suffix'] = $embed_suffix;
  3319. $element['#attributes']['media'] = $item['media'];
  3320. $element['#browsers'] = $group['browsers'];
  3321. $elements[] = $element;
  3322. }
  3323. }
  3324. break;
  3325. // Output a LINK tag for each external item. The item's 'data' property
  3326. // contains the full URL.
  3327. case 'external':
  3328. foreach ($group['items'] as $item) {
  3329. $element = $link_element_defaults;
  3330. $element['#attributes']['href'] = $item['data'];
  3331. $element['#attributes']['media'] = $item['media'];
  3332. $element['#browsers'] = $group['browsers'];
  3333. $elements[] = $element;
  3334. }
  3335. break;
  3336. }
  3337. }
  3338. return $elements;
  3339. }
  3340. /**
  3341. * Aggregates and optimizes CSS files into a cache file in the files directory.
  3342. *
  3343. * The file name for the CSS cache file is generated from the hash of the
  3344. * aggregated contents of the files in $css. This forces proxies and browsers
  3345. * to download new CSS when the CSS changes.
  3346. *
  3347. * The cache file name is retrieved on a page load via a lookup variable that
  3348. * contains an associative array. The array key is the hash of the file names
  3349. * in $css while the value is the cache file name. The cache file is generated
  3350. * in two cases. First, if there is no file name value for the key, which will
  3351. * happen if a new file name has been added to $css or after the lookup
  3352. * variable is emptied to force a rebuild of the cache. Second, the cache file
  3353. * is generated if it is missing on disk. Old cache files are not deleted
  3354. * immediately when the lookup variable is emptied, but are deleted after a set
  3355. * period by drupal_delete_file_if_stale(). This ensures that files referenced
  3356. * by a cached page will still be available.
  3357. *
  3358. * @param $css
  3359. * An array of CSS files to aggregate and compress into one file.
  3360. *
  3361. * @return
  3362. * The URI of the CSS cache file, or FALSE if the file could not be saved.
  3363. */
  3364. function drupal_build_css_cache($css) {
  3365. $data = '';
  3366. $uri = '';
  3367. $map = variable_get('drupal_css_cache_files', array());
  3368. // Create a new array so that only the file names are used to create the hash.
  3369. // This prevents new aggregates from being created unnecessarily.
  3370. $css_data = array();
  3371. foreach ($css as $css_file) {
  3372. $css_data[] = $css_file['data'];
  3373. }
  3374. $key = hash('sha256', serialize($css_data));
  3375. if (isset($map[$key])) {
  3376. $uri = $map[$key];
  3377. }
  3378. if (empty($uri) || !file_exists($uri)) {
  3379. // Build aggregate CSS file.
  3380. foreach ($css as $stylesheet) {
  3381. // Only 'file' stylesheets can be aggregated.
  3382. if ($stylesheet['type'] == 'file') {
  3383. $contents = drupal_load_stylesheet($stylesheet['data'], TRUE);
  3384. // Build the base URL of this CSS file: start with the full URL.
  3385. $css_base_url = file_create_url($stylesheet['data']);
  3386. // Move to the parent.
  3387. $css_base_url = substr($css_base_url, 0, strrpos($css_base_url, '/'));
  3388. // Simplify to a relative URL if the stylesheet URL starts with the
  3389. // base URL of the website.
  3390. if (substr($css_base_url, 0, strlen($GLOBALS['base_root'])) == $GLOBALS['base_root']) {
  3391. $css_base_url = substr($css_base_url, strlen($GLOBALS['base_root']));
  3392. }
  3393. _drupal_build_css_path(NULL, $css_base_url . '/');
  3394. // Anchor all paths in the CSS with its base URL, ignoring external and absolute paths.
  3395. $data .= preg_replace_callback('/url\(\s*[\'"]?(?![a-z]+:|\/+)([^\'")]+)[\'"]?\s*\)/i', '_drupal_build_css_path', $contents);
  3396. }
  3397. }
  3398. // Per the W3C specification at http://www.w3.org/TR/REC-CSS2/cascade.html#at-import,
  3399. // @import rules must proceed any other style, so we move those to the top.
  3400. $regexp = '/@import[^;]+;/i';
  3401. preg_match_all($regexp, $data, $matches);
  3402. $data = preg_replace($regexp, '', $data);
  3403. $data = implode('', $matches[0]) . $data;
  3404. // Prefix filename to prevent blocking by firewalls which reject files
  3405. // starting with "ad*".
  3406. $filename = 'css_' . drupal_hash_base64($data) . '.css';
  3407. // Create the css/ within the files folder.
  3408. $csspath = 'public://css';
  3409. $uri = $csspath . '/' . $filename;
  3410. // Create the CSS file.
  3411. file_prepare_directory($csspath, FILE_CREATE_DIRECTORY);
  3412. if (!file_exists($uri) && !file_unmanaged_save_data($data, $uri, FILE_EXISTS_REPLACE)) {
  3413. return FALSE;
  3414. }
  3415. // If CSS gzip compression is enabled, clean URLs are enabled (which means
  3416. // that rewrite rules are working) and the zlib extension is available then
  3417. // create a gzipped version of this file. This file is served conditionally
  3418. // to browsers that accept gzip using .htaccess rules.
  3419. if (variable_get('css_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
  3420. if (!file_exists($uri . '.gz') && !file_unmanaged_save_data(gzencode($data, 9, FORCE_GZIP), $uri . '.gz', FILE_EXISTS_REPLACE)) {
  3421. return FALSE;
  3422. }
  3423. }
  3424. // Save the updated map.
  3425. $map[$key] = $uri;
  3426. variable_set('drupal_css_cache_files', $map);
  3427. }
  3428. return $uri;
  3429. }
  3430. /**
  3431. * Prefixes all paths within a CSS file for drupal_build_css_cache().
  3432. */
  3433. function _drupal_build_css_path($matches, $base = NULL) {
  3434. $_base = &drupal_static(__FUNCTION__);
  3435. // Store base path for preg_replace_callback.
  3436. if (isset($base)) {
  3437. $_base = $base;
  3438. }
  3439. // Prefix with base and remove '../' segments where possible.
  3440. $path = $_base . $matches[1];
  3441. $last = '';
  3442. while ($path != $last) {
  3443. $last = $path;
  3444. $path = preg_replace('`(^|/)(?!\.\./)([^/]+)/\.\./`', '$1', $path);
  3445. }
  3446. return 'url(' . $path . ')';
  3447. }
  3448. /**
  3449. * Loads the stylesheet and resolves all @import commands.
  3450. *
  3451. * Loads a stylesheet and replaces @import commands with the contents of the
  3452. * imported file. Use this instead of file_get_contents when processing
  3453. * stylesheets.
  3454. *
  3455. * The returned contents are compressed removing white space and comments only
  3456. * when CSS aggregation is enabled. This optimization will not apply for
  3457. * color.module enabled themes with CSS aggregation turned off.
  3458. *
  3459. * @param $file
  3460. * Name of the stylesheet to be processed.
  3461. * @param $optimize
  3462. * Defines if CSS contents should be compressed or not.
  3463. * @param $reset_basepath
  3464. * Used internally to facilitate recursive resolution of @import commands.
  3465. *
  3466. * @return
  3467. * Contents of the stylesheet, including any resolved @import commands.
  3468. */
  3469. function drupal_load_stylesheet($file, $optimize = NULL, $reset_basepath = TRUE) {
  3470. // These statics are not cache variables, so we don't use drupal_static().
  3471. static $_optimize, $basepath;
  3472. if ($reset_basepath) {
  3473. $basepath = '';
  3474. }
  3475. // Store the value of $optimize for preg_replace_callback with nested
  3476. // @import loops.
  3477. if (isset($optimize)) {
  3478. $_optimize = $optimize;
  3479. }
  3480. // Stylesheets are relative one to each other. Start by adding a base path
  3481. // prefix provided by the parent stylesheet (if necessary).
  3482. if ($basepath && !file_uri_scheme($file)) {
  3483. $file = $basepath . '/' . $file;
  3484. }
  3485. // Store the parent base path to restore it later.
  3486. $parent_base_path = $basepath;
  3487. // Set the current base path to process possible child imports.
  3488. $basepath = dirname($file);
  3489. // Load the CSS stylesheet. We suppress errors because themes may specify
  3490. // stylesheets in their .info file that don't exist in the theme's path,
  3491. // but are merely there to disable certain module CSS files.
  3492. $content = '';
  3493. if ($contents = @file_get_contents($file)) {
  3494. // Return the processed stylesheet.
  3495. $content = drupal_load_stylesheet_content($contents, $_optimize);
  3496. }
  3497. // Restore the parent base path as the file and its childen are processed.
  3498. $basepath = $parent_base_path;
  3499. return $content;
  3500. }
  3501. /**
  3502. * Processes the contents of a stylesheet for aggregation.
  3503. *
  3504. * @param $contents
  3505. * The contents of the stylesheet.
  3506. * @param $optimize
  3507. * (optional) Boolean whether CSS contents should be minified. Defaults to
  3508. * FALSE.
  3509. *
  3510. * @return
  3511. * Contents of the stylesheet including the imported stylesheets.
  3512. */
  3513. function drupal_load_stylesheet_content($contents, $optimize = FALSE) {
  3514. // Remove multiple charset declarations for standards compliance (and fixing Safari problems).
  3515. $contents = preg_replace('/^@charset\s+[\'"](\S*?)\b[\'"];/i', '', $contents);
  3516. if ($optimize) {
  3517. // Perform some safe CSS optimizations.
  3518. // Regexp to match comment blocks.
  3519. $comment = '/\*[^*]*\*+(?:[^/*][^*]*\*+)*/';
  3520. // Regexp to match double quoted strings.
  3521. $double_quot = '"[^"\\\\]*(?:\\\\.[^"\\\\]*)*"';
  3522. // Regexp to match single quoted strings.
  3523. $single_quot = "'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'";
  3524. // Strip all comment blocks, but keep double/single quoted strings.
  3525. $contents = preg_replace(
  3526. "<($double_quot|$single_quot)|$comment>Ss",
  3527. "$1",
  3528. $contents
  3529. );
  3530. // Remove certain whitespace.
  3531. // There are different conditions for removing leading and trailing
  3532. // whitespace.
  3533. // @see http://php.net/manual/regexp.reference.subpatterns.php
  3534. $contents = preg_replace('<
  3535. # Strip leading and trailing whitespace.
  3536. \s*([@{};,])\s*
  3537. # Strip only leading whitespace from:
  3538. # - Closing parenthesis: Retain "@media (bar) and foo".
  3539. | \s+([\)])
  3540. # Strip only trailing whitespace from:
  3541. # - Opening parenthesis: Retain "@media (bar) and foo".
  3542. # - Colon: Retain :pseudo-selectors.
  3543. | ([\(:])\s+
  3544. >xS',
  3545. // Only one of the three capturing groups will match, so its reference
  3546. // will contain the wanted value and the references for the
  3547. // two non-matching groups will be replaced with empty strings.
  3548. '$1$2$3',
  3549. $contents
  3550. );
  3551. // End the file with a new line.
  3552. $contents = trim($contents);
  3553. $contents .= "\n";
  3554. }
  3555. // Replaces @import commands with the actual stylesheet content.
  3556. // This happens recursively but omits external files.
  3557. $contents = preg_replace_callback('/@import\s*(?:url\(\s*)?[\'"]?(?![a-z]+:)(?!\/\/)([^\'"\()]+)[\'"]?\s*\)?\s*;/', '_drupal_load_stylesheet', $contents);
  3558. return $contents;
  3559. }
  3560. /**
  3561. * Loads stylesheets recursively and returns contents with corrected paths.
  3562. *
  3563. * This function is used for recursive loading of stylesheets and
  3564. * returns the stylesheet content with all url() paths corrected.
  3565. */
  3566. function _drupal_load_stylesheet($matches) {
  3567. $filename = $matches[1];
  3568. // Load the imported stylesheet and replace @import commands in there as well.
  3569. $file = drupal_load_stylesheet($filename, NULL, FALSE);
  3570. // Determine the file's directory.
  3571. $directory = dirname($filename);
  3572. // If the file is in the current directory, make sure '.' doesn't appear in
  3573. // the url() path.
  3574. $directory = $directory == '.' ? '' : $directory .'/';
  3575. // Alter all internal url() paths. Leave external paths alone. We don't need
  3576. // to normalize absolute paths here (i.e. remove folder/... segments) because
  3577. // that will be done later.
  3578. return preg_replace('/url\(\s*([\'"]?)(?![a-z]+:|\/+)([^\'")]+)([\'"]?)\s*\)/i', 'url(\1' . $directory . '\2\3)', $file);
  3579. }
  3580. /**
  3581. * Deletes old cached CSS files.
  3582. */
  3583. function drupal_clear_css_cache() {
  3584. variable_del('drupal_css_cache_files');
  3585. file_scan_directory('public://css', '/.*/', array('callback' => 'drupal_delete_file_if_stale'));
  3586. }
  3587. /**
  3588. * Callback to delete files modified more than a set time ago.
  3589. */
  3590. function drupal_delete_file_if_stale($uri) {
  3591. // Default stale file threshold is 30 days.
  3592. if (REQUEST_TIME - filemtime($uri) > variable_get('drupal_stale_file_threshold', 2592000)) {
  3593. file_unmanaged_delete($uri);
  3594. }
  3595. }
  3596. /**
  3597. * Prepares a string for use as a CSS identifier (element, class, or ID name).
  3598. *
  3599. * http://www.w3.org/TR/CSS21/syndata.html#characters shows the syntax for valid
  3600. * CSS identifiers (including element names, classes, and IDs in selectors.)
  3601. *
  3602. * @param $identifier
  3603. * The identifier to clean.
  3604. * @param $filter
  3605. * An array of string replacements to use on the identifier.
  3606. *
  3607. * @return
  3608. * The cleaned identifier.
  3609. */
  3610. function drupal_clean_css_identifier($identifier, $filter = array(' ' => '-', '_' => '-', '/' => '-', '[' => '-', ']' => '')) {
  3611. // Use the advanced drupal_static() pattern, since this is called very often.
  3612. static $drupal_static_fast;
  3613. if (!isset($drupal_static_fast)) {
  3614. $drupal_static_fast['allow_css_double_underscores'] = &drupal_static(__FUNCTION__ . ':allow_css_double_underscores');
  3615. }
  3616. $allow_css_double_underscores = &$drupal_static_fast['allow_css_double_underscores'];
  3617. if (!isset($allow_css_double_underscores)) {
  3618. $allow_css_double_underscores = variable_get('allow_css_double_underscores', FALSE);
  3619. }
  3620. // Preserve BEM-style double-underscores depending on custom setting.
  3621. if ($allow_css_double_underscores) {
  3622. $filter['__'] = '__';
  3623. }
  3624. // By default, we filter using Drupal's coding standards.
  3625. $identifier = strtr($identifier, $filter);
  3626. // Valid characters in a CSS identifier are:
  3627. // - the hyphen (U+002D)
  3628. // - a-z (U+0030 - U+0039)
  3629. // - A-Z (U+0041 - U+005A)
  3630. // - the underscore (U+005F)
  3631. // - 0-9 (U+0061 - U+007A)
  3632. // - ISO 10646 characters U+00A1 and higher
  3633. // We strip out any character not in the above list.
  3634. $identifier = preg_replace('/[^\x{002D}\x{0030}-\x{0039}\x{0041}-\x{005A}\x{005F}\x{0061}-\x{007A}\x{00A1}-\x{FFFF}]/u', '', $identifier);
  3635. return $identifier;
  3636. }
  3637. /**
  3638. * Prepares a string for use as a valid class name.
  3639. *
  3640. * Do not pass one string containing multiple classes as they will be
  3641. * incorrectly concatenated with dashes, i.e. "one two" will become "one-two".
  3642. *
  3643. * @param $class
  3644. * The class name to clean.
  3645. *
  3646. * @return
  3647. * The cleaned class name.
  3648. */
  3649. function drupal_html_class($class) {
  3650. // The output of this function will never change, so this uses a normal
  3651. // static instead of drupal_static().
  3652. static $classes = array();
  3653. if (!isset($classes[$class])) {
  3654. $classes[$class] = drupal_clean_css_identifier(drupal_strtolower($class));
  3655. }
  3656. return $classes[$class];
  3657. }
  3658. /**
  3659. * Prepares a string for use as a valid HTML ID and guarantees uniqueness.
  3660. *
  3661. * This function ensures that each passed HTML ID value only exists once on the
  3662. * page. By tracking the already returned ids, this function enables forms,
  3663. * blocks, and other content to be output multiple times on the same page,
  3664. * without breaking (X)HTML validation.
  3665. *
  3666. * For already existing IDs, a counter is appended to the ID string. Therefore,
  3667. * JavaScript and CSS code should not rely on any value that was generated by
  3668. * this function and instead should rely on manually added CSS classes or
  3669. * similarly reliable constructs.
  3670. *
  3671. * Two consecutive hyphens separate the counter from the original ID. To manage
  3672. * uniqueness across multiple Ajax requests on the same page, Ajax requests
  3673. * POST an array of all IDs currently present on the page, which are used to
  3674. * prime this function's cache upon first invocation.
  3675. *
  3676. * To allow reverse-parsing of IDs submitted via Ajax, any multiple consecutive
  3677. * hyphens in the originally passed $id are replaced with a single hyphen.
  3678. *
  3679. * @param $id
  3680. * The ID to clean.
  3681. *
  3682. * @return
  3683. * The cleaned ID.
  3684. */
  3685. function drupal_html_id($id) {
  3686. // If this is an Ajax request, then content returned by this page request will
  3687. // be merged with content already on the base page. The HTML IDs must be
  3688. // unique for the fully merged content. Therefore, initialize $seen_ids to
  3689. // take into account IDs that are already in use on the base page.
  3690. static $drupal_static_fast;
  3691. if (!isset($drupal_static_fast['seen_ids_init'])) {
  3692. $drupal_static_fast['seen_ids_init'] = &drupal_static(__FUNCTION__ . ':init');
  3693. }
  3694. $seen_ids_init = &$drupal_static_fast['seen_ids_init'];
  3695. if (!isset($seen_ids_init)) {
  3696. // Ideally, Drupal would provide an API to persist state information about
  3697. // prior page requests in the database, and we'd be able to add this
  3698. // function's $seen_ids static variable to that state information in order
  3699. // to have it properly initialized for this page request. However, no such
  3700. // page state API exists, so instead, ajax.js adds all of the in-use HTML
  3701. // IDs to the POST data of Ajax submissions. Direct use of $_POST is
  3702. // normally not recommended as it could open up security risks, but because
  3703. // the raw POST data is cast to a number before being returned by this
  3704. // function, this usage is safe.
  3705. if (empty($_POST['ajax_html_ids'])) {
  3706. $seen_ids_init = array();
  3707. }
  3708. else {
  3709. // This function ensures uniqueness by appending a counter to the base id
  3710. // requested by the calling function after the first occurrence of that
  3711. // requested id. $_POST['ajax_html_ids'] contains the ids as they were
  3712. // returned by this function, potentially with the appended counter, so
  3713. // we parse that to reconstruct the $seen_ids array.
  3714. if (isset($_POST['ajax_html_ids'][0]) && strpos($_POST['ajax_html_ids'][0], ',') === FALSE) {
  3715. $ajax_html_ids = $_POST['ajax_html_ids'];
  3716. }
  3717. else {
  3718. // jquery.form.js may send the server a comma-separated string as the
  3719. // first element of an array (see http://drupal.org/node/1575060), so
  3720. // we need to convert it to an array in that case.
  3721. $ajax_html_ids = explode(',', $_POST['ajax_html_ids'][0]);
  3722. }
  3723. foreach ($ajax_html_ids as $seen_id) {
  3724. // We rely on '--' being used solely for separating a base id from the
  3725. // counter, which this function ensures when returning an id.
  3726. $parts = explode('--', $seen_id, 2);
  3727. if (!empty($parts[1]) && is_numeric($parts[1])) {
  3728. list($seen_id, $i) = $parts;
  3729. }
  3730. else {
  3731. $i = 1;
  3732. }
  3733. if (!isset($seen_ids_init[$seen_id]) || ($i > $seen_ids_init[$seen_id])) {
  3734. $seen_ids_init[$seen_id] = $i;
  3735. }
  3736. }
  3737. }
  3738. }
  3739. if (!isset($drupal_static_fast['seen_ids'])) {
  3740. $drupal_static_fast['seen_ids'] = &drupal_static(__FUNCTION__, $seen_ids_init);
  3741. }
  3742. $seen_ids = &$drupal_static_fast['seen_ids'];
  3743. $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
  3744. // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can
  3745. // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"),
  3746. // colons (":"), and periods ("."). We strip out any character not in that
  3747. // list. Note that the CSS spec doesn't allow colons or periods in identifiers
  3748. // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two
  3749. // characters as well.
  3750. $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id);
  3751. // Removing multiple consecutive hyphens.
  3752. $id = preg_replace('/\-+/', '-', $id);
  3753. // Ensure IDs are unique by appending a counter after the first occurrence.
  3754. // The counter needs to be appended with a delimiter that does not exist in
  3755. // the base ID. Requiring a unique delimiter helps ensure that we really do
  3756. // return unique IDs and also helps us re-create the $seen_ids array during
  3757. // Ajax requests.
  3758. if (isset($seen_ids[$id])) {
  3759. $id = $id . '--' . ++$seen_ids[$id];
  3760. }
  3761. else {
  3762. $seen_ids[$id] = 1;
  3763. }
  3764. return $id;
  3765. }
  3766. /**
  3767. * Provides a standard HTML class name that identifies a page region.
  3768. *
  3769. * It is recommended that template preprocess functions apply this class to any
  3770. * page region that is output by the theme (Drupal core already handles this in
  3771. * the standard template preprocess implementation). Standardizing the class
  3772. * names in this way allows modules to implement certain features, such as
  3773. * drag-and-drop or dynamic Ajax loading, in a theme-independent way.
  3774. *
  3775. * @param $region
  3776. * The name of the page region (for example, 'page_top' or 'content').
  3777. *
  3778. * @return
  3779. * An HTML class that identifies the region (for example, 'region-page-top'
  3780. * or 'region-content').
  3781. *
  3782. * @see template_preprocess_region()
  3783. */
  3784. function drupal_region_class($region) {
  3785. return drupal_html_class("region-$region");
  3786. }
  3787. /**
  3788. * Adds a JavaScript file, setting, or inline code to the page.
  3789. *
  3790. * The behavior of this function depends on the parameters it is called with.
  3791. * Generally, it handles the addition of JavaScript to the page, either as
  3792. * reference to an existing file or as inline code. The following actions can be
  3793. * performed using this function:
  3794. * - Add a file ('file'): Adds a reference to a JavaScript file to the page.
  3795. * - Add inline JavaScript code ('inline'): Executes a piece of JavaScript code
  3796. * on the current page by placing the code directly in the page (for example,
  3797. * to tell the user that a new message arrived, by opening a pop up, alert
  3798. * box, etc.). This should only be used for JavaScript that cannot be executed
  3799. * from a file. When adding inline code, make sure that you are not relying on
  3800. * $() being the jQuery function. Wrap your code in
  3801. * @code (function ($) {... })(jQuery); @endcode
  3802. * or use jQuery() instead of $().
  3803. * - Add external JavaScript ('external'): Allows the inclusion of external
  3804. * JavaScript files that are not hosted on the local server. Note that these
  3805. * external JavaScript references do not get aggregated when preprocessing is
  3806. * on.
  3807. * - Add settings ('setting'): Adds settings to Drupal's global storage of
  3808. * JavaScript settings. Per-page settings are required by some modules to
  3809. * function properly. All settings will be accessible at Drupal.settings.
  3810. *
  3811. * Examples:
  3812. * @code
  3813. * drupal_add_js('misc/collapse.js');
  3814. * drupal_add_js('misc/collapse.js', 'file');
  3815. * drupal_add_js('jQuery(document).ready(function () { alert("Hello!"); });', 'inline');
  3816. * drupal_add_js('jQuery(document).ready(function () { alert("Hello!"); });',
  3817. * array('type' => 'inline', 'scope' => 'footer', 'weight' => 5)
  3818. * );
  3819. * drupal_add_js('http://example.com/example.js', 'external');
  3820. * drupal_add_js(array('myModule' => array('key' => 'value')), 'setting');
  3821. * @endcode
  3822. *
  3823. * Calling drupal_static_reset('drupal_add_js') will clear all JavaScript added
  3824. * so far.
  3825. *
  3826. * If JavaScript aggregation is enabled, all JavaScript files added with
  3827. * $options['preprocess'] set to TRUE will be merged into one aggregate file.
  3828. * Preprocessed inline JavaScript will not be aggregated into this single file.
  3829. * Externally hosted JavaScripts are never aggregated.
  3830. *
  3831. * The reason for aggregating the files is outlined quite thoroughly here:
  3832. * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
  3833. * to request overhead, one bigger file just loads faster than two smaller ones
  3834. * half its size."
  3835. *
  3836. * $options['preprocess'] should be only set to TRUE when a file is required for
  3837. * all typical visitors and most pages of a site. It is critical that all
  3838. * preprocessed files are added unconditionally on every page, even if the
  3839. * files are not needed on a page. This is normally done by calling
  3840. * drupal_add_js() in a hook_init() implementation.
  3841. *
  3842. * Non-preprocessed files should only be added to the page when they are
  3843. * actually needed.
  3844. *
  3845. * @param $data
  3846. * (optional) If given, the value depends on the $options parameter, or
  3847. * $options['type'] if $options is passed as an associative array:
  3848. * - 'file': Path to the file relative to base_path().
  3849. * - 'inline': The JavaScript code that should be placed in the given scope.
  3850. * - 'external': The absolute path to an external JavaScript file that is not
  3851. * hosted on the local server. These files will not be aggregated if
  3852. * JavaScript aggregation is enabled.
  3853. * - 'setting': An associative array with configuration options. The array is
  3854. * merged directly into Drupal.settings. All modules should wrap their
  3855. * actual configuration settings in another variable to prevent conflicts in
  3856. * the Drupal.settings namespace. Items added with a string key will replace
  3857. * existing settings with that key; items with numeric array keys will be
  3858. * added to the existing settings array.
  3859. * @param $options
  3860. * (optional) A string defining the type of JavaScript that is being added in
  3861. * the $data parameter ('file'/'setting'/'inline'/'external'), or an
  3862. * associative array. JavaScript settings should always pass the string
  3863. * 'setting' only. Other types can have the following elements in the array:
  3864. * - type: The type of JavaScript that is to be added to the page. Allowed
  3865. * values are 'file', 'inline', 'external' or 'setting'. Defaults
  3866. * to 'file'.
  3867. * - scope: The location in which you want to place the script. Possible
  3868. * values are 'header' or 'footer'. If your theme implements different
  3869. * regions, you can also use these. Defaults to 'header'.
  3870. * - group: A number identifying the group in which to add the JavaScript.
  3871. * Available constants are:
  3872. * - JS_LIBRARY: Any libraries, settings, or jQuery plugins.
  3873. * - JS_DEFAULT: Any module-layer JavaScript.
  3874. * - JS_THEME: Any theme-layer JavaScript.
  3875. * The group number serves as a weight: JavaScript within a lower weight
  3876. * group is presented on the page before JavaScript within a higher weight
  3877. * group.
  3878. * - every_page: For optimal front-end performance when aggregation is
  3879. * enabled, this should be set to TRUE if the JavaScript is present on every
  3880. * page of the website for users for whom it is present at all. This
  3881. * defaults to FALSE. It is set to TRUE for JavaScript files that are added
  3882. * via module and theme .info files. Modules that add JavaScript within
  3883. * hook_init() implementations, or from other code that ensures that the
  3884. * JavaScript is added to all website pages, should also set this flag to
  3885. * TRUE. All JavaScript files within the same group and that have the
  3886. * 'every_page' flag set to TRUE and do not have 'preprocess' set to FALSE
  3887. * are aggregated together into a single aggregate file, and that aggregate
  3888. * file can be reused across a user's entire site visit, leading to faster
  3889. * navigation between pages. However, JavaScript that is only needed on
  3890. * pages less frequently visited, can be added by code that only runs for
  3891. * those particular pages, and that code should not set the 'every_page'
  3892. * flag. This minimizes the size of the aggregate file that the user needs
  3893. * to download when first visiting the website. JavaScript without the
  3894. * 'every_page' flag is aggregated into a separate aggregate file. This
  3895. * other aggregate file is likely to change from page to page, and each new
  3896. * aggregate file needs to be downloaded when first encountered, so it
  3897. * should be kept relatively small by ensuring that most commonly needed
  3898. * JavaScript is added to every page.
  3899. * - weight: A number defining the order in which the JavaScript is added to
  3900. * the page relative to other JavaScript with the same 'scope', 'group',
  3901. * and 'every_page' value. In some cases, the order in which the JavaScript
  3902. * is presented on the page is very important. jQuery, for example, must be
  3903. * added to the page before any jQuery code is run, so jquery.js uses the
  3904. * JS_LIBRARY group and a weight of -20, jquery.once.js (a library drupal.js
  3905. * depends on) uses the JS_LIBRARY group and a weight of -19, drupal.js uses
  3906. * the JS_LIBRARY group and a weight of -1, other libraries use the
  3907. * JS_LIBRARY group and a weight of 0 or higher, and all other scripts use
  3908. * one of the other group constants. The exact ordering of JavaScript is as
  3909. * follows:
  3910. * - First by scope, with 'header' first, 'footer' last, and any other
  3911. * scopes provided by a custom theme coming in between, as determined by
  3912. * the theme.
  3913. * - Then by group.
  3914. * - Then by the 'every_page' flag, with TRUE coming before FALSE.
  3915. * - Then by weight.
  3916. * - Then by the order in which the JavaScript was added. For example, all
  3917. * else being the same, JavaScript added by a call to drupal_add_js() that
  3918. * happened later in the page request gets added to the page after one for
  3919. * which drupal_add_js() happened earlier in the page request.
  3920. * - requires_jquery: Set this to FALSE if the JavaScript you are adding does
  3921. * not have a dependency on jQuery. Defaults to TRUE, except for JavaScript
  3922. * settings where it defaults to FALSE. This is used on sites that have the
  3923. * 'javascript_always_use_jquery' variable set to FALSE; on those sites, if
  3924. * all the JavaScript added to the page by drupal_add_js() does not have a
  3925. * dependency on jQuery, then for improved front-end performance Drupal
  3926. * will not add jQuery and related libraries and settings to the page.
  3927. * - defer: If set to TRUE, the defer attribute is set on the <script>
  3928. * tag. Defaults to FALSE.
  3929. * - cache: If set to FALSE, the JavaScript file is loaded anew on every page
  3930. * call; in other words, it is not cached. Used only when 'type' references
  3931. * a JavaScript file. Defaults to TRUE.
  3932. * - preprocess: If TRUE and JavaScript aggregation is enabled, the script
  3933. * file will be aggregated. Defaults to TRUE.
  3934. *
  3935. * @return
  3936. * The current array of JavaScript files, settings, and in-line code,
  3937. * including Drupal defaults, anything previously added with calls to
  3938. * drupal_add_js(), and this function call's additions.
  3939. *
  3940. * @see drupal_get_js()
  3941. */
  3942. function drupal_add_js($data = NULL, $options = NULL) {
  3943. $javascript = &drupal_static(__FUNCTION__, array());
  3944. $jquery_added = &drupal_static(__FUNCTION__ . ':jquery_added', FALSE);
  3945. // If the $javascript variable has been reset with drupal_static_reset(),
  3946. // jQuery and related files will have been removed from the list, so set the
  3947. // variable back to FALSE to indicate they have not yet been added.
  3948. if (empty($javascript)) {
  3949. $jquery_added = FALSE;
  3950. }
  3951. // Construct the options, taking the defaults into consideration.
  3952. if (isset($options)) {
  3953. if (!is_array($options)) {
  3954. $options = array('type' => $options);
  3955. }
  3956. }
  3957. else {
  3958. $options = array();
  3959. }
  3960. if (isset($options['type']) && $options['type'] == 'setting') {
  3961. $options += array('requires_jquery' => FALSE);
  3962. }
  3963. $options += drupal_js_defaults($data);
  3964. // Preprocess can only be set if caching is enabled.
  3965. $options['preprocess'] = $options['cache'] ? $options['preprocess'] : FALSE;
  3966. // Tweak the weight so that files of the same weight are included in the
  3967. // order of the calls to drupal_add_js().
  3968. $options['weight'] += count($javascript) / 1000;
  3969. if (isset($data)) {
  3970. // Add jquery.js, drupal.js, and related files and settings if they have
  3971. // not been added yet. However, if the 'javascript_always_use_jquery'
  3972. // variable is set to FALSE (indicating that the site does not want jQuery
  3973. // automatically added on all pages) then only add it if a file or setting
  3974. // that requires jQuery is being added also.
  3975. if (!$jquery_added && (variable_get('javascript_always_use_jquery', TRUE) || $options['requires_jquery'])) {
  3976. $jquery_added = TRUE;
  3977. // url() generates the prefix using hook_url_outbound_alter(). Instead of
  3978. // running the hook_url_outbound_alter() again here, extract the prefix
  3979. // from url().
  3980. url('', array('prefix' => &$prefix));
  3981. $default_javascript = array(
  3982. 'settings' => array(
  3983. 'data' => array(
  3984. array('basePath' => base_path()),
  3985. array('pathPrefix' => empty($prefix) ? '' : $prefix),
  3986. ),
  3987. 'type' => 'setting',
  3988. 'scope' => 'header',
  3989. 'group' => JS_LIBRARY,
  3990. 'every_page' => TRUE,
  3991. 'weight' => 0,
  3992. ),
  3993. 'misc/drupal.js' => array(
  3994. 'data' => 'misc/drupal.js',
  3995. 'type' => 'file',
  3996. 'scope' => 'header',
  3997. 'group' => JS_LIBRARY,
  3998. 'every_page' => TRUE,
  3999. 'weight' => -1,
  4000. 'requires_jquery' => TRUE,
  4001. 'preprocess' => TRUE,
  4002. 'cache' => TRUE,
  4003. 'defer' => FALSE,
  4004. ),
  4005. );
  4006. $javascript = drupal_array_merge_deep($javascript, $default_javascript);
  4007. // Register all required libraries.
  4008. drupal_add_library('system', 'jquery', TRUE);
  4009. drupal_add_library('system', 'jquery.once', TRUE);
  4010. }
  4011. switch ($options['type']) {
  4012. case 'setting':
  4013. // All JavaScript settings are placed in the header of the page with
  4014. // the library weight so that inline scripts appear afterwards.
  4015. $javascript['settings']['data'][] = $data;
  4016. break;
  4017. case 'inline':
  4018. $javascript[] = $options;
  4019. break;
  4020. default: // 'file' and 'external'
  4021. // Local and external files must keep their name as the associative key
  4022. // so the same JavaScript file is not added twice.
  4023. $javascript[$options['data']] = $options;
  4024. }
  4025. }
  4026. return $javascript;
  4027. }
  4028. /**
  4029. * Constructs an array of the defaults that are used for JavaScript items.
  4030. *
  4031. * @param $data
  4032. * (optional) The default data parameter for the JavaScript item array.
  4033. *
  4034. * @see drupal_get_js()
  4035. * @see drupal_add_js()
  4036. */
  4037. function drupal_js_defaults($data = NULL) {
  4038. return array(
  4039. 'type' => 'file',
  4040. 'group' => JS_DEFAULT,
  4041. 'every_page' => FALSE,
  4042. 'weight' => 0,
  4043. 'requires_jquery' => TRUE,
  4044. 'scope' => 'header',
  4045. 'cache' => TRUE,
  4046. 'defer' => FALSE,
  4047. 'preprocess' => TRUE,
  4048. 'version' => NULL,
  4049. 'data' => $data,
  4050. );
  4051. }
  4052. /**
  4053. * Returns a themed presentation of all JavaScript code for the current page.
  4054. *
  4055. * References to JavaScript files are placed in a certain order: first, all
  4056. * 'core' files, then all 'module' and finally all 'theme' JavaScript files
  4057. * are added to the page. Then, all settings are output, followed by 'inline'
  4058. * JavaScript code. If running update.php, all preprocessing is disabled.
  4059. *
  4060. * Note that hook_js_alter(&$javascript) is called during this function call
  4061. * to allow alterations of the JavaScript during its presentation. Calls to
  4062. * drupal_add_js() from hook_js_alter() will not be added to the output
  4063. * presentation. The correct way to add JavaScript during hook_js_alter()
  4064. * is to add another element to the $javascript array, deriving from
  4065. * drupal_js_defaults(). See locale_js_alter() for an example of this.
  4066. *
  4067. * @param $scope
  4068. * (optional) The scope for which the JavaScript rules should be returned.
  4069. * Defaults to 'header'.
  4070. * @param $javascript
  4071. * (optional) An array with all JavaScript code. Defaults to the default
  4072. * JavaScript array for the given scope.
  4073. * @param $skip_alter
  4074. * (optional) If set to TRUE, this function skips calling drupal_alter() on
  4075. * $javascript, useful when the calling function passes a $javascript array
  4076. * that has already been altered.
  4077. *
  4078. * @return
  4079. * All JavaScript code segments and includes for the scope as HTML tags.
  4080. *
  4081. * @see drupal_add_js()
  4082. * @see locale_js_alter()
  4083. * @see drupal_js_defaults()
  4084. */
  4085. function drupal_get_js($scope = 'header', $javascript = NULL, $skip_alter = FALSE) {
  4086. if (!isset($javascript)) {
  4087. $javascript = drupal_add_js();
  4088. }
  4089. // If no JavaScript items have been added, or if the only JavaScript items
  4090. // that have been added are JavaScript settings (which don't do anything
  4091. // without any JavaScript code to use them), then no JavaScript code should
  4092. // be added to the page.
  4093. if (empty($javascript) || (isset($javascript['settings']) && count($javascript) == 1)) {
  4094. return '';
  4095. }
  4096. // Allow modules to alter the JavaScript.
  4097. if (!$skip_alter) {
  4098. drupal_alter('js', $javascript);
  4099. }
  4100. // Filter out elements of the given scope.
  4101. $items = array();
  4102. foreach ($javascript as $key => $item) {
  4103. if ($item['scope'] == $scope) {
  4104. $items[$key] = $item;
  4105. }
  4106. }
  4107. $output = '';
  4108. // The index counter is used to keep aggregated and non-aggregated files in
  4109. // order by weight.
  4110. $index = 1;
  4111. $processed = array();
  4112. $files = array();
  4113. $preprocess_js = (variable_get('preprocess_js', FALSE) && (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update'));
  4114. // A dummy query-string is added to filenames, to gain control over
  4115. // browser-caching. The string changes on every update or full cache
  4116. // flush, forcing browsers to load a new copy of the files, as the
  4117. // URL changed. Files that should not be cached (see drupal_add_js())
  4118. // get REQUEST_TIME as query-string instead, to enforce reload on every
  4119. // page request.
  4120. $default_query_string = variable_get('css_js_query_string', '0');
  4121. // For inline JavaScript to validate as XHTML, all JavaScript containing
  4122. // XHTML needs to be wrapped in CDATA. To make that backwards compatible
  4123. // with HTML 4, we need to comment out the CDATA-tag.
  4124. $embed_prefix = "\n<!--//--><![CDATA[//><!--\n";
  4125. $embed_suffix = "\n//--><!]]>\n";
  4126. // Since JavaScript may look for arguments in the URL and act on them, some
  4127. // third-party code might require the use of a different query string.
  4128. $js_version_string = variable_get('drupal_js_version_query_string', 'v=');
  4129. // Sort the JavaScript so that it appears in the correct order.
  4130. uasort($items, 'drupal_sort_css_js');
  4131. // Provide the page with information about the individual JavaScript files
  4132. // used, information not otherwise available when aggregation is enabled.
  4133. $setting['ajaxPageState']['js'] = array_fill_keys(array_keys($items), 1);
  4134. unset($setting['ajaxPageState']['js']['settings']);
  4135. drupal_add_js($setting, 'setting');
  4136. // If we're outputting the header scope, then this might be the final time
  4137. // that drupal_get_js() is running, so add the setting to this output as well
  4138. // as to the drupal_add_js() cache. If $items['settings'] doesn't exist, it's
  4139. // because drupal_get_js() was intentionally passed a $javascript argument
  4140. // stripped off settings, potentially in order to override how settings get
  4141. // output, so in this case, do not add the setting to this output.
  4142. if ($scope == 'header' && isset($items['settings'])) {
  4143. $items['settings']['data'][] = $setting;
  4144. }
  4145. // Loop through the JavaScript to construct the rendered output.
  4146. $element = array(
  4147. '#tag' => 'script',
  4148. '#value' => '',
  4149. '#attributes' => array(
  4150. 'type' => 'text/javascript',
  4151. ),
  4152. );
  4153. foreach ($items as $item) {
  4154. $query_string = empty($item['version']) ? $default_query_string : $js_version_string . $item['version'];
  4155. switch ($item['type']) {
  4156. case 'setting':
  4157. $js_element = $element;
  4158. $js_element['#value_prefix'] = $embed_prefix;
  4159. $js_element['#value'] = 'jQuery.extend(Drupal.settings, ' . drupal_json_encode(drupal_array_merge_deep_array($item['data'])) . ");";
  4160. $js_element['#value_suffix'] = $embed_suffix;
  4161. $output .= theme('html_tag', array('element' => $js_element));
  4162. break;
  4163. case 'inline':
  4164. $js_element = $element;
  4165. if ($item['defer']) {
  4166. $js_element['#attributes']['defer'] = 'defer';
  4167. }
  4168. $js_element['#value_prefix'] = $embed_prefix;
  4169. $js_element['#value'] = $item['data'];
  4170. $js_element['#value_suffix'] = $embed_suffix;
  4171. $processed[$index++] = theme('html_tag', array('element' => $js_element));
  4172. break;
  4173. case 'file':
  4174. $js_element = $element;
  4175. if (!$item['preprocess'] || !$preprocess_js) {
  4176. if ($item['defer']) {
  4177. $js_element['#attributes']['defer'] = 'defer';
  4178. }
  4179. $query_string_separator = (strpos($item['data'], '?') !== FALSE) ? '&' : '?';
  4180. $js_element['#attributes']['src'] = file_create_url($item['data']) . $query_string_separator . ($item['cache'] ? $query_string : REQUEST_TIME);
  4181. $processed[$index++] = theme('html_tag', array('element' => $js_element));
  4182. }
  4183. else {
  4184. // By increasing the index for each aggregated file, we maintain
  4185. // the relative ordering of JS by weight. We also set the key such
  4186. // that groups are split by items sharing the same 'group' value and
  4187. // 'every_page' flag. While this potentially results in more aggregate
  4188. // files, it helps make each one more reusable across a site visit,
  4189. // leading to better front-end performance of a website as a whole.
  4190. // See drupal_add_js() for details.
  4191. $key = 'aggregate_' . $item['group'] . '_' . $item['every_page'] . '_' . $index;
  4192. $processed[$key] = '';
  4193. $files[$key][$item['data']] = $item;
  4194. }
  4195. break;
  4196. case 'external':
  4197. $js_element = $element;
  4198. // Preprocessing for external JavaScript files is ignored.
  4199. if ($item['defer']) {
  4200. $js_element['#attributes']['defer'] = 'defer';
  4201. }
  4202. $js_element['#attributes']['src'] = $item['data'];
  4203. $processed[$index++] = theme('html_tag', array('element' => $js_element));
  4204. break;
  4205. }
  4206. }
  4207. // Aggregate any remaining JS files that haven't already been output.
  4208. if ($preprocess_js && count($files) > 0) {
  4209. foreach ($files as $key => $file_set) {
  4210. $uri = drupal_build_js_cache($file_set);
  4211. // Only include the file if was written successfully. Errors are logged
  4212. // using watchdog.
  4213. if ($uri) {
  4214. $preprocess_file = file_create_url($uri);
  4215. $js_element = $element;
  4216. $js_element['#attributes']['src'] = $preprocess_file;
  4217. $processed[$key] = theme('html_tag', array('element' => $js_element));
  4218. }
  4219. }
  4220. }
  4221. // Keep the order of JS files consistent as some are preprocessed and others are not.
  4222. // Make sure any inline or JS setting variables appear last after libraries have loaded.
  4223. return implode('', $processed) . $output;
  4224. }
  4225. /**
  4226. * Adds attachments to a render() structure.
  4227. *
  4228. * Libraries, JavaScript, CSS and other types of custom structures are attached
  4229. * to elements using the #attached property. The #attached property is an
  4230. * associative array, where the keys are the attachment types and the values are
  4231. * the attached data. For example:
  4232. * @code
  4233. * $build['#attached'] = array(
  4234. * 'js' => array(drupal_get_path('module', 'taxonomy') . '/taxonomy.js'),
  4235. * 'css' => array(drupal_get_path('module', 'taxonomy') . '/taxonomy.css'),
  4236. * );
  4237. * @endcode
  4238. *
  4239. * 'js', 'css', and 'library' are types that get special handling. For any
  4240. * other kind of attached data, the array key must be the full name of the
  4241. * callback function and each value an array of arguments. For example:
  4242. * @code
  4243. * $build['#attached']['drupal_add_http_header'] = array(
  4244. * array('Content-Type', 'application/rss+xml; charset=utf-8'),
  4245. * );
  4246. * @endcode
  4247. *
  4248. * External 'js' and 'css' files can also be loaded. For example:
  4249. * @code
  4250. * $build['#attached']['js'] = array(
  4251. * 'http://code.jquery.com/jquery-1.4.2.min.js' => array(
  4252. * 'type' => 'external',
  4253. * ),
  4254. * );
  4255. * @endcode
  4256. *
  4257. * @param $elements
  4258. * The structured array describing the data being rendered.
  4259. * @param $group
  4260. * The default group of JavaScript and CSS being added. This is only applied
  4261. * to the stylesheets and JavaScript items that don't have an explicit group
  4262. * assigned to them.
  4263. * @param $dependency_check
  4264. * When TRUE, will exit if a given library's dependencies are missing. When
  4265. * set to FALSE, will continue to add the libraries, even though one or more
  4266. * dependencies are missing. Defaults to FALSE.
  4267. * @param $every_page
  4268. * Set to TRUE to indicate that the attachments are added to every page on the
  4269. * site. Only attachments with the every_page flag set to TRUE can participate
  4270. * in JavaScript/CSS aggregation.
  4271. *
  4272. * @return
  4273. * FALSE if there were any missing library dependencies; TRUE if all library
  4274. * dependencies were met.
  4275. *
  4276. * @see drupal_add_library()
  4277. * @see drupal_add_js()
  4278. * @see drupal_add_css()
  4279. * @see drupal_render()
  4280. */
  4281. function drupal_process_attached($elements, $group = JS_DEFAULT, $dependency_check = FALSE, $every_page = NULL) {
  4282. // Add defaults to the special attached structures that should be processed differently.
  4283. $elements['#attached'] += array(
  4284. 'library' => array(),
  4285. 'js' => array(),
  4286. 'css' => array(),
  4287. );
  4288. // Add the libraries first.
  4289. $success = TRUE;
  4290. foreach ($elements['#attached']['library'] as $library) {
  4291. if (drupal_add_library($library[0], $library[1], $every_page) === FALSE) {
  4292. $success = FALSE;
  4293. // Exit if the dependency is missing.
  4294. if ($dependency_check) {
  4295. return $success;
  4296. }
  4297. }
  4298. }
  4299. unset($elements['#attached']['library']);
  4300. // Add both the JavaScript and the CSS.
  4301. // The parameters for drupal_add_js() and drupal_add_css() require special
  4302. // handling.
  4303. foreach (array('js', 'css') as $type) {
  4304. foreach ($elements['#attached'][$type] as $data => $options) {
  4305. // If the value is not an array, it's a filename and passed as first
  4306. // (and only) argument.
  4307. if (!is_array($options)) {
  4308. $data = $options;
  4309. $options = NULL;
  4310. }
  4311. // In some cases, the first parameter ($data) is an array. Arrays can't be
  4312. // passed as keys in PHP, so we have to get $data from the value array.
  4313. if (is_numeric($data)) {
  4314. $data = $options['data'];
  4315. unset($options['data']);
  4316. }
  4317. // Apply the default group if it isn't explicitly given.
  4318. if (!isset($options['group'])) {
  4319. $options['group'] = $group;
  4320. }
  4321. // Set the every_page flag if one was passed.
  4322. if (isset($every_page)) {
  4323. $options['every_page'] = $every_page;
  4324. }
  4325. call_user_func('drupal_add_' . $type, $data, $options);
  4326. }
  4327. unset($elements['#attached'][$type]);
  4328. }
  4329. // Add additional types of attachments specified in the render() structure.
  4330. // Libraries, JavaScript and CSS have been added already, as they require
  4331. // special handling.
  4332. foreach ($elements['#attached'] as $callback => $options) {
  4333. if (function_exists($callback)) {
  4334. foreach ($elements['#attached'][$callback] as $args) {
  4335. call_user_func_array($callback, $args);
  4336. }
  4337. }
  4338. }
  4339. return $success;
  4340. }
  4341. /**
  4342. * Adds JavaScript to change the state of an element based on another element.
  4343. *
  4344. * A "state" means a certain property on a DOM element, such as "visible" or
  4345. * "checked". A state can be applied to an element, depending on the state of
  4346. * another element on the page. In general, states depend on HTML attributes and
  4347. * DOM element properties, which change due to user interaction.
  4348. *
  4349. * Since states are driven by JavaScript only, it is important to understand
  4350. * that all states are applied on presentation only, none of the states force
  4351. * any server-side logic, and that they will not be applied for site visitors
  4352. * without JavaScript support. All modules implementing states have to make
  4353. * sure that the intended logic also works without JavaScript being enabled.
  4354. *
  4355. * #states is an associative array in the form of:
  4356. * @code
  4357. * array(
  4358. * STATE1 => CONDITIONS_ARRAY1,
  4359. * STATE2 => CONDITIONS_ARRAY2,
  4360. * ...
  4361. * )
  4362. * @endcode
  4363. * Each key is the name of a state to apply to the element, such as 'visible'.
  4364. * Each value is a list of conditions that denote when the state should be
  4365. * applied.
  4366. *
  4367. * Multiple different states may be specified to act on complex conditions:
  4368. * @code
  4369. * array(
  4370. * 'visible' => CONDITIONS,
  4371. * 'checked' => OTHER_CONDITIONS,
  4372. * )
  4373. * @endcode
  4374. *
  4375. * Every condition is a key/value pair, whose key is a jQuery selector that
  4376. * denotes another element on the page, and whose value is an array of
  4377. * conditions, which must bet met on that element:
  4378. * @code
  4379. * array(
  4380. * 'visible' => array(
  4381. * JQUERY_SELECTOR => REMOTE_CONDITIONS,
  4382. * JQUERY_SELECTOR => REMOTE_CONDITIONS,
  4383. * ...
  4384. * ),
  4385. * )
  4386. * @endcode
  4387. * All conditions must be met for the state to be applied.
  4388. *
  4389. * Each remote condition is a key/value pair specifying conditions on the other
  4390. * element that need to be met to apply the state to the element:
  4391. * @code
  4392. * array(
  4393. * 'visible' => array(
  4394. * ':input[name="remote_checkbox"]' => array('checked' => TRUE),
  4395. * ),
  4396. * )
  4397. * @endcode
  4398. *
  4399. * For example, to show a textfield only when a checkbox is checked:
  4400. * @code
  4401. * $form['toggle_me'] = array(
  4402. * '#type' => 'checkbox',
  4403. * '#title' => t('Tick this box to type'),
  4404. * );
  4405. * $form['settings'] = array(
  4406. * '#type' => 'textfield',
  4407. * '#states' => array(
  4408. * // Only show this field when the 'toggle_me' checkbox is enabled.
  4409. * 'visible' => array(
  4410. * ':input[name="toggle_me"]' => array('checked' => TRUE),
  4411. * ),
  4412. * ),
  4413. * );
  4414. * @endcode
  4415. *
  4416. * The following states may be applied to an element:
  4417. * - enabled
  4418. * - disabled
  4419. * - required
  4420. * - optional
  4421. * - visible
  4422. * - invisible
  4423. * - checked
  4424. * - unchecked
  4425. * - expanded
  4426. * - collapsed
  4427. *
  4428. * The following states may be used in remote conditions:
  4429. * - empty
  4430. * - filled
  4431. * - checked
  4432. * - unchecked
  4433. * - expanded
  4434. * - collapsed
  4435. * - value
  4436. *
  4437. * The following states exist for both elements and remote conditions, but are
  4438. * not fully implemented and may not change anything on the element:
  4439. * - relevant
  4440. * - irrelevant
  4441. * - valid
  4442. * - invalid
  4443. * - touched
  4444. * - untouched
  4445. * - readwrite
  4446. * - readonly
  4447. *
  4448. * When referencing select lists and radio buttons in remote conditions, a
  4449. * 'value' condition must be used:
  4450. * @code
  4451. * '#states' => array(
  4452. * // Show the settings if 'bar' has been selected for 'foo'.
  4453. * 'visible' => array(
  4454. * ':input[name="foo"]' => array('value' => 'bar'),
  4455. * ),
  4456. * ),
  4457. * @endcode
  4458. *
  4459. * @param $elements
  4460. * A renderable array element having a #states property as described above.
  4461. *
  4462. * @see form_example_states_form()
  4463. */
  4464. function drupal_process_states(&$elements) {
  4465. $elements['#attached']['library'][] = array('system', 'drupal.states');
  4466. $elements['#attached']['js'][] = array(
  4467. 'type' => 'setting',
  4468. 'data' => array('states' => array('#' . $elements['#id'] => $elements['#states'])),
  4469. );
  4470. }
  4471. /**
  4472. * Adds multiple JavaScript or CSS files at the same time.
  4473. *
  4474. * A library defines a set of JavaScript and/or CSS files, optionally using
  4475. * settings, and optionally requiring another library. For example, a library
  4476. * can be a jQuery plugin, a JavaScript framework, or a CSS framework. This
  4477. * function allows modules to load a library defined/shipped by itself or a
  4478. * depending module, without having to add all files of the library separately.
  4479. * Each library is only loaded once.
  4480. *
  4481. * @param $module
  4482. * The name of the module that registered the library.
  4483. * @param $name
  4484. * The name of the library to add.
  4485. * @param $every_page
  4486. * Set to TRUE if this library is added to every page on the site. Only items
  4487. * with the every_page flag set to TRUE can participate in aggregation.
  4488. *
  4489. * @return
  4490. * TRUE if the library was successfully added; FALSE if the library or one of
  4491. * its dependencies could not be added.
  4492. *
  4493. * @see drupal_get_library()
  4494. * @see hook_library()
  4495. * @see hook_library_alter()
  4496. */
  4497. function drupal_add_library($module, $name, $every_page = NULL) {
  4498. $added = &drupal_static(__FUNCTION__, array());
  4499. // Only process the library if it exists and it was not added already.
  4500. if (!isset($added[$module][$name])) {
  4501. if ($library = drupal_get_library($module, $name)) {
  4502. // Add all components within the library.
  4503. $elements['#attached'] = array(
  4504. 'library' => $library['dependencies'],
  4505. 'js' => $library['js'],
  4506. 'css' => $library['css'],
  4507. );
  4508. $added[$module][$name] = drupal_process_attached($elements, JS_LIBRARY, TRUE, $every_page);
  4509. }
  4510. else {
  4511. // Requested library does not exist.
  4512. $added[$module][$name] = FALSE;
  4513. }
  4514. }
  4515. return $added[$module][$name];
  4516. }
  4517. /**
  4518. * Retrieves information for a JavaScript/CSS library.
  4519. *
  4520. * Library information is statically cached. Libraries are keyed by module for
  4521. * several reasons:
  4522. * - Libraries are not unique. Multiple modules might ship with the same library
  4523. * in a different version or variant. This registry cannot (and does not
  4524. * attempt to) prevent library conflicts.
  4525. * - Modules implementing and thereby depending on a library that is registered
  4526. * by another module can only rely on that module's library.
  4527. * - Two (or more) modules can still register the same library and use it
  4528. * without conflicts in case the libraries are loaded on certain pages only.
  4529. *
  4530. * @param $module
  4531. * The name of a module that registered a library.
  4532. * @param $name
  4533. * (optional) The name of a registered library to retrieve. By default, all
  4534. * libraries registered by $module are returned.
  4535. *
  4536. * @return
  4537. * The definition of the requested library, if $name was passed and it exists,
  4538. * or FALSE if it does not exist. If no $name was passed, an associative array
  4539. * of libraries registered by $module is returned (which may be empty).
  4540. *
  4541. * @see drupal_add_library()
  4542. * @see hook_library()
  4543. * @see hook_library_alter()
  4544. *
  4545. * @todo The purpose of drupal_get_*() is completely different to other page
  4546. * requisite API functions; find and use a different name.
  4547. */
  4548. function drupal_get_library($module, $name = NULL) {
  4549. $libraries = &drupal_static(__FUNCTION__, array());
  4550. if (!isset($libraries[$module])) {
  4551. // Retrieve all libraries associated with the module.
  4552. $module_libraries = module_invoke($module, 'library');
  4553. if (empty($module_libraries)) {
  4554. $module_libraries = array();
  4555. }
  4556. // Allow modules to alter the module's registered libraries.
  4557. drupal_alter('library', $module_libraries, $module);
  4558. foreach ($module_libraries as $key => $data) {
  4559. if (is_array($data)) {
  4560. // Add default elements to allow for easier processing.
  4561. $module_libraries[$key] += array('dependencies' => array(), 'js' => array(), 'css' => array());
  4562. foreach ($module_libraries[$key]['js'] as $file => $options) {
  4563. $module_libraries[$key]['js'][$file]['version'] = $module_libraries[$key]['version'];
  4564. }
  4565. }
  4566. }
  4567. $libraries[$module] = $module_libraries;
  4568. }
  4569. if (isset($name)) {
  4570. if (!isset($libraries[$module][$name])) {
  4571. $libraries[$module][$name] = FALSE;
  4572. }
  4573. return $libraries[$module][$name];
  4574. }
  4575. return $libraries[$module];
  4576. }
  4577. /**
  4578. * Assists in adding the tableDrag JavaScript behavior to a themed table.
  4579. *
  4580. * Draggable tables should be used wherever an outline or list of sortable items
  4581. * needs to be arranged by an end-user. Draggable tables are very flexible and
  4582. * can manipulate the value of form elements placed within individual columns.
  4583. *
  4584. * To set up a table to use drag and drop in place of weight select-lists or in
  4585. * place of a form that contains parent relationships, the form must be themed
  4586. * into a table. The table must have an ID attribute set. If using
  4587. * theme_table(), the ID may be set as follows:
  4588. * @code
  4589. * $output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'my-module-table')));
  4590. * return $output;
  4591. * @endcode
  4592. *
  4593. * In the theme function for the form, a special class must be added to each
  4594. * form element within the same column, "grouping" them together.
  4595. *
  4596. * In a situation where a single weight column is being sorted in the table, the
  4597. * classes could be added like this (in the theme function):
  4598. * @code
  4599. * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
  4600. * @endcode
  4601. *
  4602. * Each row of the table must also have a class of "draggable" in order to
  4603. * enable the drag handles:
  4604. * @code
  4605. * $row = array(...);
  4606. * $rows[] = array(
  4607. * 'data' => $row,
  4608. * 'class' => array('draggable'),
  4609. * );
  4610. * @endcode
  4611. *
  4612. * When tree relationships are present, the two additional classes
  4613. * 'tabledrag-leaf' and 'tabledrag-root' can be used to refine the behavior:
  4614. * - Rows with the 'tabledrag-leaf' class cannot have child rows.
  4615. * - Rows with the 'tabledrag-root' class cannot be nested under a parent row.
  4616. *
  4617. * Calling drupal_add_tabledrag() would then be written as such:
  4618. * @code
  4619. * drupal_add_tabledrag('my-module-table', 'order', 'sibling', 'my-elements-weight');
  4620. * @endcode
  4621. *
  4622. * In a more complex case where there are several groups in one column (such as
  4623. * the block regions on the admin/structure/block page), a separate subgroup
  4624. * class must also be added to differentiate the groups.
  4625. * @code
  4626. * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
  4627. * @endcode
  4628. *
  4629. * $group is still 'my-element-weight', and the additional $subgroup variable
  4630. * will be passed in as 'my-elements-weight-' . $region. This also means that
  4631. * you'll need to call drupal_add_tabledrag() once for every region added.
  4632. *
  4633. * @code
  4634. * foreach ($regions as $region) {
  4635. * drupal_add_tabledrag('my-module-table', 'order', 'sibling', 'my-elements-weight', 'my-elements-weight-' . $region);
  4636. * }
  4637. * @endcode
  4638. *
  4639. * In a situation where tree relationships are present, adding multiple
  4640. * subgroups is not necessary, because the table will contain indentations that
  4641. * provide enough information about the sibling and parent relationships. See
  4642. * theme_menu_overview_form() for an example creating a table containing parent
  4643. * relationships.
  4644. *
  4645. * Note that this function should be called from the theme layer, such as in a
  4646. * .tpl.php file, theme_ function, or in a template_preprocess function, not in
  4647. * a form declaration. Though the same JavaScript could be added to the page
  4648. * using drupal_add_js() directly, this function helps keep template files
  4649. * clean and readable. It also prevents tabledrag.js from being added twice
  4650. * accidentally.
  4651. *
  4652. * @param $table_id
  4653. * String containing the target table's id attribute. If the table does not
  4654. * have an id, one will need to be set, such as <table id="my-module-table">.
  4655. * @param $action
  4656. * String describing the action to be done on the form item. Either 'match'
  4657. * 'depth', or 'order'. Match is typically used for parent relationships.
  4658. * Order is typically used to set weights on other form elements with the same
  4659. * group. Depth updates the target element with the current indentation.
  4660. * @param $relationship
  4661. * String describing where the $action variable should be performed. Either
  4662. * 'parent', 'sibling', 'group', or 'self'. Parent will only look for fields
  4663. * up the tree. Sibling will look for fields in the same group in rows above
  4664. * and below it. Self affects the dragged row itself. Group affects the
  4665. * dragged row, plus any children below it (the entire dragged group).
  4666. * @param $group
  4667. * A class name applied on all related form elements for this action.
  4668. * @param $subgroup
  4669. * (optional) If the group has several subgroups within it, this string should
  4670. * contain the class name identifying fields in the same subgroup.
  4671. * @param $source
  4672. * (optional) If the $action is 'match', this string should contain the class
  4673. * name identifying what field will be used as the source value when matching
  4674. * the value in $subgroup.
  4675. * @param $hidden
  4676. * (optional) The column containing the field elements may be entirely hidden
  4677. * from view dynamically when the JavaScript is loaded. Set to FALSE if the
  4678. * column should not be hidden.
  4679. * @param $limit
  4680. * (optional) Limit the maximum amount of parenting in this table.
  4681. * @see block-admin-display-form.tpl.php
  4682. * @see theme_menu_overview_form()
  4683. */
  4684. function drupal_add_tabledrag($table_id, $action, $relationship, $group, $subgroup = NULL, $source = NULL, $hidden = TRUE, $limit = 0) {
  4685. $js_added = &drupal_static(__FUNCTION__, FALSE);
  4686. if (!$js_added) {
  4687. // Add the table drag JavaScript to the page before the module JavaScript
  4688. // to ensure that table drag behaviors are registered before any module
  4689. // uses it.
  4690. drupal_add_library('system', 'jquery.cookie');
  4691. drupal_add_js('misc/tabledrag.js', array('weight' => -1));
  4692. $js_added = TRUE;
  4693. }
  4694. // If a subgroup or source isn't set, assume it is the same as the group.
  4695. $target = isset($subgroup) ? $subgroup : $group;
  4696. $source = isset($source) ? $source : $target;
  4697. $settings['tableDrag'][$table_id][$group][] = array(
  4698. 'target' => $target,
  4699. 'source' => $source,
  4700. 'relationship' => $relationship,
  4701. 'action' => $action,
  4702. 'hidden' => $hidden,
  4703. 'limit' => $limit,
  4704. );
  4705. drupal_add_js($settings, 'setting');
  4706. }
  4707. /**
  4708. * Aggregates JavaScript files into a cache file in the files directory.
  4709. *
  4710. * The file name for the JavaScript cache file is generated from the hash of
  4711. * the aggregated contents of the files in $files. This forces proxies and
  4712. * browsers to download new JavaScript when the JavaScript changes.
  4713. *
  4714. * The cache file name is retrieved on a page load via a lookup variable that
  4715. * contains an associative array. The array key is the hash of the names in
  4716. * $files while the value is the cache file name. The cache file is generated
  4717. * in two cases. First, if there is no file name value for the key, which will
  4718. * happen if a new file name has been added to $files or after the lookup
  4719. * variable is emptied to force a rebuild of the cache. Second, the cache file
  4720. * is generated if it is missing on disk. Old cache files are not deleted
  4721. * immediately when the lookup variable is emptied, but are deleted after a set
  4722. * period by drupal_delete_file_if_stale(). This ensures that files referenced
  4723. * by a cached page will still be available.
  4724. *
  4725. * @param $files
  4726. * An array of JavaScript files to aggregate and compress into one file.
  4727. *
  4728. * @return
  4729. * The URI of the cache file, or FALSE if the file could not be saved.
  4730. */
  4731. function drupal_build_js_cache($files) {
  4732. $contents = '';
  4733. $uri = '';
  4734. $map = variable_get('drupal_js_cache_files', array());
  4735. // Create a new array so that only the file names are used to create the hash.
  4736. // This prevents new aggregates from being created unnecessarily.
  4737. $js_data = array();
  4738. foreach ($files as $file) {
  4739. $js_data[] = $file['data'];
  4740. }
  4741. $key = hash('sha256', serialize($js_data));
  4742. if (isset($map[$key])) {
  4743. $uri = $map[$key];
  4744. }
  4745. if (empty($uri) || !file_exists($uri)) {
  4746. // Build aggregate JS file.
  4747. foreach ($files as $path => $info) {
  4748. if ($info['preprocess']) {
  4749. // Append a ';' and a newline after each JS file to prevent them from running together.
  4750. $contents .= file_get_contents($path) . ";\n";
  4751. }
  4752. }
  4753. // Prefix filename to prevent blocking by firewalls which reject files
  4754. // starting with "ad*".
  4755. $filename = 'js_' . drupal_hash_base64($contents) . '.js';
  4756. // Create the js/ within the files folder.
  4757. $jspath = 'public://js';
  4758. $uri = $jspath . '/' . $filename;
  4759. // Create the JS file.
  4760. file_prepare_directory($jspath, FILE_CREATE_DIRECTORY);
  4761. if (!file_exists($uri) && !file_unmanaged_save_data($contents, $uri, FILE_EXISTS_REPLACE)) {
  4762. return FALSE;
  4763. }
  4764. // If JS gzip compression is enabled, clean URLs are enabled (which means
  4765. // that rewrite rules are working) and the zlib extension is available then
  4766. // create a gzipped version of this file. This file is served conditionally
  4767. // to browsers that accept gzip using .htaccess rules.
  4768. if (variable_get('js_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
  4769. if (!file_exists($uri . '.gz') && !file_unmanaged_save_data(gzencode($contents, 9, FORCE_GZIP), $uri . '.gz', FILE_EXISTS_REPLACE)) {
  4770. return FALSE;
  4771. }
  4772. }
  4773. $map[$key] = $uri;
  4774. variable_set('drupal_js_cache_files', $map);
  4775. }
  4776. return $uri;
  4777. }
  4778. /**
  4779. * Deletes old cached JavaScript files and variables.
  4780. */
  4781. function drupal_clear_js_cache() {
  4782. variable_del('javascript_parsed');
  4783. variable_del('drupal_js_cache_files');
  4784. file_scan_directory('public://js', '/.*/', array('callback' => 'drupal_delete_file_if_stale'));
  4785. }
  4786. /**
  4787. * Converts a PHP variable into its JavaScript equivalent.
  4788. *
  4789. * We use HTML-safe strings, with several characters escaped.
  4790. *
  4791. * @see drupal_json_decode()
  4792. * @see drupal_json_encode_helper()
  4793. * @ingroup php_wrappers
  4794. */
  4795. function drupal_json_encode($var) {
  4796. // The PHP version cannot change within a request.
  4797. static $php530;
  4798. if (!isset($php530)) {
  4799. $php530 = version_compare(PHP_VERSION, '5.3.0', '>=');
  4800. }
  4801. if ($php530) {
  4802. // Encode <, >, ', &, and " using the json_encode() options parameter.
  4803. return json_encode($var, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT);
  4804. }
  4805. // json_encode() escapes <, >, ', &, and " using its options parameter, but
  4806. // does not support this parameter prior to PHP 5.3.0. Use a helper instead.
  4807. include_once DRUPAL_ROOT . '/includes/json-encode.inc';
  4808. return drupal_json_encode_helper($var);
  4809. }
  4810. /**
  4811. * Converts an HTML-safe JSON string into its PHP equivalent.
  4812. *
  4813. * @see drupal_json_encode()
  4814. * @ingroup php_wrappers
  4815. */
  4816. function drupal_json_decode($var) {
  4817. return json_decode($var, TRUE);
  4818. }
  4819. /**
  4820. * Returns data in JSON format.
  4821. *
  4822. * This function should be used for JavaScript callback functions returning
  4823. * data in JSON format. It sets the header for JavaScript output.
  4824. *
  4825. * @param $var
  4826. * (optional) If set, the variable will be converted to JSON and output.
  4827. */
  4828. function drupal_json_output($var = NULL) {
  4829. // We are returning JSON, so tell the browser.
  4830. drupal_add_http_header('Content-Type', 'application/json');
  4831. if (isset($var)) {
  4832. echo drupal_json_encode($var);
  4833. }
  4834. }
  4835. /**
  4836. * Ensures the private key variable used to generate tokens is set.
  4837. *
  4838. * @return
  4839. * The private key.
  4840. */
  4841. function drupal_get_private_key() {
  4842. if (!($key = variable_get('drupal_private_key', 0))) {
  4843. $key = drupal_random_key();
  4844. variable_set('drupal_private_key', $key);
  4845. }
  4846. return $key;
  4847. }
  4848. /**
  4849. * Generates a token based on $value, the user session, and the private key.
  4850. *
  4851. * @param $value
  4852. * An additional value to base the token on.
  4853. *
  4854. * The generated token is based on the session ID of the current user. Normally,
  4855. * anonymous users do not have a session, so the generated token will be
  4856. * different on every page request. To generate a token for users without a
  4857. * session, manually start a session prior to calling this function.
  4858. *
  4859. * @return string
  4860. * A 43-character URL-safe token for validation, based on the user session ID,
  4861. * the hash salt provided from drupal_get_hash_salt(), and the
  4862. * 'drupal_private_key' configuration variable.
  4863. *
  4864. * @see drupal_get_hash_salt()
  4865. */
  4866. function drupal_get_token($value = '') {
  4867. return drupal_hmac_base64($value, session_id() . drupal_get_private_key() . drupal_get_hash_salt());
  4868. }
  4869. /**
  4870. * Validates a token based on $value, the user session, and the private key.
  4871. *
  4872. * @param $token
  4873. * The token to be validated.
  4874. * @param $value
  4875. * An additional value to base the token on.
  4876. * @param $skip_anonymous
  4877. * Set to true to skip token validation for anonymous users.
  4878. *
  4879. * @return
  4880. * True for a valid token, false for an invalid token. When $skip_anonymous
  4881. * is true, the return value will always be true for anonymous users.
  4882. */
  4883. function drupal_valid_token($token, $value = '', $skip_anonymous = FALSE) {
  4884. global $user;
  4885. return (($skip_anonymous && $user->uid == 0) || ($token === drupal_get_token($value)));
  4886. }
  4887. function _drupal_bootstrap_full() {
  4888. static $called = FALSE;
  4889. if ($called) {
  4890. return;
  4891. }
  4892. $called = TRUE;
  4893. require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'includes/path.inc');
  4894. require_once DRUPAL_ROOT . '/includes/theme.inc';
  4895. require_once DRUPAL_ROOT . '/includes/pager.inc';
  4896. require_once DRUPAL_ROOT . '/' . variable_get('menu_inc', 'includes/menu.inc');
  4897. require_once DRUPAL_ROOT . '/includes/tablesort.inc';
  4898. require_once DRUPAL_ROOT . '/includes/file.inc';
  4899. require_once DRUPAL_ROOT . '/includes/unicode.inc';
  4900. require_once DRUPAL_ROOT . '/includes/image.inc';
  4901. require_once DRUPAL_ROOT . '/includes/form.inc';
  4902. require_once DRUPAL_ROOT . '/includes/mail.inc';
  4903. require_once DRUPAL_ROOT . '/includes/actions.inc';
  4904. require_once DRUPAL_ROOT . '/includes/ajax.inc';
  4905. require_once DRUPAL_ROOT . '/includes/token.inc';
  4906. require_once DRUPAL_ROOT . '/includes/errors.inc';
  4907. // Detect string handling method
  4908. unicode_check();
  4909. // Undo magic quotes
  4910. fix_gpc_magic();
  4911. // Load all enabled modules
  4912. module_load_all();
  4913. // Reset drupal_alter() and module_implements() static caches as these
  4914. // include implementations for vital modules only when called early on
  4915. // in the bootstrap.
  4916. drupal_static_reset('drupal_alter');
  4917. drupal_static_reset('module_implements');
  4918. // Make sure all stream wrappers are registered.
  4919. file_get_stream_wrappers();
  4920. // Ensure mt_rand is reseeded, to prevent random values from one page load
  4921. // being exploited to predict random values in subsequent page loads.
  4922. $seed = unpack("L", drupal_random_bytes(4));
  4923. mt_srand($seed[1]);
  4924. $test_info = &$GLOBALS['drupal_test_info'];
  4925. if (!empty($test_info['in_child_site'])) {
  4926. // Running inside the simpletest child site, log fatal errors to test
  4927. // specific file directory.
  4928. ini_set('log_errors', 1);
  4929. ini_set('error_log', 'public://error.log');
  4930. }
  4931. // Initialize $_GET['q'] prior to invoking hook_init().
  4932. drupal_path_initialize();
  4933. // Let all modules take action before the menu system handles the request.
  4934. // We do not want this while running update.php.
  4935. if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
  4936. // Prior to invoking hook_init(), initialize the theme (potentially a custom
  4937. // one for this page), so that:
  4938. // - Modules with hook_init() implementations that call theme() or
  4939. // theme_get_registry() don't initialize the incorrect theme.
  4940. // - The theme can have hook_*_alter() implementations affect page building
  4941. // (e.g., hook_form_alter(), hook_node_view_alter(), hook_page_alter()),
  4942. // ahead of when rendering starts.
  4943. menu_set_custom_theme();
  4944. drupal_theme_initialize();
  4945. module_invoke_all('init');
  4946. }
  4947. }
  4948. /**
  4949. * Stores the current page in the cache.
  4950. *
  4951. * If page_compression is enabled, a gzipped version of the page is stored in
  4952. * the cache to avoid compressing the output on each request. The cache entry
  4953. * is unzipped in the relatively rare event that the page is requested by a
  4954. * client without gzip support.
  4955. *
  4956. * Page compression requires the PHP zlib extension
  4957. * (http://php.net/manual/ref.zlib.php).
  4958. *
  4959. * @see drupal_page_header()
  4960. */
  4961. function drupal_page_set_cache() {
  4962. global $base_root;
  4963. if (drupal_page_is_cacheable()) {
  4964. // Check whether the current page might be compressed.
  4965. $page_compressed = variable_get('page_compression', TRUE) && extension_loaded('zlib');
  4966. $cache = (object) array(
  4967. 'cid' => $base_root . request_uri(),
  4968. 'data' => array(
  4969. 'path' => $_GET['q'],
  4970. 'body' => ob_get_clean(),
  4971. 'title' => drupal_get_title(),
  4972. 'headers' => array(),
  4973. // We need to store whether page was compressed or not,
  4974. // because by the time it is read, the configuration might change.
  4975. 'page_compressed' => $page_compressed,
  4976. ),
  4977. 'expire' => CACHE_TEMPORARY,
  4978. 'created' => REQUEST_TIME,
  4979. );
  4980. // Restore preferred header names based on the lower-case names returned
  4981. // by drupal_get_http_header().
  4982. $header_names = _drupal_set_preferred_header_name();
  4983. foreach (drupal_get_http_header() as $name_lower => $value) {
  4984. $cache->data['headers'][$header_names[$name_lower]] = $value;
  4985. if ($name_lower == 'expires') {
  4986. // Use the actual timestamp from an Expires header if available.
  4987. $cache->expire = strtotime($value);
  4988. }
  4989. }
  4990. if ($cache->data['body']) {
  4991. if ($page_compressed) {
  4992. $cache->data['body'] = gzencode($cache->data['body'], 9, FORCE_GZIP);
  4993. }
  4994. cache_set($cache->cid, $cache->data, 'cache_page', $cache->expire);
  4995. }
  4996. return $cache;
  4997. }
  4998. }
  4999. /**
  5000. * Executes a cron run when called.
  5001. *
  5002. * Do not call this function from a test. Use $this->cronRun() instead.
  5003. *
  5004. * @return bool
  5005. * TRUE if cron ran successfully and FALSE if cron is already running.
  5006. */
  5007. function drupal_cron_run() {
  5008. // Allow execution to continue even if the request gets canceled.
  5009. @ignore_user_abort(TRUE);
  5010. // Prevent session information from being saved while cron is running.
  5011. $original_session_saving = drupal_save_session();
  5012. drupal_save_session(FALSE);
  5013. // Force the current user to anonymous to ensure consistent permissions on
  5014. // cron runs.
  5015. $original_user = $GLOBALS['user'];
  5016. $GLOBALS['user'] = drupal_anonymous_user();
  5017. // Try to allocate enough time to run all the hook_cron implementations.
  5018. drupal_set_time_limit(240);
  5019. $return = FALSE;
  5020. // Grab the defined cron queues.
  5021. $queues = module_invoke_all('cron_queue_info');
  5022. drupal_alter('cron_queue_info', $queues);
  5023. // Try to acquire cron lock.
  5024. if (!lock_acquire('cron', 240.0)) {
  5025. // Cron is still running normally.
  5026. watchdog('cron', 'Attempting to re-run cron while it is already running.', array(), WATCHDOG_WARNING);
  5027. }
  5028. else {
  5029. // Make sure every queue exists. There is no harm in trying to recreate an
  5030. // existing queue.
  5031. foreach ($queues as $queue_name => $info) {
  5032. DrupalQueue::get($queue_name)->createQueue();
  5033. }
  5034. // Iterate through the modules calling their cron handlers (if any):
  5035. foreach (module_implements('cron') as $module) {
  5036. // Do not let an exception thrown by one module disturb another.
  5037. try {
  5038. module_invoke($module, 'cron');
  5039. }
  5040. catch (Exception $e) {
  5041. watchdog_exception('cron', $e);
  5042. }
  5043. }
  5044. // Record cron time.
  5045. variable_set('cron_last', REQUEST_TIME);
  5046. watchdog('cron', 'Cron run completed.', array(), WATCHDOG_NOTICE);
  5047. // Release cron lock.
  5048. lock_release('cron');
  5049. // Return TRUE so other functions can check if it did run successfully
  5050. $return = TRUE;
  5051. }
  5052. foreach ($queues as $queue_name => $info) {
  5053. if (!empty($info['skip on cron'])) {
  5054. // Do not run if queue wants to skip.
  5055. continue;
  5056. }
  5057. $callback = $info['worker callback'];
  5058. $end = time() + (isset($info['time']) ? $info['time'] : 15);
  5059. $queue = DrupalQueue::get($queue_name);
  5060. while (time() < $end && ($item = $queue->claimItem())) {
  5061. try {
  5062. call_user_func($callback, $item->data);
  5063. $queue->deleteItem($item);
  5064. }
  5065. catch (Exception $e) {
  5066. // In case of exception log it and leave the item in the queue
  5067. // to be processed again later.
  5068. watchdog_exception('cron', $e);
  5069. }
  5070. }
  5071. }
  5072. // Restore the user.
  5073. $GLOBALS['user'] = $original_user;
  5074. drupal_save_session($original_session_saving);
  5075. return $return;
  5076. }
  5077. /**
  5078. * DEPRECATED: Shutdown function: Performs cron cleanup.
  5079. *
  5080. * This function is deprecated because the 'cron_semaphore' variable it
  5081. * references no longer exists. It is therefore no longer used as a shutdown
  5082. * function by Drupal core.
  5083. *
  5084. * @deprecated
  5085. */
  5086. function drupal_cron_cleanup() {
  5087. // See if the semaphore is still locked.
  5088. if (variable_get('cron_semaphore', FALSE)) {
  5089. watchdog('cron', 'Cron run exceeded the time limit and was aborted.', array(), WATCHDOG_WARNING);
  5090. // Release cron semaphore.
  5091. variable_del('cron_semaphore');
  5092. }
  5093. }
  5094. /**
  5095. * Returns information about system object files (modules, themes, etc.).
  5096. *
  5097. * This function is used to find all or some system object files (module files,
  5098. * theme files, etc.) that exist on the site. It searches in several locations,
  5099. * depending on what type of object you are looking for. For instance, if you
  5100. * are looking for modules and call:
  5101. * @code
  5102. * drupal_system_listing("/\.module$/", "modules", 'name', 0);
  5103. * @endcode
  5104. * this function will search the site-wide modules directory (i.e., /modules/),
  5105. * your installation profile's directory (i.e.,
  5106. * /profiles/your_site_profile/modules/), the all-sites directory (i.e.,
  5107. * /sites/all/modules/), and your site-specific directory (i.e.,
  5108. * /sites/your_site_dir/modules/), in that order, and return information about
  5109. * all of the files ending in .module in those directories.
  5110. *
  5111. * The information is returned in an associative array, which can be keyed on
  5112. * the file name ($key = 'filename'), the file name without the extension ($key
  5113. * = 'name'), or the full file stream URI ($key = 'uri'). If you use a key of
  5114. * 'filename' or 'name', files found later in the search will take precedence
  5115. * over files found earlier (unless they belong to a module or theme not
  5116. * compatible with Drupal core); if you choose a key of 'uri', you will get all
  5117. * files found.
  5118. *
  5119. * @param string $mask
  5120. * The preg_match() regular expression for the files to find.
  5121. * @param string $directory
  5122. * The subdirectory name in which the files are found. For example,
  5123. * 'modules' will search in sub-directories of the top-level /modules
  5124. * directory, sub-directories of /sites/all/modules/, etc.
  5125. * @param string $key
  5126. * The key to be used for the associative array returned. Possible values are
  5127. * 'uri', for the file's URI; 'filename', for the basename of the file; and
  5128. * 'name' for the name of the file without the extension. If you choose 'name'
  5129. * or 'filename', only the highest-precedence file will be returned.
  5130. * @param int $min_depth
  5131. * Minimum depth of directories to return files from, relative to each
  5132. * directory searched. For instance, a minimum depth of 2 would find modules
  5133. * inside /modules/node/tests, but not modules directly in /modules/node.
  5134. *
  5135. * @return array
  5136. * An associative array of file objects, keyed on the chosen key. Each element
  5137. * in the array is an object containing file information, with properties:
  5138. * - 'uri': Full URI of the file.
  5139. * - 'filename': File name.
  5140. * - 'name': Name of file without the extension.
  5141. */
  5142. function drupal_system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
  5143. $config = conf_path();
  5144. $searchdir = array($directory);
  5145. $files = array();
  5146. // The 'profiles' directory contains pristine collections of modules and
  5147. // themes as organized by a distribution. It is pristine in the same way
  5148. // that /modules is pristine for core; users should avoid changing anything
  5149. // there in favor of sites/all or sites/<domain> directories.
  5150. $profiles = array();
  5151. $profile = drupal_get_profile();
  5152. // For SimpleTest to be able to test modules packaged together with a
  5153. // distribution we need to include the profile of the parent site (in which
  5154. // test runs are triggered).
  5155. if (drupal_valid_test_ua()) {
  5156. $testing_profile = variable_get('simpletest_parent_profile', FALSE);
  5157. if ($testing_profile && $testing_profile != $profile) {
  5158. $profiles[] = $testing_profile;
  5159. }
  5160. }
  5161. // In case both profile directories contain the same extension, the actual
  5162. // profile always has precedence.
  5163. $profiles[] = $profile;
  5164. foreach ($profiles as $profile) {
  5165. if (file_exists("profiles/$profile/$directory")) {
  5166. $searchdir[] = "profiles/$profile/$directory";
  5167. }
  5168. }
  5169. // Always search sites/all/* as well as the global directories.
  5170. $searchdir[] = 'sites/all/' . $directory;
  5171. if (file_exists("$config/$directory")) {
  5172. $searchdir[] = "$config/$directory";
  5173. }
  5174. // Get current list of items.
  5175. if (!function_exists('file_scan_directory')) {
  5176. require_once DRUPAL_ROOT . '/includes/file.inc';
  5177. }
  5178. foreach ($searchdir as $dir) {
  5179. $files_to_add = file_scan_directory($dir, $mask, array('key' => $key, 'min_depth' => $min_depth));
  5180. // Duplicate files found in later search directories take precedence over
  5181. // earlier ones, so we want them to overwrite keys in our resulting
  5182. // $files array.
  5183. // The exception to this is if the later file is from a module or theme not
  5184. // compatible with Drupal core. This may occur during upgrades of Drupal
  5185. // core when new modules exist in core while older contrib modules with the
  5186. // same name exist in a directory such as sites/all/modules/.
  5187. foreach (array_intersect_key($files_to_add, $files) as $file_key => $file) {
  5188. // If it has no info file, then we just behave liberally and accept the
  5189. // new resource on the list for merging.
  5190. if (file_exists($info_file = dirname($file->uri) . '/' . $file->name . '.info')) {
  5191. // Get the .info file for the module or theme this file belongs to.
  5192. $info = drupal_parse_info_file($info_file);
  5193. // If the module or theme is incompatible with Drupal core, remove it
  5194. // from the array for the current search directory, so it is not
  5195. // overwritten when merged with the $files array.
  5196. if (isset($info['core']) && $info['core'] != DRUPAL_CORE_COMPATIBILITY) {
  5197. unset($files_to_add[$file_key]);
  5198. }
  5199. }
  5200. }
  5201. $files = array_merge($files, $files_to_add);
  5202. }
  5203. return $files;
  5204. }
  5205. /**
  5206. * Sets the main page content value for later use.
  5207. *
  5208. * Given the nature of the Drupal page handling, this will be called once with
  5209. * a string or array. We store that and return it later as the block is being
  5210. * displayed.
  5211. *
  5212. * @param $content
  5213. * A string or renderable array representing the body of the page.
  5214. *
  5215. * @return
  5216. * If called without $content, a renderable array representing the body of
  5217. * the page.
  5218. */
  5219. function drupal_set_page_content($content = NULL) {
  5220. $content_block = &drupal_static(__FUNCTION__, NULL);
  5221. $main_content_display = &drupal_static('system_main_content_added', FALSE);
  5222. if (!empty($content)) {
  5223. $content_block = (is_array($content) ? $content : array('main' => array('#markup' => $content)));
  5224. }
  5225. else {
  5226. // Indicate that the main content has been requested. We assume that
  5227. // the module requesting the content will be adding it to the page.
  5228. // A module can indicate that it does not handle the content by setting
  5229. // the static variable back to FALSE after calling this function.
  5230. $main_content_display = TRUE;
  5231. return $content_block;
  5232. }
  5233. }
  5234. /**
  5235. * #pre_render callback to render #browsers into #prefix and #suffix.
  5236. *
  5237. * @param $elements
  5238. * A render array with a '#browsers' property. The '#browsers' property can
  5239. * contain any or all of the following keys:
  5240. * - 'IE': If FALSE, the element is not rendered by Internet Explorer. If
  5241. * TRUE, the element is rendered by Internet Explorer. Can also be a string
  5242. * containing an expression for Internet Explorer to evaluate as part of a
  5243. * conditional comment. For example, this can be set to 'lt IE 7' for the
  5244. * element to be rendered in Internet Explorer 6, but not in Internet
  5245. * Explorer 7 or higher. Defaults to TRUE.
  5246. * - '!IE': If FALSE, the element is not rendered by browsers other than
  5247. * Internet Explorer. If TRUE, the element is rendered by those browsers.
  5248. * Defaults to TRUE.
  5249. * Examples:
  5250. * - To render an element in all browsers, '#browsers' can be left out or set
  5251. * to array('IE' => TRUE, '!IE' => TRUE).
  5252. * - To render an element in Internet Explorer only, '#browsers' can be set
  5253. * to array('!IE' => FALSE).
  5254. * - To render an element in Internet Explorer 6 only, '#browsers' can be set
  5255. * to array('IE' => 'lt IE 7', '!IE' => FALSE).
  5256. * - To render an element in Internet Explorer 8 and higher and in all other
  5257. * browsers, '#browsers' can be set to array('IE' => 'gte IE 8').
  5258. *
  5259. * @return
  5260. * The passed-in element with markup for conditional comments potentially
  5261. * added to '#prefix' and '#suffix'.
  5262. */
  5263. function drupal_pre_render_conditional_comments($elements) {
  5264. $browsers = isset($elements['#browsers']) ? $elements['#browsers'] : array();
  5265. $browsers += array(
  5266. 'IE' => TRUE,
  5267. '!IE' => TRUE,
  5268. );
  5269. // If rendering in all browsers, no need for conditional comments.
  5270. if ($browsers['IE'] === TRUE && $browsers['!IE']) {
  5271. return $elements;
  5272. }
  5273. // Determine the conditional comment expression for Internet Explorer to
  5274. // evaluate.
  5275. if ($browsers['IE'] === TRUE) {
  5276. $expression = 'IE';
  5277. }
  5278. elseif ($browsers['IE'] === FALSE) {
  5279. $expression = '!IE';
  5280. }
  5281. else {
  5282. $expression = $browsers['IE'];
  5283. }
  5284. // Wrap the element's potentially existing #prefix and #suffix properties with
  5285. // conditional comment markup. The conditional comment expression is evaluated
  5286. // by Internet Explorer only. To control the rendering by other browsers,
  5287. // either the "downlevel-hidden" or "downlevel-revealed" technique must be
  5288. // used. See http://en.wikipedia.org/wiki/Conditional_comment for details.
  5289. $elements += array(
  5290. '#prefix' => '',
  5291. '#suffix' => '',
  5292. );
  5293. if (!$browsers['!IE']) {
  5294. // "downlevel-hidden".
  5295. $elements['#prefix'] = "\n<!--[if $expression]>\n" . $elements['#prefix'];
  5296. $elements['#suffix'] .= "<![endif]-->\n";
  5297. }
  5298. else {
  5299. // "downlevel-revealed".
  5300. $elements['#prefix'] = "\n<!--[if $expression]><!-->\n" . $elements['#prefix'];
  5301. $elements['#suffix'] .= "<!--<![endif]-->\n";
  5302. }
  5303. return $elements;
  5304. }
  5305. /**
  5306. * #pre_render callback to render a link into #markup.
  5307. *
  5308. * Doing so during pre_render gives modules a chance to alter the link parts.
  5309. *
  5310. * @param $elements
  5311. * A structured array whose keys form the arguments to l():
  5312. * - #title: The link text to pass as argument to l().
  5313. * - #href: The URL path component to pass as argument to l().
  5314. * - #options: (optional) An array of options to pass to l().
  5315. *
  5316. * @return
  5317. * The passed-in elements containing a rendered link in '#markup'.
  5318. */
  5319. function drupal_pre_render_link($element) {
  5320. // By default, link options to pass to l() are normally set in #options.
  5321. $element += array('#options' => array());
  5322. // However, within the scope of renderable elements, #attributes is a valid
  5323. // way to specify attributes, too. Take them into account, but do not override
  5324. // attributes from #options.
  5325. if (isset($element['#attributes'])) {
  5326. $element['#options'] += array('attributes' => array());
  5327. $element['#options']['attributes'] += $element['#attributes'];
  5328. }
  5329. // This #pre_render callback can be invoked from inside or outside of a Form
  5330. // API context, and depending on that, a HTML ID may be already set in
  5331. // different locations. #options should have precedence over Form API's #id.
  5332. // #attributes have been taken over into #options above already.
  5333. if (isset($element['#options']['attributes']['id'])) {
  5334. $element['#id'] = $element['#options']['attributes']['id'];
  5335. }
  5336. elseif (isset($element['#id'])) {
  5337. $element['#options']['attributes']['id'] = $element['#id'];
  5338. }
  5339. // Conditionally invoke ajax_pre_render_element(), if #ajax is set.
  5340. if (isset($element['#ajax']) && !isset($element['#ajax_processed'])) {
  5341. // If no HTML ID was found above, automatically create one.
  5342. if (!isset($element['#id'])) {
  5343. $element['#id'] = $element['#options']['attributes']['id'] = drupal_html_id('ajax-link');
  5344. }
  5345. // If #ajax['path] was not specified, use the href as Ajax request URL.
  5346. if (!isset($element['#ajax']['path'])) {
  5347. $element['#ajax']['path'] = $element['#href'];
  5348. $element['#ajax']['options'] = $element['#options'];
  5349. }
  5350. $element = ajax_pre_render_element($element);
  5351. }
  5352. $element['#markup'] = l($element['#title'], $element['#href'], $element['#options']);
  5353. return $element;
  5354. }
  5355. /**
  5356. * #pre_render callback that collects child links into a single array.
  5357. *
  5358. * This function can be added as a pre_render callback for a renderable array,
  5359. * usually one which will be themed by theme_links(). It iterates through all
  5360. * unrendered children of the element, collects any #links properties it finds,
  5361. * merges them into the parent element's #links array, and prevents those
  5362. * children from being rendered separately.
  5363. *
  5364. * The purpose of this is to allow links to be logically grouped into related
  5365. * categories, so that each child group can be rendered as its own list of
  5366. * links if drupal_render() is called on it, but calling drupal_render() on the
  5367. * parent element will still produce a single list containing all the remaining
  5368. * links, regardless of what group they were in.
  5369. *
  5370. * A typical example comes from node links, which are stored in a renderable
  5371. * array similar to this:
  5372. * @code
  5373. * $node->content['links'] = array(
  5374. * '#theme' => 'links__node',
  5375. * '#pre_render' => array('drupal_pre_render_links'),
  5376. * 'comment' => array(
  5377. * '#theme' => 'links__node__comment',
  5378. * '#links' => array(
  5379. * // An array of links associated with node comments, suitable for
  5380. * // passing in to theme_links().
  5381. * ),
  5382. * ),
  5383. * 'statistics' => array(
  5384. * '#theme' => 'links__node__statistics',
  5385. * '#links' => array(
  5386. * // An array of links associated with node statistics, suitable for
  5387. * // passing in to theme_links().
  5388. * ),
  5389. * ),
  5390. * 'translation' => array(
  5391. * '#theme' => 'links__node__translation',
  5392. * '#links' => array(
  5393. * // An array of links associated with node translation, suitable for
  5394. * // passing in to theme_links().
  5395. * ),
  5396. * ),
  5397. * );
  5398. * @endcode
  5399. *
  5400. * In this example, the links are grouped by functionality, which can be
  5401. * helpful to themers who want to display certain kinds of links independently.
  5402. * For example, adding this code to node.tpl.php will result in the comment
  5403. * links being rendered as a single list:
  5404. * @code
  5405. * print render($content['links']['comment']);
  5406. * @endcode
  5407. *
  5408. * (where $node->content has been transformed into $content before handing
  5409. * control to the node.tpl.php template).
  5410. *
  5411. * The pre_render function defined here allows the above flexibility, but also
  5412. * allows the following code to be used to render all remaining links into a
  5413. * single list, regardless of their group:
  5414. * @code
  5415. * print render($content['links']);
  5416. * @endcode
  5417. *
  5418. * In the above example, this will result in the statistics and translation
  5419. * links being rendered together in a single list (but not the comment links,
  5420. * which were rendered previously on their own).
  5421. *
  5422. * Because of the way this function works, the individual properties of each
  5423. * group (for example, a group-specific #theme property such as
  5424. * 'links__node__comment' in the example above, or any other property such as
  5425. * #attributes or #pre_render that is attached to it) are only used when that
  5426. * group is rendered on its own. When the group is rendered together with other
  5427. * children, these child-specific properties are ignored, and only the overall
  5428. * properties of the parent are used.
  5429. */
  5430. function drupal_pre_render_links($element) {
  5431. $element += array('#links' => array());
  5432. foreach (element_children($element) as $key) {
  5433. $child = &$element[$key];
  5434. // If the child has links which have not been printed yet and the user has
  5435. // access to it, merge its links in to the parent.
  5436. if (isset($child['#links']) && empty($child['#printed']) && (!isset($child['#access']) || $child['#access'])) {
  5437. $element['#links'] += $child['#links'];
  5438. // Mark the child as having been printed already (so that its links
  5439. // cannot be mistakenly rendered twice).
  5440. $child['#printed'] = TRUE;
  5441. }
  5442. }
  5443. return $element;
  5444. }
  5445. /**
  5446. * #pre_render callback to append contents in #markup to #children.
  5447. *
  5448. * This needs to be a #pre_render callback, because eventually assigned
  5449. * #theme_wrappers will expect the element's rendered content in #children.
  5450. * Note that if also a #theme is defined for the element, then the result of
  5451. * the theme callback will override #children.
  5452. *
  5453. * @param $elements
  5454. * A structured array using the #markup key.
  5455. *
  5456. * @return
  5457. * The passed-in elements, but #markup appended to #children.
  5458. *
  5459. * @see drupal_render()
  5460. */
  5461. function drupal_pre_render_markup($elements) {
  5462. $elements['#children'] = $elements['#markup'];
  5463. return $elements;
  5464. }
  5465. /**
  5466. * Renders the page, including all theming.
  5467. *
  5468. * @param $page
  5469. * A string or array representing the content of a page. The array consists of
  5470. * the following keys:
  5471. * - #type: Value is always 'page'. This pushes the theming through
  5472. * page.tpl.php (required).
  5473. * - #show_messages: Suppress drupal_get_message() items. Used by Batch
  5474. * API (optional).
  5475. *
  5476. * @see hook_page_alter()
  5477. * @see element_info()
  5478. */
  5479. function drupal_render_page($page) {
  5480. $main_content_display = &drupal_static('system_main_content_added', FALSE);
  5481. // Allow menu callbacks to return strings or arbitrary arrays to render.
  5482. // If the array returned is not of #type page directly, we need to fill
  5483. // in the page with defaults.
  5484. if (is_string($page) || (is_array($page) && (!isset($page['#type']) || ($page['#type'] != 'page')))) {
  5485. drupal_set_page_content($page);
  5486. $page = element_info('page');
  5487. }
  5488. // Modules can add elements to $page as needed in hook_page_build().
  5489. foreach (module_implements('page_build') as $module) {
  5490. $function = $module . '_page_build';
  5491. $function($page);
  5492. }
  5493. // Modules alter the $page as needed. Blocks are populated into regions like
  5494. // 'sidebar_first', 'footer', etc.
  5495. drupal_alter('page', $page);
  5496. // If no module has taken care of the main content, add it to the page now.
  5497. // This allows the site to still be usable even if no modules that
  5498. // control page regions (for example, the Block module) are enabled.
  5499. if (!$main_content_display) {
  5500. $page['content']['system_main'] = drupal_set_page_content();
  5501. }
  5502. return drupal_render($page);
  5503. }
  5504. /**
  5505. * Renders HTML given a structured array tree.
  5506. *
  5507. * Recursively iterates over each of the array elements, generating HTML code.
  5508. *
  5509. * Renderable arrays have two kinds of key/value pairs: properties and
  5510. * children. Properties have keys starting with '#' and their values influence
  5511. * how the array will be rendered. Children are all elements whose keys do not
  5512. * start with a '#'. Their values should be renderable arrays themselves,
  5513. * which will be rendered during the rendering of the parent array. The markup
  5514. * provided by the children is typically inserted into the markup generated by
  5515. * the parent array.
  5516. *
  5517. * HTML generation for a renderable array, and the treatment of any children,
  5518. * is controlled by two properties containing theme functions, #theme and
  5519. * #theme_wrappers.
  5520. *
  5521. * #theme is the theme function called first. If it is set and the element has
  5522. * any children, it is the responsibility of the theme function to render
  5523. * these children. For elements that are not allowed to have any children,
  5524. * e.g. buttons or textfields, the theme function can be used to render the
  5525. * element itself. If #theme is not present and the element has children, each
  5526. * child is itself rendered by a call to drupal_render(), and the results are
  5527. * concatenated.
  5528. *
  5529. * The #theme_wrappers property contains an array of theme functions which will
  5530. * be called, in order, after #theme has run. These can be used to add further
  5531. * markup around the rendered children; e.g., fieldsets add the required markup
  5532. * for a fieldset around their rendered child elements. All wrapper theme
  5533. * functions have to include the element's #children property in their output,
  5534. * as it contains the output of the previous theme functions and the rendered
  5535. * children.
  5536. *
  5537. * For example, for the form element type, by default only the #theme_wrappers
  5538. * property is set, which adds the form markup around the rendered child
  5539. * elements of the form. This allows you to set the #theme property on a
  5540. * specific form to a custom theme function, giving you complete control over
  5541. * the placement of the form's children while not at all having to deal with
  5542. * the form markup itself.
  5543. *
  5544. * drupal_render() can optionally cache the rendered output of elements to
  5545. * improve performance. To use drupal_render() caching, set the element's #cache
  5546. * property to an associative array with one or several of the following keys:
  5547. * - 'keys': An array of one or more keys that identify the element. If 'keys'
  5548. * is set, the cache ID is created automatically from these keys. See
  5549. * drupal_render_cid_create().
  5550. * - 'granularity' (optional): Define the cache granularity using binary
  5551. * combinations of the cache granularity constants, e.g.
  5552. * DRUPAL_CACHE_PER_USER to cache for each user separately or
  5553. * DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE to cache separately for each
  5554. * page and role. If not specified the element is cached globally for each
  5555. * theme and language.
  5556. * - 'cid': Specify the cache ID directly. Either 'keys' or 'cid' is required.
  5557. * If 'cid' is set, 'keys' and 'granularity' are ignored. Use only if you
  5558. * have special requirements.
  5559. * - 'expire': Set to one of the cache lifetime constants.
  5560. * - 'bin': Specify a cache bin to cache the element in. Defaults to 'cache'.
  5561. *
  5562. * This function is usually called from within another function, like
  5563. * drupal_get_form() or a theme function. Elements are sorted internally
  5564. * using uasort(). Since this is expensive, when passing already sorted
  5565. * elements to drupal_render(), for example from a database query, set
  5566. * $elements['#sorted'] = TRUE to avoid sorting them a second time.
  5567. *
  5568. * drupal_render() flags each element with a '#printed' status to indicate that
  5569. * the element has been rendered, which allows individual elements of a given
  5570. * array to be rendered independently and prevents them from being rendered
  5571. * more than once on subsequent calls to drupal_render() (e.g., as part of a
  5572. * larger array). If the same array or array element is passed more than once
  5573. * to drupal_render(), it simply returns an empty string.
  5574. *
  5575. * @param array $elements
  5576. * The structured array describing the data to be rendered.
  5577. *
  5578. * @return string
  5579. * The rendered HTML.
  5580. */
  5581. function drupal_render(&$elements) {
  5582. // Early-return nothing if user does not have access.
  5583. if (empty($elements) || (isset($elements['#access']) && !$elements['#access'])) {
  5584. return '';
  5585. }
  5586. // Do not print elements twice.
  5587. if (!empty($elements['#printed'])) {
  5588. return '';
  5589. }
  5590. // Try to fetch the element's markup from cache and return.
  5591. if (isset($elements['#cache'])) {
  5592. $cached_output = drupal_render_cache_get($elements);
  5593. if ($cached_output !== FALSE) {
  5594. return $cached_output;
  5595. }
  5596. }
  5597. // If #markup is set, ensure #type is set. This allows to specify just #markup
  5598. // on an element without setting #type.
  5599. if (isset($elements['#markup']) && !isset($elements['#type'])) {
  5600. $elements['#type'] = 'markup';
  5601. }
  5602. // If the default values for this element have not been loaded yet, populate
  5603. // them.
  5604. if (isset($elements['#type']) && empty($elements['#defaults_loaded'])) {
  5605. $elements += element_info($elements['#type']);
  5606. }
  5607. // Make any final changes to the element before it is rendered. This means
  5608. // that the $element or the children can be altered or corrected before the
  5609. // element is rendered into the final text.
  5610. if (isset($elements['#pre_render'])) {
  5611. foreach ($elements['#pre_render'] as $function) {
  5612. if (function_exists($function)) {
  5613. $elements = $function($elements);
  5614. }
  5615. }
  5616. }
  5617. // Allow #pre_render to abort rendering.
  5618. if (!empty($elements['#printed'])) {
  5619. return '';
  5620. }
  5621. // Get the children of the element, sorted by weight.
  5622. $children = element_children($elements, TRUE);
  5623. // Initialize this element's #children, unless a #pre_render callback already
  5624. // preset #children.
  5625. if (!isset($elements['#children'])) {
  5626. $elements['#children'] = '';
  5627. }
  5628. // Call the element's #theme function if it is set. Then any children of the
  5629. // element have to be rendered there.
  5630. if (isset($elements['#theme'])) {
  5631. $elements['#children'] = theme($elements['#theme'], $elements);
  5632. }
  5633. // If #theme was not set and the element has children, render them now.
  5634. // This is the same process as drupal_render_children() but is inlined
  5635. // for speed.
  5636. if ($elements['#children'] == '') {
  5637. foreach ($children as $key) {
  5638. $elements['#children'] .= drupal_render($elements[$key]);
  5639. }
  5640. }
  5641. // Let the theme functions in #theme_wrappers add markup around the rendered
  5642. // children.
  5643. if (isset($elements['#theme_wrappers'])) {
  5644. foreach ($elements['#theme_wrappers'] as $theme_wrapper) {
  5645. $elements['#children'] = theme($theme_wrapper, $elements);
  5646. }
  5647. }
  5648. // Filter the outputted content and make any last changes before the
  5649. // content is sent to the browser. The changes are made on $content
  5650. // which allows the output'ed text to be filtered.
  5651. if (isset($elements['#post_render'])) {
  5652. foreach ($elements['#post_render'] as $function) {
  5653. if (function_exists($function)) {
  5654. $elements['#children'] = $function($elements['#children'], $elements);
  5655. }
  5656. }
  5657. }
  5658. // Add any JavaScript state information associated with the element.
  5659. if (!empty($elements['#states'])) {
  5660. drupal_process_states($elements);
  5661. }
  5662. // Add additional libraries, CSS, JavaScript an other custom
  5663. // attached data associated with this element.
  5664. if (!empty($elements['#attached'])) {
  5665. drupal_process_attached($elements);
  5666. }
  5667. $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
  5668. $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
  5669. $output = $prefix . $elements['#children'] . $suffix;
  5670. // Cache the processed element if #cache is set.
  5671. if (isset($elements['#cache'])) {
  5672. drupal_render_cache_set($output, $elements);
  5673. }
  5674. $elements['#printed'] = TRUE;
  5675. return $output;
  5676. }
  5677. /**
  5678. * Renders children of an element and concatenates them.
  5679. *
  5680. * @param array $element
  5681. * The structured array whose children shall be rendered.
  5682. * @param array $children_keys
  5683. * (optional) If the keys of the element's children are already known, they
  5684. * can be passed in to save another run of element_children().
  5685. *
  5686. * @return string
  5687. * The rendered HTML of all children of the element.
  5688. * @see drupal_render()
  5689. */
  5690. function drupal_render_children(&$element, $children_keys = NULL) {
  5691. if ($children_keys === NULL) {
  5692. $children_keys = element_children($element);
  5693. }
  5694. $output = '';
  5695. foreach ($children_keys as $key) {
  5696. if (!empty($element[$key])) {
  5697. $output .= drupal_render($element[$key]);
  5698. }
  5699. }
  5700. return $output;
  5701. }
  5702. /**
  5703. * Renders an element.
  5704. *
  5705. * This function renders an element using drupal_render(). The top level
  5706. * element is shown with show() before rendering, so it will always be rendered
  5707. * even if hide() had been previously used on it.
  5708. *
  5709. * @param $element
  5710. * The element to be rendered.
  5711. *
  5712. * @return
  5713. * The rendered element.
  5714. *
  5715. * @see drupal_render()
  5716. * @see show()
  5717. * @see hide()
  5718. */
  5719. function render(&$element) {
  5720. if (is_array($element)) {
  5721. show($element);
  5722. return drupal_render($element);
  5723. }
  5724. else {
  5725. // Safe-guard for inappropriate use of render() on flat variables: return
  5726. // the variable as-is.
  5727. return $element;
  5728. }
  5729. }
  5730. /**
  5731. * Hides an element from later rendering.
  5732. *
  5733. * The first time render() or drupal_render() is called on an element tree,
  5734. * as each element in the tree is rendered, it is marked with a #printed flag
  5735. * and the rendered children of the element are cached. Subsequent calls to
  5736. * render() or drupal_render() will not traverse the child tree of this element
  5737. * again: they will just use the cached children. So if you want to hide an
  5738. * element, be sure to call hide() on the element before its parent tree is
  5739. * rendered for the first time, as it will have no effect on subsequent
  5740. * renderings of the parent tree.
  5741. *
  5742. * @param $element
  5743. * The element to be hidden.
  5744. *
  5745. * @return
  5746. * The element.
  5747. *
  5748. * @see render()
  5749. * @see show()
  5750. */
  5751. function hide(&$element) {
  5752. $element['#printed'] = TRUE;
  5753. return $element;
  5754. }
  5755. /**
  5756. * Shows a hidden element for later rendering.
  5757. *
  5758. * You can also use render($element), which shows the element while rendering
  5759. * it.
  5760. *
  5761. * The first time render() or drupal_render() is called on an element tree,
  5762. * as each element in the tree is rendered, it is marked with a #printed flag
  5763. * and the rendered children of the element are cached. Subsequent calls to
  5764. * render() or drupal_render() will not traverse the child tree of this element
  5765. * again: they will just use the cached children. So if you want to show an
  5766. * element, be sure to call show() on the element before its parent tree is
  5767. * rendered for the first time, as it will have no effect on subsequent
  5768. * renderings of the parent tree.
  5769. *
  5770. * @param $element
  5771. * The element to be shown.
  5772. *
  5773. * @return
  5774. * The element.
  5775. *
  5776. * @see render()
  5777. * @see hide()
  5778. */
  5779. function show(&$element) {
  5780. $element['#printed'] = FALSE;
  5781. return $element;
  5782. }
  5783. /**
  5784. * Gets the rendered output of a renderable element from the cache.
  5785. *
  5786. * @param $elements
  5787. * A renderable array.
  5788. *
  5789. * @return
  5790. * A markup string containing the rendered content of the element, or FALSE
  5791. * if no cached copy of the element is available.
  5792. *
  5793. * @see drupal_render()
  5794. * @see drupal_render_cache_set()
  5795. */
  5796. function drupal_render_cache_get($elements) {
  5797. if (!in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD')) || !$cid = drupal_render_cid_create($elements)) {
  5798. return FALSE;
  5799. }
  5800. $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
  5801. if (!empty($cid) && $cache = cache_get($cid, $bin)) {
  5802. // Add additional libraries, JavaScript, CSS and other data attached
  5803. // to this element.
  5804. if (isset($cache->data['#attached'])) {
  5805. drupal_process_attached($cache->data);
  5806. }
  5807. // Return the rendered output.
  5808. return $cache->data['#markup'];
  5809. }
  5810. return FALSE;
  5811. }
  5812. /**
  5813. * Caches the rendered output of a renderable element.
  5814. *
  5815. * This is called by drupal_render() if the #cache property is set on an
  5816. * element.
  5817. *
  5818. * @param $markup
  5819. * The rendered output string of $elements.
  5820. * @param $elements
  5821. * A renderable array.
  5822. *
  5823. * @see drupal_render_cache_get()
  5824. */
  5825. function drupal_render_cache_set(&$markup, $elements) {
  5826. // Create the cache ID for the element.
  5827. if (!in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD')) || !$cid = drupal_render_cid_create($elements)) {
  5828. return FALSE;
  5829. }
  5830. // Cache implementations are allowed to modify the markup, to support
  5831. // replacing markup with edge-side include commands. The supporting cache
  5832. // backend will store the markup in some other key (like
  5833. // $data['#real-value']) and return an include command instead. When the
  5834. // ESI command is executed by the content accelerator, the real value can
  5835. // be retrieved and used.
  5836. $data['#markup'] = &$markup;
  5837. // Persist attached data associated with this element.
  5838. $attached = drupal_render_collect_attached($elements, TRUE);
  5839. if ($attached) {
  5840. $data['#attached'] = $attached;
  5841. }
  5842. $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
  5843. $expire = isset($elements['#cache']['expire']) ? $elements['#cache']['expire'] : CACHE_PERMANENT;
  5844. cache_set($cid, $data, $bin, $expire);
  5845. }
  5846. /**
  5847. * Collects #attached for an element and its children into a single array.
  5848. *
  5849. * When caching elements, it is necessary to collect all libraries, JavaScript
  5850. * and CSS into a single array, from both the element itself and all child
  5851. * elements. This allows drupal_render() to add these back to the page when the
  5852. * element is returned from cache.
  5853. *
  5854. * @param $elements
  5855. * The element to collect #attached from.
  5856. * @param $return
  5857. * Whether to return the attached elements and reset the internal static.
  5858. *
  5859. * @return
  5860. * The #attached array for this element and its descendants.
  5861. */
  5862. function drupal_render_collect_attached($elements, $return = FALSE) {
  5863. $attached = &drupal_static(__FUNCTION__, array());
  5864. // Collect all #attached for this element.
  5865. if (isset($elements['#attached'])) {
  5866. foreach ($elements['#attached'] as $key => $value) {
  5867. if (!isset($attached[$key])) {
  5868. $attached[$key] = array();
  5869. }
  5870. $attached[$key] = array_merge($attached[$key], $value);
  5871. }
  5872. }
  5873. if ($children = element_children($elements)) {
  5874. foreach ($children as $child) {
  5875. drupal_render_collect_attached($elements[$child]);
  5876. }
  5877. }
  5878. // If this was the first call to the function, return all attached elements
  5879. // and reset the static cache.
  5880. if ($return) {
  5881. $return = $attached;
  5882. $attached = array();
  5883. return $return;
  5884. }
  5885. }
  5886. /**
  5887. * Prepares an element for caching based on a query.
  5888. *
  5889. * This smart caching strategy saves Drupal from querying and rendering to HTML
  5890. * when the underlying query is unchanged.
  5891. *
  5892. * Expensive queries should use the query builder to create the query and then
  5893. * call this function. Executing the query and formatting results should happen
  5894. * in a #pre_render callback.
  5895. *
  5896. * @param $query
  5897. * A select query object as returned by db_select().
  5898. * @param $function
  5899. * The name of the function doing this caching. A _pre_render suffix will be
  5900. * added to this string and is also part of the cache key in
  5901. * drupal_render_cache_set() and drupal_render_cache_get().
  5902. * @param $expire
  5903. * The cache expire time, passed eventually to cache_set().
  5904. * @param $granularity
  5905. * One or more granularity constants passed to drupal_render_cid_parts().
  5906. *
  5907. * @return
  5908. * A renderable array with the following keys and values:
  5909. * - #query: The passed-in $query.
  5910. * - #pre_render: $function with a _pre_render suffix.
  5911. * - #cache: An associative array prepared for drupal_render_cache_set().
  5912. */
  5913. function drupal_render_cache_by_query($query, $function, $expire = CACHE_TEMPORARY, $granularity = NULL) {
  5914. $cache_keys = array_merge(array($function), drupal_render_cid_parts($granularity));
  5915. $query->preExecute();
  5916. $cache_keys[] = hash('sha256', serialize(array((string) $query, $query->getArguments())));
  5917. return array(
  5918. '#query' => $query,
  5919. '#pre_render' => array($function . '_pre_render'),
  5920. '#cache' => array(
  5921. 'keys' => $cache_keys,
  5922. 'expire' => $expire,
  5923. ),
  5924. );
  5925. }
  5926. /**
  5927. * Returns cache ID parts for building a cache ID.
  5928. *
  5929. * @param $granularity
  5930. * One or more cache granularity constants. For example, to cache separately
  5931. * for each user, use DRUPAL_CACHE_PER_USER. To cache separately for each
  5932. * page and role, use the expression:
  5933. * @code
  5934. * DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE
  5935. * @endcode
  5936. *
  5937. * @return
  5938. * An array of cache ID parts, always containing the active theme. If the
  5939. * locale module is enabled it also contains the active language. If
  5940. * $granularity was passed in, more parts are added.
  5941. */
  5942. function drupal_render_cid_parts($granularity = NULL) {
  5943. global $theme, $base_root, $user;
  5944. $cid_parts[] = $theme;
  5945. // If Locale is enabled but we have only one language we do not need it as cid
  5946. // part.
  5947. if (drupal_multilingual()) {
  5948. foreach (language_types_configurable() as $language_type) {
  5949. $cid_parts[] = $GLOBALS[$language_type]->language;
  5950. }
  5951. }
  5952. if (!empty($granularity)) {
  5953. $cache_per_role = $granularity & DRUPAL_CACHE_PER_ROLE;
  5954. $cache_per_user = $granularity & DRUPAL_CACHE_PER_USER;
  5955. // User 1 has special permissions outside of the role system, so when
  5956. // caching per role is requested, it should cache per user instead.
  5957. if ($user->uid == 1 && $cache_per_role) {
  5958. $cache_per_user = TRUE;
  5959. $cache_per_role = FALSE;
  5960. }
  5961. // 'PER_ROLE' and 'PER_USER' are mutually exclusive. 'PER_USER' can be a
  5962. // resource drag for sites with many users, so when a module is being
  5963. // equivocal, we favor the less expensive 'PER_ROLE' pattern.
  5964. if ($cache_per_role) {
  5965. $cid_parts[] = 'r.' . implode(',', array_keys($user->roles));
  5966. }
  5967. elseif ($cache_per_user) {
  5968. $cid_parts[] = "u.$user->uid";
  5969. }
  5970. if ($granularity & DRUPAL_CACHE_PER_PAGE) {
  5971. $cid_parts[] = $base_root . request_uri();
  5972. }
  5973. }
  5974. return $cid_parts;
  5975. }
  5976. /**
  5977. * Creates the cache ID for a renderable element.
  5978. *
  5979. * This creates the cache ID string, either by returning the #cache['cid']
  5980. * property if present or by building the cache ID out of the #cache['keys']
  5981. * and, optionally, the #cache['granularity'] properties.
  5982. *
  5983. * @param $elements
  5984. * A renderable array.
  5985. *
  5986. * @return
  5987. * The cache ID string, or FALSE if the element may not be cached.
  5988. */
  5989. function drupal_render_cid_create($elements) {
  5990. if (isset($elements['#cache']['cid'])) {
  5991. return $elements['#cache']['cid'];
  5992. }
  5993. elseif (isset($elements['#cache']['keys'])) {
  5994. $granularity = isset($elements['#cache']['granularity']) ? $elements['#cache']['granularity'] : NULL;
  5995. // Merge in additional cache ID parts based provided by drupal_render_cid_parts().
  5996. $cid_parts = array_merge($elements['#cache']['keys'], drupal_render_cid_parts($granularity));
  5997. return implode(':', $cid_parts);
  5998. }
  5999. return FALSE;
  6000. }
  6001. /**
  6002. * Function used by uasort to sort structured arrays by weight.
  6003. */
  6004. function element_sort($a, $b) {
  6005. $a_weight = (is_array($a) && isset($a['#weight'])) ? $a['#weight'] : 0;
  6006. $b_weight = (is_array($b) && isset($b['#weight'])) ? $b['#weight'] : 0;
  6007. if ($a_weight == $b_weight) {
  6008. return 0;
  6009. }
  6010. return ($a_weight < $b_weight) ? -1 : 1;
  6011. }
  6012. /**
  6013. * Array sorting callback; sorts elements by title.
  6014. */
  6015. function element_sort_by_title($a, $b) {
  6016. $a_title = (is_array($a) && isset($a['#title'])) ? $a['#title'] : '';
  6017. $b_title = (is_array($b) && isset($b['#title'])) ? $b['#title'] : '';
  6018. return strnatcasecmp($a_title, $b_title);
  6019. }
  6020. /**
  6021. * Retrieves the default properties for the defined element type.
  6022. *
  6023. * @param $type
  6024. * An element type as defined by hook_element_info().
  6025. */
  6026. function element_info($type) {
  6027. // Use the advanced drupal_static() pattern, since this is called very often.
  6028. static $drupal_static_fast;
  6029. if (!isset($drupal_static_fast)) {
  6030. $drupal_static_fast['cache'] = &drupal_static(__FUNCTION__);
  6031. }
  6032. $cache = &$drupal_static_fast['cache'];
  6033. if (!isset($cache)) {
  6034. $cache = module_invoke_all('element_info');
  6035. foreach ($cache as $element_type => $info) {
  6036. $cache[$element_type]['#type'] = $element_type;
  6037. }
  6038. // Allow modules to alter the element type defaults.
  6039. drupal_alter('element_info', $cache);
  6040. }
  6041. return isset($cache[$type]) ? $cache[$type] : array();
  6042. }
  6043. /**
  6044. * Retrieves a single property for the defined element type.
  6045. *
  6046. * @param $type
  6047. * An element type as defined by hook_element_info().
  6048. * @param $property_name
  6049. * The property within the element type that should be returned.
  6050. * @param $default
  6051. * (Optional) The value to return if the element type does not specify a
  6052. * value for the property. Defaults to NULL.
  6053. */
  6054. function element_info_property($type, $property_name, $default = NULL) {
  6055. return (($info = element_info($type)) && array_key_exists($property_name, $info)) ? $info[$property_name] : $default;
  6056. }
  6057. /**
  6058. * Sorts a structured array by the 'weight' element.
  6059. *
  6060. * Note that the sorting is by the 'weight' array element, not by the render
  6061. * element property '#weight'.
  6062. *
  6063. * Callback for uasort() used in various functions.
  6064. *
  6065. * @param $a
  6066. * First item for comparison. The compared items should be associative arrays
  6067. * that optionally include a 'weight' element. For items without a 'weight'
  6068. * element, a default value of 0 will be used.
  6069. * @param $b
  6070. * Second item for comparison.
  6071. */
  6072. function drupal_sort_weight($a, $b) {
  6073. $a_weight = (is_array($a) && isset($a['weight'])) ? $a['weight'] : 0;
  6074. $b_weight = (is_array($b) && isset($b['weight'])) ? $b['weight'] : 0;
  6075. if ($a_weight == $b_weight) {
  6076. return 0;
  6077. }
  6078. return ($a_weight < $b_weight) ? -1 : 1;
  6079. }
  6080. /**
  6081. * Array sorting callback; sorts elements by 'title' key.
  6082. */
  6083. function drupal_sort_title($a, $b) {
  6084. if (!isset($b['title'])) {
  6085. return -1;
  6086. }
  6087. if (!isset($a['title'])) {
  6088. return 1;
  6089. }
  6090. return strcasecmp($a['title'], $b['title']);
  6091. }
  6092. /**
  6093. * Checks if the key is a property.
  6094. */
  6095. function element_property($key) {
  6096. return $key[0] == '#';
  6097. }
  6098. /**
  6099. * Gets properties of a structured array element (keys beginning with '#').
  6100. */
  6101. function element_properties($element) {
  6102. return array_filter(array_keys((array) $element), 'element_property');
  6103. }
  6104. /**
  6105. * Checks if the key is a child.
  6106. */
  6107. function element_child($key) {
  6108. return !isset($key[0]) || $key[0] != '#';
  6109. }
  6110. /**
  6111. * Identifies the children of an element array, optionally sorted by weight.
  6112. *
  6113. * The children of a element array are those key/value pairs whose key does
  6114. * not start with a '#'. See drupal_render() for details.
  6115. *
  6116. * @param $elements
  6117. * The element array whose children are to be identified.
  6118. * @param $sort
  6119. * Boolean to indicate whether the children should be sorted by weight.
  6120. *
  6121. * @return
  6122. * The array keys of the element's children.
  6123. */
  6124. function element_children(&$elements, $sort = FALSE) {
  6125. // Do not attempt to sort elements which have already been sorted.
  6126. $sort = isset($elements['#sorted']) ? !$elements['#sorted'] : $sort;
  6127. // Filter out properties from the element, leaving only children.
  6128. $children = array();
  6129. $sortable = FALSE;
  6130. foreach ($elements as $key => $value) {
  6131. if ($key === '' || $key[0] !== '#') {
  6132. $children[$key] = $value;
  6133. if (is_array($value) && isset($value['#weight'])) {
  6134. $sortable = TRUE;
  6135. }
  6136. }
  6137. }
  6138. // Sort the children if necessary.
  6139. if ($sort && $sortable) {
  6140. uasort($children, 'element_sort');
  6141. // Put the sorted children back into $elements in the correct order, to
  6142. // preserve sorting if the same element is passed through
  6143. // element_children() twice.
  6144. foreach ($children as $key => $child) {
  6145. unset($elements[$key]);
  6146. $elements[$key] = $child;
  6147. }
  6148. $elements['#sorted'] = TRUE;
  6149. }
  6150. return array_keys($children);
  6151. }
  6152. /**
  6153. * Returns the visible children of an element.
  6154. *
  6155. * @param $elements
  6156. * The parent element.
  6157. *
  6158. * @return
  6159. * The array keys of the element's visible children.
  6160. */
  6161. function element_get_visible_children(array $elements) {
  6162. $visible_children = array();
  6163. foreach (element_children($elements) as $key) {
  6164. $child = $elements[$key];
  6165. // Skip un-accessible children.
  6166. if (isset($child['#access']) && !$child['#access']) {
  6167. continue;
  6168. }
  6169. // Skip value and hidden elements, since they are not rendered.
  6170. if (isset($child['#type']) && in_array($child['#type'], array('value', 'hidden'))) {
  6171. continue;
  6172. }
  6173. $visible_children[$key] = $child;
  6174. }
  6175. return array_keys($visible_children);
  6176. }
  6177. /**
  6178. * Sets HTML attributes based on element properties.
  6179. *
  6180. * @param $element
  6181. * The renderable element to process.
  6182. * @param $map
  6183. * An associative array whose keys are element property names and whose values
  6184. * are the HTML attribute names to set for corresponding the property; e.g.,
  6185. * array('#propertyname' => 'attributename'). If both names are identical
  6186. * except for the leading '#', then an attribute name value is sufficient and
  6187. * no property name needs to be specified.
  6188. */
  6189. function element_set_attributes(array &$element, array $map) {
  6190. foreach ($map as $property => $attribute) {
  6191. // If the key is numeric, the attribute name needs to be taken over.
  6192. if (is_int($property)) {
  6193. $property = '#' . $attribute;
  6194. }
  6195. // Do not overwrite already existing attributes.
  6196. if (isset($element[$property]) && !isset($element['#attributes'][$attribute])) {
  6197. $element['#attributes'][$attribute] = $element[$property];
  6198. }
  6199. }
  6200. }
  6201. /**
  6202. * Recursively computes the difference of arrays with additional index check.
  6203. *
  6204. * This is a version of array_diff_assoc() that supports multidimensional
  6205. * arrays.
  6206. *
  6207. * @param array $array1
  6208. * The array to compare from.
  6209. * @param array $array2
  6210. * The array to compare to.
  6211. *
  6212. * @return array
  6213. * Returns an array containing all the values from array1 that are not present
  6214. * in array2.
  6215. */
  6216. function drupal_array_diff_assoc_recursive($array1, $array2) {
  6217. $difference = array();
  6218. foreach ($array1 as $key => $value) {
  6219. if (is_array($value)) {
  6220. if (!array_key_exists($key, $array2) || !is_array($array2[$key])) {
  6221. $difference[$key] = $value;
  6222. }
  6223. else {
  6224. $new_diff = drupal_array_diff_assoc_recursive($value, $array2[$key]);
  6225. if (!empty($new_diff)) {
  6226. $difference[$key] = $new_diff;
  6227. }
  6228. }
  6229. }
  6230. elseif (!array_key_exists($key, $array2) || $array2[$key] !== $value) {
  6231. $difference[$key] = $value;
  6232. }
  6233. }
  6234. return $difference;
  6235. }
  6236. /**
  6237. * Sets a value in a nested array with variable depth.
  6238. *
  6239. * This helper function should be used when the depth of the array element you
  6240. * are changing may vary (that is, the number of parent keys is variable). It
  6241. * is primarily used for form structures and renderable arrays.
  6242. *
  6243. * Example:
  6244. * @code
  6245. * // Assume you have a 'signature' element somewhere in a form. It might be:
  6246. * $form['signature_settings']['signature'] = array(
  6247. * '#type' => 'text_format',
  6248. * '#title' => t('Signature'),
  6249. * );
  6250. * // Or, it might be further nested:
  6251. * $form['signature_settings']['user']['signature'] = array(
  6252. * '#type' => 'text_format',
  6253. * '#title' => t('Signature'),
  6254. * );
  6255. * @endcode
  6256. *
  6257. * To deal with the situation, the code needs to figure out the route to the
  6258. * element, given an array of parents that is either
  6259. * @code array('signature_settings', 'signature') @endcode in the first case or
  6260. * @code array('signature_settings', 'user', 'signature') @endcode in the second
  6261. * case.
  6262. *
  6263. * Without this helper function the only way to set the signature element in one
  6264. * line would be using eval(), which should be avoided:
  6265. * @code
  6266. * // Do not do this! Avoid eval().
  6267. * eval('$form[\'' . implode("']['", $parents) . '\'] = $element;');
  6268. * @endcode
  6269. *
  6270. * Instead, use this helper function:
  6271. * @code
  6272. * drupal_array_set_nested_value($form, $parents, $element);
  6273. * @endcode
  6274. *
  6275. * However if the number of array parent keys is static, the value should always
  6276. * be set directly rather than calling this function. For instance, for the
  6277. * first example we could just do:
  6278. * @code
  6279. * $form['signature_settings']['signature'] = $element;
  6280. * @endcode
  6281. *
  6282. * @param $array
  6283. * A reference to the array to modify.
  6284. * @param $parents
  6285. * An array of parent keys, starting with the outermost key.
  6286. * @param $value
  6287. * The value to set.
  6288. * @param $force
  6289. * (Optional) If TRUE, the value is forced into the structure even if it
  6290. * requires the deletion of an already existing non-array parent value. If
  6291. * FALSE, PHP throws an error if trying to add into a value that is not an
  6292. * array. Defaults to FALSE.
  6293. *
  6294. * @see drupal_array_get_nested_value()
  6295. */
  6296. function drupal_array_set_nested_value(array &$array, array $parents, $value, $force = FALSE) {
  6297. $ref = &$array;
  6298. foreach ($parents as $parent) {
  6299. // PHP auto-creates container arrays and NULL entries without error if $ref
  6300. // is NULL, but throws an error if $ref is set, but not an array.
  6301. if ($force && isset($ref) && !is_array($ref)) {
  6302. $ref = array();
  6303. }
  6304. $ref = &$ref[$parent];
  6305. }
  6306. $ref = $value;
  6307. }
  6308. /**
  6309. * Retrieves a value from a nested array with variable depth.
  6310. *
  6311. * This helper function should be used when the depth of the array element being
  6312. * retrieved may vary (that is, the number of parent keys is variable). It is
  6313. * primarily used for form structures and renderable arrays.
  6314. *
  6315. * Without this helper function the only way to get a nested array value with
  6316. * variable depth in one line would be using eval(), which should be avoided:
  6317. * @code
  6318. * // Do not do this! Avoid eval().
  6319. * // May also throw a PHP notice, if the variable array keys do not exist.
  6320. * eval('$value = $array[\'' . implode("']['", $parents) . "'];");
  6321. * @endcode
  6322. *
  6323. * Instead, use this helper function:
  6324. * @code
  6325. * $value = drupal_array_get_nested_value($form, $parents);
  6326. * @endcode
  6327. *
  6328. * A return value of NULL is ambiguous, and can mean either that the requested
  6329. * key does not exist, or that the actual value is NULL. If it is required to
  6330. * know whether the nested array key actually exists, pass a third argument that
  6331. * is altered by reference:
  6332. * @code
  6333. * $key_exists = NULL;
  6334. * $value = drupal_array_get_nested_value($form, $parents, $key_exists);
  6335. * if ($key_exists) {
  6336. * // ... do something with $value ...
  6337. * }
  6338. * @endcode
  6339. *
  6340. * However if the number of array parent keys is static, the value should always
  6341. * be retrieved directly rather than calling this function. For instance:
  6342. * @code
  6343. * $value = $form['signature_settings']['signature'];
  6344. * @endcode
  6345. *
  6346. * @param $array
  6347. * The array from which to get the value.
  6348. * @param $parents
  6349. * An array of parent keys of the value, starting with the outermost key.
  6350. * @param $key_exists
  6351. * (optional) If given, an already defined variable that is altered by
  6352. * reference.
  6353. *
  6354. * @return
  6355. * The requested nested value. Possibly NULL if the value is NULL or not all
  6356. * nested parent keys exist. $key_exists is altered by reference and is a
  6357. * Boolean that indicates whether all nested parent keys exist (TRUE) or not
  6358. * (FALSE). This allows to distinguish between the two possibilities when NULL
  6359. * is returned.
  6360. *
  6361. * @see drupal_array_set_nested_value()
  6362. */
  6363. function &drupal_array_get_nested_value(array &$array, array $parents, &$key_exists = NULL) {
  6364. $ref = &$array;
  6365. foreach ($parents as $parent) {
  6366. if (is_array($ref) && array_key_exists($parent, $ref)) {
  6367. $ref = &$ref[$parent];
  6368. }
  6369. else {
  6370. $key_exists = FALSE;
  6371. $null = NULL;
  6372. return $null;
  6373. }
  6374. }
  6375. $key_exists = TRUE;
  6376. return $ref;
  6377. }
  6378. /**
  6379. * Determines whether a nested array contains the requested keys.
  6380. *
  6381. * This helper function should be used when the depth of the array element to be
  6382. * checked may vary (that is, the number of parent keys is variable). See
  6383. * drupal_array_set_nested_value() for details. It is primarily used for form
  6384. * structures and renderable arrays.
  6385. *
  6386. * If it is required to also get the value of the checked nested key, use
  6387. * drupal_array_get_nested_value() instead.
  6388. *
  6389. * If the number of array parent keys is static, this helper function is
  6390. * unnecessary and the following code can be used instead:
  6391. * @code
  6392. * $value_exists = isset($form['signature_settings']['signature']);
  6393. * $key_exists = array_key_exists('signature', $form['signature_settings']);
  6394. * @endcode
  6395. *
  6396. * @param $array
  6397. * The array with the value to check for.
  6398. * @param $parents
  6399. * An array of parent keys of the value, starting with the outermost key.
  6400. *
  6401. * @return
  6402. * TRUE if all the parent keys exist, FALSE otherwise.
  6403. *
  6404. * @see drupal_array_get_nested_value()
  6405. */
  6406. function drupal_array_nested_key_exists(array $array, array $parents) {
  6407. // Although this function is similar to PHP's array_key_exists(), its
  6408. // arguments should be consistent with drupal_array_get_nested_value().
  6409. $key_exists = NULL;
  6410. drupal_array_get_nested_value($array, $parents, $key_exists);
  6411. return $key_exists;
  6412. }
  6413. /**
  6414. * Provides theme registration for themes across .inc files.
  6415. */
  6416. function drupal_common_theme() {
  6417. return array(
  6418. // From theme.inc.
  6419. 'html' => array(
  6420. 'render element' => 'page',
  6421. 'template' => 'html',
  6422. ),
  6423. 'page' => array(
  6424. 'render element' => 'page',
  6425. 'template' => 'page',
  6426. ),
  6427. 'region' => array(
  6428. 'render element' => 'elements',
  6429. 'template' => 'region',
  6430. ),
  6431. 'status_messages' => array(
  6432. 'variables' => array('display' => NULL),
  6433. ),
  6434. 'link' => array(
  6435. 'variables' => array('text' => NULL, 'path' => NULL, 'options' => array()),
  6436. ),
  6437. 'links' => array(
  6438. 'variables' => array('links' => NULL, 'attributes' => array('class' => array('links')), 'heading' => array()),
  6439. ),
  6440. 'image' => array(
  6441. // HTML 4 and XHTML 1.0 always require an alt attribute. The HTML 5 draft
  6442. // allows the alt attribute to be omitted in some cases. Therefore,
  6443. // default the alt attribute to an empty string, but allow code calling
  6444. // theme('image') to pass explicit NULL for it to be omitted. Usually,
  6445. // neither omission nor an empty string satisfies accessibility
  6446. // requirements, so it is strongly encouraged for code calling
  6447. // theme('image') to pass a meaningful value for the alt variable.
  6448. // - http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
  6449. // - http://www.w3.org/TR/xhtml1/dtds.html
  6450. // - http://dev.w3.org/html5/spec/Overview.html#alt
  6451. // The title attribute is optional in all cases, so it is omitted by
  6452. // default.
  6453. 'variables' => array('path' => NULL, 'width' => NULL, 'height' => NULL, 'alt' => '', 'title' => NULL, 'attributes' => array()),
  6454. ),
  6455. 'breadcrumb' => array(
  6456. 'variables' => array('breadcrumb' => NULL),
  6457. ),
  6458. 'help' => array(
  6459. 'variables' => array(),
  6460. ),
  6461. 'table' => array(
  6462. 'variables' => array('header' => NULL, 'rows' => NULL, 'attributes' => array(), 'caption' => NULL, 'colgroups' => array(), 'sticky' => TRUE, 'empty' => ''),
  6463. ),
  6464. 'tablesort_indicator' => array(
  6465. 'variables' => array('style' => NULL),
  6466. ),
  6467. 'mark' => array(
  6468. 'variables' => array('type' => MARK_NEW),
  6469. ),
  6470. 'item_list' => array(
  6471. 'variables' => array('items' => array(), 'title' => NULL, 'type' => 'ul', 'attributes' => array()),
  6472. ),
  6473. 'more_help_link' => array(
  6474. 'variables' => array('url' => NULL),
  6475. ),
  6476. 'feed_icon' => array(
  6477. 'variables' => array('url' => NULL, 'title' => NULL),
  6478. ),
  6479. 'more_link' => array(
  6480. 'variables' => array('url' => NULL, 'title' => NULL)
  6481. ),
  6482. 'username' => array(
  6483. 'variables' => array('account' => NULL),
  6484. ),
  6485. 'progress_bar' => array(
  6486. 'variables' => array('percent' => NULL, 'message' => NULL),
  6487. ),
  6488. 'indentation' => array(
  6489. 'variables' => array('size' => 1),
  6490. ),
  6491. 'html_tag' => array(
  6492. 'render element' => 'element',
  6493. ),
  6494. // From theme.maintenance.inc.
  6495. 'maintenance_page' => array(
  6496. 'variables' => array('content' => NULL, 'show_messages' => TRUE),
  6497. 'template' => 'maintenance-page',
  6498. ),
  6499. 'update_page' => array(
  6500. 'variables' => array('content' => NULL, 'show_messages' => TRUE),
  6501. ),
  6502. 'install_page' => array(
  6503. 'variables' => array('content' => NULL),
  6504. ),
  6505. 'task_list' => array(
  6506. 'variables' => array('items' => NULL, 'active' => NULL),
  6507. ),
  6508. 'authorize_message' => array(
  6509. 'variables' => array('message' => NULL, 'success' => TRUE),
  6510. ),
  6511. 'authorize_report' => array(
  6512. 'variables' => array('messages' => array()),
  6513. ),
  6514. // From pager.inc.
  6515. 'pager' => array(
  6516. 'variables' => array('tags' => array(), 'element' => 0, 'parameters' => array(), 'quantity' => 9),
  6517. ),
  6518. 'pager_first' => array(
  6519. 'variables' => array('text' => NULL, 'element' => 0, 'parameters' => array()),
  6520. ),
  6521. 'pager_previous' => array(
  6522. 'variables' => array('text' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
  6523. ),
  6524. 'pager_next' => array(
  6525. 'variables' => array('text' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
  6526. ),
  6527. 'pager_last' => array(
  6528. 'variables' => array('text' => NULL, 'element' => 0, 'parameters' => array()),
  6529. ),
  6530. 'pager_link' => array(
  6531. 'variables' => array('text' => NULL, 'page_new' => NULL, 'element' => NULL, 'parameters' => array(), 'attributes' => array()),
  6532. ),
  6533. // From menu.inc.
  6534. 'menu_link' => array(
  6535. 'render element' => 'element',
  6536. ),
  6537. 'menu_tree' => array(
  6538. 'render element' => 'tree',
  6539. ),
  6540. 'menu_local_task' => array(
  6541. 'render element' => 'element',
  6542. ),
  6543. 'menu_local_action' => array(
  6544. 'render element' => 'element',
  6545. ),
  6546. 'menu_local_tasks' => array(
  6547. 'variables' => array('primary' => array(), 'secondary' => array()),
  6548. ),
  6549. // From form.inc.
  6550. 'select' => array(
  6551. 'render element' => 'element',
  6552. ),
  6553. 'fieldset' => array(
  6554. 'render element' => 'element',
  6555. ),
  6556. 'radio' => array(
  6557. 'render element' => 'element',
  6558. ),
  6559. 'radios' => array(
  6560. 'render element' => 'element',
  6561. ),
  6562. 'date' => array(
  6563. 'render element' => 'element',
  6564. ),
  6565. 'exposed_filters' => array(
  6566. 'render element' => 'form',
  6567. ),
  6568. 'checkbox' => array(
  6569. 'render element' => 'element',
  6570. ),
  6571. 'checkboxes' => array(
  6572. 'render element' => 'element',
  6573. ),
  6574. 'button' => array(
  6575. 'render element' => 'element',
  6576. ),
  6577. 'image_button' => array(
  6578. 'render element' => 'element',
  6579. ),
  6580. 'hidden' => array(
  6581. 'render element' => 'element',
  6582. ),
  6583. 'textfield' => array(
  6584. 'render element' => 'element',
  6585. ),
  6586. 'form' => array(
  6587. 'render element' => 'element',
  6588. ),
  6589. 'textarea' => array(
  6590. 'render element' => 'element',
  6591. ),
  6592. 'password' => array(
  6593. 'render element' => 'element',
  6594. ),
  6595. 'file' => array(
  6596. 'render element' => 'element',
  6597. ),
  6598. 'tableselect' => array(
  6599. 'render element' => 'element',
  6600. ),
  6601. 'form_element' => array(
  6602. 'render element' => 'element',
  6603. ),
  6604. 'form_required_marker' => array(
  6605. 'render element' => 'element',
  6606. ),
  6607. 'form_element_label' => array(
  6608. 'render element' => 'element',
  6609. ),
  6610. 'vertical_tabs' => array(
  6611. 'render element' => 'element',
  6612. ),
  6613. 'container' => array(
  6614. 'render element' => 'element',
  6615. ),
  6616. );
  6617. }
  6618. /**
  6619. * @addtogroup schemaapi
  6620. * @{
  6621. */
  6622. /**
  6623. * Creates all tables defined in a module's hook_schema().
  6624. *
  6625. * Note: This function does not pass the module's schema through
  6626. * hook_schema_alter(). The module's tables will be created exactly as the
  6627. * module defines them.
  6628. *
  6629. * @param $module
  6630. * The module for which the tables will be created.
  6631. */
  6632. function drupal_install_schema($module) {
  6633. $schema = drupal_get_schema_unprocessed($module);
  6634. _drupal_schema_initialize($schema, $module, FALSE);
  6635. foreach ($schema as $name => $table) {
  6636. db_create_table($name, $table);
  6637. }
  6638. }
  6639. /**
  6640. * Removes all tables defined in a module's hook_schema().
  6641. *
  6642. * Note: This function does not pass the module's schema through
  6643. * hook_schema_alter(). The module's tables will be created exactly as the
  6644. * module defines them.
  6645. *
  6646. * @param $module
  6647. * The module for which the tables will be removed.
  6648. *
  6649. * @return
  6650. * An array of arrays with the following key/value pairs:
  6651. * - success: a boolean indicating whether the query succeeded.
  6652. * - query: the SQL query(s) executed, passed through check_plain().
  6653. */
  6654. function drupal_uninstall_schema($module) {
  6655. $schema = drupal_get_schema_unprocessed($module);
  6656. _drupal_schema_initialize($schema, $module, FALSE);
  6657. foreach ($schema as $table) {
  6658. if (db_table_exists($table['name'])) {
  6659. db_drop_table($table['name']);
  6660. }
  6661. }
  6662. }
  6663. /**
  6664. * Returns the unprocessed and unaltered version of a module's schema.
  6665. *
  6666. * Use this function only if you explicitly need the original
  6667. * specification of a schema, as it was defined in a module's
  6668. * hook_schema(). No additional default values will be set,
  6669. * hook_schema_alter() is not invoked and these unprocessed
  6670. * definitions won't be cached. To retrieve the schema after
  6671. * hook_schema_alter() has been invoked use drupal_get_schema().
  6672. *
  6673. * This function can be used to retrieve a schema specification in
  6674. * hook_schema(), so it allows you to derive your tables from existing
  6675. * specifications.
  6676. *
  6677. * It is also used by drupal_install_schema() and
  6678. * drupal_uninstall_schema() to ensure that a module's tables are
  6679. * created exactly as specified without any changes introduced by a
  6680. * module that implements hook_schema_alter().
  6681. *
  6682. * @param $module
  6683. * The module to which the table belongs.
  6684. * @param $table
  6685. * The name of the table. If not given, the module's complete schema
  6686. * is returned.
  6687. */
  6688. function drupal_get_schema_unprocessed($module, $table = NULL) {
  6689. // Load the .install file to get hook_schema.
  6690. module_load_install($module);
  6691. $schema = module_invoke($module, 'schema');
  6692. if (isset($table) && isset($schema[$table])) {
  6693. return $schema[$table];
  6694. }
  6695. elseif (!empty($schema)) {
  6696. return $schema;
  6697. }
  6698. return array();
  6699. }
  6700. /**
  6701. * Fills in required default values for table definitions from hook_schema().
  6702. *
  6703. * @param $schema
  6704. * The schema definition array as it was returned by the module's
  6705. * hook_schema().
  6706. * @param $module
  6707. * The module for which hook_schema() was invoked.
  6708. * @param $remove_descriptions
  6709. * (optional) Whether to additionally remove 'description' keys of all tables
  6710. * and fields to improve performance of serialize() and unserialize().
  6711. * Defaults to TRUE.
  6712. */
  6713. function _drupal_schema_initialize(&$schema, $module, $remove_descriptions = TRUE) {
  6714. // Set the name and module key for all tables.
  6715. foreach ($schema as $name => &$table) {
  6716. if (empty($table['module'])) {
  6717. $table['module'] = $module;
  6718. }
  6719. if (!isset($table['name'])) {
  6720. $table['name'] = $name;
  6721. }
  6722. if ($remove_descriptions) {
  6723. unset($table['description']);
  6724. foreach ($table['fields'] as &$field) {
  6725. unset($field['description']);
  6726. }
  6727. }
  6728. }
  6729. }
  6730. /**
  6731. * Retrieves the type for every field in a table schema.
  6732. *
  6733. * @param $table
  6734. * The name of the table from which to retrieve type information.
  6735. *
  6736. * @return
  6737. * An array of types, keyed by field name.
  6738. */
  6739. function drupal_schema_field_types($table) {
  6740. $table_schema = drupal_get_schema($table);
  6741. $field_types = array();
  6742. foreach ($table_schema['fields'] as $field_name => $field_info) {
  6743. $field_types[$field_name] = isset($field_info['type']) ? $field_info['type'] : NULL;
  6744. }
  6745. return $field_types;
  6746. }
  6747. /**
  6748. * Retrieves a list of fields from a table schema.
  6749. *
  6750. * The returned list is suitable for use in an SQL query.
  6751. *
  6752. * @param $table
  6753. * The name of the table from which to retrieve fields.
  6754. * @param
  6755. * An optional prefix to to all fields.
  6756. *
  6757. * @return An array of fields.
  6758. */
  6759. function drupal_schema_fields_sql($table, $prefix = NULL) {
  6760. $schema = drupal_get_schema($table);
  6761. $fields = array_keys($schema['fields']);
  6762. if ($prefix) {
  6763. $columns = array();
  6764. foreach ($fields as $field) {
  6765. $columns[] = "$prefix.$field";
  6766. }
  6767. return $columns;
  6768. }
  6769. else {
  6770. return $fields;
  6771. }
  6772. }
  6773. /**
  6774. * Saves (inserts or updates) a record to the database based upon the schema.
  6775. *
  6776. * Do not use drupal_write_record() within hook_update_N() functions, since the
  6777. * database schema cannot be relied upon when a user is running a series of
  6778. * updates. Instead, use db_insert() or db_update() to save the record.
  6779. *
  6780. * @param $table
  6781. * The name of the table; this must be defined by a hook_schema()
  6782. * implementation.
  6783. * @param $record
  6784. * An object or array representing the record to write, passed in by
  6785. * reference. If inserting a new record, values not provided in $record will
  6786. * be populated in $record and in the database with the default values from
  6787. * the schema, as well as a single serial (auto-increment) field (if present).
  6788. * If updating an existing record, only provided values are updated in the
  6789. * database, and $record is not modified.
  6790. * @param $primary_keys
  6791. * To indicate that this is a new record to be inserted, omit this argument.
  6792. * If this is an update, this argument specifies the primary keys' field
  6793. * names. If there is only 1 field in the key, you may pass in a string; if
  6794. * there are multiple fields in the key, pass in an array.
  6795. *
  6796. * @return
  6797. * If the record insert or update failed, returns FALSE. If it succeeded,
  6798. * returns SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
  6799. */
  6800. function drupal_write_record($table, &$record, $primary_keys = array()) {
  6801. // Standardize $primary_keys to an array.
  6802. if (is_string($primary_keys)) {
  6803. $primary_keys = array($primary_keys);
  6804. }
  6805. $schema = drupal_get_schema($table);
  6806. if (empty($schema)) {
  6807. return FALSE;
  6808. }
  6809. $object = (object) $record;
  6810. $fields = array();
  6811. // Go through the schema to determine fields to write.
  6812. foreach ($schema['fields'] as $field => $info) {
  6813. if ($info['type'] == 'serial') {
  6814. // Skip serial types if we are updating.
  6815. if (!empty($primary_keys)) {
  6816. continue;
  6817. }
  6818. // Track serial field so we can helpfully populate them after the query.
  6819. // NOTE: Each table should come with one serial field only.
  6820. $serial = $field;
  6821. }
  6822. // Skip field if it is in $primary_keys as it is unnecessary to update a
  6823. // field to the value it is already set to.
  6824. if (in_array($field, $primary_keys)) {
  6825. continue;
  6826. }
  6827. if (!property_exists($object, $field)) {
  6828. // Skip fields that are not provided, default values are already known
  6829. // by the database.
  6830. continue;
  6831. }
  6832. // Build array of fields to update or insert.
  6833. if (empty($info['serialize'])) {
  6834. $fields[$field] = $object->$field;
  6835. }
  6836. else {
  6837. $fields[$field] = serialize($object->$field);
  6838. }
  6839. // Type cast to proper datatype, except when the value is NULL and the
  6840. // column allows this.
  6841. //
  6842. // MySQL PDO silently casts e.g. FALSE and '' to 0 when inserting the value
  6843. // into an integer column, but PostgreSQL PDO does not. Also type cast NULL
  6844. // when the column does not allow this.
  6845. if (isset($object->$field) || !empty($info['not null'])) {
  6846. if ($info['type'] == 'int' || $info['type'] == 'serial') {
  6847. $fields[$field] = (int) $fields[$field];
  6848. }
  6849. elseif ($info['type'] == 'float') {
  6850. $fields[$field] = (float) $fields[$field];
  6851. }
  6852. else {
  6853. $fields[$field] = (string) $fields[$field];
  6854. }
  6855. }
  6856. }
  6857. if (empty($fields)) {
  6858. return;
  6859. }
  6860. // Build the SQL.
  6861. if (empty($primary_keys)) {
  6862. // We are doing an insert.
  6863. $options = array('return' => Database::RETURN_INSERT_ID);
  6864. if (isset($serial) && isset($fields[$serial])) {
  6865. // If the serial column has been explicitly set with an ID, then we don't
  6866. // require the database to return the last insert id.
  6867. if ($fields[$serial]) {
  6868. $options['return'] = Database::RETURN_AFFECTED;
  6869. }
  6870. // If a serial column does exist with no value (i.e. 0) then remove it as
  6871. // the database will insert the correct value for us.
  6872. else {
  6873. unset($fields[$serial]);
  6874. }
  6875. }
  6876. $query = db_insert($table, $options)->fields($fields);
  6877. $return = SAVED_NEW;
  6878. }
  6879. else {
  6880. $query = db_update($table)->fields($fields);
  6881. foreach ($primary_keys as $key) {
  6882. $query->condition($key, $object->$key);
  6883. }
  6884. $return = SAVED_UPDATED;
  6885. }
  6886. // Execute the SQL.
  6887. if ($query_return = $query->execute()) {
  6888. if (isset($serial)) {
  6889. // If the database was not told to return the last insert id, it will be
  6890. // because we already know it.
  6891. if (isset($options) && $options['return'] != Database::RETURN_INSERT_ID) {
  6892. $object->$serial = $fields[$serial];
  6893. }
  6894. else {
  6895. $object->$serial = $query_return;
  6896. }
  6897. }
  6898. }
  6899. // If we have a single-field primary key but got no insert ID, the
  6900. // query failed. Note that we explicitly check for FALSE, because
  6901. // a valid update query which doesn't change any values will return
  6902. // zero (0) affected rows.
  6903. elseif ($query_return === FALSE && count($primary_keys) == 1) {
  6904. $return = FALSE;
  6905. }
  6906. // If we are inserting, populate empty fields with default values.
  6907. if (empty($primary_keys)) {
  6908. foreach ($schema['fields'] as $field => $info) {
  6909. if (isset($info['default']) && !property_exists($object, $field)) {
  6910. $object->$field = $info['default'];
  6911. }
  6912. }
  6913. }
  6914. // If we began with an array, convert back.
  6915. if (is_array($record)) {
  6916. $record = (array) $object;
  6917. }
  6918. return $return;
  6919. }
  6920. /**
  6921. * @} End of "addtogroup schemaapi".
  6922. */
  6923. /**
  6924. * Parses Drupal module and theme .info files.
  6925. *
  6926. * Info files are NOT for placing arbitrary theme and module-specific settings.
  6927. * Use variable_get() and variable_set() for that.
  6928. *
  6929. * Information stored in a module .info file:
  6930. * - name: The real name of the module for display purposes.
  6931. * - description: A brief description of the module.
  6932. * - dependencies: An array of dependency strings. Each is in the form
  6933. * 'project:module (versions)'; with the following meanings:
  6934. * - project: (optional) Project shortname, recommended to ensure uniqueness,
  6935. * if the module is part of a project hosted on drupal.org. If omitted,
  6936. * also omit the : that follows. The project name is currently ignored by
  6937. * Drupal core but is used for automated testing.
  6938. * - module: (required) Module shortname within the project.
  6939. * - (versions): Optional version information, consisting of one or more
  6940. * comma-separated operator/value pairs or simply version numbers, which
  6941. * can contain "x" as a wildcard. Examples: (>=7.22, <7.28), (7.x-3.x).
  6942. * - package: The name of the package of modules this module belongs to.
  6943. *
  6944. * See forum.info for an example of a module .info file.
  6945. *
  6946. * Information stored in a theme .info file:
  6947. * - name: The real name of the theme for display purposes.
  6948. * - description: Brief description.
  6949. * - screenshot: Path to screenshot relative to the theme's .info file.
  6950. * - engine: Theme engine; typically phptemplate.
  6951. * - base: Name of a base theme, if applicable; e.g., base = zen.
  6952. * - regions: Listed regions; e.g., region[left] = Left sidebar.
  6953. * - features: Features available; e.g., features[] = logo.
  6954. * - stylesheets: Theme stylesheets; e.g., stylesheets[all][] = my-style.css.
  6955. * - scripts: Theme scripts; e.g., scripts[] = my-script.js.
  6956. *
  6957. * See bartik.info for an example of a theme .info file.
  6958. *
  6959. * @param $filename
  6960. * The file we are parsing. Accepts file with relative or absolute path.
  6961. *
  6962. * @return
  6963. * The info array.
  6964. *
  6965. * @see drupal_parse_info_format()
  6966. */
  6967. function drupal_parse_info_file($filename) {
  6968. $info = &drupal_static(__FUNCTION__, array());
  6969. if (!isset($info[$filename])) {
  6970. if (!file_exists($filename)) {
  6971. $info[$filename] = array();
  6972. }
  6973. else {
  6974. $data = file_get_contents($filename);
  6975. $info[$filename] = drupal_parse_info_format($data);
  6976. }
  6977. }
  6978. return $info[$filename];
  6979. }
  6980. /**
  6981. * Parses data in Drupal's .info format.
  6982. *
  6983. * Data should be in an .ini-like format to specify values. White-space
  6984. * generally doesn't matter, except inside values:
  6985. * @code
  6986. * key = value
  6987. * key = "value"
  6988. * key = 'value'
  6989. * key = "multi-line
  6990. * value"
  6991. * key = 'multi-line
  6992. * value'
  6993. * key
  6994. * =
  6995. * 'value'
  6996. * @endcode
  6997. *
  6998. * Arrays are created using a HTTP GET alike syntax:
  6999. * @code
  7000. * key[] = "numeric array"
  7001. * key[index] = "associative array"
  7002. * key[index][] = "nested numeric array"
  7003. * key[index][index] = "nested associative array"
  7004. * @endcode
  7005. *
  7006. * PHP constants are substituted in, but only when used as the entire value.
  7007. * Comments should start with a semi-colon at the beginning of a line.
  7008. *
  7009. * @param $data
  7010. * A string to parse.
  7011. *
  7012. * @return
  7013. * The info array.
  7014. *
  7015. * @see drupal_parse_info_file()
  7016. */
  7017. function drupal_parse_info_format($data) {
  7018. $info = array();
  7019. if (preg_match_all('
  7020. @^\s* # Start at the beginning of a line, ignoring leading whitespace
  7021. ((?:
  7022. [^=;\[\]]| # Key names cannot contain equal signs, semi-colons or square brackets,
  7023. \[[^\[\]]*\] # unless they are balanced and not nested
  7024. )+?)
  7025. \s*=\s* # Key/value pairs are separated by equal signs (ignoring white-space)
  7026. (?:
  7027. ("(?:[^"]|(?<=\\\\)")*")| # Double-quoted string, which may contain slash-escaped quotes/slashes
  7028. (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
  7029. ([^\r\n]*?) # Non-quoted string
  7030. )\s*$ # Stop at the next end of a line, ignoring trailing whitespace
  7031. @msx', $data, $matches, PREG_SET_ORDER)) {
  7032. foreach ($matches as $match) {
  7033. // Fetch the key and value string.
  7034. $i = 0;
  7035. foreach (array('key', 'value1', 'value2', 'value3') as $var) {
  7036. $$var = isset($match[++$i]) ? $match[$i] : '';
  7037. }
  7038. $value = stripslashes(substr($value1, 1, -1)) . stripslashes(substr($value2, 1, -1)) . $value3;
  7039. // Parse array syntax.
  7040. $keys = preg_split('/\]?\[/', rtrim($key, ']'));
  7041. $last = array_pop($keys);
  7042. $parent = &$info;
  7043. // Create nested arrays.
  7044. foreach ($keys as $key) {
  7045. if ($key == '') {
  7046. $key = count($parent);
  7047. }
  7048. if (!isset($parent[$key]) || !is_array($parent[$key])) {
  7049. $parent[$key] = array();
  7050. }
  7051. $parent = &$parent[$key];
  7052. }
  7053. // Handle PHP constants.
  7054. if (preg_match('/^\w+$/i', $value) && defined($value)) {
  7055. $value = constant($value);
  7056. }
  7057. // Insert actual value.
  7058. if ($last == '') {
  7059. $last = count($parent);
  7060. }
  7061. $parent[$last] = $value;
  7062. }
  7063. }
  7064. return $info;
  7065. }
  7066. /**
  7067. * Returns a list of severity levels, as defined in RFC 3164.
  7068. *
  7069. * @return
  7070. * Array of the possible severity levels for log messages.
  7071. *
  7072. * @see http://www.ietf.org/rfc/rfc3164.txt
  7073. * @see watchdog()
  7074. * @ingroup logging_severity_levels
  7075. */
  7076. function watchdog_severity_levels() {
  7077. return array(
  7078. WATCHDOG_EMERGENCY => t('emergency'),
  7079. WATCHDOG_ALERT => t('alert'),
  7080. WATCHDOG_CRITICAL => t('critical'),
  7081. WATCHDOG_ERROR => t('error'),
  7082. WATCHDOG_WARNING => t('warning'),
  7083. WATCHDOG_NOTICE => t('notice'),
  7084. WATCHDOG_INFO => t('info'),
  7085. WATCHDOG_DEBUG => t('debug'),
  7086. );
  7087. }
  7088. /**
  7089. * Explodes a string of tags into an array.
  7090. *
  7091. * @see drupal_implode_tags()
  7092. */
  7093. function drupal_explode_tags($tags) {
  7094. // This regexp allows the following types of user input:
  7095. // this, "somecompany, llc", "and ""this"" w,o.rks", foo bar
  7096. $regexp = '%(?:^|,\ *)("(?>[^"]*)(?>""[^"]* )*"|(?: [^",]*))%x';
  7097. preg_match_all($regexp, $tags, $matches);
  7098. $typed_tags = array_unique($matches[1]);
  7099. $tags = array();
  7100. foreach ($typed_tags as $tag) {
  7101. // If a user has escaped a term (to demonstrate that it is a group,
  7102. // or includes a comma or quote character), we remove the escape
  7103. // formatting so to save the term into the database as the user intends.
  7104. $tag = trim(str_replace('""', '"', preg_replace('/^"(.*)"$/', '\1', $tag)));
  7105. if ($tag != "") {
  7106. $tags[] = $tag;
  7107. }
  7108. }
  7109. return $tags;
  7110. }
  7111. /**
  7112. * Implodes an array of tags into a string.
  7113. *
  7114. * @see drupal_explode_tags()
  7115. */
  7116. function drupal_implode_tags($tags) {
  7117. $encoded_tags = array();
  7118. foreach ($tags as $tag) {
  7119. // Commas and quotes in tag names are special cases, so encode them.
  7120. if (strpos($tag, ',') !== FALSE || strpos($tag, '"') !== FALSE) {
  7121. $tag = '"' . str_replace('"', '""', $tag) . '"';
  7122. }
  7123. $encoded_tags[] = $tag;
  7124. }
  7125. return implode(', ', $encoded_tags);
  7126. }
  7127. /**
  7128. * Flushes all cached data on the site.
  7129. *
  7130. * Empties cache tables, rebuilds the menu cache and theme registries, and
  7131. * invokes a hook so that other modules' cache data can be cleared as well.
  7132. */
  7133. function drupal_flush_all_caches() {
  7134. // Change query-strings on css/js files to enforce reload for all users.
  7135. _drupal_flush_css_js();
  7136. registry_rebuild();
  7137. drupal_clear_css_cache();
  7138. drupal_clear_js_cache();
  7139. // Rebuild the theme data. Note that the module data is rebuilt above, as
  7140. // part of registry_rebuild().
  7141. system_rebuild_theme_data();
  7142. drupal_theme_rebuild();
  7143. entity_info_cache_clear();
  7144. node_types_rebuild();
  7145. // node_menu() defines menu items based on node types so it needs to come
  7146. // after node types are rebuilt.
  7147. menu_rebuild();
  7148. // Synchronize to catch any actions that were added or removed.
  7149. actions_synchronize();
  7150. // Don't clear cache_form - in-progress form submissions may break.
  7151. // Ordered so clearing the page cache will always be the last action.
  7152. $core = array('cache', 'cache_path', 'cache_filter', 'cache_bootstrap', 'cache_page');
  7153. $cache_tables = array_merge(module_invoke_all('flush_caches'), $core);
  7154. foreach ($cache_tables as $table) {
  7155. cache_clear_all('*', $table, TRUE);
  7156. }
  7157. // Rebuild the bootstrap module list. We do this here so that developers
  7158. // can get new hook_boot() implementations registered without having to
  7159. // write a hook_update_N() function.
  7160. _system_update_bootstrap_status();
  7161. }
  7162. /**
  7163. * Changes the dummy query string added to all CSS and JavaScript files.
  7164. *
  7165. * Changing the dummy query string appended to CSS and JavaScript files forces
  7166. * all browsers to reload fresh files.
  7167. */
  7168. function _drupal_flush_css_js() {
  7169. // The timestamp is converted to base 36 in order to make it more compact.
  7170. variable_set('css_js_query_string', base_convert(REQUEST_TIME, 10, 36));
  7171. }
  7172. /**
  7173. * Outputs debug information.
  7174. *
  7175. * The debug information is passed on to trigger_error() after being converted
  7176. * to a string using _drupal_debug_message().
  7177. *
  7178. * @param $data
  7179. * Data to be output.
  7180. * @param $label
  7181. * Label to prefix the data.
  7182. * @param $print_r
  7183. * Flag to switch between print_r() and var_export() for data conversion to
  7184. * string. Set $print_r to TRUE when dealing with a recursive data structure
  7185. * as var_export() will generate an error.
  7186. */
  7187. function debug($data, $label = NULL, $print_r = FALSE) {
  7188. // Print $data contents to string.
  7189. $string = check_plain($print_r ? print_r($data, TRUE) : var_export($data, TRUE));
  7190. // Display values with pre-formatting to increase readability.
  7191. $string = '<pre>' . $string . '</pre>';
  7192. trigger_error(trim($label ? "$label: $string" : $string));
  7193. }
  7194. /**
  7195. * Parses a dependency for comparison by drupal_check_incompatibility().
  7196. *
  7197. * @param $dependency
  7198. * A dependency string, which specifies a module dependency, and optionally
  7199. * the project it comes from and versions that are supported. Supported
  7200. * formats include:
  7201. * - 'module'
  7202. * - 'project:module'
  7203. * - 'project:module (>=version, version)'
  7204. *
  7205. * @return
  7206. * An associative array with three keys:
  7207. * - 'name' includes the name of the thing to depend on (e.g. 'foo').
  7208. * - 'original_version' contains the original version string (which can be
  7209. * used in the UI for reporting incompatibilities).
  7210. * - 'versions' is a list of associative arrays, each containing the keys
  7211. * 'op' and 'version'. 'op' can be one of: '=', '==', '!=', '<>', '<',
  7212. * '<=', '>', or '>='. 'version' is one piece like '4.5-beta3'.
  7213. * Callers should pass this structure to drupal_check_incompatibility().
  7214. *
  7215. * @see drupal_check_incompatibility()
  7216. */
  7217. function drupal_parse_dependency($dependency) {
  7218. $value = array();
  7219. // Split out the optional project name.
  7220. if (strpos($dependency, ':')) {
  7221. list($project_name, $dependency) = explode(':', $dependency);
  7222. $value['project'] = $project_name;
  7223. }
  7224. // We use named subpatterns and support every op that version_compare
  7225. // supports. Also, op is optional and defaults to equals.
  7226. $p_op = '(?P<operation>!=|==|=|<|<=|>|>=|<>)?';
  7227. // Core version is always optional: 7.x-2.x and 2.x is treated the same.
  7228. $p_core = '(?:' . preg_quote(DRUPAL_CORE_COMPATIBILITY) . '-)?';
  7229. $p_major = '(?P<major>\d+)';
  7230. // By setting the minor version to x, branches can be matched.
  7231. $p_minor = '(?P<minor>(?:\d+|x)(?:-[A-Za-z]+\d+)?)';
  7232. $parts = explode('(', $dependency, 2);
  7233. $value['name'] = trim($parts[0]);
  7234. if (isset($parts[1])) {
  7235. $value['original_version'] = ' (' . $parts[1];
  7236. foreach (explode(',', $parts[1]) as $version) {
  7237. if (preg_match("/^\s*$p_op\s*$p_core$p_major\.$p_minor/", $version, $matches)) {
  7238. $op = !empty($matches['operation']) ? $matches['operation'] : '=';
  7239. if ($matches['minor'] == 'x') {
  7240. // Drupal considers "2.x" to mean any version that begins with
  7241. // "2" (e.g. 2.0, 2.9 are all "2.x"). PHP's version_compare(),
  7242. // on the other hand, treats "x" as a string; so to
  7243. // version_compare(), "2.x" is considered less than 2.0. This
  7244. // means that >=2.x and <2.x are handled by version_compare()
  7245. // as we need, but > and <= are not.
  7246. if ($op == '>' || $op == '<=') {
  7247. $matches['major']++;
  7248. }
  7249. // Equivalence can be checked by adding two restrictions.
  7250. if ($op == '=' || $op == '==') {
  7251. $value['versions'][] = array('op' => '<', 'version' => ($matches['major'] + 1) . '.x');
  7252. $op = '>=';
  7253. }
  7254. }
  7255. $value['versions'][] = array('op' => $op, 'version' => $matches['major'] . '.' . $matches['minor']);
  7256. }
  7257. }
  7258. }
  7259. return $value;
  7260. }
  7261. /**
  7262. * Checks whether a version is compatible with a given dependency.
  7263. *
  7264. * @param $v
  7265. * The parsed dependency structure from drupal_parse_dependency().
  7266. * @param $current_version
  7267. * The version to check against (like 4.2).
  7268. *
  7269. * @return
  7270. * NULL if compatible, otherwise the original dependency version string that
  7271. * caused the incompatibility.
  7272. *
  7273. * @see drupal_parse_dependency()
  7274. */
  7275. function drupal_check_incompatibility($v, $current_version) {
  7276. if (!empty($v['versions'])) {
  7277. foreach ($v['versions'] as $required_version) {
  7278. if ((isset($required_version['op']) && !version_compare($current_version, $required_version['version'], $required_version['op']))) {
  7279. return $v['original_version'];
  7280. }
  7281. }
  7282. }
  7283. }
  7284. /**
  7285. * Get the entity info array of an entity type.
  7286. *
  7287. * @param $entity_type
  7288. * The entity type, e.g. node, for which the info shall be returned, or NULL
  7289. * to return an array with info about all types.
  7290. *
  7291. * @see hook_entity_info()
  7292. * @see hook_entity_info_alter()
  7293. */
  7294. function entity_get_info($entity_type = NULL) {
  7295. global $language;
  7296. // Use the advanced drupal_static() pattern, since this is called very often.
  7297. static $drupal_static_fast;
  7298. if (!isset($drupal_static_fast)) {
  7299. $drupal_static_fast['entity_info'] = &drupal_static(__FUNCTION__);
  7300. }
  7301. $entity_info = &$drupal_static_fast['entity_info'];
  7302. // hook_entity_info() includes translated strings, so each language is cached
  7303. // separately.
  7304. $langcode = $language->language;
  7305. if (empty($entity_info)) {
  7306. if ($cache = cache_get("entity_info:$langcode")) {
  7307. $entity_info = $cache->data;
  7308. }
  7309. else {
  7310. $entity_info = module_invoke_all('entity_info');
  7311. // Merge in default values.
  7312. foreach ($entity_info as $name => $data) {
  7313. $entity_info[$name] += array(
  7314. 'fieldable' => FALSE,
  7315. 'controller class' => 'DrupalDefaultEntityController',
  7316. 'static cache' => TRUE,
  7317. 'field cache' => TRUE,
  7318. 'load hook' => $name . '_load',
  7319. 'bundles' => array(),
  7320. 'view modes' => array(),
  7321. 'entity keys' => array(),
  7322. 'translation' => array(),
  7323. );
  7324. $entity_info[$name]['entity keys'] += array(
  7325. 'revision' => '',
  7326. 'bundle' => '',
  7327. );
  7328. foreach ($entity_info[$name]['view modes'] as $view_mode => $view_mode_info) {
  7329. $entity_info[$name]['view modes'][$view_mode] += array(
  7330. 'custom settings' => FALSE,
  7331. );
  7332. }
  7333. // If no bundle key is provided, assume a single bundle, named after
  7334. // the entity type.
  7335. if (empty($entity_info[$name]['entity keys']['bundle']) && empty($entity_info[$name]['bundles'])) {
  7336. $entity_info[$name]['bundles'] = array($name => array('label' => $entity_info[$name]['label']));
  7337. }
  7338. // Prepare entity schema fields SQL info for
  7339. // DrupalEntityControllerInterface::buildQuery().
  7340. if (isset($entity_info[$name]['base table'])) {
  7341. $entity_info[$name]['base table field types'] = drupal_schema_field_types($entity_info[$name]['base table']);
  7342. $entity_info[$name]['schema_fields_sql']['base table'] = drupal_schema_fields_sql($entity_info[$name]['base table']);
  7343. if (isset($entity_info[$name]['revision table'])) {
  7344. $entity_info[$name]['schema_fields_sql']['revision table'] = drupal_schema_fields_sql($entity_info[$name]['revision table']);
  7345. }
  7346. }
  7347. }
  7348. // Let other modules alter the entity info.
  7349. drupal_alter('entity_info', $entity_info);
  7350. cache_set("entity_info:$langcode", $entity_info);
  7351. }
  7352. }
  7353. if (empty($entity_type)) {
  7354. return $entity_info;
  7355. }
  7356. elseif (isset($entity_info[$entity_type])) {
  7357. return $entity_info[$entity_type];
  7358. }
  7359. }
  7360. /**
  7361. * Resets the cached information about entity types.
  7362. */
  7363. function entity_info_cache_clear() {
  7364. drupal_static_reset('entity_get_info');
  7365. // Clear all languages.
  7366. cache_clear_all('entity_info:', 'cache', TRUE);
  7367. }
  7368. /**
  7369. * Helper function to extract id, vid, and bundle name from an entity.
  7370. *
  7371. * @param $entity_type
  7372. * The entity type; e.g. 'node' or 'user'.
  7373. * @param $entity
  7374. * The entity from which to extract values.
  7375. *
  7376. * @return
  7377. * A numerically indexed array (not a hash table) containing these
  7378. * elements:
  7379. * - 0: Primary ID of the entity.
  7380. * - 1: Revision ID of the entity, or NULL if $entity_type is not versioned.
  7381. * - 2: Bundle name of the entity, or NULL if $entity_type has no bundles.
  7382. */
  7383. function entity_extract_ids($entity_type, $entity) {
  7384. $info = entity_get_info($entity_type);
  7385. // Objects being created might not have id/vid yet.
  7386. $id = isset($entity->{$info['entity keys']['id']}) ? $entity->{$info['entity keys']['id']} : NULL;
  7387. $vid = ($info['entity keys']['revision'] && isset($entity->{$info['entity keys']['revision']})) ? $entity->{$info['entity keys']['revision']} : NULL;
  7388. if (!empty($info['entity keys']['bundle'])) {
  7389. // Explicitly fail for malformed entities missing the bundle property.
  7390. if (!isset($entity->{$info['entity keys']['bundle']}) || $entity->{$info['entity keys']['bundle']} === '') {
  7391. throw new EntityMalformedException(t('Missing bundle property on entity of type @entity_type.', array('@entity_type' => $entity_type)));
  7392. }
  7393. $bundle = $entity->{$info['entity keys']['bundle']};
  7394. }
  7395. else {
  7396. // The entity type provides no bundle key: assume a single bundle, named
  7397. // after the entity type.
  7398. $bundle = $entity_type;
  7399. }
  7400. return array($id, $vid, $bundle);
  7401. }
  7402. /**
  7403. * Helper function to assemble an object structure with initial ids.
  7404. *
  7405. * This function can be seen as reciprocal to entity_extract_ids().
  7406. *
  7407. * @param $entity_type
  7408. * The entity type; e.g. 'node' or 'user'.
  7409. * @param $ids
  7410. * A numerically indexed array, as returned by entity_extract_ids().
  7411. *
  7412. * @return
  7413. * An entity structure, initialized with the ids provided.
  7414. *
  7415. * @see entity_extract_ids()
  7416. */
  7417. function entity_create_stub_entity($entity_type, $ids) {
  7418. $entity = new stdClass();
  7419. $info = entity_get_info($entity_type);
  7420. $entity->{$info['entity keys']['id']} = $ids[0];
  7421. if (!empty($info['entity keys']['revision']) && isset($ids[1])) {
  7422. $entity->{$info['entity keys']['revision']} = $ids[1];
  7423. }
  7424. if (!empty($info['entity keys']['bundle']) && isset($ids[2])) {
  7425. $entity->{$info['entity keys']['bundle']} = $ids[2];
  7426. }
  7427. return $entity;
  7428. }
  7429. /**
  7430. * Load entities from the database.
  7431. *
  7432. * The entities are stored in a static memory cache, and will not require
  7433. * database access if loaded again during the same page request.
  7434. *
  7435. * The actual loading is done through a class that has to implement the
  7436. * DrupalEntityControllerInterface interface. By default,
  7437. * DrupalDefaultEntityController is used. Entity types can specify that a
  7438. * different class should be used by setting the 'controller class' key in
  7439. * hook_entity_info(). These classes can either implement the
  7440. * DrupalEntityControllerInterface interface, or, most commonly, extend the
  7441. * DrupalDefaultEntityController class. See node_entity_info() and the
  7442. * NodeController in node.module as an example.
  7443. *
  7444. * @param $entity_type
  7445. * The entity type to load, e.g. node or user.
  7446. * @param $ids
  7447. * An array of entity IDs, or FALSE to load all entities.
  7448. * @param $conditions
  7449. * (deprecated) An associative array of conditions on the base table, where
  7450. * the keys are the database fields and the values are the values those
  7451. * fields must have. Instead, it is preferable to use EntityFieldQuery to
  7452. * retrieve a list of entity IDs loadable by this function.
  7453. * @param $reset
  7454. * Whether to reset the internal cache for the requested entity type.
  7455. *
  7456. * @return
  7457. * An array of entity objects indexed by their ids. When no results are
  7458. * found, an empty array is returned.
  7459. *
  7460. * @todo Remove $conditions in Drupal 8.
  7461. *
  7462. * @see hook_entity_info()
  7463. * @see DrupalEntityControllerInterface
  7464. * @see DrupalDefaultEntityController
  7465. * @see EntityFieldQuery
  7466. */
  7467. function entity_load($entity_type, $ids = FALSE, $conditions = array(), $reset = FALSE) {
  7468. if ($reset) {
  7469. entity_get_controller($entity_type)->resetCache();
  7470. }
  7471. return entity_get_controller($entity_type)->load($ids, $conditions);
  7472. }
  7473. /**
  7474. * Loads the unchanged, i.e. not modified, entity from the database.
  7475. *
  7476. * Unlike entity_load() this function ensures the entity is directly loaded from
  7477. * the database, thus bypassing any static cache. In particular, this function
  7478. * is useful to determine changes by comparing the entity being saved to the
  7479. * stored entity.
  7480. *
  7481. * @param $entity_type
  7482. * The entity type to load, e.g. node or user.
  7483. * @param $id
  7484. * The ID of the entity to load.
  7485. *
  7486. * @return
  7487. * The unchanged entity, or FALSE if the entity cannot be loaded.
  7488. */
  7489. function entity_load_unchanged($entity_type, $id) {
  7490. entity_get_controller($entity_type)->resetCache(array($id));
  7491. $result = entity_get_controller($entity_type)->load(array($id));
  7492. return reset($result);
  7493. }
  7494. /**
  7495. * Gets the entity controller for an entity type.
  7496. *
  7497. * @return DrupalEntityControllerInterface
  7498. * The entity controller object for the specified entity type.
  7499. */
  7500. function entity_get_controller($entity_type) {
  7501. $controllers = &drupal_static(__FUNCTION__, array());
  7502. if (!isset($controllers[$entity_type])) {
  7503. $type_info = entity_get_info($entity_type);
  7504. $class = $type_info['controller class'];
  7505. $controllers[$entity_type] = new $class($entity_type);
  7506. }
  7507. return $controllers[$entity_type];
  7508. }
  7509. /**
  7510. * Invoke hook_entity_prepare_view().
  7511. *
  7512. * If adding a new entity similar to nodes, comments or users, you should
  7513. * invoke this function during the ENTITY_build_content() or
  7514. * ENTITY_view_multiple() phases of rendering to allow other modules to alter
  7515. * the objects during this phase. This is needed for situations where
  7516. * information needs to be loaded outside of ENTITY_load() - particularly
  7517. * when loading entities into one another - i.e. a user object into a node, due
  7518. * to the potential for unwanted side-effects such as caching and infinite
  7519. * recursion. By convention, entity_prepare_view() is called after
  7520. * field_attach_prepare_view() to allow entity level hooks to act on content
  7521. * loaded by field API.
  7522. *
  7523. * @param $entity_type
  7524. * The type of entity, i.e. 'node', 'user'.
  7525. * @param $entities
  7526. * The entity objects which are being prepared for view, keyed by object ID.
  7527. * @param $langcode
  7528. * (optional) A language code to be used for rendering. Defaults to the global
  7529. * content language of the current request.
  7530. *
  7531. * @see hook_entity_prepare_view()
  7532. */
  7533. function entity_prepare_view($entity_type, $entities, $langcode = NULL) {
  7534. if (!isset($langcode)) {
  7535. $langcode = $GLOBALS['language_content']->language;
  7536. }
  7537. // To ensure hooks are only run once per entity, check for an
  7538. // entity_view_prepared flag and only process items without it.
  7539. // @todo: resolve this more generally for both entity and field level hooks.
  7540. $prepare = array();
  7541. foreach ($entities as $id => $entity) {
  7542. if (empty($entity->entity_view_prepared)) {
  7543. // Add this entity to the items to be prepared.
  7544. $prepare[$id] = $entity;
  7545. // Mark this item as prepared.
  7546. $entity->entity_view_prepared = TRUE;
  7547. }
  7548. }
  7549. if (!empty($prepare)) {
  7550. module_invoke_all('entity_prepare_view', $prepare, $entity_type, $langcode);
  7551. }
  7552. }
  7553. /**
  7554. * Invoke hook_entity_view_mode_alter().
  7555. *
  7556. * If adding a new entity similar to nodes, comments or users, you should invoke
  7557. * this function during the ENTITY_build_content() or ENTITY_view_multiple()
  7558. * phases of rendering to allow other modules to alter the view mode during this
  7559. * phase. This function needs to be called before field_attach_prepare_view() to
  7560. * ensure that the correct content is loaded by field API.
  7561. *
  7562. * @param $entity_type
  7563. * The type of entity, i.e. 'node', 'user'.
  7564. * @param $entities
  7565. * The entity objects which are being prepared for view, keyed by object ID.
  7566. * @param $view_mode
  7567. * The original view mode e.g. 'full', 'teaser'...
  7568. * @param $langcode
  7569. * (optional) A language code to be used for rendering. Defaults to the global
  7570. * content language of the current request.
  7571. * @return
  7572. * An associative array with arrays of entities keyed by view mode.
  7573. *
  7574. * @see hook_entity_view_mode_alter()
  7575. */
  7576. function entity_view_mode_prepare($entity_type, $entities, $view_mode, $langcode = NULL) {
  7577. if (!isset($langcode)) {
  7578. $langcode = $GLOBALS['language_content']->language;
  7579. }
  7580. // To ensure hooks are never run after field_attach_prepare_view() only
  7581. // process items without the entity_view_prepared flag.
  7582. $entities_by_view_mode = array();
  7583. foreach ($entities as $id => $entity) {
  7584. $entity_view_mode = $view_mode;
  7585. if (empty($entity->entity_view_prepared)) {
  7586. // Allow modules to change the view mode.
  7587. $context = array(
  7588. 'entity_type' => $entity_type,
  7589. 'entity' => $entity,
  7590. 'langcode' => $langcode,
  7591. );
  7592. drupal_alter('entity_view_mode', $entity_view_mode, $context);
  7593. }
  7594. $entities_by_view_mode[$entity_view_mode][$id] = $entity;
  7595. }
  7596. return $entities_by_view_mode;
  7597. }
  7598. /**
  7599. * Returns the URI elements of an entity.
  7600. *
  7601. * @param $entity_type
  7602. * The entity type; e.g. 'node' or 'user'.
  7603. * @param $entity
  7604. * The entity for which to generate a path.
  7605. * @return
  7606. * An array containing the 'path' and 'options' keys used to build the URI of
  7607. * the entity, and matching the signature of url(). NULL if the entity has no
  7608. * URI of its own.
  7609. */
  7610. function entity_uri($entity_type, $entity) {
  7611. $info = entity_get_info($entity_type);
  7612. list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
  7613. // A bundle-specific callback takes precedence over the generic one for the
  7614. // entity type.
  7615. if (isset($info['bundles'][$bundle]['uri callback'])) {
  7616. $uri_callback = $info['bundles'][$bundle]['uri callback'];
  7617. }
  7618. elseif (isset($info['uri callback'])) {
  7619. $uri_callback = $info['uri callback'];
  7620. }
  7621. else {
  7622. return NULL;
  7623. }
  7624. // Invoke the callback to get the URI. If there is no callback, return NULL.
  7625. if (isset($uri_callback) && function_exists($uri_callback)) {
  7626. $uri = $uri_callback($entity);
  7627. // Pass the entity data to url() so that alter functions do not need to
  7628. // lookup this entity again.
  7629. $uri['options']['entity_type'] = $entity_type;
  7630. $uri['options']['entity'] = $entity;
  7631. return $uri;
  7632. }
  7633. }
  7634. /**
  7635. * Returns the label of an entity.
  7636. *
  7637. * See the 'label callback' component of the hook_entity_info() return value
  7638. * for more information.
  7639. *
  7640. * @param $entity_type
  7641. * The entity type; e.g., 'node' or 'user'.
  7642. * @param $entity
  7643. * The entity for which to generate the label.
  7644. *
  7645. * @return
  7646. * The entity label, or FALSE if not found.
  7647. */
  7648. function entity_label($entity_type, $entity) {
  7649. $label = FALSE;
  7650. $info = entity_get_info($entity_type);
  7651. if (isset($info['label callback']) && function_exists($info['label callback'])) {
  7652. $label = $info['label callback']($entity, $entity_type);
  7653. }
  7654. elseif (!empty($info['entity keys']['label']) && isset($entity->{$info['entity keys']['label']})) {
  7655. $label = $entity->{$info['entity keys']['label']};
  7656. }
  7657. return $label;
  7658. }
  7659. /**
  7660. * Returns the language of an entity.
  7661. *
  7662. * @param $entity_type
  7663. * The entity type; e.g., 'node' or 'user'.
  7664. * @param $entity
  7665. * The entity for which to get the language.
  7666. *
  7667. * @return
  7668. * A valid language code or NULL if the entity has no language support.
  7669. */
  7670. function entity_language($entity_type, $entity) {
  7671. $info = entity_get_info($entity_type);
  7672. // Invoke the callback to get the language. If there is no callback, try to
  7673. // get it from a property of the entity, otherwise NULL.
  7674. if (isset($info['language callback']) && function_exists($info['language callback'])) {
  7675. $langcode = $info['language callback']($entity_type, $entity);
  7676. }
  7677. elseif (!empty($info['entity keys']['language']) && isset($entity->{$info['entity keys']['language']})) {
  7678. $langcode = $entity->{$info['entity keys']['language']};
  7679. }
  7680. else {
  7681. // The value returned in D8 would be LANGUAGE_NONE, we cannot use it here to
  7682. // preserve backward compatibility. In fact this function has been
  7683. // introduced very late in the D7 life cycle, mainly as the proper default
  7684. // for field_attach_form(). By returning LANGUAGE_NONE when no language
  7685. // information is available, we would introduce a potentially BC-breaking
  7686. // API change, since field_attach_form() defaults to the default language
  7687. // instead of LANGUAGE_NONE. Moreover this allows us to distinguish between
  7688. // entities that have no language specified from ones that do not have
  7689. // language support at all.
  7690. $langcode = NULL;
  7691. }
  7692. return $langcode;
  7693. }
  7694. /**
  7695. * Attaches field API validation to entity forms.
  7696. */
  7697. function entity_form_field_validate($entity_type, $form, &$form_state) {
  7698. // All field attach API functions act on an entity object, but during form
  7699. // validation, we don't have one. $form_state contains the entity as it was
  7700. // prior to processing the current form submission, and we must not update it
  7701. // until we have fully validated the submitted input. Therefore, for
  7702. // validation, act on a pseudo entity created out of the form values.
  7703. $pseudo_entity = (object) $form_state['values'];
  7704. field_attach_form_validate($entity_type, $pseudo_entity, $form, $form_state);
  7705. }
  7706. /**
  7707. * Copies submitted values to entity properties for simple entity forms.
  7708. *
  7709. * During the submission handling of an entity form's "Save", "Preview", and
  7710. * possibly other buttons, the form state's entity needs to be updated with the
  7711. * submitted form values. Each entity form implements its own builder function
  7712. * for doing this, appropriate for the particular entity and form, whereas
  7713. * modules may specify additional builder functions in $form['#entity_builders']
  7714. * for copying the form values of added form elements to entity properties.
  7715. * Many of the main entity builder functions can call this helper function to
  7716. * re-use its logic of copying $form_state['values'][PROPERTY] values to
  7717. * $entity->PROPERTY for all entries in $form_state['values'] that are not field
  7718. * data, and calling field_attach_submit() to copy field data. Apart from that
  7719. * this helper invokes any additional builder functions that have been specified
  7720. * in $form['#entity_builders'].
  7721. *
  7722. * For some entity forms (e.g., forms with complex non-field data and forms that
  7723. * simultaneously edit multiple entities), this behavior may be inappropriate,
  7724. * so the builder function for such forms needs to implement the required
  7725. * functionality instead of calling this function.
  7726. */
  7727. function entity_form_submit_build_entity($entity_type, $entity, $form, &$form_state) {
  7728. $info = entity_get_info($entity_type);
  7729. list(, , $bundle) = entity_extract_ids($entity_type, $entity);
  7730. // Copy top-level form values that are not for fields to entity properties,
  7731. // without changing existing entity properties that are not being edited by
  7732. // this form. Copying field values must be done using field_attach_submit().
  7733. $values_excluding_fields = $info['fieldable'] ? array_diff_key($form_state['values'], field_info_instances($entity_type, $bundle)) : $form_state['values'];
  7734. foreach ($values_excluding_fields as $key => $value) {
  7735. $entity->$key = $value;
  7736. }
  7737. // Invoke all specified builders for copying form values to entity properties.
  7738. if (isset($form['#entity_builders'])) {
  7739. foreach ($form['#entity_builders'] as $function) {
  7740. $function($entity_type, $entity, $form, $form_state);
  7741. }
  7742. }
  7743. // Copy field values to the entity.
  7744. if ($info['fieldable']) {
  7745. field_attach_submit($entity_type, $entity, $form, $form_state);
  7746. }
  7747. }
  7748. /**
  7749. * Performs one or more XML-RPC request(s).
  7750. *
  7751. * Usage example:
  7752. * @code
  7753. * $result = xmlrpc('http://example.com/xmlrpc.php', array(
  7754. * 'service.methodName' => array($parameter, $second, $third),
  7755. * ));
  7756. * @endcode
  7757. *
  7758. * @param $url
  7759. * An absolute URL of the XML-RPC endpoint.
  7760. * @param $args
  7761. * An associative array whose keys are the methods to call and whose values
  7762. * are the arguments to pass to the respective method. If multiple methods
  7763. * are specified, a system.multicall is performed.
  7764. * @param $options
  7765. * (optional) An array of options to pass along to drupal_http_request().
  7766. *
  7767. * @return
  7768. * For one request:
  7769. * Either the return value of the method on success, or FALSE.
  7770. * If FALSE is returned, see xmlrpc_errno() and xmlrpc_error_msg().
  7771. * For multiple requests:
  7772. * An array of results. Each result will either be the result
  7773. * returned by the method called, or an xmlrpc_error object if the call
  7774. * failed. See xmlrpc_error().
  7775. */
  7776. function xmlrpc($url, $args, $options = array()) {
  7777. require_once DRUPAL_ROOT . '/includes/xmlrpc.inc';
  7778. return _xmlrpc($url, $args, $options);
  7779. }
  7780. /**
  7781. * Retrieves a list of all available archivers.
  7782. *
  7783. * @see hook_archiver_info()
  7784. * @see hook_archiver_info_alter()
  7785. */
  7786. function archiver_get_info() {
  7787. $archiver_info = &drupal_static(__FUNCTION__, array());
  7788. if (empty($archiver_info)) {
  7789. $cache = cache_get('archiver_info');
  7790. if ($cache === FALSE) {
  7791. // Rebuild the cache and save it.
  7792. $archiver_info = module_invoke_all('archiver_info');
  7793. drupal_alter('archiver_info', $archiver_info);
  7794. uasort($archiver_info, 'drupal_sort_weight');
  7795. cache_set('archiver_info', $archiver_info);
  7796. }
  7797. else {
  7798. $archiver_info = $cache->data;
  7799. }
  7800. }
  7801. return $archiver_info;
  7802. }
  7803. /**
  7804. * Returns a string of supported archive extensions.
  7805. *
  7806. * @return
  7807. * A space-separated string of extensions suitable for use by the file
  7808. * validation system.
  7809. */
  7810. function archiver_get_extensions() {
  7811. $valid_extensions = array();
  7812. foreach (archiver_get_info() as $archive) {
  7813. foreach ($archive['extensions'] as $extension) {
  7814. foreach (explode('.', $extension) as $part) {
  7815. if (!in_array($part, $valid_extensions)) {
  7816. $valid_extensions[] = $part;
  7817. }
  7818. }
  7819. }
  7820. }
  7821. return implode(' ', $valid_extensions);
  7822. }
  7823. /**
  7824. * Creates the appropriate archiver for the specified file.
  7825. *
  7826. * @param $file
  7827. * The full path of the archive file. Note that stream wrapper paths are
  7828. * supported, but not remote ones.
  7829. *
  7830. * @return
  7831. * A newly created instance of the archiver class appropriate
  7832. * for the specified file, already bound to that file.
  7833. * If no appropriate archiver class was found, will return FALSE.
  7834. */
  7835. function archiver_get_archiver($file) {
  7836. // Archivers can only work on local paths
  7837. $filepath = drupal_realpath($file);
  7838. if (!is_file($filepath)) {
  7839. throw new Exception(t('Archivers can only operate on local files: %file not supported', array('%file' => $file)));
  7840. }
  7841. $archiver_info = archiver_get_info();
  7842. foreach ($archiver_info as $implementation) {
  7843. foreach ($implementation['extensions'] as $extension) {
  7844. // Because extensions may be multi-part, such as .tar.gz,
  7845. // we cannot use simpler approaches like substr() or pathinfo().
  7846. // This method isn't quite as clean but gets the job done.
  7847. // Also note that the file may not yet exist, so we cannot rely
  7848. // on fileinfo() or other disk-level utilities.
  7849. if (strrpos($filepath, '.' . $extension) === strlen($filepath) - strlen('.' . $extension)) {
  7850. return new $implementation['class']($filepath);
  7851. }
  7852. }
  7853. }
  7854. }
  7855. /**
  7856. * Assembles the Drupal Updater registry.
  7857. *
  7858. * An Updater is a class that knows how to update various parts of the Drupal
  7859. * file system, for example to update modules that have newer releases, or to
  7860. * install a new theme.
  7861. *
  7862. * @return
  7863. * The Drupal Updater class registry.
  7864. *
  7865. * @see hook_updater_info()
  7866. * @see hook_updater_info_alter()
  7867. */
  7868. function drupal_get_updaters() {
  7869. $updaters = &drupal_static(__FUNCTION__);
  7870. if (!isset($updaters)) {
  7871. $updaters = module_invoke_all('updater_info');
  7872. drupal_alter('updater_info', $updaters);
  7873. uasort($updaters, 'drupal_sort_weight');
  7874. }
  7875. return $updaters;
  7876. }
  7877. /**
  7878. * Assembles the Drupal FileTransfer registry.
  7879. *
  7880. * @return
  7881. * The Drupal FileTransfer class registry.
  7882. *
  7883. * @see FileTransfer
  7884. * @see hook_filetransfer_info()
  7885. * @see hook_filetransfer_info_alter()
  7886. */
  7887. function drupal_get_filetransfer_info() {
  7888. $info = &drupal_static(__FUNCTION__);
  7889. if (!isset($info)) {
  7890. // Since we have to manually set the 'file path' default for each
  7891. // module separately, we can't use module_invoke_all().
  7892. $info = array();
  7893. foreach (module_implements('filetransfer_info') as $module) {
  7894. $function = $module . '_filetransfer_info';
  7895. if (function_exists($function)) {
  7896. $result = $function();
  7897. if (isset($result) && is_array($result)) {
  7898. foreach ($result as &$values) {
  7899. if (empty($values['file path'])) {
  7900. $values['file path'] = drupal_get_path('module', $module);
  7901. }
  7902. }
  7903. $info = array_merge_recursive($info, $result);
  7904. }
  7905. }
  7906. }
  7907. drupal_alter('filetransfer_info', $info);
  7908. uasort($info, 'drupal_sort_weight');
  7909. }
  7910. return $info;
  7911. }

Functions

Namesort descending Description
archiver_get_archiver Creates the appropriate archiver for the specified file.
archiver_get_extensions Returns a string of supported archive extensions.
archiver_get_info Retrieves a list of all available archivers.
base_path Returns the base URL path (i.e., directory) of the Drupal installation.
check_url Strips dangerous protocols from a URI and encodes it for output to HTML.
date_iso8601 Returns an ISO8601 formatted date based on the given date.
debug Outputs debug information.
drupal_access_denied Delivers an "access denied" error to the browser.
drupal_add_css Adds a cascading stylesheet to the stylesheet queue.
drupal_add_feed Adds a feed URL for the current page.
drupal_add_html_head Adds output to the HEAD tag of the HTML page.
drupal_add_html_head_link Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
drupal_add_js Adds a JavaScript file, setting, or inline code to the page.
drupal_add_library Adds multiple JavaScript or CSS files at the same time.
drupal_add_region_content Adds content to a specified region.
drupal_add_tabledrag Assists in adding the tableDrag JavaScript behavior to a themed table.
drupal_aggregate_css Default callback to aggregate CSS files and inline content.
drupal_array_diff_assoc_recursive Recursively computes the difference of arrays with additional index check.
drupal_array_get_nested_value Retrieves a value from a nested array with variable depth.
drupal_array_nested_key_exists Determines whether a nested array contains the requested keys.
drupal_array_set_nested_value Sets a value in a nested array with variable depth.
drupal_attributes Converts an associative array to an XML/HTML tag attribute string.
drupal_build_css_cache Aggregates and optimizes CSS files into a cache file in the files directory.
drupal_build_js_cache Aggregates JavaScript files into a cache file in the files directory.
drupal_check_incompatibility Checks whether a version is compatible with a given dependency.
drupal_clean_css_identifier Prepares a string for use as a CSS identifier (element, class, or ID name).
drupal_clear_css_cache Deletes old cached CSS files.
drupal_clear_js_cache Deletes old cached JavaScript files and variables.
drupal_common_theme Provides theme registration for themes across .inc files.
drupal_cron_cleanup DEPRECATED: Shutdown function: Performs cron cleanup.
drupal_cron_run Executes a cron run when called.
drupal_delete_file_if_stale Callback to delete files modified more than a set time ago.
drupal_deliver_html_page Packages and sends the result of a page callback to the browser as HTML.
drupal_deliver_page Delivers a page callback result to the browser in the appropriate format.
drupal_encode_path Encodes a Drupal path for use in a URL.
drupal_exit Performs end-of-request tasks.
drupal_explode_tags Explodes a string of tags into an array.
drupal_flush_all_caches Flushes all cached data on the site.
drupal_get_breadcrumb Gets the breadcrumb trail for the current page.
drupal_get_css Returns a themed representation of all stylesheets to attach to the page.
drupal_get_destination Prepares a 'destination' URL query parameter for use with drupal_goto().
drupal_get_feeds Gets the feed URLs for the current page.
drupal_get_filetransfer_info Assembles the Drupal FileTransfer registry.
drupal_get_html_head Retrieves output to be displayed in the HEAD tag of the HTML page.
drupal_get_js Returns a themed presentation of all JavaScript code for the current page.
drupal_get_library Retrieves information for a JavaScript/CSS library.
drupal_get_path Returns the path to a system item (module, theme, etc.).
drupal_get_private_key Ensures the private key variable used to generate tokens is set.
drupal_get_profile Gets the name of the currently active installation profile.
drupal_get_query_array Splits a URL-encoded query string into an array.
drupal_get_query_parameters Processes a URL query parameter array to remove unwanted elements.
drupal_get_rdf_namespaces Returns a string containing RDF namespace declarations for use in XML and XHTML output.
drupal_get_region_content Gets assigned content for a given region.
drupal_get_schema_unprocessed Returns the unprocessed and unaltered version of a module's schema.
drupal_get_token Generates a token based on $value, the user session, and the private key.
drupal_get_updaters Assembles the Drupal Updater registry.
drupal_goto Sends the user to a different page.
drupal_group_css Default callback to group CSS items.
drupal_html_class Prepares a string for use as a valid class name.
drupal_html_id Prepares a string for use as a valid HTML ID and guarantees uniqueness.
drupal_http_build_query Parses an array into a valid, rawurlencoded query string.
drupal_http_header_attributes Formats an attribute string for an HTTP header.
drupal_http_request Performs an HTTP request.
drupal_implode_tags Implodes an array of tags into a string.
drupal_install_schema Creates all tables defined in a module's hook_schema().
drupal_json_decode Converts an HTML-safe JSON string into its PHP equivalent.
drupal_json_encode Converts a PHP variable into its JavaScript equivalent.
drupal_json_output Returns data in JSON format.
drupal_js_defaults Constructs an array of the defaults that are used for JavaScript items.
drupal_load_stylesheet Loads the stylesheet and resolves all @import commands.
drupal_load_stylesheet_content Processes the contents of a stylesheet for aggregation.
drupal_map_assoc Forms an associative array from a linear array.
drupal_not_found Delivers a "page not found" error to the browser.
drupal_page_footer Performs end-of-request tasks.
drupal_page_set_cache Stores the current page in the cache.
drupal_parse_dependency Parses a dependency for comparison by drupal_check_incompatibility().
drupal_parse_info_file Parses Drupal module and theme .info files.
drupal_parse_info_format Parses data in Drupal's .info format.
drupal_parse_url Parses a URL string into its path, query, and fragment components.
drupal_pre_render_conditional_comments #pre_render callback to render #browsers into #prefix and #suffix.
drupal_pre_render_link #pre_render callback to render a link into #markup.
drupal_pre_render_links #pre_render callback that collects child links into a single array.
drupal_pre_render_markup #pre_render callback to append contents in #markup to #children.
drupal_pre_render_styles #pre_render callback to add the elements needed for CSS tags to be rendered.
drupal_process_attached Adds attachments to a render() structure.
drupal_process_states Adds JavaScript to change the state of an element based on another element.
drupal_region_class Provides a standard HTML class name that identifies a page region.
drupal_render Renders HTML given a structured array tree.
drupal_render_cache_by_query Prepares an element for caching based on a query.
drupal_render_cache_get Gets the rendered output of a renderable element from the cache.
drupal_render_cache_set Caches the rendered output of a renderable element.
drupal_render_children Renders children of an element and concatenates them.
drupal_render_cid_create Creates the cache ID for a renderable element.
drupal_render_cid_parts Returns cache ID parts for building a cache ID.
drupal_render_collect_attached Collects #attached for an element and its children into a single array.
drupal_render_page Renders the page, including all theming.
drupal_schema_fields_sql Retrieves a list of fields from a table schema.
drupal_schema_field_types Retrieves the type for every field in a table schema.
drupal_set_breadcrumb Sets the breadcrumb trail for the current page.
drupal_set_page_content Sets the main page content value for later use.
drupal_set_time_limit Attempts to set the PHP maximum execution time.
drupal_site_offline Delivers a "site is under maintenance" message to the browser.
drupal_sort_css_js Sorts CSS and JavaScript resources.
drupal_sort_title Array sorting callback; sorts elements by 'title' key.
drupal_sort_weight Sorts a structured array by the 'weight' element.
drupal_strip_dangerous_protocols Strips dangerous protocols (e.g. 'javascript:') from a URI.
drupal_system_listing Returns information about system object files (modules, themes, etc.).
drupal_uninstall_schema Removes all tables defined in a module's hook_schema().
drupal_valid_token Validates a token based on $value, the user session, and the private key.
drupal_write_record Saves (inserts or updates) a record to the database based upon the schema.
element_child Checks if the key is a child.
element_children Identifies the children of an element array, optionally sorted by weight.
element_get_visible_children Returns the visible children of an element.
element_info Retrieves the default properties for the defined element type.
element_info_property Retrieves a single property for the defined element type.
element_properties Gets properties of a structured array element (keys beginning with '#').
element_property Checks if the key is a property.
element_set_attributes Sets HTML attributes based on element properties.
element_sort Function used by uasort to sort structured arrays by weight.
element_sort_by_title Array sorting callback; sorts elements by title.
entity_create_stub_entity Helper function to assemble an object structure with initial ids.
entity_extract_ids Helper function to extract id, vid, and bundle name from an entity.
entity_form_field_validate Attaches field API validation to entity forms.
entity_form_submit_build_entity Copies submitted values to entity properties for simple entity forms.
entity_get_controller Gets the entity controller for an entity type.
entity_get_info Get the entity info array of an entity type.
entity_info_cache_clear Resets the cached information about entity types.
entity_label Returns the label of an entity.
entity_language Returns the language of an entity.
entity_load Load entities from the database.
entity_load_unchanged Loads the unchanged, i.e. not modified, entity from the database.
entity_prepare_view Invoke hook_entity_prepare_view().
entity_uri Returns the URI elements of an entity.
entity_view_mode_prepare Invoke hook_entity_view_mode_alter().
filter_xss Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
filter_xss_admin Applies a very permissive XSS/HTML filter for admin-only use.
filter_xss_bad_protocol Processes an HTML attribute value and strips dangerous protocols from URLs.
fix_gpc_magic Fixes double-escaping caused by "magic quotes" in some PHP installations.
flood_clear_event Makes the flood control mechanism forget an event for the current visitor.
flood_is_allowed Checks whether a user is allowed to proceed with the specified event.
flood_register_event Registers an event for the current visitor to the flood control mechanism.
format_date Formats a date, using a date type or a custom date format string.
format_interval Formats a time interval with the requested granularity.
format_plural Formats a string containing a count of items.
format_rss_channel Formats an RSS channel.
format_rss_item Formats a single RSS item.
format_size Generates a string representation for the given byte count.
format_username Format a username.
format_xml_elements Formats XML elements.
hide Hides an element from later rendering.
l Formats an internal or external URL link as an HTML anchor tag.
parse_size