common.inc 282 KB
Newer Older
Dries's avatar
   
Dries committed
1
2
<?php

3
use Drupal\Core\Database\Database;
4

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

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

44
45
46
/**
 * Return status for saving which involved creating a new item.
 */
47
const SAVED_NEW = 1;
48
49
50
51

/**
 * Return status for saving which involved an update to an existing item.
 */
52
const SAVED_UPDATED = 2;
53
54
55
56

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

59
/**
60
 * The default group for system CSS files added to the page.
61
 */
62
const CSS_SYSTEM = -100;
63
64

/**
65
 * The default group for module CSS files added to the page.
66
 */
67
const CSS_DEFAULT = 0;
68
69

/**
70
 * The default group for theme CSS files added to the page.
71
 */
72
const CSS_THEME = 100;
73

74
/**
75
 * The default group for JavaScript and jQuery libraries added to the page.
76
 */
77
const JS_LIBRARY = -100;
78
79

/**
80
 * The default group for module JavaScript code added to the page.
81
 */
82
const JS_DEFAULT = 0;
83
84

/**
85
 * The default group for theme JavaScript code added to the page.
86
 */
87
const JS_THEME = 100;
88

89
90
91
/**
 * The default group for JavaScript settings added to the page.
 */
92
const JS_SETTING = 200;
93

94
/**
95
96
97
 * Error code indicating that the request exceeded the specified timeout.
 *
 * @see drupal_http_request()
98
 */
99
const HTTP_REQUEST_TIMEOUT = -1;
100

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/**
 * Constants defining cache granularity for blocks and renderable arrays.
 *
 * Modules specify the caching patterns for their blocks using binary
 * combinations of these constants in their hook_block_info():
 *   $block[delta]['cache'] = DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE;
 * DRUPAL_CACHE_PER_ROLE is used as a default when no caching pattern is
 * specified. Use DRUPAL_CACHE_CUSTOM to disable standard block cache and
 * implement
 *
 * The block cache is cleared in cache_clear_all(), and uses the same clearing
 * policy than page cache (node, comment, user, taxonomy added or updated...).
 * Blocks requiring more fine-grained clearing might consider disabling the
 * built-in block cache (DRUPAL_NO_CACHE) and roll their own.
 *
 * Note that user 1 is excluded from block caching.
 */

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

/**
131
132
133
134
135
 * The block is handling its own caching in its hook_block_view().
 *
 * From the perspective of the block cache system, this is equivalent to
 * DRUPAL_NO_CACHE. Useful when time based expiration is needed or a site uses
 * a node access which invalidates standard block cache.
136
 */
137
const DRUPAL_CACHE_CUSTOM = -2;
138
139

/**
140
141
142
143
 * The block or element can change depending on the user's roles.
 *
 * This is the default setting for blocks, used when the block does not specify
 * anything.
144
 */
145
const DRUPAL_CACHE_PER_ROLE = 0x0001;
146
147

/**
148
149
 * The block or element can change depending on the user.
 *
150
151
152
 * This setting can be resource-consuming for sites with large number of users,
 * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
 */
153
const DRUPAL_CACHE_PER_USER = 0x0002;
154
155
156
157

/**
 * The block or element can change depending on the page being viewed.
 */
158
const DRUPAL_CACHE_PER_PAGE = 0x0004;
159
160

/**
161
 * The block or element is the same for every user and page that it is visible.
162
 */
163
const DRUPAL_CACHE_GLOBAL = 0x0008;
164

165
166
167
168
169
170
171
172
173
/**
 * The delimiter used to split plural strings.
 *
 * This is the ETX (End of text) character and is used as a minimal means to
 * separate singular and plural variants in source and translation text. It
 * was found to be the most compatible delimiter for the supported databases.
 */
const LOCALE_PLURAL_DELIMITER = "\03";

174
/**
175
 * Adds content to a specified region.
176
177
 *
 * @param $region
178
 *   Page region the content is added to.
179
 * @param $data
180
 *   Content to be added.
181
 */
182
function drupal_add_region_content($region = NULL, $data = NULL) {
183
184
  static $content = array();

185
  if (isset($region) && isset($data)) {
186
187
188
189
190
191
    $content[$region][] = $data;
  }
  return $content;
}

/**
192
 * Gets assigned content for a given region.
193
194
 *
 * @param $region
195
196
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
197
 * @param $delimiter
198
 *   Content to be inserted between imploded array elements.
199
 */
