[BUGFIX] Check folder access for inline uploader
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Form / Element / InlineElement.php
1 <?php
2 namespace TYPO3\CMS\Backend\Form\Element;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2006-2013 Oliver Hader <oliver@typo3.org>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the text file GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29
30 use TYPO3\CMS\Backend\Utility\BackendUtility;
31 use TYPO3\CMS\Backend\Utility\IconUtility;
32 use TYPO3\CMS\Core\Database\RelationHandler;
33 use TYPO3\CMS\Core\Utility\GeneralUtility;
34 use TYPO3\CMS\Core\Utility\MathUtility;
35
36 /**
37 * The Inline-Relational-Record-Editing (IRRE) functions as part of the TCEforms.
38 *
39 * @author Oliver Hader <oliver@typo3.org>
40 */
41 class InlineElement {
42
43 const Structure_Separator = '-';
44 const FlexForm_Separator = '---';
45 const FlexForm_Substitute = ':';
46 const Disposal_AttributeName = 'Disposal_AttributeName';
47 const Disposal_AttributeId = 'Disposal_AttributeId';
48 /**
49 * Reference to the calling TCEforms instance
50 *
51 * @var \TYPO3\CMS\Backend\Form\FormEngine
52 * @todo Define visibility
53 */
54 public $fObj;
55
56 // Reference to $fObj->backPath
57 /**
58 * @todo Define visibility
59 */
60 public $backPath;
61
62 // Indicates if a field is rendered upon an AJAX call
63 /**
64 * @todo Define visibility
65 */
66 public $isAjaxCall = FALSE;
67
68 // The structure/hierarchy where working in, e.g. cascading inline tables
69 /**
70 * @todo Define visibility
71 */
72 public $inlineStructure = array();
73
74 // The first call of an inline type appeared on this page (pid of record)
75 /**
76 * @todo Define visibility
77 */
78 public $inlineFirstPid;
79
80 // Keys: form, object -> hold the name/id for each of them
81 /**
82 * @todo Define visibility
83 */
84 public $inlineNames = array();
85
86 // Inline data array used for JSON output
87 /**
88 * @todo Define visibility
89 */
90 public $inlineData = array();
91
92 // Expanded/collapsed states for the current BE user
93 /**
94 * @todo Define visibility
95 */
96 public $inlineView = array();
97
98 // Count the number of inline types used
99 /**
100 * @todo Define visibility
101 */
102 public $inlineCount = 0;
103
104 /**
105 * @todo Define visibility
106 */
107 public $inlineStyles = array();
108
109 // How the $this->fObj->prependFormFieldNames should be set ('data' is default)
110 /**
111 * @todo Define visibility
112 */
113 public $prependNaming = 'data';
114
115 // Reference to $this->fObj->prependFormFieldNames
116 /**
117 * @todo Define visibility
118 */
119 public $prependFormFieldNames;
120
121 // Reference to $this->fObj->prependCmdFieldNames
122 /**
123 * @todo Define visibility
124 */
125 public $prependCmdFieldNames;
126
127 // Array containing instances of hook classes called once for IRRE objects
128 protected $hookObjects = array();
129
130 /**
131 * Initialize
132 *
133 * @param \TYPO3\CMS\Backend\Form\FormEngine $tceForms Reference to an TCEforms instance
134 * @return void
135 * @todo Define visibility
136 */
137 public function init(&$tceForms) {
138 $this->fObj = $tceForms;
139 $this->backPath = &$tceForms->backPath;
140 $this->prependFormFieldNames = &$this->fObj->prependFormFieldNames;
141 $this->prependCmdFieldNames = &$this->fObj->prependCmdFieldNames;
142 $this->inlineStyles['margin-right'] = '5';
143 $this->initHookObjects();
144 }
145
146 /**
147 * Initialized the hook objects for this class.
148 * Each hook object has to implement the interface
149 * \TYPO3\CMS\Backend\Form\Element\InlineElementHookInterface
150 *
151 * @return void
152 */
153 protected function initHookObjects() {
154 $this->hookObjects = array();
155 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tceforms_inline.php']['tceformsInlineHook'])) {
156 $tceformsInlineHook = &$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tceforms_inline.php']['tceformsInlineHook'];
157 if (is_array($tceformsInlineHook)) {
158 foreach ($tceformsInlineHook as $classData) {
159 $processObject = GeneralUtility::getUserObj($classData);
160 if (!$processObject instanceof \TYPO3\CMS\Backend\Form\Element\InlineElementHookInterface) {
161 throw new \UnexpectedValueException('$processObject must implement interface TYPO3\\CMS\\Backend\\Form\\Element\\InlineElementHookInterface', 1202072000);
162 }
163 $processObject->init($this);
164 $this->hookObjects[] = $processObject;
165 }
166 }
167 }
168 }
169
170 /**
171 * Generation of TCEform elements of the type "inline"
172 * This will render inline-relational-record sets. Relations.
173 *
174 * @param string $table The table name of the record
175 * @param string $field The field name which this element is supposed to edit
176 * @param array $row The record data array where the value(s) for the field can be found
177 * @param array $PA An array with additional configuration options.
178 * @return string The HTML code for the TCEform field
179 * @todo Define visibility
180 */
181 public function getSingleField_typeInline($table, $field, $row, &$PA) {
182 // Check the TCA configuration - if FALSE is returned, something was wrong
183 if ($this->checkConfiguration($PA['fieldConf']['config']) === FALSE) {
184 return FALSE;
185 }
186 $item = '';
187 // Count the number of processed inline elements
188 $this->inlineCount++;
189 // Init:
190 $config = $PA['fieldConf']['config'];
191 $foreign_table = $config['foreign_table'];
192 if (BackendUtility::isTableLocalizable($table)) {
193 $language = (int)$row[$GLOBALS['TCA'][$table]['ctrl']['languageField']];
194 }
195 $minitems = MathUtility::forceIntegerInRange($config['minitems'], 0);
196 $maxitems = MathUtility::forceIntegerInRange($config['maxitems'], 0);
197 if (!$maxitems) {
198 $maxitems = 100000;
199 }
200 // Register the required number of elements:
201 $this->fObj->requiredElements[$PA['itemFormElName']] = array($minitems, $maxitems, 'imgName' => $table . '_' . $row['uid'] . '_' . $field);
202 // Remember the page id (pid of record) where inline editing started first
203 // We need that pid for ajax calls, so that they would know where the action takes place on the page structure
204 if (!isset($this->inlineFirstPid)) {
205 // If this record is not new, try to fetch the inlineView states
206 // @TODO: Add checking/cleaning for unused tables, records, etc. to save space in uc-field
207 if (MathUtility::canBeInterpretedAsInteger($row['uid'])) {
208 $inlineView = unserialize($GLOBALS['BE_USER']->uc['inlineView']);
209 $this->inlineView = $inlineView[$table][$row['uid']];
210 }
211 // If the parent is a page, use the uid(!) of the (new?) page as pid for the child records:
212 if ($table == 'pages') {
213 $liveVersionId = BackendUtility::getLiveVersionIdOfRecord('pages', $row['uid']);
214 $this->inlineFirstPid = is_null($liveVersionId) ? $row['uid'] : $liveVersionId;
215 } elseif ($row['pid'] < 0) {
216 $prevRec = BackendUtility::getRecord($table, abs($row['pid']));
217 $this->inlineFirstPid = $prevRec['pid'];
218 } else {
219 $this->inlineFirstPid = $row['pid'];
220 }
221 }
222 // Add the current inline job to the structure stack
223 $this->pushStructure($table, $row['uid'], $field, $config, $PA);
224 // e.g. data[<table>][<uid>][<field>]
225 $nameForm = $this->inlineNames['form'];
226 // e.g. data-<pid>-<table1>-<uid1>-<field1>-<table2>-<uid2>-<field2>
227 $nameObject = $this->inlineNames['object'];
228 // Get the records related to this inline record
229 $relatedRecords = $this->getRelatedRecords($table, $field, $row, $PA, $config);
230 // Set the first and last record to the config array
231 $relatedRecordsUids = array_keys($relatedRecords['records']);
232 $config['inline']['first'] = reset($relatedRecordsUids);
233 $config['inline']['last'] = end($relatedRecordsUids);
234 // Tell the browser what we have (using JSON later):
235 $top = $this->getStructureLevel(0);
236 $this->inlineData['config'][$nameObject] = array(
237 'table' => $foreign_table,
238 'md5' => md5($nameObject)
239 );
240 $this->inlineData['config'][$nameObject . self::Structure_Separator . $foreign_table] = array(
241 'min' => $minitems,
242 'max' => $maxitems,
243 'sortable' => $config['appearance']['useSortable'],
244 'top' => array(
245 'table' => $top['table'],
246 'uid' => $top['uid']
247 ),
248 'context' => array(
249 'config' => $config,
250 'hmac' => GeneralUtility::hmac(serialize($config)),
251 ),
252 );
253 // Set a hint for nested IRRE and tab elements:
254 $this->inlineData['nested'][$nameObject] = $this->fObj->getDynNestedStack(FALSE, $this->isAjaxCall);
255 // If relations are required to be unique, get the uids that have already been used on the foreign side of the relation
256 if ($config['foreign_unique']) {
257 // If uniqueness *and* selector are set, they should point to the same field - so, get the configuration of one:
258 $selConfig = $this->getPossibleRecordsSelectorConfig($config, $config['foreign_unique']);
259 // Get the used unique ids:
260 $uniqueIds = $this->getUniqueIds($relatedRecords['records'], $config, $selConfig['type'] == 'groupdb');
261 $possibleRecords = $this->getPossibleRecords($table, $field, $row, $config, 'foreign_unique');
262 $uniqueMax = $config['appearance']['useCombination'] || $possibleRecords === FALSE ? -1 : count($possibleRecords);
263 $this->inlineData['unique'][$nameObject . self::Structure_Separator . $foreign_table] = array(
264 'max' => $uniqueMax,
265 'used' => $uniqueIds,
266 'type' => $selConfig['type'],
267 'table' => $config['foreign_table'],
268 'elTable' => $selConfig['table'],
269 // element/record table (one step down in hierarchy)
270 'field' => $config['foreign_unique'],
271 'selector' => $selConfig['selector'],
272 'possible' => $this->getPossibleRecordsFlat($possibleRecords)
273 );
274 }
275 // If it's required to select from possible child records (reusable children), add a selector box
276 if ($config['foreign_selector'] && $config['appearance']['showPossibleRecordsSelector'] !== FALSE) {
277 // If not already set by the foreign_unique, set the possibleRecords here and the uniqueIds to an empty array
278 if (!$config['foreign_unique']) {
279 $possibleRecords = $this->getPossibleRecords($table, $field, $row, $config);
280 $uniqueIds = array();
281 }
282 $selectorBox = $this->renderPossibleRecordsSelector($possibleRecords, $config, $uniqueIds);
283 $item .= $selectorBox;
284 }
285 // Wrap all inline fields of a record with a <div> (like a container)
286 $item .= '<div id="' . $nameObject . '">';
287 // Define how to show the "Create new record" link - if there are more than maxitems, hide it
288 if ($relatedRecords['count'] >= $maxitems || $uniqueMax > 0 && $relatedRecords['count'] >= $uniqueMax) {
289 $config['inline']['inlineNewButtonStyle'] = 'display: none;';
290 }
291 // Render the level links (create new record, localize all, synchronize):
292 if ($config['appearance']['levelLinksPosition'] != 'none') {
293 $levelLinks = $this->getLevelInteractionLink('newRecord', $nameObject . self::Structure_Separator . $foreign_table, $config);
294 if ($language > 0 && $row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] > 0) {
295 // Add the "Localize all records" link before all child records:
296 if (isset($config['appearance']['showAllLocalizationLink']) && $config['appearance']['showAllLocalizationLink']) {
297 $levelLinks .= ' ' . $this->getLevelInteractionLink('localize', $nameObject . self::Structure_Separator . $foreign_table, $config);
298 }
299 // Add the "Synchronize with default language" link before all child records:
300 if (isset($config['appearance']['showSynchronizationLink']) && $config['appearance']['showSynchronizationLink']) {
301 $levelLinks .= ' ' . $this->getLevelInteractionLink('synchronize', $nameObject . self::Structure_Separator . $foreign_table, $config);
302 }
303 }
304 }
305 // Add the level links before all child records:
306 if (in_array($config['appearance']['levelLinksPosition'], array('both', 'top'))) {
307 $item .= $levelLinks;
308 }
309 $item .= '<div id="' . $nameObject . '_records">';
310 $relationList = array();
311 if (count($relatedRecords['records'])) {
312 foreach ($relatedRecords['records'] as $rec) {
313 $item .= $this->renderForeignRecord($row['uid'], $rec, $config);
314 if (!isset($rec['__virtual']) || !$rec['__virtual']) {
315 $relationList[] = $rec['uid'];
316 }
317 }
318 }
319 $item .= '</div>';
320 // Add the level links after all child records:
321 if (in_array($config['appearance']['levelLinksPosition'], array('both', 'bottom'))) {
322 $item .= $levelLinks;
323 }
324 if (is_array($config['customControls'])) {
325 $item .= '<div id="' . $nameObject . '_customControls">';
326 foreach ($config['customControls'] as $customControlConfig) {
327 $parameters = array(
328 'table' => $table,
329 'field' => $field,
330 'row' => $row,
331 'nameObject' => $nameObject,
332 'nameForm' => $nameForm,
333 'config' => $config
334 );
335 $item .= GeneralUtility::callUserFunction($customControlConfig, $parameters, $this);
336 }
337 $item .= '</div>';
338 }
339 // Add Drag&Drop functions for sorting to TCEforms::$additionalJS_post
340 if (count($relationList) > 1 && $config['appearance']['useSortable']) {
341 $this->addJavaScriptSortable($nameObject . '_records');
342 }
343 // Publish the uids of the child records in the given order to the browser
344 $item .= '<input type="hidden" name="' . $nameForm . '" value="' . implode(',', $relationList) . '" class="inlineRecord" />';
345 // Close the wrap for all inline fields (container)
346 $item .= '</div>';
347 // On finishing this section, remove the last item from the structure stack
348 $this->popStructure();
349 // If this was the first call to the inline type, restore the values
350 if (!$this->getStructureDepth()) {
351 unset($this->inlineFirstPid);
352 }
353 return $item;
354 }
355
356 /*******************************************************
357 *
358 * Regular rendering of forms, fields, etc.
359 *
360 *******************************************************/
361 /**
362 * Render the form-fields of a related (foreign) record.
363 *
364 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
365 * @param array $rec The table record of the child/embedded table (normaly post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor)
366 * @param array $config Content of $PA['fieldConf']['config']
367 * @return string The HTML code for this "foreign record
368 * @todo Define visibility
369 */
370 public function renderForeignRecord($parentUid, $rec, $config = array()) {
371 $foreign_table = $config['foreign_table'];
372 $foreign_field = $config['foreign_field'];
373 $foreign_selector = $config['foreign_selector'];
374 // Register default localization content:
375 $parent = $this->getStructureLevel(-1);
376 if (isset($parent['localizationMode']) && $parent['localizationMode'] != FALSE) {
377 $this->fObj->registerDefaultLanguageData($foreign_table, $rec);
378 }
379 // Send a mapping information to the browser via JSON:
380 // e.g. data[<curTable>][<curId>][<curField>] => data-<pid>-<parentTable>-<parentId>-<parentField>-<curTable>-<curId>-<curField>
381 $this->inlineData['map'][$this->inlineNames['form']] = $this->inlineNames['object'];
382 // Set this variable if we handle a brand new unsaved record:
383 $isNewRecord = !MathUtility::canBeInterpretedAsInteger($rec['uid']);
384 // Set this variable if the record is virtual and only show with header and not editable fields:
385 $isVirtualRecord = isset($rec['__virtual']) && $rec['__virtual'];
386 // If there is a selector field, normalize it:
387 if ($foreign_selector) {
388 $rec[$foreign_selector] = $this->normalizeUid($rec[$foreign_selector]);
389 }
390 if (!$this->checkAccess(($isNewRecord ? 'new' : 'edit'), $foreign_table, $rec['uid'])) {
391 return FALSE;
392 }
393 // Get the current naming scheme for DOM name/id attributes:
394 $nameObject = $this->inlineNames['object'];
395 $appendFormFieldNames = '[' . $foreign_table . '][' . $rec['uid'] . ']';
396 $objectId = $nameObject . self::Structure_Separator . $foreign_table . self::Structure_Separator . $rec['uid'];
397 // Put the current level also to the dynNestedStack of TCEforms:
398 $this->fObj->pushToDynNestedStack('inline', $objectId);
399 $class = '';
400 if (!$isVirtualRecord) {
401 // Get configuration:
402 $collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
403 $expandAll = isset($config['appearance']['collapseAll']) && !$config['appearance']['collapseAll'];
404 $ajaxLoad = isset($config['appearance']['ajaxLoad']) && !$config['appearance']['ajaxLoad'] ? FALSE : TRUE;
405 if ($isNewRecord) {
406 // Show this record expanded or collapsed
407 $isExpanded = $expandAll || (!$collapseAll ? 1 : 0);
408 } else {
409 $isExpanded = $config['renderFieldsOnly'] || !$collapseAll && $this->getExpandedCollapsedState($foreign_table, $rec['uid']) || $expandAll;
410 }
411 // Render full content ONLY IF this is a AJAX-request, a new record, the record is not collapsed or AJAX-loading is explicitly turned off
412 if ($isNewRecord || $isExpanded || !$ajaxLoad) {
413 $combination = $this->renderCombinationTable($rec, $appendFormFieldNames, $config);
414 $overruleTypesArray = isset($config['foreign_types']) ? $config['foreign_types'] : array();
415 $fields = $this->renderMainFields($foreign_table, $rec, $overruleTypesArray);
416 $fields = $this->wrapFormsSection($fields);
417 // Replace returnUrl in Wizard-Code, if this is an AJAX call
418 $ajaxArguments = GeneralUtility::_GP('ajax');
419 if (isset($ajaxArguments[2]) && trim($ajaxArguments[2]) != '') {
420 $fields = str_replace('P[returnUrl]=%2F' . rawurlencode(TYPO3_mainDir) . 'ajax.php', 'P[returnUrl]=' . rawurlencode($ajaxArguments[2]), $fields);
421 }
422 } else {
423 $combination = '';
424 // This string is the marker for the JS-function to check if the full content has already been loaded
425 $fields = '<!--notloaded-->';
426 }
427 if ($isNewRecord) {
428 // Get the top parent table
429 $top = $this->getStructureLevel(0);
430 $ucFieldName = 'uc[inlineView][' . $top['table'] . '][' . $top['uid'] . ']' . $appendFormFieldNames;
431 // Set additional fields for processing for saving
432 $fields .= '<input type="hidden" name="' . $this->prependFormFieldNames . $appendFormFieldNames . '[pid]" value="' . $rec['pid'] . '"/>';
433 $fields .= '<input type="hidden" name="' . $ucFieldName . '" value="' . $isExpanded . '" />';
434 } else {
435 // Set additional field for processing for saving
436 $fields .= '<input type="hidden" name="' . $this->prependCmdFieldNames . $appendFormFieldNames . '[delete]" value="1" disabled="disabled" />';
437 if (!$isExpanded
438 && !empty($GLOBALS['TCA'][$foreign_table]['ctrl']['enablecolumns']['disabled'])
439 && $ajaxLoad
440 ) {
441 $checked = !empty($rec['hidden']) ? ' checked="checked"' : '';
442 $fields .= '<input type="checkbox" name="' . $this->prependFormFieldNames . $appendFormFieldNames . '[hidden]_0" value="1"' . $checked . ' />';
443 $fields .= '<input type="input" name="' . $this->prependFormFieldNames . $appendFormFieldNames . '[hidden]" value="' . $rec['hidden'] . '" />';
444 }
445 }
446 // If this record should be shown collapsed
447 if (!$isExpanded) {
448 $class = 't3-form-field-container-inline-collapsed';
449 }
450 }
451 if ($config['renderFieldsOnly']) {
452 $out = $fields . $combination;
453 } else {
454 // Set the record container with data for output
455 if ($isVirtualRecord) {
456 $class .= ' t3-form-field-container-inline-placeHolder';
457 }
458 if (isset($rec['hidden']) && (int)$rec['hidden']) {
459 $class .= ' t3-form-field-container-inline-hidden';
460 }
461 $out = '<div class="t3-form-field-record-inline" id="' . $objectId . '_fields" data-expandSingle="' . ($config['appearance']['expandSingle'] ? 1 : 0) . '" data-returnURL="' . htmlspecialchars(GeneralUtility::getIndpEnv('REQUEST_URI')) . '">' . $fields . $combination . '</div>';
462 $header = IconUtility::getSpriteIcon('apps-irre-' . ($class != '' ? 'collapsed' : 'expanded'));
463 $header .= $this->renderForeignRecordHeader($parentUid, $foreign_table, $rec, $config, $isVirtualRecord);
464 $out = '<div class="t3-form-field-header-inline" id="' . $objectId . '_header">' . $header . '</div>' . $out;
465 // Wrap the header, fields and combination part of a child record with a div container
466 $classMSIE = $this->fObj->clientInfo['BROWSER'] == 'msie' && $this->fObj->clientInfo['VERSION'] < 8 ? 'MSIE' : '';
467 $class .= ' inlineDiv' . $classMSIE . ($isNewRecord ? ' inlineIsNewRecord' : '');
468 $out = '<div id="' . $objectId . '_div" class="t3-form-field-container-inline ' . trim($class) . '">' . $out . '</div>';
469 }
470 // Remove the current level also from the dynNestedStack of TCEforms:
471 $this->fObj->popFromDynNestedStack();
472 return $out;
473 }
474
475 /**
476 * Wrapper for TCEforms::getMainFields().
477 *
478 * @param string $table The table name
479 * @param array $row The record to be rendered
480 * @param array $overruleTypesArray Overrule TCA [types] array, e.g to overrride [showitem] configuration of a particular type
481 * @return string The rendered form
482 */
483 protected function renderMainFields($table, array $row, array $overruleTypesArray = array()) {
484 // The current render depth of \TYPO3\CMS\Backend\Form\FormEngine
485 $depth = $this->fObj->renderDepth;
486 // If there is some information about already rendered palettes of our parent, store this info:
487 if (isset($this->fObj->palettesRendered[$depth][$table])) {
488 $palettesRendered = $this->fObj->palettesRendered[$depth][$table];
489 }
490 // Render the form:
491 $content = $this->fObj->getMainFields($table, $row, $depth, $overruleTypesArray);
492 // If there was some info about rendered palettes stored, write it back for our parent:
493 if (isset($palettesRendered)) {
494 $this->fObj->palettesRendered[$depth][$table] = $palettesRendered;
495 }
496 return $content;
497 }
498
499 /**
500 * Renders the HTML header for a foreign record, such as the title, toggle-function, drag'n'drop, etc.
501 * Later on the command-icons are inserted here.
502 *
503 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
504 * @param string $foreign_table The foreign_table we create a header for
505 * @param array $rec The current record of that foreign_table
506 * @param array $config content of $PA['fieldConf']['config']
507 * @param boolean $isVirtualRecord
508 * @return string The HTML code of the header
509 * @todo Define visibility
510 */
511 public function renderForeignRecordHeader($parentUid, $foreign_table, $rec, $config, $isVirtualRecord = FALSE) {
512 // Init:
513 $objectId = $this->inlineNames['object'] . self::Structure_Separator . $foreign_table . self::Structure_Separator . $rec['uid'];
514 // 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)
515 // Pre-Processing:
516 $isOnSymmetricSide = RelationHandler::isOnSymmetricSide($parentUid, $config, $rec);
517 $hasForeignLabel = !$isOnSymmetricSide && $config['foreign_label'] ? TRUE : FALSE;
518 $hasSymmetricLabel = $isOnSymmetricSide && $config['symmetric_label'] ? TRUE : FALSE;
519
520 // Get the record title/label for a record:
521 // Try using a self-defined user function only for formatted labels
522 if (isset($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc'])) {
523 $params = array(
524 'table' => $foreign_table,
525 'row' => $rec,
526 'title' => '',
527 'isOnSymmetricSide' => $isOnSymmetricSide,
528 'options' => isset($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc_options'])
529 ? $GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc_options']
530 : array(),
531 'parent' => array(
532 'uid' => $parentUid,
533 'config' => $config
534 )
535 );
536 // callUserFunction requires a third parameter, but we don't want to give $this as reference!
537 $null = NULL;
538 GeneralUtility::callUserFunction($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc'], $params, $null);
539 $recTitle = $params['title'];
540
541 // Try using a normal self-defined user function
542 } elseif (isset($GLOBALS['TCA'][$foreign_table]['ctrl']['label_userFunc'])) {
543 $params = array(
544 'table' => $foreign_table,
545 'row' => $rec,
546 'title' => '',
547 'isOnSymmetricSide' => $isOnSymmetricSide,
548 'parent' => array(
549 'uid' => $parentUid,
550 'config' => $config
551 )
552 );
553 // callUserFunction requires a third parameter, but we don't want to give $this as reference!
554 $null = NULL;
555 GeneralUtility::callUserFunction($GLOBALS['TCA'][$foreign_table]['ctrl']['label_userFunc'], $params, $null);
556 $recTitle = $params['title'];
557 } elseif ($hasForeignLabel || $hasSymmetricLabel) {
558 $titleCol = $hasForeignLabel ? $config['foreign_label'] : $config['symmetric_label'];
559 $foreignConfig = $this->getPossibleRecordsSelectorConfig($config, $titleCol);
560 // Render title for everything else than group/db:
561 if ($foreignConfig['type'] != 'groupdb') {
562 $recTitle = BackendUtility::getProcessedValueExtra($foreign_table, $titleCol, $rec[$titleCol], 0, 0, FALSE);
563 } else {
564 // $recTitle could be something like: "tx_table_123|...",
565 $valueParts = GeneralUtility::trimExplode('|', $rec[$titleCol]);
566 $itemParts = GeneralUtility::revExplode('_', $valueParts[0], 2);
567 $recTemp = BackendUtility::getRecordWSOL($itemParts[0], $itemParts[1]);
568 $recTitle = BackendUtility::getRecordTitle($itemParts[0], $recTemp, FALSE);
569 }
570 $recTitle = BackendUtility::getRecordTitlePrep($recTitle);
571 if (trim($recTitle) === '') {
572 $recTitle = BackendUtility::getNoRecordTitle(TRUE);
573 }
574 } else {
575 $recTitle = BackendUtility::getRecordTitle($foreign_table, $rec, TRUE);
576 }
577
578 $altText = BackendUtility::getRecordIconAltText($rec, $foreign_table);
579 $iconImg = IconUtility::getSpriteIconForRecord($foreign_table, $rec, array('title' => htmlspecialchars($altText), 'id' => $objectId . '_icon'));
580 $label = '<span id="' . $objectId . '_label">' . $recTitle . '</span>';
581 $ctrl = $this->renderForeignRecordHeaderControl($parentUid, $foreign_table, $rec, $config, $isVirtualRecord);
582 $thumbnail = FALSE;
583
584 // Renders a thumbnail for the header
585 if (!empty($config['appearance']['headerThumbnail']['field'])) {
586 $fieldValue = $rec[$config['appearance']['headerThumbnail']['field']];
587 $firstElement = array_shift(GeneralUtility::trimExplode(',', $fieldValue));
588 $fileUid = array_pop(BackendUtility::splitTable_Uid($firstElement));
589
590 if (!empty($fileUid)) {
591 $fileObject = \TYPO3\CMS\Core\Resource\ResourceFactory::getInstance()->getFileObject($fileUid);
592 if ($fileObject && $fileObject->isMissing()) {
593 $flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
594 $thumbnail = $flashMessage->render();
595 } elseif($fileObject) {
596 $imageSetup = $config['appearance']['headerThumbnail'];
597 unset($imageSetup['field']);
598 $imageSetup = array_merge(array('width' => '45', 'height' => '45c'), $imageSetup);
599 $imageUrl = $fileObject->process(\TYPO3\CMS\Core\Resource\ProcessedFile::CONTEXT_IMAGECROPSCALEMASK, $imageSetup)->getPublicUrl(TRUE);
600 $thumbnail = '<img class="t3-form-field-header-inline-thumbnail-image" src="' . $imageUrl . '" alt="' . htmlspecialchars($recTitle) . '">';
601 }
602 }
603 }
604
605 if (!empty($config['appearance']['headerThumbnail']['field']) && $thumbnail) {
606 $headerClasses = ' t3-form-field-header-inline-has-thumbnail';
607 $mediaContainer = '<div class="t3-form-field-header-inline-thumbnail" id="' . $objectId . '_thumbnailcontainer">' . $thumbnail . '</div>';
608 } else {
609 $headerClasses = ' t3-form-field-header-inline-has-icon';
610 $mediaContainer = '<div class="t3-form-field-header-inline-icon" id="' . $objectId . '_iconcontainer">' . $iconImg . '</div>';
611 }
612
613 $header = '<div class="t3-form-field-header-inline-wrap' . $headerClasses . '">'
614 . '<div class="t3-form-field-header-inline-ctrl">' . $ctrl . '</div>'
615 . '<div class="t3-form-field-header-inline-body">'
616 . $mediaContainer
617 . '<div class="t3-form-field-header-inline-summary">' . $label . '</div>'
618 . '</div>'
619 . '</div>';
620
621 return $header;
622 }
623
624 /**
625 * Render the control-icons for a record header (create new, sorting, delete, disable/enable).
626 * Most of the parts are copy&paste from TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList and
627 * modified for the JavaScript calls here
628 *
629 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
630 * @param string $foreign_table The table (foreign_table) we create control-icons for
631 * @param array $rec The current record of that foreign_table
632 * @param array $config (modified) TCA configuration of the field
633 * @return string The HTML code with the control-icons
634 * @todo Define visibility
635 */
636 public function renderForeignRecordHeaderControl($parentUid, $foreign_table, $rec, $config = array(), $isVirtualRecord = FALSE) {
637 // Initialize:
638 $cells = array();
639 $isNewItem = substr($rec['uid'], 0, 3) == 'NEW';
640 $tcaTableCtrl = &$GLOBALS['TCA'][$foreign_table]['ctrl'];
641 $tcaTableCols = &$GLOBALS['TCA'][$foreign_table]['columns'];
642 $isPagesTable = $foreign_table == 'pages' ? TRUE : FALSE;
643 $isOnSymmetricSide = RelationHandler::isOnSymmetricSide($parentUid, $config, $rec);
644 $enableManualSorting = $tcaTableCtrl['sortby'] || $config['MM'] || !$isOnSymmetricSide && $config['foreign_sortby'] || $isOnSymmetricSide && $config['symmetric_sortby'] ? TRUE : FALSE;
645 $nameObject = $this->inlineNames['object'];
646 $nameObjectFt = $nameObject . self::Structure_Separator . $foreign_table;
647 $nameObjectFtId = $nameObjectFt . self::Structure_Separator . $rec['uid'];
648 $calcPerms = $GLOBALS['BE_USER']->calcPerms(BackendUtility::readPageAccess($rec['pid'], $GLOBALS['BE_USER']->getPagePermsClause(1)));
649 // If the listed table is 'pages' we have to request the permission settings for each page:
650 if ($isPagesTable) {
651 $localCalcPerms = $GLOBALS['BE_USER']->calcPerms(BackendUtility::getRecord('pages', $rec['uid']));
652 }
653 // This expresses the edit permissions for this particular element:
654 $permsEdit = $isPagesTable && $localCalcPerms & 2 || !$isPagesTable && $calcPerms & 16;
655 // Controls: Defines which controls should be shown
656 $enabledControls = $config['appearance']['enabledControls'];
657 // Hook: Can disable/enable single controls for specific child records:
658 foreach ($this->hookObjects as $hookObj) {
659 $hookObj->renderForeignRecordHeaderControl_preProcess($parentUid, $foreign_table, $rec, $config, $isVirtualRecord, $enabledControls);
660 }
661 // Icon to visualize that a required field is nested in this inline level:
662 $cells['required'] = '<img name="' . $nameObjectFtId . '_req" src="clear.gif" width="10" height="10" hspace="4" vspace="3" alt="" />';
663 if (isset($rec['__create'])) {
664 $cells['localize.isLocalizable'] = IconUtility::getSpriteIcon('actions-edit-localize-status-low', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localize.isLocalizable', TRUE)));
665 } elseif (isset($rec['__remove'])) {
666 $cells['localize.wasRemovedInOriginal'] = IconUtility::getSpriteIcon('actions-edit-localize-status-high', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localize.wasRemovedInOriginal', TRUE)));
667 }
668 // "Info": (All records)
669 if ($enabledControls['info'] && !$isNewItem) {
670 $cells['info'] = '<a href="#" onclick="' . htmlspecialchars(('top.launchView(\'' . $foreign_table . '\', \'' . $rec['uid'] . '\'); return false;')) . '">' . IconUtility::getSpriteIcon('status-dialog-information', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:showInfo', TRUE))) . '</a>';
671 }
672 // If the table is NOT a read-only table, then show these links:
673 if (!$tcaTableCtrl['readOnly'] && !$isVirtualRecord) {
674 // "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):
675 if ($enabledControls['new'] && ($enableManualSorting || $tcaTableCtrl['useColumnsForDefaultValues'])) {
676 if (!$isPagesTable && $calcPerms & 16 || $isPagesTable && $calcPerms & 8) {
677 $onClick = 'return inline.createNewRecord(\'' . $nameObjectFt . '\',\'' . $rec['uid'] . '\')';
678 $class = ' class="inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'] . '"';
679 if ($config['inline']['inlineNewButtonStyle']) {
680 $style = ' style="' . $config['inline']['inlineNewButtonStyle'] . '"';
681 }
682 $cells['new'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '"' . $class . $style . '>' . IconUtility::getSpriteIcon(('actions-' . ($isPagesTable ? 'page' : 'document') . '-new'), array(
683 'title' => $GLOBALS['LANG']->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:new' . ($isPagesTable ? 'Page' : 'Record')), TRUE)
684 )) . '</a>';
685 }
686 }
687 // "Up/Down" links
688 if ($enabledControls['sort'] && $permsEdit && $enableManualSorting) {
689 $onClick = 'return inline.changeSorting(\'' . $nameObjectFtId . '\', \'1\')';
690 // Up
691 $style = $config['inline']['first'] == $rec['uid'] ? 'style="visibility: hidden;"' : '';
692 $cells['sort.up'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '" class="sortingUp" ' . $style . '>' . IconUtility::getSpriteIcon('actions-move-up', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:moveUp', TRUE))) . '</a>';
693 $onClick = 'return inline.changeSorting(\'' . $nameObjectFtId . '\', \'-1\')';
694 // Down
695 $style = $config['inline']['last'] == $rec['uid'] ? 'style="visibility: hidden;"' : '';
696 $cells['sort.down'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '" class="sortingDown" ' . $style . '>' . IconUtility::getSpriteIcon('actions-move-down', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:moveDown', TRUE))) . '</a>';
697 }
698 // "Delete" link:
699 if ($enabledControls['delete'] && ($isPagesTable && $localCalcPerms & 4 || !$isPagesTable && $calcPerms & 16)) {
700 $onClick = 'inline.deleteRecord(\'' . $nameObjectFtId . '\');';
701 $cells['delete'] = '<a href="#" onclick="' . htmlspecialchars(('if (confirm(' . $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->getLL('deleteWarning')) . ')) { ' . $onClick . ' } return false;')) . '">' . IconUtility::getSpriteIcon('actions-edit-delete', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:delete', TRUE))) . '</a>';
702 }
703
704 // "Hide/Unhide" links:
705 $hiddenField = $tcaTableCtrl['enablecolumns']['disabled'];
706 if ($enabledControls['hide'] && $permsEdit && $hiddenField && $tcaTableCols[$hiddenField] && (!$tcaTableCols[$hiddenField]['exclude'] || $GLOBALS['BE_USER']->check('non_exclude_fields', $foreign_table . ':' . $hiddenField))) {
707 $onClick = 'return inline.enableDisableRecord(\'' . $nameObjectFtId . '\')';
708 if ($rec[$hiddenField]) {
709 $cells['hide.unhide'] = '<a href="#" class="hiddenHandle" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-edit-unhide', array(
710 'title' => $GLOBALS['LANG']->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:unHide' . ($isPagesTable ? 'Page' : '')), TRUE),
711 'id' => ($nameObjectFtId . '_disabled')
712 )) . '</a>';
713 } else {
714 $cells['hide.hide'] = '<a href="#" class="hiddenHandle" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-edit-hide', array(
715 'title' => $GLOBALS['LANG']->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:hide' . ($isPagesTable ? 'Page' : '')), TRUE),
716 'id' => ($nameObjectFtId . '_disabled')
717 )) . '</a>';
718 }
719 }
720 // Drag&Drop Sorting: Sortable handler for script.aculo.us
721 if ($enabledControls['dragdrop'] && $permsEdit && $enableManualSorting && $config['appearance']['useSortable']) {
722 $cells['dragdrop'] = IconUtility::getSpriteIcon('actions-move-move', array('data-id' => $rec['uid'], 'class' => 'sortableHandle', 'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.move', TRUE)));
723 }
724 } elseif ($isVirtualRecord) {
725 if ($enabledControls['localize'] && isset($rec['__create'])) {
726 $onClick = 'inline.synchronizeLocalizeRecords(\'' . $nameObjectFt . '\', ' . $rec['uid'] . ');';
727 $cells['localize'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-document-localize', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localize', TRUE))) . '</a>';
728 }
729 }
730 // If the record is edit-locked by another user, we will show a little warning sign:
731 if ($lockInfo = BackendUtility::isRecordLocked($foreign_table, $rec['uid'])) {
732 $cells['locked'] = '<a href="#" onclick="' . htmlspecialchars(('alert(' . $GLOBALS['LANG']->JScharCode($lockInfo['msg']) . ');return false;')) . '">' . IconUtility::getSpriteIcon('status-warning-in-use', array('title' => htmlspecialchars($lockInfo['msg']))) . '</a>';
733 }
734 // Hook: Post-processing of single controls for specific child records:
735 foreach ($this->hookObjects as $hookObj) {
736 $hookObj->renderForeignRecordHeaderControl_postProcess($parentUid, $foreign_table, $rec, $config, $isVirtualRecord, $cells);
737 }
738 return '<!-- CONTROL PANEL: ' . $foreign_table . ':' . $rec['uid'] . ' -->' . implode('', $cells);
739 }
740
741 /**
742 * Render a table with TCEforms, that occurs on a intermediate table but should be editable directly,
743 * so two tables are combined (the intermediate table with attributes and the sub-embedded table).
744 * -> This is a direct embedding over two levels!
745 *
746 * @param array $rec The table record of the child/embedded table (normaly post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor)
747 * @param string $appendFormFieldNames The [<table>][<uid>] of the parent record (the intermediate table)
748 * @param array $config content of $PA['fieldConf']['config']
749 * @return string A HTML string with <table> tag around.
750 * @todo Define visibility
751 */
752 public function renderCombinationTable(&$rec, $appendFormFieldNames, $config = array()) {
753 $foreign_table = $config['foreign_table'];
754 $foreign_selector = $config['foreign_selector'];
755 if ($foreign_selector && $config['appearance']['useCombination']) {
756 $comboConfig = $GLOBALS['TCA'][$foreign_table]['columns'][$foreign_selector]['config'];
757 $comboRecord = array();
758 // If record does already exist, load it:
759 if ($rec[$foreign_selector] && MathUtility::canBeInterpretedAsInteger($rec[$foreign_selector])) {
760 $comboRecord = $this->getRecord($this->inlineFirstPid, $comboConfig['foreign_table'], $rec[$foreign_selector]);
761 $isNewRecord = FALSE;
762 } else {
763 $comboRecord = $this->getNewRecord($this->inlineFirstPid, $comboConfig['foreign_table']);
764 $isNewRecord = TRUE;
765 }
766 // Get the TCEforms interpretation of the TCA of the child table
767 $out = $this->renderMainFields($comboConfig['foreign_table'], $comboRecord);
768 $out = $this->wrapFormsSection($out, array(), array('class' => 'wrapperAttention'));
769 // If this is a new record, add a pid value to store this record and the pointer value for the intermediate table
770 if ($isNewRecord) {
771 $comboFormFieldName = $this->prependFormFieldNames . '[' . $comboConfig['foreign_table'] . '][' . $comboRecord['uid'] . '][pid]';
772 $out .= '<input type="hidden" name="' . $comboFormFieldName . '" value="' . $comboRecord['pid'] . '" />';
773 }
774 // If the foreign_selector field is also responsible for uniqueness, tell the browser the uid of the "other" side of the relation
775 if ($isNewRecord || $config['foreign_unique'] == $foreign_selector) {
776 $parentFormFieldName = $this->prependFormFieldNames . $appendFormFieldNames . '[' . $foreign_selector . ']';
777 $out .= '<input type="hidden" name="' . $parentFormFieldName . '" value="' . $comboRecord['uid'] . '" />';
778 }
779 }
780 return $out;
781 }
782
783 /**
784 * Get a selector as used for the select type, to select from all available
785 * records and to create a relation to the embedding record (e.g. like MM).
786 *
787 * @param array $selItems Array of all possible records
788 * @param array $conf TCA configuration of the parent(!) field
789 * @param array $uniqueIds The uids that have already been used and should be unique
790 * @return string A HTML <select> box with all possible records
791 * @todo Define visibility
792 */
793 public function renderPossibleRecordsSelector($selItems, $conf, $uniqueIds = array()) {
794 $foreign_table = $conf['foreign_table'];
795 $foreign_selector = $conf['foreign_selector'];
796 $selConfig = $this->getPossibleRecordsSelectorConfig($conf, $foreign_selector);
797 $config = $selConfig['PA']['fieldConf']['config'];
798 if ($selConfig['type'] == 'select') {
799 $item = $this->renderPossibleRecordsSelectorTypeSelect($selItems, $conf, $selConfig['PA'], $uniqueIds);
800 } elseif ($selConfig['type'] == 'groupdb') {
801 $item = $this->renderPossibleRecordsSelectorTypeGroupDB($conf, $selConfig['PA']);
802 }
803 return $item;
804 }
805
806 /**
807 * Get a selector as used for the select type, to select from all available
808 * records and to create a relation to the embedding record (e.g. like MM).
809 *
810 * @param array $selItems Array of all possible records
811 * @param array $conf TCA configuration of the parent(!) field
812 * @param array $PA An array with additional configuration options
813 * @param array $uniqueIds The uids that have already been used and should be unique
814 * @return string A HTML <select> box with all possible records
815 * @todo Define visibility
816 */
817 public function renderPossibleRecordsSelectorTypeSelect($selItems, $conf, &$PA, $uniqueIds = array()) {
818 $foreign_table = $conf['foreign_table'];
819 $foreign_selector = $conf['foreign_selector'];
820 $PA = array();
821 $PA['fieldConf'] = $GLOBALS['TCA'][$foreign_table]['columns'][$foreign_selector];
822 $PA['fieldConf']['config']['form_type'] = $PA['fieldConf']['config']['form_type'] ?: $PA['fieldConf']['config']['type'];
823 // Using "form_type" locally in this script
824 $PA['fieldTSConfig'] = $this->fObj->setTSconfig($foreign_table, array(), $foreign_selector);
825 $config = $PA['fieldConf']['config'];
826 //TODO: $disabled is not present - should be read from config?
827 $disabled = FALSE;
828 if (!$disabled) {
829 // Create option tags:
830 $opt = array();
831 $styleAttrValue = '';
832 foreach ($selItems as $p) {
833 if ($config['iconsInOptionTags']) {
834 $styleAttrValue = $this->fObj->optionTagStyle($p[2]);
835 }
836 if (!in_array($p[1], $uniqueIds)) {
837 $opt[] = '<option value="' . htmlspecialchars($p[1]) . '"' . ' style="' . (in_array($p[1], $uniqueIds) ? '' : '') . ($styleAttrValue ? ' style="' . htmlspecialchars($styleAttrValue) : '') . '">' . htmlspecialchars($p[0]) . '</option>';
838 }
839 }
840 // Put together the selector box:
841 $selector_itemListStyle = isset($config['itemListStyle']) ? ' style="' . htmlspecialchars($config['itemListStyle']) . '"' : ' style="' . $this->fObj->defaultMultipleSelectorStyle . '"';
842 $size = (int)$conf['size'];
843 $size = $conf['autoSizeMax'] ? MathUtility::forceIntegerInRange(count($selItems) + 1, MathUtility::forceIntegerInRange($size, 1), $conf['autoSizeMax']) : $size;
844 $onChange = 'return inline.importNewRecord(\'' . $this->inlineNames['object'] . self::Structure_Separator . $conf['foreign_table'] . '\')';
845 $item = '
846 <select id="' . $this->inlineNames['object'] . self::Structure_Separator . $conf['foreign_table'] . '_selector"' . $this->fObj->insertDefStyle('select') . ($size ? ' size="' . $size . '"' : '') . ' onchange="' . htmlspecialchars($onChange) . '"' . $PA['onFocus'] . $selector_itemListStyle . ($conf['foreign_unique'] ? ' isunique="isunique"' : '') . '>
847 ' . implode('
848 ', $opt) . '
849 </select>';
850 // Add a "Create new relation" link for adding new relations
851 // This is neccessary, if the size of the selector is "1" or if
852 // there is only one record item in the select-box, that is selected by default
853 // The selector-box creates a new relation on using a onChange event (see some line above)
854 if (!empty($conf['appearance']['createNewRelationLinkTitle'])) {
855 $createNewRelationText = $GLOBALS['LANG']->sL($conf['appearance']['createNewRelationLinkTitle'], TRUE);
856 } else {
857 $createNewRelationText = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createNewRelation', TRUE);
858 }
859 $item .= ' <a href="#" class="t3-button" onclick="' . htmlspecialchars($onChange) . '" align="abstop">' . IconUtility::getSpriteIcon('actions-document-new', array('title' => $createNewRelationText)) . $createNewRelationText . '</a>';
860 $item = '<div class="t3-form-field-group">' . $item . '</div>';
861 }
862 return $item;
863 }
864
865 /**
866 * Generate a link that opens an element browser in a new window.
867 * For group/db there is no way to use a "selector" like a <select>|</select>-box.
868 *
869 * @param array $conf TCA configuration of the parent(!) field
870 * @param array $PA An array with additional configuration options
871 * @return string A HTML link that opens an element browser in a new window
872 * @todo Define visibility
873 */
874 public function renderPossibleRecordsSelectorTypeGroupDB($conf, &$PA) {
875 $foreign_table = $conf['foreign_table'];
876 $config = $PA['fieldConf']['config'];
877 $allowed = $config['allowed'];
878 $objectPrefix = $this->inlineNames['object'] . self::Structure_Separator . $foreign_table;
879 $mode = 'db';
880 $showUpload = FALSE;
881 if (!empty($conf['appearance']['createNewRelationLinkTitle'])) {
882 $createNewRelationText = $GLOBALS['LANG']->sL($conf['appearance']['createNewRelationLinkTitle'], TRUE);
883 } else {
884 $createNewRelationText = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createNewRelation', TRUE);
885 }
886 if (is_array($config['appearance'])) {
887 if (isset($config['appearance']['elementBrowserType'])) {
888 $mode = $config['appearance']['elementBrowserType'];
889 }
890 if ($mode === 'file') {
891 $showUpload = TRUE;
892 }
893 if (isset($config['appearance']['fileUploadAllowed'])) {
894 $showUpload = (bool)$config['appearance']['fileUploadAllowed'];
895 }
896 if (isset($config['appearance']['elementBrowserAllowed'])) {
897 $allowed = $config['appearance']['elementBrowserAllowed'];
898 }
899 }
900 $browserParams = '|||' . $allowed . '|' . $objectPrefix . '|inline.checkUniqueElement||inline.importElement';
901 $onClick = 'setFormValueOpenBrowser(\'' . $mode . '\', \'' . $browserParams . '\'); return false;';
902
903 $item = '<a href="#" class="t3-button" onclick="' . htmlspecialchars($onClick) . '">';
904 $item .= IconUtility::getSpriteIcon('actions-insert-record', array('title' => $createNewRelationText));
905 $item .= $createNewRelationText . '</a>';
906
907 if ($showUpload && $this->fObj->edit_docModuleUpload) {
908 $folder = $GLOBALS['BE_USER']->getDefaultUploadFolder();
909 if (
910 $folder instanceof \TYPO3\CMS\Core\Resource\Folder
911 && $folder->checkActionPermission('add')
912 ) {
913 $maxFileSize = GeneralUtility::getMaxUploadFileSize() * 1024;
914 $item .= ' <a href="#" class="t3-button t3-drag-uploader"
915 style="display:none"
916 data-dropzone-target="#' . htmlspecialchars($this->inlineNames['object']) . '"
917 data-insert-dropzone-before="1"
918 data-file-irre-object="' . htmlspecialchars($objectPrefix) . '"
919 data-file-allowed="' . htmlspecialchars($allowed) . '"
920 data-target-folder="' . htmlspecialchars($folder->getCombinedIdentifier()) . '"
921 data-max-file-size="' . htmlspecialchars($maxFileSize) . '"
922 ><span class="t3-icon t3-icon-actions t3-icon-actions-edit t3-icon-edit-upload">&nbsp;</span>';
923 $item .= $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:file_upload.select-and-submit', TRUE);
924 $item .= '</a>';
925
926 $this->loadDragUploadJs();
927 }
928 }
929 return $item;
930 }
931
932 /**
933 * Load the required javascript for the DragUploader
934 */
935 protected function loadDragUploadJs() {
936
937 /** @var $pageRenderer \TYPO3\CMS\Core\Page\PageRenderer */
938 $pageRenderer = $GLOBALS['SOBE']->doc->getPageRenderer();
939 $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/FileListLocalisation');
940 $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/DragUploader');
941 $pageRenderer->addInlineLanguagelabelFile(
942 \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('lang') . 'locallang_core.xlf',
943 'file_upload'
944 );
945 }
946
947 /**
948 * Creates the HTML code of a general link to be used on a level of inline children.
949 * The possible keys for the parameter $type are 'newRecord', 'localize' and 'synchronize'.
950 *
951 * @param string $type The link type, values are 'newRecord', 'localize' and 'synchronize'.
952 * @param string $objectPrefix The "path" to the child record to create (e.g. 'data-parentPageId-partenTable-parentUid-parentField-childTable]')
953 * @param array $conf TCA configuration of the parent(!) field
954 * @return string The HTML code of the new link, wrapped in a div
955 */
956 protected function getLevelInteractionLink($type, $objectPrefix, $conf = array()) {
957 $nameObject = $this->inlineNames['object'];
958 $attributes = array();
959 switch ($type) {
960 case 'newRecord':
961 $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createnew', TRUE);
962 $icon = 'actions-document-new';
963 $className = 'typo3-newRecordLink';
964 $attributes['class'] = 't3-button inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'];
965 $attributes['onclick'] = 'return inline.createNewRecord(\'' . $objectPrefix . '\')';
966 if (!empty($conf['inline']['inlineNewButtonStyle'])) {
967 $attributes['style'] = $conf['inline']['inlineNewButtonStyle'];
968 }
969 if (!empty($conf['appearance']['newRecordLinkAddTitle'])) {
970 $title = sprintf(
971 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createnew.link', TRUE),
972 $GLOBALS['LANG']->sL($GLOBALS['TCA'][$conf['foreign_table']]['ctrl']['title'], TRUE)
973 );
974 } elseif (isset($conf['appearance']['newRecordLinkTitle']) && $conf['appearance']['newRecordLinkTitle'] !== '') {
975 $title = $GLOBALS['LANG']->sL($conf['appearance']['newRecordLinkTitle'], TRUE);
976 }
977 break;
978 case 'localize':
979 $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localizeAllRecords', 1);
980 $icon = 'actions-document-localize';
981 $className = 'typo3-localizationLink';
982 $attributes['class'] = 't3-button';
983 $attributes['onclick'] = 'return inline.synchronizeLocalizeRecords(\'' . $objectPrefix . '\', \'localize\')';
984 break;
985 case 'synchronize':
986 $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:synchronizeWithOriginalLanguage', TRUE);
987 $icon = 'actions-document-synchronize';
988 $className = 'typo3-synchronizationLink';
989 $attributes['class'] = 't3-button inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'];
990 $attributes['onclick'] = 'return inline.synchronizeLocalizeRecords(\'' . $objectPrefix . '\', \'synchronize\')';
991 break;
992 default:
993 $title = '';
994 $icon = '';
995 $className = '';
996 }
997 // Create the link:
998 $icon = $icon ? IconUtility::getSpriteIcon($icon, array('title' => htmlspecialchars($title))) : '';
999 $link = $this->wrapWithAnchor($icon . $title, '#', $attributes);
1000 return '<div' . ($className ? ' class="' . $className . '"' : '') . '>' . $link . '</div>';
1001 }
1002
1003 /**
1004 * Add Sortable functionality using script.acolo.us "Sortable".
1005 *
1006 * @param string $objectId The container id of the object - elements inside will be sortable
1007 * @return void
1008 * @todo Define visibility
1009 */
1010 public function addJavaScriptSortable($objectId) {
1011 $this->fObj->additionalJS_post[] = '
1012 inline.createDragAndDropSorting("' . $objectId . '");
1013 ';
1014 }
1015
1016 /*******************************************************
1017 *
1018 * Handling of AJAX calls
1019 *
1020 *******************************************************/
1021 /**
1022 * General processor for AJAX requests concerning IRRE.
1023 * (called by typo3/ajax.php)
1024 *
1025 * @param array $params Additional parameters (not used here)
1026 * @param \TYPO3\CMS\Core\Http\AjaxRequestHandler $ajaxObj The AjaxRequestHandler object of this request
1027 * @return void
1028 */
1029 public function processAjaxRequest($params, $ajaxObj) {
1030 $ajaxArguments = GeneralUtility::_GP('ajax');
1031 $ajaxIdParts = explode('::', $GLOBALS['ajaxID'], 2);
1032 if (isset($ajaxArguments) && is_array($ajaxArguments) && count($ajaxArguments)) {
1033 $ajaxMethod = $ajaxIdParts[1];
1034 switch ($ajaxMethod) {
1035 case 'createNewRecord':
1036
1037 case 'synchronizeLocalizeRecords':
1038
1039 case 'getRecordDetails':
1040 $this->isAjaxCall = TRUE;
1041 // Construct runtime environment for Inline Relational Record Editing:
1042 $this->processAjaxRequestConstruct($ajaxArguments);
1043 // Parse the DOM identifier (string), add the levels to the structure stack (array) and load the TCA config:
1044 $this->parseStructureString($ajaxArguments[0], TRUE);
1045 $this->injectAjaxConfiguration($ajaxArguments);
1046 // Render content:
1047 $ajaxObj->setContentFormat('jsonbody');
1048 $ajaxObj->setContent(call_user_func_array(array(&$this, $ajaxMethod), $ajaxArguments));
1049 break;
1050 case 'setExpandedCollapsedState':
1051 $ajaxObj->setContentFormat('jsonbody');
1052 call_user_func_array(array(&$this, $ajaxMethod), $ajaxArguments);
1053 break;
1054 }
1055 }
1056 }
1057
1058 /**
1059 * Injects configuration via AJAX calls.
1060 * The configuration is validated using HMAC to avoid hijacking.
1061 *
1062 * @param array $ajaxArguments
1063 * @return void
1064 */
1065 protected function injectAjaxConfiguration(array $ajaxArguments) {
1066 $level = $this->calculateStructureLevel(-1);
1067
1068 if (empty($ajaxArguments['context']) || $level === FALSE) {
1069 return;
1070 }
1071
1072 $current = &$this->inlineStructure['stable'][$level];
1073 $context = json_decode($ajaxArguments['context'], TRUE);
1074
1075 if (GeneralUtility::hmac(serialize($context['config'])) !== $context['hmac']) {
1076 return;
1077 }
1078
1079 $current['config'] = $context['config'];
1080 $current['localizationMode'] = BackendUtility::getInlineLocalizationMode(
1081 $current['table'],
1082 $current['config']
1083 );
1084 }
1085
1086 /**
1087 * Construct runtime environment for Inline Relational Record Editing.
1088 * - creates an anoymous SC_alt_doc in $GLOBALS['SOBE']
1089 * - creates a \TYPO3\CMS\Backend\Form\FormEngine in $GLOBALS['SOBE']->tceforms
1090 * - sets ourself as reference to $GLOBALS['SOBE']->tceforms->inline
1091 * - sets $GLOBALS['SOBE']->tceforms->RTEcounter to the current situation on client-side
1092 *
1093 * @param array &$ajaxArguments The arguments to be processed by the AJAX request
1094 * @return void
1095 */
1096 protected function processAjaxRequestConstruct(&$ajaxArguments) {
1097 $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_alt_doc.xlf');
1098 // Create a new anonymous object:
1099 $GLOBALS['SOBE'] = new \stdClass();
1100 $GLOBALS['SOBE']->MOD_MENU = array(
1101 'showPalettes' => '',
1102 'showDescriptions' => '',
1103 'disableRTE' => ''
1104 );
1105 // Setting virtual document name
1106 $GLOBALS['SOBE']->MCONF['name'] = 'xMOD_alt_doc.php';
1107 // CLEANSE SETTINGS
1108 $GLOBALS['SOBE']->MOD_SETTINGS = BackendUtility::getModuleData($GLOBALS['SOBE']->MOD_MENU, GeneralUtility::_GP('SET'), $GLOBALS['SOBE']->MCONF['name']);
1109 // Create an instance of the document template object
1110 $GLOBALS['SOBE']->doc = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Template\\DocumentTemplate');
1111 $GLOBALS['SOBE']->doc->backPath = $GLOBALS['BACK_PATH'];
1112 // Initialize TCEforms (rendering the forms)
1113 $GLOBALS['SOBE']->tceforms = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Form\\FormEngine');
1114 $GLOBALS['SOBE']->tceforms->inline = $this;
1115 $GLOBALS['SOBE']->tceforms->RTEcounter = (int)array_shift($ajaxArguments);
1116 $GLOBALS['SOBE']->tceforms->initDefaultBEMode();
1117 $GLOBALS['SOBE']->tceforms->palettesCollapsed = !$GLOBALS['SOBE']->MOD_SETTINGS['showPalettes'];
1118 $GLOBALS['SOBE']->tceforms->disableRTE = $GLOBALS['SOBE']->MOD_SETTINGS['disableRTE'];
1119 $GLOBALS['SOBE']->tceforms->enableClickMenu = TRUE;
1120 $GLOBALS['SOBE']->tceforms->enableTabMenu = TRUE;
1121 // Clipboard is initialized:
1122 // Start clipboard
1123 $GLOBALS['SOBE']->tceforms->clipObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Clipboard\\Clipboard');
1124 // Initialize - reads the clipboard content from the user session
1125 $GLOBALS['SOBE']->tceforms->clipObj->initializeClipboard();
1126 }
1127
1128 /**
1129 * Determines and sets several script calls to a JSON array, that would have been executed if processed in non-AJAX mode.
1130 *
1131 * @param array &$jsonArray Reference of the array to be used for JSON
1132 * @param array $config The configuration of the IRRE field of the parent record
1133 * @return void
1134 */
1135 protected function getCommonScriptCalls(&$jsonArray, $config) {
1136 // Add data that would have been added at the top of a regular TCEforms call:
1137 if ($headTags = $this->getHeadTags()) {
1138 $jsonArray['headData'] = $headTags;
1139 }
1140 // Add the JavaScript data that would have been added at the bottom of a regular TCEforms call:
1141 $jsonArray['scriptCall'][] = $this->fObj->JSbottom($this->fObj->formName, TRUE);
1142 // If script.aculo.us Sortable is used, update the Observer to know the record:
1143 if ($config['appearance']['useSortable']) {
1144 $jsonArray['scriptCall'][] = 'inline.createDragAndDropSorting(\'' . $this->inlineNames['object'] . '_records\');';
1145 }
1146 // if TCEforms has some JavaScript code to be executed, just do it
1147 if ($this->fObj->extJSCODE) {
1148 $jsonArray['scriptCall'][] = $this->fObj->extJSCODE;
1149 }
1150 }
1151
1152 /**
1153 * Generates an error message that transferred as JSON for AJAX calls
1154 *
1155 * @param string $message The error message to be shown
1156 * @return array The error message in a JSON array
1157 */
1158 protected function getErrorMessageForAJAX($message) {
1159 $jsonArray = array(
1160 'data' => $message,
1161 'scriptCall' => array(
1162 'alert("' . $message . '");'
1163 )
1164 );
1165 return $jsonArray;
1166 }
1167
1168 /**
1169 * Handle AJAX calls to show a new inline-record of the given table.
1170 * Normally this method is never called from inside TYPO3. Always from outside by AJAX.
1171 *
1172 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1173 * @param string $foreignUid If set, the new record should be inserted after that one.
1174 * @return array An array to be used for JSON
1175 * @todo Define visibility
1176 */
1177 public function createNewRecord($domObjectId, $foreignUid = 0) {
1178 // The current table - for this table we should add/import records
1179 $current = $this->inlineStructure['unstable'];
1180 // The parent table - this table embeds the current table
1181 $parent = $this->getStructureLevel(-1);
1182 $config = $parent['config'];
1183 // Get TCA 'config' of the parent table
1184 if (!$this->checkConfiguration($config)) {
1185 return $this->getErrorMessageForAJAX('Wrong configuration in table ' . $parent['table']);
1186 }
1187 $collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
1188 $expandSingle = isset($config['appearance']['expandSingle']) && $config['appearance']['expandSingle'];
1189 // Put the current level also to the dynNestedStack of TCEforms:
1190 $this->fObj->pushToDynNestedStack('inline', $this->inlineNames['object']);
1191 // Dynamically create a new record using \TYPO3\CMS\Backend\Form\DataPreprocessor
1192 if (!$foreignUid || !MathUtility::canBeInterpretedAsInteger($foreignUid) || $config['foreign_selector']) {
1193 $record = $this->getNewRecord($this->inlineFirstPid, $current['table']);
1194 // Set default values for new created records
1195 if (isset($config['foreign_record_defaults']) && is_array($config['foreign_record_defaults'])) {
1196 $foreignTableConfig = $GLOBALS['TCA'][$current['table']];
1197 // the following system relevant fields can't be set by foreign_record_defaults
1198 $notSettableFields = array(
1199 'uid', 'pid', 't3ver_oid', 't3ver_id', 't3ver_label', 't3ver_wsid', 't3ver_state', 't3ver_stage',
1200 't3ver_count', 't3ver_tstamp', 't3ver_move_id'
1201 );
1202 $configurationKeysForNotSettableFields = array(
1203 'crdate', 'cruser_id', 'delete', 'origUid', 'transOrigDiffSourceField', 'transOrigPointerField',
1204 'tstamp'
1205 );
1206 foreach ($configurationKeysForNotSettableFields as $configurationKey) {
1207 if (isset($foreignTableConfig['ctrl'][$configurationKey])) {
1208 $notSettableFields[] = $foreignTableConfig['ctrl'][$configurationKey];
1209 }
1210 }
1211 foreach ($config['foreign_record_defaults'] as $fieldName => $defaultValue) {
1212 if (isset($foreignTableConfig['columns'][$fieldName]) && !in_array($fieldName, $notSettableFields)) {
1213 $record[$fieldName] = $defaultValue;
1214 }
1215 }
1216 }
1217 // Set language of new child record to the language of the parent record:
1218 if ($config['localizationMode'] == 'select') {
1219 $parentRecord = $this->getRecord(0, $parent['table'], $parent['uid']);
1220 $parentLanguageField = $GLOBALS['TCA'][$parent['table']]['ctrl']['languageField'];
1221 $childLanguageField = $GLOBALS['TCA'][$current['table']]['ctrl']['languageField'];
1222 if ($parentRecord[$parentLanguageField] > 0) {
1223 $record[$childLanguageField] = $parentRecord[$parentLanguageField];
1224 }
1225 }
1226 } else {
1227 $record = $this->getRecord($this->inlineFirstPid, $current['table'], $foreignUid);
1228 }
1229 // Now there is a foreign_selector, so there is a new record on the intermediate table, but
1230 // this intermediate table holds a field, which is responsible for the foreign_selector, so
1231 // we have to set this field to the uid we get - or if none, to a new uid
1232 if ($config['foreign_selector'] && $foreignUid) {
1233 $selConfig = $this->getPossibleRecordsSelectorConfig($config, $config['foreign_selector']);
1234 // For a selector of type group/db, prepend the tablename (<tablename>_<uid>):
1235 $record[$config['foreign_selector']] = $selConfig['type'] != 'groupdb' ? '' : $selConfig['table'] . '_';
1236 $record[$config['foreign_selector']] .= $foreignUid;
1237 }
1238 // The HTML-object-id's prefix of the dynamically created record
1239 $objectPrefix = $this->inlineNames['object'] . self::Structure_Separator . $current['table'];
1240 $objectId = $objectPrefix . self::Structure_Separator . $record['uid'];
1241 // Render the foreign record that should passed back to browser
1242 $item = $this->renderForeignRecord($parent['uid'], $record, $config);
1243 if ($item === FALSE) {
1244 return $this->getErrorMessageForAJAX('Access denied');
1245 }
1246 if (!$current['uid']) {
1247 $jsonArray = array(
1248 'data' => $item,
1249 'scriptCall' => array(
1250 'inline.domAddNewRecord(\'bottom\',\'' . $this->inlineNames['object'] . '_records\',\'' . $objectPrefix . '\',json.data);',
1251 'inline.memorizeAddRecord(\'' . $objectPrefix . '\',\'' . $record['uid'] . '\',null,\'' . $foreignUid . '\');'
1252 )
1253 );
1254 } else {
1255 $jsonArray = array(
1256 'data' => $item,
1257 'scriptCall' => array(
1258 'inline.domAddNewRecord(\'after\',\'' . $domObjectId . '_div' . '\',\'' . $objectPrefix . '\',json.data);',
1259 'inline.memorizeAddRecord(\'' . $objectPrefix . '\',\'' . $record['uid'] . '\',\'' . $current['uid'] . '\',\'' . $foreignUid . '\');'
1260 )
1261 );
1262 }
1263 $this->getCommonScriptCalls($jsonArray, $config);
1264 // Collapse all other records if requested:
1265 if (!$collapseAll && $expandSingle) {
1266 $jsonArray['scriptCall'][] = 'inline.collapseAllRecords(\'' . $objectId . '\', \'' . $objectPrefix . '\', \'' . $record['uid'] . '\');';
1267 }
1268 // Tell the browser to scroll to the newly created record
1269 $jsonArray['scriptCall'][] = 'Element.scrollTo(\'' . $objectId . '_div\');';
1270 // Fade out and fade in the new record in the browser view to catch the user's eye
1271 $jsonArray['scriptCall'][] = 'inline.fadeOutFadeIn(\'' . $objectId . '_div\');';
1272 // Remove the current level also from the dynNestedStack of TCEforms:
1273 $this->fObj->popFromDynNestedStack();
1274 // Return the JSON array:
1275 return $jsonArray;
1276 }
1277
1278 /**
1279 * Handle AJAX calls to localize all records of a parent, localize a single record or to synchronize with the original language parent.
1280 *
1281 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1282 * @param mixed $type Defines the type 'localize' or 'synchronize' (string) or a single uid to be localized (integer)
1283 * @return array An array to be used for JSON
1284 */
1285 protected function synchronizeLocalizeRecords($domObjectId, $type) {
1286 $jsonArray = FALSE;
1287 if (GeneralUtility::inList('localize,synchronize', $type) || MathUtility::canBeInterpretedAsInteger($type)) {
1288 // The current level:
1289 $current = $this->inlineStructure['unstable'];
1290 // The parent level:
1291 $parent = $this->getStructureLevel(-1);
1292 $parentRecord = $this->getRecord(0, $parent['table'], $parent['uid']);
1293 $cmd = array();
1294 $cmd[$parent['table']][$parent['uid']]['inlineLocalizeSynchronize'] = $parent['field'] . ',' . $type;
1295 /** @var $tce \TYPO3\CMS\Core\DataHandling\DataHandler */
1296 $tce = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\DataHandling\\DataHandler');
1297 $tce->stripslashes_values = FALSE;
1298 $tce->start(array(), $cmd);
1299 $tce->process_cmdmap();
1300 $newItemList = $tce->registerDBList[$parent['table']][$parent['uid']][$parent['field']];
1301 unset($tce);
1302 $jsonArray = $this->getExecuteChangesJsonArray($parentRecord[$parent['field']], $newItemList);
1303 $this->getCommonScriptCalls($jsonArray, $parent['config']);
1304 }
1305 return $jsonArray;
1306 }
1307
1308 /**
1309 * Handle AJAX calls to dynamically load the form fields of a given record.
1310 * (basically a copy of "createNewRecord")
1311 * Normally this method is never called from inside TYPO3. Always from outside by AJAX.
1312 *
1313 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1314 * @return array An array to be used for JSON
1315 * @todo Define visibility
1316 */
1317 public function getRecordDetails($domObjectId) {
1318 // The current table - for this table we should add/import records
1319 $current = $this->inlineStructure['unstable'];
1320 // The parent table - this table embeds the current table
1321 $parent = $this->getStructureLevel(-1);
1322 // Get TCA 'config' of the parent table
1323 if (!$this->checkConfiguration($parent['config'])) {
1324 return $this->getErrorMessageForAJAX('Wrong configuration in table ' . $parent['table']);
1325 }
1326 $config = $parent['config'];
1327 // Set flag in config so that only the fields are rendered
1328 $config['renderFieldsOnly'] = TRUE;
1329 $collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
1330 $expandSingle = isset($config['appearance']['expandSingle']) && $config['appearance']['expandSingle'];
1331 // Put the current level also to the dynNestedStack of TCEforms:
1332 $this->fObj->pushToDynNestedStack('inline', $this->inlineNames['object']);
1333 $record = $this->getRecord($this->inlineFirstPid, $current['table'], $current['uid']);
1334 // The HTML-object-id's prefix of the dynamically created record
1335 $objectPrefix = $this->inlineNames['object'] . self::Structure_Separator . $current['table'];
1336 $objectId = $objectPrefix . self::Structure_Separator . $record['uid'];
1337 $item = $this->renderForeignRecord($parent['uid'], $record, $config);
1338 if ($item === FALSE) {
1339 return $this->getErrorMessageForAJAX('Access denied');
1340 }
1341 $jsonArray = array(
1342 'data' => $item,
1343 'scriptCall' => array(
1344 'inline.domAddRecordDetails(\'' . $domObjectId . '\',\'' . $objectPrefix . '\',' . ($expandSingle ? '1' : '0') . ',json.data);'
1345 )
1346 );
1347 if ($config['foreign_unique']) {
1348 $jsonArray['scriptCall'][] = 'inline.removeUsed(\'' . $objectPrefix . '\',\'' . $record['uid'] . '\');';
1349 }
1350 $this->getCommonScriptCalls($jsonArray, $config);
1351 // Collapse all other records if requested:
1352 if (!$collapseAll && $expandSingle) {
1353 $jsonArray['scriptCall'][] = 'inline.collapseAllRecords(\'' . $objectId . '\',\'' . $objectPrefix . '\',\'' . $record['uid'] . '\');';
1354 }
1355 // Remove the current level also from the dynNestedStack of TCEforms:
1356 $this->fObj->popFromDynNestedStack();
1357 // Return the JSON array:
1358 return $jsonArray;
1359 }
1360
1361 /**
1362 * Generates a JSON array which executes the changes and thus updates the forms view.
1363 *
1364 * @param string $oldItemList List of related child reocrds before changes were made (old)
1365 * @param string $newItemList List of related child records after changes where made (new)
1366 * @return array An array to be used for JSON
1367 */
1368 protected function getExecuteChangesJsonArray($oldItemList, $newItemList) {
1369 $data = '';
1370 $parent = $this->getStructureLevel(-1);
1371 $current = $this->inlineStructure['unstable'];
1372 $jsonArray = array('scriptCall' => array());
1373 $jsonArrayScriptCall = &$jsonArray['scriptCall'];
1374 $nameObject = $this->inlineNames['object'];
1375 $nameObjectForeignTable = $nameObject . self::Structure_Separator . $current['table'];
1376 // Get the name of the field pointing to the original record:
1377 $transOrigPointerField = $GLOBALS['TCA'][$current['table']]['ctrl']['transOrigPointerField'];
1378 // Get the name of the field used as foreign selector (if any):
1379 $foreignSelector = isset($parent['config']['foreign_selector']) && $parent['config']['foreign_selector'] ? $parent['config']['foreign_selector'] : FALSE;
1380 // Convert lists to array with uids of child records:
1381 $oldItems = $this->getRelatedRecordsUidArray($oldItemList);
1382 $newItems = $this->getRelatedRecordsUidArray($newItemList);
1383 // Determine the items that were localized or localized:
1384 $removedItems = array_diff($oldItems, $newItems);
1385 $localizedItems = array_diff($newItems, $oldItems);
1386 // Set the items that should be removed in the forms view:
1387 foreach ($removedItems as $item) {
1388 $jsonArrayScriptCall[] = 'inline.deleteRecord(\'' . $nameObjectForeignTable . self::Structure_Separator . $item . '\', {forceDirectRemoval: true});';
1389 }
1390 // Set the items that should be added in the forms view:
1391 foreach ($localizedItems as $item) {
1392 $row = $this->getRecord($this->inlineFirstPid, $current['table'], $item);
1393 $selectedValue = $foreignSelector ? '\'' . $row[$foreignSelector] . '\'' : 'null';
1394 $data .= $this->renderForeignRecord($parent['uid'], $row, $parent['config']);
1395 $jsonArrayScriptCall[] = 'inline.memorizeAddRecord(\'' . $nameObjectForeignTable . '\', \'' . $item . '\', null, ' . $selectedValue . ');';
1396 // Remove possible virtual records in the form which showed that a child records could be localized:
1397 if (isset($row[$transOrigPointerField]) && $row[$transOrigPointerField]) {
1398 $jsonArrayScriptCall[] = 'inline.fadeAndRemove(\'' . $nameObjectForeignTable . self::Structure_Separator . $row[$transOrigPointerField] . '_div' . '\');';
1399 }
1400 }
1401 if ($data) {
1402 $jsonArray['data'] = $data;
1403 array_unshift($jsonArrayScriptCall, 'inline.domAddNewRecord(\'bottom\', \'' . $nameObject . '_records\', \'' . $nameObjectForeignTable . '\', json.data);');
1404 }
1405 return $jsonArray;
1406 }
1407
1408 /**
1409 * Save the expanded/collapsed state of a child record in the BE_USER->uc.
1410 *
1411 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1412 * @param string $expand Whether this record is expanded.
1413 * @param string $collapse Whether this record is collapsed.
1414 * @return void
1415 * @todo Define visibility
1416 */
1417 public function setExpandedCollapsedState($domObjectId, $expand, $collapse) {
1418 // Parse the DOM identifier (string), add the levels to the structure stack (array), but don't load TCA config
1419 $this->parseStructureString($domObjectId, FALSE);
1420 // The current table - for this table we should add/import records
1421 $current = $this->inlineStructure['unstable'];
1422 // The top parent table - this table embeds the current table
1423 $top = $this->getStructureLevel(0);
1424 // Only do some action if the top record and the current record were saved before
1425 if (MathUtility::canBeInterpretedAsInteger($top['uid'])) {
1426 $inlineView = (array) unserialize($GLOBALS['BE_USER']->uc['inlineView']);
1427 $inlineViewCurrent = &$inlineView[$top['table']][$top['uid']];
1428 $expandUids = GeneralUtility::trimExplode(',', $expand);
1429 $collapseUids = GeneralUtility::trimExplode(',', $collapse);
1430 // Set records to be expanded
1431 foreach ($expandUids as $uid) {
1432 $inlineViewCurrent[$current['table']][] = $uid;
1433 }
1434 // Set records to be collapsed
1435 foreach ($collapseUids as $uid) {
1436 $inlineViewCurrent[$current['table']] = $this->removeFromArray($uid, $inlineViewCurrent[$current['table']]);
1437 }
1438 // Save states back to database
1439 if (is_array($inlineViewCurrent[$current['table']])) {
1440 $inlineViewCurrent[$current['table']] = array_unique($inlineViewCurrent[$current['table']]);
1441 $GLOBALS['BE_USER']->uc['inlineView'] = serialize($inlineView);
1442 $GLOBALS['BE_USER']->writeUC();
1443 }
1444 }
1445 }
1446
1447 /*******************************************************
1448 *
1449 * Get data from database and handle relations
1450 *
1451 *******************************************************/
1452 /**
1453 * Get the related records of the embedding item, this could be 1:n, m:n.
1454 * Returns an associative array with the keys records and count. 'count' contains only real existing records on the current parent record.
1455 *
1456 * @param string $table The table name of the record
1457 * @param string $field The field name which this element is supposed to edit
1458 * @param array $row The record data array where the value(s) for the field can be found
1459 * @param array $PA An array with additional configuration options.
1460 * @param array $config (Redundant) content of $PA['fieldConf']['config'] (for convenience)
1461 * @return array The records related to the parent item as associative array.
1462 * @todo Define visibility
1463 */
1464 public function getRelatedRecords($table, $field, $row, &$PA, $config) {
1465 $pid = $row['pid'];
1466 $elements = $PA['itemFormElValue'];
1467 $foreignTable = $config['foreign_table'];
1468 $localizationMode = BackendUtility::getInlineLocalizationMode($table, $config);
1469 if ($localizationMode != FALSE) {
1470 $language = (int)$row[$GLOBALS['TCA'][$table]['ctrl']['languageField']];
1471 $transOrigPointer = (int)$row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']];
1472 $transOrigTable = BackendUtility::getOriginalTranslationTable($table);
1473
1474 if ($language > 0 && $transOrigPointer) {
1475 // Localization in mode 'keep', isn't a real localization, but keeps the children of the original parent record:
1476 if ($localizationMode == 'keep') {
1477 $transOrigRec = $this->getRecord(0, $transOrigTable, $transOrigPointer);
1478 $elements = $transOrigRec[$field];
1479 $pid = $transOrigRec['pid'];
1480 } elseif ($localizationMode == 'select') {
1481 $transOrigRec = $this->getRecord(0, $transOrigTable, $transOrigPointer);
1482 $pid = $transOrigRec['pid'];
1483 $recordsOriginal = $this->getRelatedRecordsArray($pid, $foreignTable, $transOrigRec[$field]);
1484 }
1485 }
1486 }
1487 $records = $this->getRelatedRecordsArray($pid, $foreignTable, $elements);
1488 $relatedRecords = array('records' => $records, 'count' => count($records));
1489 // Merge original language with current localization and show differences:
1490 if (is_array($recordsOriginal)) {
1491 $options = array(
1492 'showPossible' => isset($config['appearance']['showPossibleLocalizationRecords']) && $config['appearance']['showPossibleLocalizationRecords'],
1493 'showRemoved' => isset($config['appearance']['showRemovedLocalizationRecords']) && $config['appearance']['showRemovedLocalizationRecords']
1494 );
1495 if ($options['showPossible'] || $options['showRemoved']) {
1496 $relatedRecords['records'] = $this->getLocalizationDifferences($foreignTable, $options, $recordsOriginal, $records);
1497 }
1498 }
1499 return $relatedRecords;
1500 }
1501
1502 /**
1503 * Gets the related records of the embedding item, this could be 1:n, m:n.
1504 *
1505 * @param integer $pid The pid of the parent record
1506 * @param string $table The table name of the record
1507 * @param string $itemList The list of related child records
1508 * @return array The records related to the parent item
1509 */
1510 protected function getRelatedRecordsArray($pid, $table, $itemList) {
1511 $records = array();
1512 $itemArray = $this->getRelatedRecordsUidArray($itemList);
1513 // Perform modification of the selected items array:
1514 foreach ($itemArray as $uid) {
1515 // Get the records for this uid using \TYPO3\CMS\Backend\Form\DataPreprocessor
1516 if ($record = $this->getRecord($pid, $table, $uid)) {
1517 $records[$uid] = $record;
1518 }
1519 }
1520 return $records;
1521 }
1522
1523 /**
1524 * Gets an array with the uids of related records out of a list of items.
1525 * This list could contain more information than required. This methods just
1526 * extracts the uids.
1527 *
1528 * @param string $itemList The list of related child records
1529 * @return array An array with uids
1530 */
1531 protected function getRelatedRecordsUidArray($itemList) {
1532 $itemArray = GeneralUtility::trimExplode(',', $itemList, TRUE);
1533 // Perform modification of the selected items array:
1534 foreach ($itemArray as $key => &$value) {
1535 $parts = explode('|', $value, 2);
1536 $value = $parts[0];
1537 }
1538 unset($value);
1539 return $itemArray;
1540 }
1541
1542 /**
1543 * Gets the difference between current localized structure and the original language structure.
1544 * If there are records which once were localized but don't exist in the original version anymore, the record row is marked with '__remove'.
1545 * If there are records which can be localized and exist only in the original version, the record row is marked with '__create' and '__virtual'.
1546 *
1547 * @param string $table The table name of the parent records
1548 * @param array $options Options defining what kind of records to display
1549 * @param array $recordsOriginal The uids of the child records of the original language
1550 * @param array $recordsLocalization The uids of the child records of the current localization
1551 * @return array Merged array of uids of the child records of both versions
1552 */
1553 protected function getLocalizationDifferences($table, array $options, array $recordsOriginal, array $recordsLocalization) {
1554 $records = array();
1555 $transOrigPointerField = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'];
1556 // Compare original to localized version of the records:
1557 foreach ($recordsLocalization as $uid => $row) {
1558 // If the record points to a original translation which doesn't exist anymore, it could be removed:
1559 if (isset($row[$transOrigPointerField]) && $row[$transOrigPointerField] > 0) {
1560 $transOrigPointer = $row[$transOrigPointerField];
1561 if (isset($recordsOriginal[$transOrigPointer])) {
1562 unset($recordsOriginal[$transOrigPointer]);
1563 } elseif ($options['showRemoved']) {
1564 $row['__remove'] = TRUE;
1565 }
1566 }
1567 $records[$uid] = $row;
1568 }
1569 // Process the remaining records in the original unlocalized parent:
1570 if ($options['showPossible']) {
1571 foreach ($recordsOriginal as $uid => $row) {
1572 $row['__create'] = TRUE;
1573 $row['__virtual'] = TRUE;
1574 $records[$uid] = $row;
1575 }
1576 }
1577 return $records;
1578 }
1579
1580 /**
1581 * Get possible records.
1582 * Copied from TCEform and modified.
1583 *
1584 * @param string $table The table name of the record
1585 * @param string $field The field name which this element is supposed to edit
1586 * @param array $row The record data array where the value(s) for the field can be found
1587 * @param array $conf An array with additional configuration options.
1588 * @param string $checkForConfField For which field in the foreign_table the possible records should be fetched
1589 * @return mixed Array of possible record items; FALSE if type is "group/db", then everything could be "possible
1590 * @todo Define visibility
1591 */
1592 public function getPossibleRecords($table, $field, $row, $conf, $checkForConfField = 'foreign_selector') {
1593 // ctrl configuration from TCA:
1594 $tcaTableCtrl = $GLOBALS['TCA'][$table]['ctrl'];
1595 // Field configuration from TCA:
1596 $foreign_table = $conf['foreign_table'];
1597 $foreign_check = $conf[$checkForConfField];
1598 $foreignConfig = $this->getPossibleRecordsSelectorConfig($conf, $foreign_check);
1599 $PA = $foreignConfig['PA'];
1600 $config = $PA['fieldConf']['config'];
1601 if ($foreignConfig['type'] == 'select') {
1602 // Getting the selector box items from the system
1603 $selItems = $this->fObj->addSelectOptionsToItemArray($this->fObj->initItemArray($PA['fieldConf']), $PA['fieldConf'], $this->fObj->setTSconfig($table, $row), $field);
1604
1605 // Possibly filter some items:
1606 $selItems = GeneralUtility::keepItemsInArray(
1607 $selItems,
1608 $PA['fieldTSConfig']['keepItems'],
1609 function ($value) {
1610 return $value[1];
1611 }
1612 );
1613
1614 // Possibly add some items:
1615 $selItems = $this->fObj->addItems($selItems, $PA['fieldTSConfig']['addItems.']);
1616 if (isset($config['itemsProcFunc']) && $config['itemsProcFunc']) {
1617 $selItems = $this->fObj->procItems($selItems, $PA['fieldTSConfig']['itemsProcFunc.'], $config, $table, $row, $field);
1618 }
1619 // Possibly remove some items:
1620 $removeItems = GeneralUtility::trimExplode(',', $PA['fieldTSConfig']['removeItems'], TRUE);
1621 foreach ($selItems as $tk => $p) {
1622 // Checking languages and authMode:
1623 $languageDeny = $tcaTableCtrl['languageField'] && (string)$tcaTableCtrl['languageField'] === $field && !$GLOBALS['BE_USER']->checkLanguageAccess($p[1]);
1624 $authModeDeny = $config['form_type'] == 'select' && $config['authMode'] && !$GLOBALS['BE_USER']->checkAuthMode($table, $field, $p[1], $config['authMode']);
1625 if (in_array($p[1], $removeItems) || $languageDeny || $authModeDeny) {
1626 unset($selItems[$tk]);
1627 } elseif (isset($PA['fieldTSConfig']['altLabels.'][$p[1]])) {
1628 $selItems[$tk][0] = htmlspecialchars($this->fObj->sL($PA['fieldTSConfig']['altLabels.'][$p[1]]));
1629 }
1630 // Removing doktypes with no access:
1631 if (($table === 'pages' || $table === 'pages_language_overlay') && $field === 'doktype') {
1632 if (!($GLOBALS['BE_USER']->isAdmin() || GeneralUtility::inList($GLOBALS['BE_USER']->groupData['pagetypes_select'], $p[1]))) {
1633 unset($selItems[$tk]);
1634 }
1635 }
1636 }
1637 } else {
1638 $selItems = FALSE;
1639 }
1640 return $selItems;
1641 }
1642
1643 /**
1644 * Gets the uids of a select/selector that should be unique an have already been used.
1645 *
1646 * @param array $records All inline records on this level
1647 * @param array $conf The TCA field configuration of the inline field to be rendered
1648 * @param boolean $splitValue For usage with group/db, values come like "tx_table_123|Title%20abc", but we need "tx_table" and "123
1649 * @return array The uids, that have been used already and should be used unique
1650 * @todo Define visibility
1651 */
1652 public function getUniqueIds($records, $conf = array(), $splitValue = FALSE) {
1653 $uniqueIds = array();
1654 if (isset($conf['foreign_unique']) && $conf['foreign_unique'] && count($records)) {
1655 foreach ($records as $rec) {
1656 // Skip virtual records (e.g. shown in localization mode):
1657 if (!isset($rec['__virtual']) || !$rec['__virtual']) {
1658 $value = $rec[$conf['foreign_unique']];
1659 // Split the value and extract the table and uid:
1660 if ($splitValue) {
1661 $valueParts = GeneralUtility::trimExplode('|', $value);
1662 $itemParts = explode('_', $valueParts[0]);
1663 $value = array(
1664 'uid' => array_pop($itemParts),
1665 'table' => implode('_', $itemParts)
1666 );
1667 }
1668 $uniqueIds[$rec['uid']] = $value;
1669 }
1670 }
1671 }
1672 return $uniqueIds;
1673 }
1674
1675 /**
1676 * Determines the corrected pid to be used for a new record.
1677 * The pid to be used can be defined by a Page TSconfig.
1678 *
1679 * @param string $table The table name
1680 * @param integer $parentPid The pid of the parent record
1681 * @return integer The corrected pid to be used for a new record
1682 */
1683 protected function getNewRecordPid($table, $parentPid = NULL) {
1684 $newRecordPid = $this->inlineFirstPid;
1685 $pageTS = BackendUtility::getPagesTSconfig($parentPid);
1686 if (isset($pageTS['TCAdefaults.'][$table . '.']['pid']) && MathUtility::canBeInterpretedAsInteger($pageTS['TCAdefaults.'][$table . '.']['pid'])) {
1687 $newRecordPid = $pageTS['TCAdefaults.'][$table . '.']['pid'];
1688 } elseif (isset($parentPid) && MathUtility::canBeInterpretedAsInteger($parentPid)) {
1689 $newRecordPid = $parentPid;
1690 }
1691 return $newRecordPid;
1692 }
1693
1694 /**
1695 * Get a single record row for a TCA table from the database.
1696 * \TYPO3\CMS\Backend\Form\DataPreprocessor is used for "upgrading" the
1697 * values, especially the relations.
1698 *
1699 * @param integer $pid The pid of the page the record should be stored (only relevant for NEW records)
1700 * @param string $table The table to fetch data from (= foreign_table)
1701 * @param string $uid The uid of the record to fetch, or the pid if a new record should be created
1702 * @param string $cmd The command to perform, empty or 'new'
1703 * @return array A record row from the database post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor
1704 * @todo Define visibility
1705 */
1706 public function getRecord($pid, $table, $uid, $cmd = '') {
1707 // Fetch workspace version of a record (if any):
1708 if ($cmd !== 'new' && $GLOBALS['BE_USER']->workspace !== 0) {
1709 $workspaceVersion = BackendUtility::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace, $table, $uid, 'uid');
1710 if ($workspaceVersion !== FALSE) {
1711 $uid = $workspaceVersion['uid'];
1712 }
1713 }
1714 $trData = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Form\\DataPreprocessor');
1715 $trData->addRawData = TRUE;
1716 $trData->lockRecords = 1;
1717 $trData->disableRTE = $GLOBALS['SOBE']->MOD_SETTINGS['disableRTE'];
1718 // If a new record should be created
1719 $trData->fetchRecord($table, $uid, $cmd === 'new' ? 'new' : '');
1720 $rec = reset($trData->regTableItems_data);
1721 return $rec;
1722 }
1723
1724 /**
1725 * Wrapper. Calls getRecord in case of a new record should be created.
1726 *
1727 * @param integer $pid The pid of the page the record should be stored (only relevant for NEW records)
1728 * @param string $table The table to fetch data from (= foreign_table)
1729 * @return array A record row from the database post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor
1730 * @todo Define visibility
1731 */
1732 public function getNewRecord($pid, $table) {
1733 $rec = $this->getRecord($pid, $table, $pid, 'new');
1734 $rec['uid'] = uniqid('NEW');
1735 $rec['pid'] = $this->getNewRecordPid($table, $pid);
1736 return $rec;
1737 }
1738
1739 /*******************************************************
1740 *
1741 * Structure stack for handling inline objects/levels
1742 *
1743 *******************************************************/
1744 /**
1745 * Add a new level on top of the structure stack. Other functions can access the
1746 * stack and determine, if there's possibly a endless loop.
1747 *
1748 * @param string $table The table name of the record
1749 * @param string $uid The uid of the record that embeds the inline data
1750 * @param string $field The field name which this element is supposed to edit
1751 * @param array $config The TCA-configuration of the inline field
1752 * @param array $parameters The full parameter array (PA)
1753 * @return void
1754 * @todo Define visibility
1755 */
1756 public function pushStructure($table, $uid, $field = '', $config = array(), array $parameters = array()) {
1757 $structure = array(
1758 'table' => $table,
1759 'uid' => $uid,
1760 'field' => $field,
1761 'config' => $config,
1762 'localizationMode' => BackendUtility::getInlineLocalizationMode($table, $config),
1763 );
1764
1765 // Extract FlexForm parts (if any) from element name,
1766 // e.g. array('vDEF', 'lDEF', 'FlexField', 'vDEF')
1767 if (!empty($parameters['itemFormElName'])) {
1768 $flexFormParts = $this->extractFlexFormParts($parameters['itemFormElName']);
1769
1770 if ($flexFormParts !== NULL) {
1771 $structure['flexform'] = $flexFormParts;
1772 }
1773 }
1774
1775 $this->inlineStructure['stable'][] = $structure;
1776 $this->updateStructureNames();
1777 }
1778
1779 /**
1780 * Remove the item on top of the structure stack and return it.
1781 *
1782 * @return array The top item of the structure stack - array(<table>,<uid>,<field>,<config>)
1783 * @todo Define visibility
1784 */
1785 public function popStructure() {
1786 $popItem = NULL;
1787
1788 if (count($this->inlineStructure['stable'])) {
1789 $popItem = array_pop($this->inlineStructure['stable']);
1790 $this->updateStructureNames();
1791 }
1792 return $popItem;
1793 }
1794
1795 /**
1796 * For common use of DOM object-ids and form field names of a several inline-level,
1797 * these names/identifiers are preprocessed and set to $this->inlineNames.
1798 * This function is automatically called if a level is pushed to or removed from the
1799 * inline structure stack.
1800 *
1801 * @return void
1802 * @todo Define visibility
1803 */
1804 public function updateStructureNames() {
1805 $current = $this->getStructureLevel(-1);
1806 // If there are still more inline levels available
1807 if ($current !== FALSE) {
1808 $this->inlineNames = array(
1809 'form' => $this->prependFormFieldNames . $this->getStructureItemName($current, self::Disposal_AttributeName),
1810 'object' => $this->prependNaming . self::Structure_Separator . $this->inlineFirstPid . self::Structure_Separator . $this->getStructurePath()
1811 );
1812 } else {
1813 $this->inlineNames = array();
1814 }
1815 }
1816
1817 /**
1818 * Create a name/id for usage in HTML output of a level of the structure stack to be used in form names.
1819 *
1820 * @param array $levelData Array of a level of the structure stack (containing the keys table, uid and field)
1821 * @param string $disposal How the structure name is used (e.g. as <div id="..."> or <input name="..." />)
1822 * @return string The name/id of that level, to be used for HTML output
1823 * @todo Define visibility
1824 */
1825 public function getStructureItemName($levelData, $disposal = self::Disposal_AttributeId) {
1826 $name = NULL;
1827
1828 if (is_array($levelData)) {
1829 $parts = array($levelData['table'], $levelData['uid']);
1830
1831 if (!empty($levelData['field'])) {
1832 $parts[] = $levelData['field'];
1833 }
1834
1835 // Use in name attributes:
1836 if ($disposal === self::Disposal_AttributeName) {
1837 if (!empty($levelData['field']) && !empty($levelData['flexform']) && $this->getStructureLevel(-1) === $levelData) {
1838 $parts[] = implode('][', $levelData['flexform']);
1839 }
1840 $name = '[' . implode('][', $parts) . ']';
1841 // Use in object id attributes:
1842 } else {
1843 $name = implode(self::Structure_Separator, $parts);
1844
1845 if (!empty($levelData['field']) && !empty($levelData['flexform'])) {
1846 array_unshift($levelData['flexform'], $name);
1847 $name = implode(self::FlexForm_Separator, $levelData['flexform']);
1848 }
1849 }
1850 }
1851
1852 return $name;
1853 }
1854
1855 /**
1856 * Get a level from the stack and return the data.
1857 * If the $level value is negative, this function works top-down,
1858 * if the $level value is positive, this function works bottom-up.
1859 *
1860 * @param integer $level Which level to return
1861 * @return array The item of the stack at the requested level
1862 * @todo Define visibility
1863 */
1864 public function getStructureLevel($level) {
1865 $level = $this->calculateStructureLevel($level);
1866
1867 if ($level !== FALSE) {
1868 return $this->inlineStructure['stable'][$level];
1869 } else {
1870 return FALSE;
1871 }
1872 }
1873
1874 /**
1875 * Calculates structure level.
1876 *
1877 * @param integer $level Which level to return
1878 * @return boolean|integer
1879 */
1880 protected function calculateStructureLevel($level) {
1881 $result = FALSE;
1882
1883 $inlineStructureCount = count($this->inlineStructure['stable']);
1884 if ($level < 0) {
1885 $level = $inlineStructureCount + $level;
1886 }
1887 if ($level >= 0 && $level < $inlineStructureCount) {
1888 $result = $level;
1889 }
1890
1891 return $result;
1892 }
1893
1894 /**
1895 * Get the identifiers of a given depth of level, from the top of the stack to the bottom.
1896 * An identifier looks like "<table>-<uid>-<field>".
1897 *
1898 * @param integer $structureDepth How much levels to output, beginning from the top of the stack
1899 * @return string The path of identifiers
1900 * @todo Define visibility
1901 */
1902 public function getStructurePath($structureDepth = -1) {
1903 $structureLevels = array();
1904 $structureCount = count($this->inlineStructure['stable']);
1905 if ($structureDepth < 0 || $structureDepth > $structureCount) {
1906 $structureDepth = $structureCount;
1907 }
1908 for ($i = 1; $i <= $structureDepth; $i++) {
1909 array_unshift($structureLevels, $this->getStructureItemName($this->getStructureLevel(-$i), self::Disposal_AttributeId));
1910 }
1911 return implode(self::Structure_Separator, $structureLevels);
1912 }
1913
1914 /**
1915 * Convert the DOM object-id of an inline container to an array.
1916 * The object-id could look like 'data-parentPageId-tx_mmftest_company-1-employees'.
1917 * The result is written to $this->inlineStructure.
1918 * There are two keys:
1919 * - 'stable': Containing full qualified identifiers (table, uid and field)
1920 * - 'unstable': Containting partly filled data (e.g. only table and possibly field)
1921 *
1922 * @param string $domObjectId The DOM object-id
1923 * @param boolean $loadConfig Load the TCA configuration for that level (default: TRUE)
1924 * @return void
1925 * @todo Define visibility
1926 */
1927 public function parseStructureString($string, $loadConfig = TRUE) {
1928 $unstable = array();
1929 $vector = array('table', 'uid', 'field');
1930
1931 // Substitute FlexForm additon and make parsing a bit easier
1932 $string = str_replace(self::FlexForm_Separator, self::FlexForm_Substitute, $string);
1933 // The starting pattern of an object identifer (e.g. "data-<firstPidValue>-<anything>)
1934 $pattern = '/^' . $this->prependNaming . self::Structure_Separator . '(.+?)' . self::Structure_Separator . '(.+)$/';
1935
1936 if (preg_match($pattern, $string, $match)) {
1937 $this->inlineFirstPid = $match[1];
1938 $parts = explode(self::Structure_Separator, $match[2]);
1939 $partsCnt = count($parts);
1940 for ($i = 0; $i < $partsCnt; $i++) {
1941 if ($i > 0 && $i % 3 == 0) {
1942 // Load the TCA configuration of the table field and store it in the stack
1943 if ($loadConfig) {
1944 $unstable['config'] = $GLOBALS['TCA'][$unstable['table']]['columns'][$unstable['field']]['config'];
1945 // Fetch TSconfig:
1946 $TSconfig = $this->fObj->setTSconfig($unstable['table'], array('uid' => $unstable['uid'], 'pid' => $this->inlineFirstPid), $unstable['field']);
1947 // Override TCA field config by TSconfig:
1948 if (!$TSconfig['disabled']) {
1949 $unstable['config'] = $this->fObj->overrideFieldConf($unstable['config'], $TSconfig);
1950 }
1951 $unstable['localizationMode'] = BackendUtility::getInlineLocalizationMode($unstable['table'], $unstable['config']);
1952 }
1953
1954 // Extract FlexForm from field part (if any)
1955 if (strpos($unstable['field'], self::FlexForm_Substitute) !== FALSE) {
1956 $fieldParts = GeneralUtility::trimExplode(self::FlexForm_Substitute, $unstable['field']);
1957 $unstable['field'] = array_shift($fieldParts);
1958 // FlexForm parts start with data:
1959 if (count($fieldParts) > 0 && $fieldParts[0] === 'data') {
1960 $unstable['flexform'] = $fieldParts;
1961 }
1962 }
1963
1964 $this->inlineStructure['stable'][] = $unstable;
1965 $unstable = array();
1966 }
1967 $unstable[$vector[$i % 3]] = $parts[$i];
1968 }
1969 $this->updateStructureNames();
1970 if (count($unstable)) {
1971 $this->inlineStructure['unstable'] = $unstable;
1972 }
1973 }
1974 }
1975
1976 /*******************************************************
1977 *
1978 * Helper functions
1979 *
1980 *******************************************************/
1981 /**
1982 * Does some checks on the TCA configuration of the inline field to render.
1983 *
1984 * @param array $config Reference to the TCA field configuration
1985 * @param string $table The table name of the record
1986 * @param string $field The field name which this element is supposed to edit
1987 * @param array $row The record data array of the parent
1988 * @return boolean If critical configuration errors were found, FALSE is returned
1989 * @todo Define visibility
1990 */
1991 public function checkConfiguration(&$config) {
1992 $foreign_table = $config['foreign_table'];
1993 // An inline field must have a foreign_table, if not, stop all further inline actions for this field:
1994 if (!$foreign_table || !is_array($GLOBALS['TCA'][$foreign_table])) {
1995 return FALSE;
1996 }
1997 // Init appearance if not set:
1998 if (!isset($config['appearance']) || !is_array($config['appearance'])) {
1999 $config['appearance'] = array();
2000 }
2001 // Set the position/appearance of the "Create new record" link:
2002 if (isset($config['foreign_selector']) && $config['foreign_selector'] && (!isset($config['appearance']['useCombination']) || !$config['appearance']['useCombination'])) {
2003 $config['appearance']['levelLinksPosition'] = 'none';
2004 } elseif (!isset($config['appearance']['levelLinksPosition']) || !in_array($config['appearance']['levelLinksPosition'], array('top', 'bottom', 'both', 'none'))) {
2005 $config['appearance']['levelLinksPosition'] = 'top';
2006 }
2007 // Defines which controls should be shown in header of each record:
2008 $enabledControls = array(
2009 'info' => TRUE,
2010 'new' => TRUE,
2011 'dragdrop' => TRUE,
2012 'sort' => TRUE,
2013 'hide' => TRUE,
2014 'delete' => TRUE,
2015 'localize' => TRUE
2016 );
2017 if (isset($config['appearance']['enabledControls']) && is_array($config['appearance']['enabledControls'])) {
2018 $config['appearance']['enabledControls'] = array_merge($enabledControls, $config['appearance']['enabledControls']);
2019 } else {
2020 $config['appearance']['enabledControls'] = $enabledControls;
2021 }
2022 return TRUE;
2023 }
2024
2025 /**
2026 * Checks the page access rights (Code for access check mostly taken from alt_doc.php)
2027 * as well as the table access rights of the user.
2028 *
2029 * @param string $cmd The command that sould be performed ('new' or 'edit')
2030 * @param string $table The table to check access for
2031 * @param string $theUid The record uid of the table
2032 * @return boolean Returns TRUE is the user has access, or FALSE if not
2033 * @todo Define visibility
2034 */
2035 public function checkAccess($cmd, $table, $theUid) {
2036 // Checking if the user has permissions? (Only working as a precaution, because the final permission check is always down in TCE. But it's good to notify the user on beforehand...)
2037 // First, resetting flags.
2038 $hasAccess = 0;
2039 $deniedAccessReason = '';
2040 // Admin users always have acces:
2041 if ($GLOBALS['BE_USER']->isAdmin()) {
2042 return TRUE;
2043 }
2044 // If the command is to create a NEW record...:
2045 if ($cmd == 'new') {
2046 // If the pid is numerical, check if it's possible to write to this page:
2047 if (MathUtility::canBeInterpretedAsInteger($this->inlineFirstPid)) {
2048 $calcPRec = BackendUtility::getRecord('pages', $this->inlineFirstPid);
2049 if (!is_array($calcPRec)) {
2050 return FALSE;
2051 }
2052 // Permissions for the parent page
2053 $CALC_PERMS = $GLOBALS['BE_USER']->calcPerms($calcPRec);
2054 // If pages:
2055 if ($table == 'pages') {
2056 // Are we allowed to create new subpages?
2057 $hasAccess = $CALC_PERMS & 8 ? 1 : 0;
2058 } else {
2059 // Are we allowed to edit content on this page?
2060 $hasAccess = $CALC_PERMS & 16 ? 1 : 0;
2061 }
2062 } else {
2063 $hasAccess = 1;
2064 }
2065 } else {
2066 // Edit:
2067 $calcPRec = BackendUtility::getRecord($table, $theUid);
2068 BackendUtility::fixVersioningPid($table, $calcPRec);
2069 if (is_array($calcPRec)) {
2070 // If pages:
2071 if ($table == 'pages') {
2072 $CALC_PERMS = $GLOBALS['BE_USER']->calcPerms($calcPRec);
2073 $hasAccess = $CALC_PERMS & 2 ? 1 : 0;
2074 } else {
2075 // Fetching pid-record first.
2076 $CALC_PERMS = $GLOBALS['BE_USER']->calcPerms(BackendUtility::getRecord('pages', $calcPRec['pid']));
2077 $hasAccess = $CALC_PERMS & 16 ? 1 : 0;
2078 }
2079 // Check internals regarding access:
2080 if ($hasAccess) {
2081 $hasAccess = $GLOBALS['BE_USER']->recordEditAccessInternals($table, $calcPRec);
2082 }
2083 }
2084 }
2085 if (!$GLOBALS['BE_USER']->check('tables_modify', $table)) {
2086 $hasAccess = 0;
2087 }
2088 if (!$hasAccess) {
2089 $deniedAccessReason = $GLOBALS['BE_USER']->errorMsg;
2090 if ($deniedAccessReason) {
2091 debug($deniedAccessReason);
2092 }
2093 }
2094 return $hasAccess ? TRUE : FALSE;
2095 }
2096
2097 /**
2098 * Check the keys and values in the $compare array against the ['config'] part of the top level of the stack.
2099 * A boolean value is return depending on how the comparison was successful.
2100 *
2101 * @param array $compare Keys and values to compare to the ['config'] part of the top level of the stack
2102 * @return boolean Whether the comparison was successful
2103 * @see arrayCompareComplex
2104 * @todo Define visibility
2105 */
2106 public function compareStructureConfiguration($compare) {
2107 $level = $this->getStructureLevel(-1);
2108 $result = $this->arrayCompareComplex($level, $compare);
2109 return $result;
2110 }
2111
2112 /**
2113 * Normalize a relation "uid" published by transferData, like "1|Company%201"
2114 *
2115 * @param string $string A transferData reference string, containing the uid
2116 * @return string The normalized uid
2117 * @todo Define visibility
2118 */
2119 public function normalizeUid($string) {
2120 $parts = explode('|', $string);
2121 return $parts[0];
2122 }
2123
2124 /**
2125 * Wrap the HTML code of a section with a table tag.
2126 *
2127 * @param string $section The HTML code to be wrapped
2128 * @param array $styleAttrs Attributes for the style argument in the table tag
2129 * @param array $tableAttrs Attributes for the table tag (like width, border, etc.)
2130 * @return string The wrapped HTML code
2131 * @todo Define visibility
2132 */
2133 public function wrapFormsSection($section, $styleAttrs = array(), $tableAttrs = array()) {
2134 $style = '';
2135 $table = '';
2136 foreach ($styleAttrs as $key => $value) {
2137 $style .= ($style ? ' ' : '') . $key . ': ' . htmlspecialchars($value) . '; ';
2138 }
2139 if ($style) {
2140 $style = ' style="' . $style . '"';
2141 }
2142 if (!$tableAttrs['background'] && $this->fObj->borderStyle[2]) {
2143 $tableAttrs['background'] = $this->backPath . $this->borderStyle[2];
2144 }
2145 if (!$tableAttrs['class'] && $this->borderStyle[3]) {
2146 $tableAttrs['class'] = $this->borderStyle[3];
2147 }
2148 foreach ($tableAttrs as $key => $value) {
2149 $table .= ($table ? ' ' : '') . $key . '="' . htmlspecialchars($value) . '"';
2150 }
2151 $out = '<table ' . $table . $style . '>' . $section . '</table>';
2152 return $out;
2153 }
2154
2155 /**
2156 * Checks if the $table is the child of a inline type AND the $field is the label field of this table.
2157 * This function is used to dynamically update the label while editing. This has no effect on labels,
2158 * that were processed by a TCEmain-hook on saving.
2159 *
2160 * @param string $table The table to check
2161 * @param string $field The field on this table to check
2162 * @return boolean Is inline child and field is responsible for the label
2163 * @todo Define visibility
2164 */
2165 public function isInlineChildAndLabelField($table, $field) {
2166 $level = $this->getStructureLevel(-1);
2167 if ($level['config']['foreign_label']) {
2168 $label = $level['config']['foreign_label'];
2169 } else {
2170 $label = $GLOBALS['TCA'][$table]['ctrl']['label'];
2171 }
2172 return $level['config']['foreign_table'] === $table && $label == $field ? TRUE : FALSE;
2173 }
2174
2175 /**
2176 * Get the depth of the stable structure stack.
2177 * (count($this->inlineStructure['stable'])
2178 *
2179 * @return integer The depth of the structure stack
2180 * @todo Define visibility
2181 */
2182 public function getStructureDepth() {
2183 return count($this->inlineStructure['stable']);
2184 }
2185
2186 /**
2187 * Handles complex comparison requests on an array.
2188 * A request could look like the following:
2189 *
2190 * $searchArray = array(
2191 * '%AND' => array(
2192 * 'key1' => 'value1',
2193 * 'key2' => 'value2',
2194 * '%OR' => array(
2195 * 'subarray' => array(
2196 * 'subkey' => 'subvalue'
2197 * ),
2198 * 'key3' => 'value3',
2199 * 'key4' => 'value4'
2200 * )
2201 * )
2202 * );
2203 *
2204 * It is possible to use the array keys '%AND.1', '%AND.2', etc. to prevent
2205 * overwriting the sub-array. It could be neccessary, if you use complex comparisons.
2206 *
2207 * The example above means, key1 *AND* key2 (and their values) have to match with
2208 * the $subjectArray and additional one *OR* key3 or key4 have to meet the same
2209 * condition.
2210 * It is also possible to compare parts of a sub-array (e.g. "subarray"), so this
2211 * function recurses down one level in that sub-array.
2212 *
2213 * @param array $subjectArray The array to search in
2214 * @param array $searchArray The array with keys and values to search for
2215 * @param string $type Use '%AND' or '%OR' for comparision
2216 * @return boolean The result of the comparison
2217 * @todo Define visibility
2218 */
2219 public function arrayCompareComplex($subjectArray, $searchArray, $type = '') {
2220 $localMatches = 0;
2221 $localEntries = 0;
2222 if (is_array($searchArray) && count($searchArray)) {
2223 // If no type was passed, try to determine
2224 if (!$type) {
2225 reset($searchArray);
2226 $type = key($searchArray);
2227 $searchArray = current($searchArray);
2228 }
2229 // We use '%AND' and '%OR' in uppercase
2230 $type = strtoupper($type);
2231 // Split regular elements from sub elements
2232 foreach ($searchArray as $key => $value) {
2233 $localEntries++;
2234 // Process a sub-group of OR-conditions
2235 if ($key == '%OR') {
2236 $localMatches += $this->arrayCompareComplex($subjectArray, $value, '%OR') ? 1 : 0;
2237 } elseif ($key == '%AND') {
2238 $localMatches += $this->arrayCompareComplex($subjectArray, $value, '%AND') ? 1 : 0;
2239 } elseif (is_array($value) && $this->isAssociativeArray($searchArray)) {
2240 $localMatches += $this->arrayCompareComplex($subjectArray[$key], $value, $type) ? 1 : 0;
2241 } elseif (is_array($value)) {
2242 $localMatches += $this->arrayCompareComplex($subjectArray, $value, $type) ? 1 : 0;
2243 } else {
2244 if (isset($subjectArray[$key]) && isset($value)) {
2245 // Boolean match:
2246 if (is_bool($value)) {
2247 $localMatches += !($subjectArray[$key] xor $value) ? 1 : 0;
2248 } elseif (is_numeric($subjectArray[$key]) && is_numeric($value)) {
2249 $localMatches += $subjectArray[$key] == $value ? 1 : 0;
2250 } else {
2251 $localMatches += $subjectArray[$key] === $value ? 1 : 0;
2252 }
2253 }
2254 }
2255 // If one or more matches are required ('OR'), return TRUE after the first successful match
2256 if ($type == '%OR' && $localMatches > 0) {
2257 return TRUE;
2258 }
2259 // If all matches are required ('AND') and we have no result after the first run, return FALSE
2260 if ($type == '%AND' && $localMatches == 0) {
2261 return FALSE;
2262 }
2263 }
2264 }
2265 // Return the result for '%AND' (if nothing was checked, TRUE is returned)
2266 return $localEntries == $localMatches ? TRUE : FALSE;
2267 }
2268
2269 /**
2270 * Checks whether an object is an associative array.
2271 *
2272 * @param mixed $object The object to be checked
2273 * @return boolean Returns TRUE, if the object is an associative array
2274 * @todo Define visibility
2275 */
2276 public function isAssociativeArray($object) {
2277 return is_array($object) && count($object) && array_keys($object) !== range(0, sizeof($object) - 1) ? TRUE : FALSE;
2278 }
2279
2280 /**
2281 * Remove an element from an array.
2282 *
2283 * @param mixed $needle The element to be removed.
2284 * @param array $haystack The array the element should be removed from.
2285 * @param mixed $strict Search elements strictly.
2286 * @return array The array $haystack without the $needle
2287 * @todo Define visibility
2288 */
2289 public function removeFromArray($needle, $haystack, $strict = NULL) {
2290 $pos = array_search($needle, $haystack, $strict);
2291 if ($pos !== FALSE) {
2292 unset($haystack[$pos]);
2293 }
2294 return $haystack;
2295 }
2296
2297 /**
2298 * Makes a flat array from the $possibleRecords array.
2299 * The key of the flat array is the value of the record,
2300 * the value of the flat array is the label of the record.
2301 *
2302 * @param array $possibleRecords The possibleRecords array (for select fields)
2303 * @return mixed A flat array with key=uid, value=label; if $possibleRecords isn't an array, FALSE is returned.
2304 * @todo Define visibility
2305 */
2306 public function getPossibleRecordsFlat($possibleRecords) {
2307 $flat = FALSE;
2308 if (is_array($possibleRecords)) {
2309 $flat = array();
2310 foreach ($possibleRecords as $record) {
2311 $flat[$record[1]] = $record[0];
2312 }
2313 }
2314 return $flat;
2315 }
2316
2317 /**
2318 * Determine the configuration and the type of a record selector.
2319 *
2320 * @param array $conf TCA configuration of the parent(!) field
2321 * @return array Associative array with the keys 'PA' and 'type', both are FALSE if the selector was not valid.
2322 * @todo Define visibility
2323 */
2324 public function getPossibleRecordsSelectorConfig($conf, $field = '') {
2325 $foreign_table = $conf['foreign_table'];
2326 $foreign_selector = $conf['foreign_selector'];
2327 $PA = FALSE;
2328 $type = FALSE;
2329 $table = FALSE;
2330 $selector = FALSE;
2331 if ($field) {
2332 $PA = array();
2333 $PA['fieldConf'] = $GLOBALS['TCA'][$foreign_table]['columns'][$field];
2334 if ($PA['fieldConf'] && $conf['foreign_selector_fieldTcaOverride']) {
2335 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($PA['fieldConf'], $conf['foreign_selector_fieldTcaOverride']);
2336 }
2337 $PA['fieldConf']['config']['form_type'] = $PA['fieldConf']['config']['form_type'] ?: $PA['fieldConf']['config']['type'];
2338 // Using "form_type" locally in this script
2339 $PA['fieldTSConfig'] = $this->fObj->setTSconfig($foreign_table, array(), $field);
2340 $config = $PA['fieldConf']['config'];
2341 // Determine type of Selector:
2342 $type = $this->getPossibleRecordsSelectorType($config);
2343 // Return table on this level:
2344 $table = $type == 'select' ? $config['foreign_table'] : $config['allowed'];
2345 // Return type of the selector if foreign_selector is defined and points to the same field as in $field:
2346 if ($foreign_selector && $foreign_selector == $field && $type) {
2347 $selector = $type;
2348 }
2349 }
2350 return array(
2351 'PA' => $PA,
2352 'type' => $type,
2353 'table' => $table,
2354 'selector' => $selector
2355 );
2356 }
2357
2358 /**
2359 * Determine the type of a record selector, e.g. select or group/db.
2360 *
2361 * @param array $config TCE configuration of the selector
2362 * @return mixed The type of the selector, 'select' or 'groupdb' - FALSE not valid
2363 * @todo Define visibility
2364 */
2365 public function getPossibleRecordsSelectorType($config) {
2366 $type = FALSE;
2367 if ($config['type'] == 'select') {
2368 $type = 'select';
2369 } elseif ($config['type'] == 'group' && $config['internal_type'] == 'db') {
2370 $type = 'groupdb';
2371 }
2372 return $type;
2373 }
2374
2375 /**
2376 * Check, if a field should be skipped, that was defined to be handled as foreign_field or foreign_sortby of
2377 * the parent record of the "inline"-type - if so, we have to skip this field - the rendering is done via "inline" as hidden field
2378 *
2379 * @param string $table The table name
2380 * @param string $field The field name
2381 * @param array $row The record row from the database
2382 * @param array $config TCA configuration of the field
2383 * @return boolean Determines whether the field should be skipped.
2384 * @todo Define visibility
2385 */
2386 public function skipField($table, $field, $row, $config) {
2387 $skipThisField = FALSE;
2388 if ($this->getStructureDepth()) {
2389 $searchArray = array(
2390 '%OR' => array(
2391 'config' => array(
2392 0 => array(
2393 '%AND' => array(
2394 'foreign_table' => $table,
2395 '%OR' => array(
2396 '%AND' => array(
2397 'appearance' => array('useCombination' => TRUE),
2398 'foreign_selector' => $field
2399 ),
2400 'MM' => $config['MM']
2401 )
2402 )
2403 ),
2404 1 => array(
2405 '%AND' => array(
2406 'foreign_table' => $config['foreign_table'],
2407 'foreign_selector' => $config['foreign_field']
2408 )
2409 )
2410 )
2411 )
2412 );
2413 // Get the parent record from structure stack
2414 $level = $this->getStructureLevel(-1);
2415 // If we have symmetric fields, check on which side we are and hide fields, that are set automatically:
2416 if (RelationHandler::isOnSymmetricSide($level['uid'], $level['config'], $row)) {
2417 $searchArray['%OR']['config'][0]['%AND']['%OR']['symmetric_field'] = $field;
2418 $searchArray['%OR']['config'][0]['%AND']['%OR']['symmetric_sortby'] = $field;
2419 } else {
2420 $searchArray['%OR']['config'][0]['%AND']['%OR']['foreign_field'] = $field;
2421 $searchArray['%OR']['config'][0]['%AND']['%OR']['foreign_sortby'] = $field;
2422 }
2423 $skipThisField = $this->compareStructureConfiguration($searchArray, TRUE);
2424 }
2425 return $skipThisField;
2426 }
2427
2428 /**
2429 * Checks if a uid of a child table is in the inline view settings.
2430 *
2431 * @param string $table Name of the child table
2432 * @param integer $uid uid of the the child record
2433 * @return boolean TRUE=expand, FALSE=collapse
2434 * @todo Define visibility
2435 */
2436 public function getExpandedCollapsedState($table, $uid) {
2437 if (isset($this->inlineView[$table]) && is_array($this->inlineView[$table])) {
2438 if (in_array($uid, $this->inlineView[$table]) !== FALSE) {
2439 return TRUE;
2440 }
2441 }
2442 return FALSE;
2443 }
2444
2445 /**
2446 * Update expanded/collapsed states on new inline records if any.
2447 *
2448 * @param array $uc The uc array to be processed and saved (by reference)
2449 * @param \TYPO3\CMS\Core\DataHandling\DataHandler $tce Instance of TCEmain that saved data before
2450 * @return void
2451 * @todo Define visibility
2452 */
2453 public function updateInlineView(&$uc, $tce) {
2454 if (isset($uc['inlineView']) && is_array($uc['inlineView'])) {
2455 $inlineView = (array) unserialize($GLOBALS['BE_USER']->uc['inlineView']);
2456 foreach ($uc['inlineView'] as $topTable => $topRecords) {
2457 foreach ($topRecords as $topUid => $childElements) {
2458 foreach ($childElements as $childTable => $childRecords) {
2459 $uids = array_keys($tce->substNEWwithIDs_table, $childTable);
2460 if (count($uids)) {
2461 $newExpandedChildren = array();
2462 foreach ($childRecords as $childUid => $state) {
2463 if ($state && in_array($childUid, $uids)) {
2464 $newChildUid = $tce->substNEWwithIDs[$childUid];
2465 $newExpandedChildren[] = $newChildUid;
2466 }
2467 }
2468 // Add new expanded child records to UC (if any):
2469 if (count($newExpandedChildren)) {
2470 $inlineViewCurrent = &$inlineView[$topTable][$topUid][$childTable];
2471 if (is_array($inlineViewCurrent)) {
2472 $inlineViewCurrent = array_unique(array_merge($inlineViewCurrent, $newExpandedChildren));
2473 } else {
2474 $inlineViewCurrent = $newExpandedChildren;
2475 }
2476 }
2477 }
2478 }
2479 }
2480 }
2481 $GLOBALS['BE_USER']->uc['inlineView'] = serialize($inlineView);
2482 $GLOBALS['BE_USER']->writeUC();
2483 }
2484 }
2485
2486 /**
2487 * Returns the the margin in pixels, that is used for each new inline level.
2488 *
2489 * @return integer A pixel value for the margin of each new inline level.
2490 * @todo Define visibility
2491 */
2492 public function getLevelMargin() {
2493 $margin = ($this->inlineStyles['margin-right'] + 1) * 2;
2494 return $margin;
2495 }
2496
2497 /**
2498 * Parses the HTML tags that would have been inserted to the <head> of a HTML document and returns the found tags as multidimensional array.
2499 *
2500 * @return array The parsed tags with their attributes and innerHTML parts
2501 */
2502 protected function getHeadTags() {
2503 $headTags = array();
2504 $headDataRaw = $this->fObj->JStop() . $this->getJavaScriptAndStyleSheetsOfPageRenderer();
2505 if ($headDataRaw) {
2506 // Create instance of the HTML parser:
2507 $parseObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Html\\HtmlParser');
2508 // Removes script wraps:
2509 $headDataRaw = str_replace(array('/*<![CDATA[*/', '/*]]>*/'), '', $headDataRaw);
2510 // Removes leading spaces of a multiline string:
2511 $headDataRaw = trim(preg_replace('/(^|\\r|\\n)( |\\t)+/', '$1', $headDataRaw));
2512 // Get script and link tags:
2513 $tags = array_merge($parseObj->getAllParts($parseObj->splitTags('link', $headDataRaw)), $parseObj->getAllParts($parseObj->splitIntoBlock('script', $headDataRaw)));
2514 foreach ($tags as $tagData) {
2515 $tagAttributes = $parseObj->get_tag_attributes($parseObj->getFirstTag($tagData), TRUE);
2516 $headTags[] = array(
2517 'name' => $parseObj->getFirstTagName($tagData),
2518 'attributes' => $tagAttributes[0],
2519 'innerHTML' => $parseObj->removeFirstAndLastTag($tagData)
2520 );
2521 }
2522 }
2523 return $headTags;
2524 }
2525
2526 /**
2527 * Gets the JavaScript of the pageRenderer.
2528 * This can be used to extract newly added files which have been added
2529 * during an AJAX request. Due to the spread possibilities of the pageRenderer
2530 * to add JavaScript rendering and extracting seems to be the easiest way.
2531 *
2532 * @return string
2533 */
2534 protected function getJavaScriptAndStyleSheetsOfPageRenderer() {
2535 /** @var $pageRenderer \TYPO3\CMS\Core\Page\PageRenderer */
2536 $pageRenderer = clone $GLOBALS['SOBE']->doc->getPageRenderer();
2537 $pageRenderer->setCharSet($GLOBALS['LANG']->charSet);
2538 $pageRenderer->setTemplateFile('EXT:backend/Resources/Private/Templates/helper_javascript_css.html');
2539 $javaScriptAndStyleSheets = $pageRenderer->render();
2540 return $javaScriptAndStyleSheets;
2541 }
2542
2543 /**
2544 * Wraps a text with an anchor and returns the HTML representation.
2545 *
2546 * @param string $text The text to be wrapped by an anchor
2547 * @param string $link The link to be used in the anchor
2548 * @param array $attributes Array of attributes to be used in the anchor
2549 * @return string The wrapped texted as HTML representation
2550 */
2551 protected function wrapWithAnchor($text, $link, $attributes = array()) {
2552 $link = trim($link);
2553 $result = '<a href="' . ($link ?: '#') . '"';
2554 foreach ($attributes as $key => $value) {
2555 $result .= ' ' . $key . '="' . htmlspecialchars(trim($value)) . '"';
2556 }
2557 $result .= '>' . $text . '</a>';
2558 return $result;
2559 }
2560
2561 /**
2562 * Extracts FlexForm parts of a form element name like
2563 * data[table][uid][field][sDEF][lDEF][FlexForm][vDEF]
2564 *
2565 * @param string $formElementName The form element name
2566 * @return array|NULL
2567 */
2568 protected function extractFlexFormParts($formElementName) {
2569 $flexFormParts = NULL;
2570
2571 $matches = array();
2572 $prefix = preg_quote($this->fObj->prependFormFieldNames, '#');
2573
2574 if (preg_match('#^' . $prefix . '(?:\[[^]]+\]){3}(\[data\](?:\[[^]]+\]){4,})$#', $formElementName, $matches)) {
2575 $flexFormParts = GeneralUtility::trimExplode(
2576 '][',
2577 trim($matches[1], '[]')
2578 );
2579 }
2580
2581 return $flexFormParts;
2582 }
2583
2584 }