-
Notifications
You must be signed in to change notification settings - Fork 653
/
BackendUtility.php
4571 lines (4340 loc) · 205 KB
/
BackendUtility.php
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
namespace TYPO3\CMS\Backend\Utility;
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
use Psr\Log\LoggerInterface;
use TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;
use TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\Query\QueryHelper;
use TYPO3\CMS\Core\Database\Query\Restriction\BackendWorkspaceRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
use TYPO3\CMS\Core\Database\RelationHandler;
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
use TYPO3\CMS\Core\Http\ServerRequest;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Resource\AbstractFile;
use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
use TYPO3\CMS\Core\Resource\File;
use TYPO3\CMS\Core\Resource\ProcessedFile;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Routing\PageUriBuilder;
use TYPO3\CMS\Core\Routing\SiteMatcher;
use TYPO3\CMS\Core\Site\Entity\PseudoSite;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Core\Utility\PathUtility;
use TYPO3\CMS\Core\Versioning\VersionState;
use TYPO3\CMS\Frontend\Compatibility\LegacyDomainResolver;
use TYPO3\CMS\Frontend\Page\PageRepository;
/**
* Standard functions available for the TYPO3 backend.
* You are encouraged to use this class in your own applications (Backend Modules)
* Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.
*
* Call ALL methods without making an object!
* Eg. to get a page-record 51 do this: '\TYPO3\CMS\Backend\Utility\BackendUtility::getRecord('pages',51)'
*/
class BackendUtility
{
/**
* Cache the TCA configuration of tables with their types during runtime
*
* @var array
* @see self::getTCAtypes()
* @deprecated since TYPO3 v9.4 will be removed in TYPO3 v10.0.
*/
protected static $tcaTableTypeConfigurationCache = [];
/*******************************************
*
* SQL-related, selecting records, searching
*
*******************************************/
/**
* Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
* is configured in $GLOBALS['TCA'] for the tablename, $table
* This function should ALWAYS be called in the backend for selection on tables which
* are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
* even if they are marked deleted (in which case the system must always treat them as non-existent!)
* In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
* and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
* on those fields as well in the backend you can use ->BEenableFields() though.
*
* @param string $table Table name present in $GLOBALS['TCA']
* @param string $tableAlias Table alias if any
* @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10, the DeletedRestriction functionality should be used instead.
*/
public static function deleteClause($table, $tableAlias = '')
{
trigger_error('This method will be removed in TYPO3 v10. Add the delete statement directly in your SQL statement via the DeletedRestriction', E_USER_DEPRECATED);
if (empty($GLOBALS['TCA'][$table]['ctrl']['delete'])) {
return '';
}
$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable($table)
->expr();
return ' AND ' . $expressionBuilder->eq(
($tableAlias ?: $table) . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'],
0
);
}
/**
* Gets record with uid = $uid from $table
* You can set $field to a list of fields (default is '*')
* Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1')
* Will automatically check if records has been deleted and if so, not return anything.
* $table must be found in $GLOBALS['TCA']
*
* @param string $table Table name present in $GLOBALS['TCA']
* @param int $uid UID of record
* @param string $fields List of fields to select
* @param string $where Additional WHERE clause, eg. " AND blablabla = 0
* @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
* @return array|null Returns the row if found, otherwise NULL
*/
public static function getRecord($table, $uid, $fields = '*', $where = '', $useDeleteClause = true)
{
// Ensure we have a valid uid (not 0 and not NEWxxxx) and a valid TCA
if ((int)$uid && !empty($GLOBALS['TCA'][$table])) {
$queryBuilder = static::getQueryBuilderForTable($table);
// do not use enabled fields here
$queryBuilder->getRestrictions()->removeAll();
// should the delete clause be used
if ($useDeleteClause) {
$queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
}
// set table and where clause
$queryBuilder
->select(...GeneralUtility::trimExplode(',', $fields, true))
->from($table)
->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter((int)$uid, \PDO::PARAM_INT)));
// add custom where clause
if ($where) {
$queryBuilder->andWhere(QueryHelper::stripLogicalOperatorPrefix($where));
}
$row = $queryBuilder->execute()->fetch();
if ($row) {
return $row;
}
}
return null;
}
/**
* Like getRecord(), but overlays workspace version if any.
*
* @param string $table Table name present in $GLOBALS['TCA']
* @param int $uid UID of record
* @param string $fields List of fields to select
* @param string $where Additional WHERE clause, eg. " AND blablabla = 0
* @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
* @param bool $unsetMovePointers If TRUE the function does not return a "pointer" row for moved records in a workspace
* @return array Returns the row if found, otherwise nothing
*/
public static function getRecordWSOL(
$table,
$uid,
$fields = '*',
$where = '',
$useDeleteClause = true,
$unsetMovePointers = false
) {
if ($fields !== '*') {
$internalFields = GeneralUtility::uniqueList($fields . ',uid,pid');
$row = self::getRecord($table, $uid, $internalFields, $where, $useDeleteClause);
self::workspaceOL($table, $row, -99, $unsetMovePointers);
if (is_array($row)) {
foreach ($row as $key => $_) {
if (!GeneralUtility::inList($fields, $key) && $key[0] !== '_') {
unset($row[$key]);
}
}
}
} else {
$row = self::getRecord($table, $uid, $fields, $where, $useDeleteClause);
self::workspaceOL($table, $row, -99, $unsetMovePointers);
}
return $row;
}
/**
* Purges computed properties starting with underscore character ('_').
*
* @param array $record
* @return array
*/
public static function purgeComputedPropertiesFromRecord(array $record): array
{
return array_filter(
$record,
function (string $propertyName): bool {
return $propertyName[0] !== '_';
},
ARRAY_FILTER_USE_KEY
);
}
/**
* Purges computed property names starting with underscore character ('_').
*
* @param array $propertyNames
* @return array
*/
public static function purgeComputedPropertyNames(array $propertyNames): array
{
return array_filter(
$propertyNames,
function (string $propertyName): bool {
return $propertyName[0] !== '_';
}
);
}
/**
* Makes an backwards explode on the $str and returns an array with ($table, $uid).
* Example: tt_content_45 => ['tt_content', 45]
*
* @param string $str [tablename]_[uid] string to explode
* @return array
*/
public static function splitTable_Uid($str)
{
list($uid, $table) = explode('_', strrev($str), 2);
return [strrev($table), strrev($uid)];
}
/**
* Backend implementation of enableFields()
* Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
* Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
* $GLOBALS["SIM_ACCESS_TIME"] is used for date.
*
* @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
* @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
* @return string WHERE clause part
*/
public static function BEenableFields($table, $inv = false)
{
$ctrl = $GLOBALS['TCA'][$table]['ctrl'];
$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getConnectionForTable($table)
->getExpressionBuilder();
$query = $expressionBuilder->andX();
$invQuery = $expressionBuilder->orX();
if (is_array($ctrl)) {
if (is_array($ctrl['enablecolumns'])) {
if ($ctrl['enablecolumns']['disabled'] ?? false) {
$field = $table . '.' . $ctrl['enablecolumns']['disabled'];
$query->add($expressionBuilder->eq($field, 0));
$invQuery->add($expressionBuilder->neq($field, 0));
}
if ($ctrl['enablecolumns']['starttime'] ?? false) {
$field = $table . '.' . $ctrl['enablecolumns']['starttime'];
$query->add($expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME']));
$invQuery->add(
$expressionBuilder->andX(
$expressionBuilder->neq($field, 0),
$expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
)
);
}
if ($ctrl['enablecolumns']['endtime'] ?? false) {
$field = $table . '.' . $ctrl['enablecolumns']['endtime'];
$query->add(
$expressionBuilder->orX(
$expressionBuilder->eq($field, 0),
$expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
)
);
$invQuery->add(
$expressionBuilder->andX(
$expressionBuilder->neq($field, 0),
$expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
)
);
}
}
}
if ($query->count() === 0) {
return '';
}
return ' AND ' . ($inv ? $invQuery : $query);
}
/**
* Fetches the localization for a given record.
*
* @param string $table Table name present in $GLOBALS['TCA']
* @param int $uid The uid of the record
* @param int $language The uid of the language record in sys_language
* @param string $andWhereClause Optional additional WHERE clause (default: '')
* @return mixed Multidimensional array with selected records; if none exist, FALSE is returned
*/
public static function getRecordLocalization($table, $uid, $language, $andWhereClause = '')
{
$recordLocalization = false;
if (self::isTableLocalizable($table)) {
$tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable($table);
$queryBuilder->getRestrictions()
->removeAll()
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
->add(GeneralUtility::makeInstance(BackendWorkspaceRestriction::class));
$queryBuilder->select('*')
->from($table)
->where(
$queryBuilder->expr()->eq(
$tcaCtrl['translationSource'] ?? $tcaCtrl['transOrigPointerField'],
$queryBuilder->createNamedParameter($uid, \PDO::PARAM_INT)
),
$queryBuilder->expr()->eq(
$tcaCtrl['languageField'],
$queryBuilder->createNamedParameter((int)$language, \PDO::PARAM_INT)
)
)
->setMaxResults(1);
if ($andWhereClause) {
$queryBuilder->andWhere(QueryHelper::stripLogicalOperatorPrefix($andWhereClause));
}
$recordLocalization = $queryBuilder->execute()->fetchAll();
}
return $recordLocalization;
}
/*******************************************
*
* Page tree, TCA related
*
*******************************************/
/**
* Returns what is called the 'RootLine'. That is an array with information about the page records from a page id
* ($uid) and back to the root.
* By default deleted pages are filtered.
* This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known
* from the frontend where the rootline stops when a root-template is found.
*
* @param int $uid Page id for which to create the root line.
* @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that
* stops the process if we meet a page, the user has no reading access to.
* @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is
* usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
* @param string[] $additionalFields Additional Fields to select for rootline records
* @return array Root line array, all the way to the page tree root (or as far as $clause allows!)
*/
public static function BEgetRootLine($uid, $clause = '', $workspaceOL = false, array $additionalFields = [])
{
$runtimeCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('cache_runtime');
$beGetRootLineCache = $runtimeCache->get('backendUtilityBeGetRootLine') ?: [];
$output = [];
$pid = $uid;
$ident = $pid . '-' . $clause . '-' . $workspaceOL . ($additionalFields ? '-' . implode(',', $additionalFields) : '');
if (is_array($beGetRootLineCache[$ident] ?? false)) {
$output = $beGetRootLineCache[$ident];
} else {
$loopCheck = 100;
$theRowArray = [];
while ($uid != 0 && $loopCheck) {
$loopCheck--;
$row = self::getPageForRootline($uid, $clause, $workspaceOL, $additionalFields);
if (is_array($row)) {
$uid = $row['pid'];
$theRowArray[] = $row;
} else {
break;
}
}
if ($uid == 0) {
$theRowArray[] = [
'uid' => 0,
'pid' => null,
'title' => '',
'doktype' => null,
'slug' => null,
'tsconfig_includes' => null,
'TSconfig' => null,
'is_siteroot' => null,
't3ver_oid' => null,
't3ver_wsid' => null,
't3ver_state' => null,
't3ver_stage' => null,
'backend_layout_next_level' => null
];
}
$c = count($theRowArray);
foreach ($theRowArray as $val) {
$c--;
$fields = [
'uid',
'pid',
'title',
'doktype',
'slug',
'tsconfig_includes',
'TSconfig',
'is_siteroot',
't3ver_oid',
't3ver_wsid',
't3ver_state',
't3ver_stage',
'backend_layout_next_level',
];
$fields = array_merge($fields, $additionalFields);
$output[$c] = array_intersect_key($val, array_combine($fields, $fields));
if (isset($val['_ORIG_pid'])) {
$output[$c]['_ORIG_pid'] = $val['_ORIG_pid'];
}
}
$beGetRootLineCache[$ident] = $output;
$runtimeCache->set('backendUtilityBeGetRootLine', $beGetRootLineCache);
}
return $output;
}
/**
* Gets the cached page record for the rootline
*
* @param int $uid Page id for which to create the root line.
* @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
* @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
* @param string[] $additionalFields AdditionalFields to fetch from the root line
* @return array Cached page record for the rootline
* @see BEgetRootLine
*/
protected static function getPageForRootline($uid, $clause, $workspaceOL, array $additionalFields = [])
{
$runtimeCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('cache_runtime');
$pageForRootlineCache = $runtimeCache->get('backendUtilityPageForRootLine') ?: [];
$ident = $uid . '-' . $clause . '-' . $workspaceOL;
if (is_array($pageForRootlineCache[$ident] ?? false)) {
$row = $pageForRootlineCache[$ident];
} else {
$queryBuilder = static::getQueryBuilderForTable('pages');
$queryBuilder->getRestrictions()
->removeAll()
->add(GeneralUtility::makeInstance(DeletedRestriction::class));
$row = $queryBuilder
->select(
'pid',
'uid',
'title',
'doktype',
'slug',
'tsconfig_includes',
'TSconfig',
'is_siteroot',
't3ver_oid',
't3ver_wsid',
't3ver_state',
't3ver_stage',
'backend_layout_next_level',
...$additionalFields
)
->from('pages')
->where(
$queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($uid, \PDO::PARAM_INT)),
QueryHelper::stripLogicalOperatorPrefix($clause)
)
->execute()
->fetch();
if ($row) {
$newLocation = false;
if ($workspaceOL) {
self::workspaceOL('pages', $row);
$newLocation = self::getMovePlaceholder('pages', $row['uid'], 'pid');
}
if (is_array($row)) {
if ($newLocation !== false) {
$row['pid'] = $newLocation['pid'];
} else {
self::fixVersioningPid('pages', $row);
}
$pageForRootlineCache[$ident] = $row;
$runtimeCache->set('backendUtilityPageForRootLine', $pageForRootlineCache);
}
}
}
return $row;
}
/**
* Opens the page tree to the specified page id
*
* @param int $pid Page id.
* @param bool $clearExpansion If set, then other open branches are closed.
*/
public static function openPageTree($pid, $clearExpansion)
{
$beUser = static::getBackendUserAuthentication();
// Get current expansion data:
if ($clearExpansion) {
$expandedPages = [];
} else {
$expandedPages = unserialize($beUser->uc['browseTrees']['browsePages']);
}
// Get rootline:
$rL = self::BEgetRootLine($pid);
// First, find out what mount index to use (if more than one DB mount exists):
$mountIndex = 0;
$mountKeys = array_flip($beUser->returnWebmounts());
foreach ($rL as $rLDat) {
if (isset($mountKeys[$rLDat['uid']])) {
$mountIndex = $mountKeys[$rLDat['uid']];
break;
}
}
// Traverse rootline and open paths:
foreach ($rL as $rLDat) {
$expandedPages[$mountIndex][$rLDat['uid']] = 1;
}
// Write back:
$beUser->uc['browseTrees']['browsePages'] = serialize($expandedPages);
$beUser->writeUC();
}
/**
* Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
* Each part of the path will be limited to $titleLimit characters
* Deleted pages are filtered out.
*
* @param int $uid Page uid for which to create record path
* @param string $clause Clause is additional where clauses, eg.
* @param int $titleLimit Title limit
* @param int $fullTitleLimit Title limit of Full title (typ. set to 1000 or so)
* @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
*/
public static function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit = 0)
{
if (!$titleLimit) {
$titleLimit = 1000;
}
$output = $fullOutput = '/';
$clause = trim($clause);
if ($clause !== '' && substr($clause, 0, 3) !== 'AND') {
$clause = 'AND ' . $clause;
}
$data = self::BEgetRootLine($uid, $clause);
foreach ($data as $record) {
if ($record['uid'] === 0) {
continue;
}
$output = '/' . GeneralUtility::fixed_lgd_cs(strip_tags($record['title']), $titleLimit) . $output;
if ($fullTitleLimit) {
$fullOutput = '/' . GeneralUtility::fixed_lgd_cs(strip_tags($record['title']), $fullTitleLimit) . $fullOutput;
}
}
if ($fullTitleLimit) {
return [$output, $fullOutput];
}
return $output;
}
/**
* Gets the original translation pointer table, which is always the same table
*
* @param string $table Name of the table
* @return string Pointer table (if any)
*/
public static function getOriginalTranslationTable($table)
{
trigger_error('Starting with TYPO3 v9, the translation table is always the same as the original table, because pages_language_overlay has been migrated into pages table.', E_USER_DEPRECATED);
return $table;
}
/**
* Determines whether a table is localizable and has the languageField and transOrigPointerField set in $GLOBALS['TCA'].
*
* @param string $table The table to check
* @return bool Whether a table is localizable
*/
public static function isTableLocalizable($table)
{
$isLocalizable = false;
if (isset($GLOBALS['TCA'][$table]['ctrl']) && is_array($GLOBALS['TCA'][$table]['ctrl'])) {
$tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
$isLocalizable = isset($tcaCtrl['languageField']) && $tcaCtrl['languageField'] && isset($tcaCtrl['transOrigPointerField']) && $tcaCtrl['transOrigPointerField'];
}
return $isLocalizable;
}
/**
* Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not.
* If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
* In any case ->isInWebMount must return TRUE for the user (regardless of $perms_clause)
*
* @param int $id Page uid for which to check read-access
* @param string $perms_clause This is typically a value generated with static::getBackendUserAuthentication()->getPagePermsClause(1);
* @return array|bool Returns page record if OK, otherwise FALSE.
*/
public static function readPageAccess($id, $perms_clause)
{
if ((string)$id !== '') {
$id = (int)$id;
if (!$id) {
if (static::getBackendUserAuthentication()->isAdmin()) {
return ['_thePath' => '/'];
}
} else {
$pageinfo = self::getRecord('pages', $id, '*', $perms_clause);
if ($pageinfo['uid'] && static::getBackendUserAuthentication()->isInWebMount($id, $perms_clause)) {
self::workspaceOL('pages', $pageinfo);
if (is_array($pageinfo)) {
self::fixVersioningPid('pages', $pageinfo);
list($pageinfo['_thePath'], $pageinfo['_thePathFull']) = self::getRecordPath((int)$pageinfo['uid'], $perms_clause, 15, 1000);
return $pageinfo;
}
}
}
}
return false;
}
/**
* Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
*
* @param string $table Table name (present in TCA)
* @param array $rec Record from $table
* @param bool $useFieldNameAsKey If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
* @return array|null
* @deprecated since TYPO3 v9.4 will be removed in TYPO3 v10.0.
*/
public static function getTCAtypes($table, $rec, $useFieldNameAsKey = false)
{
trigger_error('BackendUtility::getTCAtypes will be removed in TYPO3 v10. The method is not in use anymore.', E_USER_DEPRECATED);
if (isset($GLOBALS['TCA'][$table])) {
// Get type value:
$fieldValue = self::getTCAtypeValue($table, $rec);
$cacheIdentifier = $table . '-type-' . $fieldValue . '-fnk-' . $useFieldNameAsKey;
// Fetch from first-level-cache if available
if (isset(self::$tcaTableTypeConfigurationCache[$cacheIdentifier])) {
return self::$tcaTableTypeConfigurationCache[$cacheIdentifier];
}
// Get typesConf
$typesConf = $GLOBALS['TCA'][$table]['types'][$fieldValue] ?? null;
// Get fields list and traverse it
$fieldList = explode(',', $typesConf['showitem']);
// Add subtype fields e.g. for a valid RTE transformation
// The RTE runs the DB -> RTE transformation only, if the RTE field is part of the getTCAtypes array
if (isset($typesConf['subtype_value_field'])) {
$subType = $rec[$typesConf['subtype_value_field']];
if (isset($typesConf['subtypes_addlist'][$subType])) {
$subFields = GeneralUtility::trimExplode(',', $typesConf['subtypes_addlist'][$subType], true);
$fieldList = array_merge($fieldList, $subFields);
}
}
// Add palette fields e.g. for a valid RTE transformation
$paletteFieldList = [];
foreach ($fieldList as $fieldData) {
$fieldDataArray = GeneralUtility::trimExplode(';', $fieldData);
// first two entries would be fieldname and altTitle, they are not used here.
$pPalette = $fieldDataArray[2] ?? null;
if ($pPalette
&& isset($GLOBALS['TCA'][$table]['palettes'][$pPalette])
&& is_array($GLOBALS['TCA'][$table]['palettes'][$pPalette])
&& isset($GLOBALS['TCA'][$table]['palettes'][$pPalette]['showitem'])
) {
$paletteFields = GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['palettes'][$pPalette]['showitem'], true);
foreach ($paletteFields as $paletteField) {
if ($paletteField !== '--linebreak--') {
$paletteFieldList[] = $paletteField;
}
}
}
}
$fieldList = array_merge($fieldList, $paletteFieldList);
$altFieldList = [];
// Traverse fields in types config and parse the configuration into a nice array:
foreach ($fieldList as $k => $v) {
$vArray = GeneralUtility::trimExplode(';', $v);
$fieldList[$k] = [
'field' => $vArray[0],
'title' => $vArray[1] ?? null,
'palette' => $vArray[2] ?? null,
'spec' => [],
'origString' => $v
];
if ($useFieldNameAsKey) {
$altFieldList[$fieldList[$k]['field']] = $fieldList[$k];
}
}
if ($useFieldNameAsKey) {
$fieldList = $altFieldList;
}
// Add to first-level-cache
self::$tcaTableTypeConfigurationCache[$cacheIdentifier] = $fieldList;
// Return array:
return $fieldList;
}
return null;
}
/**
* Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $GLOBALS['TCA']
* If no "type" field is configured in the "ctrl"-section of the $GLOBALS['TCA'] for the table, zero is used.
* If zero is not an index in the "types" section of $GLOBALS['TCA'] for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)
*
* Note: This method is very similar to the type determination of FormDataProvider/DatabaseRecordTypeValue,
* however, it has two differences:
* 1) The method in TCEForms also takes care of localization (which is difficult to do here as the whole infrastructure for language overlays is only in TCEforms).
* 2) The $row array looks different in TCEForms, as in there it's not the raw record but the prepared data from other providers is handled, which changes e.g. how "select"
* and "group" field values are stored, which makes different processing of the "foreign pointer field" type field variant necessary.
*
* @param string $table Table name present in TCA
* @param array $row Record from $table
* @throws \RuntimeException
* @return string Field value
*/
public static function getTCAtypeValue($table, $row)
{
$typeNum = 0;
if ($GLOBALS['TCA'][$table]) {
$field = $GLOBALS['TCA'][$table]['ctrl']['type'];
if (strpos($field, ':') !== false) {
list($pointerField, $foreignTableTypeField) = explode(':', $field);
// Get field value from database if field is not in the $row array
if (!isset($row[$pointerField])) {
$localRow = self::getRecord($table, $row['uid'], $pointerField);
$foreignUid = $localRow[$pointerField];
} else {
$foreignUid = $row[$pointerField];
}
if ($foreignUid) {
$fieldConfig = $GLOBALS['TCA'][$table]['columns'][$pointerField]['config'];
$relationType = $fieldConfig['type'];
if ($relationType === 'select') {
$foreignTable = $fieldConfig['foreign_table'];
} elseif ($relationType === 'group') {
$allowedTables = explode(',', $fieldConfig['allowed']);
$foreignTable = $allowedTables[0];
} else {
throw new \RuntimeException(
'TCA foreign field pointer fields are only allowed to be used with group or select field types.',
1325862240
);
}
$foreignRow = self::getRecord($foreignTable, $foreignUid, $foreignTableTypeField);
if ($foreignRow[$foreignTableTypeField]) {
$typeNum = $foreignRow[$foreignTableTypeField];
}
}
} else {
$typeNum = $row[$field];
}
// If that value is an empty string, set it to "0" (zero)
if (empty($typeNum)) {
$typeNum = 0;
}
}
// If current typeNum doesn't exist, set it to 0 (or to 1 for historical reasons, if 0 doesn't exist)
if (!isset($GLOBALS['TCA'][$table]['types'][$typeNum]) || !$GLOBALS['TCA'][$table]['types'][$typeNum]) {
$typeNum = isset($GLOBALS['TCA'][$table]['types']['0']) ? 0 : 1;
}
// Force to string. Necessary for eg '-1' to be recognized as a type value.
$typeNum = (string)$typeNum;
return $typeNum;
}
/*******************************************
*
* Caching related
*
*******************************************/
/**
* Stores $data in the 'cache_hash' cache with the hash key, $hash
* and visual/symbolic identification, $ident
*
* @param string $hash 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
* @param mixed $data The data to store
* @param string $ident $ident is just a textual identification in order to inform about the content!
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10, use the Caching Framework directly
*/
public static function storeHash($hash, $data, $ident)
{
trigger_error('This method will be removed in TYPO3 v10.0, use the Caching Framework directly.', E_USER_DEPRECATED);
$cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
$cacheManager->getCache('cache_hash')->set($hash, $data, ['ident_' . $ident], 0);
}
/**
* Returns data stored for the hash string in the cache "cache_hash"
* Can be used to retrieved a cached value, array or object
*
* @param string $hash The hash-string which was used to store the data value
* @return mixed The "data" from the cache
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10, use the Caching Framework directly
*/
public static function getHash($hash)
{
trigger_error('This method will be removed in TYPO3 v10.0, use the Caching Framework directly.', E_USER_DEPRECATED);
$cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
$cacheEntry = $cacheManager->getCache('cache_hash')->get($hash);
$hashContent = null;
if ($cacheEntry) {
$hashContent = $cacheEntry;
}
return $hashContent;
}
/*******************************************
*
* TypoScript related
*
*******************************************/
/**
* Returns the Page TSconfig for page with id, $id
*
* @param int $id Page uid for which to create Page TSconfig
* @param array $rootLine @deprecated
* @param bool $returnPartArray @deprecated
* @return array Page TSconfig
* @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
*/
public static function getPagesTSconfig($id, $rootLine = null, $returnPartArray = false)
{
$id = (int)$id;
$cache = self::getRuntimeCache();
if ($returnPartArray === false
&& $rootLine === null
&& $cache->has('pagesTsConfigIdToHash' . $id)
) {
return $cache->get('pagesTsConfigHashToContent' . $cache->get('pagesTsConfigIdToHash' . $id));
}
$tsConfig = [];
// No custom rootline, so the results can be cached
if (!is_array($rootLine)) {
$rootLine = self::BEgetRootLine($id, '', true);
$useCacheForCurrentPageId = true;
} else {
trigger_error('Calling TYPO3\CMS\Backend\Utility\BackendUtility::getPagesTSconfig() with a custom rootline handed over as second argument will be removed in TYPO3 v10. Use TYPO3\CMS\Backend\Utility\BackendUtility::getRawPagesTSconfig() instead and parse PageTS yourself.', E_USER_DEPRECATED);
$useCacheForCurrentPageId = false;
}
$TSdataArray = static::getRawPagesTSconfig($id, $rootLine);
if ($returnPartArray) {
trigger_error('Calling TYPO3\CMS\Backend\Utility\BackendUtility::getPagesTSconfig() with a third parameter to return the unparsed array directly will be removed in TYPO3 v10. Use TYPO3\CMS\Backend\Utility\BackendUtility::getRawPagesTSconfig() instead.', E_USER_DEPRECATED);
return $TSdataArray;
}
// Parsing the page TS-Config
$pageTs = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
/* @var $parseObj \TYPO3\CMS\Backend\Configuration\TsConfigParser */
$parseObj = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TsConfigParser::class);
$res = $parseObj->parseTSconfig($pageTs, 'PAGES', $id, $rootLine);
if ($res) {
$tsConfig = $res['TSconfig'];
}
$cacheHash = $res['hash'];
// Get User TSconfig overlay
$userTSconfig = static::getBackendUserAuthentication()->getTSConfig() ?? [];
$isCacheHashExtendedWithUserUid = false;
if (is_array($userTSconfig['page.'])) {
ArrayUtility::mergeRecursiveWithOverrule($tsConfig, $userTSconfig['page.']);
$isCacheHashExtendedWithUserUid = true;
$cacheHash .= '_user' . static::getBackendUserAuthentication()->user['uid'];
}
// Overlay page "mod." ts with user ts in a special and deprecated way
if (is_array($userTSconfig['mod.'])) {
// @deprecated This entire "if" and variable $isCacheHashExtendedWithUserUid can be deleted in v10
trigger_error(
'Overriding page TSconfig "mod." with user TSconfig "mod." is deprecated. Use user TSconfig "page.mod." instead',
E_USER_DEPRECATED
);
if (!is_array($tsConfig['mod.'])) {
$tsConfig['mod.'] = [];
}
ArrayUtility::mergeRecursiveWithOverrule($tsConfig['mod.'], $userTSconfig['mod.']);
if (!$isCacheHashExtendedWithUserUid) {
$cacheHash .= '_user' . static::getBackendUserAuthentication()->user['uid'];
}
}
if ($useCacheForCurrentPageId) {
// Many pages end up with the same ts config. To reduce memory usage, the cache
// entries are a linked list: One or more pids point to content hashes which then
// contain the cached content.
$cache->set('pagesTsConfigHashToContent' . $cacheHash, $tsConfig, ['pagesTsConfig']);
$cache->set('pagesTsConfigIdToHash' . $id, $cacheHash, ['pagesTsConfig']);
}
return $tsConfig;
}
/**
* Returns the non-parsed Page TSconfig for page with id, $id
*
* @param int $id Page uid for which to create Page TSconfig
* @param array $rootLine If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
* @return array Non-parsed Page TSconfig
*/
public static function getRawPagesTSconfig($id, array $rootLine = null)
{
if (!is_array($rootLine)) {
$rootLine = self::BEgetRootLine($id, '', true);
}
// Order correctly
ksort($rootLine);
$tsDataArray = [];
// Setting default configuration
$tsDataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'];
foreach ($rootLine as $k => $v) {
if (trim($v['tsconfig_includes'])) {
$includeTsConfigFileList = GeneralUtility::trimExplode(',', $v['tsconfig_includes'], true);
// Traversing list
foreach ($includeTsConfigFileList as $key => $includeTsConfigFile) {
if (strpos($includeTsConfigFile, 'EXT:') === 0) {
list($includeTsConfigFileExtensionKey, $includeTsConfigFilename) = explode(
'/',
substr($includeTsConfigFile, 4),
2
);
if ((string)$includeTsConfigFileExtensionKey !== ''
&& ExtensionManagementUtility::isLoaded($includeTsConfigFileExtensionKey)
&& (string)$includeTsConfigFilename !== ''
) {
$includeTsConfigFileAndPath = ExtensionManagementUtility::extPath($includeTsConfigFileExtensionKey) .
$includeTsConfigFilename;
if (file_exists($includeTsConfigFileAndPath)) {
$tsDataArray['uid_' . $v['uid'] . '_static_' . $key] = file_get_contents($includeTsConfigFileAndPath);
}
}
}
}
}
$tsDataArray['uid_' . $v['uid']] = $v['TSconfig'];
}
$tsDataArray = static::emitGetPagesTSconfigPreIncludeSignal($tsDataArray, $id, $rootLine);
$tsDataArray = TypoScriptParser::checkIncludeLines_array($tsDataArray);
return $tsDataArray;
}
/*******************************************
*
* Users / Groups related
*
*******************************************/
/**
* Returns an array with be_users records of all user NOT DELETED sorted by their username
* Keys in the array is the be_users uid
*
* @param string $fields Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
* @param string $where Optional $where clause (fx. "AND username='pete'") can be used to limit query
* @return array
*/
public static function getUserNames($fields = 'username,usergroup,usergroup_cached_list,uid', $where = '')
{
return self::getRecordsSortedByTitle(
GeneralUtility::trimExplode(',', $fields, true),
'be_users',
'username',
'AND pid=0 ' . $where
);
}
/**
* Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
*
* @param string $fields Field list
* @param string $where WHERE clause
* @return array
*/
public static function getGroupNames($fields = 'title,uid', $where = '')
{