200
201
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
202
203
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
204
      return implode($delimiter, $content[$region]);
205
    }
206
207
208
209
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
210
        $content[$region] = implode($delimiter, $content[$region]);
211
212
213
214
215
216
      }
    }
    return $content;
  }
}

217
/**
218
 * Gets the name of the currently active install profile.
219
220
221
222
 *
 * When this function is called during Drupal's initial installation process,
 * the name of the profile that's about to be installed is stored in the global
 * installation state. At all other times, the standard Drupal systems variable
223
224
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
225
226
227
228
229
230
231
232
233
234
235
 *
 * @return $profile
 *   The name of the install profile.
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
236
    $profile = variable_get('install_profile', 'standard');
237
238
239
240
241
242
  }

  return $profile;
}


Dries's avatar
   
Dries committed
243
/**
244
 * Sets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
245
 *
Dries's avatar
   
Dries committed
246
247
248
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
249
 */
Dries's avatar
   
Dries committed
250
function drupal_set_breadcrumb($breadcrumb = NULL) {
251
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
   
Dries committed
252

253
  if (isset($breadcrumb)) {
Dries's avatar
   
Dries committed
254
255
256
257
258
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
259
/**
260
 * Gets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
261
 */
Dries's avatar
   
Dries committed
262
263
264
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

265
  if (!isset($breadcrumb)) {
Dries's avatar
   
Dries committed
266
267
268
269
270
271
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

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

293
294
295
296
297
298
299
300
301
302
  if (!isset($stored_head)) {
    // Make sure the defaults, including Content-Type, come first.
    $stored_head = _drupal_default_html_head();
  }

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
303
304
305
306
  }
  return $stored_head;
}

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

/**
340
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
   
Dries committed
341
 */
Dries's avatar
Dries committed
342
function drupal_get_html_head() {
343
344
345
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
346
347
}

348
/**
349
 * Adds a feed URL for the current page.
350
 *
351
352
 * This function can be called as long the HTML header hasn't been sent.
 *
353
 * @param $url
354
 *   An internal system path or a fully qualified external URL of the feed.
355
 * @param $title
356
 *   The title of the feed.
357
 */
358
function drupal_add_feed($url = NULL, $title = '') {
359
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
360

361
  if (isset($url)) {
362
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
363

364
365
366
367
368
369
370
371
    drupal_add_html_head_link(array(
      'rel' => 'alternate',
      'type' => 'application/rss+xml',
      'title' => $title,
      // Force the URL to be absolute, for consistency with other <link> tags
      // output by Drupal.
      'href' => url($url, array('absolute' => TRUE)),
    ));
372
373
374
375
376
  }
  return $stored_feed_links;
}

/**
377
 * Gets the feed URLs for the current page.
378
379
 *
 * @param $delimiter
380
 *   A delimiter to split feeds by.
381
382
383
384
385
386
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
387
/**
388
 * @defgroup http_handling HTTP handling
Dries's avatar
   
Dries committed
389
 * @{
Dries's avatar
   
Dries committed
390
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
391
392
 */

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

420
  $params = array();
421
  foreach ($query as $key => $value) {
422
423
424
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
425
426
    }

427
428
429
430
431
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
432
    }
433
434
435
436
437
  }

  return $params;
}

438
/**
439
 * Splits a URL-encoded query string into an array.
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 *
 * @param $query
 *   The query string to split.
 *
 * @return
 *   An array of url decoded couples $param_name => $value.
 */
function drupal_get_query_array($query) {
  $result = array();
  if (!empty($query)) {
    foreach (explode('&', $query) as $param) {
      $param = explode('=', $param);
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
    }
  }
  return $result;
}

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

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

482
    // Recurse into children.
483
    if (is_array($value)) {
484
485
486
487
488
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
489
490
    }
    else {
491
492
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
493
494
495
496
497
498
    }
  }

  return implode('&', $params);
}

