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

3
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
4
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
5
use Drupal\Core\Database\Database;
6

Dries's avatar
   
Dries committed
7
8
9
10
11
12
13
14
/**
 * @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.
 */

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
41
42
/**
 * @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
 *
43
 * @}
44
45
 */

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

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

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

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

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

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

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

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

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

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

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

103
104
105
106
107
108
109
110
111
112
/**
 * 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
 *
113
114
115
116
117
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the 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.
118
119
120
121
122
 *
 * Note that user 1 is excluded from block caching.
 */

/**
123
124
125
126
127
128
129
 * 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.
130
 */
131
const DRUPAL_NO_CACHE = -1;
132
133

/**
134
135
136
137
138
 * 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.
139
 */
140
const DRUPAL_CACHE_CUSTOM = -2;
141
142

/**
143
144
145
146
 * 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.
147
 */
148
const DRUPAL_CACHE_PER_ROLE = 0x0001;
149
150

/**
151
152
 * The block or element can change depending on the user.
 *
153
154
155
 * 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.
 */
156
const DRUPAL_CACHE_PER_USER = 0x0002;
157
158
159
160

/**
 * The block or element can change depending on the page being viewed.
 */
161
const DRUPAL_CACHE_PER_PAGE = 0x0004;
162
163

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

168
169
170
171
172
173
174
175
176
/**
 * 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";

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

188
  if (isset($region) && isset($data)) {
189
190
191
192
193
194
    $content[$region][] = $data;
  }
  return $content;
}

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

220
/**
221
 * Gets the name of the currently active install profile.
222
223
224
225
 *
 * 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
226
227
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
228
229
230
231
232
233
234
235
236
237
238
 *
 * @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 {
239
    $profile = variable_get('install_profile', 'standard');
240
241
242
243
244
245
  }

  return $profile;
}


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

256
  if (isset($breadcrumb)) {
Dries's avatar
   
Dries committed
257
258
259
260
261
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

268
  if (!isset($breadcrumb)) {
Dries's avatar
   
Dries committed
269
270
271
272
273
274
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
275
/**
276
 * Adds output to the HEAD tag of the HTML page.
277
 *
278
 * This function can be called as long as the headers aren't sent. Pass no
279
280
281
282
283
284
285
286
287
288
289
290
291
 * 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
292
 */
293
294
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
295

296
297
298
299
300
301
302
303
304
305
  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
306
307
308
309
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
310
/**
311
312
313
314
315
316
317
318
319
320
 * 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(
321
      'charset' => 'utf-8',
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
    ),
    // 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;
}

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

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

364
  if (isset($url)) {
365
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
366

367
368
369
370
371
372
373
374
    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)),
    ));
375
376
377
378
379
  }
  return $stored_feed_links;
}

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

Dries's avatar
   
Dries committed
390
/**
391
 * @defgroup http_handling HTTP handling
Dries's avatar
   
Dries committed
392
 * @{
Dries's avatar
   
Dries committed
393
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
394
395
 */

396
/**
397
 * Processes a URL query parameter array to remove unwanted elements.
398
399
 *
 * @param $query
400
 *   (optional) An array to be processed. Defaults to $_GET.
401
 * @param $exclude
402
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
403
 *   exclude nested items.
404
 * @param $parent
405
406
 *   Internal use only. Used to build the $query array key for nested items.
 *
407
 * @return
408
 *   An array containing query parameters, which can be used for url().
409
 */
410
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
411
412
413
414
415
416
417
418
419
420
421
  // 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);
  }
422

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

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

  return $params;
}

441
/**
442
 * Splits a URL-encoded query string into an array.
443
444
445
446
447
448
449
450
451
452
453
454
 *
 * @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);
455
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
456
457
458
459
460
    }
  }
  return $result;
}

461
/**
462
 * Parses an array into a valid, rawurlencoded query string.
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 *
 * 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));
484

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

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

502
/**
503
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
504
 *
505
506
507
508
 * 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.
509
510
511
512
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
513
514
515
516
517
518
  $destination = &drupal_static(__FUNCTION__);

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

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

/**
534
 * Parses a system URL string into an associative array suitable for url().
535
536
 *
 * This function should only be used for URLs that have been generated by the
537
538
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
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
589
590
591
 *
 * 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 {
592
593
594
595
596
    // 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);
597
598
599
600
601
602
603
604
605
606
607
608
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

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

Kjartan's avatar
Kjartan committed
623
/**
624
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
625
 *
Dries's avatar
   
Dries committed
626
627
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
628
 *
629
630
631
632
633
634
 * 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
635
636
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
637
 * @endcode
638
 *
639
640
 * 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
641
 *
642
643
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
644
645
 *
 * @param $path
646
647
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
648
 * @param $options
649
 *   (optional) An associative array of additional URL options to pass to url().
650
 * @param $http_response_code
651
652
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
653
654
655
656
657
658
659
660
661
662
 *   @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
 *   and the
 *   @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
 *   - 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.
 *   - 307: Temporary Redirect.
663
 *
664
 * @see drupal_get_destination()
665
 * @see url()
Kjartan's avatar
Kjartan committed
666
 */
