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

3
4
use Drupal\Database\Database;

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
 * Adds content to a specified region.
167
168
 *
 * @param $region
169
 *   Page region the content is added to.
170
 * @param $data
171
 *   Content to be added.
172
 */
173
function drupal_add_region_content($region = NULL, $data = NULL) {
174
175
  static $content = array();

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

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

208
/**
209
 * Gets the name of the currently active install profile.
210
211
212
213
 *
 * 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
214
215
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
216
217
218
219
220
221
222
223
224
225
226
 *
 * @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 {
227
    $profile = variable_get('install_profile', 'standard');
228
229
230
231
232
233
  }

  return $profile;
}


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

244
  if (isset($breadcrumb)) {
Dries's avatar
   
Dries committed
245
246
247
248
249
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
250
/**
251
 * Gets the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
252
 */
Dries's avatar
   
Dries committed
253
254
255
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

Dries's avatar
Dries committed
263
/**
264
 * Adds output to the HEAD tag of the HTML page.
265
 *
266
 * This function can be called as long as the headers aren't sent. Pass no
267
268
269
270
271
272
273
274
275
276
277
278
279
 * 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
280
 */
281
282
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
283

284
285
286
287
288
289
290
291
292
293
  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
294
295
296
297
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
298
/**
299
300
301
302
303
304
305
306
307
308
 * 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(
309
      'charset' => 'utf-8',
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
    ),
    // 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;
}

/**
331
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
   
Dries committed
332
 */
Dries's avatar
Dries committed
333
function drupal_get_html_head() {
334
335
336
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
337
338
}

339
/**
340
 * Adds a feed URL for the current page.
341
 *
342
343
 * This function can be called as long the HTML header hasn't been sent.
 *
344
 * @param $url
345
 *   An internal system path or a fully qualified external URL of the feed.
346
 * @param $title
347
 *   The title of the feed.
348
 */
349
function drupal_add_feed($url = NULL, $title = '') {
350
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
351

352
  if (isset($url)) {
353
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
354

355
356
357
358
359
360
361
362
    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)),
    ));
363
364
365
366
367
  }
  return $stored_feed_links;
}

/**
368
 * Gets the feed URLs for the current page.
369
370
 *
 * @param $delimiter
371
 *   A delimiter to split feeds by.
372
373
374
375
376
377
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
378
/**
379
 * @defgroup http_handling HTTP handling
Dries's avatar
   
Dries committed
380
 * @{
Dries's avatar
   
Dries committed
381
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
382
383
 */

384
/**
385
 * Processes a URL query parameter array to remove unwanted elements.
386
387
 *
 * @param $query
388
 *   (optional) An array to be processed. Defaults to $_GET.
389
 * @param $exclude
390
391
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
 *   exclude nested items. Defaults to array('q').
392
 * @param $parent
393
394
 *   Internal use only. Used to build the $query array key for nested items.
 *
395
 * @return
396
 *   An array containing query parameters, which can be used for url().
397
 */
398
399
400
401
402
403
404
405
406
407
408
409
function drupal_get_query_parameters(array $query = NULL, array $exclude = array('q'), $parent = '') {
  // 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);
  }
410

411
  $params = array();
412
  foreach ($query as $key => $value) {
413
414
415
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
416
417
    }

418
419
420
421
422
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
423
    }
424
425
426
427
428
  }

  return $params;
}

429
/**
430
 * Splits a URL-encoded query string into an array.
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 *
 * @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;
}

449
/**
450
 * Parses an array into a valid, rawurlencoded query string.
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 *
 * 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));
472

473
    // Recurse into children.
474
    if (is_array($value)) {
475
476
477
478
479
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
480
481
    }
    else {
482
483
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
484
485
486
487
488
489
    }
  }

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

490
/**
491
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
492
 *
493
494
495
496
 * 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.
497
498
499
500
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
501
502
503
504
505
506
  $destination = &drupal_static(__FUNCTION__);

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

507
  if (isset($_GET['destination'])) {
508
    $destination = array('destination' => $_GET['destination']);
509
510
  }
  else {
511
512
    $path = $_GET['q'];
    $query = drupal_http_build_query(drupal_get_query_parameters());
513
    if ($query != '') {
514
      $path .= '?' . $query;
515
    }
516
517
518
519
520
521
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
522
 * Parses a system URL string into an associative array suitable for url().
523
524
525
526
 *
 * This function should only be used for URLs that have been generated by the
 * system, resp. url(). It should not be used for URLs that come from external
 * sources, or URLs that link to external resources.
527
528
529
530
531
532
533
534
535
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
 *
 * 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 {
580
581
582
583
584
    // 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);
585
586
587
588
589
590
591
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }
592
593
594
595
596
597
598
  // The 'q' parameter contains the path of the current page if clean URLs are
  // disabled. It overrides the 'path' of the URL when present, even if clean
  // URLs are enabled, due to how Apache rewriting rules work.
  if (isset($options['query']['q'])) {
    $options['path'] = $options['query']['q'];
    unset($options['query']['q']);
  }
599
600
601
602
603

  return $options;
}

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

Kjartan's avatar
Kjartan committed
618
/**
619
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
620
 *
Dries's avatar
   
Dries committed
621
622
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
623
 *
624
625
626
627
628
629
 * 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
630
631
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
632
 * @endcode
633
 *
634
635
 * 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
636
 *
637
638
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
   
Dries committed
639
640
 *
 * @param $path
641
 *   A Drupal path or a full URL.
642
643
 * @param $options
 *   An associative array of additional URL options to pass to url().
644
645
646
647
648
649
650
651
 * @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
652
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
653
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
654
 *   supported.
655
 *
656
 * @see drupal_get_destination()
657
 * @see url()
Kjartan's avatar
Kjartan committed
658
 */
