InlineRecordContainer.php 32.4 KB
Newer Older
Christian Kuhn's avatar
Christian Kuhn committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?php
namespace TYPO3\CMS\Backend\Form\Container;

/*
 * 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\Form\Element\InlineElementHookInterface;
18
use TYPO3\CMS\Backend\Form\Exception\AccessDeniedContentEditException;
19
use TYPO3\CMS\Backend\Form\InlineStackProcessor;
20
use TYPO3\CMS\Backend\Form\NodeFactory;
Christian Kuhn's avatar
Christian Kuhn committed
21
22
use TYPO3\CMS\Backend\Form\Utility\FormEngineUtility;
use TYPO3\CMS\Backend\Utility\BackendUtility;
23
24
25
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Database\DatabaseConnection;
use TYPO3\CMS\Core\Database\RelationHandler;
26
27
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
28
use TYPO3\CMS\Core\Messaging\FlashMessage;
Christian Kuhn's avatar
Christian Kuhn committed
29
30
use TYPO3\CMS\Core\Resource\ProcessedFile;
use TYPO3\CMS\Core\Resource\ResourceFactory;
31
use TYPO3\CMS\Core\Type\Bitmask\Permission;
Christian Kuhn's avatar
Christian Kuhn committed
32
use TYPO3\CMS\Core\Utility\GeneralUtility;
33
use TYPO3\CMS\Core\Utility\MathUtility;
Christian Kuhn's avatar
Christian Kuhn committed
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
use TYPO3\CMS\Lang\LanguageService;

/**
 * Render a single inline record relation.
 *
 * This container is called by InlineControlContainer to render single existing records.
 * Furthermore it is called by FormEngine for an incoming ajax request to expand an existing record
 * or to create a new one.
 *
 * This container creates the outer HTML of single inline records - eg. drag and drop and delete buttons.
 * For rendering of the record itself processing is handed over to FullRecordContainer.
 */
class InlineRecordContainer extends AbstractContainer {

	/**
	 * Inline data array used for JSON output
	 *
	 * @var array
	 */
	protected $inlineData = array();

	/**
	 * @var InlineStackProcessor
	 */
	protected $inlineStackProcessor;

	/**
	 * Array containing instances of hook classes called once for IRRE objects
	 *
	 * @var array
	 */
	protected $hookObjects = array();

67
68
69
70
71
72
	/**
	 * @var IconFactory
	 */
	protected $iconFactory;