499
/**
500
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
501
 *
502
503
504
505
 * Used to direct the user back to the referring page after completing a form.
 * By default the current URL is returned. If a destination exists in the
 * previous request, that destination is returned. As such, a destination can
 * persist across multiple pages.
506
507
508
509
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
510
511
512
513
514
515
  $destination = &drupal_static(__FUNCTION__);

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

516
  if (isset($_GET['destination'])) {
517
    $destination = array('destination' => $_GET['destination']);
518
519
  }
  else {
520
    $path = current_path();
521
    $query = drupal_http_build_query(drupal_get_query_parameters());
522
    if ($query != '') {
523
      $path .= '?' . $query;
524
    }
525
526
527
528
529
530
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
531
 * Parses a system URL string into an associative array suitable for url().
532
533
 *
 * This function should only be used for URLs that have been generated by the
534
535
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
 *   $options = drupal_parse_url($_GET['destination']);
 *   $my_url = url($options['path'], $options);
 *   $my_link = l('Example link', $options['path'], $options);
 * @endcode
 *
 * This is required, because url() does not support relative URLs containing a
 * query string or fragment in its $path argument. Instead, any query string
 * needs to be parsed into an associative query parameter array in
 * $options['query'] and the fragment into $options['fragment'].
 *
 * @param $url
 *   The URL string to parse, f.e. $_GET['destination'].
 *
 * @return
 *   An associative array containing the keys:
 *   - 'path': The path of the URL. If the given $url is external, this includes
 *     the scheme and host.
 *   - 'query': An array of query parameters of $url, if existent.
 *   - 'fragment': The fragment of $url, if existent.
 *
 * @see url()
 * @see drupal_goto()
 * @ingroup php_wrappers
 */
