common.inc 285 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
45
46
47
48
49
50
51
52
53
54
55
56
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

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

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

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

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

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

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

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

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

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

94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/**
 * 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.
 */

/**
 * 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.
 */
define('DRUPAL_NO_CACHE', -1);

/**
 * 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.
 */
define('DRUPAL_CACHE_CUSTOM', -2);

/**
 * The block or element can change depending on the roles the user viewing the
 * page belongs to. This is the default setting for blocks, used when the block
 * does not specify anything.
 */
define('DRUPAL_CACHE_PER_ROLE', 0x0001);

/**
 * The block or element can change depending on the user viewing the page.
 * 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.
 */
define('DRUPAL_CACHE_PER_USER', 0x0002);

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

/**
 * The block or element is the same for every user on every page where it is visible.
 */
define('DRUPAL_CACHE_GLOBAL', 0x0008);

153
/**
154
 * Add content to a specified region.
155
156
 *
 * @param $region
157
 *   Page region the content is added to.
158
 * @param $data
159
 *   Content to be added.
160
 */
161
function drupal_add_region_content($region = NULL, $data = NULL) {
162
163
  static $content = array();

164
  if (isset($region) && isset($data)) {
165
166
167
168
169
170
    $content[$region][] = $data;
  }
  return $content;
}

/**
171
 * Get assigned content for a given region.
172
173
 *
 * @param $region
174
175
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
176
 * @param $delimiter
177
 *   Content to be inserted between imploded array elements.
178
 */
179
180
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
181
182
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
183
      return implode($delimiter, $content[$region]);
184
    }
185
186
187
188
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
189
        $content[$region] = implode($delimiter, $content[$region]);
190
191
192
193
194
195
      }
    }
    return $content;
  }
}

196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/**
 * Get the name of the currently active install profile.
 *
 * 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
 * table contains the name of the current profile, and we can call variable_get()
 * to determine what one is active.
 *
 * @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 {
215
    $profile = variable_get('install_profile', 'standard');
216
217
218
219
220
221
  }

  return $profile;
}


Dries's avatar
   
Dries committed
222
/**
Dries's avatar
   
Dries committed
223
 * Set the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
224
 *
Dries's avatar
   
Dries committed
225
226
227
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
228
 */
Dries's avatar
   
Dries committed
229
function drupal_set_breadcrumb($breadcrumb = NULL) {
230
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
   
Dries committed
231

232
  if (isset($breadcrumb)) {
Dries's avatar
   
Dries committed
233
234
235
236
237
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
238
239
240
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
   
Dries committed
241
242
243
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

251
/**
252
 * Returns a string containing RDF namespace declarations for use in XML and
253
 * XHTML output.
254
255
256
 */
function drupal_get_rdf_namespaces() {
  $xml_rdf_namespaces = array();
257
258
259
260
261
262

  // Serializes the RDF namespaces in XML namespace syntax.
  if (function_exists('rdf_get_namespaces')) {
    foreach (rdf_get_namespaces() as $prefix => $uri) {
      $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
    }
263
  }
264
  return count($xml_rdf_namespaces) ? "\n  " . implode("\n  ", $xml_rdf_namespaces) : '';
265
266
}

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

288
289
290
291
292
293
294
295
296
297
  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
298
299
300
301
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
302
/**
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 * 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(
      'http-equiv' => 'Content-Type',
      'content' => 'text/html; charset=utf-8',
    ),
    // 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;
}

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

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

357
  if (isset($url)) {
358
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
359

360
361
362
363
364
365
366
367
    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)),
    ));
368
369
370
371
372
373
374
375
  }
  return $stored_feed_links;
}

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

Dries's avatar
   
Dries committed
383
/**
384
 * @defgroup http_handling HTTP handling
Dries's avatar
   
Dries committed
385
 * @{
Dries's avatar
   
Dries committed
386
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
387
388
 */

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

416
  $params = array();
417
  foreach ($query as $key => $value) {
418
419
420
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
421
422
    }

423
424
425
426
427
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
428
    }
429
430
431
432
433
  }

  return $params;
}