667
668
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
669
670
  // 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'])) {
671
    $destination = drupal_parse_url($_GET['destination']);
672
673
674
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
675
676
  }

677
678
679
680
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

682
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
683

684
  header('Location: ' . $url, TRUE, $http_response_code);
685
686

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

Dries's avatar
   
Dries committed
692
/**
693
 * Performs an HTTP request.
Dries's avatar
   
Dries committed
694
 *
695
696
 * 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
697
698
699
 *
 * @param $url
 *   A string containing a fully qualified URI.
700
701
702
703
704
705
706
707
708
709
710
711
 * @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().
712
 *
713
714
715
716
717
718
719
720
721
722
 * @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.
723
724
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
725
726
727
728
729
 *   - 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
730
 */
731
function drupal_http_request($url, array $options = array()) {
732
  $result = new stdClass();
Dries's avatar
   
Dries committed
733

734
735
736
737
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
738
    $result->error = 'unable to parse URL';
739
    $result->code = -1001;
740
741
742
    return $result;
  }

743
744
745
746
747
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
748

749
750
751
752
753
754
755
756
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
757
758
    'timeout' => 30.0,
    'context' => NULL,
759
  );
760
761
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
762

Dries's avatar
   
Dries committed
763
764
  switch ($uri['scheme']) {
    case 'http':
765
    case 'feed':
Dries's avatar
Dries committed
766
      $port = isset($uri['port']) ? $uri['port'] : 80;
767
768
769
770
771
      $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
772
773
      break;
    case 'https':
774
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
775
      $port = isset($uri['port']) ? $uri['port'] : 443;
776
777
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
   
Dries committed
778
779
      break;
    default:
780
      $result->error = 'invalid schema ' . $uri['scheme'];
781
      $result->code = -1003;
Dries's avatar
   
Dries committed
782
783
784
      return $result;
  }

785
786
787
788
789
790
791
792
  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
793
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
794
  if (!$fp) {
795
796
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
797
    $result->code = -$errno;
798
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries's avatar
   
Dries committed
799
800
801
    return $result;
  }

Dries's avatar
   
Dries committed
802
  // Construct the path to act on.
Dries's avatar
Dries committed
803
804
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
805
    $path .= '?' . $uri['query'];
Dries's avatar
   
Dries committed
806
807
  }

808
809
810
  // Merge the default headers.
  $options['headers'] += array(
    'User-Agent' => 'Drupal (+http://drupal.org/)',
Dries's avatar
   
Dries committed
811
812
  );

813
814
815
816
  // 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.
817
818
819
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
820
821
822
  }

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

827
828
829
830
831
832
  // 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.
833
834
835
  $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']);
836
837
  }

838
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
839
  foreach ($options['headers'] as $name => $value) {
840
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
   
Dries committed
841
  }
842
  $request .= "\r\n" . $options['data'];
Dries's avatar
   
Dries committed
843
  $result->request = $request;
844
845
846
847
848
849
  // 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
850

851
852
853
854
855
  // 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'];
856
  $response = '';
857
858

  while ($alive) {
859
860
861
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
862
863
      $info['timed_out'] = TRUE;
      break;
864
865
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
866
867
868
869
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
Dries's avatar
   
Dries committed
870
871
872
  }
  fclose($fp);

873
874
875
876
877
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
878
  // Parse response headers from the response body.
879
880
881
  // 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);
882
  $response = preg_split("/\r\n|\n|\r/", $response);
883

884
  // Parse the response status line.
885
886
887
888
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
   
Dries committed
889
890
  $result->headers = array();

891
892
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
893
894
895
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
896
897
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
898
      $result->headers[$name] .= ',' . trim($value);
899
900
    }
    else {
901
      $result->headers[$name] = trim($value);
902
    }
Dries's avatar
   
Dries committed
903
904
905
  }

  $responses = array(
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
    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
946
  );
947
948
  // 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
949
950
951
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
952
  $result->code = $code;
Dries's avatar
   
Dries committed
953
954
955
956
957
958
959
960

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
961
      $location = $result->headers['location'];
962
963
964
965
966
967
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
968
969
970
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
971
        $result->redirect_code = $code;
Dries's avatar
   
Dries committed
972
      }
973
974
975
      if (!isset($result->redirect_url)) {
        $result->redirect_url = $location;
      }
Dries's avatar
   
Dries committed
976
977
      break;
    default:
978
      $result->error = $status_message;
Dries's avatar
   
Dries committed
979
980
981
982
  }

  return $result;
}
Dries's avatar
   
Dries committed
983
/**
984
 * @} End of "defgroup http_handling".
Dries's avatar
   
Dries committed
985
 */
Dries's avatar
   
Dries committed
986

Kjartan's avatar
Kjartan committed
987
/**
Dries's avatar
   
Dries committed
988
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
989
 * @{
Dries's avatar
   
Dries committed
990
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
991
992
 */

