-
Notifications
You must be signed in to change notification settings - Fork 638
/
Clipboard.php
1096 lines (1035 loc) · 42.7 KB
/
Clipboard.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\Clipboard;
/*
* 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 TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Type\Bitmask\JsConfirmation;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;
/**
* TYPO3 clipboard for records and files
*/
class Clipboard
{
/**
* @var int
*/
public $numberTabs = 3;
/**
* Clipboard data kept here
*
* Keys:
* 'normal'
* 'tab_[x]' where x is >=1 and denotes the pad-number
* 'mode' : 'copy' means copy-mode, default = moving ('cut')
* 'el' : Array of elements:
* DB: keys = '[tablename]|[uid]' eg. 'tt_content:123'
* DB: values = 1 (basically insignificant)
* FILE: keys = '_FILE|[shortmd5 of path]' eg. '_FILE|9ebc7e5c74'
* FILE: values = The full filepath, eg. '/www/htdocs/typo3/32/dummy/fileadmin/sem1_3_examples/alternative_index.php'
* or 'C:/www/htdocs/typo3/32/dummy/fileadmin/sem1_3_examples/alternative_index.php'
*
* 'current' pointer to current tab (among the above...)
*
* The virtual tablename '_FILE' will always indicate files/folders. When checking for elements from eg. 'all tables'
* (by using an empty string) '_FILE' entries are excluded (so in effect only DB elements are counted)
*
* @var array
*/
public $clipData = [];
/**
* @var int
*/
public $changed = 0;
/**
* @var string
*/
public $current = '';
/**
* @var int
*/
public $lockToNormal = 0;
/**
* If set, clipboard is displaying files.
*
* @var bool
*/
public $fileMode = false;
/**
* @var IconFactory
*/
protected $iconFactory;
/**
* @var StandaloneView
*/
protected $view;
/**
* Construct
* @throws \TYPO3\CMS\Extbase\Mvc\Exception\InvalidExtensionNameException
* @throws \InvalidArgumentException
*/
public function __construct()
{
$this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
$this->view = $this->getStandaloneView();
}
/*****************************************
*
* Initialize
*
****************************************/
/**
* Initialize the clipboard from the be_user session
*/
public function initializeClipboard()
{
// Get data
$clipData = $this->getBackendUser()->getModuleData('clipboard', $this->getBackendUser()->getTSConfigVal('options.saveClipboard') ? '' : 'ses');
// NumberTabs
$clNP = $this->getBackendUser()->getTSConfigVal('options.clipboardNumberPads');
if (MathUtility::canBeInterpretedAsInteger($clNP) && $clNP >= 0) {
$this->numberTabs = MathUtility::forceIntegerInRange($clNP, 0, 20);
}
// Resets/reinstates the clipboard pads
$this->clipData['normal'] = is_array($clipData['normal']) ? $clipData['normal'] : [];
for ($a = 1; $a <= $this->numberTabs; $a++) {
$this->clipData['tab_' . $a] = is_array($clipData['tab_' . $a]) ? $clipData['tab_' . $a] : [];
}
// Setting the current pad pointer ($this->current))
$this->clipData['current'] = ($this->current = isset($this->clipData[$clipData['current']]) ? $clipData['current'] : 'normal');
}
/**
* Call this method after initialization if you want to lock the clipboard to operate on the normal pad only.
* Trying to switch pad through ->setCmd will not work.
* This is used by the clickmenu since it only allows operation on single elements at a time (that is the "normal" pad)
*/
public function lockToNormal()
{
$this->lockToNormal = 1;
$this->current = 'normal';
}
/**
* The array $cmd may hold various keys which notes some action to take.
* Normally perform only one action at a time.
* In scripts like db_list.php / filelist/mod1/index.php the GET-var CB is used to control the clipboard.
*
* Selecting / Deselecting elements
* Array $cmd['el'] has keys = element-ident, value = element value (see description of clipData array in header)
* Selecting elements for 'copy' should be done by simultaneously setting setCopyMode.
*
* @param array $cmd Array of actions, see function description
*/
public function setCmd($cmd)
{
if (is_array($cmd['el'])) {
foreach ($cmd['el'] as $k => $v) {
if ($this->current === 'normal') {
unset($this->clipData['normal']);
}
if ($v) {
$this->clipData[$this->current]['el'][$k] = $v;
} else {
$this->removeElement($k);
}
$this->changed = 1;
}
}
// Change clipboard pad (if not locked to normal)
if ($cmd['setP']) {
$this->setCurrentPad($cmd['setP']);
}
// Remove element (value = item ident: DB; '[tablename]|[uid]' FILE: '_FILE|[shortmd5 hash of path]'
if ($cmd['remove']) {
$this->removeElement($cmd['remove']);
$this->changed = 1;
}
// Remove all on current pad (value = pad-ident)
if ($cmd['removeAll']) {
$this->clipData[$cmd['removeAll']] = [];
$this->changed = 1;
}
// Set copy mode of the tab
if (isset($cmd['setCopyMode'])) {
$this->clipData[$this->current]['mode'] = $this->isElements() ? ($cmd['setCopyMode'] ? 'copy' : '') : '';
$this->changed = 1;
}
}
/**
* Setting the current pad on clipboard
*
* @param string $padIdent Key in the array $this->clipData
*/
public function setCurrentPad($padIdent)
{
// Change clipboard pad (if not locked to normal)
if (!$this->lockToNormal && $this->current != $padIdent) {
if (isset($this->clipData[$padIdent])) {
$this->clipData['current'] = ($this->current = $padIdent);
}
if ($this->current !== 'normal' || !$this->isElements()) {
$this->clipData[$this->current]['mode'] = '';
}
// Setting mode to default (move) if no items on it or if not 'normal'
$this->changed = 1;
}
}
/**
* Call this after initialization and setCmd in order to save the clipboard to the user session.
* The function will check if the internal flag ->changed has been set and if so, save the clipboard. Else not.
*/
public function endClipboard()
{
if ($this->changed) {
$this->saveClipboard();
}
$this->changed = 0;
}
/**
* Cleans up an incoming element array $CBarr (Array selecting/deselecting elements)
*
* @param array $CBarr Element array from outside ("key" => "selected/deselected")
* @param string $table The 'table which is allowed'. Must be set.
* @param bool|int $removeDeselected Can be set in order to remove entries which are marked for deselection.
* @return array Processed input $CBarr
*/
public function cleanUpCBC($CBarr, $table, $removeDeselected = 0)
{
if (is_array($CBarr)) {
foreach ($CBarr as $k => $v) {
$p = explode('|', $k);
if ((string)$p[0] != (string)$table || $removeDeselected && !$v) {
unset($CBarr[$k]);
}
}
}
return $CBarr;
}
/*****************************************
*
* Clipboard HTML renderings
*
****************************************/
/**
* Prints the clipboard
*
* @return string HTML output
* @throws \BadFunctionCallException
*/
public function printClipboard()
{
$languageService = $this->getLanguageService();
$elementCount = count($this->elFromTable($this->fileMode ? '_FILE' : ''));
// Copymode Selector menu
$copymodeUrl = GeneralUtility::linkThisScript();
$this->view->assign('actionCopyModeUrl', htmlspecialchars(GeneralUtility::quoteJSvalue($copymodeUrl . '&CB[setCopyMode]=')));
$this->view->assign('actionCopyModeUrl1', htmlspecialchars(GeneralUtility::quoteJSvalue($copymodeUrl . '&CB[setCopyMode]=1')));
$this->view->assign('currentMode', $this->currentMode());
$this->view->assign('elementCount', $elementCount);
if ($elementCount) {
$removeAllUrl = GeneralUtility::linkThisScript(['CB' => ['removeAll' => $this->current]]);
$this->view->assign('removeAllUrl', $removeAllUrl);
// Selector menu + clear button
$optionArray = [];
// Import / Export link:
if (ExtensionManagementUtility::isLoaded('impexp')) {
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
$url = $uriBuilder->buildUriFromRoute('xMOD_tximpexp', $this->exportClipElementParameters());
$optionArray[] = [
'label' => $this->clLabel('export', 'rm'),
'uri' => (string)$url
];
}
// Edit:
if (!$this->fileMode) {
$optionArray[] = [
'label' => $this->clLabel('edit', 'rm'),
'uri' => '#',
'additionalAttributes' => [
'onclick' => htmlspecialchars('window.location.href=' . GeneralUtility::quoteJSvalue($this->editUrl() . '&returnUrl=') . '+top.rawurlencode(window.location.href);'),
]
];
}
// Delete referenced elements:
$confirmationCheck = false;
if ($this->getBackendUser()->jsConfirmation(JsConfirmation::DELETE)) {
$confirmationCheck = true;
}
$confirmationMessage = sprintf(
$languageService->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:mess.deleteClip'),
$elementCount
);
$title = $languageService
->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.clipboard.delete_elements');
$returnUrl = $this->deleteUrl(true, $this->fileMode);
$btnOkText = $languageService
->sL('LLL:EXT:lang/Resources/Private/Language/locallang_alt_doc.xlf:buttons.confirm.delete_elements.yes');
$btnCancelText = $languageService
->sL('LLL:EXT:lang/Resources/Private/Language/locallang_alt_doc.xlf:buttons.confirm.delete_elements.no');
$optionArray[] = [
'label' => htmlspecialchars($title),
'uri' => $returnUrl,
'additionalAttributes' => [
'class' => $confirmationCheck ? 't3js-modal-trigger' : '',
],
'data' => [
'severity' => 'warning',
'button-close-text' => htmlspecialchars($btnCancelText),
'button-ok-text' => htmlspecialchars($btnOkText),
'content' => htmlspecialchars($confirmationMessage),
'title' => htmlspecialchars($title)
]
];
// Clear clipboard
$optionArray[] = [
'label' => $languageService->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.clipboard.clear_clipboard', true),
'uri' => $removeAllUrl . '#clip_head'
];
$this->view->assign('optionArray', $optionArray);
}
// Print header and content for the NORMAL tab:
$this->view->assign('current', $this->current);
$tabArray = [];
$tabArray['normal'] = [
'id' => 'normal',
'number' => 0,
'url' => GeneralUtility::linkThisScript(['CB' => ['setP' => 'normal']]),
'description' => 'normal-description',
'label' => 'labels.normal',
'padding' => $this->padTitle('normal')
];
if ($this->current === 'normal') {
$tabArray['normal']['content'] = $this->getContentFromTab('normal');
}
// Print header and content for the NUMERIC tabs:
for ($a = 1; $a <= $this->numberTabs; $a++) {
$tabArray['tab_' . $a] = [
'id' => 'tab_' . $a,
'number' => $a,
'url' => GeneralUtility::linkThisScript(['CB' => ['setP' => 'tab_' . $a]]),
'description' => 'cliptabs-description',
'label' => 'labels.cliptabs-name',
'padding' => $this->padTitle('tab_' . $a)
];
if ($this->current === 'tab_' . $a) {
$tabArray['tab_' . $a]['content'] = $this->getContentFromTab('tab_' . $a);
}
}
$this->view->assign('clipboardHeader', BackendUtility::wrapInHelp('xMOD_csh_corebe', 'list_clipboard', $this->clLabel('clipboard', 'buttons')));
$this->view->assign('tabArray', $tabArray);
return $this->view->render();
}
/**
* Print the content on a pad. Called from ->printClipboard()
*
* @access private
* @param string $pad Pad reference
* @return array Array with table rows for the clipboard.
*/
public function getContentFromTab($pad)
{
$lines = [];
if (is_array($this->clipData[$pad]['el'] ?? false)) {
foreach ($this->clipData[$pad]['el'] as $k => $v) {
if ($v) {
list($table, $uid) = explode('|', $k);
// Rendering files/directories on the clipboard
if ($table === '_FILE') {
$fileObject = ResourceFactory::getInstance()->retrieveFileOrFolderObject($v);
if ($fileObject) {
$thumb = [];
$folder = $fileObject instanceof \TYPO3\CMS\Core\Resource\Folder;
$size = $folder ? '' : '(' . GeneralUtility::formatSize($fileObject->getSize()) . 'bytes)';
if (
!$folder
&& GeneralUtility::inList(
$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'],
$fileObject->getExtension()
)
) {
$thumb = [
'image' => $fileObject->process(\TYPO3\CMS\Core\Resource\ProcessedFile::CONTEXT_IMAGEPREVIEW, []),
'title' => htmlspecialchars($fileObject->getName())
];
}
$lines[] = [
'icon' => '<span title="' . htmlspecialchars($fileObject->getName() . ' ' . $size) . '">' . $this->iconFactory->getIconForResource(
$fileObject,
Icon::SIZE_SMALL
)->render() . '</span>',
'title' => $this->linkItemText(htmlspecialchars(GeneralUtility::fixed_lgd_cs(
$fileObject->getName(),
$this->getBackendUser()->uc['titleLen']
)), $fileObject->getName()),
'thumb' => $thumb,
'infoLink' => htmlspecialchars('top.TYPO3.InfoWindow.showItem(' . GeneralUtility::quoteJSvalue($table) . ', ' . GeneralUtility::quoteJSvalue($v) . '); return false;'),
'removeLink' => $this->removeUrl('_FILE', GeneralUtility::shortMD5($v))
];
} else {
// If the file did not exist (or is illegal) then it is removed from the clipboard immediately:
unset($this->clipData[$pad]['el'][$k]);
$this->changed = 1;
}
} else {
// Rendering records:
$rec = BackendUtility::getRecordWSOL($table, $uid);
if (is_array($rec)) {
$lines[] = [
'icon' => $this->linkItemText($this->iconFactory->getIconForRecord(
$table,
$rec,
Icon::SIZE_SMALL
)->render(), $rec, $table),
'title' => $this->linkItemText(htmlspecialchars(GeneralUtility::fixed_lgd_cs(BackendUtility::getRecordTitle(
$table,
$rec
), $this->getBackendUser()->uc['titleLen'])), $rec, $table),
'infoLink' => htmlspecialchars('top.TYPO3.InfoWindow.showItem(' . GeneralUtility::quoteJSvalue($table) . ', \'' . (int)$uid . '\'); return false;'),
'removeLink' => $this->removeUrl($table, $uid)
];
$localizationData = $this->getLocalizations($table, $rec);
if (!empty($localizationData)) {
$lines = array_merge($lines, $localizationData);
}
} else {
unset($this->clipData[$pad]['el'][$k]);
$this->changed = 1;
}
}
}
}
}
$this->endClipboard();
return $lines;
}
/**
* Returns true if the clipboard contains elements
*
* @return bool
*/
public function hasElements()
{
foreach ($this->clipData as $data) {
if (isset($data['el']) && is_array($data['el']) && !empty($data['el'])) {
return true;
}
}
return false;
}
/**
* Gets all localizations of the current record.
*
* @param string $table The table
* @param array $parentRec The current record
* @return array HTML table rows
*/
public function getLocalizations($table, $parentRec)
{
$lines = [];
$tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
if (BackendUtility::isTableLocalizable($table)) {
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
$queryBuilder->getRestrictions()
->removeAll()
->add(GeneralUtility::makeInstance(DeletedRestriction::class));
$queryBuilder
->select('*')
->from($table)
->where(
$queryBuilder->expr()->eq(
$tcaCtrl['transOrigPointerField'],
$queryBuilder->createNamedParameter($parentRec['uid'], \PDO::PARAM_INT)
),
$queryBuilder->expr()->neq(
$tcaCtrl['languageField'],
$queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
),
$queryBuilder->expr()->gt(
'pid',
$queryBuilder->createNamedParameter(-1, \PDO::PARAM_INT)
)
);
if (isset($tcaCtrl['versioningWS']) && $tcaCtrl['versioningWS']) {
$queryBuilder
->andWhere(
$queryBuilder->expr()->eq(
't3ver_wsid',
$queryBuilder->createNamedParameter($parentRec['t3ver_wsid'], \PDO::PARAM_INT)
)
);
}
$rows = $queryBuilder->execute()->fetchAll();
if (is_array($rows)) {
foreach ($rows as $rec) {
$lines[] = [
'icon' => $this->iconFactory->getIconForRecord($table, $rec, Icon::SIZE_SMALL)->render(),
'title' => htmlspecialchars(GeneralUtility::fixed_lgd_cs(BackendUtility::getRecordTitle($table, $rec), $this->getBackendUser()->uc['titleLen']))
];
}
}
}
return $lines;
}
/**
* Warps title with number of elements if any.
*
* @param string $pad Pad reference
* @return string padding
*/
public function padTitle($pad)
{
$el = count($this->elFromTable($this->fileMode ? '_FILE' : '', $pad));
if ($el) {
return ' (' . ($pad === 'normal' ? ($this->clipData['normal']['mode'] === 'copy' ? $this->clLabel('copy', 'cm') : $this->clLabel('cut', 'cm')) : htmlspecialchars($el)) . ')';
}
return '';
}
/**
* Wraps the title of the items listed in link-tags. The items will link to the page/folder where they originate from
*
* @param string $str Title of element - must be htmlspecialchar'ed on beforehand.
* @param mixed $rec If array, a record is expected. If string, its a path
* @param string $table Table name
* @return string
*/
public function linkItemText($str, $rec, $table = '')
{
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
if (is_array($rec) && $table) {
if ($this->fileMode) {
$str = '<span class="text-muted">' . $str . '</span>';
} else {
$str = '<a href="' . htmlspecialchars((string)$uriBuilder->buildUriFromRoute('web_list', ['id' => $rec['pid']])) . '">' . $str . '</a>';
}
} elseif (file_exists($rec)) {
if (!$this->fileMode) {
$str = '<span class="text-muted">' . $str . '</span>';
} elseif (ExtensionManagementUtility::isLoaded('filelist')) {
$str = '<a href="' . htmlspecialchars((string)$uriBuilder->buildUriFromRoute('file_list', ['id' => dirname($rec)])) . '">' . $str . '</a>';
}
}
return $str;
}
/**
* Returns the select-url for database elements
*
* @param string $table Table name
* @param int $uid Uid of record
* @param bool|int $copy If set, copymode will be enabled
* @param bool|int $deselect If set, the link will deselect, otherwise select.
* @param array $baseArray The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.
* @return string URL linking to the current script but with the CB array set to select the element with table/uid
*/
public function selUrlDB($table, $uid, $copy = 0, $deselect = 0, $baseArray = [])
{
$CB = ['el' => [rawurlencode($table . '|' . $uid) => $deselect ? 0 : 1]];
if ($copy) {
$CB['setCopyMode'] = 1;
}
$baseArray['CB'] = $CB;
return GeneralUtility::linkThisScript($baseArray);
}
/**
* Returns the select-url for files
*
* @param string $path Filepath
* @param bool|int $copy If set, copymode will be enabled
* @param bool|int $deselect If set, the link will deselect, otherwise select.
* @param array $baseArray The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.
* @return string URL linking to the current script but with the CB array set to select the path
*/
public function selUrlFile($path, $copy = 0, $deselect = 0, $baseArray = [])
{
$CB = ['el' => [rawurlencode('_FILE|' . GeneralUtility::shortMD5($path)) => $deselect ? '' : $path]];
if ($copy) {
$CB['setCopyMode'] = 1;
}
$baseArray['CB'] = $CB;
return GeneralUtility::linkThisScript($baseArray);
}
/**
* pasteUrl of the element (database and file)
* For the meaning of $table and $uid, please read from ->makePasteCmdArray!!!
* The URL will point to tce_file or tce_db depending in $table
*
* @param string $table Tablename (_FILE for files)
* @param mixed $uid "destination": can be positive or negative indicating how the paste is done (paste into / paste after)
* @param bool $setRedirect If set, then the redirect URL will point back to the current script, but with CB reset.
* @param array|null $update Additional key/value pairs which should get set in the moved/copied record (via DataHandler)
* @return string
*/
public function pasteUrl($table, $uid, $setRedirect = true, array $update = null)
{
$urlParameters = [
'CB[paste]' => $table . '|' . $uid,
'CB[pad]' => $this->current
];
if ($setRedirect) {
$urlParameters['redirect'] = GeneralUtility::linkThisScript(['CB' => '']);
}
if (is_array($update)) {
$urlParameters['CB[update]'] = $update;
}
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
return (string)$uriBuilder->buildUriFromRoute($table === '_FILE' ? 'tce_file' : 'tce_db', $urlParameters);
}
/**
* deleteUrl for current pad
*
* @param bool $setRedirect If set, then the redirect URL will point back to the current script, but with CB reset.
* @param bool $file If set, then the URL will link to the tce_file.php script in the typo3/ dir.
* @return string
*/
public function deleteUrl($setRedirect = true, $file = false)
{
$urlParameters = [
'CB[delete]' => 1,
'CB[pad]' => $this->current
];
if ($setRedirect) {
$urlParameters['redirect'] = GeneralUtility::linkThisScript(['CB' => '']);
}
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
return (string)$uriBuilder->buildUriFromRoute($file ? 'tce_file' : 'tce_db', $urlParameters);
}
/**
* editUrl of all current elements
* ONLY database
* Links to FormEngine
*
* @return string The URL to FormEngine with parameters.
*/
public function editUrl()
{
$parameters = [];
// All records
$elements = $this->elFromTable('');
foreach ($elements as $tP => $value) {
list($table, $uid) = explode('|', $tP);
$parameters['edit[' . $table . '][' . $uid . ']'] = 'edit';
}
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
return (string)$uriBuilder->buildUriFromRoute('record_edit', $parameters);
}
/**
* Returns the remove-url (file and db)
* for file $table='_FILE' and $uid = shortmd5 hash of path
*
* @param string $table Tablename
* @param string $uid Uid integer/shortmd5 hash
* @return string URL
*/
public function removeUrl($table, $uid)
{
return GeneralUtility::linkThisScript(['CB' => ['remove' => $table . '|' . $uid]]);
}
/**
* Returns confirm JavaScript message
*
* @param string $table Table name
* @param mixed $rec For records its an array, for files its a string (path)
* @param string $type Type-code
* @param array $clElements Array of selected elements
* @param string $columnLabel Name of the content column
* @return string the text for a confirm message
*/
public function confirmMsgText($table, $rec, $type, $clElements, $columnLabel = '')
{
if ($this->getBackendUser()->jsConfirmation(JsConfirmation::COPY_MOVE_PASTE)) {
$labelKey = 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:mess.' . ($this->currentMode() === 'copy' ? 'copy' : 'move') . ($this->current === 'normal' ? '' : 'cb') . '_' . $type;
$msg = $this->getLanguageService()->sL($labelKey . ($columnLabel ? '_colPos' : ''));
if ($table === '_FILE') {
$thisRecTitle = basename($rec);
if ($this->current === 'normal') {
$selItem = reset($clElements);
$selRecTitle = basename($selItem);
} else {
$selRecTitle = count($clElements);
}
} else {
$thisRecTitle = $table === 'pages' && !is_array($rec) ? $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] : BackendUtility::getRecordTitle($table, $rec);
if ($this->current === 'normal') {
$selItem = $this->getSelectedRecord();
$selRecTitle = $selItem['_RECORD_TITLE'];
} else {
$selRecTitle = count($clElements);
}
}
// @TODO
// This can get removed as soon as the "_colPos" label is translated
// into all available locallang languages.
if (!$msg && $columnLabel) {
$thisRecTitle .= ' | ' . $columnLabel;
$msg = $this->getLanguageService()->sL($labelKey);
}
// Message
$conf = sprintf(
$msg,
GeneralUtility::fixed_lgd_cs($selRecTitle, 30),
GeneralUtility::fixed_lgd_cs($thisRecTitle, 30),
GeneralUtility::fixed_lgd_cs($columnLabel, 30)
);
} else {
$conf = '';
}
return $conf;
}
/**
* Clipboard label - getting from "EXT:lang/Resources/Private/Language/locallang_core.xlf:"
*
* @param string $key Label Key
* @param string $Akey Alternative key to "labels
* @return string
*/
public function clLabel($key, $Akey = 'labels')
{
return htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:' . $Akey . '.' . $key));
}
/**
* Creates GET parameters for linking to the export module.
*
* @return array GET parameters for current clipboard content to be exported
*/
protected function exportClipElementParameters()
{
// Init
$pad = $this->current;
$params = [];
$params['tx_impexp']['action'] = 'export';
// Traverse items:
if (is_array($this->clipData[$pad]['el'] ?? false)) {
foreach ($this->clipData[$pad]['el'] as $k => $v) {
if ($v) {
list($table, $uid) = explode('|', $k);
// Rendering files/directories on the clipboard
if ($table === '_FILE') {
if (file_exists($v) && GeneralUtility::isAllowedAbsPath($v)) {
$params['tx_impexp'][is_dir($v) ? 'dir' : 'file'][] = $v;
}
} else {
// Rendering records:
$rec = BackendUtility::getRecord($table, $uid);
if (is_array($rec)) {
$params['tx_impexp']['record'][] = $table . ':' . $uid;
}
}
}
}
}
return $params;
}
/*****************************************
*
* Helper functions
*
****************************************/
/**
* Removes element on clipboard
*
* @param string $el Key of element in ->clipData array
*/
public function removeElement($el)
{
unset($this->clipData[$this->current]['el'][$el]);
$this->changed = 1;
}
/**
* Saves the clipboard, no questions asked.
* Use ->endClipboard normally (as it checks if changes has been done so saving is necessary)
*
* @access private
*/
public function saveClipboard()
{
$this->getBackendUser()->pushModuleData('clipboard', $this->clipData);
}
/**
* Returns the current mode, 'copy' or 'cut'
*
* @return string "copy" or "cut
*/
public function currentMode()
{
return ($this->clipData[$this->current]['mode'] ?? '') === 'copy' ? 'copy' : 'cut';
}
/**
* This traverses the elements on the current clipboard pane
* and unsets elements which does not exist anymore or are disabled.
*/
public function cleanCurrent()
{
if (is_array($this->clipData[$this->current]['el'] ?? false)) {
foreach ($this->clipData[$this->current]['el'] as $k => $v) {
list($table, $uid) = explode('|', $k);
if ($table !== '_FILE') {
if (!$v || !is_array(BackendUtility::getRecord($table, $uid, 'uid'))) {
unset($this->clipData[$this->current]['el'][$k]);
$this->changed = 1;
}
} else {
if (!$v) {
unset($this->clipData[$this->current]['el'][$k]);
$this->changed = 1;
} else {
try {
ResourceFactory::getInstance()->retrieveFileOrFolderObject($v);
} catch (\TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException $e) {
// The file has been deleted in the meantime, so just remove it silently
unset($this->clipData[$this->current]['el'][$k]);
}
}
}
}
}
}
/**
* Counts the number of elements from the table $matchTable. If $matchTable is blank, all tables (except '_FILE' of course) is counted.
*
* @param string $matchTable Table to match/count for.
* @param string $pad Can optionally be used to set another pad than the current.
* @return array Array with keys from the CB.
*/
public function elFromTable($matchTable = '', $pad = '')
{
$pad = $pad ? $pad : $this->current;
$list = [];
if (is_array($this->clipData[$pad]['el'] ?? false)) {
foreach ($this->clipData[$pad]['el'] as $k => $v) {
if ($v) {
list($table, $uid) = explode('|', $k);
if ($table !== '_FILE') {
if ((!$matchTable || (string)$table == (string)$matchTable) && $GLOBALS['TCA'][$table]) {
$list[$k] = $pad === 'normal' ? $v : $uid;
}
} else {
if ((string)$table == (string)$matchTable) {
$list[$k] = $v;
}
}
}
}
}
return $list;
}
/**
* Verifies if the item $table/$uid is on the current pad.
* If the pad is "normal", the mode value is returned if the element existed. Thus you'll know if the item was copy or cut moded...
*
* @param string $table Table name, (_FILE for files...)
* @param int $uid Element uid (path for files)
* @return string
*/
public function isSelected($table, $uid)
{
$k = $table . '|' . $uid;
return !empty($this->clipData[$this->current]['el'][$k]) ? ($this->current === 'normal' ? $this->currentMode() : 1) : '';
}
/**
* Returns item record $table,$uid if selected on current clipboard
* If table and uid is blank, the first element is returned.
* Makes sense only for DB records - not files!
*
* @param string $table Table name
* @param int|string $uid Element uid
* @return array Element record with extra field _RECORD_TITLE set to the title of the record
*/
public function getSelectedRecord($table = '', $uid = '')
{
if (!$table && !$uid) {
$elArr = $this->elFromTable('');
reset($elArr);
list($table, $uid) = explode('|', key($elArr));
}
if ($this->isSelected($table, $uid)) {
$selRec = BackendUtility::getRecordWSOL($table, $uid);
$selRec['_RECORD_TITLE'] = BackendUtility::getRecordTitle($table, $selRec);
return $selRec;
}
return [];
}
/**
* Reports if the current pad has elements (does not check file/DB type OR if file/DBrecord exists or not. Only counting array)
*
* @return bool TRUE if elements exist.
*/
public function isElements()
{
return is_array($this->clipData[$this->current]['el']) && !empty($this->clipData[$this->current]['el']);
}
/*****************************************
*
* FOR USE IN tce_db.php:
*
****************************************/
/**
* Applies the proper paste configuration in the $cmd array send to tce_db.php.
* $ref is the target, see description below.
* The current pad is pasted
*
* $ref: [tablename]:[paste-uid].
* Tablename is the name of the table from which elements *on the current clipboard* is pasted with the 'pid' paste-uid.
* No tablename means that all items on the clipboard (non-files) are pasted. This requires paste-uid to be positive though.
* so 'tt_content:-3' means 'paste tt_content elements on the clipboard to AFTER tt_content:3 record
* 'tt_content:30' means 'paste tt_content elements on the clipboard into page with id 30
* ':30' means 'paste ALL database elements on the clipboard into page with id 30
* ':-30' not valid.
*
* @param string $ref [tablename]:[paste-uid], see description
* @param array $CMD Command-array
* @param array|null $update If additional values should get set in the copied/moved record this will be an array containing key=>value pairs
* @return array Modified Command-array
*/
public function makePasteCmdArray($ref, $CMD, array $update = null)
{
list($pTable, $pUid) = explode('|', $ref);
$pUid = (int)$pUid;
// pUid must be set and if pTable is not set (that means paste ALL elements)
// the uid MUST be positive/zero (pointing to page id)
if ($pTable || $pUid >= 0) {
$elements = $this->elFromTable($pTable);
// So the order is preserved.
$elements = array_reverse($elements);
$mode = $this->currentMode() === 'copy' ? 'copy' : 'move';
// Traverse elements and make CMD array
foreach ($elements as $tP => $value) {
list($table, $uid) = explode('|', $tP);
if (!is_array($CMD[$table])) {
$CMD[$table] = [];
}
if (is_array($update)) {
$CMD[$table][$uid][$mode] = [
'action' => 'paste',
'target' => $pUid,
'update' => $update,
];
} else {
$CMD[$table][$uid][$mode] = $pUid;
}
if ($mode === 'move') {
$this->removeElement($tP);
}
}
$this->endClipboard();
}
return $CMD;
}
/**
* Delete record entries in CMD array
*
* @param array $CMD Command-array
* @return array Modified Command-array
*/
public function makeDeleteCmdArray($CMD)
{
// all records
$elements = $this->elFromTable('');
foreach ($elements as $tP => $value) {
list($table, $uid) = explode('|', $tP);
if (!is_array($CMD[$table])) {
$CMD[$table] = [];