434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/**
 * Split an URL-encoded query string into an array.
 *
 * @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;
}

454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
/**
 * Parse an array into a valid, rawurlencoded query string.
 *
 * 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));
477

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

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

495
/**
496
 * Prepare a 'destination' URL query parameter for use in combination with drupal_goto().
497
 *
498
499
500
501
 * 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.
502
503
504
505
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
506
507
508
509
510
511
  $destination = &drupal_static(__FUNCTION__);

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

512
  if (isset($_GET['destination'])) {
513
    $destination = array('destination' => $_GET['destination']);
514
515
  }
  else {
516
517
    $path = $_GET['q'];
    $query = drupal_http_build_query(drupal_get_query_parameters());
518
    if ($query != '') {
519
      $path .= '?' . $query;
520
    }
521
522
523
524
525
526
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
527
528
529
530
531
 * Wrapper around parse_url() to parse a system URL string into an associative array, suitable for url().
 *
 * 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.
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
580
581
582
583
584
 *
 * 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 {
585
586
587
588
589
    // 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);
590
591
592
593
594
595
596
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }
597
598
599
600
601
602
603
  // 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']);
  }
604
605
606
607
608

  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
/**
Dries's avatar
   
Dries committed
624
 * Send 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
 *   A Drupal path or a full URL.
647
648
 * @param $options
 *   An associative array of additional URL options to pass to url().
649
650
651
652
653
654
655
656
 * @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
657
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
658
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
659
 *   supported.
660
 *
661
 * @see drupal_get_destination()
662
 * @see url()
Kjartan's avatar
Kjartan committed
663
 */
664
665
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
666
667
  // 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'])) {
668
    $destination = drupal_parse_url($_GET['destination']);
669
670
671
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
672
673
  }

674
675
676
677
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

679
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
680

681
  header('Location: ' . $url, TRUE, $http_response_code);
682
683

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

689
/**
690
691
692
693
694
695
 * Deliver a "site is under maintenance" message to the browser.
 *
 * 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().
696
697
 */
function drupal_site_offline() {
698
  drupal_deliver_page(MENU_SITE_OFFLINE);
699
700
}

Kjartan's avatar
Kjartan committed
701
/**
702
703
704
705
706
707
 * Deliver a "page not found" error to the browser.
 *
 * 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
708
 */
Dries's avatar
   
Dries committed
709
function drupal_not_found() {
710
  drupal_deliver_page(MENU_NOT_FOUND);
Dries's avatar
   
Dries committed
711
}
Dries's avatar
   
Dries committed
712

Dries's avatar
   
Dries committed
713
/**
714
715
716
717
718
719
 * Deliver a "access denied" error to the browser.
 *
 * 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
 * bubble up to menu_execute_active_handler() should call drupal_access_denied().
Dries's avatar
   
Dries committed
720
721
 */
function drupal_access_denied() {
722
  drupal_deliver_page(MENU_ACCESS_DENIED);
Dries's avatar
   
Dries committed
723
724
}

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

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

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

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

782
783
784
785
786
787
788
789
  timer_start(__FUNCTION__);

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

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

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

    // 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.
836
    // See system_requirements()
837
838
    variable_set('drupal_http_request_fails', TRUE);

Dries's avatar
   
Dries committed
839
840
841
    return $result;
  }

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

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

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

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

867
868
869
870
871
872
  // 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.
873
874
875
  $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']);
876
877
  }

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

891
892
893
894
895
  // 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'];
896
  $response = '';
897
898

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

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

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

Dries's avatar
   
Dries committed
929
930
  $result->headers = array();

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

  $responses = array(
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
    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
986
  );
987
988
  // 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
989
990
991
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
992
  $result->code = $code;
Dries's avatar
   
Dries committed
993
994
995
996
997
998
999
1000

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

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

Dries's avatar
   
Dries committed
1027
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
1028
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
1029
1030
1031
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
1032
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
1033
1034
1035
  }
}

1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
/**
 * Helper function to strip slashes from $_FILES skipping over the tmp_name keys
 * since PHP generates single backslashes for file paths on Windows systems.
 *
 * tmp_name does not have backslashes added see
 * http://php.net/manual/en/features.file-upload.php#42280
 */
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
1054
/**
1055
 * Fix double-escaping problems caused by "magic quotes" in some PHP installations.
Dries's avatar
   
Dries committed
1056
 */
Dries's avatar
   
