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

Dries's avatar
   
Dries committed
3
4
5
6
7
8
9
10
/**
 * @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.
 */

11
12
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
/**
 * @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
 *
39
 * @}
40
41
 */

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

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

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

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

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

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

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

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

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

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

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

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/**
 * 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.
 */

/**
118
119
120
121
122
123
124
 * 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.
125
 */
126
const DRUPAL_NO_CACHE = -1;
127
128

/**
129
130
131
132
133
 * 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.
134
 */
135
const DRUPAL_CACHE_CUSTOM = -2;
136
137

/**
138
139
140
141
 * 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.
142
 */
143
const DRUPAL_CACHE_PER_ROLE = 0x0001;
144
145

/**
146
147
 * The block or element can change depending on the user.
 *
148
149
150
 * 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.
 */
151
const DRUPAL_CACHE_PER_USER = 0x0002;
152
153
154
155

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

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

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

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

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

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

  return $profile;
}


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

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

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

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

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

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

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

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

  return $params;
}

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

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

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

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

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

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

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

/**
520
 * Parses a system URL string into an associative array suitable for url().
521
522
523
524
 *
 * 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.
525
526
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
 *
 * 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 {
578
579
580
581
582
    // 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);
583
584
585
586
587
588
589
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }
590
591
592
593
594
595
596
  // 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']);
  }
597
598
599
600
601

  return $options;
}

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

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

667
668
669
670
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

672
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
673

674
  header('Location: ' . $url, TRUE, $http_response_code);
675
676

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

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

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

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

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

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

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

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

776
777
778
779
780
781
782
783
  timer_start(__FUNCTION__);

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

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

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

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

Dries's avatar
   
Dries committed
833
834
835
    return $result;
  }

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

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
923
924
  $result->headers = array();

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

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

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
995
      $location = $result->headers['location'];
996
997
998
999
1000
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
For faster browsing, not all history is shown. View entire blame