[FOLLOWUP] Use GeneralUtility::quoteJSvalue() where needed part 1
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Utility / BackendUtility.php
1 <?php
2 namespace TYPO3\CMS\Backend\Utility;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider;
18 use TYPO3\CMS\Backend\Template\DocumentTemplate;
19 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
20 use TYPO3\CMS\Core\Cache\CacheManager;
21 use TYPO3\CMS\Core\Database\RelationHandler;
22 use TYPO3\CMS\Core\FormProtection\FormProtectionFactory;
23 use TYPO3\CMS\Core\Messaging\FlashMessage;
24 use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
25 use TYPO3\CMS\Core\Resource\File;
26 use TYPO3\CMS\Core\Resource\ProcessedFile;
27 use TYPO3\CMS\Core\Resource\ResourceFactory;
28 use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
29 use TYPO3\CMS\Core\Utility\ArrayUtility;
30 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
31 use TYPO3\CMS\Core\Utility\GeneralUtility;
32 use TYPO3\CMS\Core\Utility\HttpUtility;
33 use TYPO3\CMS\Core\Utility\MathUtility;
34 use TYPO3\CMS\Core\Utility\PathUtility;
35 use TYPO3\CMS\Core\Versioning\VersionState;
36 use TYPO3\CMS\Core\Database\DatabaseConnection;
37 use TYPO3\CMS\Frontend\Page\PageRepository;
38 use TYPO3\CMS\Lang\LanguageService;
39
40 /**
41 * Standard functions available for the TYPO3 backend.
42 * You are encouraged to use this class in your own applications (Backend Modules)
43 * Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.
44 *
45 * Call ALL methods without making an object!
46 * Eg. to get a page-record 51 do this: '\TYPO3\CMS\Backend\Utility\BackendUtility::getRecord('pages',51)'
47 *
48 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
49 */
50 class BackendUtility {
51
52 /**
53 * Cache the TCA configuration of tables with their types during runtime
54 *
55 * @var array
56 * @see getTCAtypes()
57 */
58 static protected $tcaTableTypeConfigurationCache = array();
59
60 /*******************************************
61 *
62 * SQL-related, selecting records, searching
63 *
64 *******************************************/
65 /**
66 * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
67 * is configured in $GLOBALS['TCA'] for the tablename, $table
68 * This function should ALWAYS be called in the backend for selection on tables which
69 * are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
70 * even if they are marked deleted (in which case the system must always treat them as non-existent!)
71 * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
72 * and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
73 * on those fields as well in the backend you can use ->BEenableFields() though.
74 *
75 * @param string $table Table name present in $GLOBALS['TCA']
76 * @param string $tableAlias Table alias if any
77 * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
78 */
79 static public function deleteClause($table, $tableAlias = '') {
80 if ($GLOBALS['TCA'][$table]['ctrl']['delete']) {
81 return ' AND ' . ($tableAlias ?: $table) . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'] . '=0';
82 } else {
83 return '';
84 }
85 }
86
87 /**
88 * Gets record with uid = $uid from $table
89 * You can set $field to a list of fields (default is '*')
90 * Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1')
91 * Will automatically check if records has been deleted and if so, not return anything.
92 * $table must be found in $GLOBALS['TCA']
93 *
94 * @param string $table Table name present in $GLOBALS['TCA']
95 * @param int $uid UID of record
96 * @param string $fields List of fields to select
97 * @param string $where Additional WHERE clause, eg. " AND blablabla = 0
98 * @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
99 * @return array|NULL Returns the row if found, otherwise NULL
100 */
101 static public function getRecord($table, $uid, $fields = '*', $where = '', $useDeleteClause = TRUE) {
102 // Ensure we have a valid uid (not 0 and not NEWxxxx) and a valid TCA
103 if ((int)$uid && !empty($GLOBALS['TCA'][$table])) {
104 $where = 'uid=' . (int)$uid . ($useDeleteClause ? self::deleteClause($table) : '') . $where;
105 $row = static::getDatabaseConnection()->exec_SELECTgetSingleRow($fields, $table, $where);
106 if ($row) {
107 return $row;
108 }
109 }
110 return NULL;
111 }
112
113 /**
114 * Like getRecord(), but overlays workspace version if any.
115 *
116 * @param string $table Table name present in $GLOBALS['TCA']
117 * @param int $uid UID of record
118 * @param string $fields List of fields to select
119 * @param string $where Additional WHERE clause, eg. " AND blablabla = 0
120 * @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
121 * @param bool $unsetMovePointers If TRUE the function does not return a "pointer" row for moved records in a workspace
122 * @return array Returns the row if found, otherwise nothing
123 */
124 static public function getRecordWSOL($table, $uid, $fields = '*', $where = '', $useDeleteClause = TRUE, $unsetMovePointers = FALSE) {
125 if ($fields !== '*') {
126 $internalFields = GeneralUtility::uniqueList($fields . ',uid,pid');
127 $row = self::getRecord($table, $uid, $internalFields, $where, $useDeleteClause);
128 self::workspaceOL($table, $row, -99, $unsetMovePointers);
129 if (is_array($row)) {
130 foreach ($row as $key => $_) {
131 if (!GeneralUtility::inList($fields, $key) && $key[0] !== '_') {
132 unset($row[$key]);
133 }
134 }
135 }
136 } else {
137 $row = self::getRecord($table, $uid, $fields, $where, $useDeleteClause);
138 self::workspaceOL($table, $row, -99, $unsetMovePointers);
139 }
140 return $row;
141 }
142
143 /**
144 * Returns the first record found from $table with $where as WHERE clause
145 * This function does NOT check if a record has the deleted flag set.
146 * $table does NOT need to be configured in $GLOBALS['TCA']
147 * The query used is simply this:
148 * $query = 'SELECT ' . $fields . ' FROM ' . $table . ' WHERE ' . $where;
149 *
150 * @param string $table Table name (not necessarily in TCA)
151 * @param string $where WHERE clause
152 * @param string $fields $fields is a list of fields to select, default is '*'
153 * @return array First row found, if any, FALSE otherwise
154 */
155 static public function getRecordRaw($table, $where = '', $fields = '*') {
156 $row = FALSE;
157 $db = static::getDatabaseConnection();
158 if (FALSE !== ($res = $db->exec_SELECTquery($fields, $table, $where, '', '', '1'))) {
159 $row = $db->sql_fetch_assoc($res);
160 $db->sql_free_result($res);
161 }
162 return $row;
163 }
164
165 /**
166 * Returns records from table, $theTable, where a field ($theField) equals the value, $theValue
167 * The records are returned in an array
168 * If no records were selected, the function returns nothing
169 *
170 * @param string $theTable Table name present in $GLOBALS['TCA']
171 * @param string $theField Field to select on
172 * @param string $theValue Value that $theField must match
173 * @param string $whereClause Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
174 * @param string $groupBy Optional GROUP BY field(s), if none, supply blank string.
175 * @param string $orderBy Optional ORDER BY field(s), if none, supply blank string.
176 * @param string $limit Optional LIMIT value ([begin,]max), if none, supply blank string.
177 * @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
178 * @return mixed Multidimensional array with selected records (if any is selected)
179 */
180 static public function getRecordsByField($theTable, $theField, $theValue, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '', $useDeleteClause = TRUE) {
181 if (is_array($GLOBALS['TCA'][$theTable])) {
182 $db = static::getDatabaseConnection();
183 $res = $db->exec_SELECTquery(
184 '*',
185 $theTable,
186 $theField . '=' . $db->fullQuoteStr($theValue, $theTable) .
187 ($useDeleteClause ? self::deleteClause($theTable) . ' ' : '') .
188 self::versioningPlaceholderClause($theTable) . ' ' .
189 $whereClause,
190 $groupBy,
191 $orderBy,
192 $limit
193 );
194 $rows = array();
195 while ($row = $db->sql_fetch_assoc($res)) {
196 $rows[] = $row;
197 }
198 $db->sql_free_result($res);
199 if (count($rows)) {
200 return $rows;
201 }
202 }
203 return NULL;
204 }
205
206 /**
207 * Makes an backwards explode on the $str and returns an array with ($table, $uid).
208 * Example: tt_content_45 => array('tt_content', 45)
209 *
210 * @param string $str [tablename]_[uid] string to explode
211 * @return array
212 */
213 static public function splitTable_Uid($str) {
214 list($uid, $table) = explode('_', strrev($str), 2);
215 return array(strrev($table), strrev($uid));
216 }
217
218 /**
219 * Returns a list of pure ints based on $in_list being a list of records with table-names prepended.
220 * Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well.
221 *
222 * @param string $in_list Input list
223 * @param string $tablename Table name from which ids is returned
224 * @param string $default_tablename $default_tablename denotes what table the number '45' is from (if nothing is prepended on the value)
225 * @return string List of ids
226 */
227 static public function getSQLselectableList($in_list, $tablename, $default_tablename) {
228 $list = array();
229 if ((string)trim($in_list) != '') {
230 $tempItemArray = explode(',', trim($in_list));
231 foreach ($tempItemArray as $key => $val) {
232 $val = strrev($val);
233 $parts = explode('_', $val, 2);
234 if ((string)trim($parts[0]) != '') {
235 $theID = (int)strrev($parts[0]);
236 $theTable = trim($parts[1]) ? strrev(trim($parts[1])) : $default_tablename;
237 if ($theTable == $tablename) {
238 $list[] = $theID;
239 }
240 }
241 }
242 }
243 return implode(',', $list);
244 }
245
246 /**
247 * Backend implementation of enableFields()
248 * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
249 * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
250 * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
251 *
252 * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
253 * @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
254 * @return string WHERE clause part
255 */
256 static public function BEenableFields($table, $inv = FALSE) {
257 $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
258 $query = array();
259 $invQuery = array();
260 if (is_array($ctrl)) {
261 if (is_array($ctrl['enablecolumns'])) {
262 if ($ctrl['enablecolumns']['disabled']) {
263 $field = $table . '.' . $ctrl['enablecolumns']['disabled'];
264 $query[] = $field . '=0';
265 $invQuery[] = $field . '<>0';
266 }
267 if ($ctrl['enablecolumns']['starttime']) {
268 $field = $table . '.' . $ctrl['enablecolumns']['starttime'];
269 $query[] = '(' . $field . '<=' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
270 $invQuery[] = '(' . $field . '<>0 AND ' . $field . '>' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
271 }
272 if ($ctrl['enablecolumns']['endtime']) {
273 $field = $table . '.' . $ctrl['enablecolumns']['endtime'];
274 $query[] = '(' . $field . '=0 OR ' . $field . '>' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
275 $invQuery[] = '(' . $field . '<>0 AND ' . $field . '<=' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
276 }
277 }
278 }
279 $outQ = $inv ? '(' . implode(' OR ', $invQuery) . ')' : implode(' AND ', $query);
280 return $outQ ? ' AND ' . $outQ : '';
281 }
282
283 /**
284 * Fetches the localization for a given record.
285 *
286 * @param string $table Table name present in $GLOBALS['TCA']
287 * @param int $uid The uid of the record
288 * @param int $language The uid of the language record in sys_language
289 * @param string $andWhereClause Optional additional WHERE clause (default: '')
290 * @return mixed Multidimensional array with selected records; if none exist, FALSE is returned
291 */
292 static public function getRecordLocalization($table, $uid, $language, $andWhereClause = '') {
293 $recordLocalization = FALSE;
294
295 // Check if translations are stored in other table
296 if (isset($GLOBALS['TCA'][$table]['ctrl']['transForeignTable'])) {
297 $table = $GLOBALS['TCA'][$table]['ctrl']['transForeignTable'];
298 }
299
300 if (self::isTableLocalizable($table)) {
301 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
302 $recordLocalization = self::getRecordsByField($table, $tcaCtrl['transOrigPointerField'], $uid, 'AND ' . $tcaCtrl['languageField'] . '=' . (int)$language . ($andWhereClause ? ' ' . $andWhereClause : ''), '', '', '1');
303 }
304 return $recordLocalization;
305 }
306
307 /*******************************************
308 *
309 * Page tree, TCA related
310 *
311 *******************************************/
312 /**
313 * Returns what is called the 'RootLine'. That is an array with information about the page records from a page id ($uid) and back to the root.
314 * By default deleted pages are filtered.
315 * This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found.
316 *
317 * @param int $uid Page id for which to create the root line.
318 * @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
319 * @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
320 * @return array Root line array, all the way to the page tree root (or as far as $clause allows!)
321 */
322 static public function BEgetRootLine($uid, $clause = '', $workspaceOL = FALSE) {
323 static $BEgetRootLine_cache = array();
324 $output = array();
325 $pid = $uid;
326 $ident = $pid . '-' . $clause . '-' . $workspaceOL;
327 if (is_array($BEgetRootLine_cache[$ident])) {
328 $output = $BEgetRootLine_cache[$ident];
329 } else {
330 $loopCheck = 100;
331 $theRowArray = array();
332 while ($uid != 0 && $loopCheck) {
333 $loopCheck--;
334 $row = self::getPageForRootline($uid, $clause, $workspaceOL);
335 if (is_array($row)) {
336 $uid = $row['pid'];
337 $theRowArray[] = $row;
338 } else {
339 break;
340 }
341 }
342 if ($uid == 0) {
343 $theRowArray[] = array('uid' => 0, 'title' => '');
344 }
345 $c = count($theRowArray);
346 foreach ($theRowArray as $val) {
347 $c--;
348 $output[$c] = array(
349 'uid' => $val['uid'],
350 'pid' => $val['pid'],
351 'title' => $val['title'],
352 'doktype' => $val['doktype'],
353 'TSconfig' => $val['TSconfig'],
354 'is_siteroot' => $val['is_siteroot'],
355 'storage_pid' => $val['storage_pid'],
356 't3ver_oid' => $val['t3ver_oid'],
357 't3ver_wsid' => $val['t3ver_wsid'],
358 't3ver_state' => $val['t3ver_state'],
359 't3ver_stage' => $val['t3ver_stage'],
360 'backend_layout_next_level' => $val['backend_layout_next_level']
361 );
362 if (isset($val['_ORIG_pid'])) {
363 $output[$c]['_ORIG_pid'] = $val['_ORIG_pid'];
364 }
365 }
366 $BEgetRootLine_cache[$ident] = $output;
367 }
368 return $output;
369 }
370
371 /**
372 * Gets the cached page record for the rootline
373 *
374 * @param int $uid Page id for which to create the root line.
375 * @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
376 * @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
377 * @return array Cached page record for the rootline
378 * @see BEgetRootLine
379 */
380 static protected function getPageForRootline($uid, $clause, $workspaceOL) {
381 static $getPageForRootline_cache = array();
382 $ident = $uid . '-' . $clause . '-' . $workspaceOL;
383 if (is_array($getPageForRootline_cache[$ident])) {
384 $row = $getPageForRootline_cache[$ident];
385 } else {
386 $db = static::getDatabaseConnection();
387 $res = $db->exec_SELECTquery('pid,uid,title,doktype,TSconfig,is_siteroot,storage_pid,t3ver_oid,t3ver_wsid,t3ver_state,t3ver_stage,backend_layout_next_level', 'pages', 'uid=' . (int)$uid . ' ' . self::deleteClause('pages') . ' ' . $clause);
388 $row = $db->sql_fetch_assoc($res);
389 if ($row) {
390 $newLocation = FALSE;
391 if ($workspaceOL) {
392 self::workspaceOL('pages', $row);
393 $newLocation = self::getMovePlaceholder('pages', $row['uid'], 'pid');
394 }
395 if (is_array($row)) {
396 if ($newLocation !== FALSE) {
397 $row['pid'] = $newLocation['pid'];
398 } else {
399 self::fixVersioningPid('pages', $row);
400 }
401 $getPageForRootline_cache[$ident] = $row;
402 }
403 }
404 $db->sql_free_result($res);
405 }
406 return $row;
407 }
408
409 /**
410 * Opens the page tree to the specified page id
411 *
412 * @param int $pid Page id.
413 * @param bool $clearExpansion If set, then other open branches are closed.
414 * @return void
415 */
416 static public function openPageTree($pid, $clearExpansion) {
417 $beUser = static::getBackendUserAuthentication();
418 // Get current expansion data:
419 if ($clearExpansion) {
420 $expandedPages = array();
421 } else {
422 $expandedPages = unserialize($beUser->uc['browseTrees']['browsePages']);
423 }
424 // Get rootline:
425 $rL = self::BEgetRootLine($pid);
426 // First, find out what mount index to use (if more than one DB mount exists):
427 $mountIndex = 0;
428 $mountKeys = array_flip($beUser->returnWebmounts());
429 foreach ($rL as $rLDat) {
430 if (isset($mountKeys[$rLDat['uid']])) {
431 $mountIndex = $mountKeys[$rLDat['uid']];
432 break;
433 }
434 }
435 // Traverse rootline and open paths:
436 foreach ($rL as $rLDat) {
437 $expandedPages[$mountIndex][$rLDat['uid']] = 1;
438 }
439 // Write back:
440 $beUser->uc['browseTrees']['browsePages'] = serialize($expandedPages);
441 $beUser->writeUC();
442 }
443
444 /**
445 * Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
446 * Each part of the path will be limited to $titleLimit characters
447 * Deleted pages are filtered out.
448 *
449 * @param int $uid Page uid for which to create record path
450 * @param string $clause Clause is additional where clauses, eg.
451 * @param int $titleLimit Title limit
452 * @param int $fullTitleLimit Title limit of Full title (typ. set to 1000 or so)
453 * @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
454 */
455 static public function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit = 0) {
456 if (!$titleLimit) {
457 $titleLimit = 1000;
458 }
459 $output = $fullOutput = '/';
460 $clause = trim($clause);
461 if ($clause !== '' && substr($clause, 0, 3) !== 'AND') {
462 $clause = 'AND ' . $clause;
463 }
464 $data = self::BEgetRootLine($uid, $clause);
465 foreach ($data as $record) {
466 if ($record['uid'] === 0) {
467 continue;
468 }
469 $output = '/' . GeneralUtility::fixed_lgd_cs(strip_tags($record['title']), $titleLimit) . $output;
470 if ($fullTitleLimit) {
471 $fullOutput = '/' . GeneralUtility::fixed_lgd_cs(strip_tags($record['title']), $fullTitleLimit) . $fullOutput;
472 }
473 }
474 if ($fullTitleLimit) {
475 return array($output, $fullOutput);
476 } else {
477 return $output;
478 }
479 }
480
481 /**
482 * Returns an array with the exclude-fields as defined in TCA and FlexForms
483 * Used for listing the exclude-fields in be_groups forms
484 *
485 * @return array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)
486 */
487 static public function getExcludeFields() {
488 $finalExcludeArray = array();
489
490 // Fetch translations for table names
491 $tableToTranslation = array();
492 $lang = static::getLanguageService();
493 // All TCA keys
494 foreach ($GLOBALS['TCA'] as $table => $conf) {
495 $tableToTranslation[$table] = $lang->sl($conf['ctrl']['title']);
496 }
497 // Sort by translations
498 asort($tableToTranslation);
499 foreach ($tableToTranslation as $table => $translatedTable) {
500 $excludeArrayTable = array();
501
502 // All field names configured and not restricted to admins
503 if (is_array($GLOBALS['TCA'][$table]['columns'])
504 && empty($GLOBALS['TCA'][$table]['ctrl']['adminOnly'])
505 && (empty($GLOBALS['TCA'][$table]['ctrl']['rootLevel']) || !empty($GLOBALS['TCA'][$table]['ctrl']['security']['ignoreRootLevelRestriction']))
506 ) {
507 foreach ($GLOBALS['TCA'][$table]['columns'] as $field => $_) {
508 if ($GLOBALS['TCA'][$table]['columns'][$field]['exclude']) {
509 // Get human readable names of fields
510 $translatedField = $lang->sl($GLOBALS['TCA'][$table]['columns'][$field]['label']);
511 // Add entry
512 $excludeArrayTable[] = array($translatedTable . ': ' . $translatedField, $table . ':' . $field);
513 }
514 }
515 }
516 // All FlexForm fields
517 $flexFormArray = static::getRegisteredFlexForms($table);
518 foreach ($flexFormArray as $tableField => $flexForms) {
519 // Prefix for field label, e.g. "Plugin Options:"
520 $labelPrefix = '';
521 if (!empty($GLOBALS['TCA'][$table]['columns'][$tableField]['label'])) {
522 $labelPrefix = $lang->sl($GLOBALS['TCA'][$table]['columns'][$tableField]['label']);
523 }
524 // Get all sheets and title
525 foreach ($flexForms as $extIdent => $extConf) {
526 $extTitle = $lang->sl($extConf['title']);
527 // Get all fields in sheet
528 foreach ($extConf['ds']['sheets'] as $sheetName => $sheet) {
529 if (empty($sheet['ROOT']['el']) || !is_array($sheet['ROOT']['el'])) {
530 continue;
531 }
532 foreach ($sheet['ROOT']['el'] as $fieldName => $field) {
533 // Use only excludeable fields
534 if (empty($field['TCEforms']['exclude'])) {
535 continue;
536 }
537 $fieldLabel = !empty($field['TCEforms']['label']) ? $lang->sl($field['TCEforms']['label']) : $fieldName;
538 $fieldIdent = $table . ':' . $tableField . ';' . $extIdent . ';' . $sheetName . ';' . $fieldName;
539 $excludeArrayTable[] = array(trim(($labelPrefix . ' ' . $extTitle), ': ') . ': ' . $fieldLabel, $fieldIdent);
540 }
541 }
542 }
543 }
544 // Sort fields by the translated value
545 if (count($excludeArrayTable) > 0) {
546 usort($excludeArrayTable, array(\TYPO3\CMS\Backend\Form\FlexFormsHelper::class, 'compareArraysByFirstValue'));
547 $finalExcludeArray = array_merge($finalExcludeArray, $excludeArrayTable);
548 }
549 }
550
551 return $finalExcludeArray;
552 }
553
554 /**
555 * Returns an array with explicit Allow/Deny fields.
556 * Used for listing these field/value pairs in be_groups forms
557 *
558 * @return array Array with information from all of $GLOBALS['TCA']
559 */
560 static public function getExplicitAuthFieldValues() {
561 // Initialize:
562 $lang = static::getLanguageService();
563 $adLabel = array(
564 'ALLOW' => $lang->sl('LLL:EXT:lang/locallang_core.xlf:labels.allow'),
565 'DENY' => $lang->sl('LLL:EXT:lang/locallang_core.xlf:labels.deny')
566 );
567 // All TCA keys:
568 $allowDenyOptions = array();
569 foreach ($GLOBALS['TCA'] as $table => $_) {
570 // All field names configured:
571 if (is_array($GLOBALS['TCA'][$table]['columns'])) {
572 foreach ($GLOBALS['TCA'][$table]['columns'] as $field => $_) {
573 $fCfg = $GLOBALS['TCA'][$table]['columns'][$field]['config'];
574 if ($fCfg['type'] == 'select' && $fCfg['authMode']) {
575 // Check for items:
576 if (is_array($fCfg['items'])) {
577 // Get Human Readable names of fields and table:
578 $allowDenyOptions[$table . ':' . $field]['tableFieldLabel'] =
579 $lang->sl($GLOBALS['TCA'][$table]['ctrl']['title']) . ': '
580 . $lang->sl($GLOBALS['TCA'][$table]['columns'][$field]['label']);
581 // Check for items:
582 foreach ($fCfg['items'] as $iVal) {
583 // Values '' is not controlled by this setting.
584 if ((string)$iVal[1] !== '') {
585 // Find iMode
586 $iMode = '';
587 switch ((string)$fCfg['authMode']) {
588 case 'explicitAllow':
589 $iMode = 'ALLOW';
590 break;
591 case 'explicitDeny':
592 $iMode = 'DENY';
593 break;
594 case 'individual':
595 if ($iVal[4] === 'EXPL_ALLOW') {
596 $iMode = 'ALLOW';
597 } elseif ($iVal[4] === 'EXPL_DENY') {
598 $iMode = 'DENY';
599 }
600 break;
601 }
602 // Set iMode
603 if ($iMode) {
604 $allowDenyOptions[$table . ':' . $field]['items'][$iVal[1]] = array($iMode, $lang->sl($iVal[0]), $adLabel[$iMode]);
605 }
606 }
607 }
608 }
609 }
610 }
611 }
612 }
613 return $allowDenyOptions;
614 }
615
616 /**
617 * Returns an array with system languages:
618 *
619 * The property flagIcon returns a string <flags-xx>. The calling party should call
620 * \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon(<flags-xx>) to get an HTML
621 * which will represent the flag of this language.
622 *
623 * @return array Array with languages (title, uid, flagIcon - used with IconUtility::getSpriteIcon)
624 */
625 static public function getSystemLanguages() {
626 /** @var TranslationConfigurationProvider $translationConfigurationProvider */
627 $translationConfigurationProvider = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider::class);
628 $languages = $translationConfigurationProvider->getSystemLanguages();
629 $sysLanguages = array();
630 foreach ($languages as $language) {
631 if ($language['uid'] !== -1) {
632 $sysLanguages[] = array(
633 0 => htmlspecialchars($language['title']) . ' [' . $language['uid'] . ']',
634 1 => $language['uid'],
635 2 => $language['flagIcon']
636 );
637 }
638 }
639 return $sysLanguages;
640 }
641
642 /**
643 * Gets the original translation pointer table.
644 * For e.g. pages_language_overlay this would be pages.
645 *
646 * @param string $table Name of the table
647 * @return string Pointer table (if any)
648 */
649 static public function getOriginalTranslationTable($table) {
650 if (!empty($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerTable'])) {
651 $table = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerTable'];
652 }
653
654 return $table;
655 }
656
657 /**
658 * Determines whether a table is localizable and has the languageField and transOrigPointerField set in $GLOBALS['TCA'].
659 *
660 * @param string $table The table to check
661 * @return bool Whether a table is localizable
662 */
663 static public function isTableLocalizable($table) {
664 $isLocalizable = FALSE;
665 if (isset($GLOBALS['TCA'][$table]['ctrl']) && is_array($GLOBALS['TCA'][$table]['ctrl'])) {
666 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
667 $isLocalizable = isset($tcaCtrl['languageField']) && $tcaCtrl['languageField'] && isset($tcaCtrl['transOrigPointerField']) && $tcaCtrl['transOrigPointerField'];
668 }
669 return $isLocalizable;
670 }
671
672 /**
673 * Returns the value of the property localizationMode in the given $config array ($GLOBALS['TCA'][<table>]['columns'][<field>]['config']).
674 * If the table is prepared for localization and no localizationMode is set, 'select' is returned by default.
675 * If the table is not prepared for localization or not defined at all in $GLOBALS['TCA'], FALSE is returned.
676 *
677 * @param string $table The name of the table to lookup in TCA
678 * @param mixed $fieldOrConfig The fieldname (string) or the configuration of the field to check (array)
679 * @return mixed If table is localizable, the set localizationMode is returned (if property is not set, 'select' is returned by default); if table is not localizable, FALSE is returned
680 */
681 static public function getInlineLocalizationMode($table, $fieldOrConfig) {
682 $localizationMode = FALSE;
683 $config = NULL;
684 if (is_array($fieldOrConfig) && !empty($fieldOrConfig)) {
685 $config = $fieldOrConfig;
686 } elseif (is_string($fieldOrConfig) && isset($GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'])) {
687 $config = $GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'];
688 }
689 if (is_array($config) && isset($config['type']) && $config['type'] === 'inline' && self::isTableLocalizable($table)) {
690 $localizationMode = isset($config['behaviour']['localizationMode']) && $config['behaviour']['localizationMode']
691 ? $config['behaviour']['localizationMode']
692 : 'select';
693 // The mode 'select' is not possible when child table is not localizable at all:
694 if ($localizationMode === 'select' && !self::isTableLocalizable($config['foreign_table'])) {
695 $localizationMode = FALSE;
696 }
697 }
698 return $localizationMode;
699 }
700
701 /**
702 * Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not.
703 * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
704 * In any case ->isInWebMount must return TRUE for the user (regardless of $perms_clause)
705 *
706 * @param int $id Page uid for which to check read-access
707 * @param string $perms_clause This is typically a value generated with static::getBackendUserAuthentication()->getPagePermsClause(1);
708 * @return array Returns page record if OK, otherwise FALSE.
709 */
710 static public function readPageAccess($id, $perms_clause) {
711 if ((string)$id !== '') {
712 $id = (int)$id;
713 if (!$id) {
714 if (static::getBackendUserAuthentication()->isAdmin()) {
715 $path = '/';
716 $pageinfo['_thePath'] = $path;
717 return $pageinfo;
718 }
719 } else {
720 $pageinfo = self::getRecord('pages', $id, '*', $perms_clause ? ' AND ' . $perms_clause : '');
721 if ($pageinfo['uid'] && static::getBackendUserAuthentication()->isInWebMount($id, $perms_clause)) {
722 self::workspaceOL('pages', $pageinfo);
723 if (is_array($pageinfo)) {
724 self::fixVersioningPid('pages', $pageinfo);
725 list($pageinfo['_thePath'], $pageinfo['_thePathFull']) = self::getRecordPath((int)$pageinfo['uid'], $perms_clause, 15, 1000);
726 return $pageinfo;
727 }
728 }
729 }
730 }
731 return FALSE;
732 }
733
734 /**
735 * Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
736 *
737 * @param string $table Table name (present in TCA)
738 * @param array $rec Record from $table
739 * @param bool $useFieldNameAsKey If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
740 * @return array|NULL
741 */
742 static public function getTCAtypes($table, $rec, $useFieldNameAsKey = FALSE) {
743 if ($GLOBALS['TCA'][$table]) {
744 // Get type value:
745 $fieldValue = self::getTCAtypeValue($table, $rec);
746 $cacheIdentifier = $table . '-type-' . $fieldValue . '-fnk-' . $useFieldNameAsKey;
747
748 // Fetch from first-level-cache if available
749 if (isset(self::$tcaTableTypeConfigurationCache[$cacheIdentifier])) {
750 return self::$tcaTableTypeConfigurationCache[$cacheIdentifier];
751 }
752
753 // Get typesConf
754 $typesConf = $GLOBALS['TCA'][$table]['types'][$fieldValue];
755 // Get fields list and traverse it
756 $fieldList = explode(',', $typesConf['showitem']);
757
758 // Add subtype fields e.g. for a valid RTE transformation
759 // The RTE runs the DB -> RTE transformation only, if the RTE field is part of the getTCAtypes array
760 if (isset($typesConf['subtype_value_field'])) {
761 $subType = $rec[$typesConf['subtype_value_field']];
762 if (isset($typesConf['subtypes_addlist'][$subType])) {
763 $subFields = GeneralUtility::trimExplode(',', $typesConf['subtypes_addlist'][$subType], TRUE);
764 $fieldList = array_merge($fieldList, $subFields);
765 }
766 }
767
768 $altFieldList = array();
769 // Traverse fields in types config and parse the configuration into a nice array:
770 foreach ($fieldList as $k => $v) {
771 list($pFieldName, $pAltTitle, $pPalette, $pSpec) = GeneralUtility::trimExplode(';', $v);
772 $defaultExtras = is_array($GLOBALS['TCA'][$table]['columns'][$pFieldName]) ? $GLOBALS['TCA'][$table]['columns'][$pFieldName]['defaultExtras'] : '';
773 $specConfParts = self::getSpecConfParts($pSpec, $defaultExtras);
774 $fieldList[$k] = array(
775 'field' => $pFieldName,
776 'title' => $pAltTitle,
777 'palette' => $pPalette,
778 'spec' => $specConfParts,
779 'origString' => $v
780 );
781 if ($useFieldNameAsKey) {
782 $altFieldList[$fieldList[$k]['field']] = $fieldList[$k];
783 }
784 }
785 if ($useFieldNameAsKey) {
786 $fieldList = $altFieldList;
787 }
788
789 // Add to first-level-cache
790 self::$tcaTableTypeConfigurationCache[$cacheIdentifier] = $fieldList;
791
792 // Return array:
793 return $fieldList;
794 }
795 return NULL;
796 }
797
798 /**
799 * Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $GLOBALS['TCA']
800 * If no "type" field is configured in the "ctrl"-section of the $GLOBALS['TCA'] for the table, zero is used.
801 * If zero is not an index in the "types" section of $GLOBALS['TCA'] for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)
802 *
803 * Note: This method is very similar to \TYPO3\CMS\Backend\Form\FormEngine::getRTypeNum(),
804 * however, it has two differences:
805 * 1) The method in TCEForms also takes care of localization (which is difficult to do here as the whole infrastructure for language overlays is only in TCEforms).
806 * 2) The $rec array looks different in TCEForms, as in there it's not the raw record but the \TYPO3\CMS\Backend\Form\DataPreprocessor version of it, which changes e.g. how "select"
807 * and "group" field values are stored, which makes different processing of the "foreign pointer field" type field variant necessary.
808 *
809 * @param string $table Table name present in TCA
810 * @param array $row Record from $table
811 * @throws \RuntimeException
812 * @return string Field value
813 * @see getTCAtypes()
814 */
815 static public function getTCAtypeValue($table, $row) {
816 $typeNum = 0;
817 if ($GLOBALS['TCA'][$table]) {
818 $field = $GLOBALS['TCA'][$table]['ctrl']['type'];
819 if (strpos($field, ':') !== FALSE) {
820 list($pointerField, $foreignTableTypeField) = explode(':', $field);
821 // Get field value from database if field is not in the $row array
822 if (!isset($row[$pointerField])) {
823 $localRow = self::getRecord($table, $row['uid'], $pointerField);
824 $foreignUid = $localRow[$pointerField];
825 } else {
826 $foreignUid = $row[$pointerField];
827 }
828 if ($foreignUid) {
829 $fieldConfig = $GLOBALS['TCA'][$table]['columns'][$pointerField]['config'];
830 $relationType = $fieldConfig['type'];
831 if ($relationType === 'select') {
832 $foreignTable = $fieldConfig['foreign_table'];
833 } elseif ($relationType === 'group') {
834 $allowedTables = explode(',', $fieldConfig['allowed']);
835 $foreignTable = $allowedTables[0];
836 } else {
837 throw new \RuntimeException('TCA foreign field pointer fields are only allowed to be used with group or select field types.', 1325862240);
838 }
839 $foreignRow = self::getRecord($foreignTable, $foreignUid, $foreignTableTypeField);
840 if ($foreignRow[$foreignTableTypeField]) {
841 $typeNum = $foreignRow[$foreignTableTypeField];
842 }
843 }
844 } else {
845 $typeNum = $row[$field];
846 }
847 // If that value is an empty string, set it to "0" (zero)
848 if (empty($typeNum)) {
849 $typeNum = 0;
850 }
851 }
852 // If current typeNum doesn't exist, set it to 0 (or to 1 for historical reasons, if 0 doesn't exist)
853 if (!$GLOBALS['TCA'][$table]['types'][$typeNum]) {
854 $typeNum = $GLOBALS['TCA'][$table]['types']['0'] ? 0 : 1;
855 }
856 // Force to string. Necessary for eg '-1' to be recognized as a type value.
857 $typeNum = (string)$typeNum;
858 return $typeNum;
859 }
860
861 /**
862 * Parses a part of the field lists in the "types"-section of $GLOBALS['TCA'] arrays, namely the "special configuration" at index 3 (position 4)
863 * Elements are splitted by ":" and within those parts, parameters are splitted by "|".
864 * Everything is returned in an array and you should rather see it visually than listen to me anymore now... Check out example in Inside TYPO3
865 *
866 * @param string $str Content from the "types" configuration of TCA (the special configuration) - see description of function
867 * @param string $defaultExtras The ['defaultExtras'] value from field configuration
868 * @return array
869 */
870 static public function getSpecConfParts($str, $defaultExtras) {
871 // Add defaultExtras:
872 $specConfParts = GeneralUtility::trimExplode(':', $defaultExtras . ':' . $str, TRUE);
873 $reg = array();
874 if (count($specConfParts)) {
875 foreach ($specConfParts as $k2 => $v2) {
876 unset($specConfParts[$k2]);
877 if (preg_match('/(.*)\\[(.*)\\]/', $v2, $reg)) {
878 $specConfParts[trim($reg[1])] = array(
879 'parameters' => GeneralUtility::trimExplode('|', $reg[2], TRUE)
880 );
881 } else {
882 $specConfParts[trim($v2)] = 1;
883 }
884 }
885 } else {
886 $specConfParts = array();
887 }
888 return $specConfParts;
889 }
890
891 /**
892 * Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value.
893 * Better see it in action! Find example in Inside TYPO3
894 *
895 * @param array $pArr Array of "[key] = [value]" strings to convert.
896 * @return array
897 */
898 static public function getSpecConfParametersFromArray($pArr) {
899 $out = array();
900 if (is_array($pArr)) {
901 foreach ($pArr as $k => $v) {
902 $parts = explode('=', $v, 2);
903 if (count($parts) == 2) {
904 $out[trim($parts[0])] = trim($parts[1]);
905 } else {
906 $out[$k] = $v;
907 }
908 }
909 }
910 return $out;
911 }
912
913 /**
914 * Finds the Data Structure for a FlexForm field
915 *
916 * NOTE ON data structures for deleted records: This function may fail to deliver the data structure
917 * for a record for a few reasons:
918 * a) The data structure could be deleted (either with deleted-flagged or hard-deleted),
919 * b) the data structure is fetched using the ds_pointerField_searchParent in which case any
920 * deleted record on the route to the final location of the DS will make it fail.
921 * In theory, we can solve the problem in the case where records that are deleted-flagged keeps us
922 * from finding the DS - this is done at the markers ###NOTE_A### where we make sure to also select deleted records.
923 * However, we generally want the DS lookup to fail for deleted records since for the working website we expect a
924 * deleted-flagged record to be as inaccessible as one that is completely deleted from the DB. Any way we look
925 * at it, this may lead to integrity problems of the reference index and even lost files if attached.
926 * However, that is not really important considering that a single change to a data structure can instantly
927 * invalidate large amounts of the reference index which we do accept as a cost for the flexform features.
928 * Other than requiring a reference index update, deletion of/changes in data structure or the failure to look
929 * them up when completely deleting records may lead to lost files in the uploads/ folders since those are now
930 * without a proper reference.
931 *
932 * @param array $conf Field config array
933 * @param array $row Record data
934 * @param string $table The table name
935 * @param string $fieldName Optional fieldname passed to hook object
936 * @param bool $WSOL If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a TRUE reflection of how things are in the live workspace.
937 * @param int $newRecordPidValue SPECIAL CASES: Use this, if the DataStructure may come from a parent record and the INPUT row doesn't have a uid yet (hence, the pid cannot be looked up). Then it is necessary to supply a PID value to search recursively in for the DS (used from TCEmain)
938 * @return mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.
939 * @see \TYPO3\CMS\Backend\Form\FormEngine::getSingleField_typeFlex()
940 */
941 static public function getFlexFormDS($conf, $row, $table, $fieldName = '', $WSOL = TRUE, $newRecordPidValue = 0) {
942 // Get pointer field etc from TCA-config:
943 $ds_pointerField = $conf['ds_pointerField'];
944 $ds_array = $conf['ds'];
945 $ds_tableField = $conf['ds_tableField'];
946 $ds_searchParentField = $conf['ds_pointerField_searchParent'];
947 // If there is a data source array, that takes precedence
948 if (is_array($ds_array)) {
949 // If a pointer field is set, take the value from that field in the $row array and use as key.
950 if ($ds_pointerField) {
951 // Up to two pointer fields can be specified in a comma separated list.
952 $pointerFields = GeneralUtility::trimExplode(',', $ds_pointerField);
953 // If we have two pointer fields, the array keys should contain both field values separated by comma. The asterisk "*" catches all values. For backwards compatibility, it's also possible to specify only the value of the first defined ds_pointerField.
954 if (count($pointerFields) == 2) {
955 if ($ds_array[$row[$pointerFields[0]] . ',' . $row[$pointerFields[1]]]) {
956 // Check if we have a DS for the combination of both pointer fields values
957 $srcPointer = $row[$pointerFields[0]] . ',' . $row[$pointerFields[1]];
958 } elseif ($ds_array[$row[$pointerFields[1]] . ',*']) {
959 // Check if we have a DS for the value of the first pointer field suffixed with ",*"
960 $srcPointer = $row[$pointerFields[1]] . ',*';
961 } elseif ($ds_array['*,' . $row[$pointerFields[1]]]) {
962 // Check if we have a DS for the value of the second pointer field prefixed with "*,"
963 $srcPointer = '*,' . $row[$pointerFields[1]];
964 } elseif ($ds_array[$row[$pointerFields[0]]]) {
965 // Check if we have a DS for just the value of the first pointer field (mainly for backwards compatibility)
966 $srcPointer = $row[$pointerFields[0]];
967 } else {
968 $srcPointer = NULL;
969 }
970 } else {
971 $srcPointer = $row[$pointerFields[0]];
972 }
973 $srcPointer = $srcPointer !== NULL && isset($ds_array[$srcPointer]) ? $srcPointer : 'default';
974 } else {
975 $srcPointer = 'default';
976 }
977 // Get Data Source: Detect if it's a file reference and in that case read the file and parse as XML. Otherwise the value is expected to be XML.
978 if (substr($ds_array[$srcPointer], 0, 5) == 'FILE:') {
979 $file = GeneralUtility::getFileAbsFileName(substr($ds_array[$srcPointer], 5));
980 if ($file && @is_file($file)) {
981 $dataStructArray = GeneralUtility::xml2array(GeneralUtility::getUrl($file));
982 } else {
983 $dataStructArray = 'The file "' . substr($ds_array[$srcPointer], 5) . '" in ds-array key "' . $srcPointer . '" was not found ("' . $file . '")';
984 }
985 } else {
986 $dataStructArray = GeneralUtility::xml2array($ds_array[$srcPointer]);
987 }
988 } elseif ($ds_pointerField) {
989 // If pointer field AND possibly a table/field is set:
990 // Value of field pointed to:
991 $srcPointer = $row[$ds_pointerField];
992 // Searching recursively back if 'ds_pointerField_searchParent' is defined (typ. a page rootline, or maybe a tree-table):
993 if ($ds_searchParentField && !$srcPointer) {
994 $rr = self::getRecord($table, $row['uid'], 'uid,' . $ds_searchParentField);
995 // Get the "pid" field - we cannot know that it is in the input record! ###NOTE_A###
996 if ($WSOL) {
997 self::workspaceOL($table, $rr);
998 self::fixVersioningPid($table, $rr, TRUE);
999 }
1000 $db = static::getDatabaseConnection();
1001 $uidAcc = array();
1002 // Used to avoid looping, if any should happen.
1003 $subFieldPointer = $conf['ds_pointerField_searchParent_subField'];
1004 while (!$srcPointer) {
1005 $res = $db->exec_SELECTquery('uid,' . $ds_pointerField . ',' . $ds_searchParentField . ($subFieldPointer ? ',' . $subFieldPointer : ''), $table, 'uid=' . (int)($newRecordPidValue ?: $rr[$ds_searchParentField]) . self::deleteClause($table));
1006 $newRecordPidValue = 0;
1007 $rr = $db->sql_fetch_assoc($res);
1008 $db->sql_free_result($res);
1009 // Break if no result from SQL db or if looping...
1010 if (!is_array($rr) || isset($uidAcc[$rr['uid']])) {
1011 break;
1012 }
1013 $uidAcc[$rr['uid']] = 1;
1014 if ($WSOL) {
1015 self::workspaceOL($table, $rr);
1016 self::fixVersioningPid($table, $rr, TRUE);
1017 }
1018 $srcPointer = $subFieldPointer && $rr[$subFieldPointer] ? $rr[$subFieldPointer] : $rr[$ds_pointerField];
1019 }
1020 }
1021 // If there is a srcPointer value:
1022 if ($srcPointer) {
1023 if (MathUtility::canBeInterpretedAsInteger($srcPointer)) {
1024 // If integer, then its a record we will look up:
1025 list($tName, $fName) = explode(':', $ds_tableField, 2);
1026 if ($tName && $fName && is_array($GLOBALS['TCA'][$tName])) {
1027 $dataStructRec = self::getRecord($tName, $srcPointer);
1028 if ($WSOL) {
1029 self::workspaceOL($tName, $dataStructRec);
1030 }
1031 if (strpos($dataStructRec[$fName], '<') === FALSE) {
1032 if (is_file(PATH_site . $dataStructRec[$fName])) {
1033 // The value is a pointer to a file
1034 $dataStructArray = GeneralUtility::xml2array(GeneralUtility::getUrl(PATH_site . $dataStructRec[$fName]));
1035 } else {
1036 $dataStructArray = sprintf('File \'%s\' was not found', $dataStructRec[$fName]);
1037 }
1038 } else {
1039 // No file pointer, handle as being XML (default behaviour)
1040 $dataStructArray = GeneralUtility::xml2array($dataStructRec[$fName]);
1041 }
1042 } else {
1043 $dataStructArray = 'No tablename (' . $tName . ') or fieldname (' . $fName . ') was found an valid!';
1044 }
1045 } else {
1046 // Otherwise expect it to be a file:
1047 $file = GeneralUtility::getFileAbsFileName($srcPointer);
1048 if ($file && @is_file($file)) {
1049 $dataStructArray = GeneralUtility::xml2array(GeneralUtility::getUrl($file));
1050 } else {
1051 // Error message.
1052 $dataStructArray = 'The file "' . $srcPointer . '" was not found ("' . $file . '")';
1053 }
1054 }
1055 } else {
1056 // Error message.
1057 $dataStructArray = 'No source value in fieldname "' . $ds_pointerField . '"';
1058 }
1059 } else {
1060 $dataStructArray = 'No proper configuration!';
1061 }
1062 // Hook for post-processing the Flexform DS. Introduces the possibility to configure Flexforms via TSConfig
1063 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'])) {
1064 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'] as $classRef) {
1065 $hookObj = GeneralUtility::getUserObj($classRef);
1066 if (method_exists($hookObj, 'getFlexFormDS_postProcessDS')) {
1067 $hookObj->getFlexFormDS_postProcessDS($dataStructArray, $conf, $row, $table, $fieldName);
1068 }
1069 }
1070 }
1071 return $dataStructArray;
1072 }
1073
1074 /**
1075 * Returns all registered FlexForm definitions with title and fields
1076 *
1077 * @param string $table The content table
1078 * @return array The data structures with speaking extension title
1079 * @see \TYPO3\CMS\Backend\Utility\BackendUtility::getExcludeFields()
1080 */
1081 static public function getRegisteredFlexForms($table = 'tt_content') {
1082 if (empty($table) || empty($GLOBALS['TCA'][$table]['columns'])) {
1083 return array();
1084 }
1085 $flexForms = array();
1086 foreach ($GLOBALS['TCA'][$table]['columns'] as $tableField => $fieldConf) {
1087 if (!empty($fieldConf['config']['type']) && !empty($fieldConf['config']['ds']) && $fieldConf['config']['type'] == 'flex') {
1088 $flexForms[$tableField] = array();
1089 unset($fieldConf['config']['ds']['default']);
1090 // Get pointer fields
1091 $pointerFields = !empty($fieldConf['config']['ds_pointerField']) ? $fieldConf['config']['ds_pointerField'] : 'list_type,CType';
1092 $pointerFields = GeneralUtility::trimExplode(',', $pointerFields);
1093 // Get FlexForms
1094 foreach ($fieldConf['config']['ds'] as $flexFormKey => $dataStruct) {
1095 // Get extension identifier (uses second value if it's not empty, "list" or "*", else first one)
1096 $identFields = GeneralUtility::trimExplode(',', $flexFormKey);
1097 $extIdent = $identFields[0];
1098 if (!empty($identFields[1]) && $identFields[1] != 'list' && $identFields[1] != '*') {
1099 $extIdent = $identFields[1];
1100 }
1101 // Load external file references
1102 if (!is_array($dataStruct)) {
1103 $file = GeneralUtility::getFileAbsFileName(str_ireplace('FILE:', '', $dataStruct));
1104 if ($file && @is_file($file)) {
1105 $dataStruct = GeneralUtility::getUrl($file);
1106 }
1107 $dataStruct = GeneralUtility::xml2array($dataStruct);
1108 if (!is_array($dataStruct)) {
1109 continue;
1110 }
1111 }
1112 // Get flexform content
1113 $dataStruct = GeneralUtility::resolveAllSheetsInDS($dataStruct);
1114 if (empty($dataStruct['sheets']) || !is_array($dataStruct['sheets'])) {
1115 continue;
1116 }
1117 // Use DS pointer to get extension title from TCA
1118 $title = $extIdent;
1119 $keyFields = GeneralUtility::trimExplode(',', $flexFormKey);
1120 foreach ($pointerFields as $pointerKey => $pointerName) {
1121 if (empty($keyFields[$pointerKey]) || $keyFields[$pointerKey] == '*' || $keyFields[$pointerKey] == 'list') {
1122 continue;
1123 }
1124 if (!empty($GLOBALS['TCA'][$table]['columns'][$pointerName]['config']['items'])) {
1125 $items = $GLOBALS['TCA'][$table]['columns'][$pointerName]['config']['items'];
1126 if (!is_array($items)) {
1127 continue;
1128 }
1129 foreach ($items as $itemConf) {
1130 if (!empty($itemConf[0]) && !empty($itemConf[1]) && $itemConf[1] == $keyFields[$pointerKey]) {
1131 $title = $itemConf[0];
1132 break 2;
1133 }
1134 }
1135 }
1136 }
1137 $flexForms[$tableField][$extIdent] = array(
1138 'title' => $title,
1139 'ds' => $dataStruct
1140 );
1141 }
1142 }
1143 }
1144 return $flexForms;
1145 }
1146
1147 /*******************************************
1148 *
1149 * Caching related
1150 *
1151 *******************************************/
1152 /**
1153 * Stores $data in the 'cache_hash' cache with the hash key, $hash
1154 * and visual/symbolic identification, $ident
1155 *
1156 * IDENTICAL to the function by same name found in \TYPO3\CMS\Frontend\Page\PageRepository
1157 *
1158 * @param string $hash 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
1159 * @param mixed $data The data to store
1160 * @param string $ident $ident is just a textual identification in order to inform about the content!
1161 * @return void
1162 */
1163 static public function storeHash($hash, $data, $ident) {
1164 /** @var CacheManager $cacheManager */
1165 $cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
1166 $cacheManager->getCache('cache_hash')->set($hash, $data, array('ident_' . $ident), 0);
1167 }
1168
1169 /**
1170 * Returns data stored for the hash string in the cache "cache_hash"
1171 * Can be used to retrieved a cached value, array or object
1172 *
1173 * IDENTICAL to the function by same name found in \TYPO3\CMS\Frontend\Page\PageRepository
1174 *
1175 * @param string $hash The hash-string which was used to store the data value
1176 * @return mixed The "data" from the cache
1177 */
1178 static public function getHash($hash) {
1179 /** @var CacheManager $cacheManager */
1180 $cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
1181 $cacheEntry = $cacheManager->getCache('cache_hash')->get($hash);
1182 $hashContent = NULL;
1183 if ($cacheEntry) {
1184 $hashContent = $cacheEntry;
1185 }
1186 return $hashContent;
1187 }
1188
1189 /*******************************************
1190 *
1191 * TypoScript related
1192 *
1193 *******************************************/
1194 /**
1195 * Returns the Page TSconfig for page with id, $id
1196 *
1197 * @param int $id Page uid for which to create Page TSconfig
1198 * @param array $rootLine If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
1199 * @param bool $returnPartArray If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser.
1200 * @return array Page TSconfig
1201 * @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
1202 */
1203 static public function getPagesTSconfig($id, $rootLine = NULL, $returnPartArray = FALSE) {
1204 static $pagesTSconfig_cacheReference = array();
1205 static $combinedTSconfig_cache = array();
1206
1207 $id = (int)$id;
1208 if ($returnPartArray === FALSE
1209 && $rootLine === NULL
1210 && isset($pagesTSconfig_cacheReference[$id])
1211 ) {
1212 return $combinedTSconfig_cache[$pagesTSconfig_cacheReference[$id]];
1213 } else {
1214 $TSconfig = array();
1215 if (!is_array($rootLine)) {
1216 $useCacheForCurrentPageId = TRUE;
1217 $rootLine = self::BEgetRootLine($id, '', TRUE);
1218 } else {
1219 $useCacheForCurrentPageId = FALSE;
1220 }
1221
1222 // Order correctly
1223 ksort($rootLine);
1224 $TSdataArray = array();
1225 // Setting default configuration
1226 $TSdataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'];
1227 foreach ($rootLine as $k => $v) {
1228 $TSdataArray['uid_' . $v['uid']] = $v['TSconfig'];
1229 }
1230 $TSdataArray = static::emitGetPagesTSconfigPreIncludeSignal($TSdataArray, $id, $rootLine, $returnPartArray);
1231 $TSdataArray = TypoScriptParser::checkIncludeLines_array($TSdataArray);
1232 if ($returnPartArray) {
1233 return $TSdataArray;
1234 }
1235 // Parsing the page TS-Config
1236 $pageTS = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
1237 /* @var $parseObj \TYPO3\CMS\Backend\Configuration\TsConfigParser */
1238 $parseObj = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TsConfigParser::class);
1239 $res = $parseObj->parseTSconfig($pageTS, 'PAGES', $id, $rootLine);
1240 if ($res) {
1241 $TSconfig = $res['TSconfig'];
1242 }
1243 $cacheHash = $res['hash'];
1244 // Get User TSconfig overlay
1245 $userTSconfig = static::getBackendUserAuthentication()->userTS['page.'];
1246 if (is_array($userTSconfig)) {
1247 ArrayUtility::mergeRecursiveWithOverrule($TSconfig, $userTSconfig);
1248 $cacheHash .= '_user' . $GLOBALS['BE_USER']->user['uid'];
1249 }
1250
1251 if ($useCacheForCurrentPageId) {
1252 if (!isset($combinedTSconfig_cache[$cacheHash])) {
1253 $combinedTSconfig_cache[$cacheHash] = $TSconfig;
1254 }
1255 $pagesTSconfig_cacheReference[$id] = $cacheHash;
1256 }
1257 }
1258 return $TSconfig;
1259 }
1260
1261 /**
1262 * Implodes a multi dimensional TypoScript array, $p, into a one-dimensional array (return value)
1263 *
1264 * @param array $p TypoScript structure
1265 * @param string $k Prefix string
1266 * @return array Imploded TypoScript objectstring/values
1267 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
1268 */
1269 static public function implodeTSParams($p, $k = '') {
1270 GeneralUtility::logDeprecatedFunction();
1271 $implodeParams = array();
1272 if (is_array($p)) {
1273 foreach ($p as $kb => $val) {
1274 if (is_array($val)) {
1275 $implodeParams = array_merge($implodeParams, self::implodeTSParams($val, $k . $kb));
1276 } else {
1277 $implodeParams[$k . $kb] = $val;
1278 }
1279 }
1280 }
1281 return $implodeParams;
1282 }
1283
1284 /*******************************************
1285 *
1286 * Users / Groups related
1287 *
1288 *******************************************/
1289 /**
1290 * Returns an array with be_users records of all user NOT DELETED sorted by their username
1291 * Keys in the array is the be_users uid
1292 *
1293 * @param string $fields Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
1294 * @param string $where Optional $where clause (fx. "AND username='pete'") can be used to limit query
1295 * @return array
1296 */
1297 static public function getUserNames($fields = 'username,usergroup,usergroup_cached_list,uid', $where = '') {
1298 return self::getRecordsSortedByTitle(
1299 GeneralUtility::trimExplode(',', $fields, TRUE),
1300 'be_users',
1301 'username',
1302 'AND pid=0 ' . $where
1303 );
1304 }
1305
1306 /**
1307 * Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
1308 *
1309 * @param string $fields Field list
1310 * @param string $where WHERE clause
1311 * @return array
1312 */
1313 static public function getGroupNames($fields = 'title,uid', $where = '') {
1314 return self::getRecordsSortedByTitle(
1315 GeneralUtility::trimExplode(',', $fields, TRUE),
1316 'be_groups',
1317 'title',
1318 'AND pid=0 ' . $where
1319 );
1320 }
1321
1322 /**
1323 * Returns an array of all non-deleted records of a table sorted by a given title field.
1324 * The value of the title field will be replaced by the return value
1325 * of self::getRecordTitle() before the sorting is performed.
1326 *
1327 * @param array $fields Fields to select
1328 * @param string $table Table name
1329 * @param string $titleField Field that will contain the record title
1330 * @param string $where Additional where clause
1331 * @return array Array of sorted records
1332 */
1333 static protected function getRecordsSortedByTitle(array $fields, $table, $titleField, $where = '') {
1334 $fieldsIndex = array_flip($fields);
1335 // Make sure the titleField is amongst the fields when getting sorted
1336 $fieldsIndex[$titleField] = 1;
1337
1338 $result = array();
1339 $db = static::getDatabaseConnection();
1340 $res = $db->exec_SELECTquery('*', $table, '1=1 ' . $where . self::deleteClause($table));
1341 while ($record = $db->sql_fetch_assoc($res)) {
1342 // store the uid, because it might be unset if it's not among the requested $fields
1343 $recordId = $record['uid'];
1344 $record[$titleField] = self::getRecordTitle($table, $record);
1345
1346 // include only the requested fields in the result
1347 $result[$recordId] = array_intersect_key($record, $fieldsIndex);
1348 }
1349 $db->sql_free_result($res);
1350
1351 // sort records by $sortField. This is not done in the query because the title might have been overwritten by
1352 // self::getRecordTitle();
1353 return ArrayUtility::sortArraysByKey($result, $titleField);
1354 }
1355
1356 /**
1357 * Returns an array with be_groups records (like ->getGroupNames) but:
1358 * - if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned.
1359 *
1360 * @param string $fields Field list; $fields specify the fields selected (default: title,uid)
1361 * @return array
1362 */
1363 static public function getListGroupNames($fields = 'title, uid') {
1364 $beUser = static::getBackendUserAuthentication();
1365 $exQ = ' AND hide_in_lists=0';
1366 if (!$beUser->isAdmin()) {
1367 $exQ .= ' AND uid IN (' . ($beUser->user['usergroup_cached_list'] ?: 0) . ')';
1368 }
1369 return self::getGroupNames($fields, $exQ);
1370 }
1371
1372 /**
1373 * Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!).
1374 * If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1375 * Takes $usernames (array made by \TYPO3\CMS\Backend\Utility\BackendUtility::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input
1376 *
1377 * @param array $usernames User names
1378 * @param array $groupArray Group names
1379 * @param bool $excludeBlindedFlag If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1380 * @return array User names, blinded
1381 */
1382 static public function blindUserNames($usernames, $groupArray, $excludeBlindedFlag = FALSE) {
1383 if (is_array($usernames) && is_array($groupArray)) {
1384 foreach ($usernames as $uid => $row) {
1385 $userN = $uid;
1386 $set = 0;
1387 if ($row['uid'] != static::getBackendUserAuthentication()->user['uid']) {
1388 foreach ($groupArray as $v) {
1389 if ($v && GeneralUtility::inList($row['usergroup_cached_list'], $v)) {
1390 $userN = $row['username'];
1391 $set = 1;
1392 }
1393 }
1394 } else {
1395 $userN = $row['username'];
1396 $set = 1;
1397 }
1398 $usernames[$uid]['username'] = $userN;
1399 if ($excludeBlindedFlag && !$set) {
1400 unset($usernames[$uid]);
1401 }
1402 }
1403 }
1404 return $usernames;
1405 }
1406
1407 /**
1408 * Corresponds to blindUserNames but works for groups instead
1409 *
1410 * @param array $groups Group names
1411 * @param array $groupArray Group names (reference)
1412 * @param bool $excludeBlindedFlag If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1413 * @return array
1414 */
1415 static public function blindGroupNames($groups, $groupArray, $excludeBlindedFlag = FALSE) {
1416 if (is_array($groups) && is_array($groupArray)) {
1417 foreach ($groups as $uid => $row) {
1418 $groupN = $uid;
1419 $set = 0;
1420 if (ArrayUtility::inArray($groupArray, $uid)) {
1421 $groupN = $row['title'];
1422 $set = 1;
1423 }
1424 $groups[$uid]['title'] = $groupN;
1425 if ($excludeBlindedFlag && !$set) {
1426 unset($groups[$uid]);
1427 }
1428 }
1429 }
1430 return $groups;
1431 }
1432
1433 /*******************************************
1434 *
1435 * Output related
1436 *
1437 *******************************************/
1438 /**
1439 * Returns the difference in days between input $tstamp and $EXEC_TIME
1440 *
1441 * @param int $tstamp Time stamp, seconds
1442 * @return int
1443 */
1444 static public function daysUntil($tstamp) {
1445 $delta_t = $tstamp - $GLOBALS['EXEC_TIME'];
1446 return ceil($delta_t / (3600 * 24));
1447 }
1448
1449 /**
1450 * Returns $tstamp formatted as "ddmmyy" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'])
1451 *
1452 * @param int $tstamp Time stamp, seconds
1453 * @return string Formatted time
1454 */
1455 static public function date($tstamp) {
1456 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], (int)$tstamp);
1457 }
1458
1459 /**
1460 * Returns $tstamp formatted as "ddmmyy hhmm" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] AND $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'])
1461 *
1462 * @param int $value Time stamp, seconds
1463 * @return string Formatted time
1464 */
1465 static public function datetime($value) {
1466 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] . ' ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'], $value);
1467 }
1468
1469 /**
1470 * Returns $value (in seconds) formatted as hh:mm:ss
1471 * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
1472 *
1473 * @param int $value Time stamp, seconds
1474 * @param bool $withSeconds Output hh:mm:ss. If FALSE: hh:mm
1475 * @return string Formatted time
1476 */
1477 static public function time($value, $withSeconds = TRUE) {
1478 $hh = floor($value / 3600);
1479 $min = floor(($value - $hh * 3600) / 60);
1480 $sec = $value - $hh * 3600 - $min * 60;
1481 $l = sprintf('%02d', $hh) . ':' . sprintf('%02d', $min);
1482 if ($withSeconds) {
1483 $l .= ':' . sprintf('%02d', $sec);
1484 }
1485 return $l;
1486 }
1487
1488 /**
1489 * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
1490 *
1491 * @param int $seconds Seconds could be the difference of a certain timestamp and time()
1492 * @param string $labels Labels should be something like ' min| hrs| days| yrs| min| hour| day| year'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears")
1493 * @return string Formatted time
1494 */
1495 static public function calcAge($seconds, $labels = ' min| hrs| days| yrs| min| hour| day| year') {
1496 $labelArr = explode('|', $labels);
1497 $absSeconds = abs($seconds);
1498 $sign = $seconds < 0 ? -1 : 1;
1499 if ($absSeconds < 3600) {
1500 $val = round($absSeconds / 60);
1501 $seconds = $sign * $val . ($val == 1 ? $labelArr[4] : $labelArr[0]);
1502 } elseif ($absSeconds < 24 * 3600) {
1503 $val = round($absSeconds / 3600);
1504 $seconds = $sign * $val . ($val == 1 ? $labelArr[5] : $labelArr[1]);
1505 } elseif ($absSeconds < 365 * 24 * 3600) {
1506 $val = round($absSeconds / (24 * 3600));
1507 $seconds = $sign * $val . ($val == 1 ? $labelArr[6] : $labelArr[2]);
1508 } else {
1509 $val = round($absSeconds / (365 * 24 * 3600));
1510 $seconds = $sign * $val . ($val == 1 ? $labelArr[7] : $labelArr[3]);
1511 }
1512 return $seconds;
1513 }
1514
1515 /**
1516 * Returns a formatted timestamp if $tstamp is set.
1517 * The date/datetime will be followed by the age in parenthesis.
1518 *
1519 * @param int $tstamp Time stamp, seconds
1520 * @param int $prefix 1/-1 depending on polarity of age.
1521 * @param string $date $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm
1522 * @return string
1523 */
1524 static public function dateTimeAge($tstamp, $prefix = 1, $date = '') {
1525 if (!$tstamp) {
1526 return '';
1527 }
1528 $label = static::getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears');
1529 $age = ' (' . self::calcAge($prefix * ($GLOBALS['EXEC_TIME'] - $tstamp), $label) . ')';
1530 return $date === 'date' ? self::date($tstamp) : self::datetime($tstamp) . $age;
1531 }
1532
1533 /**
1534 * Returns alt="" and title="" attributes with the value of $content.
1535 *
1536 * @param string $content Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
1537 * @return string
1538 */
1539 static public function titleAltAttrib($content) {
1540 $out = '';
1541 $out .= ' alt="' . htmlspecialchars($content) . '"';
1542 $out .= ' title="' . htmlspecialchars($content) . '"';
1543 return $out;
1544 }
1545
1546 /**
1547 * Resolves file references for a given record.
1548 *
1549 * @param string $tableName Name of the table of the record
1550 * @param string $fieldName Name of the field of the record
1551 * @param array $element Record data
1552 * @param NULL|int $workspaceId Workspace to fetch data for
1553 * @return NULL|\TYPO3\CMS\Core\Resource\FileReference[]
1554 */
1555 static public function resolveFileReferences($tableName, $fieldName, $element, $workspaceId = NULL) {
1556 if (empty($GLOBALS['TCA'][$tableName]['columns'][$fieldName]['config'])) {
1557 return NULL;
1558 }
1559 $configuration = $GLOBALS['TCA'][$tableName]['columns'][$fieldName]['config'];
1560 if (empty($configuration['type']) || $configuration['type'] !== 'inline'
1561 || empty($configuration['foreign_table']) || $configuration['foreign_table'] !== 'sys_file_reference') {
1562 return NULL;
1563 }
1564
1565 $fileReferences = array();
1566 /** @var $relationHandler RelationHandler */
1567 $relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
1568 if ($workspaceId !== NULL) {
1569 $relationHandler->setWorkspaceId($workspaceId);
1570 }
1571 $relationHandler->start($element[$fieldName], $configuration['foreign_table'], $configuration['MM'], $element['uid'], $tableName, $configuration);
1572 $relationHandler->processDeletePlaceholder();
1573 $referenceUids = $relationHandler->tableArray[$configuration['foreign_table']];
1574
1575 foreach ($referenceUids as $referenceUid) {
1576 try {
1577 $fileReference = ResourceFactory::getInstance()->getFileReferenceObject($referenceUid, array(), ($workspaceId === 0));
1578 $fileReferences[$fileReference->getUid()] = $fileReference;
1579 } catch (\TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException $e) {
1580 /**
1581 * We just catch the exception here
1582 * Reasoning: There is nothing an editor or even admin could do
1583 */
1584 }
1585 }
1586
1587 return $fileReferences;
1588 }
1589
1590 /**
1591 * Returns a linked image-tag for thumbnail(s)/fileicons/truetype-font-previews from a database row with a list of image files in a field
1592 * All $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
1593 * Thumbsnails are linked to the show_item.php script which will display further details.
1594 *
1595 * @param array $row Row is the database row from the table, $table.
1596 * @param string $table Table name for $row (present in TCA)
1597 * @param string $field Field is pointing to the list of image files
1598 * @param string $backPath Back path prefix for image tag src="" field
1599 * @param string $thumbScript UNUSED since FAL
1600 * @param string $uploaddir Optional: $uploaddir is the directory relative to PATH_site where the image files from the $field value is found (Is by default set to the entry in $GLOBALS['TCA'] for that field! so you don't have to!)
1601 * @param int $abs UNUSED
1602 * @param string $tparams Optional: $tparams is additional attributes for the image tags
1603 * @param int|string $size Optional: $size is [w]x[h] of the thumbnail. 64 is default.
1604 * @param bool $linkInfoPopup Whether to wrap with a link opening the info popup
1605 * @return string Thumbnail image tag.
1606 */
1607 static public function thumbCode($row, $table, $field, $backPath, $thumbScript = '', $uploaddir = NULL, $abs = 0, $tparams = '', $size = '', $linkInfoPopup = TRUE) {
1608 // Check and parse the size parameter
1609 $size = trim($size);
1610 $sizeParts = array(64, 64);
1611 if ($size) {
1612 $sizeParts = explode('x', $size . 'x' . $size);
1613 }
1614 $thumbData = '';
1615 $fileReferences = static::resolveFileReferences($table, $field, $row);
1616 // FAL references
1617 if ($fileReferences !== NULL) {
1618 foreach ($fileReferences as $fileReferenceObject) {
1619 $fileObject = $fileReferenceObject->getOriginalFile();
1620
1621 if ($fileObject->isMissing()) {
1622 $flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
1623 $thumbData .= $flashMessage->render();
1624 continue;
1625 }
1626
1627 // Web image
1628 if (GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileReferenceObject->getExtension())) {
1629 $processedImage = $fileObject->process(ProcessedFile::CONTEXT_IMAGECROPSCALEMASK, array(
1630 'width' => $sizeParts[0],
1631 'height' => $sizeParts[1] . 'c',
1632 'crop' => $fileReferenceObject->getProperty('crop')
1633 ));
1634 $imageUrl = $processedImage->getPublicUrl(TRUE);
1635 $imgTag = '<img src="' . $imageUrl . '" ' .
1636 'width="' . $processedImage->getProperty('width') . '" ' .
1637 'height="' . $processedImage->getProperty('height') . '" ' .
1638 'alt="' . htmlspecialchars($fileReferenceObject->getName()) . '" />';
1639 } else {
1640 // Icon
1641 $imgTag = IconUtility::getSpriteIconForResource($fileObject, array('title' => $fileObject->getName()));
1642 }
1643 if ($linkInfoPopup) {
1644 $onClick = 'top.launchView(\'_FILE\',\'' . (int)$fileObject->getUid() . '\',' . GeneralUtility::quoteJSvalue($backPath) . '); return false;';
1645 $thumbData .= '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . $imgTag . '</a> ';
1646 } else {
1647 $thumbData .= $imgTag;
1648 }
1649 }
1650 } else {
1651 // Find uploaddir automatically
1652 if (is_null($uploaddir)) {
1653 $uploaddir = $GLOBALS['TCA'][$table]['columns'][$field]['config']['uploadfolder'];
1654 }
1655 $uploaddir = rtrim($uploaddir, '/');
1656 // Traverse files:
1657 $thumbs = GeneralUtility::trimExplode(',', $row[$field], TRUE);
1658 $thumbData = '';
1659 foreach ($thumbs as $theFile) {
1660 if ($theFile) {
1661 $fileName = trim($uploaddir . '/' . $theFile, '/');
1662 try {
1663 /** @var File $fileObject */
1664 $fileObject = ResourceFactory::getInstance()->retrieveFileOrFolderObject($fileName);
1665 if ($fileObject->isMissing()) {
1666 $flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
1667 $thumbData .= $flashMessage->render();
1668 continue;
1669 }
1670 } catch (ResourceDoesNotExistException $exception) {
1671 /** @var FlashMessage $flashMessage */
1672 $flashMessage = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessage::class,
1673 htmlspecialchars($exception->getMessage()),
1674 static::getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:warning.file_missing', TRUE),
1675 FlashMessage::ERROR
1676 );
1677 $thumbData .= $flashMessage->render();
1678 continue;
1679 }
1680
1681 $fileExtension = $fileObject->getExtension();
1682 if ($fileExtension == 'ttf' || GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileExtension)) {
1683 $imageUrl = $fileObject->process(ProcessedFile::CONTEXT_IMAGEPREVIEW, array(
1684 'width' => $sizeParts[0],
1685 'height' => $sizeParts[1]
1686 ))->getPublicUrl(TRUE);
1687 $image = '<img src="' . htmlspecialchars($imageUrl) . '" hspace="2" border="0" title="' . htmlspecialchars($fileObject->getName()) . '"' . $tparams . ' alt="" />';
1688 if ($linkInfoPopup) {
1689 $onClick = 'top.launchView(\'_FILE\', ' . GeneralUtility::quoteJSvalue($fileName) . ',\'\',' . GeneralUtility::quoteJSvalue($backPath) . ');return false;';
1690 $thumbData .= '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . $image . '</a> ';
1691 } else {
1692 $thumbData .= $image;
1693 }
1694 } else {
1695 // Gets the icon
1696 $fileIcon = IconUtility::getSpriteIconForResource($fileObject, array('title' => $fileObject->getName()));
1697 if ($linkInfoPopup) {
1698 $onClick = 'top.launchView(\'_FILE\', ' . GeneralUtility::quoteJSvalue($fileName) . ',\'\',' . GeneralUtility::quoteJSvalue($backPath) . '); return false;';
1699 $thumbData .= '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . $fileIcon . '</a> ';
1700 } else {
1701 $thumbData .= $fileIcon;
1702 }
1703 }
1704 }
1705 }
1706 }
1707 return $thumbData;
1708 }
1709
1710 /**
1711 * Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
1712 *
1713 * @param string $thumbScript Must point to "thumbs.php" relative to the script position
1714 * @param string $theFile Must be the proper reference to the file that thumbs.php should show
1715 * @param string $tparams The additional attributes for the image tag
1716 * @param string $size The size of the thumbnail send along to thumbs.php
1717 * @return string Image tag
1718 * @deprecated since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use the corresponding Resource objects and Processing functionality
1719 */
1720 static public function getThumbNail($thumbScript, $theFile, $tparams = '', $size = '') {
1721 GeneralUtility::logDeprecatedFunction();
1722 $size = trim($size);
1723 $check = basename($theFile) . ':' . filemtime($theFile) . ':' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
1724 $params = '&file=' . rawurlencode($theFile);
1725 $params .= $size ? '&size=' . $size : '';
1726 $params .= '&md5sum=' . md5($check);
1727 $url = $thumbScript . '?' . $params;
1728 $th = '<img src="' . htmlspecialchars($url) . '" title="' . trim(basename($theFile)) . '"' . ($tparams ? ' ' . $tparams : '') . ' alt="" />';
1729 return $th;
1730 }
1731
1732 /**
1733 * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
1734 *
1735 * @param array $row Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
1736 * @param string $perms_clause This is used to get the record path of the shortcut page, if any (and doktype==4)
1737 * @param bool $includeAttrib If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already
1738 * @return string
1739 */
1740 static public function titleAttribForPages($row, $perms_clause = '', $includeAttrib = TRUE) {
1741 $lang = static::getLanguageService();
1742 $parts = array();
1743 $parts[] = 'id=' . $row['uid'];
1744 if ($row['alias']) {
1745 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['alias']['label']) . ' ' . $row['alias'];
1746 }
1747 if ($row['pid'] < 0) {
1748 $parts[] = 'v#1.' . $row['t3ver_id'];
1749 }
1750 switch (VersionState::cast($row['t3ver_state'])) {
1751 case new VersionState(VersionState::NEW_PLACEHOLDER):
1752 $parts[] = 'PLH WSID#' . $row['t3ver_wsid'];
1753 break;
1754 case new VersionState(VersionState::DELETE_PLACEHOLDER):
1755 $parts[] = 'Deleted element!';
1756 break;
1757 case new VersionState(VersionState::MOVE_PLACEHOLDER):
1758 $parts[] = 'NEW LOCATION (PLH) WSID#' . $row['t3ver_wsid'];
1759 break;
1760 case new VersionState(VersionState::MOVE_POINTER):
1761 $parts[] = 'OLD LOCATION (PNT) WSID#' . $row['t3ver_wsid'];
1762 break;
1763 case new VersionState(VersionState::NEW_PLACEHOLDER_VERSION):
1764 $parts[] = 'New element!';
1765 break;
1766 }
1767 if ($row['doktype'] == PageRepository::DOKTYPE_LINK) {
1768 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['url']['label']) . ' ' . $row['url'];
1769 } elseif ($row['doktype'] == PageRepository::DOKTYPE_SHORTCUT) {
1770 if ($perms_clause) {
1771 $label = self::getRecordPath((int)$row['shortcut'], $perms_clause, 20);
1772 } else {
1773 $row['shortcut'] = (int)$row['shortcut'];
1774 $lRec = self::getRecordWSOL('pages', $row['shortcut'], 'title');
1775 $label = $lRec['title'] . ' (id=' . $row['shortcut'] . ')';
1776 }
1777 if ($row['shortcut_mode'] != PageRepository::SHORTCUT_MODE_NONE) {
1778 $label .= ', ' . $lang->sL($GLOBALS['TCA']['pages']['columns']['shortcut_mode']['label']) . ' ' . $lang->sL(self::getLabelFromItemlist('pages', 'shortcut_mode', $row['shortcut_mode']));
1779 }
1780 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['shortcut']['label']) . ' ' . $label;
1781 } elseif ($row['doktype'] == PageRepository::DOKTYPE_MOUNTPOINT) {
1782 if ($perms_clause) {
1783 $label = self::getRecordPath((int)$row['mount_pid'], $perms_clause, 20);
1784 } else {
1785 $lRec = self::getRecordWSOL('pages', (int)$row['mount_pid'], 'title');
1786 $label = $lRec['title'] . ' (id=' . $row['mount_pid'] . ')';
1787 }
1788 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['mount_pid']['label']) . ' ' . $label;
1789 if ($row['mount_pid_ol']) {
1790 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['mount_pid_ol']['label']);
1791 }
1792 }
1793 if ($row['nav_hide']) {
1794 $parts[] = rtrim($lang->sL($GLOBALS['TCA']['pages']['columns']['nav_hide']['label']), ':');
1795 }
1796 if ($row['hidden']) {
1797 $parts[] = $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.hidden');
1798 }
1799 if ($row['starttime']) {
1800 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['starttime']['label']) . ' ' . self::dateTimeAge($row['starttime'], -1, 'date');
1801 }
1802 if ($row['endtime']) {
1803 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['endtime']['label']) . ' ' . self::dateTimeAge($row['endtime'], -1, 'date');
1804 }
1805 if ($row['fe_group']) {
1806 $fe_groups = array();
1807 foreach (GeneralUtility::intExplode(',', $row['fe_group']) as $fe_group) {
1808 if ($fe_group < 0) {
1809 $fe_groups[] = $lang->sL(self::getLabelFromItemlist('pages', 'fe_group', $fe_group));
1810 } else {
1811 $lRec = self::getRecordWSOL('fe_groups', $fe_group, 'title');
1812 $fe_groups[] = $lRec['title'];
1813 }
1814 }
1815 $label = implode(', ', $fe_groups);
1816 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['fe_group']['label']) . ' ' . $label;
1817 }
1818 $out = htmlspecialchars(implode(' - ', $parts));
1819 return $includeAttrib ? 'title="' . $out . '"' : $out;
1820 }
1821
1822 /**
1823 * Returns title-attribute information for ANY record (from a table defined in TCA of course)
1824 * The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included.
1825 * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
1826 *
1827 * @param array $row Table row; $row is a row from the table, $table
1828 * @param string $table Table name
1829 * @return string
1830 */
1831 static public function getRecordIconAltText($row, $table = 'pages') {
1832 if ($table == 'pages') {
1833 $out = self::titleAttribForPages($row, '', 0);
1834 } else {
1835 $ctrl = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns'];
1836 // Uid is added
1837 $out = 'id=' . $row['uid'];
1838 if ($table == 'pages' && $row['alias']) {
1839 $out .= ' / ' . $row['alias'];
1840 }
1841 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'] && $row['pid'] < 0) {
1842 $out .= ' - v#1.' . $row['t3ver_id'];
1843 }
1844 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
1845 switch (VersionState::cast($row['t3ver_state'])) {
1846 case new VersionState(VersionState::NEW_PLACEHOLDER):
1847 $out .= ' - PLH WSID#' . $row['t3ver_wsid'];
1848 break;
1849 case new VersionState(VersionState::DELETE_PLACEHOLDER):
1850 $out .= ' - Deleted element!';
1851 break;
1852 case new VersionState(VersionState::MOVE_PLACEHOLDER):
1853 $out .= ' - NEW LOCATION (PLH) WSID#' . $row['t3ver_wsid'];
1854 break;
1855 case new VersionState(VersionState::MOVE_POINTER):
1856 $out .= ' - OLD LOCATION (PNT) WSID#' . $row['t3ver_wsid'];
1857 break;
1858 case new VersionState(VersionState::NEW_PLACEHOLDER_VERSION):
1859 $out .= ' - New element!';
1860 break;
1861 }
1862 }
1863 // Hidden
1864 $lang = static::getLanguageService();
1865 if ($ctrl['disabled']) {
1866 $out .= $row[$ctrl['disabled']] ? ' - ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.hidden') : '';
1867 }
1868 if ($ctrl['starttime']) {
1869 if ($row[$ctrl['starttime']] > $GLOBALS['EXEC_TIME']) {
1870 $out .= ' - ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.starttime') . ':' . self::date($row[$ctrl['starttime']]) . ' (' . self::daysUntil($row[$ctrl['starttime']]) . ' ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.days') . ')';
1871 }
1872 }
1873 if ($row[$ctrl['endtime']]) {
1874 $out .= ' - ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.endtime') . ': ' . self::date($row[$ctrl['endtime']]) . ' (' . self::daysUntil($row[$ctrl['endtime']]) . ' ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.days') . ')';
1875 }
1876 }
1877 return htmlspecialchars($out);
1878 }
1879
1880 /**
1881 * Returns the label of the first found entry in an "items" array from $GLOBALS['TCA'] (tablename = $table/fieldname = $col) where the value is $key
1882 *
1883 * @param string $table Table name, present in $GLOBALS['TCA']
1884 * @param string $col Field name, present in $GLOBALS['TCA']
1885 * @param string $key items-array value to match
1886 * @return string Label for item entry
1887 */
1888 static public function getLabelFromItemlist($table, $col, $key) {
1889 // Check, if there is an "items" array:
1890 if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$col]) && is_array($GLOBALS['TCA'][$table]['columns'][$col]['config']['items'])) {
1891 // Traverse the items-array...
1892 foreach ($GLOBALS['TCA'][$table]['columns'][$col]['config']['items'] as $v) {
1893 // ... and return the first found label where the value was equal to $key
1894 if ((string)$v[1] === (string)$key) {
1895 return $v[0];
1896 }
1897 }
1898 }
1899 return '';
1900 }
1901
1902 /**
1903 * Return the label of a field by additionally checking TsConfig values
1904 *
1905 * @param int $pageId Page id
1906 * @param string $table Table name
1907 * @param string $column Field Name
1908 * @param string $key item value
1909 * @return string Label for item entry
1910 */
1911 static public function getLabelFromItemListMerged($pageId, $table, $column, $key) {
1912 $pageTsConfig = static::getPagesTSconfig($pageId);
1913 $label = '';
1914 if (is_array($pageTsConfig['TCEFORM.']) && is_array($pageTsConfig['TCEFORM.'][$table . '.']) && is_array($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.'])) {
1915 if (is_array($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['addItems.']) && isset($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['addItems.'][$key])) {
1916 $label = $pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['addItems.'][$key];
1917 } elseif (is_array($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['altLabels.']) && isset($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['altLabels.'][$key])) {
1918 $label = $pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['altLabels.'][$key];
1919 }
1920 }
1921 if (empty($label)) {
1922 $tcaValue = self::getLabelFromItemlist($table, $column, $key);
1923 if (!empty($tcaValue)) {
1924 $label = $tcaValue;
1925 }
1926 }
1927 return $label;
1928 }
1929
1930 /**
1931 * Splits the given key with commas and returns the list of all the localized items labels, separated by a comma.
1932 * NOTE: this does not take itemsProcFunc into account
1933 *
1934 * @param string $table Table name, present in TCA
1935 * @param string $column Field name
1936 * @param string $key Key or comma-separated list of keys.
1937 * @return string Comma-separated list of localized labels
1938 */
1939 static public function getLabelsFromItemsList($table, $column, $key) {
1940 $labels = array();
1941 $values = GeneralUtility::trimExplode(',', $key, TRUE);
1942 if (count($values) > 0) {
1943 // Check if there is an "items" array
1944 if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$column]) && is_array($GLOBALS['TCA'][$table]['columns'][$column]['config']['items'])) {
1945 // Loop on all selected values
1946 foreach ($values as $aValue) {
1947 foreach ($GLOBALS['TCA'][$table]['columns'][$column]['config']['items'] as $itemConfiguration) {
1948 // Loop on all available items
1949 // Keep matches and move on to next value
1950 if ((string)$aValue === (string)$itemConfiguration[1]) {
1951 $labels[] = static::getLanguageService()->sL($itemConfiguration[0]);
1952 break;
1953 }
1954 }
1955 }
1956 }
1957 }
1958 return implode(', ', $labels);
1959 }
1960
1961 /**
1962 * Returns the label-value for fieldname $col in table, $table
1963 * If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap = '<strong>|</strong>' and the fieldname was 'not_found_field' then the return value would be '<strong>not_found_field</strong>'
1964 *
1965 * @param string $table Table name, present in $GLOBALS['TCA']
1966 * @param string $col Field name
1967 * @param string $printAllWrap Wrap value - set function description - this parameter is deprecated since TYPO3 6.2 and is removed two versions later. This parameter is a conceptual failure, as the content can then never be HSCed afterwards (which is how the method is used all the time), and then the code would be HSCed twice.
1968 * @return string or NULL if $col is not found in the TCA table
1969 */
1970 static public function getItemLabel($table, $col, $printAllWrap = '') {
1971 // Check if column exists
1972 if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$col])) {
1973 return $GLOBALS['TCA'][$table]['columns'][$col]['label'];
1974 }
1975 if ($printAllWrap) {
1976 GeneralUtility::deprecationLog('The third parameter of getItemLabel() is deprecated with TYPO3 CMS 6.2 and will be removed two versions later.');
1977 $parts = explode('|', $printAllWrap);
1978 return $parts[0] . $col . $parts[1];
1979 }
1980
1981 return NULL;
1982 }
1983
1984 /**
1985 * Replace field values in given row with values from the original language
1986 * if l10n_mode TCA settings require to do so.
1987 *
1988 * @param string $table Table name
1989 * @param array $row Row to fill with original language values
1990 * @return array Row with values from the original language
1991 */
1992 static protected function replaceL10nModeFields($table, array $row) {
1993 $originalUidField = isset($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'])
1994 ? $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']
1995 : '';
1996 if (empty($row[$originalUidField])) {
1997 return $row;
1998 }
1999
2000 $originalTable = self::getOriginalTranslationTable($table);
2001 $originalRow = self::getRecord($originalTable, $row[$originalUidField]);
2002 foreach ($row as $field => $_) {
2003 $l10n_mode = isset($GLOBALS['TCA'][$originalTable]['columns'][$field]['l10n_mode'])
2004 ? $GLOBALS['TCA'][$originalTable]['columns'][$field]['l10n_mode']
2005 : '';
2006 if ($l10n_mode === 'exclude' || ($l10n_mode === 'mergeIfNotBlank' && trim($originalRow[$field]) !== '')) {
2007 $row[$field] = $originalRow[$field];
2008 }
2009 }
2010 return $row;
2011 }
2012
2013 /**
2014 * Returns the "title"-value in record, $row, from table, $table
2015 * The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
2016 *
2017 * @param string $table Table name, present in TCA
2018 * @param array $row Row from table
2019 * @param bool $prep If set, result is prepared for output: The output is cropped to a limited length (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '<em>[No title]</em>' is returned (localized). Further, the output is htmlspecialchars()'ed
2020 * @param bool $forceResult If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
2021 * @return string
2022 */
2023 static public function getRecordTitle($table, $row, $prep = FALSE, $forceResult = TRUE) {
2024 if (is_array($GLOBALS['TCA'][$table])) {
2025 // If configured, call userFunc
2026 if ($GLOBALS['TCA'][$table]['ctrl']['label_userFunc']) {
2027 $params['table'] = $table;
2028 $params['row'] = $row;
2029 $params['title'] = '';
2030 $params['options'] = isset($GLOBALS['TCA'][$table]['ctrl']['label_userFunc_options']) ? $GLOBALS['TCA'][$table]['ctrl']['label_userFunc_options'] : array();
2031
2032 // Create NULL-reference
2033 $null = NULL;
2034 GeneralUtility::callUserFunction($GLOBALS['TCA'][$table]['ctrl']['label_userFunc'], $params, $null);
2035 $t = $params['title'];
2036 } else {
2037 if (is_array($row)) {
2038 $row = self::replaceL10nModeFields($table, $row);
2039 }
2040
2041 // No userFunc: Build label
2042 $t = self::getProcessedValue($table, $GLOBALS['TCA'][$table]['ctrl']['label'], $row[$GLOBALS['TCA'][$table]['ctrl']['label']], 0, 0, FALSE, $row['uid'], $forceResult);
2043 if ($GLOBALS['TCA'][$table]['ctrl']['label_alt'] && ($GLOBALS['TCA'][$table]['ctrl']['label_alt_force'] || (string)$t === '')) {
2044 $altFields = GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['label_alt'], TRUE);
2045 $tA = array();
2046 if (!empty($t)) {
2047 $tA[] = $t;
2048 }
2049 foreach ($altFields as $fN) {
2050 $t = trim(strip_tags($row[$fN]));
2051 if ((string)$t !== '') {
2052 $t = self::getProcessedValue($table, $fN, $t, 0, 0, FALSE, $row['uid']);
2053 if (!$GLOBALS['TCA'][$table]['ctrl']['label_alt_force']) {
2054 break;
2055 }
2056 $tA[] = $t;
2057 }
2058 }
2059 if ($GLOBALS['TCA'][$table]['ctrl']['label_alt_force']) {
2060 $t = implode(', ', $tA);
2061 }
2062 }
2063 }
2064 // If the current result is empty, set it to '[No title]' (localized) and prepare for output if requested
2065 if ($prep || $forceResult) {
2066 if ($prep) {
2067 $t = self::getRecordTitlePrep($t);
2068 }
2069 if (trim($t) === '') {
2070 $t = self::getNoRecordTitle($prep);
2071 }
2072 }
2073 return $t;
2074 }
2075 return '';
2076 }
2077
2078 /**
2079 * Crops a title string to a limited length and if it really was cropped, wrap it in a <span title="...">|</span>,
2080 * which offers a tooltip with the original title when moving mouse over it.
2081 *
2082 * @param string $title The title string to be cropped
2083 * @param int $titleLength Crop title after this length - if not set, BE_USER->uc['titleLen'] is used
2084 * @return string The processed title string, wrapped in <span title="...">|</span> if cropped
2085 */
2086 static public function getRecordTitlePrep($title, $titleLength = 0) {
2087 // If $titleLength is not a valid positive integer, use BE_USER->uc['titleLen']:
2088 if (!$titleLength || !MathUtility::canBeInterpretedAsInteger($titleLength) || $titleLength < 0) {
2089 $titleLength = static::getBackendUserAuthentication()->uc['titleLen'];
2090 }
2091 $titleOrig = htmlspecialchars($title);
2092 $title = htmlspecialchars(GeneralUtility::fixed_lgd_cs($title, $titleLength));
2093 // If title was cropped, offer a tooltip:
2094 if ($titleOrig != $title) {
2095 $title = '<span title="' . $titleOrig . '">' . $title . '</span>';
2096 }
2097 return $title;
2098 }
2099
2100 /**
2101 * Get a localized [No title] string, wrapped in <em>|</em> if $prep is TRUE.
2102 *
2103 * @param bool $prep Wrap result in <em>|</em>
2104 * @return string Localized [No title] string
2105 */
2106 static public function getNoRecordTitle($prep = FALSE) {
2107 $noTitle = '[' . static::getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.no_title', TRUE) . ']';
2108 if ($prep) {
2109 $noTitle = '<em>' . $noTitle . '</em>';
2110 }
2111 return $noTitle;
2112 }
2113
2114 /**
2115 * Returns a human readable output of a value from a record
2116 * For instance a database record relation would be looked up to display the title-value of that record. A checkbox with a "1" value would be "Yes", etc.
2117 * $table/$col is tablename and fieldname
2118 * REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
2119 *
2120 * @param string $table Table name, present in TCA
2121 * @param string $col Field name, present in TCA
2122 * @param string $value The value of that field from a selected record
2123 * @param int $fixed_lgd_chars The max amount of characters the value may occupy
2124 * @param bool $defaultPassthrough Flag means that values for columns that has no conversion will just be pass through directly (otherwise cropped to 200 chars or returned as "N/A")
2125 * @param bool $noRecordLookup If set, no records will be looked up, UIDs are just shown.
2126 * @param int $uid Uid of the current record
2127 * @param bool $forceResult If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
2128 * @return string|NULL
2129 */
2130 static public function getProcessedValue($table, $col, $value, $fixed_lgd_chars = 0, $defaultPassthrough = FALSE, $noRecordLookup = FALSE, $uid = 0, $forceResult = TRUE) {
2131 if ($col === 'uid') {
2132 // uid is not in TCA-array
2133 return $value;
2134 }
2135 // Check if table and field is configured
2136 if (!is_array($GLOBALS['TCA'][$table]) || !is_array($GLOBALS['TCA'][$table]['columns'][$col])) {
2137 return NULL;
2138 }
2139 // Depending on the fields configuration, make a meaningful output value.
2140 $theColConf = $GLOBALS['TCA'][$table]['columns'][$col]['config'];
2141 /*****************
2142 *HOOK: pre-processing the human readable output from a record
2143 ****************/
2144 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'])) {
2145 // Create NULL-reference
2146 $null = NULL;
2147 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'] as $_funcRef) {
2148 GeneralUtility::callUserFunction($_funcRef, $theColConf, $null);
2149 }
2150 }
2151 $l = '';
2152 $db = static::getDatabaseConnection();
2153 $lang = static::getLanguageService();
2154 switch ((string)$theColConf['type']) {
2155 case 'radio':
2156 $l = self::getLabelFromItemlist($table, $col, $value);
2157 $l = $lang->sL($l);
2158 break;
2159 case 'inline':
2160 case 'select':
2161 if ($theColConf['MM']) {
2162 if ($uid) {
2163 // Display the title of MM related records in lists
2164 if ($noRecordLookup) {
2165 $MMfield = $theColConf['foreign_table'] . '.uid';
2166 } else {
2167 $MMfields = array($theColConf['foreign_table'] . '.' . $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label']);
2168 foreach (GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label_alt'], TRUE) as $f) {
2169 $MMfields[] = $theColConf['foreign_table'] . '.' . $f;
2170 }
2171 $MMfield = join(',', $MMfields);
2172 }
2173 /** @var $dbGroup RelationHandler */
2174 $dbGroup = GeneralUtility::makeInstance(RelationHandler::class);
2175 $dbGroup->start($value, $theColConf['foreign_table'], $theColConf['MM'], $uid, $table, $theColConf);
2176 $selectUids = $dbGroup->tableArray[$theColConf['foreign_table']];
2177 if (is_array($selectUids) && count($selectUids) > 0) {
2178 $MMres = $db->exec_SELECTquery('uid, ' . $MMfield, $theColConf['foreign_table'], 'uid IN (' . implode(',', $selectUids) . ')' . self::deleteClause($theColConf['foreign_table']));
2179 $mmlA = array();
2180 while ($MMrow = $db->sql_fetch_assoc($MMres)) {
2181 // Keep sorting of $selectUids
2182 $mmlA[array_search($MMrow['uid'], $selectUids)] = $noRecordLookup ?
2183 $MMrow['uid'] :
2184 static::getRecordTitle($theColConf['foreign_table'], $MMrow, FALSE, $forceResult);
2185 }
2186 $db->sql_free_result($MMres);
2187 if (!empty($mmlA)) {
2188 ksort($mmlA);
2189 $l = implode('; ', $mmlA);
2190 } else {
2191 $l = 'N/A';
2192 }
2193 } else {
2194 $l = 'N/A';
2195 }
2196 } else {
2197 $l = 'N/A';
2198 }
2199 } else {
2200 $l = self::getLabelsFromItemsList($table, $col, $value);
2201 if ($theColConf['foreign_table'] && !$l && $GLOBALS['TCA'][$theColConf['foreign_table']]) {
2202 if ($noRecordLookup) {
2203 $l = $value;
2204 } else {
2205 $rParts = array();
2206 if ($uid && isset($theColConf['foreign_field']) && $theColConf['foreign_field'] !== '') {
2207 $whereClause = '';
2208 if (!empty($theColConf['foreign_table_field'])) {
2209 $whereClause .= ' AND ' . $theColConf['foreign_table_field'] . ' = ' . static::getDatabaseConnection()->fullQuoteStr($table, $theColConf['foreign_table']);
2210 }
2211 // Add additional where clause if foreign_match_fields are defined
2212 $foreignMatchFields = is_array($theColConf['foreign_match_fields']) ? $theColConf['foreign_match_fields'] : array();
2213 foreach ($foreignMatchFields as $matchField => $matchValue) {
2214 $whereClause .= ' AND ' . $matchField . '=' . static::getDatabaseConnection()->fullQuoteStr($matchValue, $theColConf['foreign_table']);
2215 }
2216 $records = self::getRecordsByField($theColConf['foreign_table'], $theColConf['foreign_field'], $uid, $whereClause);
2217 if (!empty($records)) {
2218 foreach ($records as $record) {
2219 $rParts[] = $record['uid'];
2220 }
2221 }
2222 }
2223 if (empty($rParts)) {
2224 $rParts = GeneralUtility::trimExplode(',', $value, TRUE);
2225 }
2226 $lA = array();
2227 foreach ($rParts as $rVal) {
2228 $rVal = (int)$rVal;
2229 if ($rVal > 0) {
2230 $r = self::getRecordWSOL($theColConf['foreign_table'], $rVal);
2231 } else {
2232 $r = self::getRecordWSOL($theColConf['neg_foreign_table'], -$rVal);
2233 }
2234 if (is_array($r)) {
2235 $lA[] = $lang->sL(($rVal > 0 ? $theColConf['foreign_table_prefix'] : $theColConf['neg_foreign_table_prefix'])) . self::getRecordTitle(($rVal > 0 ? $theColConf['foreign_table'] : $theColConf['neg_foreign_table']), $r, FALSE, $forceResult);
2236 } else {
2237 $lA[] = $rVal ? '[' . $rVal . '!]' : '';
2238 }
2239 }
2240 $l = implode(', ', $lA);
2241 }
2242 }
2243 if (empty($l) && !empty($value)) {
2244 // Use plain database value when label is empty
2245 $l = $value;
2246 }
2247 }
2248 break;
2249 case 'group':
2250 // resolve the titles for DB records
2251 if ($theColConf['internal_type'] === 'db') {
2252 if ($theColConf['MM']) {
2253 if ($uid) {
2254 // Display the title of MM related records in lists
2255 if ($noRecordLookup) {
2256 $MMfield = $theColConf['foreign_table'] . '.uid';
2257 } else {
2258 $MMfields = array($theColConf['foreign_table'] . '.' . $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label']);
2259 $altLabelFields = explode(',', $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label_alt']);
2260 foreach ($altLabelFields as $f) {
2261 $f = trim($f);
2262 if ($f !== '') {
2263 $MMfields[] = $theColConf['foreign_table'] . '.' . $f;
2264 }
2265 }
2266 $MMfield = join(',', $MMfields);
2267 }
2268 /** @var $dbGroup RelationHandler */
2269 $dbGroup = GeneralUtility::makeInstance(RelationHandler::class);
2270 $dbGroup->start($value, $theColConf['foreign_table'], $theColConf['MM'], $uid, $table, $theColConf);
2271 $selectUids = $dbGroup->tableArray[$theColConf['foreign_table']];
2272 if (!empty($selectUids) && is_array($selectUids)) {
2273 $MMres = $db->exec_SELECTquery(
2274 'uid, ' . $MMfield,
2275 $theColConf['foreign_table'],
2276 'uid IN (' . implode(',', $selectUids) . ')' . static::deleteClause($theColConf['foreign_table'])
2277 );
2278 $mmlA = array();
2279 while ($MMrow = $db->sql_fetch_assoc($MMres)) {
2280 // Keep sorting of $selectUids
2281 $mmlA[array_search($MMrow['uid'], $selectUids)] = $noRecordLookup
2282 ? $MMrow['uid']
2283 : static::getRecordTitle($theColConf['foreign_table'], $MMrow, FALSE, $forceResult);
2284 }
2285 $db->sql_free_result($MMres);
2286 if (!empty($mmlA)) {
2287 ksort($mmlA);
2288 $l = implode('; ', $mmlA);
2289 } else {
2290 $l = 'N/A';
2291 }
2292 } else {
2293 $l = 'N/A';
2294 }
2295 } else {
2296 $l = 'N/A';
2297 }
2298 } else {
2299 $finalValues = array();
2300 $relationTableName = $theColConf['allowed'];
2301 $explodedValues = GeneralUtility::trimExplode(',', $value, TRUE);
2302
2303 foreach ($explodedValues as $explodedValue) {
2304 if (MathUtility::canBeInterpretedAsInteger($explodedValue)) {
2305 $relationTableNameForField = $relationTableName;
2306 } else {
2307 list($relationTableNameForField, $explodedValue) = self::splitTable_Uid($explodedValue);
2308 }
2309
2310 $relationRecord = static::getRecordWSOL($relationTableNameForField, $explodedValue);
2311 $finalValues[] = static::getRecordTitle($relationTableNameForField, $relationRecord);
2312 }
2313 $l = implode(', ', $finalValues);
2314 }
2315 } else {
2316 $l = implode(', ', GeneralUtility::trimExplode(',', $value, TRUE));
2317 }
2318 break;
2319 case 'check':
2320 if (!is_array($theColConf['items']) || count($theColConf['items']) == 1) {
2321 $l = $value ? $lang->sL('LLL:EXT:lang/locallang_common.xlf:yes') : $lang->sL('LLL:EXT:lang/locallang_common.xlf:no');
2322 } else {
2323 $lA = array();
2324 foreach ($theColConf['items'] as $key => $val) {
2325 if ($value & pow(2, $key)) {
2326 $lA[] = $lang->sL($val[0]);
2327 }
2328 }
2329 $l = implode(', ', $lA);
2330 }
2331 break;
2332 case 'input':
2333 // Hide value 0 for dates, but show it for everything else
2334 if (isset($value)) {
2335 if (GeneralUtility::inList($theColConf['eval'], 'date')) {
2336 // Handle native date field
2337 if (isset($theColConf['dbType']) && $theColConf['dbType'] === 'date') {
2338 $dateTimeFormats = $db->getDateTimeFormats($table);
2339 $emptyValue = $dateTimeFormats['date']['empty'];
2340 $value = $value !== $emptyValue ? strtotime($value) : 0;
2341 }
2342 if (!empty($value)) {
2343 $l = self::date($value) . ' (' . ($GLOBALS['EXEC_TIME'] - $value > 0 ? '-' : '') . self::calcAge(abs(($GLOBALS['EXEC_TIME'] - $value)), $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears')) . ')';
2344 }
2345 } elseif (GeneralUtility::inList($theColConf['eval'], 'time')) {
2346 if (!empty($value)) {
2347 $l = self::time($value, FALSE);
2348 }
2349 } elseif (GeneralUtility::inList($theColConf['eval'], 'timesec')) {
2350 if (!empty($value)) {
2351 $l = self::time($value);
2352 }
2353 } elseif (GeneralUtility::inList($theColConf['eval'], 'datetime')) {
2354 // Handle native date/time field
2355 if (isset($theColConf['dbType']) && $theColConf['dbType'] === 'datetime') {
2356 $dateTimeFormats = $db->getDateTimeFormats($table);
2357 $emptyValue = $dateTimeFormats['datetime']['empty'];
2358 $value = $value !== $emptyValue ? strtotime($value) : 0;
2359 }
2360 if (!empty($value)) {
2361 $l = self::datetime($value);
2362 }
2363 } else {
2364 $l = $value;
2365 }
2366 }
2367 break;
2368 case 'flex':
2369 $l = strip_tags($value);
2370 break;
2371 default:
2372 if ($defaultPassthrough) {
2373 $l = $value;
2374 } elseif ($theColConf['MM']) {
2375 $l = 'N/A';
2376 } elseif ($value) {
2377 $l = GeneralUtility::fixed_lgd_cs(strip_tags($value), 200);
2378 }
2379 }
2380 // If this field is a password field, then hide the password by changing it to a random number of asterisk (*)
2381 if (stristr($theColConf['eval'], 'password')) {
2382 $l = '';
2383 $randomNumber = rand(5, 12);
2384 for ($i = 0; $i < $randomNumber; $i++) {
2385 $l .= '*';
2386 }
2387 }
2388 /*****************
2389 *HOOK: post-processing the human readable output from a record
2390 ****************/
2391 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'])) {
2392 // Create NULL-reference
2393 $null = NULL;
2394 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'] as $_funcRef) {
2395 $params = array(
2396 'value' => $l,
2397 'colConf' => $theColConf
2398 );
2399 $l = GeneralUtility::callUserFunction($_funcRef, $params, $null);
2400 }
2401 }
2402 if ($fixed_lgd_chars) {
2403 return GeneralUtility::fixed_lgd_cs($l, $fixed_lgd_chars);
2404 } else {
2405 return $l;
2406 }
2407 }
2408
2409 /**
2410 * Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead.
2411 *
2412 * @param string $table Table name, present in TCA
2413 * @param string $fN Field name
2414 * @param string $fV Field value
2415 * @param int $fixed_lgd_chars The max amount of characters the value may occupy
2416 * @param int $uid Uid of the current record
2417 * @param bool $forceResult If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
2418 * @return string
2419 * @see getProcessedValue()
2420 */
2421 static public function getProcessedValueExtra($table, $fN, $fV, $fixed_lgd_chars = 0, $uid = 0, $forceResult = TRUE) {
2422 $fVnew = self::getProcessedValue($table, $fN, $fV, $fixed_lgd_chars, 1, 0, $uid, $forceResult);
2423 if (!isset($fVnew)) {
2424 if (is_array($GLOBALS['TCA'][$table])) {
2425 if ($fN == $GLOBALS['TCA'][$table]['ctrl']['tstamp'] || $fN == $GLOBALS['TCA'][$table]['ctrl']['crdate']) {
2426 $fVnew = self::datetime($fV);
2427 } elseif ($fN == 'pid') {
2428 // Fetches the path with no regard to the users permissions to select pages.
2429 $fVnew = self::getRecordPath($fV, '1=1', 20);
2430 } else {
2431 $fVnew = $fV;
2432 }
2433 }
2434 }
2435 return $fVnew;
2436 }
2437
2438 /**
2439 * Returns file icon name (from $FILEICONS) for the fileextension $ext
2440 *
2441 * @param string $ext File extension, lowercase
2442 * @return string File icon filename
2443 */
2444 static public function getFileIcon($ext) {
2445 return $GLOBALS['FILEICONS'][$ext] ?: $GLOBALS['FILEICONS']['default'];
2446 }
2447
2448 /**
2449 * Returns fields for a table, $table, which would typically be interesting to select
2450 * This includes uid, the fields defined for title, icon-field.
2451 * Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed)
2452 *
2453 * @param string $table Table name, present in $GLOBALS['TCA']
2454 * @param string $prefix Table prefix
2455 * @param array $fields Preset fields (must include prefix if that is used)
2456 * @return string List of fields.
2457 */
2458 static public function getCommonSelectFields($table, $prefix = '', $fields = array()) {
2459 $fields[] = $prefix . 'uid';
2460 if (isset($GLOBALS['TCA'][$table]['ctrl']['label']) && $GLOBALS['TCA'][$table]['ctrl']['label'] != '') {
2461 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['label'];
2462 }
2463 if ($GLOBALS['TCA'][$table]['ctrl']['label_alt']) {
2464 $secondFields = GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['label_alt'], TRUE);
2465 foreach ($secondFields as $fieldN) {
2466 $fields[] = $prefix . $fieldN;
2467 }
2468 }
2469 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
2470 $fields[] = $prefix . 't3ver_id';
2471 $fields[] = $prefix . 't3ver_state';
2472 $fields[] = $prefix . 't3ver_wsid';
2473 $fields[] = $prefix . 't3ver_count';
2474 }
2475 if ($GLOBALS['TCA'][$table]['ctrl']['selicon_field']) {
2476 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['selicon_field'];
2477 }
2478 if ($GLOBALS['TCA'][$table]['ctrl']['typeicon_column']) {
2479 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['typeicon_column'];
2480 }
2481 if (is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns'])) {
2482 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']) {
2483 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'];
2484 }
2485 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['starttime']) {
2486 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['starttime'];
2487 }
2488 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime']) {
2489 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime'];
2490 }
2491 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['fe_group']) {
2492 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['fe_group'];
2493 }
2494 }
2495 return implode(',', array_unique($fields));
2496 }
2497
2498 /**
2499 * Makes a form for configuration of some values based on configuration found in the array $configArray,
2500 * with default values from $defaults and a data-prefix $dataPrefix
2501 * <form>-tags must be supplied separately
2502 * Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3.
2503 * That's were you can expect to find example, if anywhere.
2504 *
2505 * @param array $configArray Field configuration code.
2506 * @param array $defaults Defaults
2507 * @param string $dataPrefix Prefix for formfields
2508 * @return string HTML for a form.
2509 */
2510 static public function makeConfigForm($configArray, $defaults, $dataPrefix) {
2511 $params = $defaults;
2512 $lines = array();
2513 if (is_array($configArray)) {
2514 foreach ($configArray as $fname => $config) {
2515 if (is_array($config)) {
2516 $lines[$fname] = '<strong>' . htmlspecialchars($config[1]) . '</strong><br />';
2517 $lines[$fname] .= $config[2] . '<br />';
2518 switch ($config[0]) {
2519 case 'string':
2520
2521 case 'short':
2522 $formEl = '<input type="text" name="' . $dataPrefix . '[' . $fname . ']" value="' . $params[$fname] . '"' . static::getDocumentTemplate()->formWidth(($config[0] == 'short' ? 24 : 48)) . ' />';
2523 break;
2524 case 'check':
2525 $formEl = '<input type="hidden" name="' . $dataPrefix . '[' . $fname . ']" value="0" /><input type="checkbox" name="' . $dataPrefix . '[' . $fname . ']" value="1"' . ($params[$fname] ? ' checked="checked"' : '') . ' />';
2526 break;
2527 case 'comment':
2528 $formEl = '';
2529 break;
2530 case 'select':
2531 $opt = array();
2532 foreach ($config[3] as $k => $v) {
2533 $opt[] = '<option value="' . htmlspecialchars($k) . '"' . ($params[$fname] == $k ? ' selected="selected"' : '') . '>' . htmlspecialchars($v) . '</option>';
2534 }
2535 $formEl = '<select name="' . $dataPrefix . '[' . $fname . ']">' . implode('', $opt) . '</select>';
2536 break;
2537 default:
2538 $formEl = '<strong>Should not happen. Bug in config.</strong>';
2539 }
2540 $lines[$fname] .= $formEl;
2541 $lines[$fname] .= '<br /><br />';
2542 } else {
2543 $lines[$fname] = '<hr />';
2544 if ($config) {
2545 $lines[$fname] .= '<strong>' . strtoupper(htmlspecialchars($config)) . '</strong><br />';
2546 }
2547 if ($config) {
2548 $lines[$fname] .= '<br />';
2549 }
2550 }
2551 }
2552 }
2553 $out = implode('', $lines);
2554 $out .= '<input class="btn btn-default" type="submit" name="submit" value="Update configuration" />';
2555 return $out;
2556 }
2557
2558 /*******************************************
2559 *
2560 * Backend Modules API functions
2561 *
2562 *******************************************/
2563 /**
2564 * Returns help-text icon if configured for.
2565 * TCA_DESCR must be loaded prior to this function
2566 *
2567 * Please note: since TYPO3 4.5 the UX team decided to not use CSH in its former way,
2568 * but to wrap the given text (where before the help icon was, and you could hover over it)
2569 * Please also note that since TYPO3 4.5 the option to enable help (none, icon only, full text)
2570 * was completely removed.
2571 *
2572 * @param string $table Table name
2573 * @param string $field Field name
2574 * @param string $BACK_PATH UNUSED
2575 * @param bool $force Force display of icon no matter BE_USER setting for help
2576 * @return string HTML content for a help icon/text
2577 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, use cshItem() instead
2578 */
2579 static public function helpTextIcon($table, $field, $BACK_PATH = '', $force = FALSE) {
2580 GeneralUtility::logDeprecatedFunction();
2581 if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field])) {
2582 return self::wrapInHelp($table, $field);
2583 }
2584 return '';
2585 }
2586
2587 /**
2588 * Returns CSH help text (description), if configured for, as an array (title, description)
2589 *
2590 * @param string $table Table name
2591 * @param string $field Field name
2592 * @return array With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'
2593 */
2594 static public function helpTextArray($table, $field) {
2595 if (!isset($GLOBALS['TCA_DESCR'][$table]['columns'])) {
2596 static::getLanguageService()->loadSingleTableDescription($table);
2597 }
2598 $output = array(
2599 'description' => NULL,
2600 'title' => NULL,
2601 'moreInfo' => FALSE
2602 );
2603 if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field])) {
2604 $data = $GLOBALS['TCA_DESCR'][$table]['columns'][$field];
2605 // Add alternative title, if defined
2606 if ($data['alttitle']) {
2607 $output['title'] = $data['alttitle'];
2608 }
2609 // If we have more information to show
2610 if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
2611 $output['moreInfo'] = TRUE;
2612 }
2613 // Add description
2614 if ($data['description']) {
2615 $output['description'] = $data['description'];
2616 }
2617 }
2618 return $output;
2619 }
2620
2621 /**
2622 * Returns CSH help text
2623 *
2624 * @param string $table Table name
2625 * @param string $field Field name
2626 * @return string HTML content for help text
2627 * @see cshItem()
2628 */
2629 static public function helpText($table, $field) {
2630 $helpTextArray = self::helpTextArray($table, $field);
2631 $output = '';
2632 $arrow = '';
2633 // Put header before the rest of the text