	/**
73
74
75
76
	 * Default constructor
	 *
	 * @param NodeFactory $nodeFactory
	 * @param array $data
77
	 */
78
79
	public function __construct(NodeFactory $nodeFactory, array $data) {
		parent::__construct($nodeFactory, $data);
80
81
82
		$this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
	}

Christian Kuhn's avatar
Christian Kuhn committed
83
84
85
86
	/**
	 * Entry method
	 *
	 * @return array As defined in initializeResultArray() of AbstractNode
87
	 * @throws AccessDeniedContentEditException
Christian Kuhn's avatar
Christian Kuhn committed
88
89
	 */
	public function render() {
90
		$this->inlineData = $this->data['inlineData'];
Christian Kuhn's avatar
Christian Kuhn committed
91
92
93
94

		/** @var InlineStackProcessor $inlineStackProcessor */
		$inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
		$this->inlineStackProcessor = $inlineStackProcessor;
95
		$inlineStackProcessor->initializeByGivenStructure($this->data['inlineStructure']);
Christian Kuhn's avatar
Christian Kuhn committed
96
97
98

		$this->initHookObjects();

99
100
101
		$parentUid = $this->data['inlineParentUid'];
		$record = $this->data['databaseRow'];
		$config = $this->data['inlineParentConfig'];
Christian Kuhn's avatar
Christian Kuhn committed
102
103
104
105
106
107
108

		$foreign_table = $config['foreign_table'];
		$foreign_selector = $config['foreign_selector'];
		$resultArray = $this->initializeResultArray();

		// Send a mapping information to the browser via JSON:
		// e.g. data[<curTable>][<curId>][<curField>] => data-<pid>-<parentTable>-<parentId>-<parentField>-<curTable>-<curId>-<curField>
109
		$formPrefix = $inlineStackProcessor->getCurrentStructureFormPrefix();
110
		$domObjectId = $inlineStackProcessor->getCurrentStructureDomObjectIdPrefix($this->data['inlineFirstPid']);
Christian Kuhn's avatar
Christian Kuhn committed
111
112
113
114
115
116
		$this->inlineData['map'][$formPrefix] = $domObjectId;

		$resultArray['inlineData'] = $this->inlineData;

		// Set this variable if we handle a brand new unsaved record:
		$isNewRecord = !MathUtility::canBeInterpretedAsInteger($record['uid']);
117
118
		// Set this variable if the only the default language record and inline child has not been localized yet
		$isDefaultLanguageRecord = $this->data['inlineIsDefaultLanguage'];
Christian Kuhn's avatar
Christian Kuhn committed
119
120
		// If there is a selector field, normalize it:
		if ($foreign_selector) {
121
122
123
124
125
126
			$valueToNormalize = $record[$foreign_selector];
			if (is_array($record[$foreign_selector])) {
				// @todo: this can be kicked again if always prepared rows are handled here
				$valueToNormalize = implode(',', $record[$foreign_selector]);
			}
			$record[$foreign_selector] = $this->normalizeUid($valueToNormalize);
Christian Kuhn's avatar
Christian Kuhn committed
127
128
129
130
131
132
133
		}
		// Get the current naming scheme for DOM name/id attributes:
		$appendFormFieldNames = '[' . $foreign_table . '][' . $record['uid'] . ']';
		$objectId = $domObjectId . '-' . $foreign_table . '-' . $record['uid'];
		$class = '';
		$html = '';
		$combinationHtml = '';
134
		if (!$isDefaultLanguageRecord) {
Christian Kuhn's avatar
Christian Kuhn committed
135
136
137
			// Get configuration:
			$collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
			$expandAll = isset($config['appearance']['collapseAll']) && !$config['appearance']['collapseAll'];
138
			$ajaxLoad = !isset($config['appearance']['ajaxLoad']) || $config['appearance']['ajaxLoad'];
Christian Kuhn's avatar
Christian Kuhn committed
139
140
141
142
143
144
			if ($isNewRecord) {
				// Show this record expanded or collapsed
				$isExpanded = $expandAll || (!$collapseAll ? 1 : 0);
			} else {
				$isExpanded = $config['renderFieldsOnly'] || !$collapseAll && $this->getExpandedCollapsedState($foreign_table, $record['uid']) || $expandAll;
			}
145
			// Render full content ONLY IF this is an AJAX request, a new record, the record is not collapsed or AJAX loading is explicitly turned off
Christian Kuhn's avatar
Christian Kuhn committed
146
147
			if ($isNewRecord || $isExpanded || !$ajaxLoad) {

148
149
150
151
152
153
154
155
156
157
				$combinationHtml = '';
				if (isset($this->data['combinationChild'])) {
					$combinationChild = $this->renderCombinationChild($this->data, $appendFormFieldNames);
					$combinationHtml = $combinationChild['html'];
					$combinationChild['html'] = '';
					$resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $combinationChild);
				}

				$childArray = $this->renderChild($this->data);

Christian Kuhn's avatar
Christian Kuhn committed
158
159
160
161
162
163
164
165
166
167
168
169
				$html = $childArray['html'];
				$childArray['html'] = '';
				$resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $childArray);
			} else {
				// This string is the marker for the JS-function to check if the full content has already been loaded
				$html = '<!--notloaded-->';
			}
			if ($isNewRecord) {
				// Get the top parent table
				$top = $this->inlineStackProcessor->getStructureLevel(0);
				$ucFieldName = 'uc[inlineView][' . $top['table'] . '][' . $top['uid'] . ']' . $appendFormFieldNames;
				// Set additional fields for processing for saving
170
				$html .= '<input type="hidden" name="data' . $appendFormFieldNames . '[pid]" value="' . $record['pid'] . '"/>';
Christian Kuhn's avatar
Christian Kuhn committed
171
172
173
				$html .= '<input type="hidden" name="' . $ucFieldName . '" value="' . $isExpanded . '" />';
			} else {
				// Set additional field for processing for saving
174
				$html .= '<input type="hidden" name="cmd' . $appendFormFieldNames . '[delete]" value="1" disabled="disabled" />';
Christian Kuhn's avatar
Christian Kuhn committed
175
176
177
178
179
				if (!$isExpanded
					&& !empty($GLOBALS['TCA'][$foreign_table]['ctrl']['enablecolumns']['disabled'])
					&& $ajaxLoad
				) {
					$checked = !empty($record['hidden']) ? ' checked="checked"' : '';
180
181
					$html .= '<input type="checkbox" name="data' . $appendFormFieldNames . '[hidden]_0" value="1"' . $checked . ' />';
					$html .= '<input type="input" name="data' . $appendFormFieldNames . '[hidden]" value="' . $record['hidden'] . '" />';
Christian Kuhn's avatar
Christian Kuhn committed
182
183
184
185
186
187
188
189
190
				}
			}
			// If this record should be shown collapsed
			$class = $isExpanded ? 'panel-visible' : 'panel-collapsed';
		}
		if ($config['renderFieldsOnly']) {
			$html = $html . $combinationHtml;
		} else {
			// Set the record container with data for output
191
			if ($isDefaultLanguageRecord) {
Christian Kuhn's avatar
Christian Kuhn committed
192
193
194
195
196
197
198
199
				$class .= ' t3-form-field-container-inline-placeHolder';
			}
			if (isset($record['hidden']) && (int)$record['hidden']) {
				$class .= ' t3-form-field-container-inline-hidden';
			}
			$class .= ($isNewRecord ? ' inlineIsNewRecord' : '');
			$html = '
				<div class="panel panel-default panel-condensed ' . trim($class) . '" id="' . $objectId . '_div">
200
					<div class="panel-heading" data-toggle="formengine-inline" id="' . $objectId . '_header" data-expandSingle="' . ($config['appearance']['expandSingle'] ? 1 : 0) . '">
Christian Kuhn's avatar
Christian Kuhn committed
201
202
203
204
						<div class="form-irre-header">
							<div class="form-irre-header-cell form-irre-header-icon">
								<span class="caret"></span>
							</div>
205
							' . $this->renderForeignRecordHeader($parentUid, $foreign_table, $this->data, $config, $isDefaultLanguageRecord) . '
Christian Kuhn's avatar
Christian Kuhn committed
206
207
208
209
210
211
212
213
214
215
216
						</div>
					</div>
					<div class="panel-collapse" id="' . $objectId . '_fields" data-expandSingle="' . ($config['appearance']['expandSingle'] ? 1 : 0) . '" data-returnURL="' . htmlspecialchars(GeneralUtility::getIndpEnv('REQUEST_URI')) . '">' . $html . $combinationHtml . '</div>
				</div>';
		}

		$resultArray['html'] = $html;
		return $resultArray;
	}

	/**
217
	 * Render inner child
Christian Kuhn's avatar
Christian Kuhn committed
218
	 *
219
220
	 * @param array $options
	 * @return array Result array
Christian Kuhn's avatar
Christian Kuhn committed
221
	 */
