forked from backdrop/backdrop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
common.inc
9044 lines (8444 loc) · 321 KB
/
common.inc
1
2
3
4
5
6
7
8
9
10
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
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
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* Common functions that many Backdrop 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.
*/
/**
* @defgroup php_wrappers PHP wrapper functions
* @{
* Functions that are wrappers or custom implementations of PHP functions.
*
* Certain PHP functions should not be used in Backdrop. Instead, Backdrop's
* replacement functions should be used.
*
* For example, for improved or more secure UTF8-handling, or RFC-compliant
* handling of URLs in Backdrop.
*
* For ease of use and memorizing, all these wrapper functions use the same name
* as the original PHP function, but prefixed with "backdrop_". 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 = backdrop_substr($original_string, 0, 5);
* @endcode
*
* @}
*/
/**
* 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);
/**
* The default group for system CSS files added to the page.
*/
define('CSS_SYSTEM', -100);
/**
* The default group for module CSS files added to the page.
*/
define('CSS_DEFAULT', 0);
/**
* The default group for theme CSS files added to the page.
*/
define('CSS_THEME', 100);
/**
* The default group for JavaScript and jQuery libraries added to the page.
*/
define('JS_LIBRARY', -100);
/**
* The default group for module JavaScript code added to the page.
*/
define('JS_DEFAULT', 0);
/**
* The default group for theme JavaScript code added to the page.
*/
define('JS_THEME', 100);
/**
* The default group for JavaScript settings added to the page.
*/
define('JS_SETTING', -200);
/**
* Error code indicating that the request exceeded the specified timeout.
*
* @see backdrop_http_request()
*/
define('HTTP_REQUEST_TIMEOUT', -1);
/**
* @defgroup block_caching Block Caching
* @{
* Constants that define each block's caching state.
*
* Modules specify how their blocks can be cached in their hook_block_info()
* implementations. Caching can be turned off (BACKDROP_NO_CACHE), managed by
* the module declaring the block (BACKDROP_CACHE_CUSTOM), or managed by the
* core Block module. If the Block module is managing the cache, you can specify
* that the block is the same for every page and user (BACKDROP_CACHE_GLOBAL),
* or that it can change depending on the page (BACKDROP_CACHE_PER_PAGE) or by
* user (BACKDROP_CACHE_PER_ROLE or BACKDROP_CACHE_PER_USER). Page and user
* settings can be combined with a bitwise-binary or operator; for example,
* BACKDROP_CACHE_PER_ROLE | BACKDROP_CACHE_PER_PAGE means that the block can
* change depending on the user role or page it is on.
*
* 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 (BACKDROP_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('BACKDROP_NO_CACHE', -1);
/**
* The block is handling its own caching in its hook_block_view().
*
* This setting is useful when time based expiration is needed or a site uses a
* node access which invalidates standard block cache.
*/
define('BACKDROP_CACHE_CUSTOM', -2);
/**
* 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.
*/
define('BACKDROP_CACHE_PER_ROLE', 0x0001);
/**
* The block or element can change depending on the user.
*
* This setting can be resource-consuming for sites with large number of users,
* and thus should only be used when BACKDROP_CACHE_PER_ROLE is not sufficient.
*/
define('BACKDROP_CACHE_PER_USER', 0x0002);
/**
* The block or element can change depending on the page being viewed.
*/
define('BACKDROP_CACHE_PER_PAGE', 0x0004);
/**
* The block or element is the same for every user and page that it is visible.
*/
define('BACKDROP_CACHE_GLOBAL', 0x0008);
/**
* @} End of "defgroup block_caching".
*/
/**
* Gets the name of the currently active installation profile.
*
* When this function is called during Backdrop'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 Backdrop system.core
* config file contains the name of the current profile.
*
* @return $profile
* The name of the installation profile.
*/
function backdrop_get_profile() {
global $install_state;
if (isset($install_state['parameters']['profile'])) {
$profile = $install_state['parameters']['profile'];
}
else {
try {
$profile = config_get('system.core', 'install_profile');
}
catch (ConfigException $e) {}
}
if (empty($profile)) {
$profile = 'standard';
}
return $profile;
}
/**
* Sets the breadcrumb trail for the current page.
*
* @param array $breadcrumb
* Array of links, starting with "home" and proceeding up to but not including
* the current page.
*
* @return array
* The current breadcrumb trail array.
*/
function backdrop_set_breadcrumb($breadcrumb = NULL) {
$stored_breadcrumb = &backdrop_static(__FUNCTION__);
if (isset($breadcrumb)) {
$stored_breadcrumb = $breadcrumb;
}
return $stored_breadcrumb;
}
/**
* Gets the breadcrumb trail for the current page.
*/
function backdrop_get_breadcrumb() {
$breadcrumb = backdrop_set_breadcrumb();
if (!isset($breadcrumb)) {
$breadcrumb = menu_get_active_breadcrumb();
}
return $breadcrumb;
}
/**
* Gets the path and dimensions of the site wide logo.
*
* @return array
* An array containing "path", "width", and "height".
*/
function backdrop_get_logo_info() {
$info = array(
'path' => '',
'width' => NULL,
'height' => NULL,
);
// The logo may be needed on pages prior to config being ready, e.g. during
// installer or on maintenance pages. Default to an empty string if unable to
// load the configuration.
try {
$site_config = config('system.core');
if ($site_config->get('site_logo_theme')) {
global $theme;
$theme_data = list_themes();
$theme_object = $theme_data[$theme];
$logo = dirname($theme_object->filename) . '/logo.png';
if (file_exists($logo)) {
$info['path'] = $logo;
}
}
elseif ($site_config->get('site_logo_path')) {
$info['path'] = $site_config->get('site_logo_path');
}
// Retrieve stored logo dimensions.
if ($attributes = $site_config->get('site_logo_attributes')) {
$info = array_merge($info, $attributes);
}
// Set the logo dimensions if not set.
elseif ($info['path'] && $dimensions = @getimagesize($info['path'])) {
$attributes = array();
list($attributes['width'], $attributes['height']) = $dimensions;
$site_config->set('site_logo_attributes', $attributes);
$info = array_merge($info, $attributes);
}
}
catch (ConfigException $e) {
// Use the default empty logo.
}
return $info;
}
/**
* Gets the site logo.
*
* Falls back to none (empty string) if not defined or theme provided.
*
* @return (string) $logo
* URL to the logo file to use for the site.
*
* @see backdrop_get_logo_properties()
*/
function backdrop_get_logo() {
$logo = '';
$logo_info = backdrop_get_logo_info();
if ($logo_info['path']) {
$logo = file_create_url($logo_info['path']);
}
return $logo;
}
/**
* Gets the file location and mime type for site favicon.
*
* Falls back to the Backdrop favicon if not defined or theme provided.
*
* @return (array) $favicon
* Information about the favicon to use for the site. Keys include:
* - path: Relative path to the file to be used.
* - type: mime type for the icon being used.
*/
function backdrop_get_favicon() {
$favicon = array(
'path' => file_create_url('core/misc/favicon.ico'),
'type' => 'image/vnd.microsoft.icon',
);
// Load the config and update, if we can.
try {
$site_config = config('system.core');
if ($site_config->get('site_favicon_theme')) {
global $theme;
$theme_data = list_themes();
$theme_object = $theme_data[$theme];
$theme_favicon = dirname($theme_object->filename) . '/favicon.ico';
if (file_exists($theme_favicon)) {
$favicon['path'] = file_create_url($theme_favicon);
}
}
elseif ($site_config->get('site_favicon_path')) {
$favicon['path'] = file_create_url($site_config->get('site_favicon_path'));
$favicon['type'] = $site_config->get('site_favicon_mimetype');
}
}
catch (ConfigException $e) {
// Use the default.
}
// Safety check to prevent user-provided javascript: URLs or the like.
$favicon['path'] = backdrop_strip_dangerous_protocols($favicon['path']);
return $favicon;
}
/**
* Adds output to the HEAD tag of the HTML page.
*
* This function can be called as long as 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 'head_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_head_tag()
*/
function backdrop_add_html_head($data = NULL, $key = NULL) {
$stored_head = &backdrop_static(__FUNCTION__);
if (!isset($stored_head)) {
// Make sure the defaults, including Content-Type, come first.
$stored_head = _backdrop_default_html_head();
}
if (isset($data) && isset($key)) {
if (!isset($data['#type'])) {
$data['#type'] = 'head_tag';
}
$stored_head[$key] = $data;
}
return $stored_head;
}
/**
* Returns elements that are always displayed in the HEAD tag of the HTML page.
*/
function _backdrop_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' => 'head_tag',
'#tag' => 'meta',
'#attributes' => array(
'charset' => 'utf-8',
),
// Security: This always has to be output first.
'#weight' => -1000,
);
// Show Backdrop and the major version number in the META GENERATOR tag.
// Get the major version.
list($version, ) = explode('.', BACKDROP_VERSION);
$elements['system_meta_generator'] = array(
'#type' => 'head_tag',
'#tag' => 'meta',
'#attributes' => array(
'name' => 'Generator',
'content' => 'Backdrop CMS ' . $version . ' (https://backdropcms.org)',
),
);
// Also send the generator in the HTTP header.
$elements['system_meta_generator']['#attached']['backdrop_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
return $elements;
}
/**
* Retrieves output to be displayed in the HEAD tag of the HTML page.
*/
function backdrop_get_html_head() {
$elements = backdrop_add_html_head();
// Always add the default mobile meta tags.
$elements['viewport'] = array(
'#type' => 'head_tag',
'#tag' => 'meta',
'#attributes' => array(
'name' => 'viewport',
'content' => 'width=device-width, initial-scale=1',
),
);
backdrop_alter('html_head', $elements);
return backdrop_render($elements);
}
/**
* Adds a feed URL for the current page.
*
* This function can be called as long the HTML header hasn't been sent.
*
* @param $url
* An internal system path or a fully qualified external URL of the feed.
* @param $title
* The title of the feed.
*/
function backdrop_add_feed($url = NULL, $title = '') {
$stored_feed_links = &backdrop_static(__FUNCTION__, array());
if (isset($url)) {
$stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
backdrop_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 Backdrop.
'href' => url($url, array('absolute' => TRUE)),
));
}
return $stored_feed_links;
}
/**
* Gets the feed URLs for the current page.
*
* @param string $delimiter
* A delimiter to split feeds by.
*
* @return string
* The list of feed URLs joined together by the given delimiter.
*/
function backdrop_get_feeds($delimiter = "\n") {
$feeds = backdrop_add_feed();
return implode($delimiter, $feeds);
}
/**
* @defgroup http_handling HTTP handling
* @{
* Functions to properly handle HTTP responses.
*/
/**
* Processes a URL query parameter array to remove unwanted elements.
*
* @param $query
* (optional) An array to be processed. Defaults to $_GET.
* @param $exclude
* (optional) A list of $query array keys to remove. Use "parent[child]" to
* exclude nested items. Defaults to array('q').
* @param $parent
* Internal use only. Used to build the $query array key for nested items.
*
* @return
* An array containing query parameters, which can be used for url().
*/
function backdrop_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);
}
$params = array();
foreach ($query as $key => $value) {
$string_key = ($parent ? $parent . '[' . $key . ']' : $key);
if (isset($exclude[$string_key])) {
continue;
}
if (is_array($value)) {
$params[$key] = backdrop_get_query_parameters($value, $exclude, $string_key);
}
else {
$params[$key] = $value;
}
}
return $params;
}
/**
* Splits a 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 backdrop_get_query_array($query) {
$result = array();
if (!empty($query)) {
foreach (explode('&', $query) as $param) {
$param = explode('=', $param, 2);
$result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
}
}
return $result;
}
/**
* Take a full URL and return only the bare domain, with sub-domains removed.
*
* @param string $url
* A fully-qualified URL like https://www.example.co.uk/path-to-page or a
* partial URL without the protocol, such as www.example.co.uk, as would be
* provided by $_SERVER['SERVER_NAME'].
*
* @return string|FALSE
* The bare domain of the starting URL like example.com or example.co.uk.
*/
function backdrop_get_bare_domain($url) {
$parts = parse_url(trim($url, '/'));
$domain = FALSE;
// Support full URLs with protocol.
if (array_key_exists('host', $parts)) {
$domain = $parts['host'];
}
// Partial URLs without protocol.
elseif (array_key_exists('path', $parts)) {
// Always remove any trailing path.
$parts_array = explode('/', $parts['path'], 2);
$domain = array_shift($parts_array);
}
if ($domain) {
// Always strip off www.
if (substr($domain, 0, 4) == 'www.') {
$domain = substr($domain, 3);
}
// See what's remaining.
$sub_parts = explode('.', $domain);
if (count($sub_parts) > 2) {
$last = array_pop($sub_parts);
$second_to_last = array_pop($sub_parts);
// Likely a country-specific domain like .co.uk.
if (strlen($last) === 2 && count($sub_parts)) {
$domain = array_pop($sub_parts) . '.' . $second_to_last . '.' . $last;
}
// Either a longer top-level domain such as .com or a short domain with
// no sub-domains (other than www) like lb.cm.
else {
$domain = $second_to_last . '.' . $last;
}
}
}
return $domain;
}
/**
* Parses 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 backdrop_get_query_parameters()
* @ingroup php_wrappers
*/
function backdrop_http_build_query(array $query, $parent = '') {
$params = array();
foreach ($query as $key => $value) {
$key = $parent ? $parent . rawurlencode('[' . $key . ']') : rawurlencode($key);
// For better readability of paths in query strings, we decode slashes.
$key = str_replace('%2F', '/', $key);
// Recurse into children.
if (is_array($value)) {
$params[] = backdrop_http_build_query($value, $key);
}
// If a query parameter value is NULL, only append its key.
elseif (!isset($value)) {
$params[] = $key;
}
else {
// For better readability of paths in query strings, we decode slashes.
$params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
}
}
return implode('&', $params);
}
/**
* Prepares a 'destination' URL query parameter for use with backdrop_goto().
*
* 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.
*
* @see backdrop_goto()
*/
function backdrop_get_destination() {
$destination = &backdrop_static(__FUNCTION__);
if (isset($destination)) {
return $destination;
}
if (isset($_GET['destination'])) {
$destination = array('destination' => $_GET['destination']);
}
else {
$path = $_GET['q'];
$query = backdrop_http_build_query(backdrop_get_query_parameters());
if ($query != '') {
$path .= '?' . $query;
}
$destination = array('destination' => $path);
}
return $destination;
}
/**
* Parses 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, such as via url(). It should not be used for URLs that come from
* external sources, or URLs that link to external resources.
*
* The returned array contains a 'path' that may be passed separately to url().
* For example:
* @code
* $options = backdrop_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 backdrop_goto()
* @ingroup php_wrappers
*/
function backdrop_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 {
// 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);
if (isset($parts['query'])) {
parse_str($parts['query'], $options['query']);
}
if (isset($parts['fragment'])) {
$options['fragment'] = $parts['fragment'];
}
}
// 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. The path
// parameter must be a string.
if (isset($options['query']['q']) && is_string($options['query']['q'])) {
$options['path'] = $options['query']['q'];
unset($options['query']['q']);
}
return $options;
}
/**
* Encodes a Backdrop path for use in a URL.
*
* For aesthetic reasons slashes are not escaped.
*
* Note that url() takes care of calling this function, so a path passed to that
* function should not be encoded in advance.
*
* @param string $path
* The Backdrop path to encode.
*
* @return string
* The encoded path.
*/
function backdrop_encode_path($path) {
return str_replace('%2F', '/', rawurlencode((string) $path));
}
/**
* Wraps backdrop_goto() to include a deprecated log message.
*
* In earlier versions of Backdrop, this was sometimes used directly as a menu
* callback. It is now recommended to use system_redirect_deprecated_page()
* instead when deprecating paths, because that function can handle wildcards
* and path mapping. It resolves the final path and then calls this function to
* perform the redirect.
*
* @see backdrop_goto()
* @see system_redirect_deprecated_page()
*
* @since 1.5.0
*/
function backdrop_goto_deprecated($path = '', array $options = array(), $http_response_code = 302) {
watchdog('system', 'The path %path has been deprecated and will be removed in the next major release of Backdrop. This path was called from %referrer. It is recommended to remove it from any existing links.', array('%path' => $_GET['q'], '%referrer' => $_SERVER['HTTP_REFERER']), WATCHDOG_DEPRECATED);
backdrop_goto($path, $options, $http_response_code);
}
/**
* Sends the user to a different page.
*
* This issues an on-site HTTP redirect. The function makes sure the redirected
* URL is formatted correctly.
*
* 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
* $query = array('destination' => "node/$node->nid");
* $link = l(t('Log in'), 'user/login', array('query' => $query));
* @endcode
*
* Backdrop will ensure that messages set by backdrop_set_message() and other
* session data are written to the database before the user is redirected.
*
* This function ends the request; use it instead of a return in your menu
* callback.
*
* @param $path
* (optional) A Backdrop path or a full URL, which will be passed to url() to
* compute the redirect for the URL.
* @param $options
* (optional) An associative array of additional URL options to pass to url().
* @param $http_response_code
* (optional) The HTTP status code to use for the redirection, defaults to
* 302. The valid values for 3xx redirection status codes are defined in
* @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
* and the
* @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
* - 301: Moved Permanently (the recommended value for most redirects).
* - 302: Found (default in Backdrop and PHP, sometimes used for spamming search
* engines).
* - 303: See Other.
* - 304: Not Modified.
* - 305: Use Proxy.
* - 307: Temporary Redirect.
*
* @see backdrop_get_destination()
* @see url()
*/
function backdrop_goto($path = '', array $options = array(), $http_response_code = 302) {
// A destination in $_GET always overrides the function arguments.
// 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'])) {
$destination = backdrop_parse_url($_GET['destination']);
// Double check the path derived by backdrop_parse_url() is not external.
if (!url_is_external($destination['path'])) {
$path = $destination['path'];
}
$options['query'] = $destination['query'];
$options['fragment'] = $destination['fragment'];
}
// In some cases modules call backdrop_goto(current_path()). We need to ensure
// that such a redirect is not to an external URL.
if ($path === current_path() && empty($options['external']) && url_is_external($path)) {
// Force url() to generate a non-external URL.
$options['external'] = FALSE;
}
backdrop_alter('backdrop_goto', $path, $options, $http_response_code);
// The 'Location' HTTP header must be absolute.
$options['absolute'] = TRUE;
$url = url($path, $options);
if (!backdrop_is_background()) {
header('Location: ' . $url, TRUE, $http_response_code);
}
// The "Location" header sends a redirect status code to the HTTP daemon. In
// some cases this can be wrong, so we make sure none of the code below the
// backdrop_goto() call gets executed upon redirection.
backdrop_exit($url);
}
/**
* Delivers 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 backdrop_site_offline(). However,
* functions that are invoked in contexts where that return value might not
* bubble up to menu_execute_active_handler() should call backdrop_site_offline().
*/
function backdrop_site_offline() {
backdrop_deliver_page(MENU_SITE_OFFLINE);
}
/**
* Delivers 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 backdrop_not_found(). However,
* functions that are invoked in contexts where that return value might not
* bubble up to menu_execute_active_handler() should call backdrop_not_found().
*/
function backdrop_not_found() {
backdrop_deliver_page(MENU_NOT_FOUND);
}
/**
* Delivers an "access denied" error to the browser.
*
* Page callback functions wanting to report an "access denied" message should
* return MENU_ACCESS_DENIED instead of calling backdrop_access_denied(). However,
* functions that are invoked in contexts where that return value might not
* bubble up to menu_execute_active_handler() should call
* backdrop_access_denied().
*/
function backdrop_access_denied() {
backdrop_deliver_page(MENU_ACCESS_DENIED);
}
/**
* Performs an HTTP request.
*
* This is a flexible and powerful HTTP client implementation. Correctly
* handles GET, POST, PUT or any other HTTP requests. Handles redirects.
*
* @param $url
* A string containing a fully qualified URI.
* @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: An array containing the values for the request body or a string
* containing the request body, formatted as 'param=value¶m=value&...'.
* To generate this, use backdrop_http_build_query(). 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().
*
* @return stdClass
* 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.
* - redirect_url: If redirected, a string containing the URL of the redirect
* target.
* - 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.
*
* @see backdrop_http_build_query()
*
* @since 1.18.4 The $options['data'] key may now be passed as an array.
*/
function backdrop_http_request($url, array $options = array()) {
// Allow an alternate HTTP client library to replace Backdrop's default
// implementation.
$alternate_http_system = &backdrop_static('__FUNCTION__');
if (!isset($alternate_http_system)) {
$class = settings_get('http_system');
/* @var BackdropHTTPSystemInterface $alternate_http_system */
$alternate_http_system = $class ? new $class() : FALSE;
}
if ($alternate_http_system) {
return $alternate_http_system->request($url, $options);
}
$result = new stdClass();
// Parse the URL and make sure we can handle the schema.
$uri = @parse_url($url);
if ($uri == FALSE) {
$result->error = 'unable to parse URL';
$result->code = -1001;
return $result;
}
if (!isset($uri['scheme'])) {
$result->error = 'missing schema';
$result->code = -1002;
return $result;
}
timer_start(__FUNCTION__);
// Merge the default options.
$options += array(
'headers' => array(),
'method' => 'GET',
'data' => NULL,
'max_redirects' => 3,
'timeout' => 30.0,
'context' => NULL,
);
// Merge the default headers.
$options['headers'] += array(