EditDocumentController.php 62.2 KB
Newer Older
1
2
3
<?php
namespace TYPO3\CMS\Backend\Controller;

4
/*
5
 * This file is part of the TYPO3 CMS project.
6
 *
7
8
9
 * 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.
10
 *
11
12
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
13
 *
14
15
 * The TYPO3 project - inspiring people to share!
 */
16

17
use Psr\Http\Message\ResponseInterface;
18
use Psr\Http\Message\ServerRequestInterface;
19
20
use TYPO3\CMS\Backend\Form\Exception\AccessDeniedException;
use TYPO3\CMS\Backend\Form\FormResultCompiler;
21
use TYPO3\CMS\Backend\Form\Utility\FormEngineUtility;
Nicole Cordes's avatar
Nicole Cordes committed
22
use TYPO3\CMS\Backend\Utility\BackendUtility;
23
use TYPO3\CMS\Core\DataHandling\DataHandler;
24
25
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
26
27
28
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Messaging\FlashMessageService;
use TYPO3\CMS\Core\Page\PageRenderer;
29
use TYPO3\CMS\Core\Type\Bitmask\Permission;
Nicole Cordes's avatar
Nicole Cordes committed
30
31
32
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\HttpUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
33
use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
34
use TYPO3\CMS\Frontend\Page\PageRepository;
35
36
37
use TYPO3\CMS\Backend\Form\FormDataCompiler;
use TYPO3\CMS\Backend\Form\NodeFactory;
use TYPO3\CMS\Backend\Form\FormDataGroup\TcaDatabaseRecord;
Nicole Cordes's avatar
Nicole Cordes committed
38

39
40
41
42
/**
 * Script Class: Drawing the editing form for editing records in TYPO3.
 * Notice: It does NOT use tce_db.php to submit data to, rather it handles submissions itself
 */
43
class EditDocumentController {
44

45
46
47
48
49
50
51
	/**
	 * GPvar "edit": Is an array looking approx like [tablename][list-of-ids]=command, eg.
	 * "&edit[pages][123]=edit". See \TYPO3\CMS\Backend\Utility\BackendUtility::editOnClick(). Value can be seen modified
	 * internally (converting NEW keyword to id, workspace/versioning etc).
	 *
	 * @var array
	 */
52
53
	public $editconf;

54
55
56
57
58
59
60
	/**
	 * Commalist of fieldnames to edit. The point is IF you specify this list, only those
	 * fields will be rendered in the form. Otherwise all (available) fields in the record
	 * is shown according to the types configuration in $GLOBALS['TCA']
	 *
	 * @var bool
	 */
61
62
	public $columnsOnly;

63
64
65
66
67
68
	/**
	 * Default values for fields (array with tablenames, fields etc. as keys).
	 * Can be seen modified internally.
	 *
	 * @var array
	 */
69
70
	public $defVals;

71
72
73
74
75
76
	/**
	 * Array of values to force being set (as hidden fields). Will be set as $this->defVals
	 * IF defVals does not exist.
	 *
	 * @var array
	 */
77
78
	public $overrideVals;

79
80
81
82
83
84
	/**
	 * If set, this value will be set in $this->retUrl (which is used quite many places
	 * as the return URL). If not set, "dummy.php" will be set in $this->retUrl
	 *
	 * @var string
	 */
85
86
	public $returnUrl;

87
88
89
90
91
	/**
	 * Close-document command. Not really sure of all options...
	 *
	 * @var int
	 */
92
93
	public $closeDoc;

94
95
96
97
98
99
100
	/**
	 * Quite simply, if this variable is set, then the processing of incoming data will be performed
	 * as if a save-button is pressed. Used in the forms as a hidden field which can be set through
	 * JavaScript if the form is somehow submitted by JavaScript).
	 *
	 * @var bool
	 */
101
102
	public $doSave;

103
104
105
106
107
	/**
	 * The data array from which the data comes...
	 *
	 * @var array
	 */
108
109
	public $data;

110
111
112
113
114
	/**
	 * @var string
	 */
	public $cmd;

115
116
117
	/**
	 * @var array
	 */
118
119
	public $mirror;

120
121
122
123
124
	/**
	 * Clear-cache cmd.
	 *
	 * @var string
	 */
125
126
	public $cacheCmd;

127
128
129
130
131
	/**
	 * Redirect (not used???)
	 *
	 * @var string
	 */
132
133
	public $redirect;

134
135
136
137
138
139
	/**
	 * Boolean: If set, then the GET var "&id=" will be added to the
	 * retUrl string so that the NEW id of something is returned to the script calling the form.
	 *
	 * @var bool
	 */
140
141
	public $returnNewPageId;

142
143
144
	/**
	 * @var string
	 */
145
146
	public $vC;

147
148
149
150
151
	/**
	 * update BE_USER->uc
	 *
	 * @var array
	 */
152
153
	public $uc;

154
155
156
157
158
	/**
	 * ID for displaying the page in the frontend (used for SAVE/VIEW operations)
	 *
	 * @var int
	 */
159
160
	public $popViewId;

161
162
163
164
165
	/**
	 * Additional GET vars for the link, eg. "&L=xxx"
	 *
	 * @var string
	 */
166
167
	public $popViewId_addParams;

168
169
170
171
172
	/**
	 * Alternative URL for viewing the frontend pages.
	 *
	 * @var string
	 */
173
174
	public $viewUrl;

175
176
177
178
179
	/**
	 * If this is pointing to a page id it will automatically load all content elements
	 * (NORMAL column/default language) from that page into the form!
	 *
	 * @var int
180
	 * @deprecated since TYPO3 CMS 7, will be removed with TYPO3 CMS 8
181
	 */
182
183
	public $editRegularContentFromId;

184
185
186
187
188
	/**
	 * Alternative title for the document handler.
	 *
	 * @var string
	 */
189
190
	public $recTitle;

191
192
193
194
195
	/**
	 * If set, then no SAVE/VIEW button is printed
	 *
	 * @var bool
	 */
196
197
	public $noView;

198
199
200
201
202
	/**
	 * @var string
	 */
	public $perms_clause;

203
204
205
206
207
208
	/**
	 * If set, the $this->editconf array is returned to the calling script
	 * (used by wizard_add.php for instance)
	 *
	 * @var bool
	 */
209
210
	public $returnEditConf;

211
212
213
214
215
216
217
	/**
	 * Workspace used for the editing action.
	 *
	 * @var NULL|integer
	 */
	protected $workspace;

218
219
220
	/**
	 * document template object
	 *
221
	 * @var \TYPO3\CMS\Backend\Template\DocumentTemplate
222
223
224
	 */
	public $doc;

225
226
227
228
229
	/**
	 * a static HTML template, usually in templates/alt_doc.html
	 *
	 * @var string
	 */
230
231
	public $template;

232
233
234
235
236
	/**
	 * Content accumulation
	 *
	 * @var string
	 */
237
238
	public $content;

239
240
	/**
	 * Return URL script, processed. This contains the script (if any) that we should
241
	 * RETURN TO from the FormEngine script IF we press the close button. Thus this
242
243
244
245
	 * variable is normally passed along from the calling script so we can properly return if needed.
	 *
	 * @var string
	 */
246
247
	public $retUrl;

248
249
250
251
252
253
254
	/**
	 * Contains the parts of the REQUEST_URI (current url). By parts we mean the result of resolving
	 * REQUEST_URI (current url) by the parse_url() function. The result is an array where eg. "path"
	 * is the script path and "query" is the parameters...
	 *
	 * @var array
	 */
255
256
	public $R_URL_parts;

257
258
259
260
261
262
	/**
	 * Contains the current GET vars array; More specifically this array is the foundation for creating
	 * the R_URI internal var (which becomes the "url of this script" to which we submit the forms etc.)
	 *
	 * @var array
	 */
263
264
	public $R_URL_getvars;

265
266
267
268
269
	/**
	 * Set to the URL of this script including variables which is needed to re-display the form. See main()
	 *
	 * @var string
	 */
270
271
	public $R_URI;

272
273
274
275
276
277
278
279
280
281
	/**
	 * @var array
	 */
	public $MCONF;