function drupal_parse_url($url) {
  $options = array(
    'path' => NULL,
    'query' => array(),
    'fragment' => '',
  );

  // External URLs: not using parse_url() here, so we do not have to rebuild
  // the scheme, host, and path without having any use for it.
  if (strpos($url, '://') !== FALSE) {
    // Split off everything before the query string into 'path'.
    $parts = explode('?', $url);
    $options['path'] = $parts[0];
    // If there is a query string, transform it into keyed query parameters.
    if (isset($parts[1])) {
      $query_parts = explode('#', $parts[1]);
      parse_str($query_parts[0], $options['query']);
      // Take over the fragment, if there is any.
      if (isset($query_parts[1])) {
        $options['fragment'] = $query_parts[1];
      }
    }
  }
  // Internal URLs.
  else {
589
590
591
592
593
    // parse_url() does not support relative URLs, so make it absolute. E.g. the
    // relative URL "foo/bar:1" isn't properly parsed.
    $parts = parse_url('http://example.com/' . $url);
    // Strip the leading slash that was just added.
    $options['path'] = substr($parts['path'], 1);
594
595
596
597
598
599
600
601
602
603
604
605
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

/**
606
 * Encodes a Drupal path for use in a URL.
607
 *
608
 * For aesthetic reasons slashes are not escaped.
609
 *
610
611
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
612
613
 *
 * @param $path
614
 *   The Drupal path to encode.
615
616
 */
function drupal_encode_path($path) {
617
  return str_replace('%2F', '/', rawurlencode($path));
618
619
}

Kjartan's avatar
Kjartan committed
620
/**
621
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
622
 *
Dries's avatar
   
Dries committed
623
624
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
625
 *
626
627
628
629
630
631
 * If a destination was specified in the current request's URI (i.e.,
 * $_GET['destination']) then it will override the $path and $options values
 * passed to this function. This provides the flexibility to build a link to
 * user/login and override the default redirection so that the user is
 * redirected to a specific path after logging in:
 * @code
632
633
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
634
 * @endcode
635
 *
636
637
 * Drupal will ensure that messages set by drupal_set_message() and other
 * session data are written to the database before the user is redirected.
Dries's avatar
   
Dries committed
638
 *
639
640
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
641
642
 *
 * @param $path
643
 *   A Drupal path or a full URL.
644
645
 * @param $options
 *   An associative array of additional URL options to pass to url().
646
647
648
649
650
651
652
653
 * @param $http_response_code
 *   Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
 *   - 301 Moved Permanently (the recommended value for most redirects)
 *   - 302 Found (default in Drupal and PHP, sometimes used for spamming search
 *         engines)
 *   - 303 See Other
 *   - 304 Not Modified
 *   - 305 Use Proxy
654
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
655
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
656
 *   supported.
657
 *
658
 * @see drupal_get_destination()
659
 * @see url()
Kjartan's avatar
Kjartan committed
660
 */
661
662
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
663
664
  // We do not allow absolute URLs to be passed via $_GET, as this can be an attack vector.
  if (isset($_GET['destination']) && !url_is_external($_GET['destination'])) {
665
    $destination = drupal_parse_url($_GET['destination']);
666
667
668
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
669
670
  }

671
672
673
674
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

676
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
677

678
  header('Location: ' . $url, TRUE, $http_response_code);
679
680

  // The "Location" header sends a redirect status code to the HTTP daemon. In
681
682
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
683
  drupal_exit($url);
Kjartan's avatar
Kjartan committed
684
685
}

686
/**
687
 * Delivers a "site is under maintenance" message to the browser.
688
689
690
691
692
 *
 * Page callback functions wanting to report a "site offline" message should
 * return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_site_offline().
693
694
 */
function drupal_site_offline() {
695
  drupal_deliver_page(MENU_SITE_OFFLINE);
696
697
}

Kjartan's avatar
Kjartan committed
698
/**
699
 * Delivers a "page not found" error to the browser.
700
701
702
703
704
 *
 * Page callback functions wanting to report a "page not found" message should
 * return MENU_NOT_FOUND instead of calling drupal_not_found(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_not_found().
Kjartan's avatar
Kjartan committed
705
 */
Dries's avatar
   
Dries committed
706
function drupal_not_found() {
707
  drupal_deliver_page(MENU_NOT_FOUND);
Dries's avatar
   
Dries committed
708
}
Dries's avatar
   
Dries committed
709

Dries's avatar
   
Dries committed
710
/**
711
 * Delivers an "access denied" error to the browser.
712
713
714
715
 *
 * Page callback functions wanting to report an "access denied" message should
 * return MENU_ACCESS_DENIED instead of calling drupal_access_denied(). However,
 * functions that are invoked in contexts where that return value might not
716
717
 * bubble up to menu_execute_active_handler() should call
 * drupal_access_denied().
Dries's avatar
   
Dries committed
718
719
 */
function drupal_access_denied() {
720
  drupal_deliver_page(MENU_ACCESS_DENIED);
Dries's avatar
   
Dries committed
721
722
}

Dries's avatar
   
Dries committed
723
/**
724
 * Performs an HTTP request.
Dries's avatar
   
Dries committed
725
 *
726
727
 * This is a flexible and powerful HTTP client implementation. Correctly
 * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
Dries's avatar
   
Dries committed
728
729
730
 *
 * @param $url
 *   A string containing a fully qualified URI.
731
732
733
734
735
736
737
738
739
740
741
742
 * @param array $options
 *   (optional) An array that can have one or more of the following elements:
 *   - headers: An array containing request headers to send as name/value pairs.
 *   - method: A string containing the request method. Defaults to 'GET'.
 *   - data: A string containing the request body, formatted as
 *     'param=value&param=value&...'. Defaults to NULL.
 *   - max_redirects: An integer representing how many times a redirect
 *     may be followed. Defaults to 3.
 *   - timeout: A float representing the maximum number of seconds the function
 *     call may take. The default is 30 seconds. If a timeout occurs, the error
 *     code is set to the HTTP_REQUEST_TIMEOUT constant.
 *   - context: A context resource created with stream_context_create().
743
 *
744
745
746
747
748
749
750
751
752
753
 * @return object
 *   An object that can have one or more of the following components:
 *   - request: A string containing the request body that was sent.
 *   - code: An integer containing the response status code, or the error code
 *     if an error occurred.
 *   - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
 *   - status_message: The status message from the response, if a response was
 *     received.
 *   - redirect_code: If redirected, an integer containing the initial response
 *     status code.
754
755
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
756
757
758
759
760
 *   - error: If an error occurred, the error message. Otherwise not set.
 *   - headers: An array containing the response headers as name/value pairs.
 *     HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
 *     easy access the array keys are returned in lower case.
 *   - data: A string containing the response body that was received.
Dries's avatar
   
Dries committed
761
 */
762
function drupal_http_request($url, array $options = array()) {
763
  $result = new stdClass();
Dries's avatar
   
Dries committed
764

765
766
767
768
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
769
    $result->error = 'unable to parse URL';
770
    $result->code = -1001;
771
772
773
    return $result;
  }

774
775
776
777
778
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
779

780
781
782
783
784
785
786
787
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
788
789
    'timeout' => 30.0,
    'context' => NULL,
790
  );
791
792
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
793

Dries's avatar
   