Dries committed
1057
function fix_gpc_magic() {
1058
  static $fixed = FALSE;
Dries's avatar
   
Dries committed
1059
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
1060
1061
1062
1063
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
1064
    array_walk($_FILES, '_fix_gpc_magic_files');
Dries's avatar
Dries committed
1065
  }
1066
  $fixed = TRUE;
Dries's avatar
   
Dries committed
1067
1068
}

Kjartan's avatar
Kjartan committed
1069
/**
Dries's avatar
   
Dries committed
1070
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
1071
 * @{
Dries's avatar
   
Dries committed
1072
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
1073
1074
 */

1075
/**
Dries's avatar
   
Dries committed
1076
1077
1078
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
1079
 *
Dries's avatar
   
Dries committed
1080
 * @param $mail
1081
 *   A string containing an e-mail address.
Dries's avatar
   
Dries committed
1082
 * @return
Dries's avatar
   
Dries committed
1083
 *   TRUE if the address is in a valid format.
1084
 */
Dries's avatar
   
Dries committed
1085
function valid_email_address($mail) {
1086
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1087
1088
}

Dries's avatar
   
Dries committed
1089
1090
1091
/**
 * Verify the syntax of the given URL.
 *
1092
1093
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1094
 * Valid values per RFC 3986.
Dries's avatar
   
Dries committed
1095
 * @param $url
Dries's avatar
   
Dries committed
1096
 *   The URL to verify.
Dries's avatar
   
Dries committed
1097
 * @param $absolute
Dries's avatar
   
Dries committed
1098
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
1099
 * @return
Dries's avatar
   
Dries committed
1100
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
1101
 */
Dries's avatar
   
Dries committed
1102
function valid_url($url, $absolute = FALSE) {
1103
  if ($absolute) {
1104
    return (bool)preg_match("
1105
      /^                                                      # Start at the beginning of the text
1106
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1107
1108
1109
      (?:                                                     # Userinfo (optional) which is typically
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
1110
      )?
1111
1112
1113
1114
1115
1116
      (?:
        (?:[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)
      (?:[\/|\?]
1117
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
1118
      *)?
1119
    $/xi", $url);
1120
1121
  }
  else {
1122
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
1123
  }
Dries's avatar
   
Dries committed
1124
1125
}

1126
1127
1128
1129
/**
 * @} End of "defgroup validation".
 */

Dries's avatar
   
Dries committed
1130
/**
1131
 * Register an event for the current visitor to the flood control mechanism.
Dries's avatar
   
Dries committed
1132
1133
 *
 * @param $name
1134
 *   The name of an event.
1135
1136
1137
1138
1139
 * @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.
1140
1141
 * @param $identifier
 *   Optional identifier (defaults to the current user's IP address).
Dries's avatar
   
Dries committed
1142
 */
1143
function flood_register_event($name, $window = 3600, $identifier = NULL) {
1144
1145
1146
  if (!isset($identifier)) {
    $identifier = ip_address();
  }
1147
1148
1149
  db_insert('flood')
    ->fields(array(
      'event' => $name,
1150
      'identifier' => $identifier,
1151
      'timestamp' => REQUEST_TIME,
1152
      'expiration' => REQUEST_TIME + $window,
1153
1154
    ))
    ->execute();
Dries's avatar
   
Dries committed
1155
1156
1157
}

/**
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 * Make the flood control mechanism forget about an event for the current visitor.
 *
 * @param $name
 *   The name of an event.
 * @param $identifier
 *   Optional identifier (defaults to the current user's IP address).
 */
function flood_clear_event($name, $identifier = NULL) {
  if (!isset($identifier)) {
    $identifier = ip_address();
  }
  db_delete('flood')
    ->condition('event', $name)
    ->condition('identifier', $identifier)
    ->execute();
}

/**
1176
 * Checks whether user is allowed to proceed with the specified event.
1177
 *
1178
1179
1180
 * Events can have thresholds saying that each user can only do that event
 * a certain number of times in a time window. This function verifies that the
 * current user has not exceeded this threshold.
Dries's avatar
   
Dries committed
1181
1182
 *
 * @param $name
1183
 *   The unique name of the event.
1184
 * @param $threshold
1185
 *   The maximum number of times each user can do this event per time window.