	/**
	 * @var array
	 */
	public $pageinfo;

282
283
284
285
286
287
	/**
	 * Is loaded with the "title" of the currently "open document" - this is used in the
	 * Document Selector box. (see makeDocSel())
	 *
	 * @var string
	 */
288
	public $storeTitle = '';
289

290
291
292
293
294
295
	/**
	 * Contains an array with key/value pairs of GET parameters needed to reach the
	 * current document displayed - used in the Document Selector box. (see compileStoreDat())
	 *
	 * @var array
	 */
296
297
	public $storeArray;

298
299
300
301
302
	/**
	 * Contains storeArray, but imploded into a GET parameter string (see compileStoreDat())
	 *
	 * @var string
	 */
303
304
	public $storeUrl;

305
306
307
308
309
	/**
	 * Hashed value of storeURL (see compileStoreDat())
	 *
	 * @var string
	 */
310
311
	public $storeUrlMd5;

312
313
314
315
316
	/**
	 * Module session data
	 *
	 * @var array
	 */
317
318
	public $docDat;

319
320
321
322
323
324
325
326
	/**
	 * An array of the "open documents" - keys are md5 hashes (see $storeUrlMd5) identifying
	 * the various documents on the GET parameter list needed to open it. The values are
	 * arrays with 0,1,2 keys with information about the document (see compileStoreDat()).
	 * The docHandler variable is stored in the $docDat session data, key "0".
	 *
	 * @var array
	 */
327
328
	public $docHandler;

329
330
331
332
333
	/**
	 * Array of the elements to create edit forms for.
	 *
	 * @var array
	 */
334
335
	public $elementsData;

336
337
338
339
340
	/**
	 * Pointer to the first element in $elementsData
	 *
	 * @var array
	 */
341
342
	public $firstEl;

343
344
345
346
347
	/**
	 * Counter, used to count the number of errors (when users do not have edit permissions)
	 *
	 * @var int
	 */
348
349
	public $errorC;

350
351
352
353
354
	/**
	 * Counter, used to count the number of new record forms displayed
	 *
	 * @var int
	 */
355
356
	public $newC;

357
358
359
360
361
362
	/**
	 * Is set to the pid value of the last shown record - thus indicating which page to
	 * show when clicking the SAVE/VIEW button
	 *
	 * @var int
	 */
363
364
	public $viewId;

365
366
367
368
369
	/**
	 * Is set to additional parameters (like "&L=xxx") if the record supports it.
	 *
	 * @var string
	 */
370
371
	public $viewId_addParams;

372
373
374
375
376
	/**
	 * Module TSconfig, loaded from main() based on the page id value of viewId
	 *
	 * @var array
	 */
377
378
379
	public $modTSconfig;