993
/**
994
 * Verifies the syntax of the given e-mail address.
Dries's avatar
   
Dries committed
995
 *
996
 * See @link http://tools.ietf.org/html/rfc5321 RFC 5321 @endlink for details.
997
 *
Dries's avatar
   
Dries committed
998
 * @param $mail
999
 *   A string containing an e-mail address.
1000
 *
Dries's avatar
   
Dries committed
1001
 * @return
Dries's avatar
   
Dries committed
1002
 *   TRUE if the address is in a valid format.
1003
 */
Dries's avatar
   
Dries committed
1004
function valid_email_address($mail) {
1005
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1006
1007
}

Dries's avatar
   
Dries committed
1008
/**
1009
 * Verifies the syntax of the given URL.
Dries's avatar
   
Dries committed
1010
 *
1011
1012
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1013
 * Valid values per RFC 3986.
Dries's avatar
   
Dries committed
1014
 * @param $url
Dries's avatar
   
Dries committed
1015
 *   The URL to verify.
Dries's avatar
   
Dries committed
1016
 * @param $absolute
Dries's avatar
   
Dries committed
1017
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
1018
 *
Dries's avatar
   
Dries committed
1019
 * @return
Dries's avatar
   
Dries committed
1020
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
1021
 */
Dries's avatar
   
Dries committed
1022
function valid_url($url, $absolute = FALSE) {
1023
  if ($absolute) {
1024
    return (bool)preg_match("
1025
      /^                                                      # Start at the beginning of the text
1026
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1027
1028
1029
      (?:                                                     # Userinfo (optional) which is typically
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
1030
      )?
1031
1032
1033
1034
1035
1036
      (?:
        (?:[a-z0-9\-\.]|%[0-9a-f]{2})+                        # A domain name or a IPv4 address
        |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\])         # or a well formed IPv6 address
      )
      (?::[0-9]+)?                                            # Server port number (optional)
      (?:[\/|\?]
1037
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
1038
      *)?
1039
    $/xi", $url);
1040
1041
  }
  else {
1042
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
1043
  }
Dries's avatar
   
Dries committed
1044
1045
}

1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
/**
 * Verifies that a number is a multiple of a given step.
 *
 * The implementation assumes it is dealing with IEEE 754 double precision
 * floating point numbers that are used by PHP on most systems.
 *
 * This is based on the number/range verification methods of webkit.
 *
 * @param $value
 *   The value that needs to be checked.
 * @param $step
 *   The step scale factor. Must be positive.
 * @param $offset
 *   (optional) An offset, to which the difference must be a multiple of the
 *   given step.
 *
 * @return bool
 *   TRUE if no step mismatch has occured, or FALSE otherwise.
 *
 * @see http://opensource.apple.com/source/WebCore/WebCore-1298/html/NumberInputType.cpp
 */
function valid_number_step($value, $step, $offset = 0.0) {
  $double_value = (double) abs($value - $offset);

  // The fractional part of a double has 53 bits. The greatest number that could
  // be represented with that is 2^53. If the given value is even bigger than
  // $step * 2^53, then dividing by $step will result in a very small remainder.
  // Since that remainder can't even be represented with a single precision
  // float the following computation of the remainder makes no sense and we can
  // safely ignore it instead.
  if ($double_value / pow(2.0, 53) > $step) {
    return TRUE;
  }

  // Now compute that remainder of a division by $step.
  $remainder = (double) abs($double_value - $step * round($double_value / $step));

  // $remainder is a double precision floating point number. Remainders that
  // can't be represented with single precision floats are acceptable. The
  // fractional part of a float has 24 bits. That means remainders smaller than
  // $step * 2^-24 are acceptable.
  $computed_acceptable_error = (double)($step / pow(2.0, 24));

  return $computed_acceptable_error >= $remainder || $remainder >= ($step - $computed_acceptable_error);
}

1092
1093
1094
1095
/**
 * @} End of "defgroup validation".
 */

Dries's avatar
   
Dries committed
1096
/**
1097
 * Registers an event for the current visitor to the flood control mechanism.
Dries's avatar
   
Dries committed
1098
1099
 *
 * @param $name
1100
 *   The name of an event.
1101
1102
1103
1104
1105
 * @param $window
 *   Optional number of seconds before this event expires. Defaults to 3600 (1
 *   hour). Typically uses the same value as the flood_is_allowed() $window
 *   parameter. Expired events are purged on cron run to prevent the flood table
 *   from growing indefinitely.
1106
1107
 * @param $identifier
 *   Optional identifier (defaults to the current user's IP address).
Dries's avatar
   
Dries committed
1108
 */
1109
function flood_register_event($name, $window = 3600, $identifier = NULL) {
1110
1111
1112
  if (!isset($identifier)) {
    $identifier = ip_address();
  }
1113
1114
1115
  db_insert('flood')
    ->fields(array(
      'event' => $name,
1116
      'identifier' => $identifier,
1117
      'timestamp' => REQUEST_TIME,
1118
      'expiration' => REQUEST_TIME + $window,
1119
1120
    ))
    ->execute();
Dries's avatar
    <