659
660
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
661
662
  // 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'])) {
663
    $destination = drupal_parse_url($_GET['destination']);
664
665
666
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
667
668
  }

669
670
671
672
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

674
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
675

676
  header('Location: ' . $url, TRUE, $http_response_code);
677
678

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

684
/**
685
 * Delivers a "site is under maintenance" message to the browser.
686
687
688
689
690
 *
 * 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().
691
692
 */
function drupal_site_offline() {
693
  drupal_deliver_page(MENU_SITE_OFFLINE);
694
695
}

Kjartan's avatar
Kjartan committed
696
/**
697
 * Delivers a "page not found" error to the browser.
698
699
700
701
702
 *
 * 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
703
 */
Dries's avatar
   
Dries committed
704
function drupal_not_found() {
705
  drupal_deliver_page(MENU_NOT_FOUND);
Dries's avatar
   
Dries committed
706
}
Dries's avatar
   
Dries committed
707

Dries's avatar
   
Dries committed
708
/**
709
 * Delivers an "access denied" error to the browser.
710
711
712
713
 *
 * 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
714
715
 * bubble up to menu_execute_active_handler() should call
 * drupal_access_denied().
Dries's avatar
   
Dries committed
716
717
 */
function drupal_access_denied() {
718
  drupal_deliver_page(MENU_ACCESS_DENIED);
Dries's avatar
   
Dries committed
719
720
}

Dries's avatar
   
Dries committed
721
/**
722
 * Performs an HTTP request.
Dries's avatar
   
Dries committed
723
 *
724
725
 * 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
726
727
728
 *
 * @param $url
 *   A string containing a fully qualified URI.
729
730
731
732
733
734
735
736
737
738
739
740
 * @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().
741
 *
742
743
744
745
746
747
748
749
750
751
 * @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.
752
753
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
754
755
756
757
758
 *   - 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
759
 */
760
function drupal_http_request($url, array $options = array()) {
761
  $result = new stdClass();
Dries's avatar
   
Dries committed
762

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

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

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

778
779
780
781
782
783
784
785
  timer_start(__FUNCTION__);

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

Dries's avatar
   
Dries committed
792
793
  switch ($uri['scheme']) {
    case 'http':
794
    case 'feed':
Dries's avatar
Dries committed
795
      $port = isset($uri['port']) ? $uri['port'] : 80;
796
797
798
799
800
      $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
801
802
      break;
    case 'https':
803
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
804
      $port = isset($uri['port']) ? $uri['port'] : 443;
805
806
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
   
Dries committed
807
808
      break;
    default:
809
      $result->error = 'invalid schema ' . $uri['scheme'];
810
      $result->code = -1003;
Dries's avatar
   
Dries committed
811
812
813
      return $result;
  }

814
815
816
817
818
819
820
821
  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
822
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
823
  if (!$fp) {
824
825
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
826
    $result->code = -$errno;
827
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
828
829
830
831

    // 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.
832
    // See system_requirements().
833
834
    variable_set('drupal_http_request_fails', TRUE);

Dries's avatar
   
Dries committed
835
836
837
    return $result;
  }

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

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

849
850
851
852
  // 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.
853
854
855
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
856
857
858
  }

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

863
864
865
866
867
868
  // 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.
869
870
871
  $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']);
872
873
  }

874
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
875
  foreach ($options['headers'] as $name => $value) {
876
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
   
Dries committed
877
  }
878
  $request .= "\r\n" . $options['data'];
Dries's avatar
   
Dries committed
879
  $result->request = $request;
880
881
882
883
884
885
  // 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
886

887
888
889
890
891
  // 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'];
892
  $response = '';
893
894

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

909
910
911
912
913
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
914
  // Parse response headers from the response body.
915
916
917
  // 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);
918
  $response = preg_split("/\r\n|\n|\r/", $response);
919

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

Dries's avatar
   
Dries committed
925
926
  $result->headers = array();

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

  $responses = array(
942
943
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
    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
982
  );
983
984
  // 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
985
986
987
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
988
  $result->code = $code;
Dries's avatar
   
Dries committed
989
990
991
992
993
994
995
996

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

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

1023
1024
1025
1026
1027
1028
1029
1030
/**
 * 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
1031
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
1032
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
1033
1034
1035
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
1036
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
1037
1038
1039
  }
}

1040
/**
1041
1042
1043
 * Strips slashes from $_FILES items.
 *
 * Callback for array_walk() within fix_gpc_magic().
1044
 *
1045
1046
1047
1048
1049
1050
1051
1052
1053
 * 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.
 *
 * @see http://php.net/manual/en/features.file-upload.php#42280
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 */
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
1066
/**
1067
1068
1069
1070
 * 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
1071
 */
Dries's avatar
   
Dries committed
1072
function fix_gpc_magic() {
1073
  static $fixed = FALSE;
Dries's avatar
   
Dries committed
1074
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
1075
1076
1077
1078
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
1079
    array_walk($_FILES, '_fix_gpc_magic_files');
Dries's avatar
Dries committed
1080
  }
1081
  $fixed = TRUE;
Dries's avatar
   
Dries committed
1082
1083
}

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

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

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