	/**
380
	 * @var FormResultCompiler
381
	 */
382
	protected $formResultCompiler;
383

384
385
386
387
388
	/**
	 * Used internally to disable the storage of the document reference (eg. new records)
	 *
	 * @var bool
	 */
389
	public $dontStoreDocumentRef = 0;
390

391
392
393
394
395
	/**
	 * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
	 */
	protected $signalSlotDispatcher;

396
397
398
399
400
401
402
	/**
	 * Stores information needed to preview the currently saved record
	 *
	 * @var array
	 */
	protected $previewData = [];

403
404
405
406
407
	/**
	 * @var IconFactory
	 */
	protected $iconFactory;

408
409
410
411
412
	/**
	 * Constructor
	 */
	public function __construct() {
		$GLOBALS['SOBE'] = $this;
413
		$this->getLanguageService()->includeLLFile('EXT:lang/locallang_alt_doc.xlf');
414
		$this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
415
416
	}

417
418
419
420
421
422
423
	/**
	 * Get the SignalSlot dispatcher
	 *
	 * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
	 */
	protected function getSignalSlotDispatcher() {
		if (!isset($this->signalSlotDispatcher)) {
424
			$this->signalSlotDispatcher = GeneralUtility::makeInstance(Dispatcher::class);
425
426
427
428
		}
		return $this->signalSlotDispatcher;
	}

429
430
431
432
433
434
435
436
437
	/**
	 * Emits a signal after a function was executed
	 *
	 * @param string $signalName
	 */
	protected function emitFunctionAfterSignal($signalName) {
		$this->getSignalSlotDispatcher()->dispatch(__CLASS__, $signalName . 'After', array($this));
	}

438
439
440
441
442
443
	/**
	 * First initialization.
	 *
	 * @return void
	 */
	public function preInit() {
Nicole Cordes's avatar
Nicole Cordes committed
444
445
		if (GeneralUtility::_GP('justLocalized')) {
			$this->localizationRedirect(GeneralUtility::_GP('justLocalized'));
446
447
		}
		// Setting GPvars:
Nicole Cordes's avatar
Nicole Cordes committed
448
449
450
451
452
453
454
455
456
		$this->editconf = GeneralUtility::_GP('edit');
		$this->defVals = GeneralUtility::_GP('defVals');
		$this->overrideVals = GeneralUtility::_GP('overrideVals');
		$this->columnsOnly = GeneralUtility::_GP('columnsOnly');
		$this->returnUrl = GeneralUtility::sanitizeLocalUrl(GeneralUtility::_GP('returnUrl'));
		$this->closeDoc = GeneralUtility::_GP('closeDoc');
		$this->doSave = GeneralUtility::_GP('doSave');
		$this->returnEditConf = GeneralUtility::_GP('returnEditConf');
		$this->localizationMode = GeneralUtility::_GP('localizationMode');
457
		$this->workspace = GeneralUtility::_GP('workspace');
Nicole Cordes's avatar
Nicole Cordes committed
458
		$this->uc = GeneralUtility::_GP('uc');
459
460
461
462
463
		// Setting override values as default if defVals does not exist.
		if (!is_array($this->defVals) && is_array($this->overrideVals)) {
			$this->defVals = $this->overrideVals;
		}
		// Setting return URL
464
		$this->retUrl = $this->returnUrl ?: BackendUtility::getModuleUrl('dummy');
465
466
467
		// Fix $this->editconf if versioning applies to any of the records
		$this->fixWSversioningInEditConf();
		// Make R_URL (request url) based on input GETvars:
Nicole Cordes's avatar
Nicole Cordes committed
468
469
		$this->R_URL_parts = parse_url(GeneralUtility::getIndpEnv('REQUEST_URI'));
		$this->R_URL_getvars = GeneralUtility::_GET();
470
471
472
473
		$this->R_URL_getvars['edit'] = $this->editconf;
		// MAKE url for storing
		$this->compileStoreDat();
		// Get session data for the module:
474
		$this->docDat = $this->getBackendUser()->getModuleData('FormEngine', 'ses');
475
476
477
478
479
480
481
482
		$this->docHandler = $this->docDat[0];
		// If a request for closing the document has been sent, act accordingly:
		if ($this->closeDoc > 0) {
			$this->closeDocument($this->closeDoc);
		}
		// If NO vars are sent to the script, try to read first document:
		// Added !is_array($this->editconf) because editConf must not be set either.
		// Anyways I can't figure out when this situation here will apply...
483
		if (is_array($this->R_URL_getvars) && count($this->R_URL_getvars) < 2 && !is_array($this->editconf)) {
484
485
			$this->setDocument($this->docDat[1]);
		}
486
487
488
489
490

		// Sets a temporary workspace, this request is based on
		if ($this->workspace !== NULL) {
			$this->getBackendUser()->setTemporaryWorkspace($this->workspace);
		}
491

492
		$this->emitFunctionAfterSignal(__FUNCTION__);
493
494
495
496
497
	}

