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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
|
<?php
/**
* @file
* Install, update and uninstall functions for the system module.
*/
use Drupal\Component\FileSystem\FileSystem as FileSystemComponent;
use Drupal\Component\Utility\Bytes;
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Environment;
use Drupal\Component\Utility\OpCodeCache;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Database\Database;
use Drupal\Core\DrupalKernel;
use Drupal\Core\Extension\ExtensionLifecycle;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Link;
use Drupal\Core\Utility\PhpRequirements;
use Drupal\Core\Render\Markup;
use Drupal\Core\Site\Settings;
use Drupal\Core\StreamWrapper\PrivateStream;
use Drupal\Core\StreamWrapper\PublicStream;
use Drupal\Core\StringTranslation\ByteSizeMarkup;
use Drupal\Core\StringTranslation\PluralTranslatableMarkup;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Update\EquivalentUpdate;
use Drupal\Core\Url;
use Drupal\Core\Utility\Error;
use Psr\Http\Client\ClientExceptionInterface;
use Symfony\Component\HttpFoundation\Request;
// cspell:ignore quickedit
/**
* An array of machine names of modules that were removed from Drupal core.
*/
const DRUPAL_CORE_REMOVED_MODULE_LIST = [
'action' => 'Action UI',
'book' => 'Book',
'aggregator' => 'Aggregator',
'ckeditor' => 'CKEditor',
'color' => 'Color',
'forum' => 'Forum',
'hal' => 'HAL',
'quickedit' => 'Quick Edit',
'rdf' => 'RDF',
'statistics' => 'Statistics',
'tour' => 'Tour',
'tracker' => 'Tracker',
];
/**
* An array of machine names of themes that were removed from Drupal core.
*/
const DRUPAL_CORE_REMOVED_THEME_LIST = [
'bartik' => 'Bartik',
'classy' => 'Classy',
'seven' => 'Seven',
'stable' => 'Stable',
];
/**
* Implements hook_requirements().
*/
function system_requirements($phase): array {
global $install_state;
// Get the current default PHP requirements for this version of Drupal.
$minimum_supported_php = PhpRequirements::getMinimumSupportedPhp();
// Reset the extension lists.
/** @var \Drupal\Core\Extension\ModuleExtensionList $module_extension_list */
$module_extension_list = \Drupal::service('extension.list.module');
$module_extension_list->reset();
/** @var \Drupal\Core\Extension\ThemeExtensionList $theme_extension_list */
$theme_extension_list = \Drupal::service('extension.list.theme');
$theme_extension_list->reset();
$requirements = [];
// Report Drupal version
if ($phase == 'runtime') {
$requirements['drupal'] = [
'title' => t('Drupal'),
'value' => \Drupal::VERSION,
'severity' => REQUIREMENT_INFO,
'weight' => -10,
];
// Display the currently active installation profile, if the site
// is not running the default installation profile.
$profile = \Drupal::installProfile();
if ($profile != 'standard' && !empty($profile)) {
$info = $module_extension_list->getExtensionInfo($profile);
$requirements['install_profile'] = [
'title' => t('Installation profile'),
'value' => t('%profile_name (%profile%version)', [
'%profile_name' => $info['name'],
'%profile' => $profile,
'%version' => !empty($info['version']) ? '-' . $info['version'] : '',
]),
'severity' => REQUIREMENT_INFO,
'weight' => -9,
];
}
// Gather all obsolete and experimental modules being enabled.
$obsolete_extensions = [];
$deprecated_modules = [];
$experimental_modules = [];
$enabled_modules = \Drupal::moduleHandler()->getModuleList();
foreach ($enabled_modules as $module => $data) {
$info = $module_extension_list->getExtensionInfo($module);
if (isset($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER])) {
if ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::EXPERIMENTAL) {
$experimental_modules[$module] = $info['name'];
}
elseif ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::DEPRECATED) {
$deprecated_modules[] = ['name' => $info['name'], 'lifecycle_link' => $info['lifecycle_link']];
}
elseif ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::OBSOLETE) {
$obsolete_extensions[$module] = ['name' => $info['name'], 'lifecycle_link' => $info['lifecycle_link']];
}
}
}
// Warn if any experimental modules are installed.
if (!empty($experimental_modules)) {
$requirements['experimental_modules'] = [
'title' => t('Experimental modules installed'),
'value' => t('Experimental modules found: %module_list. <a href=":url">Experimental modules</a> are provided for testing purposes only. Use at your own risk.', ['%module_list' => implode(', ', $experimental_modules), ':url' => 'https://www.drupal.org/core/experimental']),
'severity' => REQUIREMENT_WARNING,
];
}
// Warn if any deprecated modules are installed.
if (!empty($deprecated_modules)) {
foreach ($deprecated_modules as $deprecated_module) {
$deprecated_modules_link_list[] = (string) Link::fromTextAndUrl($deprecated_module['name'], Url::fromUri($deprecated_module['lifecycle_link']))->toString();
}
$requirements['deprecated_modules'] = [
'title' => t('Deprecated modules installed'),
'value' => t('Deprecated modules found: %module_list.', [
'%module_list' => Markup::create(implode(', ', $deprecated_modules_link_list)),
]),
'severity' => REQUIREMENT_WARNING,
];
}
// Gather all obsolete and experimental themes being installed.
$experimental_themes = [];
$deprecated_themes = [];
$installed_themes = \Drupal::service('theme_handler')->listInfo();
foreach ($installed_themes as $theme => $data) {
$info = $theme_extension_list->getExtensionInfo($theme);
if (isset($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER])) {
if ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::EXPERIMENTAL) {
$experimental_themes[$theme] = $info['name'];
}
elseif ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::DEPRECATED) {
$deprecated_themes[] = ['name' => $info['name'], 'lifecycle_link' => $info['lifecycle_link']];
}
elseif ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::OBSOLETE) {
$obsolete_extensions[$theme] = ['name' => $info['name'], 'lifecycle_link' => $info['lifecycle_link']];
}
}
}
// Warn if any experimental themes are installed.
if (!empty($experimental_themes)) {
$requirements['experimental_themes'] = [
'title' => t('Experimental themes installed'),
'value' => t('Experimental themes found: %theme_list. Experimental themes are provided for testing purposes only. Use at your own risk.', ['%theme_list' => implode(', ', $experimental_themes)]),
'severity' => REQUIREMENT_WARNING,
];
}
// Warn if any deprecated themes are installed.
if (!empty($deprecated_themes)) {
foreach ($deprecated_themes as $deprecated_theme) {
$deprecated_themes_link_list[] = (string) Link::fromTextAndUrl($deprecated_theme['name'], Url::fromUri($deprecated_theme['lifecycle_link']))->toString();
}
$requirements['deprecated_themes'] = [
'title' => t('Deprecated themes installed'),
'value' => t('Deprecated themes found: %theme_list.', [
'%theme_list' => Markup::create(implode(', ', $deprecated_themes_link_list)),
]),
'severity' => REQUIREMENT_WARNING,
];
}
// Warn if any obsolete extensions (themes or modules) are installed.
if (!empty($obsolete_extensions)) {
foreach ($obsolete_extensions as $obsolete_extension) {
$obsolete_extensions_link_list[] = (string) Link::fromTextAndUrl($obsolete_extension['name'], Url::fromUri($obsolete_extension['lifecycle_link']))->toString();
}
$requirements['obsolete_extensions'] = [
'title' => t('Obsolete extensions installed'),
'value' => t('Obsolete extensions found: %extensions. Obsolete extensions are provided only so that they can be uninstalled cleanly. You should immediately <a href=":uninstall_url">uninstall these extensions</a> since they may be removed in a future release.', [
'%extensions' => Markup::create(implode(', ', $obsolete_extensions_link_list)),
':uninstall_url' => Url::fromRoute('system.modules_uninstall')->toString(),
]),
'severity' => REQUIREMENT_WARNING,
];
}
_system_advisories_requirements($requirements);
}
// Web server information.
$request_object = \Drupal::request();
$software = $request_object->server->get('SERVER_SOFTWARE');
$requirements['webserver'] = [
'title' => t('Web server'),
'value' => $software,
];
// Tests clean URL support.
if ($phase == 'install' && $install_state['interactive'] && !$request_object->query->has('rewrite') && str_contains($software, 'Apache')) {
// If the Apache rewrite module is not enabled, Apache version must be >=
// 2.2.16 because of the FallbackResource directive in the root .htaccess
// file. Since the Apache version reported by the server is dependent on the
// ServerTokens setting in httpd.conf, we may not be able to determine if a
// given config is valid. Thus we are unable to use version_compare() as we
// need have three possible outcomes: the version of Apache is greater than
// 2.2.16, is less than 2.2.16, or cannot be determined accurately. In the
// first case, we encourage the use of mod_rewrite; in the second case, we
// raise an error regarding the minimum Apache version; in the third case,
// we raise a warning that the current version of Apache may not be
// supported.
$rewrite_warning = FALSE;
$rewrite_error = FALSE;
$apache_version_string = 'Apache';
// Determine the Apache version number: major, minor and revision.
if (preg_match('/Apache\/(\d+)\.?(\d+)?\.?(\d+)?/', $software, $matches)) {
$apache_version_string = $matches[0];
// Major version number
if ($matches[1] < 2) {
$rewrite_error = TRUE;
}
elseif ($matches[1] == 2) {
if (!isset($matches[2])) {
$rewrite_warning = TRUE;
}
elseif ($matches[2] < 2) {
$rewrite_error = TRUE;
}
elseif ($matches[2] == 2) {
if (!isset($matches[3])) {
$rewrite_warning = TRUE;
}
elseif ($matches[3] < 16) {
$rewrite_error = TRUE;
}
}
}
}
else {
$rewrite_warning = TRUE;
}
if ($rewrite_warning) {
$requirements['apache_version'] = [
'title' => t('Apache version'),
'value' => $apache_version_string,
'severity' => REQUIREMENT_WARNING,
'description' => t('Due to the settings for ServerTokens in httpd.conf, it is impossible to accurately determine the version of Apache running on this server. The reported value is @reported, to run Drupal without mod_rewrite, a minimum version of 2.2.16 is needed.', ['@reported' => $apache_version_string]),
];
}
if ($rewrite_error) {
$requirements['Apache version'] = [
'title' => t('Apache version'),
'value' => $apache_version_string,
'severity' => REQUIREMENT_ERROR,
'description' => t('The minimum version of Apache needed to run Drupal without mod_rewrite enabled is 2.2.16. See the <a href=":link">enabling clean URLs</a> page for more information on mod_rewrite.', [':link' => 'https://www.drupal.org/docs/8/clean-urls-in-drupal-8']),
];
}
if (!$rewrite_error && !$rewrite_warning) {
$requirements['rewrite_module'] = [
'title' => t('Clean URLs'),
'value' => t('Disabled'),
'severity' => REQUIREMENT_WARNING,
'description' => t('Your server is capable of using clean URLs, but it is not enabled. Using clean URLs gives an improved user experience and is recommended. <a href=":link">Enable clean URLs</a>', [':link' => 'https://www.drupal.org/docs/8/clean-urls-in-drupal-8']),
];
}
}
// Verify the user is running a supported PHP version.
// If the site is running a recommended version of PHP, just display it
// as an informational message on the status report. This will be overridden
// with an error or warning if the site is running older PHP versions for
// which Drupal has already or will soon drop support.
$phpversion = $phpversion_label = phpversion();
if ($phase === 'runtime') {
$phpversion_label = t('@phpversion (<a href=":url">more information</a>)', [
'@phpversion' => $phpversion,
':url' => (new Url('system.php'))->toString(),
]);
}
$requirements['php'] = [
'title' => t('PHP'),
'value' => $phpversion_label,
];
// Check if the PHP version is below what Drupal supports.
if (version_compare($phpversion, $minimum_supported_php) < 0) {
$requirements['php']['description'] = t('Your PHP installation is too old. Drupal requires at least PHP %version. It is recommended to upgrade to PHP version %recommended or higher for the best ongoing support. See <a href="http://php.net/supported-versions.php">PHP\'s version support documentation</a> and the <a href=":php_requirements">Drupal PHP requirements</a> page for more information.',
[
'%version' => $minimum_supported_php,
'%recommended' => \Drupal::RECOMMENDED_PHP,
':php_requirements' => 'https://www.drupal.org/docs/system-requirements/php-requirements',
]
);
// If the PHP version is also below the absolute minimum allowed, it's not
// safe to continue with the requirements check, and should always be an
// error.
if (version_compare($phpversion, \Drupal::MINIMUM_PHP) < 0) {
$requirements['php']['severity'] = REQUIREMENT_ERROR;
return $requirements;
}
// Otherwise, the message should be an error at runtime, and a warning
// during installation or update.
$requirements['php']['severity'] = ($phase === 'runtime') ? REQUIREMENT_ERROR : REQUIREMENT_WARNING;
}
// For PHP versions that are still supported but no longer recommended,
// inform users of what's recommended, allowing them to take action before it
// becomes urgent.
elseif ($phase === 'runtime' && version_compare($phpversion, \Drupal::RECOMMENDED_PHP) < 0) {
$requirements['php']['description'] = t('It is recommended to upgrade to PHP version %recommended or higher for the best ongoing support. See <a href="http://php.net/supported-versions.php">PHP\'s version support documentation</a> and the <a href=":php_requirements">Drupal PHP requirements</a> page for more information.', ['%recommended' => \Drupal::RECOMMENDED_PHP, ':php_requirements' => 'https://www.drupal.org/docs/system-requirements/php-requirements']);
$requirements['php']['severity'] = REQUIREMENT_INFO;
}
// Test for PHP extensions.
$requirements['php_extensions'] = [
'title' => t('PHP extensions'),
];
$missing_extensions = [];
$required_extensions = [
'date',
'dom',
'filter',
'gd',
'hash',
'json',
'pcre',
'pdo',
'session',
'SimpleXML',
'SPL',
'tokenizer',
'xml',
'zlib',
];
foreach ($required_extensions as $extension) {
if (!extension_loaded($extension)) {
$missing_extensions[] = $extension;
}
}
if (!empty($missing_extensions)) {
$description = t('Drupal requires you to enable the PHP extensions in the following list (see the <a href=":system_requirements">system requirements page</a> for more information):', [
':system_requirements' => 'https://www.drupal.org/docs/system-requirements',
]);
// We use twig inline_template to avoid twig's autoescape.
$description = [
'#type' => 'inline_template',
'#template' => '{{ description }}{{ missing_extensions }}',
'#context' => [
'description' => $description,
'missing_extensions' => [
'#theme' => 'item_list',
'#items' => $missing_extensions,
],
],
];
$requirements['php_extensions']['value'] = t('Disabled');
$requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
$requirements['php_extensions']['description'] = $description;
}
else {
$requirements['php_extensions']['value'] = t('Enabled');
}
if ($phase == 'install' || $phase == 'runtime') {
// Check to see if OPcache is installed.
if (!OpCodeCache::isEnabled()) {
$requirements['php_opcache'] = [
'value' => t('Not enabled'),
'severity' => REQUIREMENT_WARNING,
'description' => t('PHP OPcode caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href="http://php.net/manual/opcache.installation.php" target="_blank">OPcache</a> installed on your server.'),
];
}
else {
$requirements['php_opcache']['value'] = t('Enabled');
}
$requirements['php_opcache']['title'] = t('PHP OPcode caching');
}
// Check to see if APCu is installed and configured correctly.
if ($phase == 'runtime' && PHP_SAPI != 'cli') {
$requirements['php_apcu_enabled']['title'] = t('PHP APCu caching');
$requirements['php_apcu_available']['title'] = t('PHP APCu available caching');
if (extension_loaded('apcu') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN)) {
$memory_info = apcu_sma_info(TRUE);
$apcu_actual_size = ByteSizeMarkup::create($memory_info['seg_size'] * $memory_info['num_seg']);
$apcu_recommended_size = '32 MB';
$requirements['php_apcu_enabled']['value'] = t('Enabled (@size)', ['@size' => $apcu_actual_size]);
if (Bytes::toNumber(ini_get('apc.shm_size')) * ini_get('apc.shm_segments') < Bytes::toNumber($apcu_recommended_size)) {
$requirements['php_apcu_enabled']['severity'] = REQUIREMENT_WARNING;
$requirements['php_apcu_enabled']['description'] = t('Depending on your configuration, Drupal can run with a @apcu_size APCu limit. However, a @apcu_default_size APCu limit (the default) or above is recommended, especially if your site uses additional custom or contributed modules.', [
'@apcu_size' => $apcu_actual_size,
'@apcu_default_size' => $apcu_recommended_size,
]);
}
else {
$memory_available = $memory_info['avail_mem'] / ($memory_info['seg_size'] * $memory_info['num_seg']);
if ($memory_available < 0.1) {
$requirements['php_apcu_available']['severity'] = REQUIREMENT_ERROR;
$requirements['php_apcu_available']['description'] = t('APCu is using over 90% of its allotted memory (@apcu_actual_size). To improve APCu performance, consider increasing this limit.', [
'@apcu_actual_size' => $apcu_actual_size,
]);
}
elseif ($memory_available < 0.25) {
$requirements['php_apcu_available']['severity'] = REQUIREMENT_WARNING;
$requirements['php_apcu_available']['description'] = t('APCu is using over 75% of its allotted memory (@apcu_actual_size). To improve APCu performance, consider increasing this limit.', [
'@apcu_actual_size' => $apcu_actual_size,
]);
}
else {
$requirements['php_apcu_available']['severity'] = REQUIREMENT_OK;
}
$requirements['php_apcu_available']['value'] = t('Memory available: @available.', [
'@available' => ByteSizeMarkup::create($memory_info['avail_mem']),
]);
}
}
else {
$requirements['php_apcu_enabled'] += [
'value' => t('Not enabled'),
'severity' => REQUIREMENT_INFO,
'description' => t('PHP APCu caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href="https://www.php.net/manual/apcu.installation.php" target="_blank">APCu</a> installed on your server.'),
];
}
}
if ($phase != 'update') {
// Test whether we have a good source of random bytes.
$requirements['php_random_bytes'] = [
'title' => t('Random number generation'),
];
try {
$bytes = random_bytes(10);
if (strlen($bytes) != 10) {
throw new \Exception("Tried to generate 10 random bytes, generated '" . strlen($bytes) . "'");
}
$requirements['php_random_bytes']['value'] = t('Successful');
}
catch (\Exception $e) {
// If /dev/urandom is not available on a UNIX-like system, check whether
// open_basedir restrictions are the cause.
$open_basedir_blocks_urandom = FALSE;
if (DIRECTORY_SEPARATOR === '/' && !@is_readable('/dev/urandom')) {
$open_basedir = ini_get('open_basedir');
if ($open_basedir) {
$open_basedir_paths = explode(PATH_SEPARATOR, $open_basedir);
$open_basedir_blocks_urandom = !array_intersect(['/dev', '/dev/', '/dev/urandom'], $open_basedir_paths);
}
}
$args = [
':drupal-php' => 'https://www.drupal.org/docs/system-requirements/php-requirements',
'%exception_message' => $e->getMessage(),
];
if ($open_basedir_blocks_urandom) {
$requirements['php_random_bytes']['description'] = t('Drupal is unable to generate highly randomized numbers, which means certain security features like password reset URLs are not as secure as they should be. Instead, only a slow, less-secure fallback generator is available. The most likely cause is that open_basedir restrictions are in effect and /dev/urandom is not on the whitelist. See the <a href=":drupal-php">system requirements</a> page for more information. %exception_message', $args);
}
else {
$requirements['php_random_bytes']['description'] = t('Drupal is unable to generate highly randomized numbers, which means certain security features like password reset URLs are not as secure as they should be. Instead, only a slow, less-secure fallback generator is available. See the <a href=":drupal-php">system requirements</a> page for more information. %exception_message', $args);
}
$requirements['php_random_bytes']['value'] = t('Less secure');
$requirements['php_random_bytes']['severity'] = REQUIREMENT_ERROR;
}
}
if ($phase === 'runtime' && PHP_SAPI !== 'cli') {
if (!function_exists('fastcgi_finish_request') && !function_exists('litespeed_finish_request') && !ob_get_status()) {
$requirements['output_buffering'] = [
'title' => t('Output Buffering'),
'error_value' => t('Not enabled'),
'severity' => REQUIREMENT_WARNING,
'description' => t('<a href="https://www.php.net/manual/en/function.ob-start.php">Output buffering</a> is not enabled. This may degrade Drupal\'s performance. You can enable output buffering by default <a href="https://www.php.net/manual/en/outcontrol.configuration.php#ini.output-buffering">in your PHP settings</a>.'),
];
}
}
if ($phase == 'install' || $phase == 'update') {
// Test for PDO (database).
$requirements['database_extensions'] = [
'title' => t('Database support'),
];
// Make sure PDO is available.
$database_ok = extension_loaded('pdo');
if (!$database_ok) {
$pdo_message = t('Your web server does not appear to support PDO (PHP Data Objects). Ask your hosting provider if they support the native PDO extension. See the <a href=":link">system requirements</a> page for more information.', [
':link' => 'https://www.drupal.org/docs/system-requirements/php-requirements#database',
]);
}
else {
// Make sure at least one supported database driver exists.
if (empty(Database::getDriverList()->getInstallableList())) {
$database_ok = FALSE;
$pdo_message = t('Your web server does not appear to support any common PDO database extensions. Check with your hosting provider to see if they support PDO (PHP Data Objects) and offer any databases that <a href=":drupal-databases">Drupal supports</a>.', [
':drupal-databases' => 'https://www.drupal.org/docs/system-requirements/database-server-requirements',
]);
}
// Make sure the native PDO extension is available, not the older PEAR
// version. (See install_verify_pdo() for details.)
if (!defined('PDO::ATTR_DEFAULT_FETCH_MODE')) {
$database_ok = FALSE;
$pdo_message = t('Your web server seems to have the wrong version of PDO installed. Drupal requires the PDO extension from PHP core. This system has the older PECL version. See the <a href=":link">system requirements</a> page for more information.', [
':link' => 'https://www.drupal.org/docs/system-requirements/php-requirements#database',
]);
}
}
if (!$database_ok) {
$requirements['database_extensions']['value'] = t('Disabled');
$requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
$requirements['database_extensions']['description'] = $pdo_message;
}
else {
$requirements['database_extensions']['value'] = t('Enabled');
}
}
if ($phase === 'runtime' || $phase === 'update') {
// Database information.
$class = Database::getConnection()->getConnectionOptions()['namespace'] . '\\Install\\Tasks';
/** @var \Drupal\Core\Database\Install\Tasks $tasks */
$tasks = new $class();
$requirements['database_system'] = [
'title' => t('Database system'),
'value' => $tasks->name(),
];
$requirements['database_system_version'] = [
'title' => t('Database system version'),
'value' => Database::getConnection()->version(),
];
$errors = $tasks->engineVersionRequirementsCheck();
$error_count = count($errors);
if ($error_count > 0) {
$error_message = [
'#theme' => 'item_list',
'#items' => $errors,
// Use the comma-list style to display a single error without bullets.
'#context' => ['list_style' => $error_count === 1 ? 'comma-list' : ''],
];
$requirements['database_system_version']['severity'] = REQUIREMENT_ERROR;
$requirements['database_system_version']['description'] = $error_message;
}
}
if ($phase === 'runtime' || $phase === 'update') {
// Test database JSON support.
$requirements['database_support_json'] = [
'title' => t('Database support for JSON'),
'severity' => REQUIREMENT_OK,
'value' => t('Available'),
'description' => t('Drupal requires databases that support JSON storage.'),
];
if (!Database::getConnection()->hasJson()) {
$requirements['database_support_json']['value'] = t('Not available');
$requirements['database_support_json']['severity'] = REQUIREMENT_ERROR;
}
}
// Test PHP memory_limit
$memory_limit = ini_get('memory_limit');
$requirements['php_memory_limit'] = [
'title' => t('PHP memory limit'),
'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
];
if (!Environment::checkMemoryLimit(\Drupal::MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
$description = [];
if ($phase == 'install') {
$description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', ['%memory_minimum_limit' => \Drupal::MINIMUM_PHP_MEMORY_LIMIT]);
}
elseif ($phase == 'update') {
$description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', ['%memory_minimum_limit' => \Drupal::MINIMUM_PHP_MEMORY_LIMIT]);
}
elseif ($phase == 'runtime') {
$description['phase'] = t('Depending on your configuration, Drupal can run with a %memory_limit PHP memory limit. However, a %memory_minimum_limit PHP memory limit or above is recommended, especially if your site uses additional custom or contributed modules.', ['%memory_limit' => $memory_limit, '%memory_minimum_limit' => \Drupal::MINIMUM_PHP_MEMORY_LIMIT]);
}
if (!empty($description['phase'])) {
if ($php_ini_path = get_cfg_var('cfg_file_path')) {
$description['memory'] = t('Increase the memory limit by editing the memory_limit parameter in the file %configuration-file and then restart your web server (or contact your system administrator or hosting provider for assistance).', ['%configuration-file' => $php_ini_path]);
}
else {
$description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
}
$handbook_link = t('For more information, see the online handbook entry for <a href=":memory-limit">increasing the PHP memory limit</a>.', [':memory-limit' => 'https://www.drupal.org/node/207036']);
$description = [
'#type' => 'inline_template',
'#template' => '{{ description_phase }} {{ description_memory }} {{ handbook }}',
'#context' => [
'description_phase' => $description['phase'],
'description_memory' => $description['memory'],
'handbook' => $handbook_link,
],
];
$requirements['php_memory_limit']['description'] = $description;
$requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
}
}
// Test if configuration files and directory are writable.
if ($phase == 'runtime') {
$conf_errors = [];
// Find the site path. Kernel service is not always available at this point,
// but is preferred, when available.
if (\Drupal::hasService('kernel')) {
$site_path = \Drupal::getContainer()->getParameter('site.path');
}
else {
$site_path = DrupalKernel::findSitePath(Request::createFromGlobals());
}
// Allow system administrators to disable permissions hardening for the site
// directory. This allows additional files in the site directory to be
// updated when they are managed in a version control system.
if (Settings::get('skip_permissions_hardening')) {
$error_value = t('Protection disabled');
// If permissions hardening is disabled, then only show a warning for a
// writable file, as a reminder, rather than an error.
$file_protection_severity = REQUIREMENT_WARNING;
}
else {
$error_value = t('Not protected');
// In normal operation, writable files or directories are an error.
$file_protection_severity = REQUIREMENT_ERROR;
if (!drupal_verify_install_file($site_path, FILE_NOT_WRITABLE, 'dir')) {
$conf_errors[] = t("The directory %file is not protected from modifications and poses a security risk. You must change the directory's permissions to be non-writable.", ['%file' => $site_path]);
}
}
foreach (['settings.php', 'settings.local.php', 'services.yml'] as $conf_file) {
$full_path = $site_path . '/' . $conf_file;
if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE, 'file', !Settings::get('skip_permissions_hardening'))) {
$conf_errors[] = t("The file %file is not protected from modifications and poses a security risk. You must change the file's permissions to be non-writable.", ['%file' => $full_path]);
}
}
if (!empty($conf_errors)) {
if (count($conf_errors) == 1) {
$description = $conf_errors[0];
}
else {
// We use twig inline_template to avoid double escaping.
$description = [
'#type' => 'inline_template',
'#template' => '{{ configuration_error_list }}',
'#context' => [
'configuration_error_list' => [
'#theme' => 'item_list',
'#items' => $conf_errors,
],
],
];
}
$requirements['configuration_files'] = [
'value' => $error_value,
'severity' => $file_protection_severity,
'description' => $description,
];
}
else {
$requirements['configuration_files'] = [
'value' => t('Protected'),
];
}
$requirements['configuration_files']['title'] = t('Configuration files');
}
// Test the contents of the .htaccess files.
if ($phase == 'runtime') {
// Try to write the .htaccess files first, to prevent false alarms in case
// (for example) the /tmp directory was wiped.
/** @var \Drupal\Core\File\HtaccessWriterInterface $htaccessWriter */
$htaccessWriter = \Drupal::service("file.htaccess_writer");
$htaccessWriter->ensure();
foreach ($htaccessWriter->defaultProtectedDirs() as $protected_dir) {
$htaccess_file = $protected_dir->getPath() . '/.htaccess';
// Check for the string which was added to the recommended .htaccess file
// in the latest security update.
if (!file_exists($htaccess_file) || !($contents = @file_get_contents($htaccess_file)) || !str_contains($contents, 'Drupal_Security_Do_Not_Remove_See_SA_2013_003')) {
$url = 'https://www.drupal.org/SA-CORE-2013-003';
$requirements[$htaccess_file] = [
// phpcs:ignore Drupal.Semantics.FunctionT.NotLiteralString
'title' => new TranslatableMarkup($protected_dir->getTitle()),
'value' => t('Not fully protected'),
'severity' => REQUIREMENT_ERROR,
'description' => t('See <a href=":url">@url</a> for information about the recommended .htaccess file which should be added to the %directory directory to help protect against arbitrary code execution.', [':url' => $url, '@url' => $url, '%directory' => $protected_dir->getPath()]),
];
}
}
}
// Report cron status.
if ($phase == 'runtime') {
$cron_config = \Drupal::config('system.cron');
// Cron warning threshold defaults to two days.
$threshold_warning = $cron_config->get('threshold.requirements_warning');
// Cron error threshold defaults to two weeks.
$threshold_error = $cron_config->get('threshold.requirements_error');
// Determine when cron last ran.
$cron_last = \Drupal::state()->get('system.cron_last');
if (!is_numeric($cron_last)) {
$cron_last = \Drupal::state()->get('install_time', 0);
}
// Determine severity based on time since cron last ran.
$severity = REQUIREMENT_INFO;
$request_time = \Drupal::time()->getRequestTime();
if ($request_time - $cron_last > $threshold_error) {
$severity = REQUIREMENT_ERROR;
}
elseif ($request_time - $cron_last > $threshold_warning) {
$severity = REQUIREMENT_WARNING;
}
// Set summary and description based on values determined above.
$summary = t('Last run @time ago', ['@time' => \Drupal::service('date.formatter')->formatTimeDiffSince($cron_last)]);
$requirements['cron'] = [
'title' => t('Cron maintenance tasks'),
'severity' => $severity,
'value' => $summary,
];
if ($severity != REQUIREMENT_INFO) {
$requirements['cron']['description'][] = [
[
'#markup' => t('Cron has not run recently.'),
'#suffix' => ' ',
],
[
'#markup' => t('For more information, see the online handbook entry for <a href=":cron-handbook">configuring cron jobs</a>.', [':cron-handbook' => 'https://www.drupal.org/docs/administering-a-drupal-site/cron-automated-tasks/cron-automated-tasks-overview']),
'#suffix' => ' ',
],
];
}
$requirements['cron']['description'][] = [
[
'#type' => 'link',
'#prefix' => '(',
'#title' => t('more information'),
'#suffix' => ')',
'#url' => Url::fromRoute('system.cron_settings'),
],
[
'#prefix' => '<span class="cron-description__run-cron">',
'#suffix' => '</span>',
'#type' => 'link',
'#title' => t('Run cron'),
'#url' => Url::fromRoute('system.run_cron'),
],
];
}
if ($phase != 'install') {
$directories = [
PublicStream::basePath(),
// By default no private files directory is configured. For private files
// to be secure the admin needs to provide a path outside the webroot.
PrivateStream::basePath(),
\Drupal::service('file_system')->getTempDirectory(),
];
}
// During an install we need to make assumptions about the file system
// unless overrides are provided in settings.php.
if ($phase == 'install') {
$directories = [];
if ($file_public_path = Settings::get('file_public_path')) {
$directories[] = $file_public_path;
}
else {
// If we are installing Drupal, the settings.php file might not exist yet
// in the intended site directory, so don't require it.
$request = Request::createFromGlobals();
$site_path = DrupalKernel::findSitePath($request);
$directories[] = $site_path . '/files';
}
if ($file_private_path = Settings::get('file_private_path')) {
$directories[] = $file_private_path;
}
if (Settings::get('file_temp_path')) {
$directories[] = Settings::get('file_temp_path');
}
else {
// If the temporary directory is not overridden use an appropriate
// temporary path for the system.
$directories[] = FileSystemComponent::getOsTemporaryDirectory();
}
}
// Check the config directory if it is defined in settings.php. If it isn't
// defined, the installer will create a valid config directory later, but
// during runtime we must always display an error.
$config_sync_directory = Settings::get('config_sync_directory');
if (!empty($config_sync_directory)) {
// If we're installing Drupal try and create the config sync directory.
if (!is_dir($config_sync_directory) && $phase == 'install') {
\Drupal::service('file_system')->prepareDirectory($config_sync_directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
}
if (!is_dir($config_sync_directory)) {
if ($phase == 'install') {
$description = t('An automated attempt to create the directory %directory failed, possibly due to a permissions problem. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see INSTALL.txt or the <a href=":handbook_url">online handbook</a>.', ['%directory' => $config_sync_directory, ':handbook_url' => 'https://www.drupal.org/server-permissions']);
}
else {
$description = t('The directory %directory does not exist.', ['%directory' => $config_sync_directory]);
}
$requirements['config sync directory'] = [
'title' => t('Configuration sync directory'),
'description' => $description,
'severity' => REQUIREMENT_ERROR,
];
}
}
if ($phase != 'install' && empty($config_sync_directory)) {
$requirements['config sync directory'] = [
'title' => t('Configuration sync directory'),
'value' => t('Not present'),
'description' => t("Your %file file must define the %setting setting as a string containing the directory in which configuration files can be found.", ['%file' => $site_path . '/settings.php', '%setting' => "\$settings['config_sync_directory']"]),
'severity' => REQUIREMENT_ERROR,
];
}
$requirements['file system'] = [
'title' => t('File system'),
];
$error = '';
// For installer, create the directories if possible.
foreach ($directories as $directory) {
if (!$directory) {
continue;
}
if ($phase == 'install') {
\Drupal::service('file_system')->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
}
$is_writable = is_writable($directory);
$is_directory = is_dir($directory);
if (!$is_writable || !$is_directory) {
$description = '';
$requirements['file system']['value'] = t('Not writable');
if (!$is_directory) {
$error = t('The directory %directory does not exist.', ['%directory' => $directory]);
}
else {
$error = t('The directory %directory is not writable.', ['%directory' => $directory]);
}
// The files directory requirement check is done only during install and
// runtime.
if ($phase == 'runtime') {
$description = t('You may need to set the correct directory at the <a href=":admin-file-system">file system settings page</a> or change the current directory\'s permissions so that it is writable.', [':admin-file-system' => Url::fromRoute('system.file_system_settings')->toString()]);
}
elseif ($phase == 'install') {
// For the installer UI, we need different wording. 'value' will
// be treated as version, so provide none there.
$description = t('An automated attempt to create this directory failed, possibly due to a permissions problem. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see INSTALL.txt or the <a href=":handbook_url">online handbook</a>.', [':handbook_url' => 'https://www.drupal.org/server-permissions']);
$requirements['file system']['value'] = '';
}
if (!empty($description)) {
$description = [
'#type' => 'inline_template',
'#template' => '{{ error }} {{ description }}',
'#context' => [
'error' => $error,
'description' => $description,
],
];
$requirements['file system']['description'] = $description;
$requirements['file system']['severity'] = REQUIREMENT_ERROR;
}
}
else {
// This function can be called before the config_cache table has been
// created.
if ($phase == 'install' || \Drupal::config('system.file')->get('default_scheme') == 'public') {
$requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
}
else {
$requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
}
}
}
// See if updates are available in update.php.
if ($phase == 'runtime') {
$requirements['update'] = [
'title' => t('Database updates'),
'value' => t('Up to date'),
];
// Check installed modules.
$has_pending_updates = FALSE;
/** @var \Drupal\Core\Update\UpdateHookRegistry $update_registry */
$update_registry = \Drupal::service('update.update_hook_registry');
foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
$updates = $update_registry->getAvailableUpdates($module);
if ($updates) {
$default = $update_registry->getInstalledVersion($module);
if (max($updates) > $default) {
$has_pending_updates = TRUE;
break;
}
}
}
if (!$has_pending_updates) {
/** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
$post_update_registry = \Drupal::service('update.post_update_registry');
$missing_post_update_functions = $post_update_registry->getPendingUpdateFunctions();
if (!empty($missing_post_update_functions)) {
$has_pending_updates = TRUE;
}
}
if ($has_pending_updates) {
$requirements['update']['severity'] = REQUIREMENT_ERROR;
$requirements['update']['value'] = t('Out of date');
$requirements['update']['description'] = t('Some modules have database schema updates to install. You should run the <a href=":update">database update script</a> immediately.', [':update' => Url::fromRoute('system.db_update')->toString()]);
}
$requirements['entity_update'] = [
'title' => t('Entity/field definitions'),
'value' => t('Up to date'),
];
// Verify that no entity updates are pending.
if ($change_list = \Drupal::entityDefinitionUpdateManager()->getChangeSummary()) {
$build = [];
foreach ($change_list as $entity_type_id => $changes) {
$entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id);
$build[] = [
'#theme' => 'item_list',
'#title' => $entity_type->getLabel(),
'#items' => $changes,
];
}
$entity_update_issues = \Drupal::service('renderer')->renderInIsolation($build);
$requirements['entity_update']['severity'] = REQUIREMENT_ERROR;
$requirements['entity_update']['value'] = t('Mismatched entity and/or field definitions');
$requirements['entity_update']['description'] = t('The following changes were detected in the entity type and field definitions. @updates', ['@updates' => $entity_update_issues]);
}
}
// Display the deployment identifier if set.
if ($phase == 'runtime') {
if ($deployment_identifier = Settings::get('deployment_identifier')) {
$requirements['deployment identifier'] = [
'title' => t('Deployment identifier'),
'value' => $deployment_identifier,
'severity' => REQUIREMENT_INFO,
];
}
}
// Verify the update.php access setting
if ($phase == 'runtime') {
if (Settings::get('update_free_access')) {
$requirements['update access'] = [
'value' => t('Not protected'),
'severity' => REQUIREMENT_ERROR,
'description' => t('The update.php script is accessible to everyone without authentication check, which is a security risk. You must change the @settings_name value in your settings.php back to FALSE.', ['@settings_name' => '$settings[\'update_free_access\']']),
];
}
else {
$requirements['update access'] = [
'value' => t('Protected'),
];
}
$requirements['update access']['title'] = t('Access to update.php');
}
// Display an error if a newly introduced dependency in a module is not
// resolved.
if ($phase === 'update' || $phase === 'runtime') {
$create_extension_incompatibility_list = function (array $extension_names, PluralTranslatableMarkup $description, PluralTranslatableMarkup $title, TranslatableMarkup|string $message = '', TranslatableMarkup|string $additional_description = '') {
if ($message === '') {
$message = new TranslatableMarkup('Review the <a href=":url"> suggestions for resolving this incompatibility</a> to repair your installation, and then re-run update.php.', [':url' => 'https://www.drupal.org/docs/updating-drupal/troubleshooting-database-updates']);
}
// Use an inline twig template to:
// - Concatenate MarkupInterface objects and preserve safeness.
// - Use the item_list theme for the extension list.
$template = [
'#type' => 'inline_template',
'#template' => '{{ description }}{{ extensions }}{{ additional_description }}<br>',
'#context' => [
'extensions' => [
'#theme' => 'item_list',
],
],
];
$template['#context']['extensions']['#items'] = $extension_names;
$template['#context']['description'] = $description;
$template['#context']['additional_description'] = $additional_description;
return [
'title' => $title,
'value' => [
'list' => $template,
'handbook_link' => [
'#markup' => $message,
],
],
'severity' => REQUIREMENT_ERROR,
];
};
$profile = \Drupal::installProfile();
$files = $module_extension_list->getList();
$files += $theme_extension_list->getList();
$core_incompatible_extensions = [];
$php_incompatible_extensions = [];
foreach ($files as $extension_name => $file) {
// Ignore uninstalled extensions and installation profiles.
if (!$file->status || $extension_name == $profile) {
continue;
}
$name = $file->info['name'];
if (!empty($file->info['core_incompatible'])) {
$core_incompatible_extensions[$file->info['type']][] = $name;
}
// Check the extension's PHP version.
$php = $file->info['php'];
if (version_compare($php, PHP_VERSION, '>')) {
$php_incompatible_extensions[$file->info['type']][] = $name;
}
// Check the module's required modules.
/** @var \Drupal\Core\Extension\Dependency $requirement */
foreach ($file->requires as $requirement) {
$required_module = $requirement->getName();
// Check if the module exists.
if (!isset($files[$required_module])) {
$requirements["$extension_name-$required_module"] = [
'title' => t('Unresolved dependency'),
'description' => t('@name requires this module.', ['@name' => $name]),
'value' => t('@required_name (Missing)', ['@required_name' => $required_module]),
'severity' => REQUIREMENT_ERROR,
];
continue;
}
// Check for an incompatible version.
$required_file = $files[$required_module];
$required_name = $required_file->info['name'];
// Remove CORE_COMPATIBILITY- only from the start of the string.
$version = preg_replace('/^(' . \Drupal::CORE_COMPATIBILITY . '\-)/', '', $required_file->info['version'] ?? '');
if (!$requirement->isCompatible($version)) {
$requirements["$extension_name-$required_module"] = [
'title' => t('Unresolved dependency'),
'description' => t('@name requires this module and version. Currently using @required_name version @version', ['@name' => $name, '@required_name' => $required_name, '@version' => $version]),
'value' => t('@required_name (Version @compatibility required)', ['@required_name' => $required_name, '@compatibility' => $requirement->getConstraintString()]),
'severity' => REQUIREMENT_ERROR,
];
continue;
}
}
}
if (!empty($core_incompatible_extensions['module'])) {
$requirements['module_core_incompatible'] = $create_extension_incompatibility_list(
$core_incompatible_extensions['module'],
new PluralTranslatableMarkup(
count($core_incompatible_extensions['module']),
'The following module is installed, but it is incompatible with Drupal @version:',
'The following modules are installed, but they are incompatible with Drupal @version:',
['@version' => \Drupal::VERSION]
),
new PluralTranslatableMarkup(
count($core_incompatible_extensions['module']),
'Incompatible module',
'Incompatible modules'
)
);
}
if (!empty($core_incompatible_extensions['theme'])) {
$requirements['theme_core_incompatible'] = $create_extension_incompatibility_list(
$core_incompatible_extensions['theme'],
new PluralTranslatableMarkup(
count($core_incompatible_extensions['theme']),
'The following theme is installed, but it is incompatible with Drupal @version:',
'The following themes are installed, but they are incompatible with Drupal @version:',
['@version' => \Drupal::VERSION]
),
new PluralTranslatableMarkup(
count($core_incompatible_extensions['theme']),
'Incompatible theme',
'Incompatible themes'
)
);
}
if (!empty($php_incompatible_extensions['module'])) {
$requirements['module_php_incompatible'] = $create_extension_incompatibility_list(
$php_incompatible_extensions['module'],
new PluralTranslatableMarkup(
count($php_incompatible_extensions['module']),
'The following module is installed, but it is incompatible with PHP @version:',
'The following modules are installed, but they are incompatible with PHP @version:',
['@version' => phpversion()]
),
new PluralTranslatableMarkup(
count($php_incompatible_extensions['module']),
'Incompatible module',
'Incompatible modules'
)
);
}
if (!empty($php_incompatible_extensions['theme'])) {
$requirements['theme_php_incompatible'] = $create_extension_incompatibility_list(
$php_incompatible_extensions['theme'],
new PluralTranslatableMarkup(
count($php_incompatible_extensions['theme']),
'The following theme is installed, but it is incompatible with PHP @version:',
'The following themes are installed, but they are incompatible with PHP @version:',
['@version' => phpversion()]
),
new PluralTranslatableMarkup(
count($php_incompatible_extensions['theme']),
'Incompatible theme',
'Incompatible themes'
)
);
}
$extension_config = \Drupal::configFactory()->get('core.extension');
// Look for removed core modules.
$is_removed_module = function ($extension_name) use ($module_extension_list) {
return !$module_extension_list->exists($extension_name)
&& array_key_exists($extension_name, DRUPAL_CORE_REMOVED_MODULE_LIST);
};
$removed_modules = array_filter(array_keys($extension_config->get('module')), $is_removed_module);
if (!empty($removed_modules)) {
$list = [];
foreach ($removed_modules as $removed_module) {
$list[] = t('<a href=":url">@module</a>', [
':url' => "https://www.drupal.org/project/$removed_module",
'@module' => DRUPAL_CORE_REMOVED_MODULE_LIST[$removed_module],
]);
}
$requirements['removed_module'] = $create_extension_incompatibility_list(
$list,
new PluralTranslatableMarkup(
count($removed_modules),
'You must add the following contributed module and reload this page.',
'You must add the following contributed modules and reload this page.'
),
new PluralTranslatableMarkup(
count($removed_modules),
'Removed core module',
'Removed core modules'
),
new TranslatableMarkup(
'For more information read the <a href=":url">documentation on deprecated modules.</a>',
[':url' => 'https://www.drupal.org/node/3223395#s-recommendations-for-deprecated-modules']
),
new PluralTranslatableMarkup(
count($removed_modules),
'This module is installed on your site but is no longer provided by Core.',
'These modules are installed on your site but are no longer provided by Core.'
),
);
}
// Look for removed core themes.
$is_removed_theme = function ($extension_name) use ($theme_extension_list) {
return !$theme_extension_list->exists($extension_name)
&& array_key_exists($extension_name, DRUPAL_CORE_REMOVED_THEME_LIST);
};
$removed_themes = array_filter(array_keys($extension_config->get('theme')), $is_removed_theme);
if (!empty($removed_themes)) {
$list = [];
foreach ($removed_themes as $removed_theme) {
$list[] = t('<a href=":url">@theme</a>', [
':url' => "https://www.drupal.org/project/$removed_theme",
'@theme' => DRUPAL_CORE_REMOVED_THEME_LIST[$removed_theme],
]);
}
$requirements['removed_theme'] = $create_extension_incompatibility_list(
$list,
new PluralTranslatableMarkup(
count($removed_themes),
'You must add the following contributed theme and reload this page.',
'You must add the following contributed themes and reload this page.'
),
new PluralTranslatableMarkup(
count($removed_themes),
'Removed core theme',
'Removed core themes'
),
new TranslatableMarkup(
'For more information read the <a href=":url">documentation on deprecated themes.</a>',
[':url' => 'https://www.drupal.org/node/3223395#s-recommendations-for-deprecated-themes']
),
new PluralTranslatableMarkup(
count($removed_themes),
'This theme is installed on your site but is no longer provided by Core.',
'These themes are installed on your site but are no longer provided by Core.'
),
);
}
// Look for missing modules.
$is_missing_module = function ($extension_name) use ($module_extension_list) {
return !$module_extension_list->exists($extension_name) && !in_array($extension_name, array_keys(DRUPAL_CORE_REMOVED_MODULE_LIST), TRUE);
};
$invalid_modules = array_filter(array_keys($extension_config->get('module')), $is_missing_module);
if (!empty($invalid_modules)) {
$requirements['invalid_module'] = $create_extension_incompatibility_list(
$invalid_modules,
new PluralTranslatableMarkup(
count($invalid_modules),
'The following module is marked as installed in the core.extension configuration, but it is missing:',
'The following modules are marked as installed in the core.extension configuration, but they are missing:'
),
new PluralTranslatableMarkup(
count($invalid_modules),
'Missing or invalid module',
'Missing or invalid modules'
)
);
}
// Look for invalid themes.
$is_missing_theme = function ($extension_name) use (&$theme_extension_list) {
return !$theme_extension_list->exists($extension_name) && !in_array($extension_name, array_keys(DRUPAL_CORE_REMOVED_THEME_LIST), TRUE);
};
$invalid_themes = array_filter(array_keys($extension_config->get('theme')), $is_missing_theme);
if (!empty($invalid_themes)) {
$requirements['invalid_theme'] = $create_extension_incompatibility_list(
$invalid_themes,
new PluralTranslatableMarkup(
count($invalid_themes),
'The following theme is marked as installed in the core.extension configuration, but it is missing:',
'The following themes are marked as installed in the core.extension configuration, but they are missing:'
),
new PluralTranslatableMarkup(
count($invalid_themes),
'Missing or invalid theme',
'Missing or invalid themes'
)
);
}
}
// Returns Unicode library status and errors.
$libraries = [
Unicode::STATUS_SINGLEBYTE => t('Standard PHP'),
Unicode::STATUS_MULTIBYTE => t('PHP Mbstring Extension'),
Unicode::STATUS_ERROR => t('Error'),
];
$severities = [
Unicode::STATUS_SINGLEBYTE => REQUIREMENT_WARNING,
Unicode::STATUS_MULTIBYTE => NULL,
Unicode::STATUS_ERROR => REQUIREMENT_ERROR,
];
$failed_check = Unicode::check();
$library = Unicode::getStatus();
$requirements['unicode'] = [
'title' => t('Unicode library'),
'value' => $libraries[$library],
'severity' => $severities[$library],
];
switch ($failed_check) {
case 'mb_strlen':
$requirements['unicode']['description'] = t('Operations on Unicode strings are emulated on a best-effort basis. Install the <a href="http://php.net/mbstring">PHP mbstring extension</a> for improved Unicode support.');
break;
case 'mbstring.encoding_translation':
$requirements['unicode']['description'] = t('Multibyte string input conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.encoding_translation</em> setting. Refer to the <a href="http://php.net/mbstring">PHP mbstring documentation</a> for more information.');
break;
}
if ($phase == 'runtime') {
// Check for update status module.
if (!\Drupal::moduleHandler()->moduleExists('update')) {
$requirements['update status'] = [
'value' => t('Not enabled'),
'severity' => REQUIREMENT_WARNING,
'description' => t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you install the Update Status module from the <a href=":module">module administration page</a> in order to stay up-to-date on new releases. For more information, <a href=":update">Update status handbook page</a>.', [
':update' => 'https://www.drupal.org/documentation/modules/update',
':module' => Url::fromRoute('system.modules_list')->toString(),
]),
];
}
else {
$requirements['update status'] = [
'value' => t('Enabled'),
];
}
$requirements['update status']['title'] = t('Update notifications');
if (Settings::get('rebuild_access')) {
$requirements['rebuild access'] = [
'title' => t('Rebuild access'),
'value' => t('Enabled'),
'severity' => REQUIREMENT_ERROR,
'description' => t('The rebuild_access setting is enabled in settings.php. It is recommended to have this setting disabled unless you are performing a rebuild.'),
];
}
}
// Check if the SameSite cookie attribute is set to a valid value. Since this
// involves checking whether we are using a secure connection this only makes
// sense inside an HTTP request, not on the command line.
if ($phase === 'runtime' && PHP_SAPI !== 'cli') {
$samesite = ini_get('session.cookie_samesite') ?: t('Not set');
// Check if the SameSite attribute is set to a valid value. If it is set to
// 'None' the request needs to be done over HTTPS.
$valid = match ($samesite) {
'Lax', 'Strict' => TRUE,
'None' => $request_object->isSecure(),
default => FALSE,
};
$requirements['php_session_samesite'] = [
'title' => t('SameSite cookie attribute'),
'value' => $samesite,
'severity' => $valid ? REQUIREMENT_OK : REQUIREMENT_WARNING,
'description' => t('This attribute should be explicitly set to Lax, Strict or None. If set to None then the request must be made via HTTPS. See <a href=":url" target="_blank">PHP documentation</a>', [
':url' => 'https://www.php.net/manual/en/session.configuration.php#ini.session.cookie-samesite',
]),
];
}
// See if trusted host names have been configured, and warn the user if they
// are not set.
if ($phase == 'runtime') {
$trusted_host_patterns = Settings::get('trusted_host_patterns');
if (empty($trusted_host_patterns)) {
$requirements['trusted_host_patterns'] = [
'title' => t('Trusted Host Settings'),
'value' => t('Not enabled'),
'description' => t('The trusted_host_patterns setting is not configured in settings.php. This can lead to security vulnerabilities. It is <strong>highly recommended</strong> that you configure this. See <a href=":url">Protecting against HTTP HOST Header attacks</a> for more information.', [':url' => 'https://www.drupal.org/docs/installing-drupal/trusted-host-settings']),
'severity' => REQUIREMENT_ERROR,
];
}
else {
$requirements['trusted_host_patterns'] = [
'title' => t('Trusted Host Settings'),
'value' => t('Enabled'),
'description' => t('The trusted_host_patterns setting is set to allow %trusted_host_patterns', ['%trusted_host_patterns' => implode(', ', $trusted_host_patterns)]),
];
}
}
// When the database driver is provided by a module, then check that the
// providing module is installed.
if ($phase === 'runtime' || $phase === 'update') {
$connection = Database::getConnection();
$provider = $connection->getProvider();
if ($provider !== 'core' && !\Drupal::moduleHandler()->moduleExists($provider)) {
$autoload = $connection->getConnectionOptions()['autoload'] ?? '';
if (str_contains($autoload, 'src/Driver/Database/')) {
$post_update_registry = \Drupal::service('update.post_update_registry');
$pending_updates = $post_update_registry->getPendingUpdateInformation();
if (!in_array('enable_provider_database_driver', array_keys($pending_updates['system']['pending'] ?? []), TRUE)) {
// Only show the warning when the post update function has run and
// the module that is providing the database driver is not installed.
$requirements['database_driver_provided_by_module'] = [
'title' => t('Database driver provided by module'),
'value' => t('Not installed'),
'description' => t('The current database driver is provided by the module: %module. The module is currently not installed. You should immediately <a href=":install">install</a> the module.', ['%module' => $provider, ':install' => Url::fromRoute('system.modules_list')->toString()]),
'severity' => REQUIREMENT_ERROR,
];
}
}
}
}
// Check xdebug.max_nesting_level, as some pages will not work if it is too
// low.
if (extension_loaded('xdebug')) {
// Setting this value to 256 was considered adequate on Xdebug 2.3
// (see http://bugs.xdebug.org/bug_view_page.php?bug_id=00001100)
$minimum_nesting_level = 256;
$current_nesting_level = ini_get('xdebug.max_nesting_level');
if ($current_nesting_level < $minimum_nesting_level) {
$requirements['xdebug_max_nesting_level'] = [
'title' => t('Xdebug settings'),
'value' => t('xdebug.max_nesting_level is set to %value.', ['%value' => $current_nesting_level]),
'description' => t('Set <code>xdebug.max_nesting_level=@level</code> in your PHP configuration as some pages in your Drupal site will not work when this setting is too low.', ['@level' => $minimum_nesting_level]),
'severity' => REQUIREMENT_ERROR,
];
}
}
// Installations on Windows can run into limitations with MAX_PATH if the
// Drupal root directory is too deep in the filesystem. Generally this shows
// up in cached Twig templates and other public files with long directory or
// file names. There is no definite root directory depth below which Drupal is
// guaranteed to function correctly on Windows. Since problems are likely
// with more than 100 characters in the Drupal root path, show an error.
if (str_starts_with(PHP_OS, 'WIN')) {
$depth = strlen(realpath(DRUPAL_ROOT . '/' . PublicStream::basePath()));
if ($depth > 120) {
$requirements['max_path_on_windows'] = [
'title' => t('Windows installation depth'),
'description' => t('The public files directory path is %depth characters. Paths longer than 120 characters will cause problems on Windows.', ['%depth' => $depth]),
'severity' => REQUIREMENT_ERROR,
];
}
}
// Check to see if dates will be limited to 1901-2038.
if (PHP_INT_SIZE <= 4) {
$requirements['limited_date_range'] = [
'title' => t('Limited date range'),
'value' => t('Your PHP installation has a limited date range.'),
'description' => t('You are running on a system where PHP is compiled or limited to using 32-bit integers. This will limit the range of dates and timestamps to the years 1901-2038. Read about the <a href=":url">limitations of 32-bit PHP</a>.', [':url' => 'https://www.drupal.org/docs/system-requirements/limitations-of-32-bit-php']),
'severity' => REQUIREMENT_WARNING,
];
}
// During installs from configuration don't support install profiles that
// implement hook_install.
if ($phase == 'install' && !empty($install_state['config_install_path'])) {
$install_hook = $install_state['parameters']['profile'] . '_install';
if (function_exists($install_hook)) {
$requirements['config_install'] = [
'title' => t('Configuration install'),
'value' => $install_state['parameters']['profile'],
'description' => t('The selected profile has a hook_install() implementation and therefore can not be installed from configuration.'),
'severity' => REQUIREMENT_ERROR,
];
}
}
if ($phase === 'runtime') {
$settings = Settings::getAll();
if (array_key_exists('install_profile', $settings)) {
// The following message is only informational because not all site owners
// have access to edit their settings.php as it may be controlled by their
// hosting provider.
$requirements['install_profile_in_settings'] = [
'title' => t('Install profile in settings'),
'value' => t("Drupal 9 no longer uses the \$settings['install_profile'] value in settings.php and it should be removed."),
'severity' => REQUIREMENT_WARNING,
];
}
}
// Ensure that no module has a current schema version that is lower than the
// one that was last removed.
if ($phase == 'update') {
$module_handler = \Drupal::moduleHandler();
/** @var \Drupal\Core\Update\UpdateHookRegistry $update_registry */
$update_registry = \Drupal::service('update.update_hook_registry');
$module_list = [];
// hook_update_last_removed() is a procedural hook hook because we
// do not have classes loaded that would be needed.
// Simply inlining the old hook mechanism is better than making
// ModuleInstaller::invoke() public.
foreach ($module_handler->getModuleList() as $module => $extension) {
$function = $module . '_update_last_removed';
if (function_exists($function)) {
$last_removed = $function();
if ($last_removed && $last_removed > $update_registry->getInstalledVersion($module)) {
/** @var \Drupal\Core\Extension\Extension $module_info */
$module_info = $module_extension_list->get($module);
$module_list[$module] = [
'name' => $module_info->info['name'],
'last_removed' => $last_removed,
'installed_version' => $update_registry->getInstalledVersion($module),
];
}
}
}
// If user module is in the list then only show a specific message for
// Drupal core.
if (isset($module_list['user'])) {
$requirements['user_update_last_removed'] = [
'title' => t('The version of Drupal you are trying to update from is too old'),
'description' => t('Updating to Drupal @current_major is only supported from Drupal version @required_min_version or higher. If you are trying to update from an older version, first update to the latest version of Drupal @previous_major. (<a href=":url">Drupal upgrade guide</a>)', [
'@current_major' => 10,
'@required_min_version' => '9.4.0',
'@previous_major' => 9,
':url' => 'https://www.drupal.org/docs/upgrading-drupal/drupal-8-and-higher',
]),
'severity' => REQUIREMENT_ERROR,
];
}
else {
foreach ($module_list as $module => $data) {
$requirements[$module . '_update_last_removed'] = [
'title' => t('Unsupported schema version: @module', ['@module' => $data['name']]),
'description' => t('The installed version of the %module module is too old to update. Update to an intermediate version first (last removed version: @last_removed_version, installed version: @installed_version).', [
'%module' => $data['name'],
'@last_removed_version' => $data['last_removed'],
'@installed_version' => $data['installed_version'],
]),
'severity' => REQUIREMENT_ERROR,
];
}
}
// Also check post-updates. Only do this if we're not already showing an
// error for hook_update_N().
$missing_updates = [];
if (empty($module_list)) {
$existing_updates = \Drupal::service('keyvalue')->get('post_update')->get('existing_updates', []);
$post_update_registry = \Drupal::service('update.post_update_registry');
$modules = \Drupal::moduleHandler()->getModuleList();
foreach ($modules as $module => $extension) {
$module_info = $module_extension_list->get($module);
$removed_post_updates = $post_update_registry->getRemovedPostUpdates($module);
if ($missing_updates = array_diff(array_keys($removed_post_updates), $existing_updates)) {
$versions = array_unique(array_intersect_key($removed_post_updates, array_flip($missing_updates)));
$description = new PluralTranslatableMarkup(count($versions),
'The installed version of the %module module is too old to update. Update to a version prior to @versions first (missing updates: @missing_updates).',
'The installed version of the %module module is too old to update. Update first to a version prior to all of the following: @versions (missing updates: @missing_updates).',
[
'%module' => $module_info->info['name'],
'@missing_updates' => implode(', ', $missing_updates),
'@versions' => implode(', ', $versions),
]
);
$requirements[$module . '_post_update_removed'] = [
'title' => t('Missing updates for: @module', ['@module' => $module_info->info['name']]),
'description' => $description,
'severity' => REQUIREMENT_ERROR,
];
}
}
}
if (empty($missing_updates)) {
foreach ($update_registry->getAllEquivalentUpdates() as $module => $equivalent_updates) {
$module_info = $module_extension_list->get($module);
foreach ($equivalent_updates as $future_update => $data) {
$future_update_function_name = $module . '_update_' . $future_update;
$ran_update_function_name = $module . '_update_' . $data['ran_update'];
// If an update was marked as an equivalent by a previous update, and
// both the previous update and the equivalent update are not found in
// the current code base, prevent updating. This indicates a site
// attempting to go 'backwards' in terms of database schema.
// @see \Drupal\Core\Update\UpdateHookRegistry::markFutureUpdateEquivalent()
if (!function_exists($ran_update_function_name) && !function_exists($future_update_function_name)) {
// If the module is provided by core prepend helpful text as the
// module does not exist in composer or Drupal.org.
if (str_starts_with($module_info->getPathname(), 'core/')) {
$future_version_string = 'Drupal Core ' . $data['future_version_string'];
}
else {
$future_version_string = $data['future_version_string'];
}
$requirements[$module . '_equivalent_update_missing'] = [
'title' => t('Missing updates for: @module', ['@module' => $module_info->info['name']]),
'description' => t('The version of the %module module that you are attempting to update to is missing update @future_update (which was marked as an equivalent by @ran_update). Update to at least @future_version_string.', [
'%module' => $module_info->info['name'],
'@ran_update' => $data['ran_update'],
'@future_update' => $future_update,
'@future_version_string' => $future_version_string,
]),
'severity' => REQUIREMENT_ERROR,
];
break;
}
}
}
}
}
// Add warning when twig debug option is enabled.
if ($phase === 'runtime') {
$development_settings = \Drupal::keyValue('development_settings');
$twig_debug = $development_settings->get('twig_debug', FALSE);
$twig_cache_disable = $development_settings->get('twig_cache_disable', FALSE);
if ($twig_debug || $twig_cache_disable) {
$requirements['twig_debug_enabled'] = [
'title' => t('Twig development mode'),
'value' => t('Twig development mode settings are turned on. Go to @link to disable them.', [
'@link' => Link::createFromRoute(
'development settings page',
'system.development_settings',
)->toString(),
]),
'severity' => REQUIREMENT_WARNING,
];
}
$render_cache_disabled = $development_settings->get('disable_rendered_output_cache_bins', FALSE);
if ($render_cache_disabled) {
$requirements['render_cache_disabled'] = [
'title' => t('Markup caching disabled'),
'value' => t('Render cache, dynamic page cache, and page cache are bypassed. Go to @link to enable them.', [
'@link' => Link::createFromRoute(
'development settings page',
'system.development_settings',
)->toString(),
]),
'severity' => REQUIREMENT_WARNING,
];
}
}
return $requirements;
}
/**
* Implements hook_install().
*/
function system_install(): void {
// Populate the cron key state variable.
$cron_key = Crypt::randomBytesBase64(55);
\Drupal::state()->set('system.cron_key', $cron_key);
// Populate the site UUID and default name (if not set).
$site = \Drupal::configFactory()->getEditable('system.site');
$site->set('uuid', \Drupal::service('uuid')->generate());
if (!$site->get('name')) {
$site->set('name', 'Drupal');
}
$site->save(TRUE);
// Populate the dummy query string added to all CSS and JavaScript files.
\Drupal::service('asset.query_string')->reset();
}
/**
* Implements hook_schema().
*/
function system_schema(): array {
// @deprecated The sequences table has been deprecated in drupal:10.2.0 and is
// removed from drupal:12.0.0. See https://www.drupal.org/node/3220378.
// @todo Remove sequences table in Drupal 12. See https://www.drupal.org/i/3335756
$schema['sequences'] = [
'description' => 'Stores IDs.',
'fields' => [
'value' => [
'description' => 'The value of the sequence.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
],
],
'primary key' => ['value'],
];
return $schema;
}
/**
* Implements hook_update_last_removed().
*/
function system_update_last_removed(): int {
return 10201;
}
/**
* Add a [time] column to the {simpletest} table, if existing.
*/
function system_update_11200(): void {
$schema = \Drupal::database()->schema();
if ($schema->tableExists('simpletest') && !$schema->fieldExists('simpletest', 'time')) {
$schema->addField('simpletest', 'time', [
'type' => 'float',
'not null' => TRUE,
'default' => 0,
'description' => 'Time elapsed for the execution of the test.',
]);
}
}
/**
* Display requirements from security advisories.
*
* @param array[] $requirements
* The requirements array as specified in hook_requirements().
*/
function _system_advisories_requirements(array &$requirements): void {
if (!\Drupal::config('system.advisories')->get('enabled')) {
return;
}
/** @var \Drupal\system\SecurityAdvisories\SecurityAdvisoriesFetcher $fetcher */
$fetcher = \Drupal::service('system.sa_fetcher');
try {
$advisories = $fetcher->getSecurityAdvisories(TRUE, 5);
}
catch (ClientExceptionInterface $exception) {
$requirements['system_advisories']['title'] = t('Critical security announcements');
$requirements['system_advisories']['severity'] = REQUIREMENT_WARNING;
$requirements['system_advisories']['description'] = ['#theme' => 'system_security_advisories_fetch_error_message'];
Error::logException(\Drupal::logger('system'), $exception, 'Failed to retrieve security advisory data.');
return;
}
if (!empty($advisories)) {
$advisory_links = [];
$severity = REQUIREMENT_WARNING;
foreach ($advisories as $advisory) {
if (!$advisory->isPsa()) {
$severity = REQUIREMENT_ERROR;
}
$advisory_links[] = new Link($advisory->getTitle(), Url::fromUri($advisory->getUrl()));
}
$requirements['system_advisories']['title'] = t('Critical security announcements');
$requirements['system_advisories']['severity'] = $severity;
$requirements['system_advisories']['description'] = [
'list' => [
'#theme' => 'item_list',
'#items' => $advisory_links,
],
];
if (\Drupal::moduleHandler()->moduleExists('help')) {
$requirements['system_advisories']['description']['help_link'] = Link::createFromRoute(
'What are critical security announcements?',
'help.page', ['name' => 'system'],
['fragment' => 'security-advisories']
)->toRenderable();
}
}
}
/**
* Invalidate container because the module handler has changed.
*/
function system_update_11100(): void {
\Drupal::service('kernel')->invalidateContainer();
}
/**
* Update length of menu_tree fields url and route_param_key from 255 to 2048.
*/
function system_update_11001(): void {
$schema = \Drupal::database()->schema();
$spec = [
'description' => 'The external path this link points to (when not using a route).',
'type' => 'varchar',
'length' => 2048,
'not null' => TRUE,
'default' => '',
];
$schema->changeField('menu_tree', 'url', 'url', $spec);
$spec = [
'description' => 'An encoded string of route parameters for loading by route.',
'type' => 'varchar',
'length' => 2048,
];
$schema->changeField('menu_tree', 'route_param_key', 'route_param_key', $spec);
}
/**
* Equivalent update to 10400.
*/
function system_update_11102(): TranslatableMarkup|null {
// This is a no-op that exists to prevent an upgrade from 10.4+ to 11.0. That
// path is actually a downgrade.
$equivalent_update = \Drupal::service('update.update_hook_registry')
->getEquivalentUpdate();
if ($equivalent_update instanceof EquivalentUpdate) {
return $equivalent_update->toSkipMessage();
}
return NULL;
}
/**
* Add the [alias] field to the {router} table.
*/
function system_update_11201(): void {
$schema = \Drupal::database()->schema();
if ($schema->tableExists('router') && !$schema->fieldExists('router', 'alias')) {
$spec = [
'fields' => [
'alias' => [
'description' => 'The alias of the route, if applicable.',
'type' => 'varchar_ascii',
'length' => 255,
],
],
];
$schema->addField('router', 'alias', $spec['fields']['alias']);
$schema->addIndex('router', 'alias', ['alias'], $spec);
}
}
|