Dries committed
794
795
  switch ($uri['scheme']) {
    case 'http':
796
    case 'feed':
Dries's avatar
Dries committed
797
      $port = isset($uri['port']) ? $uri['port'] : 80;
798
799
800
801
802
      $socket = 'tcp://' . $uri['host'] . ':' . $port;
      // RFC 2616: "non-standard ports MUST, default ports MAY be included".
      // We don't add the standard port to prevent from breaking rewrite rules
      // checking the host that do not take into account the port number.
      $options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
Dries's avatar
   
Dries committed
803
804
      break;
    case 'https':
805
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
806
      $port = isset($uri['port']) ? $uri['port'] : 443;
807
808
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
   
Dries committed
809
810
      break;
    default:
811
      $result->error = 'invalid schema ' . $uri['scheme'];
812
      $result->code = -1003;
Dries's avatar
   
Dries committed
813
814
815
      return $result;
  }

816
817
818
819
820
821
822
823
  if (empty($options['context'])) {
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
  }
  else {
    // Create a stream with context. Allows verification of a SSL certificate.
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
  }

Dries's avatar
   
Dries committed
824
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
825
  if (!$fp) {
826
827
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
828
    $result->code = -$errno;
829
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
830
831
832
833

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

Dries's avatar
   
Dries committed
837
838
839
    return $result;
  }

Dries's avatar
   
Dries committed
840
  // Construct the path to act on.
Dries's avatar
Dries committed
841
842
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
843
    $path .= '?' . $uri['query'];
Dries's avatar
   
Dries committed
844
845
  }

846
847
848
  // Merge the default headers.
  $options['headers'] += array(
    'User-Agent' => 'Drupal (+http://drupal.org/)',
Dries's avatar
   
Dries committed
849
850
  );

851
852
853
854
  // Only add Content-Length if we actually have any content or if it is a POST
  // or PUT request. Some non-standard servers get confused by Content-Length in
  // at least HEAD/GET requests, and Squid always requires Content-Length in
  // POST/PUT requests.
855
856
857
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
858
859
860
  }

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

865
866
867
868
869
870
  // If the database prefix is being used by SimpleTest to run the tests in a copied
  // database then set the user-agent header to the database prefix so that any
  // calls to other Drupal pages will run the SimpleTest prefixed database. The
  // user-agent is used to ensure that multiple testing sessions running at the
  // same time won't interfere with each other as they would if the database
  // prefix were stored statically in a file or database variable.
871
872
873
  $test_info = &$GLOBALS['drupal_test_info'];
  if (!empty($test_info['test_run_id'])) {
    $options['headers']['User-Agent'] = drupal_generate_test_ua($test_info['test_run_id']);
874
875
  }

876
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
877
  foreach ($options['headers'] as $name => $value) {
878
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
   
Dries committed
879
  }
880
  $request .= "\r\n" . $options['data'];
Dries's avatar
   
Dries committed
881
  $result->request = $request;
882
883
884
885
886
887
  // Calculate how much time is left of the original timeout value.
  $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  if ($timeout > 0) {
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
    fwrite($fp, $request);
  }
Dries's avatar
   
Dries committed
888

889
890
891
892
893
  // Fetch response. Due to PHP bugs like http://bugs.php.net/bug.php?id=43782
  // and http://bugs.php.net/bug.php?id=46049 we can't rely on feof(), but
  // instead must invoke stream_get_meta_data() each iteration.
  $info = stream_get_meta_data($fp);
  $alive = !$info['eof'] && !$info['timed_out'];
894
  $response = '';
895
896

  while ($alive) {
897
898
899
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
900
901
      $info['timed_out'] = TRUE;
      break;
902
903
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
904
905
906
907
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
Dries's avatar
   
Dries committed
908
909
910
  }
  fclose($fp);

911
912
913
914
915
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
916
  // Parse response headers from the response body.
917
918
919
  // Be tolerant of malformed HTTP responses that separate header and body with
  // \n\n or \r\r instead of \r\n\r\n.
  list($response, $result->data) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
920
  $response = preg_split("/\r\n|\n|\r/", $response);
921

922
  // Parse the response status line.
923
924
925
926
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
   
Dries committed
927
928
  $result->headers = array();

929
930
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
931
932
933
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
934
935
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
936
      $result->headers[$name] .= ',' . trim($value);
937
938
    }
    else {
939
      $result->headers[$name] = trim($value);
940
    }
Dries's avatar
   