	/**
	 * Detects, if a save command has been triggered.
	 *
498
	 * @return bool TRUE, then save the document (data submitted)
499
500
	 */
	public function doProcessData() {
501
		$out = $this->doSave || isset($_POST['_savedok']) || isset($_POST['_saveandclosedok']) || isset($_POST['_savedokview']) || isset($_POST['_savedoknew']) || isset($_POST['_translation_savedok_x']) || isset($_POST['_translation_savedokclear_x']);
502
503
504
505
506
507
508
509
510
		return $out;
	}

	/**
	 * Do processing of data, submitting it to TCEmain.
	 *
	 * @return void
	 */
	public function processData() {
511
		$beUser = $this->getBackendUser();
512
		// GPvars specifically for processing:
Nicole Cordes's avatar
Nicole Cordes committed
513
514
515
516
517
518
519
520
		$control = GeneralUtility::_GP('control');
		$this->data = GeneralUtility::_GP('data');
		$this->cmd = GeneralUtility::_GP('cmd');
		$this->mirror = GeneralUtility::_GP('mirror');
		$this->cacheCmd = GeneralUtility::_GP('cacheCmd');
		$this->redirect = GeneralUtility::_GP('redirect');
		$this->returnNewPageId = GeneralUtility::_GP('returnNewPageId');
		$this->vC = GeneralUtility::_GP('vC');
521
522
		// See tce_db.php for relevate options here:
		// Only options related to $this->data submission are included here.
523
		/** @var $tce \TYPO3\CMS\Core\DataHandling\DataHandler */
524
525
		$tce = GeneralUtility::makeInstance(DataHandler::class);
		$tce->stripslashes_values = FALSE;
526
527
528
529

		if (!empty($control)) {
			$tce->setControl($control);
		}
530
531
532
533
534
535
536
537
		if (isset($_POST['_translation_savedok_x'])) {
			$tce->updateModeL10NdiffData = 'FORCE_FFUPD';
		}
		if (isset($_POST['_translation_savedokclear_x'])) {
			$tce->updateModeL10NdiffData = 'FORCE_FFUPD';
			$tce->updateModeL10NdiffDataClear = TRUE;
		}
		// Setting default values specific for the user:
538
		$TCAdefaultOverride = $beUser->getTSConfigProp('TCAdefaults');
539
540
541
542
		if (is_array($TCAdefaultOverride)) {
			$tce->setDefaultsFromUserTS($TCAdefaultOverride);
		}
		// Setting internal vars:
543
		if ($beUser->uc['neverHideAtCopy']) {
544
545
546
547
548
549
550
551
			$tce->neverHideAtCopy = 1;
		}
		// Loading TCEmain with data:
		$tce->start($this->data, $this->cmd);
		if (is_array($this->mirror)) {
			$tce->setMirror($this->mirror);
		}
		// Checking referer / executing
Nicole Cordes's avatar
Nicole Cordes committed
552
553
		$refInfo = parse_url(GeneralUtility::getIndpEnv('HTTP_REFERER'));
		$httpHost = GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY');
554
		if ($httpHost != $refInfo['host'] && $this->vC != $beUser->veriCode() && !$GLOBALS['TYPO3_CONF_VARS']['SYS']['doNotCheckReferer']) {
555
556
557
558
559
560
561
			$tce->log('', 0, 0, 0, 1, 'Referer host \'%s\' and server host \'%s\' did not match and veriCode was not valid either!', 1, array($refInfo['host'], $httpHost));
			debug('Error: Referer host did not match with server host.');
		} else {
			// Perform the saving operation with TCEmain:
			$tce->process_uploads($_FILES);
			$tce->process_datamap();
			$tce->process_cmdmap();
562
			// If pages are being edited, we set an instruction about updating the page tree after this operation.
563
			if ($tce->pagetreeNeedsRefresh && (isset($this->data['pages']) || $beUser->workspace != 0 && !empty($this->data))) {
564
565
				BackendUtility::setUpdateSignal('updatePageTree');
			}
566
			// If there was saved any new items, load them:
567
			if (!empty($tce->substNEWwithIDs_table)) {
568
				// save the expanded/collapsed states for new inline records, if any
Christian Kuhn's avatar
Christian Kuhn committed
569
				FormEngineUtility::updateInlineView($this->uc, $tce);
570
571
572
				$newEditConf = array();
				foreach ($this->editconf as $tableName => $tableCmds) {
					$keys = array_keys($tce->substNEWwithIDs_table, $tableName);
573
					if (!empty($keys)) {
574
575
576
577
578
						foreach ($keys as $key) {
							$editId = $tce->substNEWwithIDs[$key];
							// Check if the $editId isn't a child record of an IRRE action
							if (!(is_array($tce->newRelatedIDs[$tableName]) && in_array($editId, $tce->newRelatedIDs[$tableName]))) {
								// Translate new id to the workspace version:
579
								if ($versionRec = BackendUtility::getWorkspaceVersionOfRecord($beUser->workspace, $tableName, $editId, 'uid')) {
580
581
582
583
584
									$editId = $versionRec['uid'];
								}
								$newEditConf[$tableName][$editId] = 'edit';
							}
							// Traverse all new records and forge the content of ->editconf so we can continue to EDIT these records!
585
							if ($tableName == 'pages' && $this->retUrl != BackendUtility::getModuleUrl('dummy') && $this->returnNewPageId) {
586
587
588
589
590
591
592
593
								$this->retUrl .= '&id=' . $tce->substNEWwithIDs[$key];
							}
						}
					} else {
						$newEditConf[$tableName] = $tableCmds;
					}
				}
				// Resetting editconf if newEditConf has values:
594
				if (!empty($newEditConf)) {
595
596
597
598
599
600
601
602
603
604
					$this->editconf = $newEditConf;
				}
				// Finally, set the editconf array in the "getvars" so they will be passed along in URLs as needed.
				$this->R_URL_getvars['edit'] = $this->editconf;
				// Unsetting default values since we don't need them anymore.
				unset($this->R_URL_getvars['defVals']);
				// Re-compile the store* values since editconf changed...
				$this->compileStoreDat();
			}
			// See if any records was auto-created as new versions?
605
			if (!empty($tce->autoVersionIdMap)) {
606
607
608
				$this->fixWSversioningInEditConf($tce->autoVersionIdMap);
			}
			// If a document is saved and a new one is created right after.
609
			if (isset($_POST['_savedoknew']) && is_array($this->editconf)) {
610
611
612
613
614
615
				// Finding the current table:
				reset($this->editconf);
				$nTable = key($this->editconf);
				// Finding the first id, getting the records pid+uid
				reset($this->editconf[$nTable]);
				$nUid = key($this->editconf[$nTable]);
Nicole Cordes's avatar
Nicole Cordes committed
616
				$nRec = BackendUtility::getRecord($nTable, $nUid, 'pid,uid');
617
618
619
620
621
622
623
624
625
626
627
628
				// Setting a blank editconf array for a new record:
				$this->editconf = array();
				if ($this->getNewIconMode($nTable) == 'top') {
					$this->editconf[$nTable][$nRec['pid']] = 'new';
				} else {
					$this->editconf[$nTable][-$nRec['uid']] = 'new';
				}
				// Finally, set the editconf array in the "getvars" so they will be passed along in URLs as needed.
				$this->R_URL_getvars['edit'] = $this->editconf;
				// Re-compile the store* values since editconf changed...
				$this->compileStoreDat();
			}
629
			// If a preview is requested
630
			if (isset($_POST['_savedokview'])) {
631
632
633
634
635
636
637
638
639
640
				// Get the first table and id of the data array from DataHandler
				$table = reset(array_keys($this->data));
				$id = reset(array_keys($this->data[$table]));
				if (!MathUtility::canBeInterpretedAsInteger($id)) {
					$id = $tce->substNEWwithIDs[$id];
				}
				// Store this information for later use
				$this->previewData['table'] = $table;
				$this->previewData['id'] = $id;
			}
641
			$tce->printLogErrorMessages(isset($_POST['_saveandclosedok']) || isset($_POST['_translation_savedok_x']) ? $this->retUrl : $this->R_URL_parts['path'] . '?' . GeneralUtility::implodeArrayForUrl('', $this->R_URL_getvars));
642
643
644
		}
		//  || count($tce->substNEWwithIDs)... If any new items has been save, the document is CLOSED
		// because if not, we just get that element re-listed as new. And we don't want that!
645
		if (isset($_POST['_saveandclosedok']) || isset($_POST['_translation_savedok_x']) || $this->closeDoc < 0) {
646
647
648
649
650
651
652
653
654
655
			$this->closeDocument(abs($this->closeDoc));
		}
	}