222
223
224
	protected function renderChild(array $options) {
		$domObjectId = $this->inlineStackProcessor->getCurrentStructureDomObjectIdPrefix($options['inlineFirstPid']);
		$options['tabAndInlineStack'][] = [
Christian Kuhn's avatar
Christian Kuhn committed
225
			'inline',
226
			$domObjectId . '-' . $options['tableName'] . '-' . $options['databaseRow']['uid'],
227
		];
228
229
		// @todo: ugly construct ...
		$options['inlineData'] = $this->inlineData;
230
		$options['renderType'] = 'fullRecordContainer';
231
		return $this->nodeFactory->create($options)->render();
Christian Kuhn's avatar
Christian Kuhn committed
232
233
234
	}

	/**
235
236
	 * Render child child
	 *
237
	 * Render a table with FormEngine, that occurs on an intermediate table but should be editable directly,
Christian Kuhn's avatar
Christian Kuhn committed
238
239
240
	 * so two tables are combined (the intermediate table with attributes and the sub-embedded table).
	 * -> This is a direct embedding over two levels!
	 *
241
	 * @param array $options
Christian Kuhn's avatar
Christian Kuhn committed
242
	 * @param string $appendFormFieldNames The [<table>][<uid>] of the parent record (the intermediate table)
243
	 * @return array Result array
Christian Kuhn's avatar
Christian Kuhn committed
244
	 */
245
246
247
	protected function renderCombinationChild(array $options, $appendFormFieldNames) {
		$childData = $options['combinationChild'];
		$parentConfig = $options['inlineParentConfig'];
Christian Kuhn's avatar
Christian Kuhn committed
248

249
		$resultArray = $this->initializeResultArray();
250

251
252
253
254
255
		// Display Warning FlashMessage if it is not suppressed
		if (!isset($parentConfig['appearance']['suppressCombinationWarning']) || empty($parentConfig['appearance']['suppressCombinationWarning'])) {
			$combinationWarningMessage = 'LLL:EXT:lang/locallang_core.xlf:warning.inline_use_combination';
			if (!empty($parentConfig['appearance']['overwriteCombinationWarningMessage'])) {
				$combinationWarningMessage = $parentConfig['appearance']['overwriteCombinationWarningMessage'];
256
			}
257
258
259
260
261
262
263
264
			$flashMessage = GeneralUtility::makeInstance(
				FlashMessage::class,
				$this->getLanguageService()->sL($combinationWarningMessage),
				'',
				FlashMessage::WARNING
			);
			$resultArray['html'] = $flashMessage->render();
		}
Christian Kuhn's avatar
Christian Kuhn committed
265

266
267
		$childArray = $this->renderChild($childData);
		$resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $childArray);
Christian Kuhn's avatar
Christian Kuhn committed
268

269
270
271
272
273
274
275
276
277
		// If this is a new record, add a pid value to store this record and the pointer value for the intermediate table
		if ($childData['command'] === 'new') {
			$comboFormFieldName = 'data[' . $childData['tableName'] . '][' . $childData['databaseRow']['uid'] . '][pid]';
			$resultArray['html'] .= '<input type="hidden" name="' . htmlspecialchars($comboFormFieldName) . '" value="' . htmlspecialchars($childData['databaseRow']['pid']) . '" />';
		}
		// If the foreign_selector field is also responsible for uniqueness, tell the browser the uid of the "other" side of the relation
		if ($childData['command'] === 'new' || $parentConfig['foreign_unique'] === $parentConfig['foreign_selector']) {
			$parentFormFieldName = 'data' . $appendFormFieldNames . '[' . $parentConfig['foreign_selector'] . ']';
			$resultArray['html'] .= '<input type="hidden" name="' . htmlspecialchars($parentFormFieldName) . '" value="' . htmlspecialchars($childData['databaseRow']['uid']) . '" />';
Christian Kuhn's avatar
Christian Kuhn committed
278
		}
279

