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