	/**
	 * Initialize the normal module operation
	 *
	 * @return void
	 */
	public function init() {
656
		$beUser = $this->getBackendUser();
657
		// Setting more GPvars:
Nicole Cordes's avatar
Nicole Cordes committed
658
659
660
661
662
663
		$this->popViewId = GeneralUtility::_GP('popViewId');
		$this->popViewId_addParams = GeneralUtility::_GP('popViewId_addParams');
		$this->viewUrl = GeneralUtility::_GP('viewUrl');
		$this->editRegularContentFromId = GeneralUtility::_GP('editRegularContentFromId');
		$this->recTitle = GeneralUtility::_GP('recTitle');
		$this->noView = GeneralUtility::_GP('noView');
664
		$this->perms_clause = $beUser->getPagePermsClause(1);
665
666
		// Set other internal variables:
		$this->R_URL_getvars['returnUrl'] = $this->retUrl;
667
		$this->R_URI = $this->R_URL_parts['path'] . '?' . ltrim(GeneralUtility::implodeArrayForUrl('', $this->R_URL_getvars), '&');
668
669
		// Setting virtual document name
		$this->MCONF['name'] = 'xMOD_alt_doc.php';
670

671
672
		// Create an instance of the document template object
		$this->doc = $GLOBALS['TBE_TEMPLATE'];
673
674
		$pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
		$pageRenderer->addInlineLanguageLabelFile('EXT:lang/locallang_alt_doc.xlf');
675
		$this->doc->setModuleTemplate('EXT:backend/Resources/Private/Templates/alt_doc.html');
676
		$this->doc->form = '<form action="' . htmlspecialchars($this->R_URI) . '" method="post" enctype="multipart/form-data" name="editform" onsubmit="document.editform._scrollPosition.value=(document.documentElement.scrollTop || document.body.scrollTop); TBE_EDITOR.checkAndDoSubmit(1); return false;">';
677
678
679
		// override the default jumpToUrl
		$this->doc->JScodeArray['jumpToUrl'] = '
			function jumpToUrl(URL,formEl) {
680
681
682
683
684
685
				if (!TBE_EDITOR.isFormChanged()) {
					window.location.href = URL;
				} else if (formEl && formEl.type=="checkbox") {
					formEl.checked = formEl.checked ? 0 : 1;
				}
			}
686
';
687
688
689
		// define the window size of the element browser
		$popupWindowWidth  = 700;
		$popupWindowHeight = 750;
690
		$popupWindowSize = trim($beUser->getTSConfigVal('options.popupWindowSize'));
691
692
693
694
695
696
697
698
699
		if (!empty($popupWindowSize)) {
			list($popupWindowWidth, $popupWindowHeight) = GeneralUtility::intExplode('x', $popupWindowSize);
		}
		$t3Configuration = array(
			'PopupWindow' => array(
				'width' => $popupWindowWidth,
				'height' => $popupWindowHeight
			),
		);
700
701
702
703
704
		$javascript = '
			TYPO3.configuration = ' . json_encode($t3Configuration) . ';
			// Object: TS:
			// passwordDummy and decimalSign are used by tbe_editor.js and have to be declared here as
			// TS object overwrites the object declared in tbe_editor.js
705
706
707
			function typoSetup() {	//
				this.uniqueID = "";
				this.passwordDummy = "********";
708
				this.PATH_typo3 = "";
709
710
711
712
713
714
715
				this.decimalSign = ".";
			}
			var TS = new typoSetup();

				// Info view:
			function launchView(table,uid,bP) {	//
				var backPath= bP ? bP : "";
716
717
718
719
720
				var thePreviewWindow = window.open(
					backPath+' . GeneralUtility::quoteJSvalue(BackendUtility::getModuleUrl('show_item') . '&table=') . ' + encodeURIComponent(table) + "&uid=" + encodeURIComponent(uid),
					"ShowItem" + TS.uniqueID,
					"height=300,width=410,status=0,menubar=0,resizable=0,location=0,directories=0,scrollbars=1,toolbar=0"
				);
721
722
723
724
725
				if (thePreviewWindow && thePreviewWindow.focus) {
					thePreviewWindow.focus();
				}
			}
			function deleteRecord(table,id,url) {	//
726
				window.location.href = ' . GeneralUtility::quoteJSvalue(BackendUtility::getModuleUrl('tce_db') . '&cmd[') . '+table+"]["+id+"][delete]=1&redirect="+escape(url)+"&vC=' . $beUser->veriCode() . '&prErr=1&uPT=1";
727
			}
728
729
		';

730
		$previewCode = isset($_POST['_savedokview']) && $this->popViewId ? $this->generatePreviewCode() : '';
731
732

		$this->doc->JScode = $this->doc->wrapScriptTags($javascript . $previewCode);
733
734
		// Setting up the context sensitive menu:
		$this->doc->getContextMenuCode();
Nicole Cordes's avatar
Nicole Cordes committed
735
		$this->doc->bodyTagAdditions = 'onload="window.scrollTo(0,' . MathUtility::forceIntegerInRange(GeneralUtility::_GP('_scrollPosition'), 0, 10000) . ');"';
736

737
		$this->emitFunctionAfterSignal(__FUNCTION__);
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
	/**
	 * @return string
	 */
	protected function generatePreviewCode() {
		$currentPageId = MathUtility::convertToPositiveInteger($this->popViewId);
		$table = $this->previewData['table'];
		$recordId = $this->previewData['id'];

		$pageTsConfig = BackendUtility::getPagesTSconfig($currentPageId);
		$previewConfiguration = isset($pageTsConfig['TCEMAIN.']['preview.'][$table . '.'])
			? $pageTsConfig['TCEMAIN.']['preview.'][$table . '.']
			: array();

		$recordArray = BackendUtility::getRecord($table, $recordId);

		// find the right preview page id
		$previewPageId = 0;
		if (isset($previewConfiguration['previewPageId'])) {
			$previewPageId = $previewConfiguration['previewPageId'];
		}
		// if no preview page was configured
		if (!$previewPageId) {
			$rootPageData = NULL;
			$rootLine = BackendUtility::BEgetRootLine($currentPageId);
			$currentPage = reset($rootLine);
			if ((int)$currentPage['doktype'] === PageRepository::DOKTYPE_DEFAULT) {
				// try the current page
				$previewPageId = $currentPageId;
			} else {
				// or search for the root page
				foreach ($rootLine as $page) {
					if ($page['is_siteroot']) {
						$rootPageData = $page;
						break;
					}
				}
				$previewPageId = isset($rootPageData)
					? (int)$rootPageData['uid']
					: $currentPageId;
			}
		}

		$linkParameters = [
			'no_cache' => 1,
		];

		// language handling
		$languageField = isset($GLOBALS['TCA'][$table]['ctrl']['languageField'])
			? $GLOBALS['TCA'][$table]['ctrl']['languageField']
			: '';
		if ($languageField && !empty($recordArray[$languageField])) {
			$l18nPointer = isset($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'])
				? $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']
				: '';
			if (
				$l18nPointer && !empty($recordArray[$l18nPointer])
				&& isset($previewConfiguration['useDefaultLanguageRecord'])
				&& !$previewConfiguration['useDefaultLanguageRecord']
			) {
				// use parent record
				$recordId = $recordArray[$l18nPointer];
			}
			$linkParameters['L'] = $recordArray[$languageField];
		}

		// map record data to GET parameters
		if (isset($previewConfiguration['fieldToParameterMap.'])) {
			foreach ($previewConfiguration['fieldToParameterMap.'] as $field => $parameterName) {
				$value = $recordArray[$field];
				if ($field === 'uid') {
					$value = $recordId;
				}
				$linkParameters[$parameterName] = $value;
			}
		}

		// add/override parameters by configuration
		if (isset($previewConfiguration['additionalGetParameters.'])) {
			$linkParameters = array_replace($linkParameters, $previewConfiguration['additionalGetParameters.']);
		}

		$this->popViewId = $previewPageId;
		$this->popViewId_addParams = GeneralUtility::implodeArrayForUrl('', $linkParameters, '', FALSE, TRUE);

		$previewPageRootline = BackendUtility::BEgetRootLine($this->popViewId);
		return '
				if (window.opener) {
				'
			. BackendUtility::viewOnClick($this->popViewId, '', $previewPageRootline, '', $this->viewUrl, $this->popViewId_addParams, FALSE)
			. '
				} else {
				'
			. BackendUtility::viewOnClick($this->popViewId, '', $previewPageRootline, '', $this->viewUrl, $this->popViewId_addParams)
			. '
				}';
	}

837
838
839
840
841
842
	/**
	 * Main module operation
	 *
	 * @return void
	 */
	public function main() {
843
		$body = '';
844
845
		// Begin edit:
		if (is_array($this->editconf)) {
846
847
848
			/** @var FormResultCompiler formResultCompiler */
			$this->formResultCompiler = GeneralUtility::makeInstance(FormResultCompiler::class);

849
850
851
852
853
854
855
856
			if ($this->editRegularContentFromId) {
				$this->editRegularContentFromId();
			}
			// Creating the editing form, wrap it with buttons, document selector etc.
			$editForm = $this->makeEditForm();
			if ($editForm) {
				$this->firstEl = reset($this->elementsData);
				// Checking if the currently open document is stored in the list of "open documents" - if not, then add it:
857
				if (($this->docDat[1] !== $this->storeUrlMd5 || !isset($this->docHandler[$this->storeUrlMd5])) && !$this->dontStoreDocumentRef) {
858
					$this->docHandler[$this->storeUrlMd5] = array($this->storeTitle, $this->storeArray, $this->storeUrl, $this->firstEl);
859
					$this->getBackendUser()->pushModuleData('FormEngine', array($this->docHandler, $this->storeUrlMd5));
Nicole Cordes's avatar
Nicole Cordes committed
860
					BackendUtility::setUpdateSignal('OpendocsController::updateNumber', count($this->docHandler));
861
862
				}
				// Module configuration
Nicole Cordes's avatar
Nicole Cordes committed
863
				$this->modTSconfig = $this->viewId ? BackendUtility::getModTSconfig($this->viewId, 'mod.xMOD_alt_doc') : array();
864
				$body = $this->formResultCompiler->JStop();
865
				$body .= $this->compileForm($editForm);
866
				$body .= $this->formResultCompiler->printNeededJSFunctions();
867
868
869
870
			}
		}
		// Access check...
		// The page will show only if there is a valid page and if this page may be viewed by the user
Nicole Cordes's avatar
Nicole Cordes committed
871
		$this->pageinfo = BackendUtility::readPageAccess($this->viewId, $this->perms_clause);
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
		// Setting up the buttons and markers for docheader
		$docHeaderButtons = $this->getButtons();
		$markers = array(
			'LANGSELECTOR' => $this->langSelector(),
			'CSH' => $docHeaderButtons['csh'],
			'CONTENT' => $body
		);
		// Build the <body> for the module
		$this->content = $this->doc->startPage('TYPO3 Edit Document');
		$this->content .= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
		$this->content .= $this->doc->endPage();
		$this->content = $this->doc->insertStylesAndJS($this->content);
	}

	/**
	 * Outputting the accumulated content to screen
	 *
	 * @return void
890
	 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
891
892
	 */
	public function printContent() {
893
		GeneralUtility::logDeprecatedFunction();
894
895
896
897
898
899
900
901
902
		echo $this->content;
	}

	/***************************
	 *
	 * Sub-content functions, rendering specific parts of the module content.
	 *
	 ***************************/
	/**
903
	 * Creates the editing form with FormEnigne, based on the input from GPvars.
904
905
906
907
908
909
910
911
912
913
	 *
	 * @return string HTML form elements wrapped in tables
	 */
	public function makeEditForm() {
		// Initialize variables:
		$this->elementsData = array();
		$this->errorC = 0;
		$this->newC = 0;
		$editForm = '';
		$trData = NULL;
914
		$beUser = $this->getBackendUser();
915
916
917
		// Traverse the GPvar edit array
		// Tables:
		foreach ($this->editconf as $table => $conf) {
918
			if (is_array($conf) && $GLOBALS['TCA'][$table] && $beUser->check('tables_modify', $table)) {
919
				// Traverse the keys/comments of each table (keys can be a commalist of uids)
920
921
				foreach ($conf as $cKey => $command) {
					if ($command == 'edit' || $command == 'new') {
922
						// Get the ids:
923
						$ids = GeneralUtility::trimExplode(',', $cKey, TRUE);
924
925
						// Traverse the ids:
						foreach ($ids as $theUid) {
926
927
928

							// Don't save this document title in the document selector if the document is new.
							if ($command === 'new') {
929
								$this->dontStoreDocumentRef = 1;
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
							}

							/** @var TcaDatabaseRecord $formDataGroup */
							$formDataGroup = GeneralUtility::makeInstance(TcaDatabaseRecord::class);
							/** @var FormDataCompiler $formDataCompiler */
							$formDataCompiler = GeneralUtility::makeInstance(FormDataCompiler::class, $formDataGroup);
							/** @var NodeFactory $nodeFactory */
							$nodeFactory = GeneralUtility::makeInstance(NodeFactory::class);

							try {
								// Reset viewId - it should hold data of last entry only
								$this->viewId = 0;
								$this->viewId_addParams = '';

								$formDataCompilerInput = [
									'tableName' => $table,
									'vanillaUid' => (int)$theUid,
									'command' => $command,
									'returnUrl' => $this->R_URI,
								];
950
951
952
953
								if (is_array($this->overrideVals) && is_array($this->overrideVals[$table])) {
									$formDataCompilerInput['overrideValues'] = $this->overrideVals[$table];
								}

954
955
956
957
958
959
960
961
962
963
								$formData = $formDataCompiler->compile($formDataCompilerInput);

								// Set this->viewId if possible
								if ($command === 'new' && $table !== 'pages' && !empty($formData['parentPageRow']['uid'])) {
									$this->viewId = $formData['parentPageRow']['uid'];
								} else {
									if ($table == 'pages') {
										$this->viewId = $formData['databaseRow']['uid'];
									} elseif (!empty($formData['parentPageRow']['uid'])) {
										$this->viewId = $formData['parentPageRow']['uid'];
964
										// Adding "&L=xx" if the record being edited has a languageField with a value larger than zero!
965
966
967
968
969
										if (!empty($formData['vanillaTableTca']['ctrl']['languageField'])
											&& is_array($formData['databaseRow'][$formData['vanillaTableTca']['ctrl']['languageField']])
											&& $formData['databaseRow'][$formData['vanillaTableTca']['ctrl']['languageField']][0] > 0
										) {
											$this->viewId_addParams = '&L=' . $formData['databaseRow'][$formData['vanillaTableTca']['ctrl']['languageField']][0];
970
971
972
										}
									}
								}
973
974
975
976
977
978
979

								// Determine if delete button can be shown
								$deleteAccess = FALSE;
								if ($command === 'edit') {
									$permission = $formData['userPermissionOnPage'];
									if ($formData['tableName'] === 'pages') {
										$deleteAccess = $permission & Permission::PAGE_DELETE ? TRUE : FALSE;
980
									} else {
981
										$deleteAccess = $permission & Permission::CONTENT_EDIT ? TRUE : FALSE;
982
									}
983
984
985
986
987
988
								}

								// Display "is-locked" message:
								if ($command === 'edit') {
									$lockInfo = BackendUtility::isRecordLocked($table, $formData['databaseRow']['uid']);
									if ($lockInfo) {
989
990
										/** @var $flashMessage \TYPO3\CMS\Core\Messaging\FlashMessage */
										$flashMessage = GeneralUtility::makeInstance(FlashMessage::class, htmlspecialchars($lockInfo['msg']), '', FlashMessage::WARNING);
991
										/** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
992
										$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
993
994
995
										/** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
										$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
										$defaultFlashMessageQueue->enqueue($flashMessage);
996
997
									}
								}
998
999
1000

								// Record title
								if (!$this->storeTitle) {