Christian Kuhn's avatar
Christian Kuhn committed
280
281
282
		return $resultArray;
	}

283

Christian Kuhn's avatar
Christian Kuhn committed
284
285
286
287
288
289
	/**
	 * Renders the HTML header for a foreign record, such as the title, toggle-function, drag'n'drop, etc.
	 * Later on the command-icons are inserted here.
	 *
	 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
	 * @param string $foreign_table The foreign_table we create a header for
290
	 * @param array $data Current data
Christian Kuhn's avatar
Christian Kuhn committed
291
292
293
294
	 * @param array $config content of $PA['fieldConf']['config']
	 * @param bool $isVirtualRecord
	 * @return string The HTML code of the header
	 */
295
296
	protected function renderForeignRecordHeader($parentUid, $foreign_table, $data, $config, $isVirtualRecord = FALSE) {
		$rec = $data['databaseRow'];
Christian Kuhn's avatar
Christian Kuhn committed
297
		// Init:
298
		$domObjectId = $this->inlineStackProcessor->getCurrentStructureDomObjectIdPrefix($this->data['inlineFirstPid']);
Christian Kuhn's avatar
Christian Kuhn committed
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
		$objectId = $domObjectId . '-' . $foreign_table . '-' . $rec['uid'];
		// We need the returnUrl of the main script when loading the fields via AJAX-call (to correct wizard code, so include it as 3rd parameter)
		// Pre-Processing:
		$isOnSymmetricSide = RelationHandler::isOnSymmetricSide($parentUid, $config, $rec);
		$hasForeignLabel = (bool)(!$isOnSymmetricSide && $config['foreign_label']);
		$hasSymmetricLabel = (bool)$isOnSymmetricSide && $config['symmetric_label'];

		// Get the record title/label for a record:
		// Try using a self-defined user function only for formatted labels
		if (isset($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc'])) {
			$params = array(
				'table' => $foreign_table,
				'row' => $rec,
				'title' => '',
				'isOnSymmetricSide' => $isOnSymmetricSide,
				'options' => isset($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc_options'])
					? $GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc_options']
					: array(),
				'parent' => array(
					'uid' => $parentUid,
					'config' => $config
				)
			);
			// callUserFunction requires a third parameter, but we don't want to give $this as reference!
			$null = NULL;
			GeneralUtility::callUserFunction($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc'], $params, $null);
			$recTitle = $params['title'];

			// Try using a normal self-defined user function
		} elseif (isset($GLOBALS['TCA'][$foreign_table]['ctrl']['label_userFunc'])) {
			$params = array(
				'table' => $foreign_table,
				'row' => $rec,
				'title' => '',
				'isOnSymmetricSide' => $isOnSymmetricSide,
				'parent' => array(
					'uid' => $parentUid,
					'config' => $config
				)
			);
			// callUserFunction requires a third parameter, but we don't want to give $this as reference!
			$null = NULL;
			GeneralUtility::callUserFunction($GLOBALS['TCA'][$foreign_table]['ctrl']['label_userFunc'], $params, $null);
			$recTitle = $params['title'];
		} elseif ($hasForeignLabel || $hasSymmetricLabel) {
			$titleCol = $hasForeignLabel ? $config['foreign_label'] : $config['symmetric_label'];
			$foreignConfig = FormEngineUtility::getInlinePossibleRecordsSelectorConfig($config, $titleCol);
			// Render title for everything else than group/db:
			if ($foreignConfig['type'] !== 'groupdb') {
				$recTitle = BackendUtility::getProcessedValueExtra($foreign_table, $titleCol, $rec[$titleCol], 0, 0, FALSE);
			} else {
				// $recTitle could be something like: "tx_table_123|...",
				$valueParts = GeneralUtility::trimExplode('|', $rec[$titleCol]);
				$itemParts = GeneralUtility::revExplode('_', $valueParts[0], 2);
				$recTemp = BackendUtility::getRecordWSOL($itemParts[0], $itemParts[1]);
				$recTitle = BackendUtility::getRecordTitle($itemParts[0], $recTemp, FALSE);
			}
			$recTitle = BackendUtility::getRecordTitlePrep($recTitle);
			if (trim($recTitle) === '') {
				$recTitle = BackendUtility::getNoRecordTitle(TRUE);
			}
		} else {
361
			$recTitle = BackendUtility::getRecordTitle($foreign_table, FormEngineUtility::databaseRowCompatibility($rec), TRUE);
Christian Kuhn's avatar
Christian Kuhn committed
362
363
364
		}

		$altText = BackendUtility::getRecordIconAltText($rec, $foreign_table);
365

366
		$iconImg = '<span title="' . $altText . '" id="' . htmlspecialchars($objectId) . '_icon' . '">' . $this->iconFactory->getIconForRecord($foreign_table, $rec, Icon::SIZE_SMALL)->render() . '</span>';
Christian Kuhn's avatar
Christian Kuhn committed
367
		$label = '<span id="' . $objectId . '_label">' . $recTitle . '</span>';
368
		$ctrl = $this->renderForeignRecordHeaderControl($parentUid, $foreign_table, $data, $config, $isVirtualRecord);
Christian Kuhn's avatar
Christian Kuhn committed
369
370
371
372
373
		$thumbnail = FALSE;

		// Renders a thumbnail for the header
		if (!empty($config['appearance']['headerThumbnail']['field'])) {
			$fieldValue = $rec[$config['appearance']['headerThumbnail']['field']];
374
			$firstElement = array_shift(GeneralUtility::trimExplode('|', array_shift(GeneralUtility::trimExplode(',', $fieldValue))));
Christian Kuhn's avatar
Christian Kuhn committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
			$fileUid = array_pop(BackendUtility::splitTable_Uid($firstElement));

			if (!empty($fileUid)) {
				$fileObject = ResourceFactory::getInstance()->getFileObject($fileUid);
				if ($fileObject && $fileObject->isMissing()) {
					$flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
					$thumbnail = $flashMessage->render();
				} elseif ($fileObject) {
					$imageSetup = $config['appearance']['headerThumbnail'];
					unset($imageSetup['field']);
					if (!empty($rec['crop'])) {
						$imageSetup['crop'] = $rec['crop'];
					}
					$imageSetup = array_merge(array('width' => '45', 'height' => '45c'), $imageSetup);
					$processedImage = $fileObject->process(ProcessedFile::CONTEXT_IMAGECROPSCALEMASK, $imageSetup);
					// Only use a thumbnail if the processing process was successful by checking if image width is set
					if ($processedImage->getProperty('width')) {
						$imageUrl = $processedImage->getPublicUrl(TRUE);
						$thumbnail = '<img src="' . $imageUrl . '" ' .
394
395
396
397
							'width="' . $processedImage->getProperty('width') . '" ' .
							'height="' . $processedImage->getProperty('height') . '" ' .
							'alt="' . htmlspecialchars($altText) . '" ' .
							'title="' . htmlspecialchars($altText) . '">';
Christian Kuhn's avatar
Christian Kuhn committed
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
					}
				}
			}
		}

		if (!empty($config['appearance']['headerThumbnail']['field']) && $thumbnail) {
			$mediaContainer = '<div class="form-irre-header-cell form-irre-header-thumbnail" id="' . $objectId . '_thumbnailcontainer">' . $thumbnail . '</div>';
		} else {
			$mediaContainer = '<div class="form-irre-header-cell form-irre-header-icon" id="' . $objectId . '_iconcontainer">' . $iconImg . '</div>';
		}
		$header = $mediaContainer . '
				<div class="form-irre-header-cell form-irre-header-body">' . $label . '</div>
				<div class="form-irre-header-cell form-irre-header-control t3js-formengine-irre-control">' . $ctrl . '</div>';

		return $header;
	}

	/**
	 * Render the control-icons for a record header (create new, sorting, delete, disable/enable).
	 * Most of the parts are copy&paste from TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList and
	 * modified for the JavaScript calls here
	 *
	 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
	 * @param string $foreign_table The table (foreign_table) we create control-icons for
422
	 * @param array $data Current data
Christian Kuhn's avatar
Christian Kuhn committed
423
424
425
426
	 * @param array $config (modified) TCA configuration of the field
	 * @param bool $isVirtualRecord TRUE if the current record is virtual, FALSE otherwise
	 * @return string The HTML code with the control-icons
	 */
427
428
	protected function renderForeignRecordHeaderControl($parentUid, $foreign_table, $data, $config = array(), $isVirtualRecord = FALSE) {
		$rec = $data['databaseRow'];
Christian Kuhn's avatar
Christian Kuhn committed
429
430
431
432
433
434
435
436
437
		$languageService = $this->getLanguageService();
		$backendUser = $this->getBackendUserAuthentication();
		// Initialize:
		$cells = array();
		$additionalCells = array();
		$isNewItem = substr($rec['uid'], 0, 3) == 'NEW';
		$isParentExisting = MathUtility::canBeInterpretedAsInteger($parentUid);
		$tcaTableCtrl = &$GLOBALS['TCA'][$foreign_table]['ctrl'];
		$tcaTableCols = &$GLOBALS['TCA'][$foreign_table]['columns'];
438
		$isPagesTable = $foreign_table === 'pages';
439
		$isSysFileReferenceTable = $foreign_table === 'sys_file_reference';
Christian Kuhn's avatar
Christian Kuhn committed
440
		$isOnSymmetricSide = RelationHandler::isOnSymmetricSide($parentUid, $config, $rec);
441
		$enableManualSorting = $tcaTableCtrl['sortby'] || $config['MM'] || !$isOnSymmetricSide && $config['foreign_sortby'] || $isOnSymmetricSide && $config['symmetric_sortby'];
442
		$nameObject = $this->inlineStackProcessor->getCurrentStructureDomObjectIdPrefix($this->data['inlineFirstPid']);
Christian Kuhn's avatar
Christian Kuhn committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
		$nameObjectFt = $nameObject . '-' . $foreign_table;
		$nameObjectFtId = $nameObjectFt . '-' . $rec['uid'];
		$calcPerms = $backendUser->calcPerms(BackendUtility::readPageAccess($rec['pid'], $backendUser->getPagePermsClause(1)));
		// If the listed table is 'pages' we have to request the permission settings for each page:
		$localCalcPerms = FALSE;
		if ($isPagesTable) {
			$localCalcPerms = $backendUser->calcPerms(BackendUtility::getRecord('pages', $rec['uid']));
		}
		// This expresses the edit permissions for this particular element:
		$permsEdit = $isPagesTable && $localCalcPerms & Permission::PAGE_EDIT || !$isPagesTable && $calcPerms & Permission::CONTENT_EDIT;
		// Controls: Defines which controls should be shown
		$enabledControls = $config['appearance']['enabledControls'];
		// Hook: Can disable/enable single controls for specific child records:
		foreach ($this->hookObjects as $hookObj) {
			/** @var InlineElementHookInterface $hookObj */
			$hookObj->renderForeignRecordHeaderControl_preProcess($parentUid, $foreign_table, $rec, $config, $isVirtualRecord, $enabledControls);
		}
460
		if ($data['inlineIsDefaultLanguage']) {
461
			$cells['localize.isLocalizable'] = '<span title="' . $languageService->sL('LLL:EXT:lang/locallang_misc.xlf:localize.isLocalizable', TRUE) . '">'
462
				. $this->iconFactory->getIcon('actions-edit-localize-status-low', Icon::SIZE_SMALL)->render()
463
				. '</span>';
464
		} elseif ($data['inlineIsDanglingLocalization']) {
465
			$cells['localize.wasRemovedInOriginal'] = '<span title="' . $languageService->sL('LLL:EXT:lang/locallang_misc.xlf:localize.wasRemovedInOriginal', TRUE) . '">'
466
				. $this->iconFactory->getIcon('actions-edit-localize-status-high', Icon::SIZE_SMALL)->render()
467
				. '</span>';
Christian Kuhn's avatar
Christian Kuhn committed
468
469
470
471
472
473
474
475
476
477
478
		}
		// "Info": (All records)
		if ($enabledControls['info'] && !$isNewItem) {
			if ($rec['table_local'] === 'sys_file') {
				$uid = (int)substr($rec['uid_local'], 9);
				$table = '_FILE';
			} else {
				$uid = $rec['uid'];
				$table = $foreign_table;
			}
			$cells['info'] = '
479
				<a class="btn btn-default" href="#" onclick="' . htmlspecialchars(('top.launchView(' . GeneralUtility::quoteJSvalue($table) . ', ' . GeneralUtility::quoteJSvalue($uid) . '); return false;')) . '" title="' . $languageService->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:showInfo', TRUE) . '">
480
					' . $this->iconFactory->getIcon('actions-document-info', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
481
482
483
484
485
486
487
488
489
490
491
492
493
				</a>';
		}
		// If the table is NOT a read-only table, then show these links:
		if (!$tcaTableCtrl['readOnly'] && !$isVirtualRecord) {
			// "New record after" link (ONLY if the records in the table are sorted by a "sortby"-row or if default values can depend on previous record):
			if ($enabledControls['new'] && ($enableManualSorting || $tcaTableCtrl['useColumnsForDefaultValues'])) {
				if (!$isPagesTable && $calcPerms & Permission::CONTENT_EDIT || $isPagesTable && $calcPerms & Permission::PAGE_NEW) {
					$onClick = 'return inline.createNewRecord(' . GeneralUtility::quoteJSvalue($nameObjectFt) . ',' . GeneralUtility::quoteJSvalue($rec['uid']) . ')';
					$style = '';
					if ($config['inline']['inlineNewButtonStyle']) {
						$style = ' style="' . $config['inline']['inlineNewButtonStyle'] . '"';
					}
					$cells['new'] = '
494
						<a class="btn btn-default inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'] . '" href="#" onclick="' . htmlspecialchars($onClick) . '" title="' . $languageService->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:new' . ($isPagesTable ? 'Page' : 'Record')), TRUE) . '" ' . $style . '>
495
							' . $this->iconFactory->getIcon('actions-' . ($isPagesTable ? 'page' : 'document') . '-new', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
496
497
498
499
500
501
						</a>';
				}
			}
			// "Up/Down" links
			if ($enabledControls['sort'] && $permsEdit && $enableManualSorting) {
				// Up
502
				$onClick = 'return inline.changeSorting(' . GeneralUtility::quoteJSvalue($nameObjectFtId) . ', \'1\')';
Christian Kuhn's avatar
Christian Kuhn committed
503
504
				$style = $config['inline']['first'] == $rec['uid'] ? 'style="visibility: hidden;"' : '';
				$cells['sort.up'] = '
505
					<a class="btn btn-default sortingUp" href="#" onclick="' . htmlspecialchars($onClick) . '" ' . $style . ' title="' . $languageService->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:moveUp', TRUE) . '">
506
						' . $this->iconFactory->getIcon('actions-move-up', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
507
508
					</a>';
				// Down
509
				$onClick = 'return inline.changeSorting(' . GeneralUtility::quoteJSvalue($nameObjectFtId) . ', \'-1\')';
Christian Kuhn's avatar
Christian Kuhn committed
510
511
				$style = $config['inline']['last'] == $rec['uid'] ? 'style="visibility: hidden;"' : '';
				$cells['sort.down'] = '
512
					<a class="btn btn-default sortingDown" href="#" onclick="' . htmlspecialchars($onClick) . '" ' . $style . ' title="' . $languageService->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:moveDown', TRUE) . '">
513
						' . $this->iconFactory->getIcon('actions-move-down', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
514
515
516
517
					</a>';
			}
			// "Edit" link:
			if (($rec['table_local'] === 'sys_file') && !$isNewItem) {
518
519
520
521
				$sys_language_uid = 0;
				if (!empty($rec['sys_language_uid'])) {
					$sys_language_uid = $rec['sys_language_uid'][0];
				}
Christian Kuhn's avatar
Christian Kuhn committed
522
523
524
				$recordInDatabase = $this->getDatabaseConnection()->exec_SELECTgetSingleRow(
					'uid',
					'sys_file_metadata',
525
					'file = ' . (int)substr($rec['uid_local'], 9) . ' AND sys_language_uid = ' . $sys_language_uid
Christian Kuhn's avatar
Christian Kuhn committed
526
527
528
529
530
531
532
				);
				if ($backendUser->check('tables_modify', 'sys_file_metadata')) {
					$url = BackendUtility::getModuleUrl('record_edit', array(
						'edit[sys_file_metadata][' . (int)$recordInDatabase['uid'] . ']' => 'edit'
					));
					$editOnClick = 'if (top.content.list_frame) {' .
						'top.content.list_frame.location.href=' .
533
534
						GeneralUtility::quoteJSvalue($url . '&returnUrl=') .
						'+top.rawurlencode(top.content.list_frame.document.location.pathname+top.content.list_frame.document.location.search)' .
Christian Kuhn's avatar
Christian Kuhn committed
535
536
537
538
539
						';' .
					'}';
					$title = $languageService->sL('LLL:EXT:lang/locallang_core.xlf:cm.editMetadata');
					$cells['editmetadata'] = '
						<a class="btn btn-default" href="#" class="btn" onclick="' . htmlspecialchars($editOnClick) . '" title="' . htmlspecialchars($title) . '">
540
							' . $this->iconFactory->getIcon('actions-document-open', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
541
542
543
544
						</a>';
				}
			}
			// "Delete" link:
545
546
			if ($enabledControls['delete'] && ($isPagesTable && $localCalcPerms & Permission::PAGE_DELETE
					|| !$isPagesTable && $calcPerms & Permission::CONTENT_EDIT
547
548
					|| $isSysFileReferenceTable && $calcPerms & Permission::PAGE_EDIT)
			) {
549
				$title = $languageService->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:delete', TRUE);
550
				$icon = $this->iconFactory->getIcon('actions-edit-delete', Icon::SIZE_SMALL)->render();
551
				$cells['delete'] = '<a href="#" class="btn btn-default t3js-editform-delete-inline-record" data-objectid="' . htmlspecialchars($nameObjectFtId) . '" title="' . $title . '">' . $icon . '</a>';
Christian Kuhn's avatar
Christian Kuhn committed
552
553
554
555
556
557
			}

			// "Hide/Unhide" links:
			$hiddenField = $tcaTableCtrl['enablecolumns']['disabled'];
			if ($enabledControls['hide'] && $permsEdit && $hiddenField && $tcaTableCols[$hiddenField] && (!$tcaTableCols[$hiddenField]['exclude'] || $backendUser->check('non_exclude_fields', $foreign_table . ':' . $hiddenField))) {
				$onClick = 'return inline.enableDisableRecord(' . GeneralUtility::quoteJSvalue($nameObjectFtId) . ')';
558
				$className = 't3js-' . $nameObjectFtId . '_disabled';
Christian Kuhn's avatar
Christian Kuhn committed
559
				if ($rec[$hiddenField]) {
560
					$title = $languageService->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:unHide' . ($isPagesTable ? 'Page' : '')), TRUE);
Christian Kuhn's avatar
Christian Kuhn committed
561
					$cells['hide.unhide'] = '
562
						<a class="btn btn-default hiddenHandle ' . $className . '" href="#" onclick="'
563
						. htmlspecialchars($onClick) . '"' . 'title="' . $title . '">' .
564
						$this->iconFactory->getIcon('actions-edit-unhide', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
565
566
						</a>';
				} else {
567
					$title = $languageService->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:hide' . ($isPagesTable ? 'Page' : '')), TRUE);
Christian Kuhn's avatar
Christian Kuhn committed
568
					$cells['hide.hide'] = '
569
						<a class="btn btn-default hiddenHandle ' . $className . '" href="#" onclick="'
570
						. htmlspecialchars($onClick) . '"' . 'title="' . $title . '">' .
571
						$this->iconFactory->getIcon('actions-edit-hide', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
572
573
574
575
576
577
						</a>';
				}
			}
			// Drag&Drop Sorting: Sortable handler for script.aculo.us
			if ($enabledControls['dragdrop'] && $permsEdit && $enableManualSorting && $config['appearance']['useSortable']) {
				$additionalCells['dragdrop'] = '
578
					<span class="btn btn-default sortableHandle" data-id="' . htmlspecialchars($rec['uid']) . '" title="' . $languageService->sL('LLL:EXT:lang/locallang_core.xlf:labels.move', TRUE) . '">
579
						' . $this->iconFactory->getIcon('actions-move-move', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
580
581
582
					</span>';
			}
		} elseif ($isVirtualRecord && $isParentExisting) {
583
			if ($enabledControls['localize'] && $data['inlineIsDefaultLanguage']) {
Christian Kuhn's avatar
Christian Kuhn committed
584
585
				$onClick = 'inline.synchronizeLocalizeRecords(' . GeneralUtility::quoteJSvalue($nameObjectFt) . ', ' . GeneralUtility::quoteJSvalue($rec['uid']) . ');';
				$cells['localize'] = '
586
					<a class="btn btn-default" href="#" onclick="' . htmlspecialchars($onClick) . 'title="' . $languageService->sL('LLL:EXT:lang/locallang_misc.xlf:localize', TRUE) . '">
587
						' . $this->iconFactory->getIcon('actions-document-localize', Icon::SIZE_SMALL)->render() . '
Christian Kuhn's avatar
Christian Kuhn committed
588
589
590
591
592
593
594
					</a>';
			}
		}
		// If the record is edit-locked by another user, we will show a little warning sign:
		if ($lockInfo = BackendUtility::isRecordLocked($foreign_table, $rec['uid'])) {
			$cells['locked'] = '
				<a class="btn btn-default" href="#" onclick="alert(' . GeneralUtility::quoteJSvalue($lockInfo['msg']) . ');return false;">
595
					' . '<span title="' . htmlspecialchars($lockInfo['msg']) . '">' . $this->iconFactory->getIcon('status-warning-in-use', Icon::SIZE_SMALL)->render() . '</span>' . '
Christian Kuhn's avatar
Christian Kuhn committed
596
597
598
599
600
601
602
				</a>';
		}
		// Hook: Post-processing of single controls for specific child records:
		foreach ($this->hookObjects as $hookObj) {
			$hookObj->renderForeignRecordHeaderControl_postProcess($parentUid, $foreign_table, $rec, $config, $isVirtualRecord, $cells);
		}

603
		$out = '';
Christian Kuhn's avatar
Christian Kuhn committed
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
		if (!empty($cells)) {
			$out .= ' <div class="btn-group btn-group-sm" role="group">' . implode('', $cells) . '</div>';
		}
		if (!empty($additionalCells)) {
			$out .= ' <div class="btn-group btn-group-sm" role="group">' . implode('', $additionalCells) . '</div>';
		}
		return $out;
	}

	/**
	 * Checks if a uid of a child table is in the inline view settings.
	 *
	 * @param string $table Name of the child table
	 * @param int $uid uid of the the child record
	 * @return bool TRUE=expand, FALSE=collapse
	 */
	protected function getExpandedCollapsedState($table, $uid) {
621
		$inlineView = $this->data['inlineExpandCollapseStateArray'];
Christian Kuhn's avatar
Christian Kuhn committed
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
		// @todo Add checking/cleaning for unused tables, records, etc. to save space in uc-field
		if (isset($inlineView[$table]) && is_array($inlineView[$table])) {
			if (in_array($uid, $inlineView[$table]) !== FALSE) {
				return TRUE;
			}
		}
		return FALSE;
	}

	/**
	 * Normalize a relation "uid" published by transferData, like "1|Company%201"
	 *
	 * @param string $string A transferData reference string, containing the uid
	 * @return string The normalized uid
	 */
	protected function normalizeUid($string) {
		$parts = explode('|', $string);
		return $parts[0];
	}

	/**
	 * Initialized the hook objects for this class.
	 * Each hook object has to implement the interface
	 * \TYPO3\CMS\Backend\Form\Element\InlineElementHookInterface
	 *
	 * @throws \UnexpectedValueException
	 * @return void
	 */
	protected function initHookObjects() {
		$this->hookObjects = array();
		if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tceforms_inline.php']['tceformsInlineHook'])) {
			$tceformsInlineHook = &$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tceforms_inline.php']['tceformsInlineHook'];
			if (is_array($tceformsInlineHook)) {
				foreach ($tceformsInlineHook as $classData) {
					$processObject = GeneralUtility::getUserObj($classData);
					if (!$processObject instanceof InlineElementHookInterface) {
						throw new \UnexpectedValueException('$processObject must implement interface ' . InlineElementHookInterface::class, 1202072000);
					}
					$this->hookObjects[] = $processObject;
				}
			}
		}
	}

	/**
	 * @return BackendUserAuthentication
	 */
	protected function getBackendUserAuthentication() {
		return $GLOBALS['BE_USER'];
	}

	/**
	 * @return DatabaseConnection
	 */
	protected function getDatabaseConnection() {
		return $GLOBALS['TYPO3_DB'];
	}

	/**
	 * @return LanguageService
	 */
	protected function getLanguageService() {
		return $GLOBALS['LANG'];
	}

}