Added feature #16396: Implement a Grid View + wizard to enable the backend layout...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_befunc.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Standard functions available for the TYPO3 backend.
29 * You are encouraged to use this class in your own applications (Backend Modules)
30 *
31 * Call ALL methods without making an object!
32 * Eg. to get a page-record 51 do this: 't3lib_BEfunc::getRecord('pages',51)'
33 *
34 * $Id$
35 * Usage counts are based on search 22/2 2003 through whole backend source of typo3/
36 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
37 * XHTML compliant
38 *
39 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
40 */
41 /**
42 * [CLASS/FUNCTION INDEX of SCRIPT]
43 *
44 *
45 *
46 * 185: class t3lib_BEfunc
47 *
48 * SECTION: SQL-related, selecting records, searching
49 * 206: function deleteClause($table,$tableAlias='')
50 * 230: function getRecord($table,$uid,$fields='*',$where='',$useDeleteClause=true)
51 * 253: function getRecordWSOL($table,$uid,$fields='*',$where='',$useDeleteClause=true)
52 * 286: function getRecordRaw($table,$where='',$fields='*')
53 * 309: function getRecordsByField($theTable,$theField,$theValue,$whereClause='',$groupBy='',$orderBy='',$limit='',$useDeleteClause=true)
54 * 342: function searchQuery($searchWords,$fields,$table='')
55 * 357: function listQuery($field,$value)
56 * 369: function splitTable_Uid($str)
57 * 384: function getSQLselectableList($in_list,$tablename,$default_tablename)
58 * 412: function BEenableFields($table,$inv=0)
59 *
60 * SECTION: SQL-related, DEPRECATED functions
61 * 476: function mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='')
62 * 498: function DBcompileInsert($table,$fields_values)
63 * 512: function DBcompileUpdate($table,$where,$fields_values)
64 *
65 * SECTION: Page tree, TCA related
66 * 542: function BEgetRootLine($uid,$clause='',$workspaceOL=FALSE)
67 * 598: function openPageTree($pid,$clearExpansion)
68 * 643: function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit=0)
69 * 686: function getExcludeFields()
70 * 716: function getExplicitAuthFieldValues()
71 * 787: function getSystemLanguages()
72 * 812: function readPageAccess($id,$perms_clause)
73 * 843: function getTCAtypes($table,$rec,$useFieldNameAsKey=0)
74 * 896: function getTCAtypeValue($table,$rec)
75 * 919: function getSpecConfParts($str, $defaultExtras)
76 * 950: function getSpecConfParametersFromArray($pArr)
77 * 978: function getFlexFormDS($conf,$row,$table,$fieldName='',$WSOL=TRUE)
78 *
79 * SECTION: Caching related
80 * 1105: function storeHash($hash,$data,$ident)
81 * 1125: function getHash($hash)
82 *
83 * SECTION: TypoScript related
84 * 1161: function getPagesTSconfig($id,$rootLine='',$returnPartArray=0)
85 * 1217: function updatePagesTSconfig($id,$pageTS,$TSconfPrefix,$impParams='')
86 * 1272: function implodeTSParams($p,$k='')
87 *
88 * SECTION: Users / Groups related
89 * 1309: function getUserNames($fields='username,usergroup,usergroup_cached_list,uid',$where='')
90 * 1327: function getGroupNames($fields='title,uid', $where='')
91 * 1344: function getListGroupNames($fields='title,uid')
92 * 1363: function blindUserNames($usernames,$groupArray,$excludeBlindedFlag=0)
93 * 1396: function blindGroupNames($groups,$groupArray,$excludeBlindedFlag=0)
94 *
95 * SECTION: Output related
96 * 1437: function daysUntil($tstamp)
97 * 1449: function date($tstamp)
98 * 1460: function datetime($value)
99 * 1472: function time($value)
100 * 1488: function calcAge($seconds,$labels = 'min|hrs|days|yrs')
101 * 1514: function dateTimeAge($tstamp,$prefix=1,$date='')
102 * 1532: function titleAttrib($content='',$hsc=0)
103 * 1545: function titleAltAttrib($content)
104 * 1569: function thumbCode($row,$table,$field,$backPath,$thumbScript='',$uploaddir=NULL,$abs=0,$tparams='',$size='')
105 * 1637: function getThumbNail($thumbScript,$theFile,$tparams='',$size='')
106 * 1654: function titleAttribForPages($row,$perms_clause='',$includeAttrib=1)
107 * 1716: function getRecordIconAltText($row,$table='pages')
108 * 1758: function getLabelFromItemlist($table,$col,$key)
109 * 1784: function getItemLabel($table,$col,$printAllWrap='')
110 * 1809: function getRecordTitle($table,$row,$prep=0)
111 * 1847: function getProcessedValue($table,$col,$value,$fixed_lgd_chars=0,$defaultPassthrough=0,$noRecordLookup=FALSE,$uid=0)
112 * 2009: function getProcessedValueExtra($table,$fN,$fV,$fixed_lgd_chars=0,$uid=0)
113 * 2033: function getFileIcon($ext)
114 * 2047: function getCommonSelectFields($table,$prefix='')
115 * 2090: function makeConfigForm($configArray,$defaults,$dataPrefix)
116 *
117 * SECTION: Backend Modules API functions
118 * 2165: function helpTextIcon($table,$field,$BACK_PATH,$force=0)
119 * 2187: function helpText($table,$field,$BACK_PATH,$styleAttrib='')
120 * 2239: function cshItem($table,$field,$BACK_PATH,$wrap='',$onlyIconMode=FALSE, $styleAttrib='')
121 * 2277: function editOnClick($params,$backPath='',$requestUri='')
122 * 2296: function viewOnClick($id,$backPath='',$rootLine='',$anchor='',$altUrl='',$addGetVars='',$switchFocus=TRUE)
123 * 2328: function getModTSconfig($id,$TSref)
124 * 2349: function getFuncMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='')
125 * 2392: function getFuncCheck($mainParams,$elementName,$currentValue,$script='',$addparams='',$tagParams='')
126 * 2417: function getFuncInput($mainParams,$elementName,$currentValue,$size=10,$script="",$addparams="")
127 * 2438: function unsetMenuItems($modTSconfig,$itemArray,$TSref)
128 * 2461: function getSetUpdateSignal($set='')
129 * 2512: function getModuleData($MOD_MENU, $CHANGED_SETTINGS, $modName, $type='', $dontValidateList='', $setDefaultList='')
130 *
131 * SECTION: Core
132 * 2585: function compilePreviewKeyword($getVarsStr, $beUserUid, $ttl=172800)
133 * 2613: function lockRecords($table='',$uid=0,$pid=0)
134 * 2642: function isRecordLocked($table,$uid)
135 * 2682: function exec_foreign_table_where_query($fieldValue,$field='',$TSconfig=array(),$prefix='')
136 * 2763: function getTCEFORM_TSconfig($table,$row)
137 * 2814: function getTSconfig_pidValue($table,$uid,$pid)
138 * 2844: function getPidForModTSconfig($table,$uid,$pid)
139 * 2860: function getTSCpid($table,$uid,$pid)
140 * 2876: function firstDomainRecord($rootLine)
141 * 2898: function getDomainStartPage($domain, $path='')
142 * 2928: function RTEsetup($RTEprop,$table,$field,$type='')
143 * 2947: function &RTEgetObj()
144 * 2986: function &softRefParserObj($spKey)
145 * 3018: function explodeSoftRefParserList($parserList)
146 * 3050: function isModuleSetInTBE_MODULES($modName)
147 * 3073: function referenceCount($table,$ref,$msg='')
148 *
149 * SECTION: Workspaces / Versioning
150 * 3132: function selectVersionsOfRecord($table, $uid, $fields='*', $workspace=0)
151 * 3180: function fixVersioningPid($table,&$rr,$ignoreWorkspaceMatch=FALSE)
152 * 3220: function workspaceOL($table,&$row,$wsid=-99)
153 * 3268: function getWorkspaceVersionOfRecord($workspace, $table, $uid, $fields='*')
154 * 3297: function getLiveVersionOfRecord($table,$uid,$fields='*')
155 * 3319: function isPidInVersionizedBranch($pid, $table='',$returnStage=FALSE)
156 * 3342: function versioningPlaceholderClause($table)
157 * 3356: function countVersionsOfRecordsOnPage($workspace,$pageId, $allTables=FALSE)
158 * 3391: function wsMapId($table,$uid)
159 *
160 * SECTION: Miscellaneous
161 * 3421: function typo3PrintError($header,$text,$js='',$head=1)
162 * 3465: function TYPO3_copyRightNotice()
163 * 3489: function displayWarningMessages()
164 * 3546: function getPathType_web_nonweb($path)
165 * 3558: function ADMCMD_previewCmds($pageinfo)
166 * 3580: function processParams($params)
167 * 3606: function getListOfBackendModules($name,$perms_clause,$backPath='',$script='index.php')
168 *
169 * TOTAL FUNCTIONS: 99
170 * (This index is automatically created/updated by the extension "extdeveval")
171 *
172 */
173
174
175
176 /**
177 * Standard functions available for the TYPO3 backend.
178 * Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
179 *
180 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
181 * @package TYPO3
182 * @subpackage t3lib
183 */
184 final class t3lib_BEfunc {
185
186
187
188 /*******************************************
189 *
190 * SQL-related, selecting records, searching
191 *
192 *******************************************/
193
194
195 /**
196 * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field is configured in $TCA for the tablename, $table
197 * This function should ALWAYS be called in the backend for selection on tables which are configured in 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!)
198 * 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.
199 * Usage: 71
200 *
201 * @param string Table name present in $TCA
202 * @param string Table alias if any
203 * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0"
204 */
205 public static function deleteClause($table,$tableAlias = '') {
206 global $TCA;
207 if ($TCA[$table]['ctrl']['delete']) {
208 return ' AND '.($tableAlias ? $tableAlias : $table).'.'.$TCA[$table]['ctrl']['delete'].'=0';
209 } else {
210 return '';
211 }
212 }
213
214 /**
215 * Gets record with uid = $uid from $table
216 * You can set $field to a list of fields (default is '*')
217 * Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1')
218 * Will automatically check if records has been deleted and if so, not return anything.
219 * $table must be found in $TCA
220 * Usage: 99
221 *
222 * @param string Table name present in $TCA
223 * @param integer UID of record
224 * @param string List of fields to select
225 * @param string Additional WHERE clause, eg. " AND blablabla = 0"
226 * @param boolean Use the deleteClause to check if a record is deleted (default true)
227 * @return array Returns the row if found, otherwise nothing
228 */
229 public static function getRecord($table, $uid, $fields = '*', $where = '', $useDeleteClause = true) {
230 if ($GLOBALS['TCA'][$table]) {
231 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
232 $fields,
233 $table,
234 'uid=' . intval($uid) . ($useDeleteClause ? self::deleteClause($table) : '') . $where
235 );
236 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
237 $GLOBALS['TYPO3_DB']->sql_free_result($res);
238 if ($row) {
239 return $row;
240 }
241 }
242 }
243
244 /**
245 * Like getRecord(), but overlays workspace version if any.
246 *
247 * @param string Table name present in $TCA
248 * @param integer UID of record
249 * @param string List of fields to select
250 * @param string Additional WHERE clause, eg. " AND blablabla = 0"
251 * @param boolean Use the deleteClause to check if a record is deleted (default true)
252 * @return array Returns the row if found, otherwise nothing
253 */
254 public static function getRecordWSOL($table, $uid, $fields = '*', $where = '', $useDeleteClause = true) {
255 if ($fields !== '*') {
256 $internalFields = t3lib_div::uniqueList($fields.',uid,pid'.($table == 'pages' ? ',t3ver_swapmode' : ''));
257 $row = self::getRecord($table, $uid, $internalFields, $where, $useDeleteClause);
258 self::workspaceOL($table, $row);
259
260 if (is_array ($row)) {
261 foreach (array_keys($row) as $key) {
262 if (!t3lib_div::inList($fields, $key) && $key{0} !== '_') {
263 unset ($row[$key]);
264 }
265 }
266 }
267 } else {
268 $row = self::getRecord($table, $uid, $fields, $where);
269 self::workspaceOL($table, $row);
270 }
271 return $row;
272 }
273
274 /**
275 * Returns the first record found from $table with $where as WHERE clause
276 * This function does NOT check if a record has the deleted flag set.
277 * $table does NOT need to be configured in $TCA
278 * The query used is simply this:
279 * $query = 'SELECT '.$fields.' FROM '.$table.' WHERE '.$where;
280 * Usage: 5 (ext: sys_todos)
281 *
282 * @param string Table name (not necessarily in TCA)
283 * @param string WHERE clause
284 * @param string $fields is a list of fields to select, default is '*'
285 * @return array First row found, if any, FALSE otherwise
286 */
287 public static function getRecordRaw($table, $where = '', $fields = '*') {
288 $row = FALSE;
289 if (FALSE !== ($res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($fields, $table, $where, '', '', '1'))) {
290 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
291 $GLOBALS['TYPO3_DB']->sql_free_result($res);
292 }
293 return $row;
294 }
295
296 /**
297 * Returns records from table, $theTable, where a field ($theField) equals the value, $theValue
298 * The records are returned in an array
299 * If no records were selected, the function returns nothing
300 * Usage: 8
301 *
302 * @param string Table name present in $TCA
303 * @param string Field to select on
304 * @param string Value that $theField must match
305 * @param string Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
306 * @param string Optional GROUP BY field(s), if none, supply blank string.
307 * @param string Optional ORDER BY field(s), if none, supply blank string.
308 * @param string Optional LIMIT value ([begin,]max), if none, supply blank string.
309 * @param boolean Use the deleteClause to check if a record is deleted (default true)
310 * @return mixed Multidimensional array with selected records (if any is selected)
311 */
312 public static function getRecordsByField($theTable, $theField, $theValue, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '', $useDeleteClause = true) {
313 global $TCA;
314 if (is_array($TCA[$theTable])) {
315 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
316 '*',
317 $theTable,
318 $theField.'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($theValue, $theTable).
319 ($useDeleteClause ? self::deleteClause($theTable).' ' : '').
320 self::versioningPlaceholderClause($theTable) . ' ' .
321 $whereClause, // whereClauseMightContainGroupOrderBy
322 $groupBy,
323 $orderBy,
324 $limit
325 );
326 $rows = array();
327 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
328 $rows[] = $row;
329 }
330 $GLOBALS['TYPO3_DB']->sql_free_result($res);
331 if (count($rows)) return $rows;
332 }
333 }
334
335 /**
336 * Returns a WHERE clause which will make an AND search for the words in the $searchWords array in any of the fields in array $fields.
337 * Usage: 0
338 *
339 * @param array Array of search words
340 * @param array Array of fields
341 * @param string Table in which we are searching (for DBAL detection of quoteStr() method)
342 * @return string WHERE clause for search
343 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6, use $GLOBALS['TYPO3_DB']->searchQuery() directly!
344 */
345 public static function searchQuery($searchWords, $fields, $table = '') {
346 t3lib_div::logDeprecatedFunction();
347
348 return $GLOBALS['TYPO3_DB']->searchQuery($searchWords, $fields, $table);
349 }
350
351 /**
352 * Returns a WHERE clause that can find a value ($value) in a list field ($field)
353 * For instance a record in the database might contain a list of numbers, "34,234,5" (with no spaces between). This query would be able to select that record based on the value "34", "234" or "5" regardless of their positioni in the list (left, middle or right).
354 * Is nice to look up list-relations to records or files in TYPO3 database tables.
355 * Usage: 0
356 *
357 * @param string Table field name
358 * @param string Value to find in list
359 * @return string WHERE clause for a query
360 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6, use $GLOBALS['TYPO3_DB']->listQuery() directly!
361 */
362 public static function listQuery($field, $value) {
363 t3lib_div::logDeprecatedFunction();
364
365 return $GLOBALS['TYPO3_DB']->listQuery($field, $value, '');
366 }
367
368 /**
369 * Makes an backwards explode on the $str and returns an array with ($table, $uid).
370 * Example: tt_content_45 => array('tt_content', 45)
371 * Usage: 1
372 *
373 * @param string [tablename]_[uid] string to explode
374 * @return array
375 */
376 public static function splitTable_Uid($str) {
377 list($uid, $table) = explode('_', strrev($str), 2);
378 return array(strrev($table), strrev($uid));
379 }
380
381 /**
382 * Returns a list of pure integers based on $in_list being a list of records with table-names prepended.
383 * 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.
384 * Usage: 1 (t3lib_userauthgroup)
385 *
386 * @param string Input list
387 * @param string Table name from which ids is returned
388 * @param string $default_tablename denotes what table the number '45' is from (if nothing is prepended on the value)
389 * @return string List of ids
390 */
391 public static function getSQLselectableList($in_list, $tablename, $default_tablename) {
392 $list = Array();
393 if ((string)trim($in_list)!='') {
394 $tempItemArray = explode(',', trim($in_list));
395 foreach ($tempItemArray as $key => $val) {
396 $val = strrev($val);
397 $parts = explode('_', $val, 2);
398 if ((string)trim($parts[0])!='') {
399 $theID = intval(strrev($parts[0]));
400 $theTable = trim($parts[1]) ? strrev(trim($parts[1])) : $default_tablename;
401 if ($theTable==$tablename) {$list[] = $theID;}
402 }
403 }
404 }
405 return implode(',', $list);
406 }
407
408 /**
409 * Backend implementation of enableFields()
410 * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
411 * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
412 * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
413 * Usage: 5
414 *
415 * @param string $table is the table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $TCA.
416 * @param boolean $inv means that the query will select all records NOT VISIBLE records (inverted selection)
417 * @return string WHERE clause part
418 */
419 public static function BEenableFields($table, $inv = 0) {
420 $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
421 $query = array();
422 $invQuery = array();
423 if (is_array($ctrl)) {
424 if (is_array($ctrl['enablecolumns'])) {
425 if ($ctrl['enablecolumns']['disabled']) {
426 $field = $table.'.'.$ctrl['enablecolumns']['disabled'];
427 $query[] = $field.'=0';
428 $invQuery[] = $field.'!=0';
429 }
430 if ($ctrl['enablecolumns']['starttime']) {
431 $field = $table.'.'.$ctrl['enablecolumns']['starttime'];
432 $query[] = '('.$field.'<='.$GLOBALS['SIM_ACCESS_TIME'].')';
433 $invQuery[] = '('.$field.'!=0 AND '.$field.'>'.$GLOBALS['SIM_ACCESS_TIME'].')';
434 }
435 if ($ctrl['enablecolumns']['endtime']) {
436 $field = $table.'.'.$ctrl['enablecolumns']['endtime'];
437 $query[] = '('.$field.'=0 OR '.$field.'>'.$GLOBALS['SIM_ACCESS_TIME'].')';
438 $invQuery[] = '('.$field.'!=0 AND '.$field.'<='.$GLOBALS['SIM_ACCESS_TIME'].')';
439 }
440 }
441 }
442 $outQ = ($inv ? '(' . implode(' OR ', $invQuery) . ')' : implode(' AND ', $query));
443
444 return $outQ ? ' AND ' . $outQ : '';
445 }
446
447 /**
448 * Fetches the localization for a given record.
449 *
450 * @param string $table: Table name present in $TCA
451 * @param integer $uid: The uid of the record
452 * @param integer $language: The uid of the language record in sys_language
453 * @param string $andWhereClause: Optional additional WHERE clause (default: '')
454 * @return mixed Multidimensional array with selected records; if none exist, false is returned
455 */
456 public static function getRecordLocalization($table, $uid, $language, $andWhereClause = '') {
457 $recordLocalization = false;
458 if (self::isTableLocalizable($table)) {
459 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
460 $recordLocalization = self::getRecordsByField(
461 $table,
462 $tcaCtrl['transOrigPointerField'],
463 $uid,
464 'AND '.$tcaCtrl['languageField'].'='.intval($language).($andWhereClause ? ' '.$andWhereClause : ''),
465 '',
466 '',
467 '1'
468 );
469 }
470 return $recordLocalization;
471 }
472
473
474
475
476
477
478
479
480
481
482 /*******************************************
483 *
484 * SQL-related, DEPRECATED functions
485 * (use t3lib_DB functions instead)
486 *
487 *******************************************/
488
489
490 /**
491 * Returns a SELECT query, selecting fields ($select) from two/three tables joined
492 * $local_table and $mm_table is mandatory. $foreign_table is optional.
493 * The JOIN is done with [$local_table].uid <--> [$mm_table].uid_local / [$mm_table].uid_foreign <--> [$foreign_table].uid
494 * The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $TCA in Inside TYPO3 for more details.
495 *
496 * @param string Field list for SELECT
497 * @param string Tablename, local table
498 * @param string Tablename, relation table
499 * @param string Tablename, foreign table
500 * @param string Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
501 * @param string Optional GROUP BY field(s), if none, supply blank string.
502 * @param string Optional ORDER BY field(s), if none, supply blank string.
503 * @param string Optional LIMIT value ([begin,]max), if none, supply blank string.
504 * @return string Full SQL query
505 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6, use $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query() instead since that will return the result pointer while this returns the query. Using this function may make your application less fitted for DBAL later.
506 * @see t3lib_DB::exec_SELECT_mm_query()
507 */
508 public static function mm_query($select, $local_table, $mm_table, $foreign_table, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '') {
509 t3lib_div::logDeprecatedFunction();
510
511 $query = $GLOBALS['TYPO3_DB']->SELECTquery(
512 $select,
513 $local_table.','.$mm_table.($foreign_table?','.$foreign_table:''),
514 $local_table.'.uid='.$mm_table.'.uid_local'.($foreign_table?' AND '.$foreign_table.'.uid='.$mm_table.'.uid_foreign':'').' '.
515 $whereClause, // whereClauseMightContainGroupOrderBy
516 $groupBy,
517 $orderBy,
518 $limit
519 );
520 return $query;
521 }
522
523 /**
524 * Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
525 * DEPRECATED - $GLOBALS['TYPO3_DB']->INSERTquery() directly instead! But better yet, use $GLOBALS['TYPO3_DB']->exec_INSERTquery()
526 *
527 * @param string Table name
528 * @param array Field values as key=>value pairs.
529 * @return string Full SQL query for INSERT
530 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6, use $GLOBALS['TYPO3_DB']->exec_INSERTquery() directly!
531 */
532 public static function DBcompileInsert($table, $fields_values) {
533 t3lib_div::logDeprecatedFunction();
534
535 return $GLOBALS['TYPO3_DB']->INSERTquery($table, $fields_values);
536 }
537
538 /**
539 * Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
540 * DEPRECATED - $GLOBALS['TYPO3_DB']->UPDATEquery() directly instead! But better yet, use $GLOBALS['TYPO3_DB']->exec_UPDATEquery()
541 *
542 * @param string Database tablename
543 * @param string WHERE clause, eg. "uid=1"
544 * @param array Field values as key=>value pairs.
545 * @return string Full SQL query for UPDATE
546 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6, use $GLOBALS['TYPO3_DB']->exec_UPDATEquery() directly!
547 */
548 public static function DBcompileUpdate($table, $where, $fields_values) {
549 t3lib_div::logDeprecatedFunction();
550
551 return $GLOBALS['TYPO3_DB']->UPDATEquery($table, $where, $fields_values);
552 }
553
554
555
556
557
558
559
560
561
562
563 /*******************************************
564 *
565 * Page tree, TCA related
566 *
567 *******************************************/
568
569 /**
570 * 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.
571 * By default deleted pages are filtered.
572 * 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.
573 * Usage: 1
574 *
575 * @param integer Page id for which to create the root line.
576 * @param string $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.
577 * @param boolean 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!
578 * @return array Root line array, all the way to the page tree root (or as far as $clause allows!)
579 */
580 public static function BEgetRootLine($uid, $clause = '', $workspaceOL = FALSE) {
581 static $BEgetRootLine_cache = array();
582
583 $output = array();
584 $pid = $uid;
585 $ident = $pid . '-' . $clause . '-' . $workspaceOL;
586
587 if (is_array($BEgetRootLine_cache[$ident])) {
588 $output = $BEgetRootLine_cache[$ident];
589 } else {
590 $loopCheck = 100;
591 $theRowArray = array();
592 while ($uid != 0 && $loopCheck) {
593 $loopCheck--;
594 $row = self::getPageForRootline($uid, $clause, $workspaceOL);
595 if (is_array($row)) {
596 $uid = $row['pid'];
597 $theRowArray[] = $row;
598 } else {
599 break;
600 }
601 }
602 if ($uid == 0) {
603 $theRowArray[] = array('uid' => 0, 'title' => '');
604 }
605 $c = count($theRowArray);
606
607 foreach ($theRowArray as $val) {
608 $c--;
609 $output[$c] = array(
610 'uid' => $val['uid'],
611 'pid' => $val['pid'],
612 'title' => $val['title'],
613 'TSconfig' => $val['TSconfig'],
614 'is_siteroot' => $val['is_siteroot'],
615 'storage_pid' => $val['storage_pid'],
616 't3ver_oid' => $val['t3ver_oid'],
617 't3ver_wsid' => $val['t3ver_wsid'],
618 't3ver_state' => $val['t3ver_state'],
619 't3ver_swapmode' => $val['t3ver_swapmode'],
620 't3ver_stage' => $val['t3ver_stage'],
621 'be_layout' => $val['be_layout']
622 );
623 if (isset($val['_ORIG_pid'])) {
624 $output[$c]['_ORIG_pid'] = $val['_ORIG_pid'];
625 }
626 }
627 $BEgetRootLine_cache[$ident] = $output;
628 }
629 return $output;
630 }
631
632 /**
633 * Gets the cached page record for the rootline
634 *
635 * @param integer $uid: Page id for which to create the root line.
636 * @param string $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.
637 * @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!
638 * @return array Cached page record for the rootline
639 * @see BEgetRootLine
640 */
641 protected static function getPageForRootline($uid, $clause, $workspaceOL) {
642 static $getPageForRootline_cache = array();
643 $ident = $uid . '-' . $clause . '-' . $workspaceOL;
644
645 if (is_array($getPageForRootline_cache[$ident])) {
646 $row = $getPageForRootline_cache[$ident];
647 } else {
648 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
649 'pid,uid,title,TSconfig,is_siteroot,storage_pid,t3ver_oid,t3ver_wsid,t3ver_state,t3ver_swapmode,t3ver_stage,be_layout',
650 'pages',
651 'uid=' . intval($uid) . ' ' .
652 self::deleteClause('pages') . ' ' .
653 $clause // whereClauseMightContainGroupOrderBy
654 );
655
656 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
657 if ($row) {
658 if ($workspaceOL) {
659 self::workspaceOL('pages', $row);
660 }
661 if (is_array($row)) {
662 self::fixVersioningPid('pages', $row);
663 $getPageForRootline_cache[$ident] = $row;
664 }
665 }
666 $GLOBALS['TYPO3_DB']->sql_free_result($res);
667 }
668 return $row;
669 }
670
671 /**
672 * Opens the page tree to the specified page id
673 *
674 * @param integer Page id.
675 * @param boolean If set, then other open branches are closed.
676 * @return void
677 */
678 public static function openPageTree($pid, $clearExpansion) {
679 global $BE_USER;
680
681 // Get current expansion data:
682 if ($clearExpansion) {
683 $expandedPages = array();
684 } else {
685 $expandedPages = unserialize($BE_USER->uc['browseTrees']['browsePages']);
686 }
687
688 // Get rootline:
689 $rL = self::BEgetRootLine($pid);
690
691 // First, find out what mount index to use (if more than one DB mount exists):
692 $mountIndex = 0;
693 $mountKeys = array_flip($BE_USER->returnWebmounts());
694 foreach($rL as $rLDat) {
695 if (isset($mountKeys[$rLDat['uid']])) {
696 $mountIndex = $mountKeys[$rLDat['uid']];
697 break;
698 }
699 }
700
701 // Traverse rootline and open paths:
702 foreach($rL as $rLDat) {
703 $expandedPages[$mountIndex][$rLDat['uid']] = 1;
704 }
705
706 // Write back:
707 $BE_USER->uc['browseTrees']['browsePages'] = serialize($expandedPages);
708 $BE_USER->writeUC();
709 }
710
711 /**
712 * Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
713 * Each part of the path will be limited to $titleLimit characters
714 * Deleted pages are filtered out.
715 * Usage: 15
716 *
717 * @param integer Page uid for which to create record path
718 * @param string $clause is additional where clauses, eg. "
719 * @param integer Title limit
720 * @param integer Title limit of Full title (typ. set to 1000 or so)
721 * @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
722 */
723 public static function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit = 0) {
724 if (!$titleLimit) { $titleLimit = 1000; }
725
726 $loopCheck = 100;
727 $output = $fullOutput = '/';
728
729 $clause = trim($clause);
730 if ($clause !== '' && substr($clause, 0, 3) !== 'AND') {
731 $clause = 'AND ' . $clause;
732 }
733 $data = self::BEgetRootLine($uid, $clause);
734
735 foreach ($data as $record) {
736 if ($record['uid'] === 0) {
737 continue;
738 }
739 if ($record['_ORIG_pid'] && $record['t3ver_swapmode'] > 0) { // Branch points
740 $output = ' [#VEP#]' . $output; // Adding visual token - Versioning Entry Point - that tells that THIS position was where the versionized branch got connected to the main tree. I will have to find a better name or something...
741 }
742 $output = '/' . t3lib_div::fixed_lgd_cs(strip_tags($record['title']), $titleLimit) . $output;
743 if ($fullTitleLimit) {
744 $fullOutput = '/' . t3lib_div::fixed_lgd_cs(strip_tags($record['title']), $fullTitleLimit) . $fullOutput;
745 }
746 }
747
748 if ($fullTitleLimit) {
749 return array($output, $fullOutput);
750 } else {
751 return $output;
752 }
753 }
754
755 /**
756 * Returns an array with the exclude-fields as defined in TCA
757 * Used for listing the exclude-fields in be_groups forms
758 * Usage: 2 (t3lib_tceforms + t3lib_transferdata)
759 *
760 * @return array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries
761 */
762 public static function getExcludeFields() {
763 global $TCA;
764 // All TCA keys:
765 $theExcludeArray = Array();
766 $tc_keys = array_keys($TCA);
767 foreach($tc_keys as $table) {
768 // Load table
769 t3lib_div::loadTCA($table);
770 // All field names configured:
771 if (is_array($TCA[$table]['columns'])) {
772 $f_keys = array_keys($TCA[$table]['columns']);
773 foreach($f_keys as $field) {
774 if ($TCA[$table]['columns'][$field]['exclude']) {
775 // Get Human Readable names of fields and table:
776 $Fname = $GLOBALS['LANG']->sl($TCA[$table]['ctrl']['title']).': '.$GLOBALS['LANG']->sl($TCA[$table]['columns'][$field]['label']);
777 // add entry:
778 $theExcludeArray[] = Array($Fname, $table.':'.$field);
779 }
780 }
781 }
782 }
783 return $theExcludeArray;
784 }
785
786 /**
787 * Returns an array with explicit Allow/Deny fields.
788 * Used for listing these field/value pairs in be_groups forms
789 *
790 * @return array Array with information from all of $TCA
791 */
792 public static function getExplicitAuthFieldValues() {
793 global $TCA;
794
795 // Initialize:
796 $adLabel = array(
797 'ALLOW' => $GLOBALS['LANG']->sl('LLL:EXT:lang/locallang_core.xml:labels.allow'),
798 'DENY' => $GLOBALS['LANG']->sl('LLL:EXT:lang/locallang_core.xml:labels.deny'),
799 );
800
801 // All TCA keys:
802 $allowDenyOptions = Array();
803 $tc_keys = array_keys($TCA);
804 foreach($tc_keys as $table) {
805
806 // Load table
807 t3lib_div::loadTCA($table);
808
809 // All field names configured:
810 if (is_array($TCA[$table]['columns'])) {
811 $f_keys = array_keys($TCA[$table]['columns']);
812 foreach($f_keys as $field) {
813 $fCfg = $TCA[$table]['columns'][$field]['config'];
814 if ($fCfg['type']=='select' && $fCfg['authMode']) {
815
816 // Check for items:
817 if (is_array($fCfg['items'])) {
818 // Get Human Readable names of fields and table:
819 $allowDenyOptions[$table.':'.$field]['tableFieldLabel'] = $GLOBALS['LANG']->sl($TCA[$table]['ctrl']['title']).': '.$GLOBALS['LANG']->sl($TCA[$table]['columns'][$field]['label']);
820
821 // Check for items:
822 foreach($fCfg['items'] as $iVal) {
823 if (strcmp($iVal[1], '')) { // Values '' is not controlled by this setting.
824
825 // Find iMode:
826 $iMode = '';
827 switch((string)$fCfg['authMode']) {
828 case 'explicitAllow':
829 $iMode = 'ALLOW';
830 break;
831 case 'explicitDeny':
832 $iMode = 'DENY';
833 break;
834 case 'individual':
835 if (!strcmp($iVal[4], 'EXPL_ALLOW')) {
836 $iMode = 'ALLOW';
837 } elseif (!strcmp($iVal[4], 'EXPL_DENY')) {
838 $iMode = 'DENY';
839 }
840 break;
841 }
842
843 // Set iMode:
844 if ($iMode) {
845 $allowDenyOptions[$table.':'.$field]['items'][$iVal[1]] = array($iMode, $GLOBALS['LANG']->sl($iVal[0]), $adLabel[$iMode]);
846 }
847 }
848 }
849 }
850 }
851 }
852 }
853 }
854
855 return $allowDenyOptions;
856 }
857
858 /**
859 * Returns an array with system languages:
860 *
861 * @return array Array with languages
862 */
863 public static function getSystemLanguages() {
864
865 // Initialize, add default language:
866 $sysLanguages = array();
867 $sysLanguages[] = array('Default language', 0);
868
869 // Traverse languages
870 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,title,flag', 'sys_language', 'pid=0' . self::deleteClause('sys_language'));
871 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
872 $sysLanguages[] = array(
873 htmlspecialchars($row['title']) . ' [' . $row['uid'] . ']',
874 $row['uid'],
875 ($row['flag'] ? 'flags/' . $row['flag'] : '')
876 );
877 }
878 $GLOBALS['TYPO3_DB']->sql_free_result($res);
879
880 return $sysLanguages;
881 }
882
883 /**
884 * Determines whether a table is localizable and has the languageField and transOrigPointerField set in $TCA.
885 *
886 * @param string $table: The table to check
887 * @return boolean Whether a table is localizable
888 */
889 public static function isTableLocalizable($table) {
890 $isLocalizable = false;
891 if (isset($GLOBALS['TCA'][$table]['ctrl']) && is_array($GLOBALS['TCA'][$table]['ctrl'])) {
892 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
893 $isLocalizable = (isset($tcaCtrl['languageField']) && $tcaCtrl['languageField'] && isset($tcaCtrl['transOrigPointerField']) && $tcaCtrl['transOrigPointerField']);
894 }
895 return $isLocalizable;
896 }
897
898 /**
899 * Returns the value of the property localizationMode in the given $config array ($TCA[<table>]['columns'][<field>]['config']).
900 * If the table is prepared for localization and no localizationMode is set, 'select' is returned by default.
901 * If the table is not prepared for localization or not defined at all in $TCA, false is returned.
902 *
903 * @param string $table: The name of the table to lookup in TCA
904 * @param mixed $fieldOrConfig: The fieldname (string) or the configuration of the field to check (array)
905 * @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
906 */
907 public static function getInlineLocalizationMode($table, $fieldOrConfig) {
908 $localizationMode = false;
909 if (is_array($fieldOrConfig) && count($fieldOrConfig)) {
910 $config = $fieldOrConfig;
911 } elseif (is_string($fieldOrConfig) && isset($GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'])) {
912 $config = $GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'];
913 }
914 if (is_array($config) && isset($config['type']) && $config['type']=='inline' && self::isTableLocalizable($table)) {
915 $localizationMode = (isset($config['behaviour']['localizationMode']) && $config['behaviour']['localizationMode'] ? $config['behaviour']['localizationMode'] : 'select');
916 // The mode 'select' is not possible when child table is not localizable at all:
917 if ($localizationMode=='select' && !self::isTableLocalizable($config['foreign_table'])) {
918 $localizationMode = false;
919 }
920 }
921 return $localizationMode;
922 }
923
924 /**
925 * 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.
926 * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
927 * In any case ->isInWebMount must return true for the user (regardless of $perms_clause)
928 * Usage: 21
929 *
930 * @param integer Page uid for which to check read-access
931 * @param string $perms_clause is typically a value generated with $BE_USER->getPagePermsClause(1);
932 * @return array Returns page record if OK, otherwise false.
933 */
934 public static function readPageAccess($id, $perms_clause) {
935 if ((string)$id!='') {
936 $id = intval($id);
937 if (!$id) {
938 if ($GLOBALS['BE_USER']->isAdmin()) {
939 $path = '/';
940 $pageinfo['_thePath'] = $path;
941 return $pageinfo;
942 }
943 } else {
944 $pageinfo = self::getRecord('pages', $id, '*', ($perms_clause ? ' AND ' . $perms_clause : ''));
945 if ($pageinfo['uid'] && $GLOBALS['BE_USER']->isInWebMount($id, $perms_clause)) {
946 self::workspaceOL('pages', $pageinfo);
947 if (is_array($pageinfo)) {
948 self::fixVersioningPid('pages', $pageinfo);
949 list($pageinfo['_thePath'], $pageinfo['_thePathFull']) = self::getRecordPath(intval($pageinfo['uid']), $perms_clause, 15, 1000);
950 return $pageinfo;
951 }
952 }
953 }
954 }
955 return false;
956 }
957
958 /**
959 * Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
960 * Usage: 6
961 *
962 * @param string Table name (present in TCA)
963 * @param array Record from $table
964 * @param boolean If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
965 * @return array
966 */
967 public static function getTCAtypes($table, $rec, $useFieldNameAsKey = 0) {
968 global $TCA;
969
970 t3lib_div::loadTCA($table);
971 if ($TCA[$table]) {
972
973 // Get type value:
974 $fieldValue = self::getTCAtypeValue($table, $rec);
975
976 // Get typesConf
977 $typesConf = $TCA[$table]['types'][$fieldValue];
978
979 // Get fields list and traverse it
980 $fieldList = explode(',', $typesConf['showitem']);
981 $altFieldList = array();
982
983 // Traverse fields in types config and parse the configuration into a nice array:
984 foreach($fieldList as $k => $v) {
985 list($pFieldName, $pAltTitle, $pPalette, $pSpec) = t3lib_div::trimExplode(';', $v);
986 $defaultExtras = is_array($TCA[$table]['columns'][$pFieldName]) ? $TCA[$table]['columns'][$pFieldName]['defaultExtras'] : '';
987 $specConfParts = self::getSpecConfParts($pSpec, $defaultExtras);
988
989 $fieldList[$k] = array(
990 'field' => $pFieldName,
991 'title' => $pAltTitle,
992 'palette' => $pPalette,
993 'spec' => $specConfParts,
994 'origString' => $v
995 );
996 if ($useFieldNameAsKey) {
997 $altFieldList[$fieldList[$k]['field']] = $fieldList[$k];
998 }
999 }
1000 if ($useFieldNameAsKey) {
1001 $fieldList = $altFieldList;
1002 }
1003
1004 // Return array:
1005 return $fieldList;
1006 }
1007 }
1008
1009 /**
1010 * Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $TCA
1011 * If no "type" field is configured in the "ctrl"-section of the $TCA for the table, zero is used.
1012 * If zero is not an index in the "types" section of $TCA for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)
1013 * Usage: 7
1014 *
1015 * @param string Table name present in TCA
1016 * @param array Record from $table
1017 * @return string Field value
1018 * @see getTCAtypes()
1019 */
1020 public static function getTCAtypeValue($table, $rec) {
1021 global $TCA;
1022
1023 // If no field-value, set it to zero. If there is no type matching the field-value (which now may be zero...) test field-value '1' as default.
1024 t3lib_div::loadTCA($table);
1025 if ($TCA[$table]) {
1026 $field = $TCA[$table]['ctrl']['type'];
1027 $fieldValue = $field ? ($rec[$field] ? $rec[$field] : 0) : 0;
1028 if (!is_array($TCA[$table]['types'][$fieldValue])) $fieldValue = 1;
1029 return $fieldValue;
1030 }
1031 }
1032
1033 /**
1034 * Parses a part of the field lists in the "types"-section of $TCA arrays, namely the "special configuration" at index 3 (position 4)
1035 * Elements are splitted by ":" and within those parts, parameters are splitted by "|".
1036 * 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
1037 * Usage: 5
1038 *
1039 * @param string Content from the "types" configuration of TCA (the special configuration) - see description of function
1040 * @param string The ['defaultExtras'] value from field configuration
1041 * @return array
1042 */
1043 public static function getSpecConfParts($str, $defaultExtras) {
1044
1045 // Add defaultExtras:
1046 $specConfParts = t3lib_div::trimExplode(':', $defaultExtras.':'.$str, 1);
1047
1048 $reg = array();
1049 if (count($specConfParts)) {
1050 foreach($specConfParts as $k2 => $v2) {
1051 unset($specConfParts[$k2]);
1052 if (preg_match('/(.*)\[(.*)\]/', $v2, $reg)) {
1053 $specConfParts[trim($reg[1])] = array(
1054 'parameters' => t3lib_div::trimExplode('|', $reg[2], 1)
1055 );
1056 } else {
1057 $specConfParts[trim($v2)] = 1;
1058 }
1059 }
1060 } else {
1061 $specConfParts = array();
1062 }
1063 return $specConfParts;
1064 }
1065
1066 /**
1067 * Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value.
1068 * Better see it in action! Find example in Inside TYPO3
1069 * Usage: 6
1070 *
1071 * @param array Array of "[key] = [value]" strings to convert.
1072 * @return array
1073 */
1074 public static function getSpecConfParametersFromArray($pArr) {
1075 $out = array();
1076 if (is_array($pArr)) {
1077 foreach ($pArr as $k => $v) {
1078 $parts = explode('=', $v, 2);
1079 if (count($parts)==2) {
1080 $out[trim($parts[0])] = trim($parts[1]);
1081 } else {
1082 $out[$k] = $v;
1083 }
1084 }
1085 }
1086 return $out;
1087 }
1088
1089 /**
1090 * Finds the Data Structure for a FlexForm field
1091 * 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.
1092 * Usage: 5
1093 *
1094 * @param array Field config array
1095 * @param array Record data
1096 * @param string The table name
1097 * @param string Optional fieldname passed to hook object
1098 * @param boolean 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.
1099 * @param integer 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)
1100 * @return mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.
1101 * @see t3lib_TCEforms::getSingleField_typeFlex()
1102 */
1103 public static function getFlexFormDS($conf, $row, $table, $fieldName = '', $WSOL = TRUE, $newRecordPidValue = 0) {
1104 global $TYPO3_CONF_VARS;
1105
1106 // Get pointer field etc from TCA-config:
1107 $ds_pointerField = $conf['ds_pointerField'];
1108 $ds_array = $conf['ds'];
1109 $ds_tableField = $conf['ds_tableField'];
1110 $ds_searchParentField = $conf['ds_pointerField_searchParent'];
1111
1112 // Find source value:
1113 $dataStructArray = '';
1114 if (is_array($ds_array)) { // If there is a data source array, that takes precedence
1115 // If a pointer field is set, take the value from that field in the $row array and use as key.
1116 if ($ds_pointerField) {
1117
1118 // Up to two pointer fields can be specified in a comma separated list.
1119 $pointerFields = t3lib_div::trimExplode(',', $ds_pointerField);
1120 if(count($pointerFields) == 2) { // 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.
1121 if($ds_array[$row[$pointerFields[0]].','.$row[$pointerFields[1]]]) { // Check if we have a DS for the combination of both pointer fields values
1122 $srcPointer = $row[$pointerFields[0]].','.$row[$pointerFields[1]];
1123 } elseif($ds_array[$row[$pointerFields[1]].',*']) { // Check if we have a DS for the value of the first pointer field suffixed with ",*"
1124 $srcPointer = $row[$pointerFields[1]].',*';
1125 } elseif($ds_array['*,'.$row[$pointerFields[1]]]) { // Check if we have a DS for the value of the second pointer field prefixed with "*,"
1126 $srcPointer = '*,'.$row[$pointerFields[1]];
1127 } elseif($ds_array[$row[$pointerFields[0]]]) { // Check if we have a DS for just the value of the first pointer field (mainly for backwards compatibility)
1128 $srcPointer = $row[$pointerFields[0]];
1129 }
1130 } else {
1131 $srcPointer = $row[$pointerFields[0]];
1132 }
1133
1134 $srcPointer = isset($ds_array[$srcPointer]) ? $srcPointer : 'default';
1135 } else $srcPointer = 'default';
1136
1137 // 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.
1138 if (substr($ds_array[$srcPointer], 0, 5)=='FILE:') {
1139 $file = t3lib_div::getFileAbsFileName(substr($ds_array[$srcPointer], 5));
1140 if ($file && @is_file($file)) {
1141 $dataStructArray = t3lib_div::xml2array(t3lib_div::getUrl($file));
1142 } else $dataStructArray = 'The file "'.substr($ds_array[$srcPointer], 5).'" in ds-array key "'.$srcPointer.'" was not found ("'.$file.'")'; // Error message.
1143 } else {
1144 $dataStructArray = t3lib_div::xml2array($ds_array[$srcPointer]);
1145 }
1146
1147 } elseif ($ds_pointerField) { // If pointer field AND possibly a table/field is set:
1148 // Value of field pointed to:
1149 $srcPointer = $row[$ds_pointerField];
1150
1151 // Searching recursively back if 'ds_pointerField_searchParent' is defined (typ. a page rootline, or maybe a tree-table):
1152 if ($ds_searchParentField && !$srcPointer) {
1153 $rr = self::getRecord($table, $row['uid'], 'uid,' . $ds_searchParentField); // Get the "pid" field - we cannot know that it is in the input record! ###NOTE_A###
1154 if ($WSOL) {
1155 self::workspaceOL($table, $rr);
1156 self::fixVersioningPid($table, $rr, TRUE); // Added "TRUE" 23/03/06 before 4.0. (Also to similar call below!). Reason: When t3lib_refindex is scanning the system in Live workspace all Pages with FlexForms will not find their inherited datastructure. Thus all references from workspaces are removed! Setting TRUE means that versioning PID doesn't check workspace of the record. I can't see that this should give problems anywhere. See more information inside t3lib_refindex!
1157 }
1158 $uidAcc = array(); // Used to avoid looping, if any should happen.
1159 $subFieldPointer = $conf['ds_pointerField_searchParent_subField'];
1160 while(!$srcPointer) {
1161
1162 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1163 'uid,'.$ds_pointerField.','.$ds_searchParentField.($subFieldPointer?','.$subFieldPointer:''),
1164 $table,
1165 'uid=' . intval($newRecordPidValue ? $newRecordPidValue : $rr[$ds_searchParentField]) . self::deleteClause($table) ###NOTE_A###
1166 );
1167 $newRecordPidValue = 0;
1168 $rr = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
1169 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1170
1171 // break if no result from SQL db or if looping...
1172 if (!is_array($rr) || isset($uidAcc[$rr['uid']])) break;
1173 $uidAcc[$rr['uid']] = 1;
1174
1175 if ($WSOL) {
1176 self::workspaceOL($table, $rr);
1177 self::fixVersioningPid($table, $rr, TRUE);
1178 }
1179 $srcPointer = ($subFieldPointer && $rr[$subFieldPointer]) ? $rr[$subFieldPointer] : $rr[$ds_pointerField];
1180 }
1181 }
1182
1183 // If there is a srcPointer value:
1184 if ($srcPointer) {
1185 if (t3lib_div::testInt($srcPointer)) { // If integer, then its a record we will look up:
1186 list($tName, $fName) = explode(':', $ds_tableField, 2);
1187 if ($tName && $fName && is_array($GLOBALS['TCA'][$tName])) {
1188 $dataStructRec = self::getRecord($tName, $srcPointer);
1189 if ($WSOL) {
1190 self::workspaceOL($tName, $dataStructRec);
1191 }
1192 $dataStructArray = t3lib_div::xml2array($dataStructRec[$fName]);
1193 } else $dataStructArray = 'No tablename ('.$tName.') or fieldname ('.$fName.') was found an valid!';
1194 } else { // Otherwise expect it to be a file:
1195 $file = t3lib_div::getFileAbsFileName($srcPointer);
1196 if ($file && @is_file($file)) {
1197 $dataStructArray = t3lib_div::xml2array(t3lib_div::getUrl($file));
1198 } else $dataStructArray = 'The file "'.$srcPointer.'" was not found ("'.$file.'")'; // Error message.
1199 }
1200 } else $dataStructArray = 'No source value in fieldname "'.$ds_pointerField.'"'; // Error message.
1201 } else $dataStructArray = 'No proper configuration!';
1202
1203 // Hook for post-processing the Flexform DS. Introduces the possibility to configure Flexforms via TSConfig
1204 if (is_array ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'])) {
1205 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'] as $classRef) {
1206 $hookObj = t3lib_div::getUserObj($classRef);
1207 if (method_exists($hookObj, 'getFlexFormDS_postProcessDS')) {
1208 $hookObj->getFlexFormDS_postProcessDS($dataStructArray, $conf, $row, $table, $fieldName);
1209 }
1210 }
1211 }
1212
1213 return $dataStructArray;
1214 }
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233 /*******************************************
1234 *
1235 * Caching related
1236 *
1237 *******************************************/
1238
1239 /**
1240 * Stores the string value $data in the 'cache_hash' cache with the
1241 * hash key, $hash, and visual/symbolic identification, $ident
1242 * IDENTICAL to the function by same name found in t3lib_page:
1243 * Usage: 2
1244 *
1245 * @param string 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
1246 * @param string The data string. If you want to store an array, then just serialize it first.
1247 * @param string $ident is just a textual identification in order to inform about the content!
1248 * @return void
1249 */
1250 public static function storeHash($hash, $data, $ident) {
1251 if (TYPO3_UseCachingFramework) {
1252 $GLOBALS['typo3CacheManager']->getCache('cache_hash')->set(
1253 $hash,
1254 $data,
1255 array('ident_' . $ident),
1256 0 // unlimited lifetime
1257 );
1258 } else {
1259 $insertFields = array(
1260 'hash' => $hash,
1261 'content' => $data,
1262 'ident' => $ident,
1263 'tstamp' => $GLOBALS['EXEC_TIME']
1264 );
1265 $GLOBALS['TYPO3_DB']->exec_DELETEquery('cache_hash', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($hash, 'cache_hash'));
1266 $GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_hash', $insertFields);
1267 }
1268 }
1269
1270 /**
1271 * Returns string value stored for the hash string in the cache "cache_hash"
1272 * Can be used to retrieved a cached value
1273 *
1274 * IDENTICAL to the function by same name found in t3lib_page
1275 *
1276 * @param string The hash-string which was used to store the data value
1277 * @return string
1278 */
1279 public static function getHash($hash, $expTime = 0) {
1280 $hashContent = null;
1281 if (TYPO3_UseCachingFramework) {
1282 $contentHashCache = $GLOBALS['typo3CacheManager']->getCache('cache_hash');
1283 $cacheEntry = $contentHashCache->get($hash);
1284
1285 if ($cacheEntry) {
1286 $hashContent = $cacheEntry;
1287 }
1288 } else {
1289 $expTime = intval($expTime);
1290 if ($expTime) {
1291 $whereAdd = ' AND tstamp > '.(time()-$expTime);
1292 }
1293 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('content', 'cache_hash', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($hash, 'cache_hash').$whereAdd);
1294 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
1295 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1296
1297 $hashContent = (is_array($row) ? $row['content'] : null);
1298 }
1299 return $hashContent;
1300 }
1301
1302
1303
1304
1305
1306
1307
1308
1309 /*******************************************
1310 *
1311 * TypoScript related
1312 *
1313 *******************************************/
1314
1315 /**
1316 * Returns the Page TSconfig for page with id, $id
1317 * Requires class "t3lib_TSparser"
1318 * Usage: 26 (spec. in ext info_pagetsconfig)
1319 *
1320 * @param integer Page uid for which to create Page TSconfig
1321 * @param array If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
1322 * @param boolean 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.
1323 * @return array Page TSconfig
1324 * @see t3lib_TSparser
1325 */
1326 public static function getPagesTSconfig($id, $rootLine = '', $returnPartArray = 0) {
1327 $id = intval($id);
1328 if (!is_array($rootLine)) {
1329 $rootLine = self::BEgetRootLine($id, '', TRUE);
1330 }
1331 ksort($rootLine); // Order correctly
1332 $TSdataArray = array();
1333 $TSdataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig']; // Setting default configuration:
1334 foreach($rootLine as $k => $v) {
1335 $TSdataArray['uid_'.$v['uid']] = $v['TSconfig'];
1336 }
1337 $TSdataArray = t3lib_TSparser::checkIncludeLines_array($TSdataArray);
1338 if ($returnPartArray) {
1339 return $TSdataArray;
1340 }
1341
1342 // Parsing the page TS-Config (or getting from cache)
1343 $pageTS = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
1344 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['TSconfigConditions']) {
1345 /* @var $parseObj t3lib_TSparser_TSconfig */
1346 $parseObj = t3lib_div::makeInstance('t3lib_TSparser_TSconfig');
1347 $res = $parseObj->parseTSconfig($pageTS, 'PAGES', $id, $rootLine);
1348 if ($res) {
1349 $TSconfig = $res['TSconfig'];
1350 }
1351 } else {
1352 $hash = md5('pageTS:' . $pageTS);
1353 $cachedContent = self::getHash($hash);
1354 $TSconfig = array();
1355 if (isset($cachedContent)) {
1356 $TSconfig = unserialize($cachedContent);
1357 } else {
1358 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
1359 $parseObj->parse($pageTS);
1360 $TSconfig = $parseObj->setup;
1361 self::storeHash($hash, serialize($TSconfig), 'PAGES_TSconfig');
1362 }
1363 }
1364
1365 // get User TSconfig overlay
1366 $userTSconfig = $GLOBALS['BE_USER']->userTS['page.'];
1367 if (is_array($userTSconfig)) {
1368 $TSconfig = t3lib_div::array_merge_recursive_overrule($TSconfig, $userTSconfig);
1369 }
1370 return $TSconfig;
1371 }
1372
1373 /**
1374 * Updates Page TSconfig for a page with $id
1375 * The function seems to take $pageTS as an array with properties and compare the values with those that already exists for the "object string", $TSconfPrefix, for the page, then sets those values which were not present.
1376 * $impParams can be supplied as already known Page TSconfig, otherwise it's calculated.
1377 *
1378 * THIS DOES NOT CHECK ANY PERMISSIONS. SHOULD IT?
1379 * More documentation is needed.
1380 *
1381 * Usage: 1 (ext. direct_mail)
1382 *
1383 * @param integer Page id
1384 * @param array Page TS array to write
1385 * @param string Prefix for object paths
1386 * @param array [Description needed.]
1387 * @return void
1388 * @internal
1389 * @see implodeTSParams(), getPagesTSconfig()
1390 */
1391 public static function updatePagesTSconfig($id, $pageTS, $TSconfPrefix, $impParams = '') {
1392 $id = intval($id);
1393 if (is_array($pageTS) && $id>0) {
1394 if (!is_array($impParams)) {
1395 $impParams = self::implodeTSParams(self::getPagesTSconfig($id));
1396 }
1397 $set = array();
1398 foreach ($pageTS as $f => $v) {
1399 $f = $TSconfPrefix.$f;
1400 if ((!isset($impParams[$f])&&trim($v)) || strcmp(trim($impParams[$f]), trim($v))) {
1401 $set[$f] = trim($v);
1402 }
1403 }
1404 if (count($set)) {
1405 // Get page record and TS config lines
1406 $pRec = self::getRecord('pages', $id);
1407 $TSlines = explode(LF, $pRec['TSconfig']);
1408 $TSlines = array_reverse($TSlines);
1409 // Reset the set of changes.
1410 foreach ($set as $f => $v) {
1411 $inserted = 0;
1412 foreach ($TSlines as $ki => $kv) {
1413 if (substr($kv, 0, strlen($f)+1)==$f.'=') {
1414 $TSlines[$ki] = $f.'='.$v;
1415 $inserted = 1;
1416 break;
1417 }
1418 }
1419 if (!$inserted) {
1420 $TSlines = array_reverse($TSlines);
1421 $TSlines[] = $f.'='.$v;
1422 $TSlines = array_reverse($TSlines);
1423 }
1424 }
1425 $TSlines = array_reverse($TSlines);
1426
1427 // store those changes
1428 $TSconf = implode(LF, $TSlines);
1429
1430 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('pages', 'uid='.intval($id), array('TSconfig' => $TSconf));
1431 }
1432 }
1433 }
1434
1435 /**
1436 * Implodes a multi dimensional TypoScript array, $p, into a one-dimentional array (return value)
1437 * Usage: 3
1438 *
1439 * @param array TypoScript structure
1440 * @param string Prefix string
1441 * @return array Imploded TypoScript objectstring/values
1442 */
1443 public static function implodeTSParams($p, $k = '') {
1444 $implodeParams = array();
1445 if (is_array($p)) {
1446 foreach ($p as $kb => $val) {
1447 if (is_array($val)) {
1448 $implodeParams = array_merge($implodeParams, self::implodeTSParams($val, $k . $kb));
1449 } else {
1450 $implodeParams[$k.$kb] = $val;
1451 }
1452 }
1453 }
1454 return $implodeParams;
1455 }
1456
1457
1458
1459
1460
1461
1462
1463
1464 /*******************************************
1465 *
1466 * Users / Groups related
1467 *
1468 *******************************************/
1469
1470 /**
1471 * Returns an array with be_users records of all user NOT DELETED sorted by their username
1472 * Keys in the array is the be_users uid
1473 * Usage: 14 (spec. ext. "beuser" and module "web_perm")
1474 *
1475 * @param string Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
1476 * @param string Optional $where clause (fx. "AND username='pete'") can be used to limit query
1477 * @return array
1478 */
1479 public static function getUserNames($fields = 'username,usergroup,usergroup_cached_list,uid', $where = '') {
1480 $be_user_Array = Array();
1481
1482 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($fields, 'be_users', 'pid=0 ' . $where . self::deleteClause('be_users'), '', 'username');
1483 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1484 $be_user_Array[$row['uid']] = $row;
1485 }
1486 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1487
1488 return $be_user_Array;
1489 }
1490
1491 /**
1492 * Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
1493 * Usage: 8 (spec. ext. "beuser" and module "web_perm")
1494 *
1495 * @param string Field list
1496 * @param string WHERE clause
1497 * @return array
1498 */
1499 public static function getGroupNames($fields = 'title,uid', $where = '') {
1500 $be_group_Array = Array();
1501
1502 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($fields, 'be_groups', 'pid=0 ' . $where . self::deleteClause('be_groups'), '', 'title');
1503 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1504 $be_group_Array[$row['uid']] = $row;
1505 }
1506 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1507
1508 return $be_group_Array;
1509 }
1510
1511 /**
1512 * Returns an array with be_groups records (like ->getGroupNames) but:
1513 * - 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.
1514 * Usage: 2 (module "web_perm" and ext. taskcenter)
1515 *
1516 * @param string Field list; $fields specify the fields selected (default: title,uid)
1517 * @return array
1518 */
1519 public static function getListGroupNames($fields = 'title, uid') {
1520 $exQ = ' AND hide_in_lists=0';
1521 if (!$GLOBALS['BE_USER']->isAdmin()) {
1522 $exQ.=' AND uid IN ('.($GLOBALS['BE_USER']->user['usergroup_cached_list']?$GLOBALS['BE_USER']->user['usergroup_cached_list']:0).')';
1523 }
1524 return self::getGroupNames($fields, $exQ);
1525 }
1526
1527 /**
1528 * Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!).
1529 * If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1530 * Takes $usernames (array made by t3lib_BEfunc::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input
1531 * Usage: 8
1532 *
1533 * @param array User names
1534 * @param array Group names
1535 * @param boolean If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1536 * @return array User names, blinded
1537 */
1538 public static function blindUserNames($usernames, $groupArray, $excludeBlindedFlag = 0) {
1539 if (is_array($usernames) && is_array($groupArray)) {
1540 foreach ($usernames as $uid => $row) {
1541 $userN = $uid;
1542 $set = 0;
1543 if ($row['uid']!=$GLOBALS['BE_USER']->user['uid']) {
1544 foreach ($groupArray as $v) {
1545 if ($v && t3lib_div::inList($row['usergroup_cached_list'], $v)) {
1546 $userN = $row['username'];
1547 $set = 1;
1548 }
1549 }
1550 } else {
1551 $userN = $row['username'];
1552 $set = 1;
1553 }
1554 $usernames[$uid]['username'] = $userN;
1555 if ($excludeBlindedFlag && !$set) {unset($usernames[$uid]);}
1556 }
1557 }
1558 return $usernames;
1559 }
1560
1561 /**
1562 * Corresponds to blindUserNames but works for groups instead
1563 * Usage: 2 (module web_perm)
1564 *
1565 * @param array Group names
1566 * @param array Group names (reference)
1567 * @param boolean If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1568 * @return array
1569 */
1570 public static function blindGroupNames($groups, $groupArray, $excludeBlindedFlag = 0) {
1571 if (is_array($groups) && is_array($groupArray)) {
1572 foreach ($groups as $uid => $row) {
1573 $groupN = $uid;
1574 $set = 0;
1575 if (t3lib_div::inArray($groupArray, $uid)) {
1576 $groupN = $row['title'];
1577 $set = 1;
1578 }
1579 $groups[$uid]['title'] = $groupN;
1580 if ($excludeBlindedFlag && !$set) {unset($groups[$uid]);}
1581 }
1582 }
1583 return $groups;
1584 }
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598 /*******************************************
1599 *
1600 * Output related
1601 *
1602 *******************************************/
1603
1604 /**
1605 * Returns the difference in days between input $tstamp and $EXEC_TIME
1606 * Usage: 2 (class t3lib_BEfunc)
1607 *
1608 * @param integer Time stamp, seconds
1609 * @return integer
1610 */
1611 public static function daysUntil($tstamp) {
1612 $delta_t = $tstamp-$GLOBALS['EXEC_TIME'];
1613 return ceil($delta_t/(3600*24));
1614 }
1615
1616 /**
1617 * Returns $tstamp formatted as "ddmmyy" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'])
1618 * Usage: 11
1619 *
1620 * @param integer Time stamp, seconds
1621 * @return string Formatted time
1622 */
1623 public static function date($tstamp) {
1624 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], (int)$tstamp);
1625 }
1626
1627 /**
1628 * Returns $tstamp formatted as "ddmmyy hhmm" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'] AND $TYPO3_CONF_VARS['SYS']['hhmm'])
1629 * Usage: 28
1630 *
1631 * @param integer Time stamp, seconds
1632 * @return string Formatted time
1633 */
1634 public static function datetime($value) {
1635 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'], $value);
1636 }
1637
1638 /**
1639 * Returns $value (in seconds) formatted as hh:mm:ss
1640 * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
1641 * Usage: 1 (class t3lib_BEfunc)
1642 *
1643 * @param integer Time stamp, seconds
1644 * @param boolean Output hh:mm:ss. If false: hh:mm
1645 * @return string Formatted time
1646 */
1647 public static function time($value, $withSeconds = TRUE) {
1648 $hh = floor($value/3600);
1649 $min = floor(($value-$hh*3600)/60);
1650 $sec = $value-$hh*3600-$min*60;
1651 $l = sprintf('%02d', $hh).':'.sprintf('%02d', $min);
1652 if ($withSeconds) {
1653 $l .= ':'.sprintf('%02d', $sec);
1654 }
1655 return $l;
1656 }
1657
1658 /**
1659 * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
1660 * Usage: 15
1661 *
1662 * @param integer $seconds could be the difference of a certain timestamp and time()
1663 * @param string $labels should be something like ' min| hrs| days| yrs'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears")
1664 * @return string Formatted time
1665 */
1666 public static function calcAge($seconds, $labels = 'min|hrs|days|yrs') {
1667 $labelArr = explode('|', $labels);
1668 $prefix = '';
1669 if ($seconds<0) {$prefix = '-'; $seconds = abs($seconds);}
1670 if ($seconds<3600) {
1671 $seconds = round ($seconds/60).' '.trim($labelArr[0]);
1672 } elseif ($seconds<24*3600) {
1673 $seconds = round ($seconds/3600).' '.trim($labelArr[1]);
1674 } elseif ($seconds<365*24*3600) {
1675 $seconds = round ($seconds/(24*3600)).' '.trim($labelArr[2]);
1676 } else {
1677 $seconds = round ($seconds/(365*24*3600)).' '.trim($labelArr[3]);
1678 }
1679 return $prefix.$seconds;
1680 }
1681
1682 /**
1683 * Returns a formatted timestamp if $tstamp is set.
1684 * The date/datetime will be followed by the age in parenthesis.
1685 * Usage: 3
1686 *
1687 * @param integer Time stamp, seconds
1688 * @param integer 1/-1 depending on polarity of age.
1689 * @param string $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm"
1690 * @return string
1691 */
1692 public static function dateTimeAge($tstamp, $prefix = 1, $date = '') {
1693 return $tstamp ?
1694 ($date=='date' ? self::date($tstamp) : self::datetime($tstamp)) .
1695 ' (' . self::calcAge($prefix * ($GLOBALS['EXEC_TIME'] - $tstamp), $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears')) . ')'
1696 : '';
1697 }
1698
1699 /**
1700 * Returns either title = '' or alt = '' attribute. This depends on the client browser and whether it supports title = '' or not (which is the default)
1701 * If no $content is given only the attribute name is returned.
1702 * The returned attribute with content will have a leading space char.
1703 * Warning: Be careful to submit empty $content var - that will return just the attribute name!
1704 * Usage: 0
1705 *
1706 * @param string String to set as title-attribute. If no $content is given only the attribute name is returned.
1707 * @param boolean If $hsc is set, then content of the attribute is htmlspecialchar()'ed (which is good for XHTML and other reasons...)
1708 * @return string
1709 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6 - The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead!
1710 */
1711 public static function titleAttrib($content = '', $hsc = 0) {
1712 t3lib_div::logDeprecatedFunction();
1713
1714 global $CLIENT;
1715 $attrib= ($CLIENT['BROWSER']=='net'&&$CLIENT['VERSION']<5)||$CLIENT['BROWSER']=='konqu' ? 'alt' : 'title';
1716 return strcmp($content, '')?' '.$attrib.'="'.($hsc?htmlspecialchars($content):$content).'"' : $attrib;
1717 }
1718
1719 /**
1720 * Returns alt="" and title="" attributes with the value of $content.
1721 * Usage: 7
1722 *
1723 * @param string Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
1724 * @return string
1725 */
1726 public static function titleAltAttrib($content) {
1727 $out = '';
1728 $out.=' alt="'.htmlspecialchars($content).'"';
1729 $out.=' title="'.htmlspecialchars($content).'"';
1730 return $out;
1731 }
1732
1733 /**
1734 * 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
1735 * All $TYPO3_CONF_VARS['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
1736 * Thumbsnails are linked to the show_item.php script which will display further details.
1737 * Usage: 7
1738 *
1739 * @param array $row is the database row from the table, $table.
1740 * @param string Table name for $row (present in TCA)
1741 * @param string $field is pointing to the field with the list of image files
1742 * @param string Back path prefix for image tag src="" field
1743 * @param string Optional: $thumbScript os by default 'thumbs.php' if you don't set it otherwise
1744 * @param string 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 $TCA for that field! so you don't have to!)
1745 * @param boolean If set, uploaddir is NOT prepended with "../"
1746 * @param string Optional: $tparams is additional attributes for the image tags
1747 * @param integer Optional: $size is [w]x[h] of the thumbnail. 56 is default.
1748 * @return string Thumbnail image tag.
1749 */
1750 public static function thumbCode($row, $table, $field, $backPath, $thumbScript = '', $uploaddir = NULL, $abs = 0, $tparams = '', $size = '') {
1751 global $TCA;
1752 // Load table.
1753 t3lib_div::loadTCA($table);
1754
1755 // Find uploaddir automatically
1756 $uploaddir = (is_null($uploaddir)) ? $TCA[$table]['columns'][$field]['config']['uploadfolder'] : $uploaddir;
1757 $uploaddir = preg_replace('#/$#','', $uploaddir);
1758
1759 // Set thumbs-script:
1760 if (!$GLOBALS['TYPO3_CONF_VARS']['GFX']['thumbnails']) {
1761 $thumbScript = 'gfx/notfound_thumb.gif';
1762 } elseif(!$thumbScript) {
1763 $thumbScript = 'thumbs.php';
1764 }
1765 // Check and parse the size parameter
1766 $sizeParts = array();
1767 if ($size = trim($size)) {
1768 $sizeParts = explode('x', $size.'x'.$size);
1769 if(!intval($sizeParts[0])) $size = '';
1770 }
1771
1772 // Traverse files:
1773 $thumbs = explode(',', $row[$field]);
1774 $thumbData = '';
1775 foreach ($thumbs as $theFile) {
1776 if (trim($theFile)) {
1777 $fI = t3lib_div::split_fileref($theFile);
1778 $ext = $fI['fileext'];
1779 // New 190201 start
1780 $max = 0;
1781 if (t3lib_div::inList('gif,jpg,png', $ext)) {
1782 $imgInfo = @getimagesize(PATH_site.$uploaddir.'/'.$theFile);
1783 if (is_array($imgInfo)) {$max = max($imgInfo[0], $imgInfo[1]);}
1784 }
1785 // use the original image if it's size fits to the thumbnail size
1786 if ($max && $max<=(count($sizeParts)&&max($sizeParts)?max($sizeParts):56)) {
1787 $theFile = $url = ($abs?'':'../').($uploaddir?$uploaddir.'/':'').trim($theFile);
1788 $onClick = 'top.launchView(\''.$theFile.'\',\'\',\''.$backPath.'\');return false;';
1789 $thumbData.= '<a href="#" onclick="'.htmlspecialchars($onClick).'"><img src="'.$backPath.$url.'" '.$imgInfo[3].' hspace="2" border="0" title="'.trim($url).'"'.$tparams.' alt="" /></a> ';
1790 // New 190201 stop
1791 } elseif ($ext=='ttf' || t3lib_div::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $ext)) {
1792 $theFile_abs = PATH_site.($uploaddir?$uploaddir.'/':'').trim($theFile);
1793 $theFile = ($abs?'':'../').($uploaddir?$uploaddir.'/':'').trim($theFile);
1794
1795 if (!is_readable($theFile_abs)) {
1796 $flashMessage = t3lib_div::makeInstance(
1797 't3lib_FlashMessage',
1798 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:warning.file_missing_text') . ' <abbr title="' . $theFile_abs . '">' . $theFile . '</abbr>',
1799 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:warning.file_missing'),
1800 t3lib_FlashMessage::ERROR
1801 );
1802 $thumbData .= $flashMessage->render();
1803 continue;
1804 }
1805
1806 $check = basename($theFile_abs).':'.filemtime($theFile_abs).':'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
1807 $params = '&file='.rawurlencode($theFile);
1808 $params.= $size?'&size='.$size:'';
1809 $params.= '&md5sum='.t3lib_div::shortMD5($check);
1810
1811 $url = $thumbScript.'?&dummy='.$GLOBALS['EXEC_TIME'].$params;
1812 $onClick = 'top.launchView(\''.$theFile.'\',\'\',\''.$backPath.'\');return false;';
1813 $thumbData.= '<a href="#" onclick="'.htmlspecialchars($onClick).'"><img src="'.htmlspecialchars($backPath.$url).'" hspace="2" border="0" title="'.trim($theFile).'"'.$tparams.' alt="" /></a> ';
1814 } else {
1815 $icon = self::getFileIcon($ext);
1816 $url = 'gfx/fileicons/'.$icon;
1817 $thumbData.= '<img src="'.$backPath.$url.'" hspace="2" border="0" title="'.trim($theFile).'"'.$tparams.' alt="" /> ';
1818 }
1819 }
1820 }
1821 return $thumbData;
1822 }
1823
1824 /**
1825 * Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
1826 * Usage: 3
1827 *
1828 * @param string $thumbScript must point to "thumbs.php" relative to the script position
1829 * @param string $theFile must be the proper reference to the file thumbs.php should show
1830 * @param string $tparams are additional attributes for the image tag
1831 * @param integer $size is the size of the thumbnail send along to "thumbs.php"
1832 * @return string Image tag
1833 */
1834 public static function getThumbNail($thumbScript, $theFile, $tparams = '', $size = '') {
1835 $check = basename($theFile).':'.filemtime($theFile).':'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
1836 $params = '&file='.rawurlencode($theFile);
1837 $params.= trim($size)?'&size='.trim($size):'';
1838 $params.= '&md5sum='.t3lib_div::shortMD5($check);
1839
1840 $url = $thumbScript.'?&dummy='.$GLOBALS['EXEC_TIME'].$params;
1841 $th = '<img src="'.htmlspecialchars($url).'" title="'.trim(basename($theFile)).'"'.($tparams?" ".$tparams:"").' alt="" />';
1842 return $th;
1843 }
1844
1845 /**
1846 * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
1847 * Usage: 8
1848 *
1849 * @param array Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
1850 * @param string $perms_clause is used to get the record path of the shortcut page, if any (and doktype==4)
1851 * @param boolean If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already
1852 * @return string
1853 */
1854 public static function titleAttribForPages($row, $perms_clause = '', $includeAttrib = 1) {
1855 global $TCA, $LANG;
1856 $parts = array();
1857 $parts[] = 'id='.$row['uid'];
1858 if ($row['alias']) $parts[] = $LANG->sL($TCA['pages']['columns']['alias']['label']).' '.$row['alias'];
1859 if ($row['pid']<0) $parts[] = 'v#1.'.$row['t3ver_id'];
1860
1861 switch($row['t3ver_state']) {
1862 case 1:
1863 $parts[] = 'PLH WSID#'.$row['t3ver_wsid'];
1864 break;
1865 case 2:
1866 $parts[] = 'Deleted element!';
1867 break;
1868 case 3:
1869 $parts[] = 'NEW LOCATION (PLH) WSID#'.$row['t3ver_wsid'];
1870 break;
1871 case 4:
1872 $parts[] = 'OLD LOCATION (PNT) WSID#'.$row['t3ver_wsid'];
1873 break;
1874 case -1:
1875 $parts[] = 'New element!';
1876 break;
1877 }
1878
1879 if ($row['doktype'] == t3lib_pageSelect::DOKTYPE_LINK) {
1880 $parts[] = $LANG->sL($TCA['pages']['columns']['url']['label']).' '.$row['url'];
1881 } elseif ($row['doktype'] == t3lib_pageSelect::DOKTYPE_SHORTCUT) {
1882 if ($perms_clause) {
1883 $label = self::getRecordPath(intval($row['shortcut']), $perms_clause, 20);
1884 } else {
1885 $lRec = self::getRecordWSOL('pages', intval($row['shortcut']), 'title');
1886 $label = $lRec['title'];
1887 }
1888 if ($row['shortcut_mode'] != t3lib_pageSelect::SHORTCUT_MODE_NONE) {
1889 $label.=', '.$LANG->sL($TCA['pages']['columns']['shortcut_mode']['label']).' '.
1890 $LANG->sL(self::getLabelFromItemlist('pages', 'shortcut_mode', $row['shortcut_mode']));
1891 }
1892 $parts[] = $LANG->sL($TCA['pages']['columns']['shortcut']['label']).' '.$label;
1893 } elseif ($row['doktype'] == t3lib_pageSelect::DOKTYPE_MOUNTPOINT) {
1894 if ($perms_clause) {
1895 $label = self::getRecordPath(intval($row['mount_pid']), $perms_clause, 20);
1896 } else {
1897 $lRec = self::getRecordWSOL('pages', intval($row['mount_pid']), 'title');
1898 $label = $lRec['title'];
1899 }
1900 $parts[] = $LANG->sL($TCA['pages']['columns']['mount_pid']['label']).' '.$label;
1901 if ($row['mount_pid_ol']) {
1902 $parts[] = $LANG->sL($TCA['pages']['columns']['mount_pid_ol']['label']);
1903 }
1904 }
1905 if ($row['nav_hide']) $parts[] = rtrim($LANG->sL($TCA['pages']['columns']['nav_hide']['label']), ':');
1906 if ($row['hidden']) $parts[] = $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.hidden');
1907 if ($row['starttime']) $parts[] = $LANG->sL($TCA['pages']['columns']['starttime']['label']) . ' ' . self::dateTimeAge($row['starttime'], -1, 'date');
1908 if ($row['endtime']) $parts[] = $LANG->sL($TCA['pages']['columns']['endtime']['label']) . ' ' . self::dateTimeAge($row['endtime'], -1, 'date');
1909 if ($row['fe_group']) {
1910 $fe_groups = array();
1911 foreach (t3lib_div::intExplode(',', $row['fe_group']) as $fe_group) {
1912 if ($fe_group<0) {
1913 $fe_groups[] = $LANG->sL(self::getLabelFromItemlist('pages', 'fe_group', $fe_group));
1914 } else {
1915 $lRec = self::getRecordWSOL('fe_groups', $fe_group, 'title');
1916 $fe_groups[] = $lRec['title'];
1917 }
1918 }
1919 $label = implode(', ', $fe_groups);
1920 $parts[] = $LANG->sL($TCA['pages']['columns']['fe_group']['label']).' '.$label;
1921 }
1922 $out = htmlspecialchars(implode(' - ', $parts));
1923 return $includeAttrib ? 'title="'.$out.'"' : $out;
1924 }
1925
1926 /**
1927 * Returns title-attribute information for ANY record (from a table defined in TCA of course)
1928 * 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.
1929 * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
1930 * Usage: 10
1931 *
1932 * @param array Table row; $row is a row from the table, $table
1933 * @param string Table name
1934 * @return string
1935 */
1936 public static function getRecordIconAltText($row, $table = 'pages') {
1937 if ($table=='pages') {
1938 $out = self::titleAttribForPages($row, '', 0);
1939 } else {
1940 $ctrl = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns'];
1941
1942 $out = 'id='.$row['uid']; // Uid is added
1943 if ($table=='pages' && $row['alias']) {
1944 $out.=' / '.$row['alias'];
1945 }
1946 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'] && $row['pid']<0) {
1947 $out.=' - v#1.'.$row['t3ver_id'];
1948 }
1949 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
1950 switch($row['t3ver_state']) {
1951 case 1:
1952 $out.= ' - PLH WSID#'.$row['t3ver_wsid'];
1953 break;
1954 case 2:
1955 $out.= ' - Deleted element!';
1956 break;
1957 case 3:
1958 $out.= ' - NEW LOCATION (PLH) WSID#'.$row['t3ver_wsid'];
1959 break;
1960 case 4:
1961 $out.= ' - OLD LOCATION (PNT) WSID#'.$row['t3ver_wsid'];
1962 break;
1963 case -1:
1964 $out.= ' - New element!';
1965 break;
1966 }
1967 }
1968
1969 if ($ctrl['disabled']) { // Hidden ...
1970 $out.=($row[$ctrl['disabled']]?' - '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.hidden'):'');
1971 }
1972 if ($ctrl['starttime']) {
1973 if ($row[$ctrl['starttime']] > $GLOBALS['EXEC_TIME']) {
1974 $out .= ' - ' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.starttime') . ':' .
1975 self::date($row[$ctrl['starttime']]) . ' (' . self::daysUntil($row[$ctrl['starttime']]) . ' ' .
1976 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.days') . ')';
1977 }
1978 }
1979 if ($row[$ctrl['endtime']]) {
1980 $out .= ' - ' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.endtime') . ': ' .
1981 self::date($row[$ctrl['endtime']]) . ' (' . self::daysUntil($row[$ctrl['endtime']]) . ' ' .
1982 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.days') . ')';
1983 }
1984 }
1985 return htmlspecialchars($out);
1986 }
1987
1988 /**
1989 * Returns the label of the first found entry in an "items" array from $TCA (tablename = $table/fieldname = $col) where the value is $key
1990 * Usage: 9
1991 *
1992 * @param string Table name, present in $TCA
1993 * @param string Field name, present in $TCA
1994 * @param string items-array value to match
1995 * @return string Label for item entry
1996 */
1997 public static function getLabelFromItemlist($table, $col, $key) {
1998 global $TCA;
1999 // Load full TCA for $table
2000 t3lib_div::loadTCA($table);
2001
2002 // Check, if there is an "items" array:
2003 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$col]) && is_array($TCA[$table]['columns'][$col]['config']['items'])) {
2004 // Traverse the items-array...
2005 foreach ($TCA[$table]['columns'][$col]['config']['items'] as $k => $v) {
2006 // ... and return the first found label where the value was equal to $key
2007 if (!strcmp($v[1], $key)) return $v[0];
2008 }
2009 }
2010 }
2011
2012 /**
2013 * Returns the label-value for fieldname $col in table, $table
2014 * 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>'
2015 * Usage: 17
2016 *
2017 * @param string Table name, present in $TCA
2018 * @param string Field name
2019 * @param string Wrap value - set function description
2020 * @return string
2021 */
2022 public static function getItemLabel($table, $col, $printAllWrap = '') {
2023 global $TCA;
2024 // Load full TCA for $table
2025 t3lib_div::loadTCA($table);
2026 // Check if column exists
2027 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$col])) {
2028 // Re
2029 return $TCA[$table]['columns'][$col]['label'];
2030 }
2031 if ($printAllWrap) {
2032 $parts = explode('|', $printAllWrap);
2033 return $parts[0].$col.$parts[1];
2034 }
2035 }
2036
2037 /**
2038 * Returns the "title"-value in record, $row, from table, $table
2039 * The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
2040 * Usage: 26
2041 *
2042 * @param string Table name, present in TCA
2043 * @param array Row from table
2044 * @param boolean If set, result is prepared for output: The output is cropped to a limited lenght (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
2045 * @param boolean If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
2046 * @return string
2047 */
2048 public static function getRecordTitle($table, $row, $prep = FALSE, $forceResult = TRUE) {
2049 global $TCA;
2050 if (is_array($TCA[$table])) {
2051
2052 // If configured, call userFunc
2053 if ($TCA[$table]['ctrl']['label_userFunc']) {
2054 $params['table'] = $table;
2055 $params['row'] = $row;
2056 $params['title'] = '';
2057 //create NULL-reference
2058 $null = NULL;
2059 t3lib_div::callUserFunction($TCA[$table]['ctrl']['label_userFunc'], $params, $null);
2060 $t = $params['title'];
2061 } else {
2062
2063 // No userFunc: Build label
2064 $t = self::getProcessedValue($table, $TCA[$table]['ctrl']['label'], $row[$TCA[$table]['ctrl']['label']], 0, 0, false, $row['uid'], $forceResult);
2065 if ($TCA[$table]['ctrl']['label_alt'] && ($TCA[$table]['ctrl']['label_alt_force'] || !strcmp($t, ''))) {
2066 $altFields = t3lib_div::trimExplode(',', $TCA[$table]['ctrl']['label_alt'], 1);
2067 $tA = array();
2068 if (!empty($t)) $tA[] = $t;
2069 foreach ($altFields as $fN) {
2070 $t = trim(strip_tags($row[$fN]));
2071 if (strcmp($t, '')) {
2072 $t = self::getProcessedValue($table, $fN, $t, 0, 0, false, $row['uid']);
2073 if (!$TCA[$table]['ctrl']['label_alt_force']) {
2074 break;
2075 }
2076 $tA[] = $t;
2077 }
2078 }
2079 if ($TCA[$table]['ctrl']['label_alt_force']) {
2080 $t = implode(', ', $tA);
2081 }
2082 }
2083 }
2084
2085 // If the current result is empty, set it to '[No title]' (localized) and prepare for output if requested
2086 if ($prep || $forceResult) {
2087 if ($prep) {
2088 $t = self::getRecordTitlePrep($t);
2089 }
2090 if (!strcmp(trim($t), '')) {
2091 $t = self::getNoRecordTitle($prep);
2092 }
2093 }
2094
2095 return $t;
2096 }
2097 }
2098
2099 /**
2100 * Crops a title string to a limited lenght and if it really was cropped, wrap it in a <span title="...">|</span>,
2101 * which offers a tooltip with the original title when moving mouse over it.
2102 *
2103 * @param string $title: The title string to be cropped
2104 * @param integer $titleLength: Crop title after this length - if not set, BE_USER->uc['titleLen'] is used
2105 * @return string The processed title string, wrapped in <span title="...">|</span> if cropped
2106 */
2107 public static function getRecordTitlePrep($title, $titleLength = 0) {
2108 // If $titleLength is not a valid positive integer, use BE_USER->uc['titleLen']:
2109 if (!$titleLength || !t3lib_div::testInt($titleLength) || $titleLength < 0) {
2110 $titleLength = $GLOBALS['BE_USER']->uc['titleLen'];
2111 }
2112 $titleOrig = htmlspecialchars($title);
2113 $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($title, $titleLength));
2114 // If title was cropped, offer a tooltip:
2115 if ($titleOrig != $title) {
2116 $title = '<span title="'.$titleOrig.'">'.$title.'</span>';
2117 }
2118 return $title;
2119 }
2120
2121 /**
2122 * Get a localized [No title] string, wrapped in <em>|</em> if $prep is true.
2123 *
2124 * @param boolean $prep: Wrap result in <em>|</em>
2125 * @return string Localized [No title] string
2126 */
2127 public static function getNoRecordTitle($prep = FALSE) {
2128 $noTitle = '['.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title', 1).']';
2129 if ($prep) $noTitle = '<em>'.$noTitle.'</em>';
2130 return $noTitle;
2131 }
2132
2133 /**
2134 * Returns a human readable output of a value from a record
2135 * 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.
2136 * $table/$col is tablename and fieldname
2137 * REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
2138 * Usage: 24
2139 *
2140 * @param string Table name, present in TCA
2141 * @param string Field name, present in TCA
2142 * @param string $value is the value of that field from a selected record
2143 * @param integer $fixed_lgd_chars is the max amount of characters the value may occupy
2144 * @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")
2145 * @param boolean If set, no records will be looked up, UIDs are just shown.
2146 * @param integer uid of the current record
2147 * @param boolean If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
2148 * @return string
2149 */
2150 public static function getProcessedValue($table, $col, $value, $fixed_lgd_chars = 0, $defaultPassthrough = 0, $noRecordLookup = FALSE, $uid = 0, $forceResult = TRUE) {
2151 global $TCA;
2152 global $TYPO3_CONF_VARS;
2153
2154 if ($col == 'uid') {
2155 // no need to load TCA as uid is not in TCA-array
2156 return $value;
2157 }
2158 // Load full TCA for $table
2159 t3lib_div::loadTCA($table);
2160 // Check if table and field is configured:
2161 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$col])) {
2162 // Depending on the fields configuration, make a meaningful output value.
2163 $theColConf = $TCA[$table]['columns'][$col]['config'];
2164
2165 /*****************
2166 *HOOK: pre-processing the human readable output from a record
2167 ****************/
2168 if (is_array ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'])) {
2169 // create NULL-reference
2170 $null = NULL;
2171 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'] as $_funcRef) {
2172 t3lib_div::callUserFunction($_funcRef, $theColConf, $null);
2173 }
2174 }
2175
2176 $l = '';
2177 switch((string)$theColConf['type']) {
2178 case 'radio':
2179 $l = self::getLabelFromItemlist($table, $col, $value);
2180 $l = $GLOBALS['LANG']->sL($l);
2181 break;
2182 case 'select':
2183 if ($theColConf['MM']) {
2184 if ($uid) {
2185 // Display the title of MM related records in lists
2186 if ($noRecordLookup) {
2187 $MMfield = $theColConf['foreign_table'] . '.uid';
2188 } else {
2189 $MMfields = array($theColConf['foreign_table'] . '.' . $TCA[$theColConf['foreign_table']]['ctrl']['label']);
2190 foreach (t3lib_div::trimExplode(',', $TCA[$theColConf['foreign_table']]['ctrl']['label_alt'], 1) as $f) {
2191 $MMfields[] = $theColConf['foreign_table'] . '.' . $f;
2192 }
2193 $MMfield = join(',', $MMfields);
2194 }
2195
2196 $dbGroup = t3lib_div::makeInstance('t3lib_loadDBGroup');
2197 $dbGroup->start($value, $theColConf['foreign_table'], $theColConf['MM'], $uid, $table, $theColConf);
2198 $selectUids = $dbGroup->tableArray[$theColConf['foreign_table']];
2199
2200 if (is_array($selectUids) && count($selectUids)>0) {
2201 $MMres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
2202 'uid, ' . $MMfield,
2203 $theColConf['foreign_table'],
2204 'uid IN (' . implode(',', $selectUids) . ')'
2205 );
2206 while ($MMrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($MMres)) {
2207 $mmlA[] = ($noRecordLookup ? $MMrow['uid'] : self::getRecordTitle($theColConf['foreign_table'], $MMrow, FALSE, $forceResult));
2208 }
2209 $GLOBALS['TYPO3_DB']->sql_free_result($MMres);
2210
2211 if (is_array($mmlA)) {
2212 $l = implode('; ', $mmlA);
2213 } else {
2214 $l = '';
2215 }
2216 } else {
2217 $l = 'N/A';
2218 }
2219 } else {
2220 $l = 'N/A';
2221 }
2222 } else {
2223 $l = self::getLabelFromItemlist($table, $col, $value);
2224 $l = $GLOBALS['LANG']->sL($l);
2225 if ($theColConf['foreign_table'] && !$l && $TCA[$theColConf['foreign_table']]) {
2226 if ($noRecordLookup) {
2227 $l = $value;
2228 } else {
2229 $rParts = t3lib_div::trimExplode(',', $value, 1);
2230 $lA = array();
2231 foreach ($rParts as $rVal) {
2232 $rVal = intval($rVal);
2233 if ($rVal>0) {
2234 $r = self::getRecordWSOL($theColConf['foreign_table'], $rVal);
2235 } else {
2236 $r = self::getRecordWSOL($theColConf['neg_foreign_table'], -$rVal);
2237 }
2238 if (is_array($r)) {
2239 $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);
2240 } else {
2241 $lA[] = $rVal?'['.$rVal.'!]':'';
2242 }
2243 }
2244 $l = implode(', ', $lA);
2245 }
2246 }
2247 }
2248 break;
2249 case 'group':
2250 $l = implode(', ', t3lib_div::trimExplode(',', $value, 1));
2251 break;
2252 case 'check':
2253 if (!is_array($theColConf['items']) || count($theColConf['items'])==1) {
2254 $l = $value ? $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xml:yes') : $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xml:no');
2255 } else {
2256 $lA = Array();
2257 foreach ($theColConf['items'] as $key => $val) {
2258 if ($value & pow(2, $key)) {$lA[] = $GLOBALS['LANG']->sL($val[0]);}
2259 }
2260 $l = implode(', ', $lA);
2261 }
2262 break;
2263 case 'input':
2264 if (isset($value)) {
2265 if (t3lib_div::inList($theColConf['eval'], 'date')) {
2266 $l = self::date($value) .
2267 ' (' .
2268 ($GLOBALS['EXEC_TIME'] - $value > 0 ? '-' : '') .
2269 self::calcAge(abs($GLOBALS['EXEC_TIME'] - $value), $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears')) .
2270 ')';
2271 } elseif (t3lib_div::inList($theColConf['eval'], 'time')) {
2272 $l = self::time($value, FALSE);
2273 } elseif (t3lib_div::inList($theColConf['eval'], 'timesec')) {
2274 $l = self::time($value);
2275 } elseif (t3lib_div::inList($theColConf['eval'], 'datetime')) {
2276 $l = self::datetime($value);
2277 } else {
2278 $l = $value;
2279 }
2280 }
2281 break;
2282 case 'flex':
2283 $l = strip_tags($value);
2284 break;
2285 default:
2286 if ($defaultPassthrough) {
2287 $l = $value;
2288 } elseif ($theColConf['MM']) {
2289 $l = 'N/A';
2290 } elseif ($value) {
2291 $l = t3lib_div::fixed_lgd_cs(strip_tags($value), 200);
2292 }
2293 break;
2294 }
2295
2296 // If this field is a password field, then hide the password by changing it to a random number of asterisk (*)
2297 if (stristr($theColConf['eval'], 'password')) {
2298 unset($l);
2299 $randomNumber = rand(5, 12);
2300 for ($i=0; $i < $randomNumber; $i++) {
2301 $l .= '*';
2302 }
2303 }
2304
2305 /*****************
2306 *HOOK: post-processing the human readable output from a record
2307 ****************/
2308 if (is_array ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'])) {
2309 // create NULL-reference
2310 $null = NULL;
2311 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'] as $_funcRef) {
2312 $params = array(
2313 'value' => $l,
2314 'colConf' => $theColConf
2315 );
2316 $l = t3lib_div::callUserFunction($_funcRef, $params, $null);
2317 }
2318 }
2319
2320 if ($fixed_lgd_chars) {
2321 return t3lib_div::fixed_lgd_cs($l, $fixed_lgd_chars);
2322 } else {
2323 return $l;
2324 }
2325 }
2326 }
2327
2328 /**
2329 * 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.
2330 * Usage: 2
2331 *
2332 * @param string Table name, present in TCA
2333 * @param string Field name
2334 * @param string Field value
2335 * @param integer $fixed_lgd_chars is the max amount of characters the value may occupy
2336 * @param integer uid of the current record
2337 * @param boolean If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
2338 * @return string
2339 * @see getProcessedValue()
2340 */
2341 public static function getProcessedValueExtra($table, $fN, $fV, $fixed_lgd_chars = 0, $uid = 0, $forceResult = TRUE) {
2342 global $TCA;
2343 $fVnew = self::getProcessedValue($table, $fN, $fV, $fixed_lgd_chars, 1, 0, $uid, $forceResult);
2344 if (!isset($fVnew)) {
2345 if (is_array($TCA[$table])) {
2346 if ($fN==$TCA[$table]['ctrl']['tstamp'] || $fN==$TCA[$table]['ctrl']['crdate']) {
2347 $fVnew = self::datetime($fV);
2348 } elseif ($fN=='pid'){
2349 $fVnew = self::getRecordPath($fV, '1=1', 20); // Fetches the path with no regard to the users permissions to select pages.
2350 } else {
2351 $fVnew = $fV;
2352 }
2353 }
2354 }
2355 return $fVnew;
2356 }
2357
2358 /**
2359 * Returns file icon name (from $FILEICONS) for the fileextension $ext
2360 * Usage: 10
2361 *
2362 * @param string File extension, lowercase
2363 * @return string File icon filename
2364 */
2365 public static function getFileIcon($ext) {
2366 return $GLOBALS['FILEICONS'][$ext] ? $GLOBALS['FILEICONS'][$ext] : $GLOBALS['FILEICONS']['default'];
2367 }
2368
2369 /**
2370 * Returns fields for a table, $table, which would typically be interesting to select
2371 * This includes uid, the fields defined for title, icon-field.
2372 * 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)
2373 * Usage: 3
2374 *
2375 * @param string Table name, present in TCA
2376 * @param string Table prefix
2377 * @param array Preset fields (must include prefix if that is used)
2378 * @return string List of fields.
2379 */
2380 public static function getCommonSelectFields($table, $prefix = '', $fields = array()) {
2381 global $TCA;
2382 $fields[] = $prefix.'uid';
2383 $fields[] = $prefix.$TCA[$table]['ctrl']['label'];
2384
2385 if ($TCA[$table]['ctrl']['label_alt']) {
2386 $secondFields = t3lib_div::trimExplode(',', $TCA[$table]['ctrl']['label_alt'], 1);
2387 foreach($secondFields as $fieldN) {
2388 $fields[] = $prefix.$fieldN;
2389 }
2390 }
2391 if ($TCA[$table]['ctrl']['versioningWS']) {
2392 $fields[] = $prefix.'t3ver_id';
2393 $fields[] = $prefix.'t3ver_state';
2394 $fields[] = $prefix.'t3ver_wsid';
2395 $fields[] = $prefix.'t3ver_count';
2396 }
2397
2398 if ($TCA[$table]['ctrl']['selicon_field']) $fields[] = $prefix.$TCA[$table]['ctrl']['selicon_field'];
2399 if ($TCA[$table]['ctrl']['typeicon_column']) $fields[] = $prefix.$TCA[$table]['ctrl']['typeicon_column'];
2400
2401 if (is_array($TCA[$table]['ctrl']['enablecolumns'])) {
2402 if ($TCA[$table]['ctrl']['enablecolumns']['disabled']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['disabled'];
2403 if ($TCA[$table]['ctrl']['enablecolumns']['starttime']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['starttime'];
2404 if ($TCA[$table]['ctrl']['enablecolumns']['endtime']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['endtime'];
2405 if ($TCA[$table]['ctrl']['enablecolumns']['fe_group']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['fe_group'];
2406 }
2407
2408 return implode(',', array_unique($fields));
2409 }
2410
2411 /**
2412 * Makes a form for configuration of some values based on configuration found in the array $configArray, with default values from $defaults and a data-prefix $dataPrefix
2413 * <form>-tags must be supplied separately
2414 * Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3. That's were you can expect to find example, if anywhere.
2415 * Usage: 1 (ext. direct_mail)
2416 *
2417 * @param array Field configuration code.
2418 * @param array Defaults
2419 * @param string Prefix for formfields
2420 * @return string HTML for a form.
2421 */
2422 public static function makeConfigForm($configArray, $defaults, $dataPrefix) {
2423 $params = $defaults;
2424 if (is_array($configArray)) {
2425 $lines = array();
2426 foreach ($configArray as $fname => $config) {
2427 if (is_array($config)) {
2428 $lines[$fname] = '<strong>'.htmlspecialchars($config[1]).'</strong><br />';
2429 $lines[$fname].=$config[2].'<br />';
2430 switch($config[0]) {
2431 case 'string':
2432 case 'short':
2433 $formEl = '<input type="text" name="'.$dataPrefix.'['.$fname.']" value="'.$params[$fname].'"'.$GLOBALS['TBE_TEMPLATE']->formWidth($config[0]=='short'?24:48).' />';
2434 break;
2435 case 'check':
2436 $formEl = '<input type="hidden" name="'.$dataPrefix.'['.$fname.']" value="0" /><input type="checkbox" name="'.$dataPrefix.'['.$fname.']" value="1"'.($params[$fname]?' checked="checked"':'').' />';
2437 break;
2438 case 'comment':
2439 $formEl = '';
2440 break;
2441 case 'select':
2442 $opt = array();
2443 foreach ($config[3] as $k => $v) {
2444 $opt[] = '<option value="'.htmlspecialchars($k).'"'.($params[$fname]==$k?' selected="selected"':'').'>'.htmlspecialchars($v).'</option>';
2445 }
2446 $formEl = '<select name="'.$dataPrefix.'['.$fname.']">'.implode('', $opt).'</select>';
2447 break;
2448 default:
2449 debug($config);
2450 break;
2451 }
2452 $lines[$fname].=$formEl;
2453 $lines[$fname].='<br /><br />';
2454 } else {
2455 $lines[$fname] = '<hr />';
2456 if ($config) $lines[$fname].='<strong>'.strtoupper(htmlspecialchars($config)).'</strong><br />';
2457 if ($config) $lines[$fname].='<br />';
2458 }
2459 }
2460 }
2461 $out = implode('', $lines);
2462 $out.='<input type="submit" name="submit" value="Update configuration" />';
2463 return $out;
2464 }
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478 /*******************************************
2479 *
2480 * Backend Modules API functions
2481 *
2482 *******************************************/
2483
2484 /**
2485 * Returns help-text icon if configured for.
2486 * TCA_DESCR must be loaded prior to this function and $BE_USER must
2487 * have 'edit_showFieldHelp' set to 'icon', otherwise nothing is returned
2488 * Usage: 6
2489 *
2490 * Please note: since TYPO3 4.5 the UX team decided to not use CSH in its former way,
2491 * but to wrap the given text (where before the help icon was, and you could hover over it)
2492 * Please also note that since TYPO3 4.5 the option to enable help (none, icon only, full text)
2493 * was completely removed.
2494 *
2495 * @param string Table name
2496 * @param string Field name
2497 * @param string Back path
2498 * @param boolean Force display of icon nomatter BE_USER setting for help
2499 * @return string HTML content for a help icon/text
2500 */
2501 public static function helpTextIcon($table, $field, $BACK_PATH, $force = 0) {
2502 global $TCA_DESCR, $BE_USER;
2503
2504 if (is_array($TCA_DESCR[$table]) && is_array($TCA_DESCR[$table]['columns'][$field]) && (isset($BE_USER->uc['edit_showFieldHelp']) || $force)) {
2505 if ($BE_USER->uc['edit_showFieldHelp'] == 'icon') {
2506 $text = self::helpText($table, $field);
2507 $text = '<span class="typo3-csh-inline">' . $GLOBALS['LANG']->hscAndCharConv($text, FALSE) . '</span>';
2508 }
2509 return '<a class="typo3-csh-link" href="#" rel="' . $table . '.' . $field . '">' . t3lib_iconWorks::getSpriteIcon('actions-system-help-open', array('class' => 'typo3-csh-icon')) . $text.'</a>';
2510 }
2511 }
2512
2513 /**
2514 * Returns CSH help text (description), if configured for, as an array (title, description)
2515 * Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text.
2516 *
2517 * @param string Table name
2518 * @param string Field name
2519 * @return array With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'
2520 */
2521 public static function helpTextArray($table, $field) {
2522 if (!isset($GLOBALS['TCA_DESCR'][$table]['columns'])) {
2523 $GLOBALS['LANG']->loadSingleTableDescription($table);
2524 }
2525 $output = array(
2526 'description' => NULL,
2527 'title' => NULL,
2528 'moreInfo' => FALSE,
2529 );
2530 if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field])) {
2531 $data = $GLOBALS['TCA_DESCR'][$table]['columns'][$field];
2532
2533 // add alternative title, if defined
2534 if ($data['alttitle']) {
2535 $output['title'] = $data['alttitle'];
2536 }
2537
2538 // if we have more information to show
2539 if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
2540 $output['moreInfo'] = TRUE;
2541 }
2542
2543 // add description
2544 if ($data['description']) {
2545 $output['description'] = $data['description'];
2546 }
2547 }
2548 return $output;
2549 }
2550
2551 /**
2552 * Returns CSH help text (description), if configured for.
2553 * TCA_DESCR must be loaded prior to this function and $BE_USER must have "edit_showFieldHelp" set to "text",
2554 * otherwise nothing is returned
2555 * Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text.
2556 * Usage: 4
2557 *
2558 * @param string Table name
2559 * @param string Field name
2560 * @param string Back path, deprecated since TYPO3 4.5, will be removed in TYPO3 4.7, because not used at all
2561 * @param string DEPRECATED: Additional style-attribute content for wrapping table (now: only in function cshItem needed)
2562 * @return string HTML content for help text
2563 */
2564 public static function helpText($table, $field, $BACK_PATH = '', $styleAttrib = '') {
2565 $helpTextArray = self::helpTextArray($table, $field);
2566
2567 $output = '';
2568
2569 // put header before the rest of the text
2570 if ($helpTextArray['title'] !== NULL) {
2571 $output .= '<h2 class="t3-row-header">' . $helpTextArray['title'] . '</h2>';
2572 }
2573 // add the content
2574 if ($helpTextArray['description'] !== NULL) {
2575 $output .= $helpTextArray['description'];
2576 }
2577 // add see also arrow if we have more info
2578 if ($data['moreInfo']) {
2579 $arrow = t3lib_iconWorks::getSpriteIcon('actions-view-go-forward');
2580 }
2581 // add description text
2582 if ($data['description'] || $arrow) {
2583 $output['description'] = '<p class="t3-help-short">' . nl2br(htmlspecialchars($data['description'])) . $arrow . '</p>';
2584 }
2585
2586 return $output;
2587 }
2588
2589 /**
2590 * API function that wraps the text / html in help text, so if a user hovers over it
2591 * the help text will show up
2592 * This is the new help API function since TYPO3 4.5, and uses the new behaviour
2593 * (hover over text, no icon, no fulltext option, no option to disable the help)
2594 *
2595 * @param string $table The table name for which the help should be shown
2596 * @param string $field The field name for which the help should be shown
2597 * @param string $text the text which should be wrapped with the help text
2598 * @return string the HTML code ready to render
2599 * @api public
2600 */
2601 public static function wrapInHelp($table, $field, $text = '') {
2602 // get the help text that should be shown on hover
2603 $GLOBALS['LANG']->loadSingleTableDescription($table);
2604 $helpText = self::helpText($table, $field);
2605 if ($helpText) {
2606 // if no text was given, just use the regular help icon
2607 if ($text == '') {
2608 $text = t3lib_iconWorks::getSpriteIcon('actions-system-help-open');
2609 }
2610 $text = '<abbr class="t3-help-teaser">' . $text . '</abbr>';
2611 $text = '<a class="t3-help-link" href="#" data-table="' . $table . '" data-field="' . $field . '">' . $text . '</a>';
2612 }
2613 return $text;
2614 }
2615
2616
2617 /**
2618 * API for getting CSH icons/text for use in backend modules.
2619 * TCA_DESCR will be loaded if it isn't already
2620 * Usage: ?
2621 *
2622 * @param string Table name ('_MOD_'+module name)
2623 * @param string Field name (CSH locallang main key)
2624 * @param string Back path
2625 * @param string Wrap code for icon-mode, splitted by "|". Not used for full-text mode.
2626 * @param boolean If set, the full text will never be shown (only icon).
2627 * Useful for places where it will break the page if the table with full text is shown.
2628 * @param string Additional style-attribute content for wrapping table (full text mode only)
2629 * @return string HTML content for help text
2630 * @see helpText(), helpTextIcon()
2631 */
2632 public static function cshItem($table, $field, $BACK_PATH, $wrap = '', $onlyIconMode = FALSE, $styleAttrib = '') {
2633 global $TCA_DESCR, $LANG, $BE_USER;
2634
2635 if ($BE_USER->uc['edit_showFieldHelp']) {
2636 $LANG->loadSingleTableDescription($table);
2637
2638 if (is_array($TCA_DESCR[$table])) {
2639 // Creating CSH icon and short description:
2640 $fullText = self::helpText($table, $field, $BACK_PATH, '');
2641 $icon = self::helpTextIcon($table, $field, $BACK_PATH);
2642
2643 if ($fullText && !$onlyIconMode && $BE_USER->uc['edit_showFieldHelp'] == 'text') {
2644
2645 // Additional styles?
2646 $params = $styleAttrib ? ' style="'.$styleAttrib.'"' : '';
2647
2648 // Compile table with CSH information:
2649 $fullText = '<table border="0" cellpadding="0" cellspacing="0" class="typo3-csh-inline"'.$params.'>
2650 <tr>
2651 <td valign="top" width="14"><div class="t3-row-header">' . $icon . '</div></td>
2652 <td valign="top">'.$fullText.'</td>
2653 </tr>
2654 </table>';
2655
2656 $output = $LANG->hscAndCharConv($fullText, false);
2657 } else {
2658 $output = $icon;
2659
2660 if ($output && $wrap) {
2661 $wrParts = explode('|', $wrap);
2662 $output = $wrParts[0].$output.$wrParts[1];
2663 }
2664 }
2665
2666 return $output;
2667 }
2668 }
2669 }
2670
2671 /**
2672 * 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.
2673 * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
2674 * Usage: 35
2675 *
2676 * @param string $params is 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.
2677 * @param string $backPath must point back to the TYPO3_mainDir directory (where alt_doc.php is)
2678 * @param string $requestUri is an optional returnUrl you can set - automatically set to REQUEST_URI.
2679 * @return string
2680 * @see template::issueCommand()
2681 */
2682 public static function editOnClick($params, $backPath = '', $requestUri = '') {
2683 $retUrl = 'returnUrl='.($requestUri==-1?"'+T3_THIS_LOCATION+'":rawurlencode($requestUri?$requestUri:t3lib_div::getIndpEnv('REQUEST_URI')));
2684 return "window.location.href='".$backPath."alt_doc.php?".$retUrl.$params."'; return false;";
2685 }
2686
2687 /**
2688 * Returns a JavaScript string for viewing the page id, $id
2689 * It will detect the correct domain name if needed and provide the link with the right back path. Also it will re-use any window already open.
2690 * Usage: 8
2691 *
2692 * @param integer $id is page id
2693 * @param string $backpath must point back to TYPO3_mainDir (where the site is assumed to be one level above)
2694 * @param array If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
2695 * @param string $anchor is optional anchor to the URL
2696 * @param string $altUrl is an alternative URL which - if set - will make all other parameters ignored: The function will just return the window.open command wrapped around this URL!
2697 * @param string Additional GET variables.
2698 * @param boolean If true, then the preview window will gain the focus.
2699 * @return string
2700 */
2701 public static function viewOnClick($id, $backPath = '', $rootLine = '', $anchor = '', $altUrl = '', $addGetVars = '', $switchFocus = TRUE) {
2702
2703 $viewScriptPreviewDisabled = t3lib_extMgm::isLoaded('version') ?
2704 '/' . TYPO3_mainDir . t3lib_extMgm::extRelPath('version') . 'ws/wsol_preview.php?id='
2705 :
2706 '/index.php?id='
2707 ;
2708 $viewScriptPreviewEnabled = '/index.php?id=';
2709 if ($altUrl) {
2710 $viewScriptPreviewEnabled = $viewScriptPreviewDisabled = $altUrl;
2711 }
2712
2713 // Look if a fixed preview language should be added:
2714 $viewLanguageOrder = $GLOBALS['BE_USER']->getTSConfigVal('options.view.languageOrder');
2715 if (strlen($viewLanguageOrder)) {
2716 $suffix = '';
2717
2718 // Find allowed languages (if none, all are allowed!)
2719 if (!$GLOBALS['BE_USER']->user['admin'] &&
2720 strlen($GLOBALS['BE_USER']->groupData['allowed_languages'])) {
2721 $allowed_languages = array_flip(explode(',', $GLOBALS['BE_USER']->groupData['allowed_languages']));
2722 }
2723
2724 // Traverse the view order, match first occurence:
2725 $lOrder = t3lib_div::intExplode(',', $viewLanguageOrder);
2726 foreach($lOrder as $langUid) {
2727 if (is_array($allowed_languages) && count($allowed_languages)) {
2728 if (isset($allowed_languages[$langUid])) { // Choose if set.
2729 $suffix = '&L=' . $langUid;
2730 break;
2731 }
2732 } else { // All allowed since no lang. are listed.
2733 $suffix = '&L=' . $langUid;
2734 break;
2735 }
2736 }
2737 // Add it:
2738 $addGetVars .= $suffix;
2739 }
2740
2741 // check if we need to preview a mount point
2742 $sys_page = t3lib_div::makeInstance('t3lib_pageSelect');
2743 $sys_page->init(FALSE);
2744 $mountPointInfo = $sys_page->getMountPointInfo($id);
2745 if ($mountPointInfo && $mountPointInfo['overlay']) {
2746 $id = $mountPointInfo['mount_pid'];
2747 $addGetVars .= '&MP=' . $mountPointInfo['MPvar'];
2748 }
2749
2750 $viewDomain = self::getViewDomain($id, $rootLine);
2751 $urlPreviewEnabled = $viewDomain . $viewScriptPreviewEnabled . $id . $addGetVars . $anchor;
2752 $urlPreviewDisabled = $viewDomain . $viewScriptPreviewDisabled . $id . $addGetVars . $anchor;
2753
2754 return "var previewWin=window.open((top.TYPO3.configuration.inWorkspace === 0 || (top.TYPO3.configuration.inWorkspace !== 0 && top.TYPO3.configuration.workspaceFrontendPreviewEnabled)) ?'" .
2755 $urlPreviewEnabled . "':'" . $urlPreviewDisabled .
2756 "','newTYPO3frontendWindow');" . ( $switchFocus ? 'previewWin.focus();' : '');
2757 }
2758
2759 /**
2760 * Builds the frontend view domain for a given page ID with a given root
2761 * line.
2762 *
2763 * @param integer $pageId the page ID to use, must be > 0
2764 * @param array $rootLine the root line structure to use
2765 *
2766 * @return string the full domain including the protocol http:// or https://, but without the trailing '/'
2767 *
2768 * @author Michael Klapper <michael.klapper@aoemedia.de>
2769 */
2770 public static function getViewDomain($pageId, $rootLine = null) {
2771 $domain = rtrim(t3lib_div::getIndpEnv('TYPO3_SITE_URL'), '/');
2772
2773 if (!is_array($rootLine)) {
2774 $rootLine = self::BEgetRootLine($pageId);
2775 }
2776
2777 // checks alternate domains
2778 if (count($rootLine) > 0) {
2779 $urlParts = parse_url($domain);
2780 if (self::getDomainStartPage($urlParts['host'], $urlParts['path'])) {
2781 $protocol = t3lib_div::getIndpEnv('TYPO3_SSL') ? 'https://' : 'http://';
2782 $domain = $protocol . self::firstDomainRecord($rootLine);
2783 }
2784 }
2785
2786 return $domain;
2787 }
2788
2789 /**
2790 * Returns the merged User/Page TSconfig for page id, $id.
2791 * Please read details about module programming elsewhere!
2792 * Usage: 15
2793 *
2794 * @param integer Page uid
2795 * @param string $TSref is an object string which determines the path of the TSconfig to return.
2796 * @return array
2797 */
2798 public static function getModTSconfig($id, $TSref) {
2799 $pageTS_modOptions = $GLOBALS['BE_USER']->getTSConfig($TSref, self::getPagesTSconfig($id));
2800 $BE_USER_modOptions = $GLOBALS['BE_USER']->getTSConfig($TSref);
2801 $modTSconfig = t3lib_div::array_merge_recursive_overrule($pageTS_modOptions, $BE_USER_modOptions);
2802 return $modTSconfig;
2803 }
2804
2805 /**
2806 * Returns a selector box "function menu" for a module
2807 * Requires the JS function jumpToUrl() to be available
2808 * See Inside TYPO3 for details about how to use / make Function menus
2809 * Usage: 50
2810 *
2811 * @param mixed $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
2812 * @param string $elementName it the form elements name, probably something like "SET[...]"
2813 * @param string $currentValue is the value to be selected currently.
2814 * @param array $menuItems is an array with the menu items for the selector box
2815 * @param string $script is the script to send the &id to, if empty it's automatically found
2816 * @param string $addParams is additional parameters to pass to the script.
2817 * @return string HTML code for selector box
2818 */
2819 public static function getFuncMenu($mainParams, $elementName, $currentValue, $menuItems, $script = '', $addparams = '') {
2820 if (is_array($menuItems)) {
2821 if (!is_array($mainParams)) {
2822 $mainParams = array('id' => $mainParams);
2823 }
2824 $mainParams = t3lib_div::implodeArrayForUrl('', $mainParams);
2825
2826 if (!$script) {
2827 $script = basename(PATH_thisScript);
2828 $mainParams.= (t3lib_div::_GET('M') ? '&M='.rawurlencode(t3lib_div::_GET('M')) : '');
2829 }
2830
2831 $options = array();
2832 foreach($menuItems as $value => $label) {
2833 $options[] = '<option value="'.htmlspecialchars($value).'"'.(!strcmp($currentValue, $value)?' selected="selected"':'').'>'.
2834 t3lib_div::deHSCentities(htmlspecialchars($label)).
2835 '</option>';
2836 }
2837 if (count($options)) {
2838 $onChange = 'jumpToUrl(\''.$script.'?'.$mainParams.$addparams.'&'.$elementName.'=\'+this.options[this.selectedIndex].value,this);';
2839 return '
2840
2841 <!-- Function Menu of module -->
2842 <select name="'.$elementName.'" onchange="'.htmlspecialchars($onChange).'">
2843 '.implode('
2844 ',$options).'
2845 </select>
2846 ';
2847 }
2848 }
2849 }
2850
2851 /**
2852 * Checkbox function menu.
2853 * Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.
2854 * Usage: 34
2855 *
2856 * @param mixed $mainParams $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
2857 * @param string $elementName it the form elements name, probably something like "SET[...]"
2858 * @param string $currentValue is the value to be selected currently.
2859 * @param string $script is the script to send the &id to, if empty it's automatically found
2860 * @param string $addParams is additional parameters to pass to the script.
2861 * @param string Additional attributes for the checkbox input tag
2862 * @return string HTML code for checkbox
2863 * @see getFuncMenu()
2864 */
2865 public static function getFuncCheck($mainParams, $elementName, $currentValue, $script = '', $addparams = '', $tagParams = '') {
2866 if (!is_array($mainParams)) {
2867 $mainParams = array('id' => $mainParams);
2868 }
2869 $mainParams = t3lib_div::implodeArrayForUrl('', $mainParams);
2870
2871 if (!$script) {
2872 $script = basename(PATH_thisScript);
2873 $mainParams.= (t3lib_div::_GET('M') ? '&M='.rawurlencode(t3lib_div::_GET('M')) : '');
2874 }
2875
2876 $onClick = 'jumpToUrl(\''.$script.'?'.$mainParams.$addparams.'&'.$elementName.'=\'+(this.checked?1:0),this);';
2877 return '<input type="checkbox" class="checkbox" name="'.$elementName.'"'.($currentValue?' checked="checked"':'').' onclick="'.htmlspecialchars($onClick).'"'.($tagParams?' '.$tagParams:'').' />';
2878 }
2879
2880 /**
2881 * Input field function menu
2882 * Works like ->getFuncMenu() / ->getFuncCheck() but displays a input field instead which updates the script "onchange"
2883 * Usage: 1
2884 *
2885 * @param mixed $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
2886 * @param string $elementName it the form elements name, probably something like "SET[...]"
2887 * @param string $currentValue is the value to be selected currently.
2888 * @param integer Relative size of input field, max is 48
2889 * @param string $script is the script to send the &id to, if empty it's automatically found
2890 * @param string $addParams is additional parameters to pass to the script.
2891 * @return string HTML code for input text field.
2892 * @see getFuncMenu()
2893 */
2894 public static function getFuncInput($mainParams, $elementName, $currentValue, $size = 10, $script = "", $addparams = "") {
2895 if (!is_array($mainParams)) {
2896 $mainParams = array('id' => $mainParams);
2897 }
2898 $mainParams = t3lib_div::implodeArrayForUrl('', $mainParams);
2899
2900 if (!$script) {
2901 $script = basename(PATH_thisScript);
2902 $mainParams.= (t3lib_div::_GET('M') ? '&M='.rawurlencode(t3lib_div::_GET('M')) : '');
2903 }
2904
2905 $onChange = 'jumpToUrl(\''.$script.'?'.$mainParams.$addparams.'&'.$elementName.'=\'+escape(this.value),this);';
2906 return '<input type="text"'.$GLOBALS['TBE_TEMPLATE']->formWidth($size).' name="'.$elementName.'" value="'.htmlspecialchars($currentValue).'" onchange="'.htmlspecialchars($onChange).'" />';
2907 }
2908
2909 /**
2910 * Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig)
2911 * See Inside TYPO3 about how to program modules and use this API.
2912 * Usage: 4
2913 *
2914 * @param array Module TS config array
2915 * @param array Array of items from which to remove items.
2916 * @param string $TSref points to the "object string" in $modTSconfig
2917 * @return array The modified $itemArray is returned.
2918 */
2919 public static function unsetMenuItems($modTSconfig, $itemArray, $TSref) {
2920 // Getting TS-config options for this module for the Backend User:
2921 $conf = $GLOBALS['BE_USER']->getTSConfig($TSref, $modTSconfig);
2922 if (is_array($conf['properties'])) {
2923 foreach ($conf['properties'] as $key => $val) {
2924 if (!$val) {
2925 unset($itemArray[$key]);
2926 }
2927 }
2928 }
2929 return $itemArray;
2930 }
2931
2932 /**
2933 * Call to update the page tree frame (or something else..?) after
2934 * t3lib_BEfunc::getSetUpdateSignal('updatePageTree') -> will set the page tree to be updated.
2935 * t3lib_BEfunc::getSetUpdateSignal() -> will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
2936 * please use the setUpdateSignal function instead now, as it allows you to add more parameters
2937 * Usage: 11
2938 *
2939 * @param string Whether to set or clear the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set.
2940 * @return string HTML code (<script> section)
2941 * @see t3lib_BEfunc::getUpdateSignalCode()
2942 * @see t3lib_BEfunc::setUpdateSignal()
2943 * @deprecated since TYPO3 4.2, this function will be removed in TYPO3 4.6, use the setUpdateSignal function instead, as it allows you to add more parameters
2944 */
2945 public static function getSetUpdateSignal($set = '') {
2946 t3lib_div::logDeprecatedFunction();
2947
2948 // kept for backwards compatibility if $set is empty, use "getUpdateSignalCode()" instead
2949 if ($set) {
2950 return self::setUpdateSignal($set);
2951 } else {
2952 return self::getUpdateSignalCode();
2953 }
2954 }
2955
2956
2957 /**
2958 * Call to update the page tree frame (or something else..?) after
2959 * use 'updatePageTree' as a first parameter will set the page tree to be updated.
2960 * Usage: 10
2961 *
2962 * @param string Key to set the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. If empty, all update signals will be removed.
2963 * @param mixed Additional information for the update signal, used to only refresh a branch of the tree
2964 * @return void
2965 * @see t3lib_BEfunc::getUpdateSignalCode()
2966 */
2967 public static function setUpdateSignal($set = '', $params = '') {
2968 global $BE_USER;
2969 $modData = $BE_USER->getModuleData('t3lib_BEfunc::getUpdateSignal', 'ses');
2970
2971 if ($set) {
2972 $modData[$set] = array(
2973 'set' => $set,
2974 'parameter' => $params);
2975 } else { // clear the module data
2976 $modData = array();
2977 }
2978 $BE_USER->pushModuleData('t3lib_BEfunc::getUpdateSignal', $modData);
2979 }
2980
2981
2982 /**
2983 * Call to update the page tree frame (or something else..?) if this is set by the function
2984 * setUpdateSignal(). It will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
2985 * Usage: 1
2986 *
2987 * @return string HTML javascript code
2988 * @see t3lib_BEfunc::setUpdateSignal()
2989 */
2990 public static function getUpdateSignalCode() {
2991 $signals = array();
2992 $modData = $GLOBALS['BE_USER']->getModuleData('t3lib_BEfunc::getUpdateSignal', 'ses');
2993 if (!count($modData)) {
2994 return '';
2995 }
2996
2997 // Hook: Allows to let TYPO3 execute your JS code
2998 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['updateSignalHook'])) {
2999 $updateSignals = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['updateSignalHook'];
3000 } else {
3001 $updateSignals = array();
3002 }
3003
3004 // loop through all setUpdateSignals and get the JS code
3005 foreach ($modData as $set => $val) {
3006 if (isset($updateSignals[$set])) {
3007 $params = array('set' => $set, 'parameter' => $val['parameter'], 'JScode' => '');
3008 $ref = NULL;
3009 t3lib_div::callUserFunction($updateSignals[$set], $params, $ref);
3010 $signals[] = $params['JScode'];
3011 } else if ($set == 'updatePageTree' || $set == 'updateFolderTree') {
3012 $signals[] = '
3013 if (top && top.TYPO3.Backend.NavigationContainer) {
3014 top.TYPO3.Backend.NavigationContainer.refresh();
3015 }';
3016 }
3017 }
3018
3019 $content = implode(LF, $signals);
3020
3021 self::setUpdateSignal(); // for backwards compatibility, should be replaced
3022 return $content;
3023 }
3024
3025
3026 /**
3027 * Returns an array which is most backend modules becomes MOD_SETTINGS containing values from function menus etc. determining the function of the module.
3028 * This is kind of session variable management framework for the backend users.
3029