/
DataHandler.php
10073 lines (9463 loc) · 483 KB
/
DataHandler.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
/*
* 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!
*/
namespace TYPO3\CMS\Core\DataHandling;
use Doctrine\DBAL\Exception as DBALException;
use Doctrine\DBAL\Platforms\PostgreSQL94Platform as PostgreSQLPlatform;
use Doctrine\DBAL\Types\IntegerType;
use Doctrine\DBAL\Types\JsonType;
use Psr\Container\ContainerInterface;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Symfony\Component\Uid\Uuid;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use TYPO3\CMS\Core\Configuration\Features;
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\InvalidIdentifierException;
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\InvalidParentRowException;
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\InvalidParentRowLoopException;
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\InvalidParentRowRootException;
use TYPO3\CMS\Core\Configuration\FlexForm\Exception\InvalidPointerFieldValueException;
use TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools;
use TYPO3\CMS\Core\Configuration\Richtext;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\Crypto\PasswordHashing\InvalidPasswordHashException;
use TYPO3\CMS\Core\Crypto\PasswordHashing\PasswordHashFactory;
use TYPO3\CMS\Core\Crypto\Random;
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\DeletedRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\QueryRestrictionContainerInterface;
use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use TYPO3\CMS\Core\Database\RelationHandler;
use TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore;
use TYPO3\CMS\Core\DataHandling\Localization\DataMapProcessor;
use TYPO3\CMS\Core\DataHandling\Model\CorrelationId;
use TYPO3\CMS\Core\DataHandling\Model\RecordStateFactory;
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
use TYPO3\CMS\Core\Html\RteHtmlParser;
use TYPO3\CMS\Core\LinkHandling\Exception\UnknownLinkHandlerException;
use TYPO3\CMS\Core\LinkHandling\LinkService;
use TYPO3\CMS\Core\LinkHandling\TypoLinkCodecService;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Log\LogDataTrait;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Messaging\FlashMessageService;
use TYPO3\CMS\Core\PasswordPolicy\Event\EnrichPasswordValidationContextDataEvent;
use TYPO3\CMS\Core\PasswordPolicy\PasswordPolicyAction;
use TYPO3\CMS\Core\PasswordPolicy\PasswordPolicyValidator;
use TYPO3\CMS\Core\PasswordPolicy\Validator\Dto\ContextData;
use TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Service\OpcodeCacheService;
use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\SysLog\Action\Cache as SystemLogCacheAction;
use TYPO3\CMS\Core\SysLog\Action\Database as SystemLogDatabaseAction;
use TYPO3\CMS\Core\SysLog\Error as SystemLogErrorClassification;
use TYPO3\CMS\Core\SysLog\Type as SystemLogType;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
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\StringUtility;
use TYPO3\CMS\Core\Versioning\VersionState;
/**
* The main data handler class which takes care of correctly updating and inserting records.
* This class was formerly known as TCEmain.
*
* This is the TYPO3 Core Engine class for manipulation of the database
* This class is used by eg. the tce_db BE route (SimpleDataHandlerController) which provides an interface for POST forms to this class.
*
* Dependencies:
* - $GLOBALS['TCA'] must exist
* - $GLOBALS['LANG'] must exist
*
* Also see document 'TYPO3 Core API' for details.
*/
class DataHandler implements LoggerAwareInterface
{
use LogDataTrait;
use LoggerAwareTrait;
// *********************
// Public variables you can configure before using the class:
// *********************
/**
* If TRUE, the default log-messages will be stored. This should not be necessary if the locallang-file for the
* log-display is properly configured. So disabling this will just save some database-space as the default messages are not saved.
*
* @var bool
*/
public $storeLogMessages = true;
/**
* If TRUE, actions are logged to sys_log.
*
* @var bool
*/
public $enableLogging = true;
/**
* If TRUE, the datamap array is reversed in the order, which is a nice thing if you're creating a whole new
* bunch of records.
*
* @var bool
*/
public $reverseOrder = false;
/**
* This will read the record after having updated or inserted it. If anything is not properly submitted an error
* is written to the log. This feature consumes extra time by selecting records
*
* @var bool
*/
public $checkStoredRecords = true;
/**
* If set, values '' and 0 will equal each other when the stored records are checked.
*
* @var bool
*/
public $checkStoredRecords_loose = true;
/**
* If set, then the 'hideAtCopy' flag for tables will be ignored.
*
* @var bool
*/
public $neverHideAtCopy = false;
/**
* If set, then the TCE class has been instantiated during an import action of a T3D
*
* @var bool
*/
public $isImporting = false;
/**
* If set, then transformations are NOT performed on the input.
*
* @var bool
*/
public $dontProcessTransformations = false;
/**
* Will distinguish between translations (with parent) and localizations (without parent) while still using the same methods to copy the records
* TRUE: translation of a record connected to the default language
* FALSE: localization of a record without connection to the default language
*
* @var bool
*/
protected $useTransOrigPointerField = true;
/**
* If TRUE, workspace restrictions are bypassed on edit and create actions (process_datamap()).
* YOU MUST KNOW what you do if you use this feature!
*
* @var bool
* @internal should only be used from within TYPO3 Core
*/
public $bypassWorkspaceRestrictions = false;
/**
* If TRUE, access check, check for deleted etc. for records is bypassed.
* YOU MUST KNOW what you are doing if you use this feature!
*
* @var bool
*/
public $bypassAccessCheckForRecords = false;
/**
* Comma-separated list. This list of tables decides which tables will be copied. If empty then none will.
* If '*' then all will (that the user has permission to of course)
*
* @var string
* @internal should only be used from within TYPO3 Core
*/
public $copyWhichTables = '*';
/**
* If 0 then branch is NOT copied.
* If 1 then pages on the 1st level is copied.
* If 2 then pages on the second level is copied ... and so on
*
* @var int
*/
public $copyTree = 0;
/**
* [table][fields]=value: New records are created with default values and you can set this array on the
* form $defaultValues[$table][$field] = $value to override the default values fetched from TCA.
* If ->setDefaultsFromUserTS is called UserTSconfig default values will overrule existing values in this array
* (thus UserTSconfig overrules externally set defaults which overrules TCA defaults)
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $defaultValues = [];
/**
* [table][fields]=value: You can set this array on the form $overrideValues[$table][$field] = $value to
* override the incoming data. You must set this externally. You must make sure the fields in this array are also
* found in the table, because it's not checked. All columns can be set by this array!
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $overrideValues = [];
/**
* If entries are set in this array corresponding to fields for update, they are ignored and thus NOT updated.
* You could set this array from a series of checkboxes with value=0 and hidden fields before the checkbox with 1.
* Then an empty checkbox will disable the field.
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $data_disableFields = [];
/**
* Use this array to validate suggested uids for tables by setting [table]:[uid]. This is a dangerous option
* since it will force the inserted record to have a certain UID. The value just have to be TRUE, but if you set
* it to "DELETE" it will make sure any record with that UID will be deleted first (raw delete).
* The option is used for import of T3D files when synchronizing between two mirrored servers.
* As a security measure this feature is available only for Admin Users (for now)
*
* @var array
*/
public $suggestedInsertUids = [];
/**
* Object. Call back object for FlexForm traversal. Useful when external classes wants to use the
* iteration functions inside DataHandler for traversing a FlexForm structure.
*
* @var object
* @internal should only be used from within TYPO3 Core
*/
public $callBackObj;
/**
* A string which can be used as correlationId for RecordHistory entries.
* The string can later be used to rollback multiple changes at once.
*
* @var CorrelationId|null
*/
protected $correlationId;
// *********************
// Internal variables (mapping arrays) which can be used (read-only) from outside
// *********************
/**
* Contains mapping of auto-versionized records.
*
* @var array<string, array<int, string>>
* @internal should only be used from within TYPO3 Core
*/
public $autoVersionIdMap = [];
/**
* When new elements are created, this array contains a map between their "NEW..." string IDs and the eventual UID they got when stored in database
*
* @var array
*/
public $substNEWwithIDs = [];
/**
* Like $substNEWwithIDs, but where each old "NEW..." id is mapped to the table it was from.
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $substNEWwithIDs_table = [];
/**
* Holds the tables and there the ids of newly created child records from IRRE
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $newRelatedIDs = [];
/**
* This array is the sum of all copying operations in this class.
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $copyMappingArray_merged = [];
/**
* Per-table array with UIDs that have been deleted.
*
* @var array
*/
protected $deletedRecords = [];
/**
* Errors are collected in this variable.
*
* @var array
* @internal should only be used from within TYPO3 Core
*/
public $errorLog = [];
/**
* Fields from the pages-table for which changes will trigger a pagetree refresh
*
* @var array
*/
public $pagetreeRefreshFieldsFromPages = ['pid', 'sorting', 'deleted', 'hidden', 'title', 'doktype', 'is_siteroot', 'fe_group', 'nav_hide', 'nav_title', 'module', 'starttime', 'endtime', 'content_from_pid', 'extendToSubpages'];
/**
* Indicates whether the pagetree needs a refresh because of important changes
*
* @var bool
* @internal should only be used from within TYPO3 Core
*/
public $pagetreeNeedsRefresh = false;
// *********************
// Internal Variables, do not touch.
// *********************
// Variables set in init() function:
/**
* The user-object the script uses. If not set from outside, this is set to the current global $BE_USER.
*
* @var BackendUserAuthentication
*/
public $BE_USER;
/**
* Will be set to uid of be_user executing this script
*
* @var int
* @internal should only be used from within TYPO3 Core
*/
public $userid;
/**
* Will be set if user is admin
*
* @var bool
* @internal should only be used from within TYPO3 Core
*/
public $admin;
/**
* @var PagePermissionAssembler
*/
protected $pagePermissionAssembler;
/**
* The list of <table>-<fields> that cannot be edited by user. This is compiled from TCA/exclude-flag combined with non_exclude_fields for the user.
*
* @var array
*/
protected $excludedTablesAndFields = [];
/**
* Data submitted from the form view, used to control behaviours,
* e.g. this is used to activate/deactivate fields and thus store NULL values
*
* @var array
*/
protected $control = [];
/**
* Set with incoming data array
*
* @var array<int|string, array<int|string, array>>
*/
public $datamap = [];
/**
* Set with incoming cmd array
*
* @var array<string, array<int|string, array>>
*/
public $cmdmap = [];
/**
* List of changed old record ids to new records ids
*
* @var array
*/
protected $mmHistoryRecords = [];
/**
* List of changed old record ids to new records ids
*
* @var array
*/
protected $historyRecords = [];
// Internal static:
/**
* The interval between sorting numbers used with tables with a 'sorting' field defined.
*
* Min 1, should be power of 2
*
* @var int
* @internal should only be used from within TYPO3 Core
*/
public $sortIntervals = 256;
// Internal caching arrays
/**
* User by function checkRecordInsertAccess() to store whether a record can be inserted on a page id
*
* @var array
*/
protected $recInsertAccessCache = [];
/**
* Caching array for check of whether records are in a webmount
*
* @var array
*/
protected $isRecordInWebMount_Cache = [];
/**
* Caching array for page ids in webmounts
*
* @var array
*/
protected $isInWebMount_Cache = [];
/**
* Used for caching page records in pageInfo()
*
* @var array<int, array<string, array>>
*/
protected $pageCache = [];
// Other arrays:
/**
* For accumulation of MM relations that must be written after new records are created.
*
* @var array
* @internal
*/
public $dbAnalysisStore = [];
/**
* Used for tracking references that might need correction after operations
*
* @var array<string, array<int, array>>
* @internal
*/
public $registerDBList = [];
/**
* Used for tracking references that might need correction in pid field after operations (e.g. IRRE)
*
* @var array
* @internal
*/
public $registerDBPids = [];
/**
* Used by the copy action to track the ids of new pages so subpages are correctly inserted!
* THIS is internally cleared for each executed copy operation! DO NOT USE THIS FROM OUTSIDE!
* Read from copyMappingArray_merged instead which is accumulating this information.
*
* NOTE: This is used by some outside scripts (e.g. hooks), as the results in $copyMappingArray_merged
* are only available after an action has been completed.
*
* @var array<string, array>
* @internal
*/
public $copyMappingArray = [];
/**
* Array used for remapping uids and values at the end of process_datamap
*
* @var array
* @internal
*/
public $remapStack = [];
/**
* Array used for remapping uids and values at the end of process_datamap
* (e.g. $remapStackRecords[<table>][<uid>] = <index in $remapStack>)
*
* @var array
* @internal
*/
public $remapStackRecords = [];
/**
* Array used for checking whether new children need to be remapped
*
* @var array
*/
protected $remapStackChildIds = [];
/**
* Array used for executing addition actions after remapping happened (set processRemapStack())
*
* @var array
*/
protected $remapStackActions = [];
/**
* Registry object to gather reference index update requests and perform updates after
* main processing has been done. The first call to start() instantiates this object.
* Recursive sub instances receive this instance via __construct().
* The final update() call is done at the end of process_cmdmap() or process_datamap()
* in the outer most instance.
*
* @var ReferenceIndexUpdater
*/
protected $referenceIndexUpdater;
// Various
/**
* Set to "currentRecord" during checking of values.
*
* @var array
* @internal
*/
public $checkValue_currentRecord = [];
/**
* Disable delete clause
*
* @var bool
*/
protected $disableDeleteClause = false;
/**
* @var array|null
*/
protected $checkModifyAccessListHookObjects;
/**
* The outer most instance of \TYPO3\CMS\Core\DataHandling\DataHandler:
* This object instantiates itself on versioning and localization ...
*
* @var \TYPO3\CMS\Core\DataHandling\DataHandler|null
*/
protected $outerMostInstance;
/**
* Internal cache for collecting records that should trigger cache clearing
*
* @var array
*/
protected static $recordsToClearCacheFor = [];
/**
* Internal cache for pids of records which were deleted. It's not possible
* to retrieve the parent folder/page at a later stage
*
* @var array
*/
protected static $recordPidsForDeletedRecords = [];
/**
* Runtime Cache to store and retrieve data computed for a single request
*
* @var FrontendInterface
*/
protected $runtimeCache;
/**
* Prefix for the cache entries of nested element calls since the runtimeCache has a global scope.
*
* @var string
*/
protected $cachePrefixNestedElementCalls = 'core-datahandler-nestedElementCalls-';
/**
* Sets up the data handler cache and some additional options, the main logic is done in the start() method.
*
* @param ReferenceIndexUpdater|null $referenceIndexUpdater Hand over from outer most instance to sub instances
*/
public function __construct(ReferenceIndexUpdater $referenceIndexUpdater = null)
{
$this->checkStoredRecords = (bool)$GLOBALS['TYPO3_CONF_VARS']['BE']['checkStoredRecords'];
$this->checkStoredRecords_loose = (bool)$GLOBALS['TYPO3_CONF_VARS']['BE']['checkStoredRecordsLoose'];
$this->runtimeCache = $this->getRuntimeCache();
$this->pagePermissionAssembler = GeneralUtility::makeInstance(PagePermissionAssembler::class, $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPermissions']);
if ($referenceIndexUpdater === null) {
// Create ReferenceIndexUpdater object. This should only happen on outer most instance,
// sub instances should receive the reference index updater from a parent.
$referenceIndexUpdater = GeneralUtility::makeInstance(ReferenceIndexUpdater::class);
}
$this->referenceIndexUpdater = $referenceIndexUpdater;
}
/**
* @internal
*/
public function setControl(array $control)
{
$this->control = $control;
}
/**
* Initializing.
* For details, see 'TYPO3 Core API' document.
* This function does not start the processing of data, but merely initializes the object
*
* @param array $data Data to be modified or inserted in the database
* @param array $cmd Commands to copy, move, delete, localize, versionize records.
* @param BackendUserAuthentication|null $altUserObject An alternative userobject you can set instead of the default, which is $GLOBALS['BE_USER']
*/
public function start($data, $cmd, $altUserObject = null)
{
// Initializing BE_USER
$this->BE_USER = is_object($altUserObject) ? $altUserObject : $GLOBALS['BE_USER'];
$this->userid = (int)($this->BE_USER->user['uid'] ?? 0);
$this->admin = $this->BE_USER->user['admin'] ?? false;
// set correlation id for each new set of data or commands
$this->correlationId = CorrelationId::forScope(
md5(StringUtility::getUniqueId(self::class))
);
// Get default values from user TSconfig
$tcaDefaultOverride = $this->BE_USER->getTSConfig()['TCAdefaults.'] ?? null;
if (is_array($tcaDefaultOverride)) {
$this->setDefaultsFromUserTS($tcaDefaultOverride);
}
// generates the excludelist, based on TCA/exclude-flag and non_exclude_fields for the user:
if (!$this->admin) {
$this->excludedTablesAndFields = array_flip($this->getExcludeListArray());
}
// Setting the data and cmd arrays
if (is_array($data)) {
reset($data);
$this->datamap = $data;
}
if (is_array($cmd)) {
reset($cmd);
$this->cmdmap = $cmd;
}
}
/**
* Function that can mirror input values in datamap-array to other uid numbers.
* Example: $mirror[table][11] = '22,33' will look for content in $this->datamap[table][11] and copy it to $this->datamap[table][22] and $this->datamap[table][33]
*
* @param array $mirror This array has the syntax $mirror[table_name][uid] = [list of uids to copy data-value TO!]
* @internal
*/
public function setMirror($mirror)
{
if (!is_array($mirror)) {
return;
}
foreach ($mirror as $table => $uid_array) {
if (!isset($this->datamap[$table])) {
continue;
}
foreach ($uid_array as $id => $uidList) {
if (!isset($this->datamap[$table][$id])) {
continue;
}
$theIdsInArray = GeneralUtility::trimExplode(',', $uidList, true);
foreach ($theIdsInArray as $copyToUid) {
$this->datamap[$table][$copyToUid] = $this->datamap[$table][$id];
}
}
}
}
/**
* Initializes default values coming from user TSconfig
*
* @param array $userTS User TSconfig array
* @internal should only be used from within DataHandler
*/
public function setDefaultsFromUserTS($userTS)
{
if (!is_array($userTS)) {
return;
}
foreach ($userTS as $k => $v) {
$k = mb_substr($k, 0, -1);
if (!$k || !is_array($v) || !isset($GLOBALS['TCA'][$k])) {
continue;
}
if (is_array($this->defaultValues[$k] ?? false)) {
$this->defaultValues[$k] = array_merge($this->defaultValues[$k], $v);
} else {
$this->defaultValues[$k] = $v;
}
}
}
/**
* When a new record is created, all values that haven't been set but are set via PageTSconfig / UserTSconfig
* get applied here.
*
* This is only executed for new records. The most important part is that the pageTS of the actual resolved $pid
* is taken, and a new field array with empty defaults is set again.
*
* @param string $table
* @param int $pageId
* @param array $prepopulatedFieldArray
*/
protected function applyDefaultsForFieldArray(string $table, int $pageId, array $prepopulatedFieldArray): array
{
// First set TCAdefaults respecting the given PageID
$tcaDefaults = BackendUtility::getPagesTSconfig($pageId)['TCAdefaults.'] ?? null;
// Re-apply $this->defaultValues settings
$this->setDefaultsFromUserTS($tcaDefaults);
$cleanFieldArray = $this->newFieldArray($table);
if (isset($prepopulatedFieldArray['pid'])) {
$cleanFieldArray['pid'] = $prepopulatedFieldArray['pid'];
}
$sortColumn = $GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? null;
if ($sortColumn !== null && isset($prepopulatedFieldArray[$sortColumn])) {
$cleanFieldArray[$sortColumn] = $prepopulatedFieldArray[$sortColumn];
}
return $cleanFieldArray;
}
/*********************************************
*
* HOOKS
*
*********************************************/
/**
* Hook: processDatamap_afterDatabaseOperations
* (calls $hookObj->processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $this);)
*
* Note: When using the hook after INSERT operations, you will only get the temporary NEW... id passed to your hook as $id,
* but you can easily translate it to the real uid of the inserted record using the $this->substNEWwithIDs array.
*
* @param array $hookObjectsArr (reference) Array with hook objects
* @param string $status (reference) Status of the current operation, 'new' or 'update
* @param string $table (reference) The table currently processing data for
* @param string $id (reference) The record uid currently processing data for, [integer] or [string] (like 'NEW...')
* @param array $fieldArray (reference) The field array of a record
* @internal should only be used from within DataHandler
*/
public function hook_processDatamap_afterDatabaseOperations(&$hookObjectsArr, &$status, &$table, &$id, &$fieldArray)
{
// Process hook directly:
if (!isset($this->remapStackRecords[$table][$id])) {
foreach ($hookObjectsArr as $hookObj) {
if (method_exists($hookObj, 'processDatamap_afterDatabaseOperations')) {
$hookObj->processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $this);
}
}
} else {
$this->remapStackRecords[$table][$id]['processDatamap_afterDatabaseOperations'] = [
'status' => $status,
'fieldArray' => $fieldArray,
'hookObjectsArr' => $hookObjectsArr,
];
}
}
/**
* Gets the 'checkModifyAccessList' hook objects.
* The first call initializes the accordant objects.
*
* @return array The 'checkModifyAccessList' hook objects (if any)
* @throws \UnexpectedValueException
*/
protected function getCheckModifyAccessListHookObjects()
{
if (!isset($this->checkModifyAccessListHookObjects)) {
$this->checkModifyAccessListHookObjects = [];
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['checkModifyAccessList'] ?? [] as $className) {
$hookObject = GeneralUtility::makeInstance($className);
if (!$hookObject instanceof DataHandlerCheckModifyAccessListHookInterface) {
throw new \UnexpectedValueException($className . ' must implement interface ' . DataHandlerCheckModifyAccessListHookInterface::class, 1251892472);
}
$this->checkModifyAccessListHookObjects[] = $hookObject;
}
}
return $this->checkModifyAccessListHookObjects;
}
/*********************************************
*
* PROCESSING DATA
*
*********************************************/
/**
* Processing the data-array
* Call this function to process the data-array set by start()
*
* @return bool|void
*/
public function process_datamap()
{
$this->controlActiveElements();
// Keep versionized(!) relations here locally:
$registerDBList = [];
$this->registerElementsToBeDeleted();
$this->datamap = $this->unsetElementsToBeDeleted($this->datamap);
// Editing frozen:
if ($this->BE_USER->workspace !== 0 && ($this->BE_USER->workspaceRec['freeze'] ?? false)) {
$this->log('sys_workspace', $this->BE_USER->workspace, SystemLogDatabaseAction::VERSIONIZE, 0, SystemLogErrorClassification::USER_ERROR, 'All editing in this workspace has been frozen');
return false;
}
// First prepare user defined objects (if any) for hooks which extend this function:
$hookObjectsArr = [];
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass'] ?? [] as $className) {
$hookObject = GeneralUtility::makeInstance($className);
if (method_exists($hookObject, 'processDatamap_beforeStart')) {
$hookObject->processDatamap_beforeStart($this);
}
$hookObjectsArr[] = $hookObject;
}
// Pre-process data-map and synchronize localization states
$this->datamap = GeneralUtility::makeInstance(SlugEnricher::class)->enrichDataMap($this->datamap);
$this->datamap = DataMapProcessor::instance($this->datamap, $this->BE_USER, $this->referenceIndexUpdater)->process();
// Organize tables so that the pages-table is always processed first. This is required if you want to make sure that content pointing to a new page will be created.
$orderOfTables = [];
// Set pages first.
if (isset($this->datamap['pages'])) {
$orderOfTables[] = 'pages';
}
$orderOfTables = array_unique(array_merge($orderOfTables, array_keys($this->datamap)));
// Process the tables...
foreach ($orderOfTables as $table) {
// Check if
// - table is set in $GLOBALS['TCA'],
// - table is NOT readOnly
// - the table is set with content in the data-array (if not, there's nothing to process...)
// - permissions for tableaccess OK
$modifyAccessList = $this->checkModifyAccessList($table);
if (!$modifyAccessList) {
$this->log($table, 0, SystemLogDatabaseAction::UPDATE, 0, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify table "{table}" without permission', 1, ['table' => $table]);
}
if (!isset($GLOBALS['TCA'][$table]) || $this->tableReadOnly($table) || !is_array($this->datamap[$table]) || !$modifyAccessList) {
continue;
}
if ($this->reverseOrder) {
$this->datamap[$table] = array_reverse($this->datamap[$table], true);
}
// For each record from the table, do:
// $id is the record uid, may be a string if new records...
// $incomingFieldArray is the array of fields
foreach ($this->datamap[$table] as $id => $incomingFieldArray) {
if (!is_array($incomingFieldArray)) {
continue;
}
$theRealPid = null;
// Hook: processDatamap_preProcessFieldArray
foreach ($hookObjectsArr as $hookObj) {
if (method_exists($hookObj, 'processDatamap_preProcessFieldArray')) {
$hookObj->processDatamap_preProcessFieldArray($incomingFieldArray, $table, $id, $this);
}
}
// ******************************
// Checking access to the record
// ******************************
$createNewVersion = false;
$old_pid_value = '';
// Is it a new record? (Then Id is a string)
if (!MathUtility::canBeInterpretedAsInteger($id)) {
// Get a fieldArray with tca default values
$fieldArray = $this->newFieldArray($table);
// A pid must be set for new records.
if (isset($incomingFieldArray['pid'])) {
$pid_value = $incomingFieldArray['pid'];
// Checking and finding numerical pid, it may be a string-reference to another value
$canProceed = true;
// If a NEW... id
if (str_contains($pid_value, 'NEW')) {
if ($pid_value[0] === '-') {
$negFlag = -1;
$pid_value = substr($pid_value, 1);
} else {
$negFlag = 1;
}
// Trying to find the correct numerical value as it should be mapped by earlier processing of another new record.
if (isset($this->substNEWwithIDs[$pid_value])) {
if ($negFlag === 1) {
$old_pid_value = $this->substNEWwithIDs[$pid_value];
}
$pid_value = (int)($negFlag * $this->substNEWwithIDs[$pid_value]);
} else {
$canProceed = false;
}
}
$pid_value = (int)$pid_value;
if ($canProceed) {
$fieldArray = $this->resolveSortingAndPidForNewRecord($table, $pid_value, $fieldArray);
}
}
$theRealPid = $fieldArray['pid'];
// Checks if records can be inserted on this $pid.
// If this is a page translation, the check needs to be done for the l10n_parent record
$languageField = $GLOBALS['TCA'][$table]['ctrl']['languageField'] ?? null;
$transOrigPointerField = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? null;
if ($table === 'pages'
&& $languageField && isset($incomingFieldArray[$languageField]) && $incomingFieldArray[$languageField] > 0
&& $transOrigPointerField && isset($incomingFieldArray[$transOrigPointerField]) && $incomingFieldArray[$transOrigPointerField] > 0
) {
$recordAccess = $this->checkRecordInsertAccess($table, $incomingFieldArray[$transOrigPointerField]);
} else {
$recordAccess = $this->checkRecordInsertAccess($table, $theRealPid);
}
if ($recordAccess) {
$this->addDefaultPermittedLanguageIfNotSet($table, $incomingFieldArray, $theRealPid);
$recordAccess = $this->BE_USER->recordEditAccessInternals($table, $incomingFieldArray, true);
if (!$recordAccess) {
$this->log($table, 0, SystemLogDatabaseAction::INSERT, 0, SystemLogErrorClassification::USER_ERROR, 'recordEditAccessInternals() check failed [{reason}]', -1, ['reason' => $this->BE_USER->errorMsg]);
} elseif (!$this->bypassWorkspaceRestrictions && !$this->BE_USER->workspaceAllowsLiveEditingInTable($table)) {
// If LIVE records cannot be created due to workspace restrictions, prepare creation of placeholder-record
// So, if no live records were allowed in the current workspace, we have to create a new version of this record
if (BackendUtility::isTableWorkspaceEnabled($table)) {
$createNewVersion = true;
} else {
$recordAccess = false;
$this->log(
$table,
0,
SystemLogDatabaseAction::VERSIONIZE,
0,
SystemLogErrorClassification::USER_ERROR,
'Attempt to insert version record "{table}:{uid}" to this workspace failed. "Live" edit permissions of records from tables without versioning required',
-1,
[
'table' => $table,
'uid' => $id,
]
);
}
}
}
// Yes new record, change $record_status to 'insert'
$status = 'new';
} else {
// Nope... $id is a number
$id = (int)$id;
$fieldArray = [];
$recordAccess = $this->checkRecordUpdateAccess($table, $id, $incomingFieldArray, $hookObjectsArr);
if (!$recordAccess) {
if ($this->enableLogging) {
$propArr = $this->getRecordProperties($table, $id);
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, 0, SystemLogErrorClassification::USER_ERROR, 'Attempt to modify record "{title}" ({table}:{uid}) without permission or non-existing page', 2, ['title' => $propArr['header'], 'table' => $table, 'uid' => $id], $propArr['event_pid']);
}
continue;
}
// Next check of the record permissions (internals)
$recordAccess = $this->BE_USER->recordEditAccessInternals($table, $id);
if (!$recordAccess) {
$this->log($table, $id, SystemLogDatabaseAction::UPDATE, 0, SystemLogErrorClassification::USER_ERROR, 'recordEditAccessInternals() check failed [{reason}]', -1, ['reason' => $this->BE_USER->errorMsg]);
} else {
// Here we fetch the PID of the record that we point to...
$tempdata = $this->recordInfo($table, $id);
$theRealPid = $tempdata['pid'] ?? null;
// Use the new id of the versionized record we're trying to write to:
// (This record is a child record of a parent and has already been versionized.)
if (!empty($this->autoVersionIdMap[$table][$id])) {
// For the reason that creating a new version of this record, automatically
// created related child records (e.g. "IRRE"), update the accordant field:
$this->getVersionizedIncomingFieldArray($table, $id, $incomingFieldArray, $registerDBList);
// Use the new id of the copied/versionized record:
$id = $this->autoVersionIdMap[$table][$id];
$recordAccess = true;
} elseif (!$this->bypassWorkspaceRestrictions && $tempdata && ($errorCode = $this->workspaceCannotEditRecord($table, $tempdata))) {
$recordAccess = false;
// Versioning is required and it must be offline version!
// Check if there already is a workspace version
$workspaceVersion = BackendUtility::getWorkspaceVersionOfRecord($this->BE_USER->workspace, $table, $id, 'uid,t3ver_oid');