Dries committed
941
942
943
  }

  $responses = array(
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
    100 => 'Continue',
    101 => 'Switching Protocols',
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    307 => 'Temporary Redirect',
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Time-out',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Large',
    415 => 'Unsupported Media Type',
    416 => 'Requested range not satisfiable',
    417 => 'Expectation Failed',
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Time-out',
    505 => 'HTTP Version not supported',
Dries's avatar
   
Dries committed
984
  );
985
986
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
Dries's avatar
   
Dries committed
987
988
989
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
990
  $result->code = $code;
Dries's avatar
   
Dries committed
991
992
993
994
995
996
997
998

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
999
      $location = $result->headers['location'];
1000
1001
1002
1003
1004
1005
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
1006
1007
1008
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
1009
        $result->redirect_code = $code;
Dries's avatar
   
Dries committed
1010
      }
1011
1012
1013
      if (!isset($result->redirect_url)) {
        $result->redirect_url = $location;
      }
Dries's avatar
   
Dries committed
1014
1015
      break;
    default:
1016
      $result->error = $status_message;
Dries's avatar
   
Dries committed
1017
1018
1019
1020
  }

  return $result;
}
Dries's avatar
   
Dries committed
1021
1022
1023
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
1024

1025
1026
1027
1028
1029
1030
1031
1032
/**
 * Strips slashes from a string or array of strings.
 *
 * Callback for array_walk() within fix_gpx_magic().
 *
 * @param $item
 *   An individual string or array of strings from superglobals.
 */
Dries's avatar
   
Dries committed
1033
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
1034
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
1035
1036
1037
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
1038
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
1039
1040
1041
  }
}

1042
/**
1043
1044
1045
 * Strips slashes from $_FILES items.
 *
 * Callback for array_walk() within fix_gpc_magic().
1046
 *
1047
1048
1049
1050
1051
1052
1053
1054
 * The tmp_name key is skipped keys since PHP generates single backslashes for
 * file paths on Windows systems.
 *
 * @param $item
 *   An item from $_FILES.
 * @param $key
 *   The key for the item within $_FILES.
 *
1055
 * @see http://php.net/manual/features.file-upload.php#42280
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 */
function _fix_gpc_magic_files(&$item, $key) {
  if ($key != 'tmp_name') {
    if (is_array($item)) {
      array_walk($item, '_fix_gpc_magic_files');
    }
    else {
      $item = stripslashes($item);
    }
  }
}

Dries's avatar
   
Dries committed
1068
/**
1069
1070
1071
1072
 * Fixes double-escaping caused by "magic quotes" in some PHP installations.
 *
 * @see _fix_gpc_magic()
 * @see _fix_gpc_magic_files()
Dries's avatar
   
Dries committed
1073
 */
Dries's avatar
   
Dries committed
1074
function fix_gpc_magic() {
1075
  static $fixed = FALSE;
Dries's avatar
   
Dries committed
1076
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
1077
1078
1079
1080
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
1081
    array_walk($_FILES, '_fix_gpc_magic_files');
Dries's avatar
Dries committed
1082
  }
1083
  $fixed = TRUE;
Dries's avatar
   
Dries committed
1084
1085
}

Kjartan's avatar
Kjartan committed
1086
/**
Dries's avatar
   
Dries committed
1087
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
1088
 * @{
Dries's avatar
   
Dries committed
1089
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
1090
1091
 */

1092
/**
1093
 * Verifies the syntax of the given e-mail address.
Dries's avatar
   
Dries committed
1094
1095
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
1096
 *
Dries's avatar
   
Dries committed
1097
 * @param $mail
1098
 *   A string containing an e-mail address.
1099
 *
Dries's avatar
   
Dries committed
1100
 * @return
Dries's avatar
   
Dries committed
1101
 *   TRUE if the address is in a valid format.
1102
 */
Dries's avatar
   
Dries committed
1103
function valid_email_address($mail) {
1104
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1105
1106
}

Dries's avatar
   
Dries committed
1107
/**
1108
 * Verifies the syntax of the given URL.
Dries's avatar
   
Dries committed
1109
 *
1110
1111
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1112
 * Valid values per RFC 3986.
Dries's avatar
   
Dries committed
1113
 * @param $url
Dries's avatar
   
Dries committed
1114
 *   The URL to verify.
Dries's avatar
   
Dries committed
1115
 * @param $absolute
Dries's avatar
   
Dries committed
1116
 *   Whether the URL is absolute (beginning with a scheme such as "http:").