Projet

Général

Profil

Paste
Télécharger (305 ko) Statistiques
| Branche: | Révision:

root / drupal7 / includes / common.inc @ 582db59d

1
<?php
2

    
3
/**
4
 * @file
5
 * Common functions that many Drupal modules will need to reference.
6
 *
7
 * The functions that are critical and need to be available even when serving
8
 * a cached page are instead located in bootstrap.inc.
9
 */
10

    
11
/**
12
 * @defgroup php_wrappers PHP wrapper functions
13
 * @{
14
 * Functions that are wrappers or custom implementations of PHP functions.
15
 *
16
 * Certain PHP functions should not be used in Drupal. Instead, Drupal's
17
 * replacement functions should be used.
18
 *
19
 * For example, for improved or more secure UTF8-handling, or RFC-compliant
20
 * handling of URLs in Drupal.
21
 *
22
 * For ease of use and memorizing, all these wrapper functions use the same name
23
 * as the original PHP function, but prefixed with "drupal_". Beware, however,
24
 * that not all wrapper functions support the same arguments as the original
25
 * functions.
26
 *
27
 * You should always use these wrapper functions in your code.
28
 *
29
 * Wrong:
30
 * @code
31
 *   $my_substring = substr($original_string, 0, 5);
32
 * @endcode
33
 *
34
 * Correct:
35
 * @code
36
 *   $my_substring = drupal_substr($original_string, 0, 5);
37
 * @endcode
38
 *
39
 * @}
40
 */
41

    
42
/**
43
 * Return status for saving which involved creating a new item.
44
 */
45
define('SAVED_NEW', 1);
46

    
47
/**
48
 * Return status for saving which involved an update to an existing item.
49
 */
50
define('SAVED_UPDATED', 2);
51

    
52
/**
53
 * Return status for saving which deleted an existing item.
54
 */
55
define('SAVED_DELETED', 3);
56

    
57
/**
58
 * The default group for system CSS files added to the page.
59
 */
60
define('CSS_SYSTEM', -100);
61

    
62
/**
63
 * The default group for module CSS files added to the page.
64
 */
65
define('CSS_DEFAULT', 0);
66

    
67
/**
68
 * The default group for theme CSS files added to the page.
69
 */
70
define('CSS_THEME', 100);
71

    
72
/**
73
 * The default group for JavaScript and jQuery libraries added to the page.
74
 */
75
define('JS_LIBRARY', -100);
76

    
77
/**
78
 * The default group for module JavaScript code added to the page.
79
 */
80
define('JS_DEFAULT', 0);
81

    
82
/**
83
 * The default group for theme JavaScript code added to the page.
84
 */
85
define('JS_THEME', 100);
86

    
87
/**
88
 * Error code indicating that the request exceeded the specified timeout.
89
 *
90
 * @see drupal_http_request()
91
 */
92
define('HTTP_REQUEST_TIMEOUT', -1);
93

    
94
/**
95
 * @defgroup block_caching Block Caching
96
 * @{
97
 * Constants that define each block's caching state.
98
 *
99
 * Modules specify how their blocks can be cached in their hook_block_info()
100
 * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the
101
 * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core
102
 * Block module. If the Block module is managing the cache, you can specify that
103
 * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that
104
 * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user
105
 * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can
106
 * be combined with a bitwise-binary or operator; for example,
107
 * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change
108
 * depending on the user role or page it is on.
109
 *
110
 * The block cache is cleared in cache_clear_all(), and uses the same clearing
111
 * policy than page cache (node, comment, user, taxonomy added or updated...).
112
 * Blocks requiring more fine-grained clearing might consider disabling the
113
 * built-in block cache (DRUPAL_NO_CACHE) and roll their own.
114
 *
115
 * Note that user 1 is excluded from block caching.
116
 */
117

    
118
/**
119
 * The block should not get cached.
120
 *
121
 * This setting should be used:
122
 * - For simple blocks (notably those that do not perform any db query), where
123
 *   querying the db cache would be more expensive than directly generating the
124
 *   content.
125
 * - For blocks that change too frequently.
126
 */
127
define('DRUPAL_NO_CACHE', -1);
128

    
129
/**
130
 * The block is handling its own caching in its hook_block_view().
131
 *
132
 * This setting is useful when time based expiration is needed or a site uses a
133
 * node access which invalidates standard block cache.
134
 */
135
define('DRUPAL_CACHE_CUSTOM', -2);
136

    
137
/**
138
 * The block or element can change depending on the user's roles.
139
 *
140
 * This is the default setting for blocks, used when the block does not specify
141
 * anything.
142
 */
143
define('DRUPAL_CACHE_PER_ROLE', 0x0001);
144

    
145
/**
146
 * The block or element can change depending on the user.
147
 *
148
 * This setting can be resource-consuming for sites with large number of users,
149
 * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
150
 */
151
define('DRUPAL_CACHE_PER_USER', 0x0002);
152

    
153
/**
154
 * The block or element can change depending on the page being viewed.
155
 */
156
define('DRUPAL_CACHE_PER_PAGE', 0x0004);
157

    
158
/**
159
 * The block or element is the same for every user and page that it is visible.
160
 */
161
define('DRUPAL_CACHE_GLOBAL', 0x0008);
162

    
163
/**
164
 * @} End of "defgroup block_caching".
165
 */
166

    
167
/**
168
 * Adds content to a specified region.
169
 *
170
 * @param $region
171
 *   Page region the content is added to.
172
 * @param $data
173
 *   Content to be added.
174
 */
175
function drupal_add_region_content($region = NULL, $data = NULL) {
176
  static $content = array();
177

    
178
  if (isset($region) && isset($data)) {
179
    $content[$region][] = $data;
180
  }
181
  return $content;
182
}
183

    
184
/**
185
 * Gets assigned content for a given region.
186
 *
187
 * @param $region
188
 *   A specified region to fetch content for. If NULL, all regions will be
189
 *   returned.
190
 * @param $delimiter
191
 *   Content to be inserted between imploded array elements.
192
 */
193
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
194
  $content = drupal_add_region_content();
195
  if (isset($region)) {
196
    if (isset($content[$region]) && is_array($content[$region])) {
197
      return implode($delimiter, $content[$region]);
198
    }
199
  }
200
  else {
201
    foreach (array_keys($content) as $region) {
202
      if (is_array($content[$region])) {
203
        $content[$region] = implode($delimiter, $content[$region]);
204
      }
205
    }
206
    return $content;
207
  }
208
}
209

    
210
/**
211
 * Gets the name of the currently active installation profile.
212
 *
213
 * When this function is called during Drupal's initial installation process,
214
 * the name of the profile that's about to be installed is stored in the global
215
 * installation state. At all other times, the standard Drupal systems variable
216
 * table contains the name of the current profile, and we can call
217
 * variable_get() to determine what one is active.
218
 *
219
 * @return $profile
220
 *   The name of the installation profile.
221
 */
222
function drupal_get_profile() {
223
  global $install_state;
224

    
225
  if (isset($install_state['parameters']['profile'])) {
226
    $profile = $install_state['parameters']['profile'];
227
  }
228
  else {
229
    $profile = variable_get('install_profile', 'standard');
230
  }
231

    
232
  return $profile;
233
}
234

    
235

    
236
/**
237
 * Sets the breadcrumb trail for the current page.
238
 *
239
 * @param $breadcrumb
240
 *   Array of links, starting with "home" and proceeding up to but not including
241
 *   the current page.
242
 */
243
function drupal_set_breadcrumb($breadcrumb = NULL) {
244
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
245

    
246
  if (isset($breadcrumb)) {
247
    $stored_breadcrumb = $breadcrumb;
248
  }
249
  return $stored_breadcrumb;
250
}
251

    
252
/**
253
 * Gets the breadcrumb trail for the current page.
254
 */
255
function drupal_get_breadcrumb() {
256
  $breadcrumb = drupal_set_breadcrumb();
257

    
258
  if (!isset($breadcrumb)) {
259
    $breadcrumb = menu_get_active_breadcrumb();
260
  }
261

    
262
  return $breadcrumb;
263
}
264

    
265
/**
266
 * Returns a string containing RDF namespace declarations for use in XML and
267
 * XHTML output.
268
 */
269
function drupal_get_rdf_namespaces() {
270
  $xml_rdf_namespaces = array();
271

    
272
  // Serializes the RDF namespaces in XML namespace syntax.
273
  if (function_exists('rdf_get_namespaces')) {
274
    foreach (rdf_get_namespaces() as $prefix => $uri) {
275
      $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
276
    }
277
  }
278
  return count($xml_rdf_namespaces) ? "\n  " . implode("\n  ", $xml_rdf_namespaces) : '';
279
}
280

    
281
/**
282
 * Adds output to the HEAD tag of the HTML page.
283
 *
284
 * This function can be called as long as the headers aren't sent. Pass no
285
 * arguments (or NULL for both) to retrieve the currently stored elements.
286
 *
287
 * @param $data
288
 *   A renderable array. If the '#type' key is not set then 'html_tag' will be
289
 *   added as the default '#type'.
290
 * @param $key
291
 *   A unique string key to allow implementations of hook_html_head_alter() to
292
 *   identify the element in $data. Required if $data is not NULL.
293
 *
294
 * @return
295
 *   An array of all stored HEAD elements.
296
 *
297
 * @see theme_html_tag()
298
 */
299
function drupal_add_html_head($data = NULL, $key = NULL) {
300
  $stored_head = &drupal_static(__FUNCTION__);
301

    
302
  if (!isset($stored_head)) {
303
    // Make sure the defaults, including Content-Type, come first.
304
    $stored_head = _drupal_default_html_head();
305
  }
306

    
307
  if (isset($data) && isset($key)) {
308
    if (!isset($data['#type'])) {
309
      $data['#type'] = 'html_tag';
310
    }
311
    $stored_head[$key] = $data;
312
  }
313
  return $stored_head;
314
}
315

    
316
/**
317
 * Returns elements that are always displayed in the HEAD tag of the HTML page.
318
 */
319
function _drupal_default_html_head() {
320
  // Add default elements. Make sure the Content-Type comes first because the
321
  // IE browser may be vulnerable to XSS via encoding attacks from any content
322
  // that comes before this META tag, such as a TITLE tag.
323
  $elements['system_meta_content_type'] = array(
324
    '#type' => 'html_tag',
325
    '#tag' => 'meta',
326
    '#attributes' => array(
327
      'http-equiv' => 'Content-Type',
328
      'content' => 'text/html; charset=utf-8',
329
    ),
330
    // Security: This always has to be output first.
331
    '#weight' => -1000,
332
  );
333
  // Show Drupal and the major version number in the META GENERATOR tag.
334
  // Get the major version.
335
  list($version, ) = explode('.', VERSION);
336
  $elements['system_meta_generator'] = array(
337
    '#type' => 'html_tag',
338
    '#tag' => 'meta',
339
    '#attributes' => array(
340
      'name' => 'Generator',
341
      'content' => 'Drupal ' . $version . ' (http://drupal.org)',
342
    ),
343
  );
344
  // Also send the generator in the HTTP header.
345
  $elements['system_meta_generator']['#attached']['drupal_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
346
  return $elements;
347
}
348

    
349
/**
350
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
351
 */
352
function drupal_get_html_head() {
353
  $elements = drupal_add_html_head();
354
  drupal_alter('html_head', $elements);
355
  return drupal_render($elements);
356
}
357

    
358
/**
359
 * Adds a feed URL for the current page.
360
 *
361
 * This function can be called as long the HTML header hasn't been sent.
362
 *
363
 * @param $url
364
 *   An internal system path or a fully qualified external URL of the feed.
365
 * @param $title
366
 *   The title of the feed.
367
 */
368
function drupal_add_feed($url = NULL, $title = '') {
369
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
370

    
371
  if (isset($url)) {
372
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
373

    
374
    drupal_add_html_head_link(array(
375
      'rel' => 'alternate',
376
      'type' => 'application/rss+xml',
377
      'title' => $title,
378
      // Force the URL to be absolute, for consistency with other <link> tags
379
      // output by Drupal.
380
      'href' => url($url, array('absolute' => TRUE)),
381
    ));
382
  }
383
  return $stored_feed_links;
384
}
385

    
386
/**
387
 * Gets the feed URLs for the current page.
388
 *
389
 * @param $delimiter
390
 *   A delimiter to split feeds by.
391
 */
392
function drupal_get_feeds($delimiter = "\n") {
393
  $feeds = drupal_add_feed();
394
  return implode($feeds, $delimiter);
395
}
396

    
397
/**
398
 * @defgroup http_handling HTTP handling
399
 * @{
400
 * Functions to properly handle HTTP responses.
401
 */
402

    
403
/**
404
 * Processes a URL query parameter array to remove unwanted elements.
405
 *
406
 * @param $query
407
 *   (optional) An array to be processed. Defaults to $_GET.
408
 * @param $exclude
409
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
410
 *   exclude nested items. Defaults to array('q').
411
 * @param $parent
412
 *   Internal use only. Used to build the $query array key for nested items.
413
 *
414
 * @return
415
 *   An array containing query parameters, which can be used for url().
416
 */
417
function drupal_get_query_parameters(array $query = NULL, array $exclude = array('q'), $parent = '') {
418
  // Set defaults, if none given.
419
  if (!isset($query)) {
420
    $query = $_GET;
421
  }
422
  // If $exclude is empty, there is nothing to filter.
423
  if (empty($exclude)) {
424
    return $query;
425
  }
426
  elseif (!$parent) {
427
    $exclude = array_flip($exclude);
428
  }
429

    
430
  $params = array();
431
  foreach ($query as $key => $value) {
432
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
433
    if (isset($exclude[$string_key])) {
434
      continue;
435
    }
436

    
437
    if (is_array($value)) {
438
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
439
    }
440
    else {
441
      $params[$key] = $value;
442
    }
443
  }
444

    
445
  return $params;
446
}
447

    
448
/**
449
 * Splits a URL-encoded query string into an array.
450
 *
451
 * @param $query
452
 *   The query string to split.
453
 *
454
 * @return
455
 *   An array of URL decoded couples $param_name => $value.
456
 */
457
function drupal_get_query_array($query) {
458
  $result = array();
459
  if (!empty($query)) {
460
    foreach (explode('&', $query) as $param) {
461
      $param = explode('=', $param, 2);
462
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
463
    }
464
  }
465
  return $result;
466
}
467

    
468
/**
469
 * Parses an array into a valid, rawurlencoded query string.
470
 *
471
 * This differs from http_build_query() as we need to rawurlencode() (instead of
472
 * urlencode()) all query parameters.
473
 *
474
 * @param $query
475
 *   The query parameter array to be processed, e.g. $_GET.
476
 * @param $parent
477
 *   Internal use only. Used to build the $query array key for nested items.
478
 *
479
 * @return
480
 *   A rawurlencoded string which can be used as or appended to the URL query
481
 *   string.
482
 *
483
 * @see drupal_get_query_parameters()
484
 * @ingroup php_wrappers
485
 */
486
function drupal_http_build_query(array $query, $parent = '') {
487
  $params = array();
488

    
489
  foreach ($query as $key => $value) {
490
    $key = ($parent ? $parent . '[' . rawurlencode($key) . ']' : rawurlencode($key));
491

    
492
    // Recurse into children.
493
    if (is_array($value)) {
494
      $params[] = drupal_http_build_query($value, $key);
495
    }
496
    // If a query parameter value is NULL, only append its key.
497
    elseif (!isset($value)) {
498
      $params[] = $key;
499
    }
500
    else {
501
      // For better readability of paths in query strings, we decode slashes.
502
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
503
    }
504
  }
505

    
506
  return implode('&', $params);
507
}
508

    
509
/**
510
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
511
 *
512
 * Used to direct the user back to the referring page after completing a form.
513
 * By default the current URL is returned. If a destination exists in the
514
 * previous request, that destination is returned. As such, a destination can
515
 * persist across multiple pages.
516
 *
517
 * @return
518
 *   An associative array containing the key:
519
 *   - destination: The path provided via the destination query string or, if
520
 *     not available, the current path.
521
 *
522
 * @see current_path()
523
 * @see drupal_goto()
524
 */
525
function drupal_get_destination() {
526
  $destination = &drupal_static(__FUNCTION__);
527

    
528
  if (isset($destination)) {
529
    return $destination;
530
  }
531

    
532
  if (isset($_GET['destination'])) {
533
    $destination = array('destination' => $_GET['destination']);
534
  }
535
  else {
536
    $path = $_GET['q'];
537
    $query = drupal_http_build_query(drupal_get_query_parameters());
538
    if ($query != '') {
539
      $path .= '?' . $query;
540
    }
541
    $destination = array('destination' => $path);
542
  }
543
  return $destination;
544
}
545

    
546
/**
547
 * Parses a URL string into its path, query, and fragment components.
548
 *
549
 * This function splits both internal paths like @code node?b=c#d @endcode and
550
 * external URLs like @code https://example.com/a?b=c#d @endcode into their
551
 * component parts. See
552
 * @link http://tools.ietf.org/html/rfc3986#section-3 RFC 3986 @endlink for an
553
 * explanation of what the component parts are.
554
 *
555
 * Note that, unlike the RFC, when passed an external URL, this function
556
 * groups the scheme, authority, and path together into the path component.
557
 *
558
 * @param string $url
559
 *   The internal path or external URL string to parse.
560
 *
561
 * @return array
562
 *   An associative array containing:
563
 *   - path: The path component of $url. If $url is an external URL, this
564
 *     includes the scheme, authority, and path.
565
 *   - query: An array of query parameters from $url, if they exist.
566
 *   - fragment: The fragment component from $url, if it exists.
567
 *
568
 * @see drupal_goto()
569
 * @see l()
570
 * @see url()
571
 * @see http://tools.ietf.org/html/rfc3986
572
 *
573
 * @ingroup php_wrappers
574
 */
575
function drupal_parse_url($url) {
576
  $options = array(
577
    'path' => NULL,
578
    'query' => array(),
579
    'fragment' => '',
580
  );
581

    
582
  // External URLs: not using parse_url() here, so we do not have to rebuild
583
  // the scheme, host, and path without having any use for it.
584
  if (strpos($url, '://') !== FALSE) {
585
    // Split off everything before the query string into 'path'.
586
    $parts = explode('?', $url);
587
    $options['path'] = $parts[0];
588
    // If there is a query string, transform it into keyed query parameters.
589
    if (isset($parts[1])) {
590
      $query_parts = explode('#', $parts[1]);
591
      parse_str($query_parts[0], $options['query']);
592
      // Take over the fragment, if there is any.
593
      if (isset($query_parts[1])) {
594
        $options['fragment'] = $query_parts[1];
595
      }
596
    }
597
  }
598
  // Internal URLs.
599
  else {
600
    // parse_url() does not support relative URLs, so make it absolute. E.g. the
601
    // relative URL "foo/bar:1" isn't properly parsed.
602
    $parts = parse_url('http://example.com/' . $url);
603
    // Strip the leading slash that was just added.
604
    $options['path'] = substr($parts['path'], 1);
605
    if (isset($parts['query'])) {
606
      parse_str($parts['query'], $options['query']);
607
    }
608
    if (isset($parts['fragment'])) {
609
      $options['fragment'] = $parts['fragment'];
610
    }
611
  }
612
  // The 'q' parameter contains the path of the current page if clean URLs are
613
  // disabled. It overrides the 'path' of the URL when present, even if clean
614
  // URLs are enabled, due to how Apache rewriting rules work.
615
  if (isset($options['query']['q'])) {
616
    $options['path'] = $options['query']['q'];
617
    unset($options['query']['q']);
618
  }
619

    
620
  return $options;
621
}
622

    
623
/**
624
 * Encodes a Drupal path for use in a URL.
625
 *
626
 * For aesthetic reasons slashes are not escaped.
627
 *
628
 * Note that url() takes care of calling this function, so a path passed to that
629
 * function should not be encoded in advance.
630
 *
631
 * @param $path
632
 *   The Drupal path to encode.
633
 */
634
function drupal_encode_path($path) {
635
  return str_replace('%2F', '/', rawurlencode($path));
636
}
637

    
638
/**
639
 * Sends the user to a different page.
640
 *
641
 * This issues an on-site HTTP redirect. The function makes sure the redirected
642
 * URL is formatted correctly.
643
 *
644
 * Usually the redirected URL is constructed from this function's input
645
 * parameters. However you may override that behavior by setting a
646
 * destination in either the $_REQUEST-array (i.e. by using
647
 * the query string of an URI) This is used to direct the user back to
648
 * the proper page after completing a form. For example, after editing
649
 * a post on the 'admin/content'-page or after having logged on using the
650
 * 'user login'-block in a sidebar. The function drupal_get_destination()
651
 * can be used to help set the destination URL.
652
 *
653
 * Drupal will ensure that messages set by drupal_set_message() and other
654
 * session data are written to the database before the user is redirected.
655
 *
656
 * This function ends the request; use it instead of a return in your menu
657
 * callback.
658
 *
659
 * @param $path
660
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
661
 *   compute the redirect for the URL.
662
 * @param $options
663
 *   (optional) An associative array of additional URL options to pass to url().
664
 * @param $http_response_code
665
 *   (optional) The HTTP status code to use for the redirection, defaults to
666
 *   302. The valid values for 3xx redirection status codes are defined in
667
 *   @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
668
 *   and the
669
 *   @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
670
 *   - 301: Moved Permanently (the recommended value for most redirects).
671
 *   - 302: Found (default in Drupal and PHP, sometimes used for spamming search
672
 *     engines).
673
 *   - 303: See Other.
674
 *   - 304: Not Modified.
675
 *   - 305: Use Proxy.
676
 *   - 307: Temporary Redirect.
677
 *
678
 * @see drupal_get_destination()
679
 * @see url()
680
 */
681
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
682
  // A destination in $_GET always overrides the function arguments.
683
  // We do not allow absolute URLs to be passed via $_GET, as this can be an attack vector.
684
  if (isset($_GET['destination']) && !url_is_external($_GET['destination'])) {
685
    $destination = drupal_parse_url($_GET['destination']);
686
    $path = $destination['path'];
687
    $options['query'] = $destination['query'];
688
    $options['fragment'] = $destination['fragment'];
689
  }
690

    
691
  drupal_alter('drupal_goto', $path, $options, $http_response_code);
692

    
693
  // The 'Location' HTTP header must be absolute.
694
  $options['absolute'] = TRUE;
695

    
696
  $url = url($path, $options);
697

    
698
  header('Location: ' . $url, TRUE, $http_response_code);
699

    
700
  // The "Location" header sends a redirect status code to the HTTP daemon. In
701
  // some cases this can be wrong, so we make sure none of the code below the
702
  // drupal_goto() call gets executed upon redirection.
703
  drupal_exit($url);
704
}
705

    
706
/**
707
 * Delivers a "site is under maintenance" message to the browser.
708
 *
709
 * Page callback functions wanting to report a "site offline" message should
710
 * return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However,
711
 * functions that are invoked in contexts where that return value might not
712
 * bubble up to menu_execute_active_handler() should call drupal_site_offline().
713
 */
714
function drupal_site_offline() {
715
  drupal_deliver_page(MENU_SITE_OFFLINE);
716
}
717

    
718
/**
719
 * Delivers a "page not found" error to the browser.
720
 *
721
 * Page callback functions wanting to report a "page not found" message should
722
 * return MENU_NOT_FOUND instead of calling drupal_not_found(). However,
723
 * functions that are invoked in contexts where that return value might not
724
 * bubble up to menu_execute_active_handler() should call drupal_not_found().
725
 */
726
function drupal_not_found() {
727
  drupal_deliver_page(MENU_NOT_FOUND);
728
}
729

    
730
/**
731
 * Delivers an "access denied" error to the browser.
732
 *
733
 * Page callback functions wanting to report an "access denied" message should
734
 * return MENU_ACCESS_DENIED instead of calling drupal_access_denied(). However,
735
 * functions that are invoked in contexts where that return value might not
736
 * bubble up to menu_execute_active_handler() should call
737
 * drupal_access_denied().
738
 */
739
function drupal_access_denied() {
740
  drupal_deliver_page(MENU_ACCESS_DENIED);
741
}
742

    
743
/**
744
 * Performs an HTTP request.
745
 *
746
 * This is a flexible and powerful HTTP client implementation. Correctly
747
 * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
748
 *
749
 * @param $url
750
 *   A string containing a fully qualified URI.
751
 * @param array $options
752
 *   (optional) An array that can have one or more of the following elements:
753
 *   - headers: An array containing request headers to send as name/value pairs.
754
 *   - method: A string containing the request method. Defaults to 'GET'.
755
 *   - data: A string containing the request body, formatted as
756
 *     'param=value&param=value&...'. Defaults to NULL.
757
 *   - max_redirects: An integer representing how many times a redirect
758
 *     may be followed. Defaults to 3.
759
 *   - timeout: A float representing the maximum number of seconds the function
760
 *     call may take. The default is 30 seconds. If a timeout occurs, the error
761
 *     code is set to the HTTP_REQUEST_TIMEOUT constant.
762
 *   - context: A context resource created with stream_context_create().
763
 *
764
 * @return object
765
 *   An object that can have one or more of the following components:
766
 *   - request: A string containing the request body that was sent.
767
 *   - code: An integer containing the response status code, or the error code
768
 *     if an error occurred.
769
 *   - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
770
 *   - status_message: The status message from the response, if a response was
771
 *     received.
772
 *   - redirect_code: If redirected, an integer containing the initial response
773
 *     status code.
774
 *   - redirect_url: If redirected, a string containing the URL of the redirect
775
 *     target.
776
 *   - error: If an error occurred, the error message. Otherwise not set.
777
 *   - headers: An array containing the response headers as name/value pairs.
778
 *     HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
779
 *     easy access the array keys are returned in lower case.
780
 *   - data: A string containing the response body that was received.
781
 */
782
function drupal_http_request($url, array $options = array()) {
783
  // Allow an alternate HTTP client library to replace Drupal's default
784
  // implementation.
785
  $override_function = variable_get('drupal_http_request_function', FALSE);
786
  if (!empty($override_function) && function_exists($override_function)) {
787
    return $override_function($url, $options);
788
  }
789

    
790
  $result = new stdClass();
791

    
792
  // Parse the URL and make sure we can handle the schema.
793
  $uri = @parse_url($url);
794

    
795
  if ($uri == FALSE) {
796
    $result->error = 'unable to parse URL';
797
    $result->code = -1001;
798
    return $result;
799
  }
800

    
801
  if (!isset($uri['scheme'])) {
802
    $result->error = 'missing schema';
803
    $result->code = -1002;
804
    return $result;
805
  }
806

    
807
  timer_start(__FUNCTION__);
808

    
809
  // Merge the default options.
810
  $options += array(
811
    'headers' => array(),
812
    'method' => 'GET',
813
    'data' => NULL,
814
    'max_redirects' => 3,
815
    'timeout' => 30.0,
816
    'context' => NULL,
817
  );
818

    
819
  // Merge the default headers.
820
  $options['headers'] += array(
821
    'User-Agent' => 'Drupal (+http://drupal.org/)',
822
  );
823

    
824
  // stream_socket_client() requires timeout to be a float.
825
  $options['timeout'] = (float) $options['timeout'];
826

    
827
  // Use a proxy if one is defined and the host is not on the excluded list.
828
  $proxy_server = variable_get('proxy_server', '');
829
  if ($proxy_server && _drupal_http_use_proxy($uri['host'])) {
830
    // Set the scheme so we open a socket to the proxy server.
831
    $uri['scheme'] = 'proxy';
832
    // Set the path to be the full URL.
833
    $uri['path'] = $url;
834
    // Since the URL is passed as the path, we won't use the parsed query.
835
    unset($uri['query']);
836

    
837
    // Add in username and password to Proxy-Authorization header if needed.
838
    if ($proxy_username = variable_get('proxy_username', '')) {
839
      $proxy_password = variable_get('proxy_password', '');
840
      $options['headers']['Proxy-Authorization'] = 'Basic ' . base64_encode($proxy_username . (!empty($proxy_password) ? ":" . $proxy_password : ''));
841
    }
842
    // Some proxies reject requests with any User-Agent headers, while others
843
    // require a specific one.
844
    $proxy_user_agent = variable_get('proxy_user_agent', '');
845
    // The default value matches neither condition.
846
    if ($proxy_user_agent === NULL) {
847
      unset($options['headers']['User-Agent']);
848
    }
849
    elseif ($proxy_user_agent) {
850
      $options['headers']['User-Agent'] = $proxy_user_agent;
851
    }
852
  }
853

    
854
  switch ($uri['scheme']) {
855
    case 'proxy':
856
      // Make the socket connection to a proxy server.
857
      $socket = 'tcp://' . $proxy_server . ':' . variable_get('proxy_port', 8080);
858
      // The Host header still needs to match the real request.
859
      $options['headers']['Host'] = $uri['host'];
860
      $options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
861
      break;
862

    
863
    case 'http':
864
    case 'feed':
865
      $port = isset($uri['port']) ? $uri['port'] : 80;
866
      $socket = 'tcp://' . $uri['host'] . ':' . $port;
867
      // RFC 2616: "non-standard ports MUST, default ports MAY be included".
868
      // We don't add the standard port to prevent from breaking rewrite rules
869
      // checking the host that do not take into account the port number.
870
      $options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
871
      break;
872

    
873
    case 'https':
874
      // Note: Only works when PHP is compiled with OpenSSL support.
875
      $port = isset($uri['port']) ? $uri['port'] : 443;
876
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
877
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
878
      break;
879

    
880
    default:
881
      $result->error = 'invalid schema ' . $uri['scheme'];
882
      $result->code = -1003;
883
      return $result;
884
  }
885

    
886
  if (empty($options['context'])) {
887
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
888
  }
889
  else {
890
    // Create a stream with context. Allows verification of a SSL certificate.
891
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
892
  }
893

    
894
  // Make sure the socket opened properly.
895
  if (!$fp) {
896
    // When a network error occurs, we use a negative number so it does not
897
    // clash with the HTTP status codes.
898
    $result->code = -$errno;
899
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
900

    
901
    // Mark that this request failed. This will trigger a check of the web
902
    // server's ability to make outgoing HTTP requests the next time that
903
    // requirements checking is performed.
904
    // See system_requirements().
905
    variable_set('drupal_http_request_fails', TRUE);
906

    
907
    return $result;
908
  }
909

    
910
  // Construct the path to act on.
911
  $path = isset($uri['path']) ? $uri['path'] : '/';
912
  if (isset($uri['query'])) {
913
    $path .= '?' . $uri['query'];
914
  }
915

    
916
  // Only add Content-Length if we actually have any content or if it is a POST
917
  // or PUT request. Some non-standard servers get confused by Content-Length in
918
  // at least HEAD/GET requests, and Squid always requires Content-Length in
919
  // POST/PUT requests.
920
  $content_length = strlen($options['data']);
921
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
922
    $options['headers']['Content-Length'] = $content_length;
923
  }
924

    
925
  // If the server URL has a user then attempt to use basic authentication.
926
  if (isset($uri['user'])) {
927
    $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (isset($uri['pass']) ? ':' . $uri['pass'] : ':'));
928
  }
929

    
930
  // If the database prefix is being used by SimpleTest to run the tests in a copied
931
  // database then set the user-agent header to the database prefix so that any
932
  // calls to other Drupal pages will run the SimpleTest prefixed database. The
933
  // user-agent is used to ensure that multiple testing sessions running at the
934
  // same time won't interfere with each other as they would if the database
935
  // prefix were stored statically in a file or database variable.
936
  $test_info = &$GLOBALS['drupal_test_info'];
937
  if (!empty($test_info['test_run_id'])) {
938
    $options['headers']['User-Agent'] = drupal_generate_test_ua($test_info['test_run_id']);
939
  }
940

    
941
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
942
  foreach ($options['headers'] as $name => $value) {
943
    $request .= $name . ': ' . trim($value) . "\r\n";
944
  }
945
  $request .= "\r\n" . $options['data'];
946
  $result->request = $request;
947
  // Calculate how much time is left of the original timeout value.
948
  $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
949
  if ($timeout > 0) {
950
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
951
    fwrite($fp, $request);
952
  }
953

    
954
  // Fetch response. Due to PHP bugs like http://bugs.php.net/bug.php?id=43782
955
  // and http://bugs.php.net/bug.php?id=46049 we can't rely on feof(), but
956
  // instead must invoke stream_get_meta_data() each iteration.
957
  $info = stream_get_meta_data($fp);
958
  $alive = !$info['eof'] && !$info['timed_out'];
959
  $response = '';
960

    
961
  while ($alive) {
962
    // Calculate how much time is left of the original timeout value.
963
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
964
    if ($timeout <= 0) {
965
      $info['timed_out'] = TRUE;
966
      break;
967
    }
968
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
969
    $chunk = fread($fp, 1024);
970
    $response .= $chunk;
971
    $info = stream_get_meta_data($fp);
972
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
973
  }
974
  fclose($fp);
975

    
976
  if ($info['timed_out']) {
977
    $result->code = HTTP_REQUEST_TIMEOUT;
978
    $result->error = 'request timed out';
979
    return $result;
980
  }
981
  // Parse response headers from the response body.
982
  // Be tolerant of malformed HTTP responses that separate header and body with
983
  // \n\n or \r\r instead of \r\n\r\n.
984
  list($response, $result->data) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
985
  $response = preg_split("/\r\n|\n|\r/", $response);
986

    
987
  // Parse the response status line.
988
  $response_status_array = _drupal_parse_response_status(trim(array_shift($response)));
989
  $result->protocol = $response_status_array['http_version'];
990
  $result->status_message = $response_status_array['reason_phrase'];
991
  $code = $response_status_array['response_code'];
992

    
993
  $result->headers = array();
994

    
995
  // Parse the response headers.
996
  while ($line = trim(array_shift($response))) {
997
    list($name, $value) = explode(':', $line, 2);
998
    $name = strtolower($name);
999
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
1000
      // RFC 2109: the Set-Cookie response header comprises the token Set-
1001
      // Cookie:, followed by a comma-separated list of one or more cookies.
1002
      $result->headers[$name] .= ',' . trim($value);
1003
    }
1004
    else {
1005
      $result->headers[$name] = trim($value);
1006
    }
1007
  }
1008

    
1009
  $responses = array(
1010
    100 => 'Continue',
1011
    101 => 'Switching Protocols',
1012
    200 => 'OK',
1013
    201 => 'Created',
1014
    202 => 'Accepted',
1015
    203 => 'Non-Authoritative Information',
1016
    204 => 'No Content',
1017
    205 => 'Reset Content',
1018
    206 => 'Partial Content',
1019
    300 => 'Multiple Choices',
1020
    301 => 'Moved Permanently',
1021
    302 => 'Found',
1022
    303 => 'See Other',
1023
    304 => 'Not Modified',
1024
    305 => 'Use Proxy',
1025
    307 => 'Temporary Redirect',
1026
    400 => 'Bad Request',
1027
    401 => 'Unauthorized',
1028
    402 => 'Payment Required',
1029
    403 => 'Forbidden',
1030
    404 => 'Not Found',
1031
    405 => 'Method Not Allowed',
1032
    406 => 'Not Acceptable',
1033
    407 => 'Proxy Authentication Required',
1034
    408 => 'Request Time-out',
1035
    409 => 'Conflict',
1036
    410 => 'Gone',
1037
    411 => 'Length Required',
1038
    412 => 'Precondition Failed',
1039
    413 => 'Request Entity Too Large',
1040
    414 => 'Request-URI Too Large',
1041
    415 => 'Unsupported Media Type',
1042
    416 => 'Requested range not satisfiable',
1043
    417 => 'Expectation Failed',
1044
    500 => 'Internal Server Error',
1045
    501 => 'Not Implemented',
1046
    502 => 'Bad Gateway',
1047
    503 => 'Service Unavailable',
1048
    504 => 'Gateway Time-out',
1049
    505 => 'HTTP Version not supported',
1050
  );
1051
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
1052
  // base code in their class.
1053
  if (!isset($responses[$code])) {
1054
    $code = floor($code / 100) * 100;
1055
  }
1056
  $result->code = $code;
1057

    
1058
  switch ($code) {
1059
    case 200: // OK
1060
    case 201: // Created
1061
    case 202: // Accepted
1062
    case 203: // Non-Authoritative Information
1063
    case 204: // No Content
1064
    case 205: // Reset Content
1065
    case 206: // Partial Content
1066
    case 304: // Not modified
1067
      break;
1068
    case 301: // Moved permanently
1069
    case 302: // Moved temporarily
1070
    case 307: // Moved temporarily
1071
      $location = $result->headers['location'];
1072
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
1073
      if ($options['timeout'] <= 0) {
1074
        $result->code = HTTP_REQUEST_TIMEOUT;
1075
        $result->error = 'request timed out';
1076
      }
1077
      elseif ($options['max_redirects']) {
1078
        // Redirect to the new location.
1079
        $options['max_redirects']--;
1080
        $result = drupal_http_request($location, $options);
1081
        $result->redirect_code = $code;
1082
      }
1083
      if (!isset($result->redirect_url)) {
1084
        $result->redirect_url = $location;
1085
      }
1086
      break;
1087
    default:
1088
      $result->error = $result->status_message;
1089
  }
1090

    
1091
  return $result;
1092
}
1093

    
1094
/**
1095
 * Splits an HTTP response status line into components.
1096
 *
1097
 * See the @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html status line definition @endlink
1098
 * in RFC 2616.
1099
 *
1100
 * @param string $respone
1101
 *   The response status line, for example 'HTTP/1.1 500 Internal Server Error'.
1102
 *
1103
 * @return array
1104
 *   Keyed array containing the component parts. If the response is malformed,
1105
 *   all possible parts will be extracted. 'reason_phrase' could be empty.
1106
 *   Possible keys:
1107
 *   - 'http_version'
1108
 *   - 'response_code'
1109
 *   - 'reason_phrase'
1110
 */
1111
function _drupal_parse_response_status($response) {
1112
  $response_array = explode(' ', trim($response), 3);
1113
  // Set up empty values.
1114
  $result = array(
1115
    'reason_phrase' => '',
1116
  );
1117
  $result['http_version'] = $response_array[0];
1118
  $result['response_code'] = $response_array[1];
1119
  if (isset($response_array[2])) {
1120
    $result['reason_phrase'] = $response_array[2];
1121
  }
1122
  return $result;
1123
}
1124

    
1125
/**
1126
 * Helper function for determining hosts excluded from needing a proxy.
1127
 *
1128
 * @return
1129
 *   TRUE if a proxy should be used for this host.
1130
 */
1131
function _drupal_http_use_proxy($host) {
1132
  $proxy_exceptions = variable_get('proxy_exceptions', array('localhost', '127.0.0.1'));
1133
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
1134
}
1135

    
1136
/**
1137
 * @} End of "HTTP handling".
1138
 */
1139

    
1140
/**
1141
 * Strips slashes from a string or array of strings.
1142
 *
1143
 * Callback for array_walk() within fix_gpx_magic().
1144
 *
1145
 * @param $item
1146
 *   An individual string or array of strings from superglobals.
1147
 */
1148
function _fix_gpc_magic(&$item) {
1149
  if (is_array($item)) {
1150
    array_walk($item, '_fix_gpc_magic');
1151
  }
1152
  else {
1153
    $item = stripslashes($item);
1154
  }
1155
}
1156

    
1157
/**
1158
 * Strips slashes from $_FILES items.
1159
 *
1160
 * Callback for array_walk() within fix_gpc_magic().
1161
 *
1162
 * The tmp_name key is skipped keys since PHP generates single backslashes for
1163
 * file paths on Windows systems.
1164
 *
1165
 * @param $item
1166
 *   An item from $_FILES.
1167
 * @param $key
1168
 *   The key for the item within $_FILES.
1169
 *
1170
 * @see http://php.net/manual/features.file-upload.php#42280
1171
 */
1172
function _fix_gpc_magic_files(&$item, $key) {
1173
  if ($key != 'tmp_name') {
1174
    if (is_array($item)) {
1175
      array_walk($item, '_fix_gpc_magic_files');
1176
    }
1177
    else {
1178
      $item = stripslashes($item);
1179
    }
1180
  }
1181
}
1182

    
1183
/**
1184
 * Fixes double-escaping caused by "magic quotes" in some PHP installations.
1185
 *
1186
 * @see _fix_gpc_magic()
1187
 * @see _fix_gpc_magic_files()
1188
 */
1189
function fix_gpc_magic() {
1190
  static $fixed = FALSE;
1191
  if (!$fixed && ini_get('magic_quotes_gpc')) {
1192
    array_walk($_GET, '_fix_gpc_magic');
1193
    array_walk($_POST, '_fix_gpc_magic');
1194
    array_walk($_COOKIE, '_fix_gpc_magic');
1195
    array_walk($_REQUEST, '_fix_gpc_magic');
1196
    array_walk($_FILES, '_fix_gpc_magic_files');
1197
  }
1198
  $fixed = TRUE;
1199
}
1200

    
1201
/**
1202
 * @defgroup validation Input validation
1203
 * @{
1204
 * Functions to validate user input.
1205
 */
1206

    
1207
/**
1208
 * Verifies the syntax of the given e-mail address.
1209
 *
1210
 * This uses the
1211
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
1212
 *
1213
 * @param $mail
1214
 *   A string containing an e-mail address.
1215
 *
1216
 * @return
1217
 *   TRUE if the address is in a valid format.
1218
 */
1219
function valid_email_address($mail) {
1220
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1221
}
1222

    
1223
/**
1224
 * Verifies the syntax of the given URL.
1225
 *
1226
 * This function should only be used on actual URLs. It should not be used for
1227
 * Drupal menu paths, which can contain arbitrary characters.
1228
 * Valid values per RFC 3986.
1229
 * @param $url
1230
 *   The URL to verify.
1231
 * @param $absolute
1232
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
1233
 *
1234
 * @return
1235
 *   TRUE if the URL is in a valid format.
1236
 */
1237
function valid_url($url, $absolute = FALSE) {
1238
  if ($absolute) {
1239
    return (bool)preg_match("
1240
      /^                                                      # Start at the beginning of the text
1241
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1242
      (?:                                                     # Userinfo (optional) which is typically
1243
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
1244
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
1245
      )?
1246
      (?:
1247
        (?:[a-z0-9\-\.]|%[0-9a-f]{2})+                        # A domain name or a IPv4 address
1248
        |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\])         # or a well formed IPv6 address
1249
      )
1250
      (?::[0-9]+)?                                            # Server port number (optional)
1251
      (?:[\/|\?]
1252
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
1253
      *)?
1254
    $/xi", $url);
1255
  }
1256
  else {
1257
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
1258
  }
1259
}
1260

    
1261
/**
1262
 * @} End of "defgroup validation".
1263
 */
1264

    
1265
/**
1266
 * Registers an event for the current visitor to the flood control mechanism.
1267
 *
1268
 * @param $name
1269
 *   The name of an event.
1270
 * @param $window
1271
 *   Optional number of seconds before this event expires. Defaults to 3600 (1
1272
 *   hour). Typically uses the same value as the flood_is_allowed() $window
1273
 *   parameter. Expired events are purged on cron run to prevent the flood table
1274
 *   from growing indefinitely.
1275
 * @param $identifier
1276
 *   Optional identifier (defaults to the current user's IP address).
1277
 */
1278
function flood_register_event($name, $window = 3600, $identifier = NULL) {
1279
  if (!isset($identifier)) {
1280
    $identifier = ip_address();
1281
  }
1282
  db_insert('flood')
1283
    ->fields(array(
1284
      'event' => $name,
1285
      'identifier' => $identifier,
1286
      'timestamp' => REQUEST_TIME,
1287
      'expiration' => REQUEST_TIME + $window,
1288
    ))
1289
    ->execute();
1290
}
1291

    
1292
/**
1293
 * Makes the flood control mechanism forget an event for the current visitor.
1294
 *
1295
 * @param $name
1296
 *   The name of an event.
1297
 * @param $identifier
1298
 *   Optional identifier (defaults to the current user's IP address).
1299
 */
1300
function flood_clear_event($name, $identifier = NULL) {
1301
  if (!isset($identifier)) {
1302
    $identifier = ip_address();
1303
  }
1304
  db_delete('flood')
1305
    ->condition('event', $name)
1306
    ->condition('identifier', $identifier)
1307
    ->execute();
1308
}
1309

    
1310
/**
1311
 * Checks whether a user is allowed to proceed with the specified event.
1312
 *
1313
 * Events can have thresholds saying that each user can only do that event
1314
 * a certain number of times in a time window. This function verifies that the
1315
 * current user has not exceeded this threshold.
1316
 *
1317
 * @param $name
1318
 *   The unique name of the event.
1319
 * @param $threshold
1320
 *   The maximum number of times each user can do this event per time window.
1321
 * @param $window
1322
 *   Number of seconds in the time window for this event (default is 3600
1323
 *   seconds, or 1 hour).
1324
 * @param $identifier
1325
 *   Unique identifier of the current user. Defaults to their IP address.
1326
 *
1327
 * @return
1328
 *   TRUE if the user is allowed to proceed. FALSE if they have exceeded the
1329
 *   threshold and should not be allowed to proceed.
1330
 */
1331
function flood_is_allowed($name, $threshold, $window = 3600, $identifier = NULL) {
1332
  if (!isset($identifier)) {
1333
    $identifier = ip_address();
1334
  }
1335
  $number = db_query("SELECT COUNT(*) FROM {flood} WHERE event = :event AND identifier = :identifier AND timestamp > :timestamp", array(
1336
    ':event' => $name,
1337
    ':identifier' => $identifier,
1338
    ':timestamp' => REQUEST_TIME - $window))
1339
    ->fetchField();
1340
  return ($number < $threshold);
1341
}
1342

    
1343
/**
1344
 * @defgroup sanitization Sanitization functions
1345
 * @{
1346
 * Functions to sanitize values.
1347
 *
1348
 * See http://drupal.org/writing-secure-code for information
1349
 * on writing secure code.
1350
 */
1351

    
1352
/**
1353
 * Strips dangerous protocols (e.g. 'javascript:') from a URI.
1354
 *
1355
 * This function must be called for all URIs within user-entered input prior
1356
 * to being output to an HTML attribute value. It is often called as part of
1357
 * check_url() or filter_xss(), but those functions return an HTML-encoded
1358
 * string, so this function can be called independently when the output needs to
1359
 * be a plain-text string for passing to t(), l(), drupal_attributes(), or
1360
 * another function that will call check_plain() separately.
1361
 *
1362
 * @param $uri
1363
 *   A plain-text URI that might contain dangerous protocols.
1364
 *
1365
 * @return
1366
 *   A plain-text URI stripped of dangerous protocols. As with all plain-text
1367
 *   strings, this return value must not be output to an HTML page without
1368
 *   check_plain() being called on it. However, it can be passed to functions
1369
 *   expecting plain-text strings.
1370
 *
1371
 * @see check_url()
1372
 */
1373
function drupal_strip_dangerous_protocols($uri) {
1374
  static $allowed_protocols;
1375

    
1376
  if (!isset($allowed_protocols)) {
1377
    $allowed_protocols = array_flip(variable_get('filter_allowed_protocols', array('ftp', 'http', 'https', 'irc', 'mailto', 'news', 'nntp', 'rtsp', 'sftp', 'ssh', 'tel', 'telnet', 'webcal')));
1378
  }
1379

    
1380
  // Iteratively remove any invalid protocol found.
1381
  do {
1382
    $before = $uri;
1383
    $colonpos = strpos($uri, ':');
1384
    if ($colonpos > 0) {
1385
      // We found a colon, possibly a protocol. Verify.
1386
      $protocol = substr($uri, 0, $colonpos);
1387
      // If a colon is preceded by a slash, question mark or hash, it cannot
1388
      // possibly be part of the URL scheme. This must be a relative URL, which
1389
      // inherits the (safe) protocol of the base document.
1390
      if (preg_match('![/?#]!', $protocol)) {
1391
        break;
1392
      }
1393
      // Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
1394
      // (URI Comparison) scheme comparison must be case-insensitive.
1395
      if (!isset($allowed_protocols[strtolower($protocol)])) {
1396
        $uri = substr($uri, $colonpos + 1);
1397
      }
1398
    }
1399
  } while ($before != $uri);
1400

    
1401
  return $uri;
1402
}
1403

    
1404
/**
1405
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
1406
 *
1407
 * @param $uri
1408
 *   A plain-text URI that might contain dangerous protocols.
1409
 *
1410
 * @return
1411
 *   A URI stripped of dangerous protocols and encoded for output to an HTML
1412
 *   attribute value. Because it is already encoded, it should not be set as a
1413
 *   value within a $attributes array passed to drupal_attributes(), because
1414
 *   drupal_attributes() expects those values to be plain-text strings. To pass
1415
 *   a filtered URI to drupal_attributes(), call
1416
 *   drupal_strip_dangerous_protocols() instead.
1417
 *
1418
 * @see drupal_strip_dangerous_protocols()
1419
 */
1420
function check_url($uri) {
1421
  return check_plain(drupal_strip_dangerous_protocols($uri));
1422
}
1423

    
1424
/**
1425
 * Applies a very permissive XSS/HTML filter for admin-only use.
1426
 *
1427
 * Use only for fields where it is impractical to use the
1428
 * whole filter system, but where some (mainly inline) mark-up
1429
 * is desired (so check_plain() is not acceptable).
1430
 *
1431
 * Allows all tags that can be used inside an HTML body, save
1432
 * for scripts and styles.
1433
 */
1434
function filter_xss_admin($string) {
1435
  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'));
1436
}
1437

    
1438
/**
1439
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
1440
 *
1441
 * Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
1442
 * For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
1443
 *
1444
 * This code does four things:
1445
 * - Removes characters and constructs that can trick browsers.
1446
 * - Makes sure all HTML entities are well-formed.
1447
 * - Makes sure all HTML tags and attributes are well-formed.
1448
 * - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
1449
 *   javascript:).
1450
 *
1451
 * @param $string
1452
 *   The string with raw HTML in it. It will be stripped of everything that can
1453
 *   cause an XSS attack.
1454
 * @param $allowed_tags
1455
 *   An array of allowed tags.
1456
 *
1457
 * @return
1458
 *   An XSS safe version of $string, or an empty string if $string is not
1459
 *   valid UTF-8.
1460
 *
1461
 * @see drupal_validate_utf8()
1462
 */
1463
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
1464
  // Only operate on valid UTF-8 strings. This is necessary to prevent cross
1465
  // site scripting issues on Internet Explorer 6.
1466
  if (!drupal_validate_utf8($string)) {
1467
    return '';
1468
  }
1469
  // Store the text format.
1470
  _filter_xss_split($allowed_tags, TRUE);
1471
  // Remove NULL characters (ignored by some browsers).
1472
  $string = str_replace(chr(0), '', $string);
1473
  // Remove Netscape 4 JS entities.
1474
  $string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
1475

    
1476
  // Defuse all HTML entities.
1477
  $string = str_replace('&', '&amp;', $string);
1478
  // Change back only well-formed entities in our whitelist:
1479
  // Decimal numeric entities.
1480
  $string = preg_replace('/&amp;#([0-9]+;)/', '&#\1', $string);
1481
  // Hexadecimal numeric entities.
1482
  $string = preg_replace('/&amp;#[Xx]0*((?:[0-9A-Fa-f]{2})+;)/', '&#x\1', $string);
1483
  // Named entities.
1484
  $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]*;)/', '&\1', $string);
1485

    
1486
  return preg_replace_callback('%
1487
    (
1488
    <(?=[^a-zA-Z!/])  # a lone <
1489
    |                 # or
1490
    <!--.*?-->        # a comment
1491
    |                 # or
1492
    <[^>]*(>|$)       # a string that starts with a <, up until the > or the end of the string
1493
    |                 # or
1494
    >                 # just a >
1495
    )%x', '_filter_xss_split', $string);
1496
}
1497

    
1498
/**
1499
 * Processes an HTML tag.
1500
 *
1501
 * @param $m
1502
 *   An array with various meaning depending on the value of $store.
1503
 *   If $store is TRUE then the array contains the allowed tags.
1504
 *   If $store is FALSE then the array has one element, the HTML tag to process.
1505
 * @param $store
1506
 *   Whether to store $m.
1507
 *
1508
 * @return
1509
 *   If the element isn't allowed, an empty string. Otherwise, the cleaned up
1510
 *   version of the HTML element.
1511
 */
1512
function _filter_xss_split($m, $store = FALSE) {
1513
  static $allowed_html;
1514

    
1515
  if ($store) {
1516
    $allowed_html = array_flip($m);
1517
    return;
1518
  }
1519

    
1520
  $string = $m[1];
1521

    
1522
  if (substr($string, 0, 1) != '<') {
1523
    // We matched a lone ">" character.
1524
    return '&gt;';
1525
  }
1526
  elseif (strlen($string) == 1) {
1527
    // We matched a lone "<" character.
1528
    return '&lt;';
1529
  }
1530

    
1531
  if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9\-]+)([^>]*)>?|(<!--.*?-->)$%', $string, $matches)) {
1532
    // Seriously malformed.
1533
    return '';
1534
  }
1535

    
1536
  $slash = trim($matches[1]);
1537
  $elem = &$matches[2];
1538
  $attrlist = &$matches[3];
1539
  $comment = &$matches[4];
1540

    
1541
  if ($comment) {
1542
    $elem = '!--';
1543
  }
1544

    
1545
  if (!isset($allowed_html[strtolower($elem)])) {
1546
    // Disallowed HTML element.
1547
    return '';
1548
  }
1549

    
1550
  if ($comment) {
1551
    return $comment;
1552
  }
1553

    
1554
  if ($slash != '') {
1555
    return "</$elem>";
1556
  }
1557

    
1558
  // Is there a closing XHTML slash at the end of the attributes?
1559
  $attrlist = preg_replace('%(\s?)/\s*$%', '\1', $attrlist, -1, $count);
1560
  $xhtml_slash = $count ? ' /' : '';
1561

    
1562
  // Clean up attributes.
1563
  $attr2 = implode(' ', _filter_xss_attributes($attrlist));
1564
  $attr2 = preg_replace('/[<>]/', '', $attr2);
1565
  $attr2 = strlen($attr2) ? ' ' . $attr2 : '';
1566

    
1567
  return "<$elem$attr2$xhtml_slash>";
1568
}
1569

    
1570
/**
1571
 * Processes a string of HTML attributes.
1572
 *
1573
 * @return
1574
 *   Cleaned up version of the HTML attributes.
1575
 */
1576
function _filter_xss_attributes($attr) {
1577
  $attrarr = array();
1578
  $mode = 0;
1579
  $attrname = '';
1580

    
1581
  while (strlen($attr) != 0) {
1582
    // Was the last operation successful?
1583
    $working = 0;
1584

    
1585
    switch ($mode) {
1586
      case 0:
1587
        // Attribute name, href for instance.
1588
        if (preg_match('/^([-a-zA-Z]+)/', $attr, $match)) {
1589
          $attrname = strtolower($match[1]);
1590
          $skip = ($attrname == 'style' || substr($attrname, 0, 2) == 'on');
1591
          $working = $mode = 1;
1592
          $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
1593
        }
1594
        break;
1595

    
1596
      case 1:
1597
        // Equals sign or valueless ("selected").
1598
        if (preg_match('/^\s*=\s*/', $attr)) {
1599
          $working = 1; $mode = 2;
1600
          $attr = preg_replace('/^\s*=\s*/', '', $attr);
1601
          break;
1602
        }
1603

    
1604
        if (preg_match('/^\s+/', $attr)) {
1605
          $working = 1; $mode = 0;
1606
          if (!$skip) {
1607
            $attrarr[] = $attrname;
1608
          }
1609
          $attr = preg_replace('/^\s+/', '', $attr);
1610
        }
1611
        break;
1612

    
1613
      case 2:
1614
        // Attribute value, a URL after href= for instance.
1615
        if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) {
1616
          $thisval = filter_xss_bad_protocol($match[1]);
1617

    
1618
          if (!$skip) {
1619
            $attrarr[] = "$attrname=\"$thisval\"";
1620
          }
1621
          $working = 1;
1622
          $mode = 0;
1623
          $attr = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
1624
          break;
1625
        }
1626

    
1627
        if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) {
1628
          $thisval = filter_xss_bad_protocol($match[1]);
1629

    
1630
          if (!$skip) {
1631
            $attrarr[] = "$attrname='$thisval'";
1632
          }
1633
          $working = 1; $mode = 0;
1634
          $attr = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
1635
          break;
1636
        }
1637

    
1638
        if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) {
1639
          $thisval = filter_xss_bad_protocol($match[1]);
1640

    
1641
          if (!$skip) {
1642
            $attrarr[] = "$attrname=\"$thisval\"";
1643
          }
1644
          $working = 1; $mode = 0;
1645
          $attr = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
1646
        }
1647
        break;
1648
    }
1649

    
1650
    if ($working == 0) {
1651
      // Not well formed; remove and try again.
1652
      $attr = preg_replace('/
1653
        ^
1654
        (
1655
        "[^"]*("|$)     # - a string that starts with a double quote, up until the next double quote or the end of the string
1656
        |               # or
1657
        \'[^\']*(\'|$)| # - a string that starts with a quote, up until the next quote or the end of the string
1658
        |               # or
1659
        \S              # - a non-whitespace character
1660
        )*              # any number of the above three
1661
        \s*             # any number of whitespaces
1662
        /x', '', $attr);
1663
      $mode = 0;
1664
    }
1665
  }
1666

    
1667
  // The attribute list ends with a valueless attribute like "selected".
1668
  if ($mode == 1 && !$skip) {
1669
    $attrarr[] = $attrname;
1670
  }
1671
  return $attrarr;
1672
}
1673

    
1674
/**
1675
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
1676
 *
1677
 * @param $string
1678
 *   The string with the attribute value.
1679
 * @param $decode
1680
 *   (deprecated) Whether to decode entities in the $string. Set to FALSE if the
1681
 *   $string is in plain text, TRUE otherwise. Defaults to TRUE. This parameter
1682
 *   is deprecated and will be removed in Drupal 8. To process a plain-text URI,
1683
 *   call drupal_strip_dangerous_protocols() or check_url() instead.
1684
 *
1685
 * @return
1686
 *   Cleaned up and HTML-escaped version of $string.
1687
 */
1688
function filter_xss_bad_protocol($string, $decode = TRUE) {
1689
  // Get the plain text representation of the attribute value (i.e. its meaning).
1690
  // @todo Remove the $decode parameter in Drupal 8, and always assume an HTML
1691
  //   string that needs decoding.
1692
  if ($decode) {
1693
    if (!function_exists('decode_entities')) {
1694
      require_once DRUPAL_ROOT . '/includes/unicode.inc';
1695
    }
1696

    
1697
    $string = decode_entities($string);
1698
  }
1699
  return check_plain(drupal_strip_dangerous_protocols($string));
1700
}
1701

    
1702
/**
1703
 * @} End of "defgroup sanitization".
1704
 */
1705

    
1706
/**
1707
 * @defgroup format Formatting
1708
 * @{
1709
 * Functions to format numbers, strings, dates, etc.
1710
 */
1711

    
1712
/**
1713
 * Formats an RSS channel.
1714
 *
1715
 * Arbitrary elements may be added using the $args associative array.
1716
 */
1717
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
1718
  global $language_content;
1719
  $langcode = $langcode ? $langcode : $language_content->language;
1720

    
1721
  $output = "<channel>\n";
1722
  $output .= ' <title>' . check_plain($title) . "</title>\n";
1723
  $output .= ' <link>' . check_url($link) . "</link>\n";
1724

    
1725
  // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
1726
  // We strip all HTML tags, but need to prevent double encoding from properly
1727
  // escaped source data (such as &amp becoming &amp;amp;).
1728
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
1729
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
1730
  $output .= format_xml_elements($args);
1731
  $output .= $items;
1732
  $output .= "</channel>\n";
1733

    
1734
  return $output;
1735
}
1736

    
1737
/**
1738
 * Formats a single RSS item.
1739
 *
1740
 * Arbitrary elements may be added using the $args associative array.
1741
 */
1742
function format_rss_item($title, $link, $description, $args = array()) {
1743
  $output = "<item>\n";
1744
  $output .= ' <title>' . check_plain($title) . "</title>\n";
1745
  $output .= ' <link>' . check_url($link) . "</link>\n";
1746
  $output .= ' <description>' . check_plain($description) . "</description>\n";
1747
  $output .= format_xml_elements($args);
1748
  $output .= "</item>\n";
1749

    
1750
  return $output;
1751
}
1752

    
1753
/**
1754
 * Formats XML elements.
1755
 *
1756
 * @param $array
1757
 *   An array where each item represents an element and is either a:
1758
 *   - (key => value) pair (<key>value</key>)
1759
 *   - Associative array with fields:
1760
 *     - 'key': element name
1761
 *     - 'value': element contents
1762
 *     - 'attributes': associative array of element attributes
1763
 *
1764
 * In both cases, 'value' can be a simple string, or it can be another array
1765
 * with the same format as $array itself for nesting.
1766
 */
1767
function format_xml_elements($array) {
1768
  $output = '';
1769
  foreach ($array as $key => $value) {
1770
    if (is_numeric($key)) {
1771
      if ($value['key']) {
1772
        $output .= ' <' . $value['key'];
1773
        if (isset($value['attributes']) && is_array($value['attributes'])) {
1774
          $output .= drupal_attributes($value['attributes']);
1775
        }
1776

    
1777
        if (isset($value['value']) && $value['value'] != '') {
1778
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
1779
        }
1780
        else {
1781
          $output .= " />\n";
1782
        }
1783
      }
1784
    }
1785
    else {
1786
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
1787
    }
1788
  }
1789
  return $output;
1790
}
1791

    
1792
/**
1793
 * Formats a string containing a count of items.
1794
 *
1795
 * This function ensures that the string is pluralized correctly. Since t() is
1796
 * called by this function, make sure not to pass already-localized strings to
1797
 * it.
1798
 *
1799
 * For example:
1800
 * @code
1801
 *   $output = format_plural($node->comment_count, '1 comment', '@count comments');
1802
 * @endcode
1803
 *
1804
 * Example with additional replacements:
1805
 * @code
1806
 *   $output = format_plural($update_count,
1807
 *     'Changed the content type of 1 post from %old-type to %new-type.',
1808
 *     'Changed the content type of @count posts from %old-type to %new-type.',
1809
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
1810
 * @endcode
1811
 *
1812
 * @param $count
1813
 *   The item count to display.
1814
 * @param $singular
1815
 *   The string for the singular case. Make sure it is clear this is singular,
1816
 *   to ease translation (e.g. use "1 new comment" instead of "1 new"). Do not
1817
 *   use @count in the singular string.
1818
 * @param $plural
1819
 *   The string for the plural case. Make sure it is clear this is plural, to
1820
 *   ease translation. Use @count in place of the item count, as in
1821
 *   "@count new comments".
1822
 * @param $args
1823
 *   An associative array of replacements to make after translation. Instances
1824
 *   of any key in this array are replaced with the corresponding value.
1825
 *   Based on the first character of the key, the value is escaped and/or
1826
 *   themed. See format_string(). Note that you do not need to include @count
1827
 *   in this array; this replacement is done automatically for the plural case.
1828
 * @param $options
1829
 *   An associative array of additional options. See t() for allowed keys.
1830
 *
1831
 * @return
1832
 *   A translated string.
1833
 *
1834
 * @see t()
1835
 * @see format_string()
1836
 */
1837
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
1838
  $args['@count'] = $count;
1839
  if ($count == 1) {
1840
    return t($singular, $args, $options);
1841
  }
1842

    
1843
  // Get the plural index through the gettext formula.
1844
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
1845
  // If the index cannot be computed, use the plural as a fallback (which
1846
  // allows for most flexiblity with the replaceable @count value).
1847
  if ($index < 0) {
1848
    return t($plural, $args, $options);
1849
  }
1850
  else {
1851
    switch ($index) {
1852
      case "0":
1853
        return t($singular, $args, $options);
1854
      case "1":
1855
        return t($plural, $args, $options);
1856
      default:
1857
        unset($args['@count']);
1858
        $args['@count[' . $index . ']'] = $count;
1859
        return t(strtr($plural, array('@count' => '@count[' . $index . ']')), $args, $options);
1860
    }
1861
  }
1862
}
1863

    
1864
/**
1865
 * Parses a given byte count.
1866
 *
1867
 * @param $size
1868
 *   A size expressed as a number of bytes with optional SI or IEC binary unit
1869
 *   prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8 bytes, 9mbytes).
1870
 *
1871
 * @return
1872
 *   An integer representation of the size in bytes.
1873
 */
1874
function parse_size($size) {
1875
  $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
1876
  $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
1877
  if ($unit) {
1878
    // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
1879
    return round($size * pow(DRUPAL_KILOBYTE, stripos('bkmgtpezy', $unit[0])));
1880
  }
1881
  else {
1882
    return round($size);
1883
  }
1884
}
1885

    
1886
/**
1887
 * Generates a string representation for the given byte count.
1888
 *
1889
 * @param $size
1890
 *   A size in bytes.
1891
 * @param $langcode
1892
 *   Optional language code to translate to a language other than what is used
1893
 *   to display the page.
1894
 *
1895
 * @return
1896
 *   A translated string representation of the size.
1897
 */
1898
function format_size($size, $langcode = NULL) {
1899
  if ($size < DRUPAL_KILOBYTE) {
1900
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
1901
  }
1902
  else {
1903
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
1904
    $units = array(
1905
      t('@size KB', array(), array('langcode' => $langcode)),
1906
      t('@size MB', array(), array('langcode' => $langcode)),
1907
      t('@size GB', array(), array('langcode' => $langcode)),
1908
      t('@size TB', array(), array('langcode' => $langcode)),
1909
      t('@size PB', array(), array('langcode' => $langcode)),
1910
      t('@size EB', array(), array('langcode' => $langcode)),
1911
      t('@size ZB', array(), array('langcode' => $langcode)),
1912
      t('@size YB', array(), array('langcode' => $langcode)),
1913
    );
1914
    foreach ($units as $unit) {
1915
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
1916
        $size = $size / DRUPAL_KILOBYTE;
1917
      }
1918
      else {
1919
        break;
1920
      }
1921
    }
1922
    return str_replace('@size', round($size, 2), $unit);
1923
  }
1924
}
1925

    
1926
/**
1927
 * Formats a time interval with the requested granularity.
1928
 *
1929
 * @param $interval
1930
 *   The length of the interval in seconds.
1931
 * @param $granularity
1932
 *   How many different units to display in the string.
1933
 * @param $langcode
1934
 *   Optional language code to translate to a language other than
1935
 *   what is used to display the page.
1936
 *
1937
 * @return
1938
 *   A translated string representation of the interval.
1939
 */
1940
function format_interval($interval, $granularity = 2, $langcode = NULL) {
1941
  $units = array(
1942
    '1 year|@count years' => 31536000,
1943
    '1 month|@count months' => 2592000,
1944
    '1 week|@count weeks' => 604800,
1945
    '1 day|@count days' => 86400,
1946
    '1 hour|@count hours' => 3600,
1947
    '1 min|@count min' => 60,
1948
    '1 sec|@count sec' => 1
1949
  );
1950
  $output = '';
1951
  foreach ($units as $key => $value) {
1952
    $key = explode('|', $key);
1953
    if ($interval >= $value) {
1954
      $output .= ($output ? ' ' : '') . format_plural(floor($interval / $value), $key[0], $key[1], array(), array('langcode' => $langcode));
1955
      $interval %= $value;
1956
      $granularity--;
1957
    }
1958

    
1959
    if ($granularity == 0) {
1960
      break;
1961
    }
1962
  }
1963
  return $output ? $output : t('0 sec', array(), array('langcode' => $langcode));
1964
}
1965

    
1966
/**
1967
 * Formats a date, using a date type or a custom date format string.
1968
 *
1969
 * @param $timestamp
1970
 *   A UNIX timestamp to format.
1971
 * @param $type
1972
 *   (optional) The format to use, one of:
1973
 *   - 'short', 'medium', or 'long' (the corresponding built-in date formats).
1974
 *   - The name of a date type defined by a module in hook_date_format_types(),
1975
 *     if it's been assigned a format.
1976
 *   - The machine name of an administrator-defined date format.
1977
 *   - 'custom', to use $format.
1978
 *   Defaults to 'medium'.
1979
 * @param $format
1980
 *   (optional) If $type is 'custom', a PHP date format string suitable for
1981
 *   input to date(). Use a backslash to escape ordinary text, so it does not
1982
 *   get interpreted as date format characters.
1983
 * @param $timezone
1984
 *   (optional) Time zone identifier, as described at
1985
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
1986
 *   display the page.
1987
 * @param $langcode
1988
 *   (optional) Language code to translate to. Defaults to the language used to
1989
 *   display the page.
1990
 *
1991
 * @return
1992
 *   A translated date string in the requested format.
1993
 */
1994
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
1995
  // Use the advanced drupal_static() pattern, since this is called very often.
1996
  static $drupal_static_fast;
1997
  if (!isset($drupal_static_fast)) {
1998
    $drupal_static_fast['timezones'] = &drupal_static(__FUNCTION__);
1999
  }
2000
  $timezones = &$drupal_static_fast['timezones'];
2001

    
2002
  if (!isset($timezone)) {
2003
    $timezone = date_default_timezone_get();
2004
  }
2005
  // Store DateTimeZone objects in an array rather than repeatedly
2006
  // constructing identical objects over the life of a request.
2007
  if (!isset($timezones[$timezone])) {
2008
    $timezones[$timezone] = timezone_open($timezone);
2009
  }
2010

    
2011
  // Use the default langcode if none is set.
2012
  global $language;
2013
  if (empty($langcode)) {
2014
    $langcode = isset($language->language) ? $language->language : 'en';
2015
  }
2016

    
2017
  switch ($type) {
2018
    case 'short':
2019
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
2020
      break;
2021

    
2022
    case 'long':
2023
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
2024
      break;
2025

    
2026
    case 'custom':
2027
      // No change to format.
2028
      break;
2029

    
2030
    case 'medium':
2031
    default:
2032
      // Retrieve the format of the custom $type passed.
2033
      if ($type != 'medium') {
2034
        $format = variable_get('date_format_' . $type, '');
2035
      }
2036
      // Fall back to 'medium'.
2037
      if ($format === '') {
2038
        $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
2039
      }
2040
      break;
2041
  }
2042

    
2043
  // Create a DateTime object from the timestamp.
2044
  $date_time = date_create('@' . $timestamp);
2045
  // Set the time zone for the DateTime object.
2046
  date_timezone_set($date_time, $timezones[$timezone]);
2047

    
2048
  // Encode markers that should be translated. 'A' becomes '\xEF\AA\xFF'.
2049
  // xEF and xFF are invalid UTF-8 sequences, and we assume they are not in the
2050
  // input string.
2051
  // Paired backslashes are isolated to prevent errors in read-ahead evaluation.
2052
  // The read-ahead expression ensures that A matches, but not \A.
2053
  $format = preg_replace(array('/\\\\\\\\/', '/(?<!\\\\)([AaeDlMTF])/'), array("\xEF\\\\\\\\\xFF", "\xEF\\\\\$1\$1\xFF"), $format);
2054

    
2055
  // Call date_format().
2056
  $format = date_format($date_time, $format);
2057

    
2058
  // Pass the langcode to _format_date_callback().
2059
  _format_date_callback(NULL, $langcode);
2060

    
2061
  // Translate the marked sequences.
2062
  return preg_replace_callback('/\xEF([AaeDlMTF]?)(.*?)\xFF/', '_format_date_callback', $format);
2063
}
2064

    
2065
/**
2066
 * Returns an ISO8601 formatted date based on the given date.
2067
 *
2068
 * Callback for use within hook_rdf_mapping() implementations.
2069
 *
2070
 * @param $date
2071
 *   A UNIX timestamp.
2072
 *
2073
 * @return string
2074
 *   An ISO8601 formatted date.
2075
 */
2076
function date_iso8601($date) {
2077
  // The DATE_ISO8601 constant cannot be used here because it does not match
2078
  // date('c') and produces invalid RDF markup.
2079
  return date('c', $date);
2080
}
2081

    
2082
/**
2083
 * Translates a formatted date string.
2084
 *
2085
 * Callback for preg_replace_callback() within format_date().
2086
 */
2087
function _format_date_callback(array $matches = NULL, $new_langcode = NULL) {
2088
  // We cache translations to avoid redundant and rather costly calls to t().
2089
  static $cache, $langcode;
2090

    
2091
  if (!isset($matches)) {
2092
    $langcode = $new_langcode;
2093
    return;
2094
  }
2095

    
2096
  $code = $matches[1];
2097
  $string = $matches[2];
2098

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

    
2104
    if ($code == 'F') {
2105
      $options['context'] = 'Long month name';
2106
    }
2107

    
2108
    if ($code == '') {
2109
      $cache[$langcode][$code][$string] = $string;
2110
    }
2111
    else {
2112
      $cache[$langcode][$code][$string] = t($string, array(), $options);
2113
    }
2114
  }
2115
  return $cache[$langcode][$code][$string];
2116
}
2117

    
2118
/**
2119
 * Format a username.
2120
 *
2121
 * This is also the label callback implementation of
2122
 * callback_entity_info_label() for user_entity_info().
2123
 *
2124
 * By default, the passed-in object's 'name' property is used if it exists, or
2125
 * else, the site-defined value for the 'anonymous' variable. However, a module
2126
 * may override this by implementing hook_username_alter(&$name, $account).
2127
 *
2128
 * @see hook_username_alter()
2129
 *
2130
 * @param $account
2131
 *   The account object for the user whose name is to be formatted.
2132
 *
2133
 * @return
2134
 *   An unsanitized string with the username to display. The code receiving
2135
 *   this result must ensure that check_plain() is called on it before it is
2136
 *   printed to the page.
2137
 */
2138
function format_username($account) {
2139
  $name = !empty($account->name) ? $account->name : variable_get('anonymous', t('Anonymous'));
2140
  drupal_alter('username', $name, $account);
2141
  return $name;
2142
}
2143

    
2144
/**
2145
 * @} End of "defgroup format".
2146
 */
2147

    
2148
/**
2149
 * Generates an internal or external URL.
2150
 *
2151
 * When creating links in modules, consider whether l() could be a better
2152
 * alternative than url().
2153
 *
2154
 * @param $path
2155
 *   (optional) The internal path or external URL being linked to, such as
2156
 *   "node/34" or "http://example.com/foo". The default value is equivalent to
2157
 *   passing in '<front>'. A few notes:
2158
 *   - If you provide a full URL, it will be considered an external URL.
2159
 *   - If you provide only the path (e.g. "node/34"), it will be
2160
 *     considered an internal link. In this case, it should be a system URL,
2161
 *     and it will be replaced with the alias, if one exists. Additional query
2162
 *     arguments for internal paths must be supplied in $options['query'], not
2163
 *     included in $path.
2164
 *   - If you provide an internal path and $options['alias'] is set to TRUE, the
2165
 *     path is assumed already to be the correct path alias, and the alias is
2166
 *     not looked up.
2167
 *   - The special string '<front>' generates a link to the site's base URL.
2168
 *   - If your external URL contains a query (e.g. http://example.com/foo?a=b),
2169
 *     then you can either URL encode the query keys and values yourself and
2170
 *     include them in $path, or use $options['query'] to let this function
2171
 *     URL encode them.
2172
 * @param $options
2173
 *   (optional) An associative array of additional options, with the following
2174
 *   elements:
2175
 *   - 'query': An array of query key/value-pairs (without any URL-encoding) to
2176
 *     append to the URL.
2177
 *   - 'fragment': A fragment identifier (named anchor) to append to the URL.
2178
 *     Do not include the leading '#' character.
2179
 *   - 'absolute': Defaults to FALSE. Whether to force the output to be an
2180
 *     absolute link (beginning with http:). Useful for links that will be
2181
 *     displayed outside the site, such as in an RSS feed.
2182
 *   - 'alias': Defaults to FALSE. Whether the given path is a URL alias
2183
 *     already.
2184
 *   - 'external': Whether the given path is an external URL.
2185
 *   - 'language': An optional language object. If the path being linked to is
2186
 *     internal to the site, $options['language'] is used to look up the alias
2187
 *     for the URL. If $options['language'] is omitted, the global $language_url
2188
 *     will be used.
2189
 *   - 'https': Whether this URL should point to a secure location. If not
2190
 *     defined, the current scheme is used, so the user stays on HTTP or HTTPS
2191
 *     respectively. TRUE enforces HTTPS and FALSE enforces HTTP, but HTTPS can
2192
 *     only be enforced when the variable 'https' is set to TRUE.
2193
 *   - 'base_url': Only used internally, to modify the base URL when a language
2194
 *     dependent URL requires so.
2195
 *   - 'prefix': Only used internally, to modify the path when a language
2196
 *     dependent URL requires so.
2197
 *   - 'script': The script filename in Drupal's root directory to use when
2198
 *     clean URLs are disabled, such as 'index.php'. Defaults to an empty
2199
 *     string, as most modern web servers automatically find 'index.php'. If
2200
 *     clean URLs are disabled, the value of $path is appended as query
2201
 *     parameter 'q' to $options['script'] in the returned URL. When deploying
2202
 *     Drupal on a web server that cannot be configured to automatically find
2203
 *     index.php, then hook_url_outbound_alter() can be implemented to force
2204
 *     this value to 'index.php'.
2205
 *   - 'entity_type': The entity type of the object that called url(). Only
2206
 *     set if url() is invoked by entity_uri().
2207
 *   - 'entity': The entity object (such as a node) for which the URL is being
2208
 *     generated. Only set if url() is invoked by entity_uri().
2209
 *
2210
 * @return
2211
 *   A string containing a URL to the given path.
2212
 */
2213
function url($path = NULL, array $options = array()) {
2214
  // Merge in defaults.
2215
  $options += array(
2216
    'fragment' => '',
2217
    'query' => array(),
2218
    'absolute' => FALSE,
2219
    'alias' => FALSE,
2220
    'prefix' => ''
2221
  );
2222

    
2223
  // A duplicate of the code from url_is_external() to avoid needing another
2224
  // function call, since performance inside url() is critical.
2225
  if (!isset($options['external'])) {
2226
    // Return an external link if $path contains an allowed absolute URL. Avoid
2227
    // calling drupal_strip_dangerous_protocols() if there is any slash (/),
2228
    // hash (#) or question_mark (?) before the colon (:) occurrence - if any -
2229
    // as this would clearly mean it is not a URL. If the path starts with 2
2230
    // slashes then it is always considered an external URL without an explicit
2231
    // protocol part.
2232
    $colonpos = strpos($path, ':');
2233
    $options['external'] = (strpos($path, '//') === 0)
2234
      || ($colonpos !== FALSE
2235
        && !preg_match('![/?#]!', substr($path, 0, $colonpos))
2236
        && drupal_strip_dangerous_protocols($path) == $path);
2237
  }
2238

    
2239
  // Preserve the original path before altering or aliasing.
2240
  $original_path = $path;
2241

    
2242
  // Allow other modules to alter the outbound URL and options.
2243
  drupal_alter('url_outbound', $path, $options, $original_path);
2244

    
2245
  if (isset($options['fragment']) && $options['fragment'] !== '') {
2246
    $options['fragment'] = '#' . $options['fragment'];
2247
  }
2248

    
2249
  if ($options['external']) {
2250
    // Split off the fragment.
2251
    if (strpos($path, '#') !== FALSE) {
2252
      list($path, $old_fragment) = explode('#', $path, 2);
2253
      // If $options contains no fragment, take it over from the path.
2254
      if (isset($old_fragment) && !$options['fragment']) {
2255
        $options['fragment'] = '#' . $old_fragment;
2256
      }
2257
    }
2258
    // Append the query.
2259
    if ($options['query']) {
2260
      $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . drupal_http_build_query($options['query']);
2261
    }
2262
    if (isset($options['https']) && variable_get('https', FALSE)) {
2263
      if ($options['https'] === TRUE) {
2264
        $path = str_replace('http://', 'https://', $path);
2265
      }
2266
      elseif ($options['https'] === FALSE) {
2267
        $path = str_replace('https://', 'http://', $path);
2268
      }
2269
    }
2270
    // Reassemble.
2271
    return $path . $options['fragment'];
2272
  }
2273

    
2274
  // Strip leading slashes from internal paths to prevent them becoming external
2275
  // URLs without protocol. /example.com should not be turned into
2276
  // //example.com.
2277
  $path = ltrim($path, '/');
2278

    
2279
  global $base_url, $base_secure_url, $base_insecure_url;
2280

    
2281
  // The base_url might be rewritten from the language rewrite in domain mode.
2282
  if (!isset($options['base_url'])) {
2283
    if (isset($options['https']) && variable_get('https', FALSE)) {
2284
      if ($options['https'] === TRUE) {
2285
        $options['base_url'] = $base_secure_url;
2286
        $options['absolute'] = TRUE;
2287
      }
2288
      elseif ($options['https'] === FALSE) {
2289
        $options['base_url'] = $base_insecure_url;
2290
        $options['absolute'] = TRUE;
2291
      }
2292
    }
2293
    else {
2294
      $options['base_url'] = $base_url;
2295
    }
2296
  }
2297

    
2298
  // The special path '<front>' links to the default front page.
2299
  if ($path == '<front>') {
2300
    $path = '';
2301
  }
2302
  elseif (!empty($path) && !$options['alias']) {
2303
    $language = isset($options['language']) && isset($options['language']->language) ? $options['language']->language : '';
2304
    $alias = drupal_get_path_alias($original_path, $language);
2305
    if ($alias != $original_path) {
2306
      $path = $alias;
2307
    }
2308
  }
2309

    
2310
  $base = $options['absolute'] ? $options['base_url'] . '/' : base_path();
2311
  $prefix = empty($path) ? rtrim($options['prefix'], '/') : $options['prefix'];
2312

    
2313
  // With Clean URLs.
2314
  if (!empty($GLOBALS['conf']['clean_url'])) {
2315
    $path = drupal_encode_path($prefix . $path);
2316
    if ($options['query']) {
2317
      return $base . $path . '?' . drupal_http_build_query($options['query']) . $options['fragment'];
2318
    }
2319
    else {
2320
      return $base . $path . $options['fragment'];
2321
    }
2322
  }
2323
  // Without Clean URLs.
2324
  else {
2325
    $path = $prefix . $path;
2326
    $query = array();
2327
    if (!empty($path)) {
2328
      $query['q'] = $path;
2329
    }
2330
    if ($options['query']) {
2331
      // We do not use array_merge() here to prevent overriding $path via query
2332
      // parameters.
2333
      $query += $options['query'];
2334
    }
2335
    $query = $query ? ('?' . drupal_http_build_query($query)) : '';
2336
    $script = isset($options['script']) ? $options['script'] : '';
2337
    return $base . $script . $query . $options['fragment'];
2338
  }
2339
}
2340

    
2341
/**
2342
 * Returns TRUE if a path is external to Drupal (e.g. http://example.com).
2343
 *
2344
 * If a path cannot be assessed by Drupal's menu handler, then we must
2345
 * treat it as potentially insecure.
2346
 *
2347
 * @param $path
2348
 *   The internal path or external URL being linked to, such as "node/34" or
2349
 *   "http://example.com/foo".
2350
 *
2351
 * @return
2352
 *   Boolean TRUE or FALSE, where TRUE indicates an external path.
2353
 */
2354
function url_is_external($path) {
2355
  $colonpos = strpos($path, ':');
2356
  // Avoid calling drupal_strip_dangerous_protocols() if there is any slash (/),
2357
  // hash (#) or question_mark (?) before the colon (:) occurrence - if any - as
2358
  // this would clearly mean it is not a URL. If the path starts with 2 slashes
2359
  // then it is always considered an external URL without an explicit protocol
2360
  // part.
2361
  return (strpos($path, '//') === 0)
2362
    || ($colonpos !== FALSE
2363
      && !preg_match('![/?#]!', substr($path, 0, $colonpos))
2364
      && drupal_strip_dangerous_protocols($path) == $path);
2365
}
2366

    
2367
/**
2368
 * Formats an attribute string for an HTTP header.
2369
 *
2370
 * @param $attributes
2371
 *   An associative array of attributes such as 'rel'.
2372
 *
2373
 * @return
2374
 *   A ; separated string ready for insertion in a HTTP header. No escaping is
2375
 *   performed for HTML entities, so this string is not safe to be printed.
2376
 *
2377
 * @see drupal_add_http_header()
2378
 */
2379
function drupal_http_header_attributes(array $attributes = array()) {
2380
  foreach ($attributes as $attribute => &$data) {
2381
    if (is_array($data)) {
2382
      $data = implode(' ', $data);
2383
    }
2384
    $data = $attribute . '="' . $data . '"';
2385
  }
2386
  return $attributes ? ' ' . implode('; ', $attributes) : '';
2387
}
2388

    
2389
/**
2390
 * Converts an associative array to an XML/HTML tag attribute string.
2391
 *
2392
 * Each array key and its value will be formatted into an attribute string.
2393
 * If a value is itself an array, then its elements are concatenated to a single
2394
 * space-delimited string (for example, a class attribute with multiple values).
2395
 *
2396
 * Attribute values are sanitized by running them through check_plain().
2397
 * Attribute names are not automatically sanitized. When using user-supplied
2398
 * attribute names, it is strongly recommended to allow only white-listed names,
2399
 * since certain attributes carry security risks and can be abused.
2400
 *
2401
 * Examples of security aspects when using drupal_attributes:
2402
 * @code
2403
 *   // By running the value in the following statement through check_plain,
2404
 *   // the malicious script is neutralized.
2405
 *   drupal_attributes(array('title' => t('<script>steal_cookie();</script>')));
2406
 *
2407
 *   // The statement below demonstrates dangerous use of drupal_attributes, and
2408
 *   // will return an onmouseout attribute with JavaScript code that, when used
2409
 *   // as attribute in a tag, will cause users to be redirected to another site.
2410
 *   //
2411
 *   // In this case, the 'onmouseout' attribute should not be whitelisted --
2412
 *   // you don't want users to have the ability to add this attribute or others
2413
 *   // that take JavaScript commands.
2414
 *   drupal_attributes(array('onmouseout' => 'window.location="http://malicious.com/";')));
2415
 * @endcode
2416
 *
2417
 * @param $attributes
2418
 *   An associative array of key-value pairs to be converted to attributes.
2419
 *
2420
 * @return
2421
 *   A string ready for insertion in a tag (starts with a space).
2422
 *
2423
 * @ingroup sanitization
2424
 */
2425
function drupal_attributes(array $attributes = array()) {
2426
  foreach ($attributes as $attribute => &$data) {
2427
    $data = implode(' ', (array) $data);
2428
    $data = $attribute . '="' . check_plain($data) . '"';
2429
  }
2430
  return $attributes ? ' ' . implode(' ', $attributes) : '';
2431
}
2432

    
2433
/**
2434
 * Formats an internal or external URL link as an HTML anchor tag.
2435
 *
2436
 * This function correctly handles aliased paths and adds an 'active' class
2437
 * attribute to links that point to the current page (for theming), so all
2438
 * internal links output by modules should be generated by this function if
2439
 * possible.
2440
 *
2441
 * However, for links enclosed in translatable text you should use t() and
2442
 * embed the HTML anchor tag directly in the translated string. For example:
2443
 * @code
2444
 * t('Visit the <a href="@url">settings</a> page', array('@url' => url('admin')));
2445
 * @endcode
2446
 * This keeps the context of the link title ('settings' in the example) for
2447
 * translators.
2448
 *
2449
 * @param string $text
2450
 *   The translated link text for the anchor tag.
2451
 * @param string $path
2452
 *   The internal path or external URL being linked to, such as "node/34" or
2453
 *   "http://example.com/foo". After the url() function is called to construct
2454
 *   the URL from $path and $options, the resulting URL is passed through
2455
 *   check_plain() before it is inserted into the HTML anchor tag, to ensure
2456
 *   well-formed HTML. See url() for more information and notes.
2457
 * @param array $options
2458
 *   An associative array of additional options. Defaults to an empty array. It
2459
 *   may contain the following elements.
2460
 *   - 'attributes': An associative array of HTML attributes to apply to the
2461
 *     anchor tag. If element 'class' is included, it must be an array; 'title'
2462
 *     must be a string; other elements are more flexible, as they just need
2463
 *     to work in a call to drupal_attributes($options['attributes']).
2464
 *   - 'html' (default FALSE): Whether $text is HTML or just plain-text. For
2465
 *     example, to make an image tag into a link, this must be set to TRUE, or
2466
 *     you will see the escaped HTML image tag. $text is not sanitized if
2467
 *     'html' is TRUE. The calling function must ensure that $text is already
2468
 *     safe.
2469
 *   - 'language': An optional language object. If the path being linked to is
2470
 *     internal to the site, $options['language'] is used to determine whether
2471
 *     the link is "active", or pointing to the current page (the language as
2472
 *     well as the path must match). This element is also used by url().
2473
 *   - Additional $options elements used by the url() function.
2474
 *
2475
 * @return string
2476
 *   An HTML string containing a link to the given path.
2477
 *
2478
 * @see url()
2479
 */
2480
function l($text, $path, array $options = array()) {
2481
  global $language_url;
2482
  static $use_theme = NULL;
2483

    
2484
  // Merge in defaults.
2485
  $options += array(
2486
    'attributes' => array(),
2487
    'html' => FALSE,
2488
  );
2489

    
2490
  // Append active class.
2491
  if (($path == $_GET['q'] || ($path == '<front>' && drupal_is_front_page())) &&
2492
      (empty($options['language']) || $options['language']->language == $language_url->language)) {
2493
    $options['attributes']['class'][] = 'active';
2494
  }
2495

    
2496
  // Remove all HTML and PHP tags from a tooltip. For best performance, we act only
2497
  // if a quick strpos() pre-check gave a suspicion (because strip_tags() is expensive).
2498
  if (isset($options['attributes']['title']) && strpos($options['attributes']['title'], '<') !== FALSE) {
2499
    $options['attributes']['title'] = strip_tags($options['attributes']['title']);
2500
  }
2501

    
2502
  // Determine if rendering of the link is to be done with a theme function
2503
  // or the inline default. Inline is faster, but if the theme system has been
2504
  // loaded and a module or theme implements a preprocess or process function
2505
  // or overrides the theme_link() function, then invoke theme(). Preliminary
2506
  // benchmarks indicate that invoking theme() can slow down the l() function
2507
  // by 20% or more, and that some of the link-heavy Drupal pages spend more
2508
  // than 10% of the total page request time in the l() function.
2509
  if (!isset($use_theme) && function_exists('theme')) {
2510
    // Allow edge cases to prevent theme initialization and force inline link
2511
    // rendering.
2512
    if (variable_get('theme_link', TRUE)) {
2513
      drupal_theme_initialize();
2514
      $registry = theme_get_registry(FALSE);
2515
      // We don't want to duplicate functionality that's in theme(), so any
2516
      // hint of a module or theme doing anything at all special with the 'link'
2517
      // theme hook should simply result in theme() being called. This includes
2518
      // the overriding of theme_link() with an alternate function or template,
2519
      // the presence of preprocess or process functions, or the presence of
2520
      // include files.
2521
      $use_theme = !isset($registry['link']['function']) || ($registry['link']['function'] != 'theme_link');
2522
      $use_theme = $use_theme || !empty($registry['link']['preprocess functions']) || !empty($registry['link']['process functions']) || !empty($registry['link']['includes']);
2523
    }
2524
    else {
2525
      $use_theme = FALSE;
2526
    }
2527
  }
2528
  if ($use_theme) {
2529
    return theme('link', array('text' => $text, 'path' => $path, 'options' => $options));
2530
  }
2531
  // The result of url() is a plain-text URL. Because we are using it here
2532
  // in an HTML argument context, we need to encode it properly.
2533
  return '<a href="' . check_plain(url($path, $options)) . '"' . drupal_attributes($options['attributes']) . '>' . ($options['html'] ? $text : check_plain($text)) . '</a>';
2534
}
2535

    
2536
/**
2537
 * Delivers a page callback result to the browser in the appropriate format.
2538
 *
2539
 * This function is most commonly called by menu_execute_active_handler(), but
2540
 * can also be called by error conditions such as drupal_not_found(),
2541
 * drupal_access_denied(), and drupal_site_offline().
2542
 *
2543
 * When a user requests a page, index.php calls menu_execute_active_handler(),
2544
 * which calls the 'page callback' function registered in hook_menu(). The page
2545
 * callback function can return one of:
2546
 * - NULL: to indicate no content.
2547
 * - An integer menu status constant: to indicate an error condition.
2548
 * - A string of HTML content.
2549
 * - A renderable array of content.
2550
 * Returning a renderable array rather than a string of HTML is preferred,
2551
 * because that provides modules with more flexibility in customizing the final
2552
 * result.
2553
 *
2554
 * When the page callback returns its constructed content to
2555
 * menu_execute_active_handler(), this function gets called. The purpose of
2556
 * this function is to determine the most appropriate 'delivery callback'
2557
 * function to route the content to. The delivery callback function then
2558
 * sends the content to the browser in the needed format. The default delivery
2559
 * callback is drupal_deliver_html_page(), which delivers the content as an HTML
2560
 * page, complete with blocks in addition to the content. This default can be
2561
 * overridden on a per menu router item basis by setting 'delivery callback' in
2562
 * hook_menu() or hook_menu_alter(), and can also be overridden on a per request
2563
 * basis in hook_page_delivery_callback_alter().
2564
 *
2565
 * For example, the same page callback function can be used for an HTML
2566
 * version of the page and an Ajax version of the page. The page callback
2567
 * function just needs to decide what content is to be returned and the
2568
 * delivery callback function will send it as an HTML page or an Ajax
2569
 * response, as appropriate.
2570
 *
2571
 * In order for page callbacks to be reusable in different delivery formats,
2572
 * they should not issue any "print" or "echo" statements, but instead just
2573
 * return content.
2574
 *
2575
 * Also note that this function does not perform access checks. The delivery
2576
 * callback function specified in hook_menu(), hook_menu_alter(), or
2577
 * hook_page_delivery_callback_alter() will be called even if the router item
2578
 * access checks fail. This is intentional (it is needed for JSON and other
2579
 * purposes), but it has security implications. Do not call this function
2580
 * directly unless you understand the security implications, and be careful in
2581
 * writing delivery callbacks, so that they do not violate security. See
2582
 * drupal_deliver_html_page() for an example of a delivery callback that
2583
 * respects security.
2584
 *
2585
 * @param $page_callback_result
2586
 *   The result of a page callback. Can be one of:
2587
 *   - NULL: to indicate no content.
2588
 *   - An integer menu status constant: to indicate an error condition.
2589
 *   - A string of HTML content.
2590
 *   - A renderable array of content.
2591
 * @param $default_delivery_callback
2592
 *   (Optional) If given, it is the name of a delivery function most likely
2593
 *   to be appropriate for the page request as determined by the calling
2594
 *   function (e.g., menu_execute_active_handler()). If not given, it is
2595
 *   determined from the menu router information of the current page.
2596
 *
2597
 * @see menu_execute_active_handler()
2598
 * @see hook_menu()
2599
 * @see hook_menu_alter()
2600
 * @see hook_page_delivery_callback_alter()
2601
 */
2602
function drupal_deliver_page($page_callback_result, $default_delivery_callback = NULL) {
2603
  if (!isset($default_delivery_callback) && ($router_item = menu_get_item())) {
2604
    $default_delivery_callback = $router_item['delivery_callback'];
2605
  }
2606
  $delivery_callback = !empty($default_delivery_callback) ? $default_delivery_callback : 'drupal_deliver_html_page';
2607
  // Give modules a chance to alter the delivery callback used, based on
2608
  // request-time context (e.g., HTTP request headers).
2609
  drupal_alter('page_delivery_callback', $delivery_callback);
2610
  if (function_exists($delivery_callback)) {
2611
    $delivery_callback($page_callback_result);
2612
  }
2613
  else {
2614
    // If a delivery callback is specified, but doesn't exist as a function,
2615
    // something is wrong, but don't print anything, since it's not known
2616
    // what format the response needs to be in.
2617
    watchdog('delivery callback not found', 'callback %callback not found: %q.', array('%callback' => $delivery_callback, '%q' => $_GET['q']), WATCHDOG_ERROR);
2618
  }
2619
}
2620

    
2621
/**
2622
 * Packages and sends the result of a page callback to the browser as HTML.
2623
 *
2624
 * @param $page_callback_result
2625
 *   The result of a page callback. Can be one of:
2626
 *   - NULL: to indicate no content.
2627
 *   - An integer menu status constant: to indicate an error condition.
2628
 *   - A string of HTML content.
2629
 *   - A renderable array of content.
2630
 *
2631
 * @see drupal_deliver_page()
2632
 */
2633
function drupal_deliver_html_page($page_callback_result) {
2634
  // Emit the correct charset HTTP header, but not if the page callback
2635
  // result is NULL, since that likely indicates that it printed something
2636
  // in which case, no further headers may be sent, and not if code running
2637
  // for this page request has already set the content type header.
2638
  if (isset($page_callback_result) && is_null(drupal_get_http_header('Content-Type'))) {
2639
    drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
2640
  }
2641

    
2642
  // Send appropriate HTTP-Header for browsers and search engines.
2643
  global $language;
2644
  drupal_add_http_header('Content-Language', $language->language);
2645

    
2646
  // Menu status constants are integers; page content is a string or array.
2647
  if (is_int($page_callback_result)) {
2648
    // @todo: Break these up into separate functions?
2649
    switch ($page_callback_result) {
2650
      case MENU_NOT_FOUND:
2651
        // Print a 404 page.
2652
        drupal_add_http_header('Status', '404 Not Found');
2653

    
2654
        watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
2655

    
2656
        // Check for and return a fast 404 page if configured.
2657
        drupal_fast_404();
2658

    
2659
        // Keep old path for reference, and to allow forms to redirect to it.
2660
        if (!isset($_GET['destination'])) {
2661
          // Make sure that the current path is not interpreted as external URL.
2662
          if (!url_is_external($_GET['q'])) {
2663
            $_GET['destination'] = $_GET['q'];
2664
          }
2665
        }
2666

    
2667
        $path = drupal_get_normal_path(variable_get('site_404', ''));
2668
        if ($path && $path != $_GET['q']) {
2669
          // Custom 404 handler. Set the active item in case there are tabs to
2670
          // display, or other dependencies on the path.
2671
          menu_set_active_item($path);
2672
          $return = menu_execute_active_handler($path, FALSE);
2673
        }
2674

    
2675
        if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
2676
          // Standard 404 handler.
2677
          drupal_set_title(t('Page not found'));
2678
          $return = t('The requested page "@path" could not be found.', array('@path' => request_uri()));
2679
        }
2680

    
2681
        drupal_set_page_content($return);
2682
        $page = element_info('page');
2683
        print drupal_render_page($page);
2684
        break;
2685

    
2686
      case MENU_ACCESS_DENIED:
2687
        // Print a 403 page.
2688
        drupal_add_http_header('Status', '403 Forbidden');
2689
        watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
2690

    
2691
        // Keep old path for reference, and to allow forms to redirect to it.
2692
        if (!isset($_GET['destination'])) {
2693
          // Make sure that the current path is not interpreted as external URL.
2694
          if (!url_is_external($_GET['q'])) {
2695
            $_GET['destination'] = $_GET['q'];
2696
          }
2697
        }
2698

    
2699
        $path = drupal_get_normal_path(variable_get('site_403', ''));
2700
        if ($path && $path != $_GET['q']) {
2701
          // Custom 403 handler. Set the active item in case there are tabs to
2702
          // display or other dependencies on the path.
2703
          menu_set_active_item($path);
2704
          $return = menu_execute_active_handler($path, FALSE);
2705
        }
2706

    
2707
        if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
2708
          // Standard 403 handler.
2709
          drupal_set_title(t('Access denied'));
2710
          $return = t('You are not authorized to access this page.');
2711
        }
2712

    
2713
        print drupal_render_page($return);
2714
        break;
2715

    
2716
      case MENU_SITE_OFFLINE:
2717
        // Print a 503 page.
2718
        drupal_maintenance_theme();
2719
        drupal_add_http_header('Status', '503 Service unavailable');
2720
        drupal_set_title(t('Site under maintenance'));
2721
        print theme('maintenance_page', array('content' => filter_xss_admin(variable_get('maintenance_mode_message',
2722
          t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal')))))));
2723
        break;
2724
    }
2725
  }
2726
  elseif (isset($page_callback_result)) {
2727
    // Print anything besides a menu constant, assuming it's not NULL or
2728
    // undefined.
2729
    print drupal_render_page($page_callback_result);
2730
  }
2731

    
2732
  // Perform end-of-request tasks.
2733
  drupal_page_footer();
2734
}
2735

    
2736
/**
2737
 * Performs end-of-request tasks.
2738
 *
2739
 * This function sets the page cache if appropriate, and allows modules to
2740
 * react to the closing of the page by calling hook_exit().
2741
 */
2742
function drupal_page_footer() {
2743
  global $user;
2744

    
2745
  module_invoke_all('exit');
2746

    
2747
  // Commit the user session, if needed.
2748
  drupal_session_commit();
2749

    
2750
  if (variable_get('cache', 0) && ($cache = drupal_page_set_cache())) {
2751
    drupal_serve_page_from_cache($cache);
2752
  }
2753
  else {
2754
    ob_flush();
2755
  }
2756

    
2757
  _registry_check_code(REGISTRY_WRITE_LOOKUP_CACHE);
2758
  drupal_cache_system_paths();
2759
  module_implements_write_cache();
2760
  system_run_automated_cron();
2761
}
2762

    
2763
/**
2764
 * Performs end-of-request tasks.
2765
 *
2766
 * In some cases page requests need to end without calling drupal_page_footer().
2767
 * In these cases, call drupal_exit() instead. There should rarely be a reason
2768
 * to call exit instead of drupal_exit();
2769
 *
2770
 * @param $destination
2771
 *   If this function is called from drupal_goto(), then this argument
2772
 *   will be a fully-qualified URL that is the destination of the redirect.
2773
 *   This should be passed along to hook_exit() implementations.
2774
 */
2775
function drupal_exit($destination = NULL) {
2776
  if (drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL) {
2777
    if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
2778
      module_invoke_all('exit', $destination);
2779
    }
2780
    drupal_session_commit();
2781
  }
2782
  exit;
2783
}
2784

    
2785
/**
2786
 * Forms an associative array from a linear array.
2787
 *
2788
 * This function walks through the provided array and constructs an associative
2789
 * array out of it. The keys of the resulting array will be the values of the
2790
 * input array. The values will be the same as the keys unless a function is
2791
 * specified, in which case the output of the function is used for the values
2792
 * instead.
2793
 *
2794
 * @param $array
2795
 *   A linear array.
2796
 * @param $function
2797
 *   A name of a function to apply to all values before output.
2798
 *
2799
 * @return
2800
 *   An associative array.
2801
 */
2802
function drupal_map_assoc($array, $function = NULL) {
2803
  // array_combine() fails with empty arrays:
2804
  // http://bugs.php.net/bug.php?id=34857.
2805
  $array = !empty($array) ? array_combine($array, $array) : array();
2806
  if (is_callable($function)) {
2807
    $array = array_map($function, $array);
2808
  }
2809
  return $array;
2810
}
2811

    
2812
/**
2813
 * Attempts to set the PHP maximum execution time.
2814
 *
2815
 * This function is a wrapper around the PHP function set_time_limit().
2816
 * When called, set_time_limit() restarts the timeout counter from zero.
2817
 * In other words, if the timeout is the default 30 seconds, and 25 seconds
2818
 * into script execution a call such as set_time_limit(20) is made, the
2819
 * script will run for a total of 45 seconds before timing out.
2820
 *
2821
 * If the current time limit is not unlimited it is possible to decrease the
2822
 * total time limit if the sum of the new time limit and the current time spent
2823
 * running the script is inferior to the original time limit. It is inherent to
2824
 * the way set_time_limit() works, it should rather be called with an
2825
 * appropriate value every time you need to allocate a certain amount of time
2826
 * to execute a task than only once at the beginning of the script.
2827
 *
2828
 * Before calling set_time_limit(), we check if this function is available
2829
 * because it could be disabled by the server administrator. We also hide all
2830
 * the errors that could occur when calling set_time_limit(), because it is
2831
 * not possible to reliably ensure that PHP or a security extension will
2832
 * not issue a warning/error if they prevent the use of this function.
2833
 *
2834
 * @param $time_limit
2835
 *   An integer specifying the new time limit, in seconds. A value of 0
2836
 *   indicates unlimited execution time.
2837
 *
2838
 * @ingroup php_wrappers
2839
 */
2840
function drupal_set_time_limit($time_limit) {
2841
  if (function_exists('set_time_limit')) {
2842
    $current = ini_get('max_execution_time');
2843
    // Do not set time limit if it is currently unlimited.
2844
    if ($current != 0) {
2845
      @set_time_limit($time_limit);
2846
    }
2847
  }
2848
}
2849

    
2850
/**
2851
 * Returns the path to a system item (module, theme, etc.).
2852
 *
2853
 * @param $type
2854
 *   The type of the item (i.e. theme, theme_engine, module, profile).
2855
 * @param $name
2856
 *   The name of the item for which the path is requested.
2857
 *
2858
 * @return
2859
 *   The path to the requested item or an empty string if the item is not found.
2860
 */
2861
function drupal_get_path($type, $name) {
2862
  return dirname(drupal_get_filename($type, $name));
2863
}
2864

    
2865
/**
2866
 * Returns the base URL path (i.e., directory) of the Drupal installation.
2867
 *
2868
 * base_path() adds a "/" to the beginning and end of the returned path if the
2869
 * path is not empty. At the very least, this will return "/".
2870
 *
2871
 * Examples:
2872
 * - http://example.com returns "/" because the path is empty.
2873
 * - http://example.com/drupal/folder returns "/drupal/folder/".
2874
 */
2875
function base_path() {
2876
  return $GLOBALS['base_path'];
2877
}
2878

    
2879
/**
2880
 * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
2881
 *
2882
 * This function can be called as long the HTML header hasn't been sent, which
2883
 * on normal pages is up through the preprocess step of theme('html'). Adding
2884
 * a link will overwrite a prior link with the exact same 'rel' and 'href'
2885
 * attributes.
2886
 *
2887
 * @param $attributes
2888
 *   Associative array of element attributes including 'href' and 'rel'.
2889
 * @param $header
2890
 *   Optional flag to determine if a HTTP 'Link:' header should be sent.
2891
 */
2892
function drupal_add_html_head_link($attributes, $header = FALSE) {
2893
  $element = array(
2894
    '#tag' => 'link',
2895
    '#attributes' => $attributes,
2896
  );
2897
  $href = $attributes['href'];
2898

    
2899
  if ($header) {
2900
    // Also add a HTTP header "Link:".
2901
    $href = '<' . check_plain($attributes['href']) . '>;';
2902
    unset($attributes['href']);
2903
    $element['#attached']['drupal_add_http_header'][] = array('Link',  $href . drupal_http_header_attributes($attributes), TRUE);
2904
  }
2905

    
2906
  drupal_add_html_head($element, 'drupal_add_html_head_link:' . $attributes['rel'] . ':' . $href);
2907
}
2908

    
2909
/**
2910
 * Adds a cascading stylesheet to the stylesheet queue.
2911
 *
2912
 * Calling drupal_static_reset('drupal_add_css') will clear all cascading
2913
 * stylesheets added so far.
2914
 *
2915
 * If CSS aggregation/compression is enabled, all cascading style sheets added
2916
 * with $options['preprocess'] set to TRUE will be merged into one aggregate
2917
 * file and compressed by removing all extraneous white space.
2918
 * Preprocessed inline stylesheets will not be aggregated into this single file;
2919
 * instead, they are just compressed upon output on the page. Externally hosted
2920
 * stylesheets are never aggregated or compressed.
2921
 *
2922
 * The reason for aggregating the files is outlined quite thoroughly here:
2923
 * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
2924
 * to request overhead, one bigger file just loads faster than two smaller ones
2925
 * half its size."
2926
 *
2927
 * $options['preprocess'] should be only set to TRUE when a file is required for
2928
 * all typical visitors and most pages of a site. It is critical that all
2929
 * preprocessed files are added unconditionally on every page, even if the
2930
 * files do not happen to be needed on a page. This is normally done by calling
2931
 * drupal_add_css() in a hook_init() implementation.
2932
 *
2933
 * Non-preprocessed files should only be added to the page when they are
2934
 * actually needed.
2935
 *
2936
 * @param $data
2937
 *   (optional) The stylesheet data to be added, depending on what is passed
2938
 *   through to the $options['type'] parameter:
2939
 *   - 'file': The path to the CSS file relative to the base_path(), or a
2940
 *     stream wrapper URI. For example: "modules/devel/devel.css" or
2941
 *     "public://generated_css/stylesheet_1.css". Note that Modules should
2942
 *     always prefix the names of their CSS files with the module name; for
2943
 *     example, system-menus.css rather than simply menus.css. Themes can
2944
 *     override module-supplied CSS files based on their filenames, and this
2945
 *     prefixing helps prevent confusing name collisions for theme developers.
2946
 *     See drupal_get_css() where the overrides are performed. Also, if the
2947
 *     direction of the current language is right-to-left (Hebrew, Arabic,
2948
 *     etc.), the function will also look for an RTL CSS file and append it to
2949
 *     the list. The name of this file should have an '-rtl.css' suffix. For
2950
 *     example, a CSS file called 'mymodule-name.css' will have a
2951
 *     'mymodule-name-rtl.css' file added to the list, if exists in the same
2952
 *     directory. This CSS file should contain overrides for properties which
2953
 *     should be reversed or otherwise different in a right-to-left display.
2954
 *   - 'inline': A string of CSS that should be placed in the given scope. Note
2955
 *     that it is better practice to use 'file' stylesheets, rather than
2956
 *     'inline', as the CSS would then be aggregated and cached.
2957
 *   - 'external': The absolute path to an external CSS file that is not hosted
2958
 *     on the local server. These files will not be aggregated if CSS
2959
 *     aggregation is enabled.
2960
 * @param $options
2961
 *   (optional) A string defining the 'type' of CSS that is being added in the
2962
 *   $data parameter ('file', 'inline', or 'external'), or an array which can
2963
 *   have any or all of the following keys:
2964
 *   - 'type': The type of stylesheet being added. Available options are 'file',
2965
 *     'inline' or 'external'. Defaults to 'file'.
2966
 *   - 'basename': Force a basename for the file being added. Modules are
2967
 *     expected to use stylesheets with unique filenames, but integration of
2968
 *     external libraries may make this impossible. The basename of
2969
 *     'modules/node/node.css' is 'node.css'. If the external library "node.js"
2970
 *     ships with a 'node.css', then a different, unique basename would be
2971
 *     'node.js.css'.
2972
 *   - 'group': A number identifying the group in which to add the stylesheet.
2973
 *     Available constants are:
2974
 *     - CSS_SYSTEM: Any system-layer CSS.
2975
 *     - CSS_DEFAULT: (default) Any module-layer CSS.
2976
 *     - CSS_THEME: Any theme-layer CSS.
2977
 *     The group number serves as a weight: the markup for loading a stylesheet
2978
 *     within a lower weight group is output to the page before the markup for
2979
 *     loading a stylesheet within a higher weight group, so CSS within higher
2980
 *     weight groups take precendence over CSS within lower weight groups.
2981
 *   - 'every_page': For optimal front-end performance when aggregation is
2982
 *     enabled, this should be set to TRUE if the stylesheet is present on every
2983
 *     page of the website for users for whom it is present at all. This
2984
 *     defaults to FALSE. It is set to TRUE for stylesheets added via module and
2985
 *     theme .info files. Modules that add stylesheets within hook_init()
2986
 *     implementations, or from other code that ensures that the stylesheet is
2987
 *     added to all website pages, should also set this flag to TRUE. All
2988
 *     stylesheets within the same group that have the 'every_page' flag set to
2989
 *     TRUE and do not have 'preprocess' set to FALSE are aggregated together
2990
 *     into a single aggregate file, and that aggregate file can be reused
2991
 *     across a user's entire site visit, leading to faster navigation between
2992
 *     pages. However, stylesheets that are only needed on pages less frequently
2993
 *     visited, can be added by code that only runs for those particular pages,
2994
 *     and that code should not set the 'every_page' flag. This minimizes the
2995
 *     size of the aggregate file that the user needs to download when first
2996
 *     visiting the website. Stylesheets without the 'every_page' flag are
2997
 *     aggregated into a separate aggregate file. This other aggregate file is
2998
 *     likely to change from page to page, and each new aggregate file needs to
2999
 *     be downloaded when first encountered, so it should be kept relatively
3000
 *     small by ensuring that most commonly needed stylesheets are added to
3001
 *     every page.
3002
 *   - 'weight': The weight of the stylesheet specifies the order in which the
3003
 *     CSS will appear relative to other stylesheets with the same group and
3004
 *     'every_page' flag. The exact ordering of stylesheets is as follows:
3005
 *     - First by group.
3006
 *     - Then by the 'every_page' flag, with TRUE coming before FALSE.
3007
 *     - Then by weight.
3008
 *     - Then by the order in which the CSS was added. For example, all else
3009
 *       being the same, a stylesheet added by a call to drupal_add_css() that
3010
 *       happened later in the page request gets added to the page after one for
3011
 *       which drupal_add_css() happened earlier in the page request.
3012
 *   - 'media': The media type for the stylesheet, e.g., all, print, screen.
3013
 *     Defaults to 'all'.
3014
 *   - 'preprocess': If TRUE and CSS aggregation/compression is enabled, the
3015
 *     styles will be aggregated and compressed. Defaults to TRUE.
3016
 *   - 'browsers': An array containing information specifying which browsers
3017
 *     should load the CSS item. See drupal_pre_render_conditional_comments()
3018
 *     for details.
3019
 *
3020
 * @return
3021
 *   An array of queued cascading stylesheets.
3022
 *
3023
 * @see drupal_get_css()
3024
 */
3025
function drupal_add_css($data = NULL, $options = NULL) {
3026
  $css = &drupal_static(__FUNCTION__, array());
3027

    
3028
  // Construct the options, taking the defaults into consideration.
3029
  if (isset($options)) {
3030
    if (!is_array($options)) {
3031
      $options = array('type' => $options);
3032
    }
3033
  }
3034
  else {
3035
    $options = array();
3036
  }
3037

    
3038
  // Create an array of CSS files for each media type first, since each type needs to be served
3039
  // to the browser differently.
3040
  if (isset($data)) {
3041
    $options += array(
3042
      'type' => 'file',
3043
      'group' => CSS_DEFAULT,
3044
      'weight' => 0,
3045
      'every_page' => FALSE,
3046
      'media' => 'all',
3047
      'preprocess' => TRUE,
3048
      'data' => $data,
3049
      'browsers' => array(),
3050
    );
3051
    $options['browsers'] += array(
3052
      'IE' => TRUE,
3053
      '!IE' => TRUE,
3054
    );
3055

    
3056
    // Files with a query string cannot be preprocessed.
3057
    if ($options['type'] === 'file' && $options['preprocess'] && strpos($options['data'], '?') !== FALSE) {
3058
      $options['preprocess'] = FALSE;
3059
    }
3060

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

    
3064
    // Add the data to the CSS array depending on the type.
3065
    switch ($options['type']) {
3066
      case 'inline':
3067
        // For inline stylesheets, we don't want to use the $data as the array
3068
        // key as $data could be a very long string of CSS.
3069
        $css[] = $options;
3070
        break;
3071
      default:
3072
        // Local and external files must keep their name as the associative key
3073
        // so the same CSS file is not be added twice.
3074
        $css[$data] = $options;
3075
    }
3076
  }
3077

    
3078
  return $css;
3079
}
3080

    
3081
/**
3082
 * Returns a themed representation of all stylesheets to attach to the page.
3083
 *
3084
 * It loads the CSS in order, with 'module' first, then 'theme' afterwards.
3085
 * This ensures proper cascading of styles so themes can easily override
3086
 * module styles through CSS selectors.
3087
 *
3088
 * Themes may replace module-defined CSS files by adding a stylesheet with the
3089
 * same filename. For example, themes/bartik/system-menus.css would replace
3090
 * modules/system/system-menus.css. This allows themes to override complete
3091
 * CSS files, rather than specific selectors, when necessary.
3092
 *
3093
 * If the original CSS file is being overridden by a theme, the theme is
3094
 * responsible for supplying an accompanying RTL CSS file to replace the
3095
 * module's.
3096
 *
3097
 * @param $css
3098
 *   (optional) An array of CSS files. If no array is provided, the default
3099
 *   stylesheets array is used instead.
3100
 * @param $skip_alter
3101
 *   (optional) If set to TRUE, this function skips calling drupal_alter() on
3102
 *   $css, useful when the calling function passes a $css array that has already
3103
 *   been altered.
3104
 *
3105
 * @return
3106
 *   A string of XHTML CSS tags.
3107
 *
3108
 * @see drupal_add_css()
3109
 */
3110
function drupal_get_css($css = NULL, $skip_alter = FALSE) {
3111
  if (!isset($css)) {
3112
    $css = drupal_add_css();
3113
  }
3114

    
3115
  // Allow modules and themes to alter the CSS items.
3116
  if (!$skip_alter) {
3117
    drupal_alter('css', $css);
3118
  }
3119

    
3120
  // Sort CSS items, so that they appear in the correct order.
3121
  uasort($css, 'drupal_sort_css_js');
3122

    
3123
  // Provide the page with information about the individual CSS files used,
3124
  // information not otherwise available when CSS aggregation is enabled. The
3125
  // setting is attached later in this function, but is set here, so that CSS
3126
  // files removed below are still considered "used" and prevented from being
3127
  // added in a later AJAX request.
3128
  // Skip if no files were added to the page or jQuery.extend() will overwrite
3129
  // the Drupal.settings.ajaxPageState.css object with an empty array.
3130
  if (!empty($css)) {
3131
    // Cast the array to an object to be on the safe side even if not empty.
3132
    $setting['ajaxPageState']['css'] = (object) array_fill_keys(array_keys($css), 1);
3133
  }
3134

    
3135
  // Remove the overridden CSS files. Later CSS files override former ones.
3136
  $previous_item = array();
3137
  foreach ($css as $key => $item) {
3138
    if ($item['type'] == 'file') {
3139
      // If defined, force a unique basename for this file.
3140
      $basename = isset($item['basename']) ? $item['basename'] : drupal_basename($item['data']);
3141
      if (isset($previous_item[$basename])) {
3142
        // Remove the previous item that shared the same base name.
3143
        unset($css[$previous_item[$basename]]);
3144
      }
3145
      $previous_item[$basename] = $key;
3146
    }
3147
  }
3148

    
3149
  // Render the HTML needed to load the CSS.
3150
  $styles = array(
3151
    '#type' => 'styles',
3152
    '#items' => $css,
3153
  );
3154

    
3155
  if (!empty($setting)) {
3156
    $styles['#attached']['js'][] = array('type' => 'setting', 'data' => $setting);
3157
  }
3158

    
3159
  return drupal_render($styles);
3160
}
3161

    
3162
/**
3163
 * Sorts CSS and JavaScript resources.
3164
 *
3165
 * Callback for uasort() within:
3166
 * - drupal_get_css()
3167
 * - drupal_get_js()
3168
 *
3169
 * This sort order helps optimize front-end performance while providing modules
3170
 * and themes with the necessary control for ordering the CSS and JavaScript
3171
 * appearing on a page.
3172
 *
3173
 * @param $a
3174
 *   First item for comparison. The compared items should be associative arrays
3175
 *   of member items from drupal_add_css() or drupal_add_js().
3176
 * @param $b
3177
 *   Second item for comparison.
3178
 *
3179
 * @see drupal_add_css()
3180
 * @see drupal_add_js()
3181
 */
3182
function drupal_sort_css_js($a, $b) {
3183
  // First order by group, so that, for example, all items in the CSS_SYSTEM
3184
  // group appear before items in the CSS_DEFAULT group, which appear before
3185
  // all items in the CSS_THEME group. Modules may create additional groups by
3186
  // defining their own constants.
3187
  if ($a['group'] < $b['group']) {
3188
    return -1;
3189
  }
3190
  elseif ($a['group'] > $b['group']) {
3191
    return 1;
3192
  }
3193
  // Within a group, order all infrequently needed, page-specific files after
3194
  // common files needed throughout the website. Separating this way allows for
3195
  // the aggregate file generated for all of the common files to be reused
3196
  // across a site visit without being cut by a page using a less common file.
3197
  elseif ($a['every_page'] && !$b['every_page']) {
3198
    return -1;
3199
  }
3200
  elseif (!$a['every_page'] && $b['every_page']) {
3201
    return 1;
3202
  }
3203
  // Finally, order by weight.
3204
  elseif ($a['weight'] < $b['weight']) {
3205
    return -1;
3206
  }
3207
  elseif ($a['weight'] > $b['weight']) {
3208
    return 1;
3209
  }
3210
  else {
3211
    return 0;
3212
  }
3213
}
3214

    
3215
/**
3216
 * Default callback to group CSS items.
3217
 *
3218
 * This function arranges the CSS items that are in the #items property of the
3219
 * styles element into groups. Arranging the CSS items into groups serves two
3220
 * purposes. When aggregation is enabled, files within a group are aggregated
3221
 * into a single file, significantly improving page loading performance by
3222
 * minimizing network traffic overhead. When aggregation is disabled, grouping
3223
 * allows multiple files to be loaded from a single STYLE tag, enabling sites
3224
 * with many modules enabled or a complex theme being used to stay within IE's
3225
 * 31 CSS inclusion tag limit: http://drupal.org/node/228818.
3226
 *
3227
 * This function puts multiple items into the same group if they are groupable
3228
 * and if they are for the same 'media' and 'browsers'. Items of the 'file' type
3229
 * are groupable if their 'preprocess' flag is TRUE, items of the 'inline' type
3230
 * are always groupable, and items of the 'external' type are never groupable.
3231
 * This function also ensures that the process of grouping items does not change
3232
 * their relative order. This requirement may result in multiple groups for the
3233
 * same type, media, and browsers, if needed to accommodate other items in
3234
 * between.
3235
 *
3236
 * @param $css
3237
 *   An array of CSS items, as returned by drupal_add_css(), but after
3238
 *   alteration performed by drupal_get_css().
3239
 *
3240
 * @return
3241
 *   An array of CSS groups. Each group contains the same keys (e.g., 'media',
3242
 *   'data', etc.) as a CSS item from the $css parameter, with the value of
3243
 *   each key applying to the group as a whole. Each group also contains an
3244
 *   'items' key, which is the subset of items from $css that are in the group.
3245
 *
3246
 * @see drupal_pre_render_styles()
3247
 * @see system_element_info()
3248
 */
3249
function drupal_group_css($css) {
3250
  $groups = array();
3251
  // If a group can contain multiple items, we track the information that must
3252
  // be the same for each item in the group, so that when we iterate the next
3253
  // item, we can determine if it can be put into the current group, or if a
3254
  // new group needs to be made for it.
3255
  $current_group_keys = NULL;
3256
  // When creating a new group, we pre-increment $i, so by initializing it to
3257
  // -1, the first group will have index 0.
3258
  $i = -1;
3259
  foreach ($css as $item) {
3260
    // The browsers for which the CSS item needs to be loaded is part of the
3261
    // information that determines when a new group is needed, but the order of
3262
    // keys in the array doesn't matter, and we don't want a new group if all
3263
    // that's different is that order.
3264
    ksort($item['browsers']);
3265

    
3266
    // If the item can be grouped with other items, set $group_keys to an array
3267
    // of information that must be the same for all items in its group. If the
3268
    // item can't be grouped with other items, set $group_keys to FALSE. We
3269
    // put items into a group that can be aggregated together: whether they will
3270
    // be aggregated is up to the _drupal_css_aggregate() function or an
3271
    // override of that function specified in hook_css_alter(), but regardless
3272
    // of the details of that function, a group represents items that can be
3273
    // aggregated. Since a group may be rendered with a single HTML tag, all
3274
    // items in the group must share the same information that would need to be
3275
    // part of that HTML tag.
3276
    switch ($item['type']) {
3277
      case 'file':
3278
        // Group file items if their 'preprocess' flag is TRUE.
3279
        // Help ensure maximum reuse of aggregate files by only grouping
3280
        // together items that share the same 'group' value and 'every_page'
3281
        // flag. See drupal_add_css() for details about that.
3282
        $group_keys = $item['preprocess'] ? array($item['type'], $item['group'], $item['every_page'], $item['media'], $item['browsers']) : FALSE;
3283
        break;
3284
      case 'inline':
3285
        // Always group inline items.
3286
        $group_keys = array($item['type'], $item['media'], $item['browsers']);
3287
        break;
3288
      case 'external':
3289
        // Do not group external items.
3290
        $group_keys = FALSE;
3291
        break;
3292
    }
3293

    
3294
    // If the group keys don't match the most recent group we're working with,
3295
    // then a new group must be made.
3296
    if ($group_keys !== $current_group_keys) {
3297
      $i++;
3298
      // Initialize the new group with the same properties as the first item
3299
      // being placed into it. The item's 'data' and 'weight' properties are
3300
      // unique to the item and should not be carried over to the group.
3301
      $groups[$i] = $item;
3302
      unset($groups[$i]['data'], $groups[$i]['weight']);
3303
      $groups[$i]['items'] = array();
3304
      $current_group_keys = $group_keys ? $group_keys : NULL;
3305
    }
3306

    
3307
    // Add the item to the current group.
3308
    $groups[$i]['items'][] = $item;
3309
  }
3310
  return $groups;
3311
}
3312

    
3313
/**
3314
 * Default callback to aggregate CSS files and inline content.
3315
 *
3316
 * Having the browser load fewer CSS files results in much faster page loads
3317
 * than when it loads many small files. This function aggregates files within
3318
 * the same group into a single file unless the site-wide setting to do so is
3319
 * disabled (commonly the case during site development). To optimize download,
3320
 * it also compresses the aggregate files by removing comments, whitespace, and
3321
 * other unnecessary content. Additionally, this functions aggregates inline
3322
 * content together, regardless of the site-wide aggregation setting.
3323
 *
3324
 * @param $css_groups
3325
 *   An array of CSS groups as returned by drupal_group_css(). This function
3326
 *   modifies the group's 'data' property for each group that is aggregated.
3327
 *
3328
 * @see drupal_group_css()
3329
 * @see drupal_pre_render_styles()
3330
 * @see system_element_info()
3331
 */
3332
function drupal_aggregate_css(&$css_groups) {
3333
  $preprocess_css = (variable_get('preprocess_css', FALSE) && (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update'));
3334

    
3335
  // For each group that needs aggregation, aggregate its items.
3336
  foreach ($css_groups as $key => $group) {
3337
    switch ($group['type']) {
3338
      // If a file group can be aggregated into a single file, do so, and set
3339
      // the group's data property to the file path of the aggregate file.
3340
      case 'file':
3341
        if ($group['preprocess'] && $preprocess_css) {
3342
          $css_groups[$key]['data'] = drupal_build_css_cache($group['items']);
3343
        }
3344
        break;
3345
      // Aggregate all inline CSS content into the group's data property.
3346
      case 'inline':
3347
        $css_groups[$key]['data'] = '';
3348
        foreach ($group['items'] as $item) {
3349
          $css_groups[$key]['data'] .= drupal_load_stylesheet_content($item['data'], $item['preprocess']);
3350
        }
3351
        break;
3352
    }
3353
  }
3354
}
3355

    
3356
/**
3357
 * #pre_render callback to add the elements needed for CSS tags to be rendered.
3358
 *
3359
 * For production websites, LINK tags are preferable to STYLE tags with @import
3360
 * statements, because:
3361
 * - They are the standard tag intended for linking to a resource.
3362
 * - On Firefox 2 and perhaps other browsers, CSS files included with @import
3363
 *   statements don't get saved when saving the complete web page for offline
3364
 *   use: http://drupal.org/node/145218.
3365
 * - On IE, if only LINK tags and no @import statements are used, all the CSS
3366
 *   files are downloaded in parallel, resulting in faster page load, but if
3367
 *   @import statements are used and span across multiple STYLE tags, all the
3368
 *   ones from one STYLE tag must be downloaded before downloading begins for
3369
 *   the next STYLE tag. Furthermore, IE7 does not support media declaration on
3370
 *   the @import statement, so multiple STYLE tags must be used when different
3371
 *   files are for different media types. Non-IE browsers always download in
3372
 *   parallel, so this is an IE-specific performance quirk:
3373
 *   http://www.stevesouders.com/blog/2009/04/09/dont-use-import/.
3374
 *
3375
 * However, IE has an annoying limit of 31 total CSS inclusion tags
3376
 * (http://drupal.org/node/228818) and LINK tags are limited to one file per
3377
 * tag, whereas STYLE tags can contain multiple @import statements allowing
3378
 * multiple files to be loaded per tag. When CSS aggregation is disabled, a
3379
 * Drupal site can easily have more than 31 CSS files that need to be loaded, so
3380
 * using LINK tags exclusively would result in a site that would display
3381
 * incorrectly in IE. Depending on different needs, different strategies can be
3382
 * employed to decide when to use LINK tags and when to use STYLE tags.
3383
 *
3384
 * The strategy employed by this function is to use LINK tags for all aggregate
3385
 * files and for all files that cannot be aggregated (e.g., if 'preprocess' is
3386
 * set to FALSE or the type is 'external'), and to use STYLE tags for groups
3387
 * of files that could be aggregated together but aren't (e.g., if the site-wide
3388
 * aggregation setting is disabled). This results in all LINK tags when
3389
 * aggregation is enabled, a guarantee that as many or only slightly more tags
3390
 * are used with aggregation disabled than enabled (so that if the limit were to
3391
 * be crossed with aggregation enabled, the site developer would also notice the
3392
 * problem while aggregation is disabled), and an easy way for a developer to
3393
 * view HTML source while aggregation is disabled and know what files will be
3394
 * aggregated together when aggregation becomes enabled.
3395
 *
3396
 * This function evaluates the aggregation enabled/disabled condition on a group
3397
 * by group basis by testing whether an aggregate file has been made for the
3398
 * group rather than by testing the site-wide aggregation setting. This allows
3399
 * this function to work correctly even if modules have implemented custom
3400
 * logic for grouping and aggregating files.
3401
 *
3402
 * @param $element
3403
 *   A render array containing:
3404
 *   - '#items': The CSS items as returned by drupal_add_css() and altered by
3405
 *     drupal_get_css().
3406
 *   - '#group_callback': A function to call to group #items to enable the use
3407
 *     of fewer tags by aggregating files and/or using multiple @import
3408
 *     statements within a single tag.
3409
 *   - '#aggregate_callback': A function to call to aggregate the items within
3410
 *     the groups arranged by the #group_callback function.
3411
 *
3412
 * @return
3413
 *   A render array that will render to a string of XHTML CSS tags.
3414
 *
3415
 * @see drupal_get_css()
3416
 */
3417
function drupal_pre_render_styles($elements) {
3418
  // Group and aggregate the items.
3419
  if (isset($elements['#group_callback'])) {
3420
    $elements['#groups'] = $elements['#group_callback']($elements['#items']);
3421
  }
3422
  if (isset($elements['#aggregate_callback'])) {
3423
    $elements['#aggregate_callback']($elements['#groups']);
3424
  }
3425

    
3426
  // A dummy query-string is added to filenames, to gain control over
3427
  // browser-caching. The string changes on every update or full cache
3428
  // flush, forcing browsers to load a new copy of the files, as the
3429
  // URL changed.
3430
  $query_string = variable_get('css_js_query_string', '0');
3431

    
3432
  // For inline CSS to validate as XHTML, all CSS containing XHTML needs to be
3433
  // wrapped in CDATA. To make that backwards compatible with HTML 4, we need to
3434
  // comment out the CDATA-tag.
3435
  $embed_prefix = "\n<!--/*--><![CDATA[/*><!--*/\n";
3436
  $embed_suffix = "\n/*]]>*/-->\n";
3437

    
3438
  // Defaults for LINK and STYLE elements.
3439
  $link_element_defaults = array(
3440
    '#type' => 'html_tag',
3441
    '#tag' => 'link',
3442
    '#attributes' => array(
3443
      'type' => 'text/css',
3444
      'rel' => 'stylesheet',
3445
    ),
3446
  );
3447
  $style_element_defaults = array(
3448
    '#type' => 'html_tag',
3449
    '#tag' => 'style',
3450
    '#attributes' => array(
3451
      'type' => 'text/css',
3452
    ),
3453
  );
3454

    
3455
  // Loop through each group.
3456
  foreach ($elements['#groups'] as $group) {
3457
    switch ($group['type']) {
3458
      // For file items, there are three possibilites.
3459
      // - The group has been aggregated: in this case, output a LINK tag for
3460
      //   the aggregate file.
3461
      // - The group can be aggregated but has not been (most likely because
3462
      //   the site administrator disabled the site-wide setting): in this case,
3463
      //   output as few STYLE tags for the group as possible, using @import
3464
      //   statement for each file in the group. This enables us to stay within
3465
      //   IE's limit of 31 total CSS inclusion tags.
3466
      // - The group contains items not eligible for aggregation (their
3467
      //   'preprocess' flag has been set to FALSE): in this case, output a LINK
3468
      //   tag for each file.
3469
      case 'file':
3470
        // The group has been aggregated into a single file: output a LINK tag
3471
        // for the aggregate file.
3472
        if (isset($group['data'])) {
3473
          $element = $link_element_defaults;
3474
          $element['#attributes']['href'] = file_create_url($group['data']);
3475
          $element['#attributes']['media'] = $group['media'];
3476
          $element['#browsers'] = $group['browsers'];
3477
          $elements[] = $element;
3478
        }
3479
        // The group can be aggregated, but hasn't been: combine multiple items
3480
        // into as few STYLE tags as possible.
3481
        elseif ($group['preprocess']) {
3482
          $import = array();
3483
          foreach ($group['items'] as $item) {
3484
            // A theme's .info file may have an entry for a file that doesn't
3485
            // exist as a way of overriding a module or base theme CSS file from
3486
            // being added to the page. Normally, file_exists() calls that need
3487
            // to run for every page request should be minimized, but this one
3488
            // is okay, because it only runs when CSS aggregation is disabled.
3489
            // On a server under heavy enough load that file_exists() calls need
3490
            // to be minimized, CSS aggregation should be enabled, in which case
3491
            // this code is not run. When aggregation is enabled,
3492
            // drupal_load_stylesheet() checks file_exists(), but only when
3493
            // building the aggregate file, which is then reused for many page
3494
            // requests.
3495
            if (file_exists($item['data'])) {
3496
              // The dummy query string needs to be added to the URL to control
3497
              // browser-caching. IE7 does not support a media type on the
3498
              // @import statement, so we instead specify the media for the
3499
              // group on the STYLE tag.
3500
              $import[] = '@import url("' . check_plain(file_create_url($item['data']) . '?' . $query_string) . '");';
3501
            }
3502
          }
3503
          // In addition to IE's limit of 31 total CSS inclusion tags, it also
3504
          // has a limit of 31 @import statements per STYLE tag.
3505
          while (!empty($import)) {
3506
            $import_batch = array_slice($import, 0, 31);
3507
            $import = array_slice($import, 31);
3508
            $element = $style_element_defaults;
3509
            // This simplifies the JavaScript regex, allowing each line
3510
            // (separated by \n) to be treated as a completely different string.
3511
            // This means that we can use ^ and $ on one line at a time, and not
3512
            // worry about style tags since they'll never match the regex.
3513
            $element['#value'] = "\n" . implode("\n", $import_batch) . "\n";
3514
            $element['#attributes']['media'] = $group['media'];
3515
            $element['#browsers'] = $group['browsers'];
3516
            $elements[] = $element;
3517
          }
3518
        }
3519
        // The group contains items ineligible for aggregation: output a LINK
3520
        // tag for each file.
3521
        else {
3522
          foreach ($group['items'] as $item) {
3523
            $element = $link_element_defaults;
3524
            // We do not check file_exists() here, because this code runs for
3525
            // files whose 'preprocess' is set to FALSE, and therefore, even
3526
            // when aggregation is enabled, and we want to avoid needlessly
3527
            // taxing a server that may be under heavy load. The file_exists()
3528
            // performed above for files whose 'preprocess' is TRUE is done for
3529
            // the benefit of theme .info files, but code that deals with files
3530
            // whose 'preprocess' is FALSE is responsible for ensuring the file
3531
            // exists.
3532
            // The dummy query string needs to be added to the URL to control
3533
            // browser-caching.
3534
            $query_string_separator = (strpos($item['data'], '?') !== FALSE) ? '&' : '?';
3535
            $element['#attributes']['href'] = file_create_url($item['data']) . $query_string_separator . $query_string;
3536
            $element['#attributes']['media'] = $item['media'];
3537
            $element['#browsers'] = $group['browsers'];
3538
            $elements[] = $element;
3539
          }
3540
        }
3541
        break;
3542
      // For inline content, the 'data' property contains the CSS content. If
3543
      // the group's 'data' property is set, then output it in a single STYLE
3544
      // tag. Otherwise, output a separate STYLE tag for each item.
3545
      case 'inline':
3546
        if (isset($group['data'])) {
3547
          $element = $style_element_defaults;
3548
          $element['#value'] = $group['data'];
3549
          $element['#value_prefix'] = $embed_prefix;
3550
          $element['#value_suffix'] = $embed_suffix;
3551
          $element['#attributes']['media'] = $group['media'];
3552
          $element['#browsers'] = $group['browsers'];
3553
          $elements[] = $element;
3554
        }
3555
        else {
3556
          foreach ($group['items'] as $item) {
3557
            $element = $style_element_defaults;
3558
            $element['#value'] = $item['data'];
3559
            $element['#value_prefix'] = $embed_prefix;
3560
            $element['#value_suffix'] = $embed_suffix;
3561
            $element['#attributes']['media'] = $item['media'];
3562
            $element['#browsers'] = $group['browsers'];
3563
            $elements[] = $element;
3564
          }
3565
        }
3566
        break;
3567
      // Output a LINK tag for each external item. The item's 'data' property
3568
      // contains the full URL.
3569
      case 'external':
3570
        foreach ($group['items'] as $item) {
3571
          $element = $link_element_defaults;
3572
          $element['#attributes']['href'] = $item['data'];
3573
          $element['#attributes']['media'] = $item['media'];
3574
          $element['#browsers'] = $group['browsers'];
3575
          $elements[] = $element;
3576
        }
3577
        break;
3578
    }
3579
  }
3580

    
3581
  return $elements;
3582
}
3583

    
3584
/**
3585
 * Aggregates and optimizes CSS files into a cache file in the files directory.
3586
 *
3587
 * The file name for the CSS cache file is generated from the hash of the
3588
 * aggregated contents of the files in $css. This forces proxies and browsers
3589
 * to download new CSS when the CSS changes.
3590
 *
3591
 * The cache file name is retrieved on a page load via a lookup variable that
3592
 * contains an associative array. The array key is the hash of the file names
3593
 * in $css while the value is the cache file name. The cache file is generated
3594
 * in two cases. First, if there is no file name value for the key, which will
3595
 * happen if a new file name has been added to $css or after the lookup
3596
 * variable is emptied to force a rebuild of the cache. Second, the cache file
3597
 * is generated if it is missing on disk. Old cache files are not deleted
3598
 * immediately when the lookup variable is emptied, but are deleted after a set
3599
 * period by drupal_delete_file_if_stale(). This ensures that files referenced
3600
 * by a cached page will still be available.
3601
 *
3602
 * @param $css
3603
 *   An array of CSS files to aggregate and compress into one file.
3604
 *
3605
 * @return
3606
 *   The URI of the CSS cache file, or FALSE if the file could not be saved.
3607
 */
3608
function drupal_build_css_cache($css) {
3609
  $data = '';
3610
  $uri = '';
3611
  $map = variable_get('drupal_css_cache_files', array());
3612
  // Create a new array so that only the file names are used to create the hash.
3613
  // This prevents new aggregates from being created unnecessarily.
3614
  $css_data = array();
3615
  foreach ($css as $css_file) {
3616
    $css_data[] = $css_file['data'];
3617
  }
3618
  $key = hash('sha256', serialize($css_data));
3619
  if (isset($map[$key])) {
3620
    $uri = $map[$key];
3621
  }
3622

    
3623
  if (empty($uri) || !file_exists($uri)) {
3624
    // Build aggregate CSS file.
3625
    foreach ($css as $stylesheet) {
3626
      // Only 'file' stylesheets can be aggregated.
3627
      if ($stylesheet['type'] == 'file') {
3628
        $contents = drupal_load_stylesheet($stylesheet['data'], TRUE);
3629

    
3630
        // Build the base URL of this CSS file: start with the full URL.
3631
        $css_base_url = file_create_url($stylesheet['data']);
3632
        // Move to the parent.
3633
        $css_base_url = substr($css_base_url, 0, strrpos($css_base_url, '/'));
3634
        // Simplify to a relative URL if the stylesheet URL starts with the
3635
        // base URL of the website.
3636
        if (substr($css_base_url, 0, strlen($GLOBALS['base_root'])) == $GLOBALS['base_root']) {
3637
          $css_base_url = substr($css_base_url, strlen($GLOBALS['base_root']));
3638
        }
3639

    
3640
        _drupal_build_css_path(NULL, $css_base_url . '/');
3641
        // Anchor all paths in the CSS with its base URL, ignoring external and absolute paths.
3642
        $data .= preg_replace_callback('/url\(\s*[\'"]?(?![a-z]+:|\/+)([^\'")]+)[\'"]?\s*\)/i', '_drupal_build_css_path', $contents);
3643
      }
3644
    }
3645

    
3646
    // Per the W3C specification at http://www.w3.org/TR/REC-CSS2/cascade.html#at-import,
3647
    // @import rules must proceed any other style, so we move those to the top.
3648
    $regexp = '/@import[^;]+;/i';
3649
    preg_match_all($regexp, $data, $matches);
3650
    $data = preg_replace($regexp, '', $data);
3651
    $data = implode('', $matches[0]) . $data;
3652

    
3653
    // Prefix filename to prevent blocking by firewalls which reject files
3654
    // starting with "ad*".
3655
    $filename = 'css_' . drupal_hash_base64($data) . '.css';
3656
    // Create the css/ within the files folder.
3657
    $csspath = 'public://css';
3658
    $uri = $csspath . '/' . $filename;
3659
    // Create the CSS file.
3660
    file_prepare_directory($csspath, FILE_CREATE_DIRECTORY);
3661
    if (!file_exists($uri) && !file_unmanaged_save_data($data, $uri, FILE_EXISTS_REPLACE)) {
3662
      return FALSE;
3663
    }
3664
    // If CSS gzip compression is enabled, clean URLs are enabled (which means
3665
    // that rewrite rules are working) and the zlib extension is available then
3666
    // create a gzipped version of this file. This file is served conditionally
3667
    // to browsers that accept gzip using .htaccess rules.
3668
    if (variable_get('css_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
3669
      if (!file_exists($uri . '.gz') && !file_unmanaged_save_data(gzencode($data, 9, FORCE_GZIP), $uri . '.gz', FILE_EXISTS_REPLACE)) {
3670
        return FALSE;
3671
      }
3672
    }
3673
    // Save the updated map.
3674
    $map[$key] = $uri;
3675
    variable_set('drupal_css_cache_files', $map);
3676
  }
3677
  return $uri;
3678
}
3679

    
3680
/**
3681
 * Prefixes all paths within a CSS file for drupal_build_css_cache().
3682
 */
3683
function _drupal_build_css_path($matches, $base = NULL) {
3684
  $_base = &drupal_static(__FUNCTION__);
3685
  // Store base path for preg_replace_callback.
3686
  if (isset($base)) {
3687
    $_base = $base;
3688
  }
3689

    
3690
  // Prefix with base and remove '../' segments where possible.
3691
  $path = $_base . $matches[1];
3692
  $last = '';
3693
  while ($path != $last) {
3694
    $last = $path;
3695
    $path = preg_replace('`(^|/)(?!\.\./)([^/]+)/\.\./`', '$1', $path);
3696
  }
3697
  return 'url(' . $path . ')';
3698
}
3699

    
3700
/**
3701
 * Loads the stylesheet and resolves all @import commands.
3702
 *
3703
 * Loads a stylesheet and replaces @import commands with the contents of the
3704
 * imported file. Use this instead of file_get_contents when processing
3705
 * stylesheets.
3706
 *
3707
 * The returned contents are compressed removing white space and comments only
3708
 * when CSS aggregation is enabled. This optimization will not apply for
3709
 * color.module enabled themes with CSS aggregation turned off.
3710
 *
3711
 * @param $file
3712
 *   Name of the stylesheet to be processed.
3713
 * @param $optimize
3714
 *   Defines if CSS contents should be compressed or not.
3715
 * @param $reset_basepath
3716
 *   Used internally to facilitate recursive resolution of @import commands.
3717
 *
3718
 * @return
3719
 *   Contents of the stylesheet, including any resolved @import commands.
3720
 */
3721
function drupal_load_stylesheet($file, $optimize = NULL, $reset_basepath = TRUE) {
3722
  // These statics are not cache variables, so we don't use drupal_static().
3723
  static $_optimize, $basepath;
3724
  if ($reset_basepath) {
3725
    $basepath = '';
3726
  }
3727
  // Store the value of $optimize for preg_replace_callback with nested
3728
  // @import loops.
3729
  if (isset($optimize)) {
3730
    $_optimize = $optimize;
3731
  }
3732

    
3733
  // Stylesheets are relative one to each other. Start by adding a base path
3734
  // prefix provided by the parent stylesheet (if necessary).
3735
  if ($basepath && !file_uri_scheme($file)) {
3736
    $file = $basepath . '/' . $file;
3737
  }
3738
  // Store the parent base path to restore it later.
3739
  $parent_base_path = $basepath;
3740
  // Set the current base path to process possible child imports.
3741
  $basepath = dirname($file);
3742

    
3743
  // Load the CSS stylesheet. We suppress errors because themes may specify
3744
  // stylesheets in their .info file that don't exist in the theme's path,
3745
  // but are merely there to disable certain module CSS files.
3746
  $content = '';
3747
  if ($contents = @file_get_contents($file)) {
3748
    // Return the processed stylesheet.
3749
    $content = drupal_load_stylesheet_content($contents, $_optimize);
3750
  }
3751

    
3752
  // Restore the parent base path as the file and its childen are processed.
3753
  $basepath = $parent_base_path;
3754
  return $content;
3755
}
3756

    
3757
/**
3758
 * Processes the contents of a stylesheet for aggregation.
3759
 *
3760
 * @param $contents
3761
 *   The contents of the stylesheet.
3762
 * @param $optimize
3763
 *   (optional) Boolean whether CSS contents should be minified. Defaults to
3764
 *   FALSE.
3765
 *
3766
 * @return
3767
 *   Contents of the stylesheet including the imported stylesheets.
3768
 */
3769
function drupal_load_stylesheet_content($contents, $optimize = FALSE) {
3770
  // Remove multiple charset declarations for standards compliance (and fixing Safari problems).
3771
  $contents = preg_replace('/^@charset\s+[\'"](\S*?)\b[\'"];/i', '', $contents);
3772

    
3773
  if ($optimize) {
3774
    // Perform some safe CSS optimizations.
3775
    // Regexp to match comment blocks.
3776
    $comment     = '/\*[^*]*\*+(?:[^/*][^*]*\*+)*/';
3777
    // Regexp to match double quoted strings.
3778
    $double_quot = '"[^"\\\\]*(?:\\\\.[^"\\\\]*)*"';
3779
    // Regexp to match single quoted strings.
3780
    $single_quot = "'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'";
3781
    // Strip all comment blocks, but keep double/single quoted strings.
3782
    $contents = preg_replace(
3783
      "<($double_quot|$single_quot)|$comment>Ss",
3784
      "$1",
3785
      $contents
3786
    );
3787
    // Remove certain whitespace.
3788
    // There are different conditions for removing leading and trailing
3789
    // whitespace.
3790
    // @see http://php.net/manual/regexp.reference.subpatterns.php
3791
    $contents = preg_replace('<
3792
      # Strip leading and trailing whitespace.
3793
        \s*([@{};,])\s*
3794
      # Strip only leading whitespace from:
3795
      # - Closing parenthesis: Retain "@media (bar) and foo".
3796
      | \s+([\)])
3797
      # Strip only trailing whitespace from:
3798
      # - Opening parenthesis: Retain "@media (bar) and foo".
3799
      # - Colon: Retain :pseudo-selectors.
3800
      | ([\(:])\s+
3801
    >xS',
3802
      // Only one of the three capturing groups will match, so its reference
3803
      // will contain the wanted value and the references for the
3804
      // two non-matching groups will be replaced with empty strings.
3805
      '$1$2$3',
3806
      $contents
3807
    );
3808
    // End the file with a new line.
3809
    $contents = trim($contents);
3810
    $contents .= "\n";
3811
  }
3812

    
3813
  // Replaces @import commands with the actual stylesheet content.
3814
  // This happens recursively but omits external files.
3815
  $contents = preg_replace_callback('/@import\s*(?:url\(\s*)?[\'"]?(?![a-z]+:)(?!\/\/)([^\'"\()]+)[\'"]?\s*\)?\s*;/', '_drupal_load_stylesheet', $contents);
3816
  return $contents;
3817
}
3818

    
3819
/**
3820
 * Loads stylesheets recursively and returns contents with corrected paths.
3821
 *
3822
 * This function is used for recursive loading of stylesheets and
3823
 * returns the stylesheet content with all url() paths corrected.
3824
 */
3825
function _drupal_load_stylesheet($matches) {
3826
  $filename = $matches[1];
3827
  // Load the imported stylesheet and replace @import commands in there as well.
3828
  $file = drupal_load_stylesheet($filename, NULL, FALSE);
3829

    
3830
  // Determine the file's directory.
3831
  $directory = dirname($filename);
3832
  // If the file is in the current directory, make sure '.' doesn't appear in
3833
  // the url() path.
3834
  $directory = $directory == '.' ? '' : $directory .'/';
3835

    
3836
  // Alter all internal url() paths. Leave external paths alone. We don't need
3837
  // to normalize absolute paths here (i.e. remove folder/... segments) because
3838
  // that will be done later.
3839
  return preg_replace('/url\(\s*([\'"]?)(?![a-z]+:|\/+)([^\'")]+)([\'"]?)\s*\)/i', 'url(\1' . $directory . '\2\3)', $file);
3840
}
3841

    
3842
/**
3843
 * Deletes old cached CSS files.
3844
 */
3845
function drupal_clear_css_cache() {
3846
  variable_del('drupal_css_cache_files');
3847
  file_scan_directory('public://css', '/.*/', array('callback' => 'drupal_delete_file_if_stale'));
3848
}
3849

    
3850
/**
3851
 * Callback to delete files modified more than a set time ago.
3852
 */
3853
function drupal_delete_file_if_stale($uri) {
3854
  // Default stale file threshold is 30 days.
3855
  if (REQUEST_TIME - filemtime($uri) > variable_get('drupal_stale_file_threshold', 2592000)) {
3856
    file_unmanaged_delete($uri);
3857
  }
3858
}
3859

    
3860
/**
3861
 * Prepares a string for use as a CSS identifier (element, class, or ID name).
3862
 *
3863
 * http://www.w3.org/TR/CSS21/syndata.html#characters shows the syntax for valid
3864
 * CSS identifiers (including element names, classes, and IDs in selectors.)
3865
 *
3866
 * @param $identifier
3867
 *   The identifier to clean.
3868
 * @param $filter
3869
 *   An array of string replacements to use on the identifier.
3870
 *
3871
 * @return
3872
 *   The cleaned identifier.
3873
 */
3874
function drupal_clean_css_identifier($identifier, $filter = array(' ' => '-', '_' => '-', '/' => '-', '[' => '-', ']' => '')) {
3875
  // By default, we filter using Drupal's coding standards.
3876
  $identifier = strtr($identifier, $filter);
3877

    
3878
  // Valid characters in a CSS identifier are:
3879
  // - the hyphen (U+002D)
3880
  // - a-z (U+0030 - U+0039)
3881
  // - A-Z (U+0041 - U+005A)
3882
  // - the underscore (U+005F)
3883
  // - 0-9 (U+0061 - U+007A)
3884
  // - ISO 10646 characters U+00A1 and higher
3885
  // We strip out any character not in the above list.
3886
  $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);
3887

    
3888
  return $identifier;
3889
}
3890

    
3891
/**
3892
 * Prepares a string for use as a valid class name.
3893
 *
3894
 * Do not pass one string containing multiple classes as they will be
3895
 * incorrectly concatenated with dashes, i.e. "one two" will become "one-two".
3896
 *
3897
 * @param $class
3898
 *   The class name to clean.
3899
 *
3900
 * @return
3901
 *   The cleaned class name.
3902
 */
3903
function drupal_html_class($class) {
3904
  // The output of this function will never change, so this uses a normal
3905
  // static instead of drupal_static().
3906
  static $classes = array();
3907

    
3908
  if (!isset($classes[$class])) {
3909
    $classes[$class] = drupal_clean_css_identifier(drupal_strtolower($class));
3910
  }
3911
  return $classes[$class];
3912
}
3913

    
3914
/**
3915
 * Prepares a string for use as a valid HTML ID and guarantees uniqueness.
3916
 *
3917
 * This function ensures that each passed HTML ID value only exists once on the
3918
 * page. By tracking the already returned ids, this function enables forms,
3919
 * blocks, and other content to be output multiple times on the same page,
3920
 * without breaking (X)HTML validation.
3921
 *
3922
 * For already existing IDs, a counter is appended to the ID string. Therefore,
3923
 * JavaScript and CSS code should not rely on any value that was generated by
3924
 * this function and instead should rely on manually added CSS classes or
3925
 * similarly reliable constructs.
3926
 *
3927
 * Two consecutive hyphens separate the counter from the original ID. To manage
3928
 * uniqueness across multiple Ajax requests on the same page, Ajax requests
3929
 * POST an array of all IDs currently present on the page, which are used to
3930
 * prime this function's cache upon first invocation.
3931
 *
3932
 * To allow reverse-parsing of IDs submitted via Ajax, any multiple consecutive
3933
 * hyphens in the originally passed $id are replaced with a single hyphen.
3934
 *
3935
 * @param $id
3936
 *   The ID to clean.
3937
 *
3938
 * @return
3939
 *   The cleaned ID.
3940
 */
3941
function drupal_html_id($id) {
3942
  // If this is an Ajax request, then content returned by this page request will
3943
  // be merged with content already on the base page. The HTML IDs must be
3944
  // unique for the fully merged content. Therefore, initialize $seen_ids to
3945
  // take into account IDs that are already in use on the base page.
3946
  $seen_ids_init = &drupal_static(__FUNCTION__ . ':init');
3947
  if (!isset($seen_ids_init)) {
3948
    // Ideally, Drupal would provide an API to persist state information about
3949
    // prior page requests in the database, and we'd be able to add this
3950
    // function's $seen_ids static variable to that state information in order
3951
    // to have it properly initialized for this page request. However, no such
3952
    // page state API exists, so instead, ajax.js adds all of the in-use HTML
3953
    // IDs to the POST data of Ajax submissions. Direct use of $_POST is
3954
    // normally not recommended as it could open up security risks, but because
3955
    // the raw POST data is cast to a number before being returned by this
3956
    // function, this usage is safe.
3957
    if (empty($_POST['ajax_html_ids'])) {
3958
      $seen_ids_init = array();
3959
    }
3960
    else {
3961
      // This function ensures uniqueness by appending a counter to the base id
3962
      // requested by the calling function after the first occurrence of that
3963
      // requested id. $_POST['ajax_html_ids'] contains the ids as they were
3964
      // returned by this function, potentially with the appended counter, so
3965
      // we parse that to reconstruct the $seen_ids array.
3966
      if (isset($_POST['ajax_html_ids'][0]) && strpos($_POST['ajax_html_ids'][0], ',') === FALSE) {
3967
        $ajax_html_ids = $_POST['ajax_html_ids'];
3968
      }
3969
      else {
3970
        // jquery.form.js may send the server a comma-separated string as the
3971
        // first element of an array (see http://drupal.org/node/1575060), so
3972
        // we need to convert it to an array in that case.
3973
        $ajax_html_ids = explode(',', $_POST['ajax_html_ids'][0]);
3974
      }
3975
      foreach ($ajax_html_ids as $seen_id) {
3976
        // We rely on '--' being used solely for separating a base id from the
3977
        // counter, which this function ensures when returning an id.
3978
        $parts = explode('--', $seen_id, 2);
3979
        if (!empty($parts[1]) && is_numeric($parts[1])) {
3980
          list($seen_id, $i) = $parts;
3981
        }
3982
        else {
3983
          $i = 1;
3984
        }
3985
        if (!isset($seen_ids_init[$seen_id]) || ($i > $seen_ids_init[$seen_id])) {
3986
          $seen_ids_init[$seen_id] = $i;
3987
        }
3988
      }
3989
    }
3990
  }
3991
  $seen_ids = &drupal_static(__FUNCTION__, $seen_ids_init);
3992

    
3993
  $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
3994

    
3995
  // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can
3996
  // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"),
3997
  // colons (":"), and periods ("."). We strip out any character not in that
3998
  // list. Note that the CSS spec doesn't allow colons or periods in identifiers
3999
  // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two
4000
  // characters as well.
4001
  $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id);
4002

    
4003
  // Removing multiple consecutive hyphens.
4004
  $id = preg_replace('/\-+/', '-', $id);
4005
  // Ensure IDs are unique by appending a counter after the first occurrence.
4006
  // The counter needs to be appended with a delimiter that does not exist in
4007
  // the base ID. Requiring a unique delimiter helps ensure that we really do
4008
  // return unique IDs and also helps us re-create the $seen_ids array during
4009
  // Ajax requests.
4010
  if (isset($seen_ids[$id])) {
4011
    $id = $id . '--' . ++$seen_ids[$id];
4012
  }
4013
  else {
4014
    $seen_ids[$id] = 1;
4015
  }
4016

    
4017
  return $id;
4018
}
4019

    
4020
/**
4021
 * Provides a standard HTML class name that identifies a page region.
4022
 *
4023
 * It is recommended that template preprocess functions apply this class to any
4024
 * page region that is output by the theme (Drupal core already handles this in
4025
 * the standard template preprocess implementation). Standardizing the class
4026
 * names in this way allows modules to implement certain features, such as
4027
 * drag-and-drop or dynamic Ajax loading, in a theme-independent way.
4028
 *
4029
 * @param $region
4030
 *   The name of the page region (for example, 'page_top' or 'content').
4031
 *
4032
 * @return
4033
 *   An HTML class that identifies the region (for example, 'region-page-top'
4034
 *   or 'region-content').
4035
 *
4036
 * @see template_preprocess_region()
4037
 */
4038
function drupal_region_class($region) {
4039
  return drupal_html_class("region-$region");
4040
}
4041

    
4042
/**
4043
 * Adds a JavaScript file, setting, or inline code to the page.
4044
 *
4045
 * The behavior of this function depends on the parameters it is called with.
4046
 * Generally, it handles the addition of JavaScript to the page, either as
4047
 * reference to an existing file or as inline code. The following actions can be
4048
 * performed using this function:
4049
 * - Add a file ('file'): Adds a reference to a JavaScript file to the page.
4050
 * - Add inline JavaScript code ('inline'): Executes a piece of JavaScript code
4051
 *   on the current page by placing the code directly in the page (for example,
4052
 *   to tell the user that a new message arrived, by opening a pop up, alert
4053
 *   box, etc.). This should only be used for JavaScript that cannot be executed
4054
 *   from a file. When adding inline code, make sure that you are not relying on
4055
 *   $() being the jQuery function. Wrap your code in
4056
 *   @code (function ($) {... })(jQuery); @endcode
4057
 *   or use jQuery() instead of $().
4058
 * - Add external JavaScript ('external'): Allows the inclusion of external
4059
 *   JavaScript files that are not hosted on the local server. Note that these
4060
 *   external JavaScript references do not get aggregated when preprocessing is
4061
 *   on.
4062
 * - Add settings ('setting'): Adds settings to Drupal's global storage of
4063
 *   JavaScript settings. Per-page settings are required by some modules to
4064
 *   function properly. All settings will be accessible at Drupal.settings.
4065
 *
4066
 * Examples:
4067
 * @code
4068
 *   drupal_add_js('misc/collapse.js');
4069
 *   drupal_add_js('misc/collapse.js', 'file');
4070
 *   drupal_add_js('jQuery(document).ready(function () { alert("Hello!"); });', 'inline');
4071
 *   drupal_add_js('jQuery(document).ready(function () { alert("Hello!"); });',
4072
 *     array('type' => 'inline', 'scope' => 'footer', 'weight' => 5)
4073
 *   );
4074
 *   drupal_add_js('http://example.com/example.js', 'external');
4075
 *   drupal_add_js(array('myModule' => array('key' => 'value')), 'setting');
4076
 * @endcode
4077
 *
4078
 * Calling drupal_static_reset('drupal_add_js') will clear all JavaScript added
4079
 * so far.
4080
 *
4081
 * If JavaScript aggregation is enabled, all JavaScript files added with
4082
 * $options['preprocess'] set to TRUE will be merged into one aggregate file.
4083
 * Preprocessed inline JavaScript will not be aggregated into this single file.
4084
 * Externally hosted JavaScripts are never aggregated.
4085
 *
4086
 * The reason for aggregating the files is outlined quite thoroughly here:
4087
 * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
4088
 * to request overhead, one bigger file just loads faster than two smaller ones
4089
 * half its size."
4090
 *
4091
 * $options['preprocess'] should be only set to TRUE when a file is required for
4092
 * all typical visitors and most pages of a site. It is critical that all
4093
 * preprocessed files are added unconditionally on every page, even if the
4094
 * files are not needed on a page. This is normally done by calling
4095
 * drupal_add_js() in a hook_init() implementation.
4096
 *
4097
 * Non-preprocessed files should only be added to the page when they are
4098
 * actually needed.
4099
 *
4100
 * @param $data
4101
 *   (optional) If given, the value depends on the $options parameter, or
4102
 *   $options['type'] if $options is passed as an associative array:
4103
 *   - 'file': Path to the file relative to base_path().
4104
 *   - 'inline': The JavaScript code that should be placed in the given scope.
4105
 *   - 'external': The absolute path to an external JavaScript file that is not
4106
 *     hosted on the local server. These files will not be aggregated if
4107
 *     JavaScript aggregation is enabled.
4108
 *   - 'setting': An associative array with configuration options. The array is
4109
 *     merged directly into Drupal.settings. All modules should wrap their
4110
 *     actual configuration settings in another variable to prevent conflicts in
4111
 *     the Drupal.settings namespace. Items added with a string key will replace
4112
 *     existing settings with that key; items with numeric array keys will be
4113
 *     added to the existing settings array.
4114
 * @param $options
4115
 *   (optional) A string defining the type of JavaScript that is being added in
4116
 *   the $data parameter ('file'/'setting'/'inline'/'external'), or an
4117
 *   associative array. JavaScript settings should always pass the string
4118
 *   'setting' only. Other types can have the following elements in the array:
4119
 *   - type: The type of JavaScript that is to be added to the page. Allowed
4120
 *     values are 'file', 'inline', 'external' or 'setting'. Defaults
4121
 *     to 'file'.
4122
 *   - scope: The location in which you want to place the script. Possible
4123
 *     values are 'header' or 'footer'. If your theme implements different
4124
 *     regions, you can also use these. Defaults to 'header'.
4125
 *   - group: A number identifying the group in which to add the JavaScript.
4126
 *     Available constants are:
4127
 *     - JS_LIBRARY: Any libraries, settings, or jQuery plugins.
4128
 *     - JS_DEFAULT: Any module-layer JavaScript.
4129
 *     - JS_THEME: Any theme-layer JavaScript.
4130
 *     The group number serves as a weight: JavaScript within a lower weight
4131
 *     group is presented on the page before JavaScript within a higher weight
4132
 *     group.
4133
 *   - every_page: For optimal front-end performance when aggregation is
4134
 *     enabled, this should be set to TRUE if the JavaScript is present on every
4135
 *     page of the website for users for whom it is present at all. This
4136
 *     defaults to FALSE. It is set to TRUE for JavaScript files that are added
4137
 *     via module and theme .info files. Modules that add JavaScript within
4138
 *     hook_init() implementations, or from other code that ensures that the
4139
 *     JavaScript is added to all website pages, should also set this flag to
4140
 *     TRUE. All JavaScript files within the same group and that have the
4141
 *     'every_page' flag set to TRUE and do not have 'preprocess' set to FALSE
4142
 *     are aggregated together into a single aggregate file, and that aggregate
4143
 *     file can be reused across a user's entire site visit, leading to faster
4144
 *     navigation between pages. However, JavaScript that is only needed on
4145
 *     pages less frequently visited, can be added by code that only runs for
4146
 *     those particular pages, and that code should not set the 'every_page'
4147
 *     flag. This minimizes the size of the aggregate file that the user needs
4148
 *     to download when first visiting the website. JavaScript without the
4149
 *     'every_page' flag is aggregated into a separate aggregate file. This
4150
 *     other aggregate file is likely to change from page to page, and each new
4151
 *     aggregate file needs to be downloaded when first encountered, so it
4152
 *     should be kept relatively small by ensuring that most commonly needed
4153
 *     JavaScript is added to every page.
4154
 *   - weight: A number defining the order in which the JavaScript is added to
4155
 *     the page relative to other JavaScript with the same 'scope', 'group',
4156
 *     and 'every_page' value. In some cases, the order in which the JavaScript
4157
 *     is presented on the page is very important. jQuery, for example, must be
4158
 *     added to the page before any jQuery code is run, so jquery.js uses the
4159
 *     JS_LIBRARY group and a weight of -20, jquery.once.js (a library drupal.js
4160
 *     depends on) uses the JS_LIBRARY group and a weight of -19, drupal.js uses
4161
 *     the JS_LIBRARY group and a weight of -1, other libraries use the
4162
 *     JS_LIBRARY group and a weight of 0 or higher, and all other scripts use
4163
 *     one of the other group constants. The exact ordering of JavaScript is as
4164
 *     follows:
4165
 *     - First by scope, with 'header' first, 'footer' last, and any other
4166
 *       scopes provided by a custom theme coming in between, as determined by
4167
 *       the theme.
4168
 *     - Then by group.
4169
 *     - Then by the 'every_page' flag, with TRUE coming before FALSE.
4170
 *     - Then by weight.
4171
 *     - Then by the order in which the JavaScript was added. For example, all
4172
 *       else being the same, JavaScript added by a call to drupal_add_js() that
4173
 *       happened later in the page request gets added to the page after one for
4174
 *       which drupal_add_js() happened earlier in the page request.
4175
 *   - requires_jquery: Set this to FALSE if the JavaScript you are adding does
4176
 *     not have a dependency on jQuery. Defaults to TRUE, except for JavaScript
4177
 *     settings where it defaults to FALSE. This is used on sites that have the
4178
 *     'javascript_always_use_jquery' variable set to FALSE; on those sites, if
4179
 *     all the JavaScript added to the page by drupal_add_js() does not have a
4180
 *     dependency on jQuery, then for improved front-end performance Drupal
4181
 *     will not add jQuery and related libraries and settings to the page.
4182
 *   - defer: If set to TRUE, the defer attribute is set on the <script>
4183
 *     tag. Defaults to FALSE.
4184
 *   - cache: If set to FALSE, the JavaScript file is loaded anew on every page
4185
 *     call; in other words, it is not cached. Used only when 'type' references
4186
 *     a JavaScript file. Defaults to TRUE.
4187
 *   - preprocess: If TRUE and JavaScript aggregation is enabled, the script
4188
 *     file will be aggregated. Defaults to TRUE.
4189
 *
4190
 * @return
4191
 *   The current array of JavaScript files, settings, and in-line code,
4192
 *   including Drupal defaults, anything previously added with calls to
4193
 *   drupal_add_js(), and this function call's additions.
4194
 *
4195
 * @see drupal_get_js()
4196
 */
4197
function drupal_add_js($data = NULL, $options = NULL) {
4198
  $javascript = &drupal_static(__FUNCTION__, array());
4199
  $jquery_added = &drupal_static(__FUNCTION__ . ':jquery_added', FALSE);
4200

    
4201
  // If the $javascript variable has been reset with drupal_static_reset(),
4202
  // jQuery and related files will have been removed from the list, so set the
4203
  // variable back to FALSE to indicate they have not yet been added.
4204
  if (empty($javascript)) {
4205
    $jquery_added = FALSE;
4206
  }
4207

    
4208
  // Construct the options, taking the defaults into consideration.
4209
  if (isset($options)) {
4210
    if (!is_array($options)) {
4211
      $options = array('type' => $options);
4212
    }
4213
  }
4214
  else {
4215
    $options = array();
4216
  }
4217
  if (isset($options['type']) && $options['type'] == 'setting') {
4218
    $options += array('requires_jquery' => FALSE);
4219
  }
4220
  $options += drupal_js_defaults($data);
4221

    
4222
  // Preprocess can only be set if caching is enabled.
4223
  $options['preprocess'] = $options['cache'] ? $options['preprocess'] : FALSE;
4224

    
4225
  // Tweak the weight so that files of the same weight are included in the
4226
  // order of the calls to drupal_add_js().
4227
  $options['weight'] += count($javascript) / 1000;
4228

    
4229
  if (isset($data)) {
4230
    // Add jquery.js, drupal.js, and related files and settings if they have
4231
    // not been added yet. However, if the 'javascript_always_use_jquery'
4232
    // variable is set to FALSE (indicating that the site does not want jQuery
4233
    // automatically added on all pages) then only add it if a file or setting
4234
    // that requires jQuery is being added also.
4235
    if (!$jquery_added && (variable_get('javascript_always_use_jquery', TRUE) || $options['requires_jquery'])) {
4236
      $jquery_added = TRUE;
4237
      // url() generates the prefix using hook_url_outbound_alter(). Instead of
4238
      // running the hook_url_outbound_alter() again here, extract the prefix
4239
      // from url().
4240
      url('', array('prefix' => &$prefix));
4241
      $default_javascript = array(
4242
        'settings' => array(
4243
          'data' => array(
4244
            array('basePath' => base_path()),
4245
            array('pathPrefix' => empty($prefix) ? '' : $prefix),
4246
          ),
4247
          'type' => 'setting',
4248
          'scope' => 'header',
4249
          'group' => JS_LIBRARY,
4250
          'every_page' => TRUE,
4251
          'weight' => 0,
4252
        ),
4253
        'misc/drupal.js' => array(
4254
          'data' => 'misc/drupal.js',
4255
          'type' => 'file',
4256
          'scope' => 'header',
4257
          'group' => JS_LIBRARY,
4258
          'every_page' => TRUE,
4259
          'weight' => -1,
4260
          'requires_jquery' => TRUE,
4261
          'preprocess' => TRUE,
4262
          'cache' => TRUE,
4263
          'defer' => FALSE,
4264
        ),
4265
      );
4266
      $javascript = drupal_array_merge_deep($javascript, $default_javascript);
4267
      // Register all required libraries.
4268
      drupal_add_library('system', 'jquery', TRUE);
4269
      drupal_add_library('system', 'jquery.once', TRUE);
4270
    }
4271

    
4272
    switch ($options['type']) {
4273
      case 'setting':
4274
        // All JavaScript settings are placed in the header of the page with
4275
        // the library weight so that inline scripts appear afterwards.
4276
        $javascript['settings']['data'][] = $data;
4277
        break;
4278

    
4279
      case 'inline':
4280
        $javascript[] = $options;
4281
        break;
4282

    
4283
      default: // 'file' and 'external'
4284
        // Local and external files must keep their name as the associative key
4285
        // so the same JavaScript file is not added twice.
4286
        $javascript[$options['data']] = $options;
4287
    }
4288
  }
4289
  return $javascript;
4290
}
4291

    
4292
/**
4293
 * Constructs an array of the defaults that are used for JavaScript items.
4294
 *
4295
 * @param $data
4296
 *   (optional) The default data parameter for the JavaScript item array.
4297
 *
4298
 * @see drupal_get_js()
4299
 * @see drupal_add_js()
4300
 */
4301
function drupal_js_defaults($data = NULL) {
4302
  return array(
4303
    'type' => 'file',
4304
    'group' => JS_DEFAULT,
4305
    'every_page' => FALSE,
4306
    'weight' => 0,
4307
    'requires_jquery' => TRUE,
4308
    'scope' => 'header',
4309
    'cache' => TRUE,
4310
    'defer' => FALSE,
4311
    'preprocess' => TRUE,
4312
    'version' => NULL,
4313
    'data' => $data,
4314
  );
4315
}
4316

    
4317
/**
4318
 * Returns a themed presentation of all JavaScript code for the current page.
4319
 *
4320
 * References to JavaScript files are placed in a certain order: first, all
4321
 * 'core' files, then all 'module' and finally all 'theme' JavaScript files
4322
 * are added to the page. Then, all settings are output, followed by 'inline'
4323
 * JavaScript code. If running update.php, all preprocessing is disabled.
4324
 *
4325
 * Note that hook_js_alter(&$javascript) is called during this function call
4326
 * to allow alterations of the JavaScript during its presentation. Calls to
4327
 * drupal_add_js() from hook_js_alter() will not be added to the output
4328
 * presentation. The correct way to add JavaScript during hook_js_alter()
4329
 * is to add another element to the $javascript array, deriving from
4330
 * drupal_js_defaults(). See locale_js_alter() for an example of this.
4331
 *
4332
 * @param $scope
4333
 *   (optional) The scope for which the JavaScript rules should be returned.
4334
 *   Defaults to 'header'.
4335
 * @param $javascript
4336
 *   (optional) An array with all JavaScript code. Defaults to the default
4337
 *   JavaScript array for the given scope.
4338
 * @param $skip_alter
4339
 *   (optional) If set to TRUE, this function skips calling drupal_alter() on
4340
 *   $javascript, useful when the calling function passes a $javascript array
4341
 *   that has already been altered.
4342
 *
4343
 * @return
4344
 *   All JavaScript code segments and includes for the scope as HTML tags.
4345
 *
4346
 * @see drupal_add_js()
4347
 * @see locale_js_alter()
4348
 * @see drupal_js_defaults()
4349
 */
4350
function drupal_get_js($scope = 'header', $javascript = NULL, $skip_alter = FALSE) {
4351
  if (!isset($javascript)) {
4352
    $javascript = drupal_add_js();
4353
  }
4354

    
4355
  // If no JavaScript items have been added, or if the only JavaScript items
4356
  // that have been added are JavaScript settings (which don't do anything
4357
  // without any JavaScript code to use them), then no JavaScript code should
4358
  // be added to the page.
4359
  if (empty($javascript) || (isset($javascript['settings']) && count($javascript) == 1)) {
4360
    return '';
4361
  }
4362

    
4363
  // Allow modules to alter the JavaScript.
4364
  if (!$skip_alter) {
4365
    drupal_alter('js', $javascript);
4366
  }
4367

    
4368
  // Filter out elements of the given scope.
4369
  $items = array();
4370
  foreach ($javascript as $key => $item) {
4371
    if ($item['scope'] == $scope) {
4372
      $items[$key] = $item;
4373
    }
4374
  }
4375

    
4376
  $output = '';
4377
  // The index counter is used to keep aggregated and non-aggregated files in
4378
  // order by weight.
4379
  $index = 1;
4380
  $processed = array();
4381
  $files = array();
4382
  $preprocess_js = (variable_get('preprocess_js', FALSE) && (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update'));
4383

    
4384
  // A dummy query-string is added to filenames, to gain control over
4385
  // browser-caching. The string changes on every update or full cache
4386
  // flush, forcing browsers to load a new copy of the files, as the
4387
  // URL changed. Files that should not be cached (see drupal_add_js())
4388
  // get REQUEST_TIME as query-string instead, to enforce reload on every
4389
  // page request.
4390
  $default_query_string = variable_get('css_js_query_string', '0');
4391

    
4392
  // For inline JavaScript to validate as XHTML, all JavaScript containing
4393
  // XHTML needs to be wrapped in CDATA. To make that backwards compatible
4394
  // with HTML 4, we need to comment out the CDATA-tag.
4395
  $embed_prefix = "\n<!--//--><![CDATA[//><!--\n";
4396
  $embed_suffix = "\n//--><!]]>\n";
4397

    
4398
  // Since JavaScript may look for arguments in the URL and act on them, some
4399
  // third-party code might require the use of a different query string.
4400
  $js_version_string = variable_get('drupal_js_version_query_string', 'v=');
4401

    
4402
  // Sort the JavaScript so that it appears in the correct order.
4403
  uasort($items, 'drupal_sort_css_js');
4404

    
4405
  // Provide the page with information about the individual JavaScript files
4406
  // used, information not otherwise available when aggregation is enabled.
4407
  $setting['ajaxPageState']['js'] = array_fill_keys(array_keys($items), 1);
4408
  unset($setting['ajaxPageState']['js']['settings']);
4409
  drupal_add_js($setting, 'setting');
4410

    
4411
  // If we're outputting the header scope, then this might be the final time
4412
  // that drupal_get_js() is running, so add the setting to this output as well
4413
  // as to the drupal_add_js() cache. If $items['settings'] doesn't exist, it's
4414
  // because drupal_get_js() was intentionally passed a $javascript argument
4415
  // stripped off settings, potentially in order to override how settings get
4416
  // output, so in this case, do not add the setting to this output.
4417
  if ($scope == 'header' && isset($items['settings'])) {
4418
    $items['settings']['data'][] = $setting;
4419
  }
4420

    
4421
  // Loop through the JavaScript to construct the rendered output.
4422
  $element = array(
4423
    '#tag' => 'script',
4424
    '#value' => '',
4425
    '#attributes' => array(
4426
      'type' => 'text/javascript',
4427
    ),
4428
  );
4429
  foreach ($items as $item) {
4430
    $query_string =  empty($item['version']) ? $default_query_string : $js_version_string . $item['version'];
4431

    
4432
    switch ($item['type']) {
4433
      case 'setting':
4434
        $js_element = $element;
4435
        $js_element['#value_prefix'] = $embed_prefix;
4436
        $js_element['#value'] = 'jQuery.extend(Drupal.settings, ' . drupal_json_encode(drupal_array_merge_deep_array($item['data'])) . ");";
4437
        $js_element['#value_suffix'] = $embed_suffix;
4438
        $output .= theme('html_tag', array('element' => $js_element));
4439
        break;
4440

    
4441
      case 'inline':
4442
        $js_element = $element;
4443
        if ($item['defer']) {
4444
          $js_element['#attributes']['defer'] = 'defer';
4445
        }
4446
        $js_element['#value_prefix'] = $embed_prefix;
4447
        $js_element['#value'] = $item['data'];
4448
        $js_element['#value_suffix'] = $embed_suffix;
4449
        $processed[$index++] = theme('html_tag', array('element' => $js_element));
4450
        break;
4451

    
4452
      case 'file':
4453
        $js_element = $element;
4454
        if (!$item['preprocess'] || !$preprocess_js) {
4455
          if ($item['defer']) {
4456
            $js_element['#attributes']['defer'] = 'defer';
4457
          }
4458
          $query_string_separator = (strpos($item['data'], '?') !== FALSE) ? '&' : '?';
4459
          $js_element['#attributes']['src'] = file_create_url($item['data']) . $query_string_separator . ($item['cache'] ? $query_string : REQUEST_TIME);
4460
          $processed[$index++] = theme('html_tag', array('element' => $js_element));
4461
        }
4462
        else {
4463
          // By increasing the index for each aggregated file, we maintain
4464
          // the relative ordering of JS by weight. We also set the key such
4465
          // that groups are split by items sharing the same 'group' value and
4466
          // 'every_page' flag. While this potentially results in more aggregate
4467
          // files, it helps make each one more reusable across a site visit,
4468
          // leading to better front-end performance of a website as a whole.
4469
          // See drupal_add_js() for details.
4470
          $key = 'aggregate_' . $item['group'] . '_' . $item['every_page'] . '_' . $index;
4471
          $processed[$key] = '';
4472
          $files[$key][$item['data']] = $item;
4473
        }
4474
        break;
4475

    
4476
      case 'external':
4477
        $js_element = $element;
4478
        // Preprocessing for external JavaScript files is ignored.
4479
        if ($item['defer']) {
4480
          $js_element['#attributes']['defer'] = 'defer';
4481
        }
4482
        $js_element['#attributes']['src'] = $item['data'];
4483
        $processed[$index++] = theme('html_tag', array('element' => $js_element));
4484
        break;
4485
    }
4486
  }
4487

    
4488
  // Aggregate any remaining JS files that haven't already been output.
4489
  if ($preprocess_js && count($files) > 0) {
4490
    foreach ($files as $key => $file_set) {
4491
      $uri = drupal_build_js_cache($file_set);
4492
      // Only include the file if was written successfully. Errors are logged
4493
      // using watchdog.
4494
      if ($uri) {
4495
        $preprocess_file = file_create_url($uri);
4496
        $js_element = $element;
4497
        $js_element['#attributes']['src'] = $preprocess_file;
4498
        $processed[$key] = theme('html_tag', array('element' => $js_element));
4499
      }
4500
    }
4501
  }
4502

    
4503
  // Keep the order of JS files consistent as some are preprocessed and others are not.
4504
  // Make sure any inline or JS setting variables appear last after libraries have loaded.
4505
  return implode('', $processed) . $output;
4506
}
4507

    
4508
/**
4509
 * Adds attachments to a render() structure.
4510
 *
4511
 * Libraries, JavaScript, CSS and other types of custom structures are attached
4512
 * to elements using the #attached property. The #attached property is an
4513
 * associative array, where the keys are the attachment types and the values are
4514
 * the attached data. For example:
4515
 * @code
4516
 * $build['#attached'] = array(
4517
 *   'js' => array(drupal_get_path('module', 'taxonomy') . '/taxonomy.js'),
4518
 *   'css' => array(drupal_get_path('module', 'taxonomy') . '/taxonomy.css'),
4519
 * );
4520
 * @endcode
4521
 *
4522
 * 'js', 'css', and 'library' are types that get special handling. For any
4523
 * other kind of attached data, the array key must be the full name of the
4524
 * callback function and each value an array of arguments. For example:
4525
 * @code
4526
 * $build['#attached']['drupal_add_http_header'] = array(
4527
 *   array('Content-Type', 'application/rss+xml; charset=utf-8'),
4528
 * );
4529
 * @endcode
4530
 *
4531
 * External 'js' and 'css' files can also be loaded. For example:
4532
 * @code
4533
 * $build['#attached']['js'] = array(
4534
 *   'http://code.jquery.com/jquery-1.4.2.min.js' => array(
4535
 *     'type' => 'external',
4536
 *   ),
4537
 * );
4538
 * @endcode
4539
 *
4540
 * @param $elements
4541
 *   The structured array describing the data being rendered.
4542
 * @param $group
4543
 *   The default group of JavaScript and CSS being added. This is only applied
4544
 *   to the stylesheets and JavaScript items that don't have an explicit group
4545
 *   assigned to them.
4546
 * @param $dependency_check
4547
 *   When TRUE, will exit if a given library's dependencies are missing. When
4548
 *   set to FALSE, will continue to add the libraries, even though one or more
4549
 *   dependencies are missing. Defaults to FALSE.
4550
 * @param $every_page
4551
 *   Set to TRUE to indicate that the attachments are added to every page on the
4552
 *   site. Only attachments with the every_page flag set to TRUE can participate
4553
 *   in JavaScript/CSS aggregation.
4554
 *
4555
 * @return
4556
 *   FALSE if there were any missing library dependencies; TRUE if all library
4557
 *   dependencies were met.
4558
 *
4559
 * @see drupal_add_library()
4560
 * @see drupal_add_js()
4561
 * @see drupal_add_css()
4562
 * @see drupal_render()
4563
 */
4564
function drupal_process_attached($elements, $group = JS_DEFAULT, $dependency_check = FALSE, $every_page = NULL) {
4565
  // Add defaults to the special attached structures that should be processed differently.
4566
  $elements['#attached'] += array(
4567
    'library' => array(),
4568
    'js' => array(),
4569
    'css' => array(),
4570
  );
4571

    
4572
  // Add the libraries first.
4573
  $success = TRUE;
4574
  foreach ($elements['#attached']['library'] as $library) {
4575
    if (drupal_add_library($library[0], $library[1], $every_page) === FALSE) {
4576
      $success = FALSE;
4577
      // Exit if the dependency is missing.
4578
      if ($dependency_check) {
4579
        return $success;
4580
      }
4581
    }
4582
  }
4583
  unset($elements['#attached']['library']);
4584

    
4585
  // Add both the JavaScript and the CSS.
4586
  // The parameters for drupal_add_js() and drupal_add_css() require special
4587
  // handling.
4588
  foreach (array('js', 'css') as $type) {
4589
    foreach ($elements['#attached'][$type] as $data => $options) {
4590
      // If the value is not an array, it's a filename and passed as first
4591
      // (and only) argument.
4592
      if (!is_array($options)) {
4593
        $data = $options;
4594
        $options = NULL;
4595
      }
4596
      // In some cases, the first parameter ($data) is an array. Arrays can't be
4597
      // passed as keys in PHP, so we have to get $data from the value array.
4598
      if (is_numeric($data)) {
4599
        $data = $options['data'];
4600
        unset($options['data']);
4601
      }
4602
      // Apply the default group if it isn't explicitly given.
4603
      if (!isset($options['group'])) {
4604
        $options['group'] = $group;
4605
      }
4606
      // Set the every_page flag if one was passed.
4607
      if (isset($every_page)) {
4608
        $options['every_page'] = $every_page;
4609
      }
4610
      call_user_func('drupal_add_' . $type, $data, $options);
4611
    }
4612
    unset($elements['#attached'][$type]);
4613
  }
4614

    
4615
  // Add additional types of attachments specified in the render() structure.
4616
  // Libraries, JavaScript and CSS have been added already, as they require
4617
  // special handling.
4618
  foreach ($elements['#attached'] as $callback => $options) {
4619
    if (function_exists($callback)) {
4620
      foreach ($elements['#attached'][$callback] as $args) {
4621
        call_user_func_array($callback, $args);
4622
      }
4623
    }
4624
  }
4625

    
4626
  return $success;
4627
}
4628

    
4629
/**
4630
 * Adds JavaScript to change the state of an element based on another element.
4631
 *
4632
 * A "state" means a certain property on a DOM element, such as "visible" or
4633
 * "checked". A state can be applied to an element, depending on the state of
4634
 * another element on the page. In general, states depend on HTML attributes and
4635
 * DOM element properties, which change due to user interaction.
4636
 *
4637
 * Since states are driven by JavaScript only, it is important to understand
4638
 * that all states are applied on presentation only, none of the states force
4639
 * any server-side logic, and that they will not be applied for site visitors
4640
 * without JavaScript support. All modules implementing states have to make
4641
 * sure that the intended logic also works without JavaScript being enabled.
4642
 *
4643
 * #states is an associative array in the form of:
4644
 * @code
4645
 * array(
4646
 *   STATE1 => CONDITIONS_ARRAY1,
4647
 *   STATE2 => CONDITIONS_ARRAY2,
4648
 *   ...
4649
 * )
4650
 * @endcode
4651
 * Each key is the name of a state to apply to the element, such as 'visible'.
4652
 * Each value is a list of conditions that denote when the state should be
4653
 * applied.
4654
 *
4655
 * Multiple different states may be specified to act on complex conditions:
4656
 * @code
4657
 * array(
4658
 *   'visible' => CONDITIONS,
4659
 *   'checked' => OTHER_CONDITIONS,
4660
 * )
4661
 * @endcode
4662
 *
4663
 * Every condition is a key/value pair, whose key is a jQuery selector that
4664
 * denotes another element on the page, and whose value is an array of
4665
 * conditions, which must bet met on that element:
4666
 * @code
4667
 * array(
4668
 *   'visible' => array(
4669
 *     JQUERY_SELECTOR => REMOTE_CONDITIONS,
4670
 *     JQUERY_SELECTOR => REMOTE_CONDITIONS,
4671
 *     ...
4672
 *   ),
4673
 * )
4674
 * @endcode
4675
 * All conditions must be met for the state to be applied.
4676
 *
4677
 * Each remote condition is a key/value pair specifying conditions on the other
4678
 * element that need to be met to apply the state to the element:
4679
 * @code
4680
 * array(
4681
 *   'visible' => array(
4682
 *     ':input[name="remote_checkbox"]' => array('checked' => TRUE),
4683
 *   ),
4684
 * )
4685
 * @endcode
4686
 *
4687
 * For example, to show a textfield only when a checkbox is checked:
4688
 * @code
4689
 * $form['toggle_me'] = array(
4690
 *   '#type' => 'checkbox',
4691
 *   '#title' => t('Tick this box to type'),
4692
 * );
4693
 * $form['settings'] = array(
4694
 *   '#type' => 'textfield',
4695
 *   '#states' => array(
4696
 *     // Only show this field when the 'toggle_me' checkbox is enabled.
4697
 *     'visible' => array(
4698
 *       ':input[name="toggle_me"]' => array('checked' => TRUE),
4699
 *     ),
4700
 *   ),
4701
 * );
4702
 * @endcode
4703
 *
4704
 * The following states may be applied to an element:
4705
 * - enabled
4706
 * - disabled
4707
 * - required
4708
 * - optional
4709
 * - visible
4710
 * - invisible
4711
 * - checked
4712
 * - unchecked
4713
 * - expanded
4714
 * - collapsed
4715
 *
4716
 * The following states may be used in remote conditions:
4717
 * - empty
4718
 * - filled
4719
 * - checked
4720
 * - unchecked
4721
 * - expanded
4722
 * - collapsed
4723
 * - value
4724
 *
4725
 * The following states exist for both elements and remote conditions, but are
4726
 * not fully implemented and may not change anything on the element:
4727
 * - relevant
4728
 * - irrelevant
4729
 * - valid
4730
 * - invalid
4731
 * - touched
4732
 * - untouched
4733
 * - readwrite
4734
 * - readonly
4735
 *
4736
 * When referencing select lists and radio buttons in remote conditions, a
4737
 * 'value' condition must be used:
4738
 * @code
4739
 *   '#states' => array(
4740
 *     // Show the settings if 'bar' has been selected for 'foo'.
4741
 *     'visible' => array(
4742
 *       ':input[name="foo"]' => array('value' => 'bar'),
4743
 *     ),
4744
 *   ),
4745
 * @endcode
4746
 *
4747
 * @param $elements
4748
 *   A renderable array element having a #states property as described above.
4749
 *
4750
 * @see form_example_states_form()
4751
 */
4752
function drupal_process_states(&$elements) {
4753
  $elements['#attached']['library'][] = array('system', 'drupal.states');
4754
  $elements['#attached']['js'][] = array(
4755
    'type' => 'setting',
4756
    'data' => array('states' => array('#' . $elements['#id'] => $elements['#states'])),
4757
  );
4758
}
4759

    
4760
/**
4761
 * Adds multiple JavaScript or CSS files at the same time.
4762
 *
4763
 * A library defines a set of JavaScript and/or CSS files, optionally using
4764
 * settings, and optionally requiring another library. For example, a library
4765
 * can be a jQuery plugin, a JavaScript framework, or a CSS framework. This
4766
 * function allows modules to load a library defined/shipped by itself or a
4767
 * depending module, without having to add all files of the library separately.
4768
 * Each library is only loaded once.
4769
 *
4770
 * @param $module
4771
 *   The name of the module that registered the library.
4772
 * @param $name
4773
 *   The name of the library to add.
4774
 * @param $every_page
4775
 *   Set to TRUE if this library is added to every page on the site. Only items
4776
 *   with the every_page flag set to TRUE can participate in aggregation.
4777
 *
4778
 * @return
4779
 *   TRUE if the library was successfully added; FALSE if the library or one of
4780
 *   its dependencies could not be added.
4781
 *
4782
 * @see drupal_get_library()
4783
 * @see hook_library()
4784
 * @see hook_library_alter()
4785
 */
4786
function drupal_add_library($module, $name, $every_page = NULL) {
4787
  $added = &drupal_static(__FUNCTION__, array());
4788

    
4789
  // Only process the library if it exists and it was not added already.
4790
  if (!isset($added[$module][$name])) {
4791
    if ($library = drupal_get_library($module, $name)) {
4792
      // Add all components within the library.
4793
      $elements['#attached'] = array(
4794
        'library' => $library['dependencies'],
4795
        'js' => $library['js'],
4796
        'css' => $library['css'],
4797
      );
4798
      $added[$module][$name] = drupal_process_attached($elements, JS_LIBRARY, TRUE, $every_page);
4799
    }
4800
    else {
4801
      // Requested library does not exist.
4802
      $added[$module][$name] = FALSE;
4803
    }
4804
  }
4805

    
4806
  return $added[$module][$name];
4807
}
4808

    
4809
/**
4810
 * Retrieves information for a JavaScript/CSS library.
4811
 *
4812
 * Library information is statically cached. Libraries are keyed by module for
4813
 * several reasons:
4814
 * - Libraries are not unique. Multiple modules might ship with the same library
4815
 *   in a different version or variant. This registry cannot (and does not
4816
 *   attempt to) prevent library conflicts.
4817
 * - Modules implementing and thereby depending on a library that is registered
4818
 *   by another module can only rely on that module's library.
4819
 * - Two (or more) modules can still register the same library and use it
4820
 *   without conflicts in case the libraries are loaded on certain pages only.
4821
 *
4822
 * @param $module
4823
 *   The name of a module that registered a library.
4824
 * @param $name
4825
 *   (optional) The name of a registered library to retrieve. By default, all
4826
 *   libraries registered by $module are returned.
4827
 *
4828
 * @return
4829
 *   The definition of the requested library, if $name was passed and it exists,
4830
 *   or FALSE if it does not exist. If no $name was passed, an associative array
4831
 *   of libraries registered by $module is returned (which may be empty).
4832
 *
4833
 * @see drupal_add_library()
4834
 * @see hook_library()
4835
 * @see hook_library_alter()
4836
 *
4837
 * @todo The purpose of drupal_get_*() is completely different to other page
4838
 *   requisite API functions; find and use a different name.
4839
 */
4840
function drupal_get_library($module, $name = NULL) {
4841
  $libraries = &drupal_static(__FUNCTION__, array());
4842

    
4843
  if (!isset($libraries[$module])) {
4844
    // Retrieve all libraries associated with the module.
4845
    $module_libraries = module_invoke($module, 'library');
4846
    if (empty($module_libraries)) {
4847
      $module_libraries = array();
4848
    }
4849
    // Allow modules to alter the module's registered libraries.
4850
    drupal_alter('library', $module_libraries, $module);
4851

    
4852
    foreach ($module_libraries as $key => $data) {
4853
      if (is_array($data)) {
4854
        // Add default elements to allow for easier processing.
4855
        $module_libraries[$key] += array('dependencies' => array(), 'js' => array(), 'css' => array());
4856
        foreach ($module_libraries[$key]['js'] as $file => $options) {
4857
          $module_libraries[$key]['js'][$file]['version'] = $module_libraries[$key]['version'];
4858
        }
4859
      }
4860
    }
4861
    $libraries[$module] = $module_libraries;
4862
  }
4863
  if (isset($name)) {
4864
    if (!isset($libraries[$module][$name])) {
4865
      $libraries[$module][$name] = FALSE;
4866
    }
4867
    return $libraries[$module][$name];
4868
  }
4869
  return $libraries[$module];
4870
}
4871

    
4872
/**
4873
 * Assists in adding the tableDrag JavaScript behavior to a themed table.
4874
 *
4875
 * Draggable tables should be used wherever an outline or list of sortable items
4876
 * needs to be arranged by an end-user. Draggable tables are very flexible and
4877
 * can manipulate the value of form elements placed within individual columns.
4878
 *
4879
 * To set up a table to use drag and drop in place of weight select-lists or in
4880
 * place of a form that contains parent relationships, the form must be themed
4881
 * into a table. The table must have an ID attribute set. If using
4882
 * theme_table(), the ID may be set as follows:
4883
 * @code
4884
 * $output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'my-module-table')));
4885
 * return $output;
4886
 * @endcode
4887
 *
4888
 * In the theme function for the form, a special class must be added to each
4889
 * form element within the same column, "grouping" them together.
4890
 *
4891
 * In a situation where a single weight column is being sorted in the table, the
4892
 * classes could be added like this (in the theme function):
4893
 * @code
4894
 * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
4895
 * @endcode
4896
 *
4897
 * Each row of the table must also have a class of "draggable" in order to
4898
 * enable the drag handles:
4899
 * @code
4900
 * $row = array(...);
4901
 * $rows[] = array(
4902
 *   'data' => $row,
4903
 *   'class' => array('draggable'),
4904
 * );
4905
 * @endcode
4906
 *
4907
 * When tree relationships are present, the two additional classes
4908
 * 'tabledrag-leaf' and 'tabledrag-root' can be used to refine the behavior:
4909
 * - Rows with the 'tabledrag-leaf' class cannot have child rows.
4910
 * - Rows with the 'tabledrag-root' class cannot be nested under a parent row.
4911
 *
4912
 * Calling drupal_add_tabledrag() would then be written as such:
4913
 * @code
4914
 * drupal_add_tabledrag('my-module-table', 'order', 'sibling', 'my-elements-weight');
4915
 * @endcode
4916
 *
4917
 * In a more complex case where there are several groups in one column (such as
4918
 * the block regions on the admin/structure/block page), a separate subgroup
4919
 * class must also be added to differentiate the groups.
4920
 * @code
4921
 * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
4922
 * @endcode
4923
 *
4924
 * $group is still 'my-element-weight', and the additional $subgroup variable
4925
 * will be passed in as 'my-elements-weight-' . $region. This also means that
4926
 * you'll need to call drupal_add_tabledrag() once for every region added.
4927
 *
4928
 * @code
4929
 * foreach ($regions as $region) {
4930
 *   drupal_add_tabledrag('my-module-table', 'order', 'sibling', 'my-elements-weight', 'my-elements-weight-' . $region);
4931
 * }
4932
 * @endcode
4933
 *
4934
 * In a situation where tree relationships are present, adding multiple
4935
 * subgroups is not necessary, because the table will contain indentations that
4936
 * provide enough information about the sibling and parent relationships. See
4937
 * theme_menu_overview_form() for an example creating a table containing parent
4938
 * relationships.
4939
 *
4940
 * Note that this function should be called from the theme layer, such as in a
4941
 * .tpl.php file, theme_ function, or in a template_preprocess function, not in
4942
 * a form declaration. Though the same JavaScript could be added to the page
4943
 * using drupal_add_js() directly, this function helps keep template files
4944
 * clean and readable. It also prevents tabledrag.js from being added twice
4945
 * accidentally.
4946
 *
4947
 * @param $table_id
4948
 *   String containing the target table's id attribute. If the table does not
4949
 *   have an id, one will need to be set, such as <table id="my-module-table">.
4950
 * @param $action
4951
 *   String describing the action to be done on the form item. Either 'match'
4952
 *   'depth', or 'order'. Match is typically used for parent relationships.
4953
 *   Order is typically used to set weights on other form elements with the same
4954
 *   group. Depth updates the target element with the current indentation.
4955
 * @param $relationship
4956
 *   String describing where the $action variable should be performed. Either
4957
 *   'parent', 'sibling', 'group', or 'self'. Parent will only look for fields
4958
 *   up the tree. Sibling will look for fields in the same group in rows above
4959
 *   and below it. Self affects the dragged row itself. Group affects the
4960
 *   dragged row, plus any children below it (the entire dragged group).
4961
 * @param $group
4962
 *   A class name applied on all related form elements for this action.
4963
 * @param $subgroup
4964
 *   (optional) If the group has several subgroups within it, this string should
4965
 *   contain the class name identifying fields in the same subgroup.
4966
 * @param $source
4967
 *   (optional) If the $action is 'match', this string should contain the class
4968
 *   name identifying what field will be used as the source value when matching
4969
 *   the value in $subgroup.
4970
 * @param $hidden
4971
 *   (optional) The column containing the field elements may be entirely hidden
4972
 *   from view dynamically when the JavaScript is loaded. Set to FALSE if the
4973
 *   column should not be hidden.
4974
 * @param $limit
4975
 *   (optional) Limit the maximum amount of parenting in this table.
4976
 * @see block-admin-display-form.tpl.php
4977
 * @see theme_menu_overview_form()
4978
 */
4979
function drupal_add_tabledrag($table_id, $action, $relationship, $group, $subgroup = NULL, $source = NULL, $hidden = TRUE, $limit = 0) {
4980
  $js_added = &drupal_static(__FUNCTION__, FALSE);
4981
  if (!$js_added) {
4982
    // Add the table drag JavaScript to the page before the module JavaScript
4983
    // to ensure that table drag behaviors are registered before any module
4984
    // uses it.
4985
    drupal_add_library('system', 'jquery.cookie');
4986
    drupal_add_js('misc/tabledrag.js', array('weight' => -1));
4987
    $js_added = TRUE;
4988
  }
4989

    
4990
  // If a subgroup or source isn't set, assume it is the same as the group.
4991
  $target = isset($subgroup) ? $subgroup : $group;
4992
  $source = isset($source) ? $source : $target;
4993
  $settings['tableDrag'][$table_id][$group][] = array(
4994
    'target' => $target,
4995
    'source' => $source,
4996
    'relationship' => $relationship,
4997
    'action' => $action,
4998
    'hidden' => $hidden,
4999
    'limit' => $limit,
5000
  );
5001
  drupal_add_js($settings, 'setting');
5002
}
5003

    
5004
/**
5005
 * Aggregates JavaScript files into a cache file in the files directory.
5006
 *
5007
 * The file name for the JavaScript cache file is generated from the hash of
5008
 * the aggregated contents of the files in $files. This forces proxies and
5009
 * browsers to download new JavaScript when the JavaScript changes.
5010
 *
5011
 * The cache file name is retrieved on a page load via a lookup variable that
5012
 * contains an associative array. The array key is the hash of the names in
5013
 * $files while the value is the cache file name. The cache file is generated
5014
 * in two cases. First, if there is no file name value for the key, which will
5015
 * happen if a new file name has been added to $files or after the lookup
5016
 * variable is emptied to force a rebuild of the cache. Second, the cache file
5017
 * is generated if it is missing on disk. Old cache files are not deleted
5018
 * immediately when the lookup variable is emptied, but are deleted after a set
5019
 * period by drupal_delete_file_if_stale(). This ensures that files referenced
5020
 * by a cached page will still be available.
5021
 *
5022
 * @param $files
5023
 *   An array of JavaScript files to aggregate and compress into one file.
5024
 *
5025
 * @return
5026
 *   The URI of the cache file, or FALSE if the file could not be saved.
5027
 */
5028
function drupal_build_js_cache($files) {
5029
  $contents = '';
5030
  $uri = '';
5031
  $map = variable_get('drupal_js_cache_files', array());
5032
  // Create a new array so that only the file names are used to create the hash.
5033
  // This prevents new aggregates from being created unnecessarily.
5034
  $js_data = array();
5035
  foreach ($files as $file) {
5036
    $js_data[] = $file['data'];
5037
  }
5038
  $key = hash('sha256', serialize($js_data));
5039
  if (isset($map[$key])) {
5040
    $uri = $map[$key];
5041
  }
5042

    
5043
  if (empty($uri) || !file_exists($uri)) {
5044
    // Build aggregate JS file.
5045
    foreach ($files as $path => $info) {
5046
      if ($info['preprocess']) {
5047
        // Append a ';' and a newline after each JS file to prevent them from running together.
5048
        $contents .= file_get_contents($path) . ";\n";
5049
      }
5050
    }
5051
    // Prefix filename to prevent blocking by firewalls which reject files
5052
    // starting with "ad*".
5053
    $filename = 'js_' . drupal_hash_base64($contents) . '.js';
5054
    // Create the js/ within the files folder.
5055
    $jspath = 'public://js';
5056
    $uri = $jspath . '/' . $filename;
5057
    // Create the JS file.
5058
    file_prepare_directory($jspath, FILE_CREATE_DIRECTORY);
5059
    if (!file_exists($uri) && !file_unmanaged_save_data($contents, $uri, FILE_EXISTS_REPLACE)) {
5060
      return FALSE;
5061
    }
5062
    // If JS gzip compression is enabled, clean URLs are enabled (which means
5063
    // that rewrite rules are working) and the zlib extension is available then
5064
    // create a gzipped version of this file. This file is served conditionally
5065
    // to browsers that accept gzip using .htaccess rules.
5066
    if (variable_get('js_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
5067
      if (!file_exists($uri . '.gz') && !file_unmanaged_save_data(gzencode($contents, 9, FORCE_GZIP), $uri . '.gz', FILE_EXISTS_REPLACE)) {
5068
        return FALSE;
5069
      }
5070
    }
5071
    $map[$key] = $uri;
5072
    variable_set('drupal_js_cache_files', $map);
5073
  }
5074
  return $uri;
5075
}
5076

    
5077
/**
5078
 * Deletes old cached JavaScript files and variables.
5079
 */
5080
function drupal_clear_js_cache() {
5081
  variable_del('javascript_parsed');
5082
  variable_del('drupal_js_cache_files');
5083
  file_scan_directory('public://js', '/.*/', array('callback' => 'drupal_delete_file_if_stale'));
5084
}
5085

    
5086
/**
5087
 * Converts a PHP variable into its JavaScript equivalent.
5088
 *
5089
 * We use HTML-safe strings, with several characters escaped.
5090
 *
5091
 * @see drupal_json_decode()
5092
 * @see drupal_json_encode_helper()
5093
 * @ingroup php_wrappers
5094
 */
5095
function drupal_json_encode($var) {
5096
  // The PHP version cannot change within a request.
5097
  static $php530;
5098

    
5099
  if (!isset($php530)) {
5100
    $php530 = version_compare(PHP_VERSION, '5.3.0', '>=');
5101
  }
5102

    
5103
  if ($php530) {
5104
    // Encode <, >, ', &, and " using the json_encode() options parameter.
5105
    return json_encode($var, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT);
5106
  }
5107

    
5108
  // json_encode() escapes <, >, ', &, and " using its options parameter, but
5109
  // does not support this parameter prior to PHP 5.3.0.  Use a helper instead.
5110
  include_once DRUPAL_ROOT . '/includes/json-encode.inc';
5111
  return drupal_json_encode_helper($var);
5112
}
5113

    
5114
/**
5115
 * Converts an HTML-safe JSON string into its PHP equivalent.
5116
 *
5117
 * @see drupal_json_encode()
5118
 * @ingroup php_wrappers
5119
 */
5120
function drupal_json_decode($var) {
5121
  return json_decode($var, TRUE);
5122
}
5123

    
5124
/**
5125
 * Returns data in JSON format.
5126
 *
5127
 * This function should be used for JavaScript callback functions returning
5128
 * data in JSON format. It sets the header for JavaScript output.
5129
 *
5130
 * @param $var
5131
 *   (optional) If set, the variable will be converted to JSON and output.
5132
 */
5133
function drupal_json_output($var = NULL) {
5134
  // We are returning JSON, so tell the browser.
5135
  drupal_add_http_header('Content-Type', 'application/json');
5136

    
5137
  if (isset($var)) {
5138
    echo drupal_json_encode($var);
5139
  }
5140
}
5141

    
5142
/**
5143
 * Ensures the private key variable used to generate tokens is set.
5144
 *
5145
 * @return
5146
 *   The private key.
5147
 */
5148
function drupal_get_private_key() {
5149
  if (!($key = variable_get('drupal_private_key', 0))) {
5150
    $key = drupal_random_key();
5151
    variable_set('drupal_private_key', $key);
5152
  }
5153
  return $key;
5154
}
5155

    
5156
/**
5157
 * Generates a token based on $value, the user session, and the private key.
5158
 *
5159
 * @param $value
5160
 *   An additional value to base the token on.
5161
 *
5162
 * The generated token is based on the session ID of the current user. Normally,
5163
 * anonymous users do not have a session, so the generated token will be
5164
 * different on every page request. To generate a token for users without a
5165
 * session, manually start a session prior to calling this function.
5166
 *
5167
 * @return string
5168
 *   A 43-character URL-safe token for validation, based on the user session ID,
5169
 *   the hash salt provided from drupal_get_hash_salt(), and the
5170
 *   'drupal_private_key' configuration variable.
5171
 *
5172
 * @see drupal_get_hash_salt()
5173
 */
5174
function drupal_get_token($value = '') {
5175
  return drupal_hmac_base64($value, session_id() . drupal_get_private_key() . drupal_get_hash_salt());
5176
}
5177

    
5178
/**
5179
 * Validates a token based on $value, the user session, and the private key.
5180
 *
5181
 * @param $token
5182
 *   The token to be validated.
5183
 * @param $value
5184
 *   An additional value to base the token on.
5185
 * @param $skip_anonymous
5186
 *   Set to true to skip token validation for anonymous users.
5187
 *
5188
 * @return
5189
 *   True for a valid token, false for an invalid token. When $skip_anonymous
5190
 *   is true, the return value will always be true for anonymous users.
5191
 */
5192
function drupal_valid_token($token, $value = '', $skip_anonymous = FALSE) {
5193
  global $user;
5194
  return (($skip_anonymous && $user->uid == 0) || ($token === drupal_get_token($value)));
5195
}
5196

    
5197
function _drupal_bootstrap_full() {
5198
  static $called = FALSE;
5199

    
5200
  if ($called) {
5201
    return;
5202
  }
5203
  $called = TRUE;
5204
  require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'includes/path.inc');
5205
  require_once DRUPAL_ROOT . '/includes/theme.inc';
5206
  require_once DRUPAL_ROOT . '/includes/pager.inc';
5207
  require_once DRUPAL_ROOT . '/' . variable_get('menu_inc', 'includes/menu.inc');
5208
  require_once DRUPAL_ROOT . '/includes/tablesort.inc';
5209
  require_once DRUPAL_ROOT . '/includes/file.inc';
5210
  require_once DRUPAL_ROOT . '/includes/unicode.inc';
5211
  require_once DRUPAL_ROOT . '/includes/image.inc';
5212
  require_once DRUPAL_ROOT . '/includes/form.inc';
5213
  require_once DRUPAL_ROOT . '/includes/mail.inc';
5214
  require_once DRUPAL_ROOT . '/includes/actions.inc';
5215
  require_once DRUPAL_ROOT . '/includes/ajax.inc';
5216
  require_once DRUPAL_ROOT . '/includes/token.inc';
5217
  require_once DRUPAL_ROOT . '/includes/errors.inc';
5218

    
5219
  // Detect string handling method
5220
  unicode_check();
5221
  // Undo magic quotes
5222
  fix_gpc_magic();
5223
  // Load all enabled modules
5224
  module_load_all();
5225
  // Reset drupal_alter() and module_implements() static caches as these
5226
  // include implementations for vital modules only when called early on
5227
  // in the bootstrap.
5228
  drupal_static_reset('drupal_alter');
5229
  drupal_static_reset('module_implements');
5230
  // Make sure all stream wrappers are registered.
5231
  file_get_stream_wrappers();
5232
  // Ensure mt_rand is reseeded, to prevent random values from one page load
5233
  // being exploited to predict random values in subsequent page loads.
5234
  $seed = unpack("L", drupal_random_bytes(4));
5235
  mt_srand($seed[1]);
5236

    
5237
  $test_info = &$GLOBALS['drupal_test_info'];
5238
  if (!empty($test_info['in_child_site'])) {
5239
    // Running inside the simpletest child site, log fatal errors to test
5240
    // specific file directory.
5241
    ini_set('log_errors', 1);
5242
    ini_set('error_log', 'public://error.log');
5243
  }
5244

    
5245
  // Initialize $_GET['q'] prior to invoking hook_init().
5246
  drupal_path_initialize();
5247

    
5248
  // Let all modules take action before the menu system handles the request.
5249
  // We do not want this while running update.php.
5250
  if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
5251
    // Prior to invoking hook_init(), initialize the theme (potentially a custom
5252
    // one for this page), so that:
5253
    // - Modules with hook_init() implementations that call theme() or
5254
    //   theme_get_registry() don't initialize the incorrect theme.
5255
    // - The theme can have hook_*_alter() implementations affect page building
5256
    //   (e.g., hook_form_alter(), hook_node_view_alter(), hook_page_alter()),
5257
    //   ahead of when rendering starts.
5258
    menu_set_custom_theme();
5259
    drupal_theme_initialize();
5260
    module_invoke_all('init');
5261
  }
5262
}
5263

    
5264
/**
5265
 * Stores the current page in the cache.
5266
 *
5267
 * If page_compression is enabled, a gzipped version of the page is stored in
5268
 * the cache to avoid compressing the output on each request. The cache entry
5269
 * is unzipped in the relatively rare event that the page is requested by a
5270
 * client without gzip support.
5271
 *
5272
 * Page compression requires the PHP zlib extension
5273
 * (http://php.net/manual/ref.zlib.php).
5274
 *
5275
 * @see drupal_page_header()
5276
 */
5277
function drupal_page_set_cache() {
5278
  global $base_root;
5279

    
5280
  if (drupal_page_is_cacheable()) {
5281

    
5282
    // Check whether the current page might be compressed.
5283
    $page_compressed = variable_get('page_compression', TRUE) && extension_loaded('zlib');
5284

    
5285
    $cache = (object) array(
5286
      'cid' => $base_root . request_uri(),
5287
      'data' => array(
5288
        'path' => $_GET['q'],
5289
        'body' => ob_get_clean(),
5290
        'title' => drupal_get_title(),
5291
        'headers' => array(),
5292
        // We need to store whether page was compressed or not,
5293
        // because by the time it is read, the configuration might change.
5294
        'page_compressed' => $page_compressed,
5295
      ),
5296
      'expire' => CACHE_TEMPORARY,
5297
      'created' => REQUEST_TIME,
5298
    );
5299

    
5300
    // Restore preferred header names based on the lower-case names returned
5301
    // by drupal_get_http_header().
5302
    $header_names = _drupal_set_preferred_header_name();
5303
    foreach (drupal_get_http_header() as $name_lower => $value) {
5304
      $cache->data['headers'][$header_names[$name_lower]] = $value;
5305
      if ($name_lower == 'expires') {
5306
        // Use the actual timestamp from an Expires header if available.
5307
        $cache->expire = strtotime($value);
5308
      }
5309
    }
5310

    
5311
    if ($cache->data['body']) {
5312
      if ($page_compressed) {
5313
        $cache->data['body'] = gzencode($cache->data['body'], 9, FORCE_GZIP);
5314
      }
5315
      cache_set($cache->cid, $cache->data, 'cache_page', $cache->expire);
5316
    }
5317
    return $cache;
5318
  }
5319
}
5320

    
5321
/**
5322
 * Executes a cron run when called.
5323
 *
5324
 * Do not call this function from a test. Use $this->cronRun() instead.
5325
 *
5326
 * @return bool
5327
 *   TRUE if cron ran successfully and FALSE if cron is already running.
5328
 */
5329
function drupal_cron_run() {
5330
  // Allow execution to continue even if the request gets canceled.
5331
  @ignore_user_abort(TRUE);
5332

    
5333
  // Prevent session information from being saved while cron is running.
5334
  $original_session_saving = drupal_save_session();
5335
  drupal_save_session(FALSE);
5336

    
5337
  // Force the current user to anonymous to ensure consistent permissions on
5338
  // cron runs.
5339
  $original_user = $GLOBALS['user'];
5340
  $GLOBALS['user'] = drupal_anonymous_user();
5341

    
5342
  // Try to allocate enough time to run all the hook_cron implementations.
5343
  drupal_set_time_limit(240);
5344

    
5345
  $return = FALSE;
5346
  // Grab the defined cron queues.
5347
  $queues = module_invoke_all('cron_queue_info');
5348
  drupal_alter('cron_queue_info', $queues);
5349

    
5350
  // Try to acquire cron lock.
5351
  if (!lock_acquire('cron', 240.0)) {
5352
    // Cron is still running normally.
5353
    watchdog('cron', 'Attempting to re-run cron while it is already running.', array(), WATCHDOG_WARNING);
5354
  }
5355
  else {
5356
    // Make sure every queue exists. There is no harm in trying to recreate an
5357
    // existing queue.
5358
    foreach ($queues as $queue_name => $info) {
5359
      DrupalQueue::get($queue_name)->createQueue();
5360
    }
5361

    
5362
    // Iterate through the modules calling their cron handlers (if any):
5363
    foreach (module_implements('cron') as $module) {
5364
      // Do not let an exception thrown by one module disturb another.
5365
      try {
5366
        module_invoke($module, 'cron');
5367
      }
5368
      catch (Exception $e) {
5369
        watchdog_exception('cron', $e);
5370
      }
5371
    }
5372

    
5373
    // Record cron time.
5374
    variable_set('cron_last', REQUEST_TIME);
5375
    watchdog('cron', 'Cron run completed.', array(), WATCHDOG_NOTICE);
5376

    
5377
    // Release cron lock.
5378
    lock_release('cron');
5379

    
5380
    // Return TRUE so other functions can check if it did run successfully
5381
    $return = TRUE;
5382
  }
5383

    
5384
  foreach ($queues as $queue_name => $info) {
5385
    if (!empty($info['skip on cron'])) {
5386
      // Do not run if queue wants to skip.
5387
      continue;
5388
    }
5389
    $callback = $info['worker callback'];
5390
    $end = time() + (isset($info['time']) ? $info['time'] : 15);
5391
    $queue = DrupalQueue::get($queue_name);
5392
    while (time() < $end && ($item = $queue->claimItem())) {
5393
      try {
5394
        call_user_func($callback, $item->data);
5395
        $queue->deleteItem($item);
5396
      }
5397
      catch (Exception $e) {
5398
        // In case of exception log it and leave the item in the queue
5399
        // to be processed again later.
5400
        watchdog_exception('cron', $e);
5401
      }
5402
    }
5403
  }
5404
  // Restore the user.
5405
  $GLOBALS['user'] = $original_user;
5406
  drupal_save_session($original_session_saving);
5407

    
5408
  return $return;
5409
}
5410

    
5411
/**
5412
 * DEPRECATED: Shutdown function: Performs cron cleanup.
5413
 *
5414
 * This function is deprecated because the 'cron_semaphore' variable it
5415
 * references no longer exists. It is therefore no longer used as a shutdown
5416
 * function by Drupal core.
5417
 *
5418
 * @deprecated
5419
 */
5420
function drupal_cron_cleanup() {
5421
  // See if the semaphore is still locked.
5422
  if (variable_get('cron_semaphore', FALSE)) {
5423
    watchdog('cron', 'Cron run exceeded the time limit and was aborted.', array(), WATCHDOG_WARNING);
5424

    
5425
    // Release cron semaphore.
5426
    variable_del('cron_semaphore');
5427
  }
5428
}
5429

    
5430
/**
5431
 * Returns information about system object files (modules, themes, etc.).
5432
 *
5433
 * This function is used to find all or some system object files (module files,
5434
 * theme files, etc.) that exist on the site. It searches in several locations,
5435
 * depending on what type of object you are looking for. For instance, if you
5436
 * are looking for modules and call:
5437
 * @code
5438
 * drupal_system_listing("/\.module$/", "modules", 'name', 0);
5439
 * @endcode
5440
 * this function will search the site-wide modules directory (i.e., /modules/),
5441
 * your installation profile's directory (i.e.,
5442
 * /profiles/your_site_profile/modules/), the all-sites directory (i.e.,
5443
 * /sites/all/modules/), and your site-specific directory (i.e.,
5444
 * /sites/your_site_dir/modules/), in that order, and return information about
5445
 * all of the files ending in .module in those directories.
5446
 *
5447
 * The information is returned in an associative array, which can be keyed on
5448
 * the file name ($key = 'filename'), the file name without the extension ($key
5449
 * = 'name'), or the full file stream URI ($key = 'uri'). If you use a key of
5450
 * 'filename' or 'name', files found later in the search will take precedence
5451
 * over files found earlier (unless they belong to a module or theme not
5452
 * compatible with Drupal core); if you choose a key of 'uri', you will get all
5453
 * files found.
5454
 *
5455
 * @param string $mask
5456
 *   The preg_match() regular expression for the files to find.
5457
 * @param string $directory
5458
 *   The subdirectory name in which the files are found. For example,
5459
 *   'modules' will search in sub-directories of the top-level /modules
5460
 *   directory, sub-directories of /sites/all/modules/, etc.
5461
 * @param string $key
5462
 *   The key to be used for the associative array returned. Possible values are
5463
 *   'uri', for the file's URI; 'filename', for the basename of the file; and
5464
 *   'name' for the name of the file without the extension. If you choose 'name'
5465
 *   or 'filename', only the highest-precedence file will be returned.
5466
 * @param int $min_depth
5467
 *   Minimum depth of directories to return files from, relative to each
5468
 *   directory searched. For instance, a minimum depth of 2 would find modules
5469
 *   inside /modules/node/tests, but not modules directly in /modules/node.
5470
 *
5471
 * @return array
5472
 *   An associative array of file objects, keyed on the chosen key. Each element
5473
 *   in the array is an object containing file information, with properties:
5474
 *   - 'uri': Full URI of the file.
5475
 *   - 'filename': File name.
5476
 *   - 'name': Name of file without the extension.
5477
 */
5478
function drupal_system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
5479
  $config = conf_path();
5480

    
5481
  $searchdir = array($directory);
5482
  $files = array();
5483

    
5484
  // The 'profiles' directory contains pristine collections of modules and
5485
  // themes as organized by a distribution. It is pristine in the same way
5486
  // that /modules is pristine for core; users should avoid changing anything
5487
  // there in favor of sites/all or sites/<domain> directories.
5488
  $profiles = array();
5489
  $profile = drupal_get_profile();
5490
  // For SimpleTest to be able to test modules packaged together with a
5491
  // distribution we need to include the profile of the parent site (in which
5492
  // test runs are triggered).
5493
  if (drupal_valid_test_ua()) {
5494
    $testing_profile = variable_get('simpletest_parent_profile', FALSE);
5495
    if ($testing_profile && $testing_profile != $profile) {
5496
      $profiles[] = $testing_profile;
5497
    }
5498
  }
5499
  // In case both profile directories contain the same extension, the actual
5500
  // profile always has precedence.
5501
  $profiles[] = $profile;
5502
  foreach ($profiles as $profile) {
5503
    if (file_exists("profiles/$profile/$directory")) {
5504
      $searchdir[] = "profiles/$profile/$directory";
5505
    }
5506
  }
5507

    
5508
  // Always search sites/all/* as well as the global directories.
5509
  $searchdir[] = 'sites/all/' . $directory;
5510

    
5511
  if (file_exists("$config/$directory")) {
5512
    $searchdir[] = "$config/$directory";
5513
  }
5514

    
5515
  // Get current list of items.
5516
  if (!function_exists('file_scan_directory')) {
5517
    require_once DRUPAL_ROOT . '/includes/file.inc';
5518
  }
5519
  foreach ($searchdir as $dir) {
5520
    $files_to_add = file_scan_directory($dir, $mask, array('key' => $key, 'min_depth' => $min_depth));
5521

    
5522
    // Duplicate files found in later search directories take precedence over
5523
    // earlier ones, so we want them to overwrite keys in our resulting
5524
    // $files array.
5525
    // The exception to this is if the later file is from a module or theme not
5526
    // compatible with Drupal core. This may occur during upgrades of Drupal
5527
    // core when new modules exist in core while older contrib modules with the
5528
    // same name exist in a directory such as sites/all/modules/.
5529
    foreach (array_intersect_key($files_to_add, $files) as $file_key => $file) {
5530
      // If it has no info file, then we just behave liberally and accept the
5531
      // new resource on the list for merging.
5532
      if (file_exists($info_file = dirname($file->uri) . '/' . $file->name . '.info')) {
5533
        // Get the .info file for the module or theme this file belongs to.
5534
        $info = drupal_parse_info_file($info_file);
5535

    
5536
        // If the module or theme is incompatible with Drupal core, remove it
5537
        // from the array for the current search directory, so it is not
5538
        // overwritten when merged with the $files array.
5539
        if (isset($info['core']) && $info['core'] != DRUPAL_CORE_COMPATIBILITY) {
5540
          unset($files_to_add[$file_key]);
5541
        }
5542
      }
5543
    }
5544
    $files = array_merge($files, $files_to_add);
5545
  }
5546

    
5547
  return $files;
5548
}
5549

    
5550
/**
5551
 * Sets the main page content value for later use.
5552
 *
5553
 * Given the nature of the Drupal page handling, this will be called once with
5554
 * a string or array. We store that and return it later as the block is being
5555
 * displayed.
5556
 *
5557
 * @param $content
5558
 *   A string or renderable array representing the body of the page.
5559
 *
5560
 * @return
5561
 *   If called without $content, a renderable array representing the body of
5562
 *   the page.
5563
 */
5564
function drupal_set_page_content($content = NULL) {
5565
  $content_block = &drupal_static(__FUNCTION__, NULL);
5566
  $main_content_display = &drupal_static('system_main_content_added', FALSE);
5567

    
5568
  if (!empty($content)) {
5569
    $content_block = (is_array($content) ? $content : array('main' => array('#markup' => $content)));
5570
  }
5571
  else {
5572
    // Indicate that the main content has been requested. We assume that
5573
    // the module requesting the content will be adding it to the page.
5574
    // A module can indicate that it does not handle the content by setting
5575
    // the static variable back to FALSE after calling this function.
5576
    $main_content_display = TRUE;
5577
    return $content_block;
5578
  }
5579
}
5580

    
5581
/**
5582
 * #pre_render callback to render #browsers into #prefix and #suffix.
5583
 *
5584
 * @param $elements
5585
 *   A render array with a '#browsers' property. The '#browsers' property can
5586
 *   contain any or all of the following keys:
5587
 *   - 'IE': If FALSE, the element is not rendered by Internet Explorer. If
5588
 *     TRUE, the element is rendered by Internet Explorer. Can also be a string
5589
 *     containing an expression for Internet Explorer to evaluate as part of a
5590
 *     conditional comment. For example, this can be set to 'lt IE 7' for the
5591
 *     element to be rendered in Internet Explorer 6, but not in Internet
5592
 *     Explorer 7 or higher. Defaults to TRUE.
5593
 *   - '!IE': If FALSE, the element is not rendered by browsers other than
5594
 *     Internet Explorer. If TRUE, the element is rendered by those browsers.
5595
 *     Defaults to TRUE.
5596
 *   Examples:
5597
 *   - To render an element in all browsers, '#browsers' can be left out or set
5598
 *     to array('IE' => TRUE, '!IE' => TRUE).
5599
 *   - To render an element in Internet Explorer only, '#browsers' can be set
5600
 *     to array('!IE' => FALSE).
5601
 *   - To render an element in Internet Explorer 6 only, '#browsers' can be set
5602
 *     to array('IE' => 'lt IE 7', '!IE' => FALSE).
5603
 *   - To render an element in Internet Explorer 8 and higher and in all other
5604
 *     browsers, '#browsers' can be set to array('IE' => 'gte IE 8').
5605
 *
5606
 * @return
5607
 *   The passed-in element with markup for conditional comments potentially
5608
 *   added to '#prefix' and '#suffix'.
5609
 */
5610
function drupal_pre_render_conditional_comments($elements) {
5611
  $browsers = isset($elements['#browsers']) ? $elements['#browsers'] : array();
5612
  $browsers += array(
5613
    'IE' => TRUE,
5614
    '!IE' => TRUE,
5615
  );
5616

    
5617
  // If rendering in all browsers, no need for conditional comments.
5618
  if ($browsers['IE'] === TRUE && $browsers['!IE']) {
5619
    return $elements;
5620
  }
5621

    
5622
  // Determine the conditional comment expression for Internet Explorer to
5623
  // evaluate.
5624
  if ($browsers['IE'] === TRUE) {
5625
    $expression = 'IE';
5626
  }
5627
  elseif ($browsers['IE'] === FALSE) {
5628
    $expression = '!IE';
5629
  }
5630
  else {
5631
    $expression = $browsers['IE'];
5632
  }
5633

    
5634
  // Wrap the element's potentially existing #prefix and #suffix properties with
5635
  // conditional comment markup. The conditional comment expression is evaluated
5636
  // by Internet Explorer only. To control the rendering by other browsers,
5637
  // either the "downlevel-hidden" or "downlevel-revealed" technique must be
5638
  // used. See http://en.wikipedia.org/wiki/Conditional_comment for details.
5639
  $elements += array(
5640
    '#prefix' => '',
5641
    '#suffix' => '',
5642
  );
5643
  if (!$browsers['!IE']) {
5644
    // "downlevel-hidden".
5645
    $elements['#prefix'] = "\n<!--[if $expression]>\n" . $elements['#prefix'];
5646
    $elements['#suffix'] .= "<![endif]-->\n";
5647
  }
5648
  else {
5649
    // "downlevel-revealed".
5650
    $elements['#prefix'] = "\n<!--[if $expression]><!-->\n" . $elements['#prefix'];
5651
    $elements['#suffix'] .= "<!--<![endif]-->\n";
5652
  }
5653

    
5654
  return $elements;
5655
}
5656

    
5657
/**
5658
 * #pre_render callback to render a link into #markup.
5659
 *
5660
 * Doing so during pre_render gives modules a chance to alter the link parts.
5661
 *
5662
 * @param $elements
5663
 *   A structured array whose keys form the arguments to l():
5664
 *   - #title: The link text to pass as argument to l().
5665
 *   - #href: The URL path component to pass as argument to l().
5666
 *   - #options: (optional) An array of options to pass to l().
5667
 *
5668
 * @return
5669
 *   The passed-in elements containing a rendered link in '#markup'.
5670
 */
5671
function drupal_pre_render_link($element) {
5672
  // By default, link options to pass to l() are normally set in #options.
5673
  $element += array('#options' => array());
5674
  // However, within the scope of renderable elements, #attributes is a valid
5675
  // way to specify attributes, too. Take them into account, but do not override
5676
  // attributes from #options.
5677
  if (isset($element['#attributes'])) {
5678
    $element['#options'] += array('attributes' => array());
5679
    $element['#options']['attributes'] += $element['#attributes'];
5680
  }
5681

    
5682
  // This #pre_render callback can be invoked from inside or outside of a Form
5683
  // API context, and depending on that, a HTML ID may be already set in
5684
  // different locations. #options should have precedence over Form API's #id.
5685
  // #attributes have been taken over into #options above already.
5686
  if (isset($element['#options']['attributes']['id'])) {
5687
    $element['#id'] = $element['#options']['attributes']['id'];
5688
  }
5689
  elseif (isset($element['#id'])) {
5690
    $element['#options']['attributes']['id'] = $element['#id'];
5691
  }
5692

    
5693
  // Conditionally invoke ajax_pre_render_element(), if #ajax is set.
5694
  if (isset($element['#ajax']) && !isset($element['#ajax_processed'])) {
5695
    // If no HTML ID was found above, automatically create one.
5696
    if (!isset($element['#id'])) {
5697
      $element['#id'] = $element['#options']['attributes']['id'] = drupal_html_id('ajax-link');
5698
    }
5699
    // If #ajax['path] was not specified, use the href as Ajax request URL.
5700
    if (!isset($element['#ajax']['path'])) {
5701
      $element['#ajax']['path'] = $element['#href'];
5702
      $element['#ajax']['options'] = $element['#options'];
5703
    }
5704
    $element = ajax_pre_render_element($element);
5705
  }
5706

    
5707
  $element['#markup'] = l($element['#title'], $element['#href'], $element['#options']);
5708
  return $element;
5709
}
5710

    
5711
/**
5712
 * #pre_render callback that collects child links into a single array.
5713
 *
5714
 * This function can be added as a pre_render callback for a renderable array,
5715
 * usually one which will be themed by theme_links(). It iterates through all
5716
 * unrendered children of the element, collects any #links properties it finds,
5717
 * merges them into the parent element's #links array, and prevents those
5718
 * children from being rendered separately.
5719
 *
5720
 * The purpose of this is to allow links to be logically grouped into related
5721
 * categories, so that each child group can be rendered as its own list of
5722
 * links if drupal_render() is called on it, but calling drupal_render() on the
5723
 * parent element will still produce a single list containing all the remaining
5724
 * links, regardless of what group they were in.
5725
 *
5726
 * A typical example comes from node links, which are stored in a renderable
5727
 * array similar to this:
5728
 * @code
5729
 * $node->content['links'] = array(
5730
 *   '#theme' => 'links__node',
5731
 *   '#pre_render' => array('drupal_pre_render_links'),
5732
 *   'comment' => array(
5733
 *     '#theme' => 'links__node__comment',
5734
 *     '#links' => array(
5735
 *       // An array of links associated with node comments, suitable for
5736
 *       // passing in to theme_links().
5737
 *     ),
5738
 *   ),
5739
 *   'statistics' => array(
5740
 *     '#theme' => 'links__node__statistics',
5741
 *     '#links' => array(
5742
 *       // An array of links associated with node statistics, suitable for
5743
 *       // passing in to theme_links().
5744
 *     ),
5745
 *   ),
5746
 *   'translation' => array(
5747
 *     '#theme' => 'links__node__translation',
5748
 *     '#links' => array(
5749
 *       // An array of links associated with node translation, suitable for
5750
 *       // passing in to theme_links().
5751
 *     ),
5752
 *   ),
5753
 * );
5754
 * @endcode
5755
 *
5756
 * In this example, the links are grouped by functionality, which can be
5757
 * helpful to themers who want to display certain kinds of links independently.
5758
 * For example, adding this code to node.tpl.php will result in the comment
5759
 * links being rendered as a single list:
5760
 * @code
5761
 * print render($content['links']['comment']);
5762
 * @endcode
5763
 *
5764
 * (where $node->content has been transformed into $content before handing
5765
 * control to the node.tpl.php template).
5766
 *
5767
 * The pre_render function defined here allows the above flexibility, but also
5768
 * allows the following code to be used to render all remaining links into a
5769
 * single list, regardless of their group:
5770
 * @code
5771
 * print render($content['links']);
5772
 * @endcode
5773
 *
5774
 * In the above example, this will result in the statistics and translation
5775
 * links being rendered together in a single list (but not the comment links,
5776
 * which were rendered previously on their own).
5777
 *
5778
 * Because of the way this function works, the individual properties of each
5779
 * group (for example, a group-specific #theme property such as
5780
 * 'links__node__comment' in the example above, or any other property such as
5781
 * #attributes or #pre_render that is attached to it) are only used when that
5782
 * group is rendered on its own. When the group is rendered together with other
5783
 * children, these child-specific properties are ignored, and only the overall
5784
 * properties of the parent are used.
5785
 */
5786
function drupal_pre_render_links($element) {
5787
  $element += array('#links' => array());
5788
  foreach (element_children($element) as $key) {
5789
    $child = &$element[$key];
5790
    // If the child has links which have not been printed yet and the user has
5791
    // access to it, merge its links in to the parent.
5792
    if (isset($child['#links']) && empty($child['#printed']) && (!isset($child['#access']) || $child['#access'])) {
5793
      $element['#links'] += $child['#links'];
5794
      // Mark the child as having been printed already (so that its links
5795
      // cannot be mistakenly rendered twice).
5796
      $child['#printed'] = TRUE;
5797
    }
5798
  }
5799
  return $element;
5800
}
5801

    
5802
/**
5803
 * #pre_render callback to append contents in #markup to #children.
5804
 *
5805
 * This needs to be a #pre_render callback, because eventually assigned
5806
 * #theme_wrappers will expect the element's rendered content in #children.
5807
 * Note that if also a #theme is defined for the element, then the result of
5808
 * the theme callback will override #children.
5809
 *
5810
 * @param $elements
5811
 *   A structured array using the #markup key.
5812
 *
5813
 * @return
5814
 *   The passed-in elements, but #markup appended to #children.
5815
 *
5816
 * @see drupal_render()
5817
 */
5818
function drupal_pre_render_markup($elements) {
5819
  $elements['#children'] = $elements['#markup'];
5820
  return $elements;
5821
}
5822

    
5823
/**
5824
 * Renders the page, including all theming.
5825
 *
5826
 * @param $page
5827
 *   A string or array representing the content of a page. The array consists of
5828
 *   the following keys:
5829
 *   - #type: Value is always 'page'. This pushes the theming through
5830
 *     page.tpl.php (required).
5831
 *   - #show_messages: Suppress drupal_get_message() items. Used by Batch
5832
 *     API (optional).
5833
 *
5834
 * @see hook_page_alter()
5835
 * @see element_info()
5836
 */
5837
function drupal_render_page($page) {
5838
  $main_content_display = &drupal_static('system_main_content_added', FALSE);
5839

    
5840
  // Allow menu callbacks to return strings or arbitrary arrays to render.
5841
  // If the array returned is not of #type page directly, we need to fill
5842
  // in the page with defaults.
5843
  if (is_string($page) || (is_array($page) && (!isset($page['#type']) || ($page['#type'] != 'page')))) {
5844
    drupal_set_page_content($page);
5845
    $page = element_info('page');
5846
  }
5847

    
5848
  // Modules can add elements to $page as needed in hook_page_build().
5849
  foreach (module_implements('page_build') as $module) {
5850
    $function = $module . '_page_build';
5851
    $function($page);
5852
  }
5853
  // Modules alter the $page as needed. Blocks are populated into regions like
5854
  // 'sidebar_first', 'footer', etc.
5855
  drupal_alter('page', $page);
5856

    
5857
  // If no module has taken care of the main content, add it to the page now.
5858
  // This allows the site to still be usable even if no modules that
5859
  // control page regions (for example, the Block module) are enabled.
5860
  if (!$main_content_display) {
5861
    $page['content']['system_main'] = drupal_set_page_content();
5862
  }
5863

    
5864
  return drupal_render($page);
5865
}
5866

    
5867
/**
5868
 * Renders HTML given a structured array tree.
5869
 *
5870
 * Recursively iterates over each of the array elements, generating HTML code.
5871
 *
5872
 * Renderable arrays have two kinds of key/value pairs: properties and
5873
 * children. Properties have keys starting with '#' and their values influence
5874
 * how the array will be rendered. Children are all elements whose keys do not
5875
 * start with a '#'. Their values should be renderable arrays themselves,
5876
 * which will be rendered during the rendering of the parent array. The markup
5877
 * provided by the children is typically inserted into the markup generated by
5878
 * the parent array.
5879
 *
5880
 * HTML generation for a renderable array, and the treatment of any children,
5881
 * is controlled by two properties containing theme functions, #theme and
5882
 * #theme_wrappers.
5883
 *
5884
 * #theme is the theme function called first. If it is set and the element has
5885
 * any children, it is the responsibility of the theme function to render
5886
 * these children. For elements that are not allowed to have any children,
5887
 * e.g. buttons or textfields, the theme function can be used to render the
5888
 * element itself. If #theme is not present and the element has children, each
5889
 * child is itself rendered by a call to drupal_render(), and the results are
5890
 * concatenated.
5891
 *
5892
 * The #theme_wrappers property contains an array of theme functions which will
5893
 * be called, in order, after #theme has run. These can be used to add further
5894
 * markup around the rendered children; e.g., fieldsets add the required markup
5895
 * for a fieldset around their rendered child elements. All wrapper theme
5896
 * functions have to include the element's #children property in their output,
5897
 * as it contains the output of the previous theme functions and the rendered
5898
 * children.
5899
 *
5900
 * For example, for the form element type, by default only the #theme_wrappers
5901
 * property is set, which adds the form markup around the rendered child
5902
 * elements of the form. This allows you to set the #theme property on a
5903
 * specific form to a custom theme function, giving you complete control over
5904
 * the placement of the form's children while not at all having to deal with
5905
 * the form markup itself.
5906
 *
5907
 * drupal_render() can optionally cache the rendered output of elements to
5908
 * improve performance. To use drupal_render() caching, set the element's #cache
5909
 * property to an associative array with one or several of the following keys:
5910
 * - 'keys': An array of one or more keys that identify the element. If 'keys'
5911
 *   is set, the cache ID is created automatically from these keys. See
5912
 *   drupal_render_cid_create().
5913
 * - 'granularity' (optional): Define the cache granularity using binary
5914
 *   combinations of the cache granularity constants, e.g.
5915
 *   DRUPAL_CACHE_PER_USER to cache for each user separately or
5916
 *   DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE to cache separately for each
5917
 *   page and role. If not specified the element is cached globally for each
5918
 *   theme and language.
5919
 * - 'cid': Specify the cache ID directly. Either 'keys' or 'cid' is required.
5920
 *   If 'cid' is set, 'keys' and 'granularity' are ignored. Use only if you
5921
 *   have special requirements.
5922
 * - 'expire': Set to one of the cache lifetime constants.
5923
 * - 'bin': Specify a cache bin to cache the element in. Defaults to 'cache'.
5924
 *
5925
 * This function is usually called from within another function, like
5926
 * drupal_get_form() or a theme function. Elements are sorted internally
5927
 * using uasort(). Since this is expensive, when passing already sorted
5928
 * elements to drupal_render(), for example from a database query, set
5929
 * $elements['#sorted'] = TRUE to avoid sorting them a second time.
5930
 *
5931
 * drupal_render() flags each element with a '#printed' status to indicate that
5932
 * the element has been rendered, which allows individual elements of a given
5933
 * array to be rendered independently and prevents them from being rendered
5934
 * more than once on subsequent calls to drupal_render() (e.g., as part of a
5935
 * larger array). If the same array or array element is passed more than once
5936
 * to drupal_render(), it simply returns an empty string.
5937
 *
5938
 * @param array $elements
5939
 *   The structured array describing the data to be rendered.
5940
 *
5941
 * @return string
5942
 *   The rendered HTML.
5943
 */
5944
function drupal_render(&$elements) {
5945
  // Early-return nothing if user does not have access.
5946
  if (empty($elements) || (isset($elements['#access']) && !$elements['#access'])) {
5947
    return '';
5948
  }
5949

    
5950
  // Do not print elements twice.
5951
  if (!empty($elements['#printed'])) {
5952
    return '';
5953
  }
5954

    
5955
  // Try to fetch the element's markup from cache and return.
5956
  if (isset($elements['#cache'])) {
5957
    $cached_output = drupal_render_cache_get($elements);
5958
    if ($cached_output !== FALSE) {
5959
      return $cached_output;
5960
    }
5961
  }
5962

    
5963
  // If #markup is set, ensure #type is set. This allows to specify just #markup
5964
  // on an element without setting #type.
5965
  if (isset($elements['#markup']) && !isset($elements['#type'])) {
5966
    $elements['#type'] = 'markup';
5967
  }
5968

    
5969
  // If the default values for this element have not been loaded yet, populate
5970
  // them.
5971
  if (isset($elements['#type']) && empty($elements['#defaults_loaded'])) {
5972
    $elements += element_info($elements['#type']);
5973
  }
5974

    
5975
  // Make any final changes to the element before it is rendered. This means
5976
  // that the $element or the children can be altered or corrected before the
5977
  // element is rendered into the final text.
5978
  if (isset($elements['#pre_render'])) {
5979
    foreach ($elements['#pre_render'] as $function) {
5980
      if (function_exists($function)) {
5981
        $elements = $function($elements);
5982
      }
5983
    }
5984
  }
5985

    
5986
  // Allow #pre_render to abort rendering.
5987
  if (!empty($elements['#printed'])) {
5988
    return '';
5989
  }
5990

    
5991
  // Get the children of the element, sorted by weight.
5992
  $children = element_children($elements, TRUE);
5993

    
5994
  // Initialize this element's #children, unless a #pre_render callback already
5995
  // preset #children.
5996
  if (!isset($elements['#children'])) {
5997
    $elements['#children'] = '';
5998
  }
5999
  // Call the element's #theme function if it is set. Then any children of the
6000
  // element have to be rendered there.
6001
  if (isset($elements['#theme'])) {
6002
    $elements['#children'] = theme($elements['#theme'], $elements);
6003
  }
6004
  // If #theme was not set and the element has children, render them now.
6005
  // This is the same process as drupal_render_children() but is inlined
6006
  // for speed.
6007
  if ($elements['#children'] == '') {
6008
    foreach ($children as $key) {
6009
      $elements['#children'] .= drupal_render($elements[$key]);
6010
    }
6011
  }
6012

    
6013
  // Let the theme functions in #theme_wrappers add markup around the rendered
6014
  // children.
6015
  if (isset($elements['#theme_wrappers'])) {
6016
    foreach ($elements['#theme_wrappers'] as $theme_wrapper) {
6017
      $elements['#children'] = theme($theme_wrapper, $elements);
6018
    }
6019
  }
6020

    
6021
  // Filter the outputted content and make any last changes before the
6022
  // content is sent to the browser. The changes are made on $content
6023
  // which allows the output'ed text to be filtered.
6024
  if (isset($elements['#post_render'])) {
6025
    foreach ($elements['#post_render'] as $function) {
6026
      if (function_exists($function)) {
6027
        $elements['#children'] = $function($elements['#children'], $elements);
6028
      }
6029
    }
6030
  }
6031

    
6032
  // Add any JavaScript state information associated with the element.
6033
  if (!empty($elements['#states'])) {
6034
    drupal_process_states($elements);
6035
  }
6036

    
6037
  // Add additional libraries, CSS, JavaScript an other custom
6038
  // attached data associated with this element.
6039
  if (!empty($elements['#attached'])) {
6040
    drupal_process_attached($elements);
6041
  }
6042

    
6043
  $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
6044
  $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
6045
  $output = $prefix . $elements['#children'] . $suffix;
6046

    
6047
  // Cache the processed element if #cache is set.
6048
  if (isset($elements['#cache'])) {
6049
    drupal_render_cache_set($output, $elements);
6050
  }
6051

    
6052
  $elements['#printed'] = TRUE;
6053
  return $output;
6054
}
6055

    
6056
/**
6057
 * Renders children of an element and concatenates them.
6058
 *
6059
 * @param array $element
6060
 *   The structured array whose children shall be rendered.
6061
 * @param array $children_keys
6062
 *   (optional) If the keys of the element's children are already known, they
6063
 *   can be passed in to save another run of element_children().
6064
 *
6065
 * @return string
6066
 *   The rendered HTML of all children of the element.
6067

    
6068
 * @see drupal_render()
6069
 */
6070
function drupal_render_children(&$element, $children_keys = NULL) {
6071
  if ($children_keys === NULL) {
6072
    $children_keys = element_children($element);
6073
  }
6074
  $output = '';
6075
  foreach ($children_keys as $key) {
6076
    if (!empty($element[$key])) {
6077
      $output .= drupal_render($element[$key]);
6078
    }
6079
  }
6080
  return $output;
6081
}
6082

    
6083
/**
6084
 * Renders an element.
6085
 *
6086
 * This function renders an element using drupal_render(). The top level
6087
 * element is shown with show() before rendering, so it will always be rendered
6088
 * even if hide() had been previously used on it.
6089
 *
6090
 * @param $element
6091
 *   The element to be rendered.
6092
 *
6093
 * @return
6094
 *   The rendered element.
6095
 *
6096
 * @see drupal_render()
6097
 * @see show()
6098
 * @see hide()
6099
 */
6100
function render(&$element) {
6101
  if (is_array($element)) {
6102
    show($element);
6103
    return drupal_render($element);
6104
  }
6105
  else {
6106
    // Safe-guard for inappropriate use of render() on flat variables: return
6107
    // the variable as-is.
6108
    return $element;
6109
  }
6110
}
6111

    
6112
/**
6113
 * Hides an element from later rendering.
6114
 *
6115
 * The first time render() or drupal_render() is called on an element tree,
6116
 * as each element in the tree is rendered, it is marked with a #printed flag
6117
 * and the rendered children of the element are cached. Subsequent calls to
6118
 * render() or drupal_render() will not traverse the child tree of this element
6119
 * again: they will just use the cached children. So if you want to hide an
6120
 * element, be sure to call hide() on the element before its parent tree is
6121
 * rendered for the first time, as it will have no effect on subsequent
6122
 * renderings of the parent tree.
6123
 *
6124
 * @param $element
6125
 *   The element to be hidden.
6126
 *
6127
 * @return
6128
 *   The element.
6129
 *
6130
 * @see render()
6131
 * @see show()
6132
 */
6133
function hide(&$element) {
6134
  $element['#printed'] = TRUE;
6135
  return $element;
6136
}
6137

    
6138
/**
6139
 * Shows a hidden element for later rendering.
6140
 *
6141
 * You can also use render($element), which shows the element while rendering
6142
 * it.
6143
 *
6144
 * The first time render() or drupal_render() is called on an element tree,
6145
 * as each element in the tree is rendered, it is marked with a #printed flag
6146
 * and the rendered children of the element are cached. Subsequent calls to
6147
 * render() or drupal_render() will not traverse the child tree of this element
6148
 * again: they will just use the cached children. So if you want to show an
6149
 * element, be sure to call show() on the element before its parent tree is
6150
 * rendered for the first time, as it will have no effect on subsequent
6151
 * renderings of the parent tree.
6152
 *
6153
 * @param $element
6154
 *   The element to be shown.
6155
 *
6156
 * @return
6157
 *   The element.
6158
 *
6159
 * @see render()
6160
 * @see hide()
6161
 */
6162
function show(&$element) {
6163
  $element['#printed'] = FALSE;
6164
  return $element;
6165
}
6166

    
6167
/**
6168
 * Gets the rendered output of a renderable element from the cache.
6169
 *
6170
 * @param $elements
6171
 *   A renderable array.
6172
 *
6173
 * @return
6174
 *   A markup string containing the rendered content of the element, or FALSE
6175
 *   if no cached copy of the element is available.
6176
 *
6177
 * @see drupal_render()
6178
 * @see drupal_render_cache_set()
6179
 */
6180
function drupal_render_cache_get($elements) {
6181
  if (!in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD')) || !$cid = drupal_render_cid_create($elements)) {
6182
    return FALSE;
6183
  }
6184
  $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
6185

    
6186
  if (!empty($cid) && $cache = cache_get($cid, $bin)) {
6187
    // Add additional libraries, JavaScript, CSS and other data attached
6188
    // to this element.
6189
    if (isset($cache->data['#attached'])) {
6190
      drupal_process_attached($cache->data);
6191
    }
6192
    // Return the rendered output.
6193
    return $cache->data['#markup'];
6194
  }
6195
  return FALSE;
6196
}
6197

    
6198
/**
6199
 * Caches the rendered output of a renderable element.
6200
 *
6201
 * This is called by drupal_render() if the #cache property is set on an
6202
 * element.
6203
 *
6204
 * @param $markup
6205
 *   The rendered output string of $elements.
6206
 * @param $elements
6207
 *   A renderable array.
6208
 *
6209
 * @see drupal_render_cache_get()
6210
 */
6211
function drupal_render_cache_set(&$markup, $elements) {
6212
  // Create the cache ID for the element.
6213
  if (!in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD')) || !$cid = drupal_render_cid_create($elements)) {
6214
    return FALSE;
6215
  }
6216

    
6217
  // Cache implementations are allowed to modify the markup, to support
6218
  // replacing markup with edge-side include commands. The supporting cache
6219
  // backend will store the markup in some other key (like
6220
  // $data['#real-value']) and return an include command instead. When the
6221
  // ESI command is executed by the content accelerator, the real value can
6222
  // be retrieved and used.
6223
  $data['#markup'] = &$markup;
6224
  // Persist attached data associated with this element.
6225
  $attached = drupal_render_collect_attached($elements, TRUE);
6226
  if ($attached) {
6227
    $data['#attached'] = $attached;
6228
  }
6229
  $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
6230
  $expire = isset($elements['#cache']['expire']) ? $elements['#cache']['expire'] : CACHE_PERMANENT;
6231
  cache_set($cid, $data, $bin, $expire);
6232
}
6233

    
6234
/**
6235
 * Collects #attached for an element and its children into a single array.
6236
 *
6237
 * When caching elements, it is necessary to collect all libraries, JavaScript
6238
 * and CSS into a single array, from both the element itself and all child
6239
 * elements. This allows drupal_render() to add these back to the page when the
6240
 * element is returned from cache.
6241
 *
6242
 * @param $elements
6243
 *   The element to collect #attached from.
6244
 * @param $return
6245
 *   Whether to return the attached elements and reset the internal static.
6246
 *
6247
 * @return
6248
 *   The #attached array for this element and its descendants.
6249
 */
6250
function drupal_render_collect_attached($elements, $return = FALSE) {
6251
  $attached = &drupal_static(__FUNCTION__, array());
6252

    
6253
  // Collect all #attached for this element.
6254
  if (isset($elements['#attached'])) {
6255
    foreach ($elements['#attached'] as $key => $value) {
6256
      if (!isset($attached[$key])) {
6257
        $attached[$key] = array();
6258
      }
6259
      $attached[$key] = array_merge($attached[$key], $value);
6260
    }
6261
  }
6262
  if ($children = element_children($elements)) {
6263
    foreach ($children as $child) {
6264
      drupal_render_collect_attached($elements[$child]);
6265
    }
6266
  }
6267

    
6268
  // If this was the first call to the function, return all attached elements
6269
  // and reset the static cache.
6270
  if ($return) {
6271
    $return = $attached;
6272
    $attached = array();
6273
    return $return;
6274
  }
6275
}
6276

    
6277
/**
6278
 * Prepares an element for caching based on a query.
6279
 *
6280
 * This smart caching strategy saves Drupal from querying and rendering to HTML
6281
 * when the underlying query is unchanged.
6282
 *
6283
 * Expensive queries should use the query builder to create the query and then
6284
 * call this function. Executing the query and formatting results should happen
6285
 * in a #pre_render callback.
6286
 *
6287
 * @param $query
6288
 *   A select query object as returned by db_select().
6289
 * @param $function
6290
 *   The name of the function doing this caching. A _pre_render suffix will be
6291
 *   added to this string and is also part of the cache key in
6292
 *   drupal_render_cache_set() and drupal_render_cache_get().
6293
 * @param $expire
6294
 *   The cache expire time, passed eventually to cache_set().
6295
 * @param $granularity
6296
 *   One or more granularity constants passed to drupal_render_cid_parts().
6297
 *
6298
 * @return
6299
 *   A renderable array with the following keys and values:
6300
 *   - #query: The passed-in $query.
6301
 *   - #pre_render: $function with a _pre_render suffix.
6302
 *   - #cache: An associative array prepared for drupal_render_cache_set().
6303
 */
6304
function drupal_render_cache_by_query($query, $function, $expire = CACHE_TEMPORARY, $granularity = NULL) {
6305
  $cache_keys = array_merge(array($function), drupal_render_cid_parts($granularity));
6306
  $query->preExecute();
6307
  $cache_keys[] = hash('sha256', serialize(array((string) $query, $query->getArguments())));
6308
  return array(
6309
    '#query' => $query,
6310
    '#pre_render' => array($function . '_pre_render'),
6311
    '#cache' => array(
6312
      'keys' => $cache_keys,
6313
      'expire' => $expire,
6314
    ),
6315
  );
6316
}
6317

    
6318
/**
6319
 * Returns cache ID parts for building a cache ID.
6320
 *
6321
 * @param $granularity
6322
 *   One or more cache granularity constants. For example, to cache separately
6323
 *   for each user, use DRUPAL_CACHE_PER_USER. To cache separately for each
6324
 *   page and role, use the expression:
6325
 *   @code
6326
 *   DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE
6327
 *   @endcode
6328
 *
6329
 * @return
6330
 *   An array of cache ID parts, always containing the active theme. If the
6331
 *   locale module is enabled it also contains the active language. If
6332
 *   $granularity was passed in, more parts are added.
6333
 */
6334
function drupal_render_cid_parts($granularity = NULL) {
6335
  global $theme, $base_root, $user;
6336

    
6337
  $cid_parts[] = $theme;
6338
  // If Locale is enabled but we have only one language we do not need it as cid
6339
  // part.
6340
  if (drupal_multilingual()) {
6341
    foreach (language_types_configurable() as $language_type) {
6342
      $cid_parts[] = $GLOBALS[$language_type]->language;
6343
    }
6344
  }
6345

    
6346
  if (!empty($granularity)) {
6347
    $cache_per_role = $granularity & DRUPAL_CACHE_PER_ROLE;
6348
    $cache_per_user = $granularity & DRUPAL_CACHE_PER_USER;
6349
    // User 1 has special permissions outside of the role system, so when
6350
    // caching per role is requested, it should cache per user instead.
6351
    if ($user->uid == 1 && $cache_per_role) {
6352
      $cache_per_user = TRUE;
6353
      $cache_per_role = FALSE;
6354
    }
6355
    // 'PER_ROLE' and 'PER_USER' are mutually exclusive. 'PER_USER' can be a
6356
    // resource drag for sites with many users, so when a module is being
6357
    // equivocal, we favor the less expensive 'PER_ROLE' pattern.
6358
    if ($cache_per_role) {
6359
      $cid_parts[] = 'r.' . implode(',', array_keys($user->roles));
6360
    }
6361
    elseif ($cache_per_user) {
6362
      $cid_parts[] = "u.$user->uid";
6363
    }
6364

    
6365
    if ($granularity & DRUPAL_CACHE_PER_PAGE) {
6366
      $cid_parts[] = $base_root . request_uri();
6367
    }
6368
  }
6369

    
6370
  return $cid_parts;
6371
}
6372

    
6373
/**
6374
 * Creates the cache ID for a renderable element.
6375
 *
6376
 * This creates the cache ID string, either by returning the #cache['cid']
6377
 * property if present or by building the cache ID out of the #cache['keys']
6378
 * and, optionally, the #cache['granularity'] properties.
6379
 *
6380
 * @param $elements
6381
 *   A renderable array.
6382
 *
6383
 * @return
6384
 *   The cache ID string, or FALSE if the element may not be cached.
6385
 */
6386
function drupal_render_cid_create($elements) {
6387
  if (isset($elements['#cache']['cid'])) {
6388
    return $elements['#cache']['cid'];
6389
  }
6390
  elseif (isset($elements['#cache']['keys'])) {
6391
    $granularity = isset($elements['#cache']['granularity']) ? $elements['#cache']['granularity'] : NULL;
6392
    // Merge in additional cache ID parts based provided by drupal_render_cid_parts().
6393
    $cid_parts = array_merge($elements['#cache']['keys'], drupal_render_cid_parts($granularity));
6394
    return implode(':', $cid_parts);
6395
  }
6396
  return FALSE;
6397
}
6398

    
6399
/**
6400
 * Function used by uasort to sort structured arrays by weight.
6401
 */
6402
function element_sort($a, $b) {
6403
  $a_weight = (is_array($a) && isset($a['#weight'])) ? $a['#weight'] : 0;
6404
  $b_weight = (is_array($b) && isset($b['#weight'])) ? $b['#weight'] : 0;
6405
  if ($a_weight == $b_weight) {
6406
    return 0;
6407
  }
6408
  return ($a_weight < $b_weight) ? -1 : 1;
6409
}
6410

    
6411
/**
6412
 * Array sorting callback; sorts elements by title.
6413
 */
6414
function element_sort_by_title($a, $b) {
6415
  $a_title = (is_array($a) && isset($a['#title'])) ? $a['#title'] : '';
6416
  $b_title = (is_array($b) && isset($b['#title'])) ? $b['#title'] : '';
6417
  return strnatcasecmp($a_title, $b_title);
6418
}
6419

    
6420
/**
6421
 * Retrieves the default properties for the defined element type.
6422
 *
6423
 * @param $type
6424
 *   An element type as defined by hook_element_info().
6425
 */
6426
function element_info($type) {
6427
  // Use the advanced drupal_static() pattern, since this is called very often.
6428
  static $drupal_static_fast;
6429
  if (!isset($drupal_static_fast)) {
6430
    $drupal_static_fast['cache'] = &drupal_static(__FUNCTION__);
6431
  }
6432
  $cache = &$drupal_static_fast['cache'];
6433

    
6434
  if (!isset($cache)) {
6435
    $cache = module_invoke_all('element_info');
6436
    foreach ($cache as $element_type => $info) {
6437
      $cache[$element_type]['#type'] = $element_type;
6438
    }
6439
    // Allow modules to alter the element type defaults.
6440
    drupal_alter('element_info', $cache);
6441
  }
6442

    
6443
  return isset($cache[$type]) ? $cache[$type] : array();
6444
}
6445

    
6446
/**
6447
 * Retrieves a single property for the defined element type.
6448
 *
6449
 * @param $type
6450
 *   An element type as defined by hook_element_info().
6451
 * @param $property_name
6452
 *   The property within the element type that should be returned.
6453
 * @param $default
6454
 *   (Optional) The value to return if the element type does not specify a
6455
 *   value for the property. Defaults to NULL.
6456
 */
6457
function element_info_property($type, $property_name, $default = NULL) {
6458
  return (($info = element_info($type)) && array_key_exists($property_name, $info)) ? $info[$property_name] : $default;
6459
}
6460

    
6461
/**
6462
 * Sorts a structured array by the 'weight' element.
6463
 *
6464
 * Note that the sorting is by the 'weight' array element, not by the render
6465
 * element property '#weight'.
6466
 *
6467
 * Callback for uasort() used in various functions.
6468
 *
6469
 * @param $a
6470
 *   First item for comparison. The compared items should be associative arrays
6471
 *   that optionally include a 'weight' element. For items without a 'weight'
6472
 *   element, a default value of 0 will be used.
6473
 * @param $b
6474
 *   Second item for comparison.
6475
 */
6476
function drupal_sort_weight($a, $b) {
6477
  $a_weight = (is_array($a) && isset($a['weight'])) ? $a['weight'] : 0;
6478
  $b_weight = (is_array($b) && isset($b['weight'])) ? $b['weight'] : 0;
6479
  if ($a_weight == $b_weight) {
6480
    return 0;
6481
  }
6482
  return ($a_weight < $b_weight) ? -1 : 1;
6483
}
6484

    
6485
/**
6486
 * Array sorting callback; sorts elements by 'title' key.
6487
 */
6488
function drupal_sort_title($a, $b) {
6489
  if (!isset($b['title'])) {
6490
    return -1;
6491
  }
6492
  if (!isset($a['title'])) {
6493
    return 1;
6494
  }
6495
  return strcasecmp($a['title'], $b['title']);
6496
}
6497

    
6498
/**
6499
 * Checks if the key is a property.
6500
 */
6501
function element_property($key) {
6502
  return $key[0] == '#';
6503
}
6504

    
6505
/**
6506
 * Gets properties of a structured array element (keys beginning with '#').
6507
 */
6508
function element_properties($element) {
6509
  return array_filter(array_keys((array) $element), 'element_property');
6510
}
6511

    
6512
/**
6513
 * Checks if the key is a child.
6514
 */
6515
function element_child($key) {
6516
  return !isset($key[0]) || $key[0] != '#';
6517
}
6518

    
6519
/**
6520
 * Identifies the children of an element array, optionally sorted by weight.
6521
 *
6522
 * The children of a element array are those key/value pairs whose key does
6523
 * not start with a '#'. See drupal_render() for details.
6524
 *
6525
 * @param $elements
6526
 *   The element array whose children are to be identified.
6527
 * @param $sort
6528
 *   Boolean to indicate whether the children should be sorted by weight.
6529
 *
6530
 * @return
6531
 *   The array keys of the element's children.
6532
 */
6533
function element_children(&$elements, $sort = FALSE) {
6534
  // Do not attempt to sort elements which have already been sorted.
6535
  $sort = isset($elements['#sorted']) ? !$elements['#sorted'] : $sort;
6536

    
6537
  // Filter out properties from the element, leaving only children.
6538
  $children = array();
6539
  $sortable = FALSE;
6540
  foreach ($elements as $key => $value) {
6541
    if ($key === '' || $key[0] !== '#') {
6542
      $children[$key] = $value;
6543
      if (is_array($value) && isset($value['#weight'])) {
6544
        $sortable = TRUE;
6545
      }
6546
    }
6547
  }
6548
  // Sort the children if necessary.
6549
  if ($sort && $sortable) {
6550
    uasort($children, 'element_sort');
6551
    // Put the sorted children back into $elements in the correct order, to
6552
    // preserve sorting if the same element is passed through
6553
    // element_children() twice.
6554
    foreach ($children as $key => $child) {
6555
      unset($elements[$key]);
6556
      $elements[$key] = $child;
6557
    }
6558
    $elements['#sorted'] = TRUE;
6559
  }
6560

    
6561
  return array_keys($children);
6562
}
6563

    
6564
/**
6565
 * Returns the visible children of an element.
6566
 *
6567
 * @param $elements
6568
 *   The parent element.
6569
 *
6570
 * @return
6571
 *   The array keys of the element's visible children.
6572
 */
6573
function element_get_visible_children(array $elements) {
6574
  $visible_children = array();
6575

    
6576
  foreach (element_children($elements) as $key) {
6577
    $child = $elements[$key];
6578

    
6579
    // Skip un-accessible children.
6580
    if (isset($child['#access']) && !$child['#access']) {
6581
      continue;
6582
    }
6583

    
6584
    // Skip value and hidden elements, since they are not rendered.
6585
    if (isset($child['#type']) && in_array($child['#type'], array('value', 'hidden'))) {
6586
      continue;
6587
    }
6588

    
6589
    $visible_children[$key] = $child;
6590
  }
6591

    
6592
  return array_keys($visible_children);
6593
}
6594

    
6595
/**
6596
 * Sets HTML attributes based on element properties.
6597
 *
6598
 * @param $element
6599
 *   The renderable element to process.
6600
 * @param $map
6601
 *   An associative array whose keys are element property names and whose values
6602
 *   are the HTML attribute names to set for corresponding the property; e.g.,
6603
 *   array('#propertyname' => 'attributename'). If both names are identical
6604
 *   except for the leading '#', then an attribute name value is sufficient and
6605
 *   no property name needs to be specified.
6606
 */
6607
function element_set_attributes(array &$element, array $map) {
6608
  foreach ($map as $property => $attribute) {
6609
    // If the key is numeric, the attribute name needs to be taken over.
6610
    if (is_int($property)) {
6611
      $property = '#' . $attribute;
6612
    }
6613
    // Do not overwrite already existing attributes.
6614
    if (isset($element[$property]) && !isset($element['#attributes'][$attribute])) {
6615
      $element['#attributes'][$attribute] = $element[$property];
6616
    }
6617
  }
6618
}
6619

    
6620
/**
6621
 * Recursively computes the difference of arrays with additional index check.
6622
 *
6623
 * This is a version of array_diff_assoc() that supports multidimensional
6624
 * arrays.
6625
 *
6626
 * @param array $array1
6627
 *   The array to compare from.
6628
 * @param array $array2
6629
 *   The array to compare to.
6630
 *
6631
 * @return array
6632
 *   Returns an array containing all the values from array1 that are not present
6633
 *   in array2.
6634
 */
6635
function drupal_array_diff_assoc_recursive($array1, $array2) {
6636
  $difference = array();
6637

    
6638
  foreach ($array1 as $key => $value) {
6639
    if (is_array($value)) {
6640
      if (!array_key_exists($key, $array2) || !is_array($array2[$key])) {
6641
        $difference[$key] = $value;
6642
      }
6643
      else {
6644
        $new_diff = drupal_array_diff_assoc_recursive($value, $array2[$key]);
6645
        if (!empty($new_diff)) {
6646
          $difference[$key] = $new_diff;
6647
        }
6648
      }
6649
    }
6650
    elseif (!array_key_exists($key, $array2) || $array2[$key] !== $value) {
6651
      $difference[$key] = $value;
6652
    }
6653
  }
6654

    
6655
  return $difference;
6656
}
6657

    
6658
/**
6659
 * Sets a value in a nested array with variable depth.
6660
 *
6661
 * This helper function should be used when the depth of the array element you
6662
 * are changing may vary (that is, the number of parent keys is variable). It
6663
 * is primarily used for form structures and renderable arrays.
6664
 *
6665
 * Example:
6666
 * @code
6667
 * // Assume you have a 'signature' element somewhere in a form. It might be:
6668
 * $form['signature_settings']['signature'] = array(
6669
 *   '#type' => 'text_format',
6670
 *   '#title' => t('Signature'),
6671
 * );
6672
 * // Or, it might be further nested:
6673
 * $form['signature_settings']['user']['signature'] = array(
6674
 *   '#type' => 'text_format',
6675
 *   '#title' => t('Signature'),
6676
 * );
6677
 * @endcode
6678
 *
6679
 * To deal with the situation, the code needs to figure out the route to the
6680
 * element, given an array of parents that is either
6681
 * @code array('signature_settings', 'signature') @endcode in the first case or
6682
 * @code array('signature_settings', 'user', 'signature') @endcode in the second
6683
 * case.
6684
 *
6685
 * Without this helper function the only way to set the signature element in one
6686
 * line would be using eval(), which should be avoided:
6687
 * @code
6688
 * // Do not do this! Avoid eval().
6689
 * eval('$form[\'' . implode("']['", $parents) . '\'] = $element;');
6690
 * @endcode
6691
 *
6692
 * Instead, use this helper function:
6693
 * @code
6694
 * drupal_array_set_nested_value($form, $parents, $element);
6695
 * @endcode
6696
 *
6697
 * However if the number of array parent keys is static, the value should always
6698
 * be set directly rather than calling this function. For instance, for the
6699
 * first example we could just do:
6700
 * @code
6701
 * $form['signature_settings']['signature'] = $element;
6702
 * @endcode
6703
 *
6704
 * @param $array
6705
 *   A reference to the array to modify.
6706
 * @param $parents
6707
 *   An array of parent keys, starting with the outermost key.
6708
 * @param $value
6709
 *   The value to set.
6710
 * @param $force
6711
 *   (Optional) If TRUE, the value is forced into the structure even if it
6712
 *   requires the deletion of an already existing non-array parent value. If
6713
 *   FALSE, PHP throws an error if trying to add into a value that is not an
6714
 *   array. Defaults to FALSE.
6715
 *
6716
 * @see drupal_array_get_nested_value()
6717
 */
6718
function drupal_array_set_nested_value(array &$array, array $parents, $value, $force = FALSE) {
6719
  $ref = &$array;
6720
  foreach ($parents as $parent) {
6721
    // PHP auto-creates container arrays and NULL entries without error if $ref
6722
    // is NULL, but throws an error if $ref is set, but not an array.
6723
    if ($force && isset($ref) && !is_array($ref)) {
6724
      $ref = array();
6725
    }
6726
    $ref = &$ref[$parent];
6727
  }
6728
  $ref = $value;
6729
}
6730

    
6731
/**
6732
 * Retrieves a value from a nested array with variable depth.
6733
 *
6734
 * This helper function should be used when the depth of the array element being
6735
 * retrieved may vary (that is, the number of parent keys is variable). It is
6736
 * primarily used for form structures and renderable arrays.
6737
 *
6738
 * Without this helper function the only way to get a nested array value with
6739
 * variable depth in one line would be using eval(), which should be avoided:
6740
 * @code
6741
 * // Do not do this! Avoid eval().
6742
 * // May also throw a PHP notice, if the variable array keys do not exist.
6743
 * eval('$value = $array[\'' . implode("']['", $parents) . "'];");
6744
 * @endcode
6745
 *
6746
 * Instead, use this helper function:
6747
 * @code
6748
 * $value = drupal_array_get_nested_value($form, $parents);
6749
 * @endcode
6750
 *
6751
 * A return value of NULL is ambiguous, and can mean either that the requested
6752
 * key does not exist, or that the actual value is NULL. If it is required to
6753
 * know whether the nested array key actually exists, pass a third argument that
6754
 * is altered by reference:
6755
 * @code
6756
 * $key_exists = NULL;
6757
 * $value = drupal_array_get_nested_value($form, $parents, $key_exists);
6758
 * if ($key_exists) {
6759
 *   // ... do something with $value ...
6760
 * }
6761
 * @endcode
6762
 *
6763
 * However if the number of array parent keys is static, the value should always
6764
 * be retrieved directly rather than calling this function. For instance:
6765
 * @code
6766
 * $value = $form['signature_settings']['signature'];
6767
 * @endcode
6768
 *
6769
 * @param $array
6770
 *   The array from which to get the value.
6771
 * @param $parents
6772
 *   An array of parent keys of the value, starting with the outermost key.
6773
 * @param $key_exists
6774
 *   (optional) If given, an already defined variable that is altered by
6775
 *   reference.
6776
 *
6777
 * @return
6778
 *   The requested nested value. Possibly NULL if the value is NULL or not all
6779
 *   nested parent keys exist. $key_exists is altered by reference and is a
6780
 *   Boolean that indicates whether all nested parent keys exist (TRUE) or not
6781
 *   (FALSE). This allows to distinguish between the two possibilities when NULL
6782
 *   is returned.
6783
 *
6784
 * @see drupal_array_set_nested_value()
6785
 */
6786
function &drupal_array_get_nested_value(array &$array, array $parents, &$key_exists = NULL) {
6787
  $ref = &$array;
6788
  foreach ($parents as $parent) {
6789
    if (is_array($ref) && array_key_exists($parent, $ref)) {
6790
      $ref = &$ref[$parent];
6791
    }
6792
    else {
6793
      $key_exists = FALSE;
6794
      $null = NULL;
6795
      return $null;
6796
    }
6797
  }
6798
  $key_exists = TRUE;
6799
  return $ref;
6800
}
6801

    
6802
/**
6803
 * Determines whether a nested array contains the requested keys.
6804
 *
6805
 * This helper function should be used when the depth of the array element to be
6806
 * checked may vary (that is, the number of parent keys is variable). See
6807
 * drupal_array_set_nested_value() for details. It is primarily used for form
6808
 * structures and renderable arrays.
6809
 *
6810
 * If it is required to also get the value of the checked nested key, use
6811
 * drupal_array_get_nested_value() instead.
6812
 *
6813
 * If the number of array parent keys is static, this helper function is
6814
 * unnecessary and the following code can be used instead:
6815
 * @code
6816
 * $value_exists = isset($form['signature_settings']['signature']);
6817
 * $key_exists = array_key_exists('signature', $form['signature_settings']);
6818
 * @endcode
6819
 *
6820
 * @param $array
6821
 *   The array with the value to check for.
6822
 * @param $parents
6823
 *   An array of parent keys of the value, starting with the outermost key.
6824
 *
6825
 * @return
6826
 *   TRUE if all the parent keys exist, FALSE otherwise.
6827
 *
6828
 * @see drupal_array_get_nested_value()
6829
 */
6830
function drupal_array_nested_key_exists(array $array, array $parents) {
6831
  // Although this function is similar to PHP's array_key_exists(), its
6832
  // arguments should be consistent with drupal_array_get_nested_value().
6833
  $key_exists = NULL;
6834
  drupal_array_get_nested_value($array, $parents, $key_exists);
6835
  return $key_exists;
6836
}
6837

    
6838
/**
6839
 * Provides theme registration for themes across .inc files.
6840
 */
6841
function drupal_common_theme() {
6842
  return array(
6843
    // From theme.inc.
6844
    'html' => array(
6845
      'render element' => 'page',
6846
      'template' => 'html',
6847
    ),
6848
    'page' => array(
6849
      'render element' => 'page',
6850
      'template' => 'page',
6851
    ),
6852
    'region' => array(
6853
      'render element' => 'elements',
6854
      'template' => 'region',
6855
    ),
6856
    'status_messages' => array(
6857
      'variables' => array('display' => NULL),
6858
    ),
6859
    'link' => array(
6860
      'variables' => array('text' => NULL, 'path' => NULL, 'options' => array()),
6861
    ),
6862
    'links' => array(
6863
      'variables' => array('links' => NULL, 'attributes' => array('class' => array('links')), 'heading' => array()),
6864
    ),
6865
    'image' => array(
6866
      // HTML 4 and XHTML 1.0 always require an alt attribute. The HTML 5 draft
6867
      // allows the alt attribute to be omitted in some cases. Therefore,
6868
      // default the alt attribute to an empty string, but allow code calling
6869
      // theme('image') to pass explicit NULL for it to be omitted. Usually,
6870
      // neither omission nor an empty string satisfies accessibility
6871
      // requirements, so it is strongly encouraged for code calling
6872
      // theme('image') to pass a meaningful value for the alt variable.
6873
      // - http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
6874
      // - http://www.w3.org/TR/xhtml1/dtds.html
6875
      // - http://dev.w3.org/html5/spec/Overview.html#alt
6876
      // The title attribute is optional in all cases, so it is omitted by
6877
      // default.
6878
      'variables' => array('path' => NULL, 'width' => NULL, 'height' => NULL, 'alt' => '', 'title' => NULL, 'attributes' => array()),
6879
    ),
6880
    'breadcrumb' => array(
6881
      'variables' => array('breadcrumb' => NULL),
6882
    ),
6883
    'help' => array(
6884
      'variables' => array(),
6885
    ),
6886
    'table' => array(
6887
      'variables' => array('header' => NULL, 'rows' => NULL, 'attributes' => array(), 'caption' => NULL, 'colgroups' => array(), 'sticky' => TRUE, 'empty' => ''),
6888
    ),
6889
    'tablesort_indicator' => array(
6890
      'variables' => array('style' => NULL),
6891
    ),
6892
    'mark' => array(
6893
      'variables' => array('type' => MARK_NEW),
6894
    ),
6895
    'item_list' => array(
6896
      'variables' => array('items' => array(), 'title' => NULL, 'type' => 'ul', 'attributes' => array()),
6897
    ),
6898
    'more_help_link' => array(
6899
      'variables' => array('url' => NULL),
6900
    ),
6901
    'feed_icon' => array(
6902
      'variables' => array('url' => NULL, 'title' => NULL),
6903
    ),
6904
    'more_link' => array(
6905
      'variables' => array('url' => NULL, 'title' => NULL)
6906
    ),
6907
    'username' => array(
6908
      'variables' => array('account' => NULL),
6909
    ),
6910
    'progress_bar' => array(
6911
      'variables' => array('percent' => NULL, 'message' => NULL),
6912
    ),
6913
    'indentation' => array(
6914
      'variables' => array('size' => 1),
6915
    ),
6916
    'html_tag' => array(
6917
      'render element' => 'element',
6918
    ),
6919
    // From theme.maintenance.inc.
6920
    'maintenance_page' => array(
6921
      'variables' => array('content' => NULL, 'show_messages' => TRUE),
6922
      'template' => 'maintenance-page',
6923
    ),
6924
    'update_page' => array(
6925
      'variables' => array('content' => NULL, 'show_messages' => TRUE),
6926
    ),
6927
    'install_page' => array(
6928
      'variables' => array('content' => NULL),
6929
    ),
6930
    'task_list' => array(
6931
      'variables' => array('items' => NULL, 'active' => NULL),
6932
    ),
6933
    'authorize_message' => array(
6934
      'variables' => array('message' => NULL, 'success' => TRUE),
6935
    ),
6936
    'authorize_report' => array(
6937
      'variables' => array('messages' => array()),
6938
    ),
6939
    // From pager.inc.
6940
    'pager' => array(
6941
      'variables' => array('tags' => array(), 'element' => 0, 'parameters' => array(), 'quantity' => 9),
6942
    ),
6943
    'pager_first' => array(
6944
      'variables' => array('text' => NULL, 'element' => 0, 'parameters' => array()),
6945
    ),
6946
    'pager_previous' => array(
6947
      'variables' => array('text' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
6948
    ),
6949
    'pager_next' => array(
6950
      'variables' => array('text' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
6951
    ),
6952
    'pager_last' => array(
6953
      'variables' => array('text' => NULL, 'element' => 0, 'parameters' => array()),
6954
    ),
6955
    'pager_link' => array(
6956
      'variables' => array('text' => NULL, 'page_new' => NULL, 'element' => NULL, 'parameters' => array(), 'attributes' => array()),
6957
    ),
6958
    // From menu.inc.
6959
    'menu_link' => array(
6960
      'render element' => 'element',
6961
    ),
6962
    'menu_tree' => array(
6963
      'render element' => 'tree',
6964
    ),
6965
    'menu_local_task' => array(
6966
      'render element' => 'element',
6967
    ),
6968
    'menu_local_action' => array(
6969
      'render element' => 'element',
6970
    ),
6971
    'menu_local_tasks' => array(
6972
      'variables' => array('primary' => array(), 'secondary' => array()),
6973
    ),
6974
    // From form.inc.
6975
    'select' => array(
6976
      'render element' => 'element',
6977
    ),
6978
    'fieldset' => array(
6979
      'render element' => 'element',
6980
    ),
6981
    'radio' => array(
6982
      'render element' => 'element',
6983
    ),
6984
    'radios' => array(
6985
      'render element' => 'element',
6986
    ),
6987
    'date' => array(
6988
      'render element' => 'element',
6989
    ),
6990
    'exposed_filters' => array(
6991
      'render element' => 'form',
6992
    ),
6993
    'checkbox' => array(
6994
      'render element' => 'element',
6995
    ),
6996
    'checkboxes' => array(
6997
      'render element' => 'element',
6998
    ),
6999
    'button' => array(
7000
      'render element' => 'element',
7001
    ),
7002
    'image_button' => array(
7003
      'render element' => 'element',
7004
    ),
7005
    'hidden' => array(
7006
      'render element' => 'element',
7007
    ),
7008
    'textfield' => array(
7009
      'render element' => 'element',
7010
    ),
7011
    'form' => array(
7012
      'render element' => 'element',
7013
    ),
7014
    'textarea' => array(
7015
      'render element' => 'element',
7016
    ),
7017
    'password' => array(
7018
      'render element' => 'element',
7019
    ),
7020
    'file' => array(
7021
      'render element' => 'element',
7022
    ),
7023
    'tableselect' => array(
7024
      'render element' => 'element',
7025
    ),
7026
    'form_element' => array(
7027
      'render element' => 'element',
7028
    ),
7029
    'form_required_marker' => array(
7030
      'render element' => 'element',
7031
    ),
7032
    'form_element_label' => array(
7033
      'render element' => 'element',
7034
    ),
7035
    'vertical_tabs' => array(
7036
      'render element' => 'element',
7037
    ),
7038
    'container' => array(
7039
      'render element' => 'element',
7040
    ),
7041
  );
7042
}
7043

    
7044
/**
7045
 * @addtogroup schemaapi
7046
 * @{
7047
 */
7048

    
7049
/**
7050
 * Creates all tables defined in a module's hook_schema().
7051
 *
7052
 * Note: This function does not pass the module's schema through
7053
 * hook_schema_alter(). The module's tables will be created exactly as the
7054
 * module defines them.
7055
 *
7056
 * @param $module
7057
 *   The module for which the tables will be created.
7058
 */
7059
function drupal_install_schema($module) {
7060
  $schema = drupal_get_schema_unprocessed($module);
7061
  _drupal_schema_initialize($schema, $module, FALSE);
7062

    
7063
  foreach ($schema as $name => $table) {
7064
    db_create_table($name, $table);
7065
  }
7066
}
7067

    
7068
/**
7069
 * Removes all tables defined in a module's hook_schema().
7070
 *
7071
 * Note: This function does not pass the module's schema through
7072
 * hook_schema_alter(). The module's tables will be created exactly as the
7073
 * module defines them.
7074
 *
7075
 * @param $module
7076
 *   The module for which the tables will be removed.
7077
 *
7078
 * @return
7079
 *   An array of arrays with the following key/value pairs:
7080
 *    - success: a boolean indicating whether the query succeeded.
7081
 *    - query: the SQL query(s) executed, passed through check_plain().
7082
 */
7083
function drupal_uninstall_schema($module) {
7084
  $schema = drupal_get_schema_unprocessed($module);
7085
  _drupal_schema_initialize($schema, $module, FALSE);
7086

    
7087
  foreach ($schema as $table) {
7088
    if (db_table_exists($table['name'])) {
7089
      db_drop_table($table['name']);
7090
    }
7091
  }
7092
}
7093

    
7094
/**
7095
 * Returns the unprocessed and unaltered version of a module's schema.
7096
 *
7097
 * Use this function only if you explicitly need the original
7098
 * specification of a schema, as it was defined in a module's
7099
 * hook_schema(). No additional default values will be set,
7100
 * hook_schema_alter() is not invoked and these unprocessed
7101
 * definitions won't be cached. To retrieve the schema after
7102
 * hook_schema_alter() has been invoked use drupal_get_schema().
7103
 *
7104
 * This function can be used to retrieve a schema specification in
7105
 * hook_schema(), so it allows you to derive your tables from existing
7106
 * specifications.
7107
 *
7108
 * It is also used by drupal_install_schema() and
7109
 * drupal_uninstall_schema() to ensure that a module's tables are
7110
 * created exactly as specified without any changes introduced by a
7111
 * module that implements hook_schema_alter().
7112
 *
7113
 * @param $module
7114
 *   The module to which the table belongs.
7115
 * @param $table
7116
 *   The name of the table. If not given, the module's complete schema
7117
 *   is returned.
7118
 */
7119
function drupal_get_schema_unprocessed($module, $table = NULL) {
7120
  // Load the .install file to get hook_schema.
7121
  module_load_install($module);
7122
  $schema = module_invoke($module, 'schema');
7123

    
7124
  if (isset($table) && isset($schema[$table])) {
7125
    return $schema[$table];
7126
  }
7127
  elseif (!empty($schema)) {
7128
    return $schema;
7129
  }
7130
  return array();
7131
}
7132

    
7133
/**
7134
 * Fills in required default values for table definitions from hook_schema().
7135
 *
7136
 * @param $schema
7137
 *   The schema definition array as it was returned by the module's
7138
 *   hook_schema().
7139
 * @param $module
7140
 *   The module for which hook_schema() was invoked.
7141
 * @param $remove_descriptions
7142
 *   (optional) Whether to additionally remove 'description' keys of all tables
7143
 *   and fields to improve performance of serialize() and unserialize().
7144
 *   Defaults to TRUE.
7145
 */
7146
function _drupal_schema_initialize(&$schema, $module, $remove_descriptions = TRUE) {
7147
  // Set the name and module key for all tables.
7148
  foreach ($schema as $name => &$table) {
7149
    if (empty($table['module'])) {
7150
      $table['module'] = $module;
7151
    }
7152
    if (!isset($table['name'])) {
7153
      $table['name'] = $name;
7154
    }
7155
    if ($remove_descriptions) {
7156
      unset($table['description']);
7157
      foreach ($table['fields'] as &$field) {
7158
        unset($field['description']);
7159
      }
7160
    }
7161
  }
7162
}
7163

    
7164
/**
7165
 * Retrieves the type for every field in a table schema.
7166
 *
7167
 * @param $table
7168
 *   The name of the table from which to retrieve type information.
7169
 *
7170
 * @return
7171
 *   An array of types, keyed by field name.
7172
 */
7173
function drupal_schema_field_types($table) {
7174
  $table_schema = drupal_get_schema($table);
7175
  $field_types = array();
7176
  foreach ($table_schema['fields'] as $field_name => $field_info) {
7177
    $field_types[$field_name] = isset($field_info['type']) ? $field_info['type'] : NULL;
7178
  }
7179
  return $field_types;
7180
}
7181

    
7182
/**
7183
 * Retrieves a list of fields from a table schema.
7184
 *
7185
 * The returned list is suitable for use in an SQL query.
7186
 *
7187
 * @param $table
7188
 *   The name of the table from which to retrieve fields.
7189
 * @param
7190
 *   An optional prefix to to all fields.
7191
 *
7192
 * @return An array of fields.
7193
 */
7194
function drupal_schema_fields_sql($table, $prefix = NULL) {
7195
  $schema = drupal_get_schema($table);
7196
  $fields = array_keys($schema['fields']);
7197
  if ($prefix) {
7198
    $columns = array();
7199
    foreach ($fields as $field) {
7200
      $columns[] = "$prefix.$field";
7201
    }
7202
    return $columns;
7203
  }
7204
  else {
7205
    return $fields;
7206
  }
7207
}
7208

    
7209
/**
7210
 * Saves (inserts or updates) a record to the database based upon the schema.
7211
 *
7212
 * Do not use drupal_write_record() within hook_update_N() functions, since the
7213
 * database schema cannot be relied upon when a user is running a series of
7214
 * updates. Instead, use db_insert() or db_update() to save the record.
7215
 *
7216
 * @param $table
7217
 *   The name of the table; this must be defined by a hook_schema()
7218
 *   implementation.
7219
 * @param $record
7220
 *   An object or array representing the record to write, passed in by
7221
 *   reference. If inserting a new record, values not provided in $record will
7222
 *   be populated in $record and in the database with the default values from
7223
 *   the schema, as well as a single serial (auto-increment) field (if present).
7224
 *   If updating an existing record, only provided values are updated in the
7225
 *   database, and $record is not modified.
7226
 * @param $primary_keys
7227
 *   To indicate that this is a new record to be inserted, omit this argument.
7228
 *   If this is an update, this argument specifies the primary keys' field
7229
 *   names. If there is only 1 field in the key, you may pass in a string; if
7230
 *   there are multiple fields in the key, pass in an array.
7231
 *
7232
 * @return
7233
 *   If the record insert or update failed, returns FALSE. If it succeeded,
7234
 *   returns SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
7235
 */
7236
function drupal_write_record($table, &$record, $primary_keys = array()) {
7237
  // Standardize $primary_keys to an array.
7238
  if (is_string($primary_keys)) {
7239
    $primary_keys = array($primary_keys);
7240
  }
7241

    
7242
  $schema = drupal_get_schema($table);
7243
  if (empty($schema)) {
7244
    return FALSE;
7245
  }
7246

    
7247
  $object = (object) $record;
7248
  $fields = array();
7249

    
7250
  // Go through the schema to determine fields to write.
7251
  foreach ($schema['fields'] as $field => $info) {
7252
    if ($info['type'] == 'serial') {
7253
      // Skip serial types if we are updating.
7254
      if (!empty($primary_keys)) {
7255
        continue;
7256
      }
7257
      // Track serial field so we can helpfully populate them after the query.
7258
      // NOTE: Each table should come with one serial field only.
7259
      $serial = $field;
7260
    }
7261

    
7262
    // Skip field if it is in $primary_keys as it is unnecessary to update a
7263
    // field to the value it is already set to.
7264
    if (in_array($field, $primary_keys)) {
7265
      continue;
7266
    }
7267

    
7268
    if (!property_exists($object, $field)) {
7269
      // Skip fields that are not provided, default values are already known
7270
      // by the database.
7271
      continue;
7272
    }
7273

    
7274
    // Build array of fields to update or insert.
7275
    if (empty($info['serialize'])) {
7276
      $fields[$field] = $object->$field;
7277
    }
7278
    else {
7279
      $fields[$field] = serialize($object->$field);
7280
    }
7281

    
7282
    // Type cast to proper datatype, except when the value is NULL and the
7283
    // column allows this.
7284
    //
7285
    // MySQL PDO silently casts e.g. FALSE and '' to 0 when inserting the value
7286
    // into an integer column, but PostgreSQL PDO does not. Also type cast NULL
7287
    // when the column does not allow this.
7288
    if (isset($object->$field) || !empty($info['not null'])) {
7289
      if ($info['type'] == 'int' || $info['type'] == 'serial') {
7290
        $fields[$field] = (int) $fields[$field];
7291
      }
7292
      elseif ($info['type'] == 'float') {
7293
        $fields[$field] = (float) $fields[$field];
7294
      }
7295
      else {
7296
        $fields[$field] = (string) $fields[$field];
7297
      }
7298
    }
7299
  }
7300

    
7301
  if (empty($fields)) {
7302
    return;
7303
  }
7304

    
7305
  // Build the SQL.
7306
  if (empty($primary_keys)) {
7307
    // We are doing an insert.
7308
    $options = array('return' => Database::RETURN_INSERT_ID);
7309
    if (isset($serial) && isset($fields[$serial])) {
7310
      // If the serial column has been explicitly set with an ID, then we don't
7311
      // require the database to return the last insert id.
7312
      if ($fields[$serial]) {
7313
        $options['return'] = Database::RETURN_AFFECTED;
7314
      }
7315
      // If a serial column does exist with no value (i.e. 0) then remove it as
7316
      // the database will insert the correct value for us.
7317
      else {
7318
        unset($fields[$serial]);
7319
      }
7320
    }
7321
    $query = db_insert($table, $options)->fields($fields);
7322
    $return = SAVED_NEW;
7323
  }
7324
  else {
7325
    $query = db_update($table)->fields($fields);
7326
    foreach ($primary_keys as $key) {
7327
      $query->condition($key, $object->$key);
7328
    }
7329
    $return = SAVED_UPDATED;
7330
  }
7331

    
7332
  // Execute the SQL.
7333
  if ($query_return = $query->execute()) {
7334
    if (isset($serial)) {
7335
      // If the database was not told to return the last insert id, it will be
7336
      // because we already know it.
7337
      if (isset($options) && $options['return'] != Database::RETURN_INSERT_ID) {
7338
        $object->$serial = $fields[$serial];
7339
      }
7340
      else {
7341
        $object->$serial = $query_return;
7342
      }
7343
    }
7344
  }
7345
  // If we have a single-field primary key but got no insert ID, the
7346
  // query failed. Note that we explicitly check for FALSE, because
7347
  // a valid update query which doesn't change any values will return
7348
  // zero (0) affected rows.
7349
  elseif ($query_return === FALSE && count($primary_keys) == 1) {
7350
    $return = FALSE;
7351
  }
7352

    
7353
  // If we are inserting, populate empty fields with default values.
7354
  if (empty($primary_keys)) {
7355
    foreach ($schema['fields'] as $field => $info) {
7356
      if (isset($info['default']) && !property_exists($object, $field)) {
7357
        $object->$field = $info['default'];
7358
      }
7359
    }
7360
  }
7361

    
7362
  // If we began with an array, convert back.
7363
  if (is_array($record)) {
7364
    $record = (array) $object;
7365
  }
7366

    
7367
  return $return;
7368
}
7369

    
7370
/**
7371
 * @} End of "addtogroup schemaapi".
7372
 */
7373

    
7374
/**
7375
 * Parses Drupal module and theme .info files.
7376
 *
7377
 * Info files are NOT for placing arbitrary theme and module-specific settings.
7378
 * Use variable_get() and variable_set() for that.
7379
 *
7380
 * Information stored in a module .info file:
7381
 * - name: The real name of the module for display purposes.
7382
 * - description: A brief description of the module.
7383
 * - dependencies: An array of dependency strings. Each is in the form
7384
 *   'project:module (versions)'; with the following meanings:
7385
 *   - project: (optional) Project shortname, recommended to ensure uniqueness,
7386
 *     if the module is part of a project hosted on drupal.org. If omitted,
7387
 *     also omit the : that follows. The project name is currently ignored by
7388
 *     Drupal core but is used for automated testing.
7389
 *   - module: (required) Module shortname within the project.
7390
 *   - (versions): Optional version information, consisting of one or more
7391
 *     comma-separated operator/value pairs or simply version numbers, which
7392
 *     can contain "x" as a wildcard. Examples: (>=7.22, <7.28), (7.x-3.x).
7393
 * - package: The name of the package of modules this module belongs to.
7394
 *
7395
 * See forum.info for an example of a module .info file.
7396
 *
7397
 * Information stored in a theme .info file:
7398
 * - name: The real name of the theme for display purposes.
7399
 * - description: Brief description.
7400
 * - screenshot: Path to screenshot relative to the theme's .info file.
7401
 * - engine: Theme engine; typically phptemplate.
7402
 * - base: Name of a base theme, if applicable; e.g., base = zen.
7403
 * - regions: Listed regions; e.g., region[left] = Left sidebar.
7404
 * - features: Features available; e.g., features[] = logo.
7405
 * - stylesheets: Theme stylesheets; e.g., stylesheets[all][] = my-style.css.
7406
 * - scripts: Theme scripts; e.g., scripts[] = my-script.js.
7407
 *
7408
 * See bartik.info for an example of a theme .info file.
7409
 *
7410
 * @param $filename
7411
 *   The file we are parsing. Accepts file with relative or absolute path.
7412
 *
7413
 * @return
7414
 *   The info array.
7415
 *
7416
 * @see drupal_parse_info_format()
7417
 */
7418
function drupal_parse_info_file($filename) {
7419
  $info = &drupal_static(__FUNCTION__, array());
7420

    
7421
  if (!isset($info[$filename])) {
7422
    if (!file_exists($filename)) {
7423
      $info[$filename] = array();
7424
    }
7425
    else {
7426
      $data = file_get_contents($filename);
7427
      $info[$filename] = drupal_parse_info_format($data);
7428
    }
7429
  }
7430
  return $info[$filename];
7431
}
7432

    
7433
/**
7434
 * Parses data in Drupal's .info format.
7435
 *
7436
 * Data should be in an .ini-like format to specify values. White-space
7437
 * generally doesn't matter, except inside values:
7438
 * @code
7439
 *   key = value
7440
 *   key = "value"
7441
 *   key = 'value'
7442
 *   key = "multi-line
7443
 *   value"
7444
 *   key = 'multi-line
7445
 *   value'
7446
 *   key
7447
 *   =
7448
 *   'value'
7449
 * @endcode
7450
 *
7451
 * Arrays are created using a HTTP GET alike syntax:
7452
 * @code
7453
 *   key[] = "numeric array"
7454
 *   key[index] = "associative array"
7455
 *   key[index][] = "nested numeric array"
7456
 *   key[index][index] = "nested associative array"
7457
 * @endcode
7458
 *
7459
 * PHP constants are substituted in, but only when used as the entire value.
7460
 * Comments should start with a semi-colon at the beginning of a line.
7461
 *
7462
 * @param $data
7463
 *   A string to parse.
7464
 *
7465
 * @return
7466
 *   The info array.
7467
 *
7468
 * @see drupal_parse_info_file()
7469
 */
7470
function drupal_parse_info_format($data) {
7471
  $info = array();
7472

    
7473
  if (preg_match_all('
7474
    @^\s*                           # Start at the beginning of a line, ignoring leading whitespace
7475
    ((?:
7476
      [^=;\[\]]|                    # Key names cannot contain equal signs, semi-colons or square brackets,
7477
      \[[^\[\]]*\]                  # unless they are balanced and not nested
7478
    )+?)
7479
    \s*=\s*                         # Key/value pairs are separated by equal signs (ignoring white-space)
7480
    (?:
7481
      ("(?:[^"]|(?<=\\\\)")*")|     # Double-quoted string, which may contain slash-escaped quotes/slashes
7482
      (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
7483
      ([^\r\n]*?)                   # Non-quoted string
7484
    )\s*$                           # Stop at the next end of a line, ignoring trailing whitespace
7485
    @msx', $data, $matches, PREG_SET_ORDER)) {
7486
    foreach ($matches as $match) {
7487
      // Fetch the key and value string.
7488
      $i = 0;
7489
      foreach (array('key', 'value1', 'value2', 'value3') as $var) {
7490
        $$var = isset($match[++$i]) ? $match[$i] : '';
7491
      }
7492
      $value = stripslashes(substr($value1, 1, -1)) . stripslashes(substr($value2, 1, -1)) . $value3;
7493

    
7494
      // Parse array syntax.
7495
      $keys = preg_split('/\]?\[/', rtrim($key, ']'));
7496
      $last = array_pop($keys);
7497
      $parent = &$info;
7498

    
7499
      // Create nested arrays.
7500
      foreach ($keys as $key) {
7501
        if ($key == '') {
7502
          $key = count($parent);
7503
        }
7504
        if (!isset($parent[$key]) || !is_array($parent[$key])) {
7505
          $parent[$key] = array();
7506
        }
7507
        $parent = &$parent[$key];
7508
      }
7509

    
7510
      // Handle PHP constants.
7511
      if (preg_match('/^\w+$/i', $value) && defined($value)) {
7512
        $value = constant($value);
7513
      }
7514

    
7515
      // Insert actual value.
7516
      if ($last == '') {
7517
        $last = count($parent);
7518
      }
7519
      $parent[$last] = $value;
7520
    }
7521
  }
7522

    
7523
  return $info;
7524
}
7525

    
7526
/**
7527
 * Returns a list of severity levels, as defined in RFC 3164.
7528
 *
7529
 * @return
7530
 *   Array of the possible severity levels for log messages.
7531
 *
7532
 * @see http://www.ietf.org/rfc/rfc3164.txt
7533
 * @see watchdog()
7534
 * @ingroup logging_severity_levels
7535
 */
7536
function watchdog_severity_levels() {
7537
  return array(
7538
    WATCHDOG_EMERGENCY => t('emergency'),
7539
    WATCHDOG_ALERT     => t('alert'),
7540
    WATCHDOG_CRITICAL  => t('critical'),
7541
    WATCHDOG_ERROR     => t('error'),
7542
    WATCHDOG_WARNING   => t('warning'),
7543
    WATCHDOG_NOTICE    => t('notice'),
7544
    WATCHDOG_INFO      => t('info'),
7545
    WATCHDOG_DEBUG     => t('debug'),
7546
  );
7547
}
7548

    
7549

    
7550
/**
7551
 * Explodes a string of tags into an array.
7552
 *
7553
 * @see drupal_implode_tags()
7554
 */
7555
function drupal_explode_tags($tags) {
7556
  // This regexp allows the following types of user input:
7557
  // this, "somecompany, llc", "and ""this"" w,o.rks", foo bar
7558
  $regexp = '%(?:^|,\ *)("(?>[^"]*)(?>""[^"]* )*"|(?: [^",]*))%x';
7559
  preg_match_all($regexp, $tags, $matches);
7560
  $typed_tags = array_unique($matches[1]);
7561

    
7562
  $tags = array();
7563
  foreach ($typed_tags as $tag) {
7564
    // If a user has escaped a term (to demonstrate that it is a group,
7565
    // or includes a comma or quote character), we remove the escape
7566
    // formatting so to save the term into the database as the user intends.
7567
    $tag = trim(str_replace('""', '"', preg_replace('/^"(.*)"$/', '\1', $tag)));
7568
    if ($tag != "") {
7569
      $tags[] = $tag;
7570
    }
7571
  }
7572

    
7573
  return $tags;
7574
}
7575

    
7576
/**
7577
 * Implodes an array of tags into a string.
7578
 *
7579
 * @see drupal_explode_tags()
7580
 */
7581
function drupal_implode_tags($tags) {
7582
  $encoded_tags = array();
7583
  foreach ($tags as $tag) {
7584
    // Commas and quotes in tag names are special cases, so encode them.
7585
    if (strpos($tag, ',') !== FALSE || strpos($tag, '"') !== FALSE) {
7586
      $tag = '"' . str_replace('"', '""', $tag) . '"';
7587
    }
7588

    
7589
    $encoded_tags[] = $tag;
7590
  }
7591
  return implode(', ', $encoded_tags);
7592
}
7593

    
7594
/**
7595
 * Flushes all cached data on the site.
7596
 *
7597
 * Empties cache tables, rebuilds the menu cache and theme registries, and
7598
 * invokes a hook so that other modules' cache data can be cleared as well.
7599
 */
7600
function drupal_flush_all_caches() {
7601
  // Change query-strings on css/js files to enforce reload for all users.
7602
  _drupal_flush_css_js();
7603

    
7604
  registry_rebuild();
7605
  drupal_clear_css_cache();
7606
  drupal_clear_js_cache();
7607

    
7608
  // Rebuild the theme data. Note that the module data is rebuilt above, as
7609
  // part of registry_rebuild().
7610
  system_rebuild_theme_data();
7611
  drupal_theme_rebuild();
7612

    
7613
  entity_info_cache_clear();
7614
  node_types_rebuild();
7615
  // node_menu() defines menu items based on node types so it needs to come
7616
  // after node types are rebuilt.
7617
  menu_rebuild();
7618

    
7619
  // Synchronize to catch any actions that were added or removed.
7620
  actions_synchronize();
7621

    
7622
  // Don't clear cache_form - in-progress form submissions may break.
7623
  // Ordered so clearing the page cache will always be the last action.
7624
  $core = array('cache', 'cache_path', 'cache_filter', 'cache_bootstrap', 'cache_page');
7625
  $cache_tables = array_merge(module_invoke_all('flush_caches'), $core);
7626
  foreach ($cache_tables as $table) {
7627
    cache_clear_all('*', $table, TRUE);
7628
  }
7629

    
7630
  // Rebuild the bootstrap module list. We do this here so that developers
7631
  // can get new hook_boot() implementations registered without having to
7632
  // write a hook_update_N() function.
7633
  _system_update_bootstrap_status();
7634
}
7635

    
7636
/**
7637
 * Changes the dummy query string added to all CSS and JavaScript files.
7638
 *
7639
 * Changing the dummy query string appended to CSS and JavaScript files forces
7640
 * all browsers to reload fresh files.
7641
 */
7642
function _drupal_flush_css_js() {
7643
  // The timestamp is converted to base 36 in order to make it more compact.
7644
  variable_set('css_js_query_string', base_convert(REQUEST_TIME, 10, 36));
7645
}
7646

    
7647
/**
7648
 * Outputs debug information.
7649
 *
7650
 * The debug information is passed on to trigger_error() after being converted
7651
 * to a string using _drupal_debug_message().
7652
 *
7653
 * @param $data
7654
 *   Data to be output.
7655
 * @param $label
7656
 *   Label to prefix the data.
7657
 * @param $print_r
7658
 *   Flag to switch between print_r() and var_export() for data conversion to
7659
 *   string. Set $print_r to TRUE when dealing with a recursive data structure
7660
 *   as var_export() will generate an error.
7661
 */
7662
function debug($data, $label = NULL, $print_r = FALSE) {
7663
  // Print $data contents to string.
7664
  $string = check_plain($print_r ? print_r($data, TRUE) : var_export($data, TRUE));
7665

    
7666
  // Display values with pre-formatting to increase readability.
7667
  $string = '<pre>' . $string . '</pre>';
7668

    
7669
  trigger_error(trim($label ? "$label: $string" : $string));
7670
}
7671

    
7672
/**
7673
 * Parses a dependency for comparison by drupal_check_incompatibility().
7674
 *
7675
 * @param $dependency
7676
 *   A dependency string, which specifies a module dependency, and optionally
7677
 *   the project it comes from and versions that are supported. Supported
7678
 *   formats include:
7679
 *   - 'module'
7680
 *   - 'project:module'
7681
 *   - 'project:module (>=version, version)'
7682
 *
7683
 * @return
7684
 *   An associative array with three keys:
7685
 *   - 'name' includes the name of the thing to depend on (e.g. 'foo').
7686
 *   - 'original_version' contains the original version string (which can be
7687
 *     used in the UI for reporting incompatibilities).
7688
 *   - 'versions' is a list of associative arrays, each containing the keys
7689
 *     'op' and 'version'. 'op' can be one of: '=', '==', '!=', '<>', '<',
7690
 *     '<=', '>', or '>='. 'version' is one piece like '4.5-beta3'.
7691
 *   Callers should pass this structure to drupal_check_incompatibility().
7692
 *
7693
 * @see drupal_check_incompatibility()
7694
 */
7695
function drupal_parse_dependency($dependency) {
7696
  $value = array();
7697
  // Split out the optional project name.
7698
  if (strpos($dependency, ':')) {
7699
    list($project_name, $dependency) = explode(':', $dependency);
7700
    $value['project'] = $project_name;
7701
  }
7702
  // We use named subpatterns and support every op that version_compare
7703
  // supports. Also, op is optional and defaults to equals.
7704
  $p_op = '(?P<operation>!=|==|=|<|<=|>|>=|<>)?';
7705
  // Core version is always optional: 7.x-2.x and 2.x is treated the same.
7706
  $p_core = '(?:' . preg_quote(DRUPAL_CORE_COMPATIBILITY) . '-)?';
7707
  $p_major = '(?P<major>\d+)';
7708
  // By setting the minor version to x, branches can be matched.
7709
  $p_minor = '(?P<minor>(?:\d+|x)(?:-[A-Za-z]+\d+)?)';
7710
  $parts = explode('(', $dependency, 2);
7711
  $value['name'] = trim($parts[0]);
7712
  if (isset($parts[1])) {
7713
    $value['original_version'] = ' (' . $parts[1];
7714
    foreach (explode(',', $parts[1]) as $version) {
7715
      if (preg_match("/^\s*$p_op\s*$p_core$p_major\.$p_minor/", $version, $matches)) {
7716
        $op = !empty($matches['operation']) ? $matches['operation'] : '=';
7717
        if ($matches['minor'] == 'x') {
7718
          // Drupal considers "2.x" to mean any version that begins with
7719
          // "2" (e.g. 2.0, 2.9 are all "2.x"). PHP's version_compare(),
7720
          // on the other hand, treats "x" as a string; so to
7721
          // version_compare(), "2.x" is considered less than 2.0. This
7722
          // means that >=2.x and <2.x are handled by version_compare()
7723
          // as we need, but > and <= are not.
7724
          if ($op == '>' || $op == '<=') {
7725
            $matches['major']++;
7726
          }
7727
          // Equivalence can be checked by adding two restrictions.
7728
          if ($op == '=' || $op == '==') {
7729
            $value['versions'][] = array('op' => '<', 'version' => ($matches['major'] + 1) . '.x');
7730
            $op = '>=';
7731
          }
7732
        }
7733
        $value['versions'][] = array('op' => $op, 'version' => $matches['major'] . '.' . $matches['minor']);
7734
      }
7735
    }
7736
  }
7737
  return $value;
7738
}
7739

    
7740
/**
7741
 * Checks whether a version is compatible with a given dependency.
7742
 *
7743
 * @param $v
7744
 *   The parsed dependency structure from drupal_parse_dependency().
7745
 * @param $current_version
7746
 *   The version to check against (like 4.2).
7747
 *
7748
 * @return
7749
 *   NULL if compatible, otherwise the original dependency version string that
7750
 *   caused the incompatibility.
7751
 *
7752
 * @see drupal_parse_dependency()
7753
 */
7754
function drupal_check_incompatibility($v, $current_version) {
7755
  if (!empty($v['versions'])) {
7756
    foreach ($v['versions'] as $required_version) {
7757
      if ((isset($required_version['op']) && !version_compare($current_version, $required_version['version'], $required_version['op']))) {
7758
        return $v['original_version'];
7759
      }
7760
    }
7761
  }
7762
}
7763

    
7764
/**
7765
 * Get the entity info array of an entity type.
7766
 *
7767
 * @param $entity_type
7768
 *   The entity type, e.g. node, for which the info shall be returned, or NULL
7769
 *   to return an array with info about all types.
7770
 *
7771
 * @see hook_entity_info()
7772
 * @see hook_entity_info_alter()
7773
 */
7774
function entity_get_info($entity_type = NULL) {
7775
  global $language;
7776

    
7777
  // Use the advanced drupal_static() pattern, since this is called very often.
7778
  static $drupal_static_fast;
7779
  if (!isset($drupal_static_fast)) {
7780
    $drupal_static_fast['entity_info'] = &drupal_static(__FUNCTION__);
7781
  }
7782
  $entity_info = &$drupal_static_fast['entity_info'];
7783

    
7784
  // hook_entity_info() includes translated strings, so each language is cached
7785
  // separately.
7786
  $langcode = $language->language;
7787

    
7788
  if (empty($entity_info)) {
7789
    if ($cache = cache_get("entity_info:$langcode")) {
7790
      $entity_info = $cache->data;
7791
    }
7792
    else {
7793
      $entity_info = module_invoke_all('entity_info');
7794
      // Merge in default values.
7795
      foreach ($entity_info as $name => $data) {
7796
        $entity_info[$name] += array(
7797
          'fieldable' => FALSE,
7798
          'controller class' => 'DrupalDefaultEntityController',
7799
          'static cache' => TRUE,
7800
          'field cache' => TRUE,
7801
          'load hook' => $name . '_load',
7802
          'bundles' => array(),
7803
          'view modes' => array(),
7804
          'entity keys' => array(),
7805
          'translation' => array(),
7806
        );
7807
        $entity_info[$name]['entity keys'] += array(
7808
          'revision' => '',
7809
          'bundle' => '',
7810
        );
7811
        foreach ($entity_info[$name]['view modes'] as $view_mode => $view_mode_info) {
7812
          $entity_info[$name]['view modes'][$view_mode] += array(
7813
            'custom settings' => FALSE,
7814
          );
7815
        }
7816
        // If no bundle key is provided, assume a single bundle, named after
7817
        // the entity type.
7818
        if (empty($entity_info[$name]['entity keys']['bundle']) && empty($entity_info[$name]['bundles'])) {
7819
          $entity_info[$name]['bundles'] = array($name => array('label' => $entity_info[$name]['label']));
7820
        }
7821
        // Prepare entity schema fields SQL info for
7822
        // DrupalEntityControllerInterface::buildQuery().
7823
        if (isset($entity_info[$name]['base table'])) {
7824
          $entity_info[$name]['base table field types'] = drupal_schema_field_types($entity_info[$name]['base table']);
7825
          $entity_info[$name]['schema_fields_sql']['base table'] = drupal_schema_fields_sql($entity_info[$name]['base table']);
7826
          if (isset($entity_info[$name]['revision table'])) {
7827
            $entity_info[$name]['schema_fields_sql']['revision table'] = drupal_schema_fields_sql($entity_info[$name]['revision table']);
7828
          }
7829
        }
7830
      }
7831
      // Let other modules alter the entity info.
7832
      drupal_alter('entity_info', $entity_info);
7833
      cache_set("entity_info:$langcode", $entity_info);
7834
    }
7835
  }
7836

    
7837
  if (empty($entity_type)) {
7838
    return $entity_info;
7839
  }
7840
  elseif (isset($entity_info[$entity_type])) {
7841
    return $entity_info[$entity_type];
7842
  }
7843
}
7844

    
7845
/**
7846
 * Resets the cached information about entity types.
7847
 */
7848
function entity_info_cache_clear() {
7849
  drupal_static_reset('entity_get_info');
7850
  // Clear all languages.
7851
  cache_clear_all('entity_info:', 'cache', TRUE);
7852
}
7853

    
7854
/**
7855
 * Helper function to extract id, vid, and bundle name from an entity.
7856
 *
7857
 * @param $entity_type
7858
 *   The entity type; e.g. 'node' or 'user'.
7859
 * @param $entity
7860
 *   The entity from which to extract values.
7861
 *
7862
 * @return
7863
 *   A numerically indexed array (not a hash table) containing these
7864
 *   elements:
7865
 *   - 0: Primary ID of the entity.
7866
 *   - 1: Revision ID of the entity, or NULL if $entity_type is not versioned.
7867
 *   - 2: Bundle name of the entity, or NULL if $entity_type has no bundles.
7868
 */
7869
function entity_extract_ids($entity_type, $entity) {
7870
  $info = entity_get_info($entity_type);
7871

    
7872
  // Objects being created might not have id/vid yet.
7873
  $id = isset($entity->{$info['entity keys']['id']}) ? $entity->{$info['entity keys']['id']} : NULL;
7874
  $vid = ($info['entity keys']['revision'] && isset($entity->{$info['entity keys']['revision']})) ? $entity->{$info['entity keys']['revision']} : NULL;
7875

    
7876
  if (!empty($info['entity keys']['bundle'])) {
7877
    // Explicitly fail for malformed entities missing the bundle property.
7878
    if (!isset($entity->{$info['entity keys']['bundle']}) || $entity->{$info['entity keys']['bundle']} === '') {
7879
      throw new EntityMalformedException(t('Missing bundle property on entity of type @entity_type.', array('@entity_type' => $entity_type)));
7880
    }
7881
    $bundle = $entity->{$info['entity keys']['bundle']};
7882
  }
7883
  else {
7884
    // The entity type provides no bundle key: assume a single bundle, named
7885
    // after the entity type.
7886
    $bundle = $entity_type;
7887
  }
7888

    
7889
  return array($id, $vid, $bundle);
7890
}
7891

    
7892
/**
7893
 * Helper function to assemble an object structure with initial ids.
7894
 *
7895
 * This function can be seen as reciprocal to entity_extract_ids().
7896
 *
7897
 * @param $entity_type
7898
 *   The entity type; e.g. 'node' or 'user'.
7899
 * @param $ids
7900
 *   A numerically indexed array, as returned by entity_extract_ids().
7901
 *
7902
 * @return
7903
 *   An entity structure, initialized with the ids provided.
7904
 *
7905
 * @see entity_extract_ids()
7906
 */
7907
function entity_create_stub_entity($entity_type, $ids) {
7908
  $entity = new stdClass();
7909
  $info = entity_get_info($entity_type);
7910
  $entity->{$info['entity keys']['id']} = $ids[0];
7911
  if (!empty($info['entity keys']['revision']) && isset($ids[1])) {
7912
    $entity->{$info['entity keys']['revision']} = $ids[1];
7913
  }
7914
  if (!empty($info['entity keys']['bundle']) && isset($ids[2])) {
7915
    $entity->{$info['entity keys']['bundle']} = $ids[2];
7916
  }
7917
  return $entity;
7918
}
7919

    
7920
/**
7921
 * Load entities from the database.
7922
 *
7923
 * The entities are stored in a static memory cache, and will not require
7924
 * database access if loaded again during the same page request.
7925
 *
7926
 * The actual loading is done through a class that has to implement the
7927
 * DrupalEntityControllerInterface interface. By default,
7928
 * DrupalDefaultEntityController is used. Entity types can specify that a
7929
 * different class should be used by setting the 'controller class' key in
7930
 * hook_entity_info(). These classes can either implement the
7931
 * DrupalEntityControllerInterface interface, or, most commonly, extend the
7932
 * DrupalDefaultEntityController class. See node_entity_info() and the
7933
 * NodeController in node.module as an example.
7934
 *
7935
 * @param $entity_type
7936
 *   The entity type to load, e.g. node or user.
7937
 * @param $ids
7938
 *   An array of entity IDs, or FALSE to load all entities.
7939
 * @param $conditions
7940
 *   (deprecated) An associative array of conditions on the base table, where
7941
 *   the keys are the database fields and the values are the values those
7942
 *   fields must have. Instead, it is preferable to use EntityFieldQuery to
7943
 *   retrieve a list of entity IDs loadable by this function.
7944
 * @param $reset
7945
 *   Whether to reset the internal cache for the requested entity type.
7946
 *
7947
 * @return
7948
 *   An array of entity objects indexed by their ids. When no results are
7949
 *   found, an empty array is returned.
7950
 *
7951
 * @todo Remove $conditions in Drupal 8.
7952
 *
7953
 * @see hook_entity_info()
7954
 * @see DrupalEntityControllerInterface
7955
 * @see DrupalDefaultEntityController
7956
 * @see EntityFieldQuery
7957
 */
7958
function entity_load($entity_type, $ids = FALSE, $conditions = array(), $reset = FALSE) {
7959
  if ($reset) {
7960
    entity_get_controller($entity_type)->resetCache();
7961
  }
7962
  return entity_get_controller($entity_type)->load($ids, $conditions);
7963
}
7964

    
7965
/**
7966
 * Loads the unchanged, i.e. not modified, entity from the database.
7967
 *
7968
 * Unlike entity_load() this function ensures the entity is directly loaded from
7969
 * the database, thus bypassing any static cache. In particular, this function
7970
 * is useful to determine changes by comparing the entity being saved to the
7971
 * stored entity.
7972
 *
7973
 * @param $entity_type
7974
 *   The entity type to load, e.g. node or user.
7975
 * @param $id
7976
 *   The ID of the entity to load.
7977
 *
7978
 * @return
7979
 *   The unchanged entity, or FALSE if the entity cannot be loaded.
7980
 */
7981
function entity_load_unchanged($entity_type, $id) {
7982
  entity_get_controller($entity_type)->resetCache(array($id));
7983
  $result = entity_get_controller($entity_type)->load(array($id));
7984
  return reset($result);
7985
}
7986

    
7987
/**
7988
 * Gets the entity controller for an entity type.
7989
 *
7990
 * @return DrupalEntityControllerInterface
7991
 *   The entity controller object for the specified entity type.
7992
 */
7993
function entity_get_controller($entity_type) {
7994
  $controllers = &drupal_static(__FUNCTION__, array());
7995
  if (!isset($controllers[$entity_type])) {
7996
    $type_info = entity_get_info($entity_type);
7997
    $class = $type_info['controller class'];
7998
    $controllers[$entity_type] = new $class($entity_type);
7999
  }
8000
  return $controllers[$entity_type];
8001
}
8002

    
8003
/**
8004
 * Invoke hook_entity_prepare_view().
8005
 *
8006
 * If adding a new entity similar to nodes, comments or users, you should
8007
 * invoke this function during the ENTITY_build_content() or
8008
 * ENTITY_view_multiple() phases of rendering to allow other modules to alter
8009
 * the objects during this phase. This is needed for situations where
8010
 * information needs to be loaded outside of ENTITY_load() - particularly
8011
 * when loading entities into one another - i.e. a user object into a node, due
8012
 * to the potential for unwanted side-effects such as caching and infinite
8013
 * recursion. By convention, entity_prepare_view() is called after
8014
 * field_attach_prepare_view() to allow entity level hooks to act on content
8015
 * loaded by field API.
8016
 *
8017
 * @param $entity_type
8018
 *   The type of entity, i.e. 'node', 'user'.
8019
 * @param $entities
8020
 *   The entity objects which are being prepared for view, keyed by object ID.
8021
 * @param $langcode
8022
 *   (optional) A language code to be used for rendering. Defaults to the global
8023
 *   content language of the current request.
8024
 *
8025
 * @see hook_entity_prepare_view()
8026
 */
8027
function entity_prepare_view($entity_type, $entities, $langcode = NULL) {
8028
  if (!isset($langcode)) {
8029
    $langcode = $GLOBALS['language_content']->language;
8030
  }
8031

    
8032
  // To ensure hooks are only run once per entity, check for an
8033
  // entity_view_prepared flag and only process items without it.
8034
  // @todo: resolve this more generally for both entity and field level hooks.
8035
  $prepare = array();
8036
  foreach ($entities as $id => $entity) {
8037
    if (empty($entity->entity_view_prepared)) {
8038
      // Add this entity to the items to be prepared.
8039
      $prepare[$id] = $entity;
8040

    
8041
      // Mark this item as prepared.
8042
      $entity->entity_view_prepared = TRUE;
8043
    }
8044
  }
8045

    
8046
  if (!empty($prepare)) {
8047
    module_invoke_all('entity_prepare_view', $prepare, $entity_type, $langcode);
8048
  }
8049
}
8050

    
8051
/**
8052
 * Invoke hook_entity_view_mode_alter().
8053
 *
8054
 * If adding a new entity similar to nodes, comments or users, you should invoke
8055
 * this function during the ENTITY_build_content() or ENTITY_view_multiple()
8056
 * phases of rendering to allow other modules to alter the view mode during this
8057
 * phase. This function needs to be called before field_attach_prepare_view() to
8058
 * ensure that the correct content is loaded by field API.
8059
 *
8060
 * @param $entity_type
8061
 *   The type of entity, i.e. 'node', 'user'.
8062
 * @param $entities
8063
 *   The entity objects which are being prepared for view, keyed by object ID.
8064
 * @param $view_mode
8065
 *   The original view mode e.g. 'full', 'teaser'...
8066
 * @param $langcode
8067
 *   (optional) A language code to be used for rendering. Defaults to the global
8068
 *   content language of the current request.
8069
 * @return
8070
 *   An associative array with arrays of entities keyed by view mode.
8071
 *
8072
 * @see hook_entity_view_mode_alter()
8073
 */
8074
function entity_view_mode_prepare($entity_type, $entities, $view_mode, $langcode = NULL) {
8075
  if (!isset($langcode)) {
8076
    $langcode = $GLOBALS['language_content']->language;
8077
  }
8078

    
8079
  // To ensure hooks are never run after field_attach_prepare_view() only
8080
  // process items without the entity_view_prepared flag.
8081
  $entities_by_view_mode = array();
8082
  foreach ($entities as $id => $entity) {
8083
    $entity_view_mode = $view_mode;
8084
    if (empty($entity->entity_view_prepared)) {
8085

    
8086
      // Allow modules to change the view mode.
8087
      $context = array(
8088
        'entity_type' => $entity_type,
8089
        'entity' => $entity,
8090
        'langcode' => $langcode,
8091
      );
8092
      drupal_alter('entity_view_mode', $entity_view_mode, $context);
8093
    }
8094

    
8095
    $entities_by_view_mode[$entity_view_mode][$id] = $entity;
8096
  }
8097

    
8098
  return $entities_by_view_mode;
8099
}
8100

    
8101
/**
8102
 * Returns the URI elements of an entity.
8103
 *
8104
 * @param $entity_type
8105
 *   The entity type; e.g. 'node' or 'user'.
8106
 * @param $entity
8107
 *   The entity for which to generate a path.
8108
 * @return
8109
 *   An array containing the 'path' and 'options' keys used to build the URI of
8110
 *   the entity, and matching the signature of url(). NULL if the entity has no
8111
 *   URI of its own.
8112
 */
8113
function entity_uri($entity_type, $entity) {
8114
  $info = entity_get_info($entity_type);
8115
  list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
8116

    
8117
  // A bundle-specific callback takes precedence over the generic one for the
8118
  // entity type.
8119
  if (isset($info['bundles'][$bundle]['uri callback'])) {
8120
    $uri_callback = $info['bundles'][$bundle]['uri callback'];
8121
  }
8122
  elseif (isset($info['uri callback'])) {
8123
    $uri_callback = $info['uri callback'];
8124
  }
8125
  else {
8126
    return NULL;
8127
  }
8128

    
8129
  // Invoke the callback to get the URI. If there is no callback, return NULL.
8130
  if (isset($uri_callback) && function_exists($uri_callback)) {
8131
    $uri = $uri_callback($entity);
8132
    // Pass the entity data to url() so that alter functions do not need to
8133
    // lookup this entity again.
8134
    $uri['options']['entity_type'] = $entity_type;
8135
    $uri['options']['entity'] = $entity;
8136
    return $uri;
8137
  }
8138
}
8139

    
8140
/**
8141
 * Returns the label of an entity.
8142
 *
8143
 * See the 'label callback' component of the hook_entity_info() return value
8144
 * for more information.
8145
 *
8146
 * @param $entity_type
8147
 *   The entity type; e.g., 'node' or 'user'.
8148
 * @param $entity
8149
 *   The entity for which to generate the label.
8150
 *
8151
 * @return
8152
 *   The entity label, or FALSE if not found.
8153
 */
8154
function entity_label($entity_type, $entity) {
8155
  $label = FALSE;
8156
  $info = entity_get_info($entity_type);
8157
  if (isset($info['label callback']) && function_exists($info['label callback'])) {
8158
    $label = $info['label callback']($entity, $entity_type);
8159
  }
8160
  elseif (!empty($info['entity keys']['label']) && isset($entity->{$info['entity keys']['label']})) {
8161
    $label = $entity->{$info['entity keys']['label']};
8162
  }
8163

    
8164
  return $label;
8165
}
8166

    
8167
/**
8168
 * Returns the language of an entity.
8169
 *
8170
 * @param $entity_type
8171
 *   The entity type; e.g., 'node' or 'user'.
8172
 * @param $entity
8173
 *   The entity for which to get the language.
8174
 *
8175
 * @return
8176
 *   A valid language code or NULL if the entity has no language support.
8177
 */
8178
function entity_language($entity_type, $entity) {
8179
  $info = entity_get_info($entity_type);
8180

    
8181
  // Invoke the callback to get the language. If there is no callback, try to
8182
  // get it from a property of the entity, otherwise NULL.
8183
  if (isset($info['language callback']) && function_exists($info['language callback'])) {
8184
    $langcode = $info['language callback']($entity_type, $entity);
8185
  }
8186
  elseif (!empty($info['entity keys']['language']) && isset($entity->{$info['entity keys']['language']})) {
8187
    $langcode = $entity->{$info['entity keys']['language']};
8188
  }
8189
  else {
8190
    // The value returned in D8 would be LANGUAGE_NONE, we cannot use it here to
8191
    // preserve backward compatibility. In fact this function has been
8192
    // introduced very late in the D7 life cycle, mainly as the proper default
8193
    // for field_attach_form(). By returning LANGUAGE_NONE when no language
8194
    // information is available, we would introduce a potentially BC-breaking
8195
    // API change, since field_attach_form() defaults to the default language
8196
    // instead of LANGUAGE_NONE. Moreover this allows us to distinguish between
8197
    // entities that have no language specified from ones that do not have
8198
    // language support at all.
8199
    $langcode = NULL;
8200
  }
8201

    
8202
  return $langcode;
8203
}
8204

    
8205
/**
8206
 * Attaches field API validation to entity forms.
8207
 */
8208
function entity_form_field_validate($entity_type, $form, &$form_state) {
8209
  // All field attach API functions act on an entity object, but during form
8210
  // validation, we don't have one. $form_state contains the entity as it was
8211
  // prior to processing the current form submission, and we must not update it
8212
  // until we have fully validated the submitted input. Therefore, for
8213
  // validation, act on a pseudo entity created out of the form values.
8214
  $pseudo_entity = (object) $form_state['values'];
8215
  field_attach_form_validate($entity_type, $pseudo_entity, $form, $form_state);
8216
}
8217

    
8218
/**
8219
 * Copies submitted values to entity properties for simple entity forms.
8220
 *
8221
 * During the submission handling of an entity form's "Save", "Preview", and
8222
 * possibly other buttons, the form state's entity needs to be updated with the
8223
 * submitted form values. Each entity form implements its own builder function
8224
 * for doing this, appropriate for the particular entity and form, whereas
8225
 * modules may specify additional builder functions in $form['#entity_builders']
8226
 * for copying the form values of added form elements to entity properties.
8227
 * Many of the main entity builder functions can call this helper function to
8228
 * re-use its logic of copying $form_state['values'][PROPERTY] values to
8229
 * $entity->PROPERTY for all entries in $form_state['values'] that are not field
8230
 * data, and calling field_attach_submit() to copy field data. Apart from that
8231
 * this helper invokes any additional builder functions that have been specified
8232
 * in $form['#entity_builders'].
8233
 *
8234
 * For some entity forms (e.g., forms with complex non-field data and forms that
8235
 * simultaneously edit multiple entities), this behavior may be inappropriate,
8236
 * so the builder function for such forms needs to implement the required
8237
 * functionality instead of calling this function.
8238
 */
8239
function entity_form_submit_build_entity($entity_type, $entity, $form, &$form_state) {
8240
  $info = entity_get_info($entity_type);
8241
  list(, , $bundle) = entity_extract_ids($entity_type, $entity);
8242

    
8243
  // Copy top-level form values that are not for fields to entity properties,
8244
  // without changing existing entity properties that are not being edited by
8245
  // this form. Copying field values must be done using field_attach_submit().
8246
  $values_excluding_fields = $info['fieldable'] ? array_diff_key($form_state['values'], field_info_instances($entity_type, $bundle)) : $form_state['values'];
8247
  foreach ($values_excluding_fields as $key => $value) {
8248
    $entity->$key = $value;
8249
  }
8250

    
8251
  // Invoke all specified builders for copying form values to entity properties.
8252
  if (isset($form['#entity_builders'])) {
8253
    foreach ($form['#entity_builders'] as $function) {
8254
      $function($entity_type, $entity, $form, $form_state);
8255
    }
8256
  }
8257

    
8258
  // Copy field values to the entity.
8259
  if ($info['fieldable']) {
8260
    field_attach_submit($entity_type, $entity, $form, $form_state);
8261
  }
8262
}
8263

    
8264
/**
8265
 * Performs one or more XML-RPC request(s).
8266
 *
8267
 * Usage example:
8268
 * @code
8269
 * $result = xmlrpc('http://example.com/xmlrpc.php', array(
8270
 *   'service.methodName' => array($parameter, $second, $third),
8271
 * ));
8272
 * @endcode
8273
 *
8274
 * @param $url
8275
 *   An absolute URL of the XML-RPC endpoint.
8276
 * @param $args
8277
 *   An associative array whose keys are the methods to call and whose values
8278
 *   are the arguments to pass to the respective method. If multiple methods
8279
 *   are specified, a system.multicall is performed.
8280
 * @param $options
8281
 *   (optional) An array of options to pass along to drupal_http_request().
8282
 *
8283
 * @return
8284
 *   For one request:
8285
 *     Either the return value of the method on success, or FALSE.
8286
 *     If FALSE is returned, see xmlrpc_errno() and xmlrpc_error_msg().
8287
 *   For multiple requests:
8288
 *     An array of results. Each result will either be the result
8289
 *     returned by the method called, or an xmlrpc_error object if the call
8290
 *     failed. See xmlrpc_error().
8291
 */
8292
function xmlrpc($url, $args, $options = array()) {
8293
  require_once DRUPAL_ROOT . '/includes/xmlrpc.inc';
8294
  return _xmlrpc($url, $args, $options);
8295
}
8296

    
8297
/**
8298
 * Retrieves a list of all available archivers.
8299
 *
8300
 * @see hook_archiver_info()
8301
 * @see hook_archiver_info_alter()
8302
 */
8303
function archiver_get_info() {
8304
  $archiver_info = &drupal_static(__FUNCTION__, array());
8305

    
8306
  if (empty($archiver_info)) {
8307
    $cache = cache_get('archiver_info');
8308
    if ($cache === FALSE) {
8309
      // Rebuild the cache and save it.
8310
      $archiver_info = module_invoke_all('archiver_info');
8311
      drupal_alter('archiver_info', $archiver_info);
8312
      uasort($archiver_info, 'drupal_sort_weight');
8313
      cache_set('archiver_info', $archiver_info);
8314
    }
8315
    else {
8316
      $archiver_info = $cache->data;
8317
    }
8318
  }
8319

    
8320
  return $archiver_info;
8321
}
8322

    
8323
/**
8324
 * Returns a string of supported archive extensions.
8325
 *
8326
 * @return
8327
 *   A space-separated string of extensions suitable for use by the file
8328
 *   validation system.
8329
 */
8330
function archiver_get_extensions() {
8331
  $valid_extensions = array();
8332
  foreach (archiver_get_info() as $archive) {
8333
    foreach ($archive['extensions'] as $extension) {
8334
      foreach (explode('.', $extension) as $part) {
8335
        if (!in_array($part, $valid_extensions)) {
8336
          $valid_extensions[] = $part;
8337
        }
8338
      }
8339
    }
8340
  }
8341
  return implode(' ', $valid_extensions);
8342
}
8343

    
8344
/**
8345
 * Creates the appropriate archiver for the specified file.
8346
 *
8347
 * @param $file
8348
 *   The full path of the archive file. Note that stream wrapper paths are
8349
 *   supported, but not remote ones.
8350
 *
8351
 * @return
8352
 *   A newly created instance of the archiver class appropriate
8353
 *   for the specified file, already bound to that file.
8354
 *   If no appropriate archiver class was found, will return FALSE.
8355
 */
8356
function archiver_get_archiver($file) {
8357
  // Archivers can only work on local paths
8358
  $filepath = drupal_realpath($file);
8359
  if (!is_file($filepath)) {
8360
    throw new Exception(t('Archivers can only operate on local files: %file not supported', array('%file' => $file)));
8361
  }
8362
  $archiver_info = archiver_get_info();
8363

    
8364
  foreach ($archiver_info as $implementation) {
8365
    foreach ($implementation['extensions'] as $extension) {
8366
      // Because extensions may be multi-part, such as .tar.gz,
8367
      // we cannot use simpler approaches like substr() or pathinfo().
8368
      // This method isn't quite as clean but gets the job done.
8369
      // Also note that the file may not yet exist, so we cannot rely
8370
      // on fileinfo() or other disk-level utilities.
8371
      if (strrpos($filepath, '.' . $extension) === strlen($filepath) - strlen('.' . $extension)) {
8372
        return new $implementation['class']($filepath);
8373
      }
8374
    }
8375
  }
8376
}
8377

    
8378
/**
8379
 * Assembles the Drupal Updater registry.
8380
 *
8381
 * An Updater is a class that knows how to update various parts of the Drupal
8382
 * file system, for example to update modules that have newer releases, or to
8383
 * install a new theme.
8384
 *
8385
 * @return
8386
 *   The Drupal Updater class registry.
8387
 *
8388
 * @see hook_updater_info()
8389
 * @see hook_updater_info_alter()
8390
 */
8391
function drupal_get_updaters() {
8392
  $updaters = &drupal_static(__FUNCTION__);
8393
  if (!isset($updaters)) {
8394
    $updaters = module_invoke_all('updater_info');
8395
    drupal_alter('updater_info', $updaters);
8396
    uasort($updaters, 'drupal_sort_weight');
8397
  }
8398
  return $updaters;
8399
}
8400

    
8401
/**
8402
 * Assembles the Drupal FileTransfer registry.
8403
 *
8404
 * @return
8405
 *   The Drupal FileTransfer class registry.
8406
 *
8407
 * @see FileTransfer
8408
 * @see hook_filetransfer_info()
8409
 * @see hook_filetransfer_info_alter()
8410
 */
8411
function drupal_get_filetransfer_info() {
8412
  $info = &drupal_static(__FUNCTION__);
8413
  if (!isset($info)) {
8414
    // Since we have to manually set the 'file path' default for each
8415
    // module separately, we can't use module_invoke_all().
8416
    $info = array();
8417
    foreach (module_implements('filetransfer_info') as $module) {
8418
      $function = $module . '_filetransfer_info';
8419
      if (function_exists($function)) {
8420
        $result = $function();
8421
        if (isset($result) && is_array($result)) {
8422
          foreach ($result as &$values) {
8423
            if (empty($values['file path'])) {
8424
              $values['file path'] = drupal_get_path('module', $module);
8425
            }
8426
          }
8427
          $info = array_merge_recursive($info, $result);
8428
        }
8429
      }
8430
    }
8431
    drupal_alter('filetransfer_info', $info);
8432
    uasort($info, 'drupal_sort_weight');
8433
  }
8434
  return $info;
8435
}