Fixed bug #14307: fe_user passwords are visible in the info popup window in the backe...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_befunc.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (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 Skaarhoj
37 * XHTML compliant
38 *
39 * @author Kasper Skaarhoj <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 Skaarhoj <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 ? t3lib_BEfunc::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 = t3lib_BEfunc::getRecord($table, $uid, $internalFields, $where, $useDeleteClause);
258 t3lib_BEfunc::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 = t3lib_BEfunc::getRecord($table, $uid, $fields, $where);
269 t3lib_BEfunc::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 ? t3lib_BEfunc::deleteClause($theTable).' ' : '').
320 t3lib_BEfunc::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.5, 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.5, 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 while(list($key, $val) = each($tempItemArray)) {
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 = t3lib_BEfunc::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.5, 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.5, 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.5, 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 );
622 if (isset($val['_ORIG_pid'])) {
623 $output[$c]['_ORIG_pid'] = $val['_ORIG_pid'];
624 }
625 }
626 $BEgetRootLine_cache[$ident] = $output;
627 }
628 return $output;
629 }
630
631 /**
632 * Gets the cached page record for the rootline
633 *
634 * @param integer $uid: Page id for which to create the root line.
635 * @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.
636 * @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!
637 * @return array Cached page record for the rootline
638 * @see BEgetRootLine
639 */
640 protected static function getPageForRootline($uid, $clause, $workspaceOL) {
641 static $getPageForRootline_cache = array();
642 $ident = $uid . '-' . $clause . '-' . $workspaceOL;
643
644 if (is_array($getPageForRootline_cache[$ident])) {
645 $row = $getPageForRootline_cache[$ident];
646 } else {
647 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
648 'pid,uid,title,TSconfig,is_siteroot,storage_pid,t3ver_oid,t3ver_wsid,t3ver_state,t3ver_swapmode,t3ver_stage',
649 'pages',
650 'uid=' . intval($uid) . ' ' .
651 t3lib_BEfunc::deleteClause('pages') . ' ' .
652 $clause // whereClauseMightContainGroupOrderBy
653 );
654
655 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
656 if ($row) {
657 if ($workspaceOL) {
658 t3lib_BEfunc::workspaceOL('pages', $row);
659 }
660 if (is_array($row)) {
661 t3lib_BEfunc::fixVersioningPid('pages', $row);
662 $getPageForRootline_cache[$ident] = $row;
663 }
664 }
665 $GLOBALS['TYPO3_DB']->sql_free_result($res);
666 }
667 return $row;
668 }
669
670 /**
671 * Opens the page tree to the specified page id
672 *
673 * @param integer Page id.
674 * @param boolean If set, then other open branches are closed.
675 * @return void
676 */
677 public static function openPageTree($pid, $clearExpansion) {
678 global $BE_USER;
679
680 // Get current expansion data:
681 if ($clearExpansion) {
682 $expandedPages = array();
683 } else {
684 $expandedPages = unserialize($BE_USER->uc['browseTrees']['browsePages']);
685 }
686
687 // Get rootline:
688 $rL = t3lib_BEfunc::BEgetRootLine($pid);
689
690 // First, find out what mount index to use (if more than one DB mount exists):
691 $mountIndex = 0;
692 $mountKeys = array_flip($BE_USER->returnWebmounts());
693 foreach($rL as $rLDat) {
694 if (isset($mountKeys[$rLDat['uid']])) {
695 $mountIndex = $mountKeys[$rLDat['uid']];
696 break;
697 }
698 }
699
700 // Traverse rootline and open paths:
701 foreach($rL as $rLDat) {
702 $expandedPages[$mountIndex][$rLDat['uid']] = 1;
703 }
704
705 // Write back:
706 $BE_USER->uc['browseTrees']['browsePages'] = serialize($expandedPages);
707 $BE_USER->writeUC();
708 }
709
710 /**
711 * Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
712 * Each part of the path will be limited to $titleLimit characters
713 * Deleted pages are filtered out.
714 * Usage: 15
715 *
716 * @param integer Page uid for which to create record path
717 * @param string $clause is additional where clauses, eg. "
718 * @param integer Title limit
719 * @param integer Title limit of Full title (typ. set to 1000 or so)
720 * @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
721 */
722 public static function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit = 0) {
723 if (!$titleLimit) { $titleLimit = 1000; }
724
725 $loopCheck = 100;
726 $output = $fullOutput = '/';
727
728 $clause = trim($clause);
729 if ($clause !== '' && substr($clause, 0, 3) !== 'AND') {
730 $clause = 'AND ' . $clause;
731 }
732 $data = self::BEgetRootLine($uid, $clause);
733
734 foreach ($data as $record) {
735 if ($record['uid'] === 0) {
736 continue;
737 }
738 if ($record['_ORIG_pid'] && $record['t3ver_swapmode'] > 0) { // Branch points
739 $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...
740 }
741 $output = '/' . t3lib_div::fixed_lgd_cs(strip_tags($record['title']), $titleLimit) . $output;
742 if ($fullTitleLimit) {
743 $fullOutput = '/' . t3lib_div::fixed_lgd_cs(strip_tags($record['title']), $fullTitleLimit) . $fullOutput;
744 }
745 }
746
747 if ($fullTitleLimit) {
748 return array($output, $fullOutput);
749 } else {
750 return $output;
751 }
752 }
753
754 /**
755 * Returns an array with the exclude-fields as defined in TCA
756 * Used for listing the exclude-fields in be_groups forms
757 * Usage: 2 (t3lib_tceforms + t3lib_transferdata)
758 *
759 * @return array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries
760 */
761 public static function getExcludeFields() {
762 global $TCA;
763 // All TCA keys:
764 $theExcludeArray = Array();
765 $tc_keys = array_keys($TCA);
766 foreach($tc_keys as $table) {
767 // Load table
768 t3lib_div::loadTCA($table);
769 // All field names configured:
770 if (is_array($TCA[$table]['columns'])) {
771 $f_keys = array_keys($TCA[$table]['columns']);
772 foreach($f_keys as $field) {
773 if ($TCA[$table]['columns'][$field]['exclude']) {
774 // Get Human Readable names of fields and table:
775 $Fname = $GLOBALS['LANG']->sl($TCA[$table]['ctrl']['title']).': '.$GLOBALS['LANG']->sl($TCA[$table]['columns'][$field]['label']);
776 // add entry:
777 $theExcludeArray[] = Array($Fname, $table.':'.$field);
778 }
779 }
780 }
781 }
782 return $theExcludeArray;
783 }
784
785 /**
786 * Returns an array with explicit Allow/Deny fields.
787 * Used for listing these field/value pairs in be_groups forms
788 *
789 * @return array Array with information from all of $TCA
790 */
791 public static function getExplicitAuthFieldValues() {
792 global $TCA;
793
794 // Initialize:
795 $adLabel = array(
796 'ALLOW' => $GLOBALS['LANG']->sl('LLL:EXT:lang/locallang_core.xml:labels.allow'),
797 'DENY' => $GLOBALS['LANG']->sl('LLL:EXT:lang/locallang_core.xml:labels.deny'),
798 );
799
800 // All TCA keys:
801 $allowDenyOptions = Array();
802 $tc_keys = array_keys($TCA);
803 foreach($tc_keys as $table) {
804
805 // Load table
806 t3lib_div::loadTCA($table);
807
808 // All field names configured:
809 if (is_array($TCA[$table]['columns'])) {
810 $f_keys = array_keys($TCA[$table]['columns']);
811 foreach($f_keys as $field) {
812 $fCfg = $TCA[$table]['columns'][$field]['config'];
813 if ($fCfg['type']=='select' && $fCfg['authMode']) {
814
815 // Check for items:
816 if (is_array($fCfg['items'])) {
817 // Get Human Readable names of fields and table:
818 $allowDenyOptions[$table.':'.$field]['tableFieldLabel'] = $GLOBALS['LANG']->sl($TCA[$table]['ctrl']['title']).': '.$GLOBALS['LANG']->sl($TCA[$table]['columns'][$field]['label']);
819
820 // Check for items:
821 foreach($fCfg['items'] as $iVal) {
822 if (strcmp($iVal[1], '')) { // Values '' is not controlled by this setting.
823
824 // Find iMode:
825 $iMode = '';
826 switch((string)$fCfg['authMode']) {
827 case 'explicitAllow':
828 $iMode = 'ALLOW';
829 break;
830 case 'explicitDeny':
831 $iMode = 'DENY';
832 break;
833 case 'individual':
834 if (!strcmp($iVal[4], 'EXPL_ALLOW')) {
835 $iMode = 'ALLOW';
836 } elseif (!strcmp($iVal[4], 'EXPL_DENY')) {
837 $iMode = 'DENY';
838 }
839 break;
840 }
841
842 // Set iMode:
843 if ($iMode) {
844 $allowDenyOptions[$table.':'.$field]['items'][$iVal[1]] = array($iMode, $GLOBALS['LANG']->sl($iVal[0]), $adLabel[$iMode]);
845 }
846 }
847 }
848 }
849 }
850 }
851 }
852 }
853
854 return $allowDenyOptions;
855 }
856
857 /**
858 * Returns an array with system languages:
859 *
860 * @return array Array with languages
861 */
862 public static function getSystemLanguages() {
863
864 // Initialize, add default language:
865 $sysLanguages = array();
866 $sysLanguages[] = array('Default language', 0);
867
868 // Traverse languages
869 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,title,flag', 'sys_language', 'pid=0'.t3lib_BEfunc::deleteClause('sys_language'));
870 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
871 $sysLanguages[] = array($row['title'].' ['.$row['uid'].']', $row['uid'], ($row['flag'] ? 'flags/'.$row['flag'] : ''));
872 }
873 $GLOBALS['TYPO3_DB']->sql_free_result($res);
874
875 return $sysLanguages;
876 }
877
878 /**
879 * Determines whether a table is localizable and has the languageField and transOrigPointerField set in $TCA.
880 *
881 * @param string $table: The table to check
882 * @return boolean Whether a table is localizable
883 */
884 public static function isTableLocalizable($table) {
885 $isLocalizable = false;
886 if (isset($GLOBALS['TCA'][$table]['ctrl']) && is_array($GLOBALS['TCA'][$table]['ctrl'])) {
887 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
888 $isLocalizable = (isset($tcaCtrl['languageField']) && $tcaCtrl['languageField'] && isset($tcaCtrl['transOrigPointerField']) && $tcaCtrl['transOrigPointerField']);
889 }
890 return $isLocalizable;
891 }
892
893 /**
894 * Returns the value of the property localizationMode in the given $config array ($TCA[<table>]['columns'][<field>]['config']).
895 * If the table is prepared for localization and no localizationMode is set, 'select' is returned by default.
896 * If the table is not prepared for localization or not defined at all in $TCA, false is returned.
897 *
898 * @param string $table: The name of the table to lookup in TCA
899 * @param mixed $fieldOrConfig: The fieldname (string) or the configuration of the field to check (array)
900 * @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
901 */
902 public static function getInlineLocalizationMode($table, $fieldOrConfig) {
903 $localizationMode = false;
904 if (is_array($fieldOrConfig) && count($fieldOrConfig)) {
905 $config = $fieldOrConfig;
906 } elseif (is_string($fieldOrConfig) && isset($GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'])) {
907 $config = $GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'];
908 }
909 if (is_array($config) && isset($config['type']) && $config['type']=='inline' && self::isTableLocalizable($table)) {
910 $localizationMode = (isset($config['behaviour']['localizationMode']) && $config['behaviour']['localizationMode'] ? $config['behaviour']['localizationMode'] : 'select');
911 // The mode 'select' is not possible when child table is not localizable at all:
912 if ($localizationMode=='select' && !self::isTableLocalizable($config['foreign_table'])) {
913 $localizationMode = false;
914 }
915 }
916 return $localizationMode;
917 }
918
919 /**
920 * 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.
921 * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
922 * In any case ->isInWebMount must return true for the user (regardless of $perms_clause)
923 * Usage: 21
924 *
925 * @param integer Page uid for which to check read-access
926 * @param string $perms_clause is typically a value generated with $BE_USER->getPagePermsClause(1);
927 * @return array Returns page record if OK, otherwise false.
928 */
929 public static function readPageAccess($id, $perms_clause) {
930 if ((string)$id!='') {
931 $id = intval($id);
932 if (!$id) {
933 if ($GLOBALS['BE_USER']->isAdmin()) {
934 $path = '/';
935 $pageinfo['_thePath'] = $path;
936 return $pageinfo;
937 }
938 } else {
939 $pageinfo = t3lib_BEfunc::getRecord('pages', $id, '*', ($perms_clause ? ' AND '.$perms_clause : ''));
940 if ($pageinfo['uid'] && $GLOBALS['BE_USER']->isInWebMount($id, $perms_clause)) {
941 t3lib_BEfunc::workspaceOL('pages', $pageinfo);
942 if (is_array($pageinfo)) {
943 t3lib_BEfunc::fixVersioningPid('pages', $pageinfo);
944 list($pageinfo['_thePath'], $pageinfo['_thePathFull']) = t3lib_BEfunc::getRecordPath(intval($pageinfo['uid']), $perms_clause, 15, 1000);
945 return $pageinfo;
946 }
947 }
948 }
949 }
950 return false;
951 }
952
953 /**
954 * Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
955 * Usage: 6
956 *
957 * @param string Table name (present in TCA)
958 * @param array Record from $table
959 * @param boolean If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
960 * @return array
961 */
962 public static function getTCAtypes($table, $rec, $useFieldNameAsKey = 0) {
963 global $TCA;
964
965 t3lib_div::loadTCA($table);
966 if ($TCA[$table]) {
967
968 // Get type value:
969 $fieldValue = t3lib_BEfunc::getTCAtypeValue($table, $rec);
970
971 // Get typesConf
972 $typesConf = $TCA[$table]['types'][$fieldValue];
973
974 // Get fields list and traverse it
975 $fieldList = explode(',', $typesConf['showitem']);
976 $altFieldList = array();
977
978 // Traverse fields in types config and parse the configuration into a nice array:
979 foreach($fieldList as $k => $v) {
980 list($pFieldName, $pAltTitle, $pPalette, $pSpec) = t3lib_div::trimExplode(';', $v);
981 $defaultExtras = is_array($TCA[$table]['columns'][$pFieldName]) ? $TCA[$table]['columns'][$pFieldName]['defaultExtras'] : '';
982 $specConfParts = t3lib_BEfunc::getSpecConfParts($pSpec, $defaultExtras);
983
984 $fieldList[$k] = array(
985 'field' => $pFieldName,
986 'title' => $pAltTitle,
987 'palette' => $pPalette,
988 'spec' => $specConfParts,
989 'origString' => $v
990 );
991 if ($useFieldNameAsKey) {
992 $altFieldList[$fieldList[$k]['field']] = $fieldList[$k];
993 }
994 }
995 if ($useFieldNameAsKey) {
996 $fieldList = $altFieldList;
997 }
998
999 // Return array:
1000 return $fieldList;
1001 }
1002 }
1003
1004 /**
1005 * Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $TCA
1006 * If no "type" field is configured in the "ctrl"-section of the $TCA for the table, zero is used.
1007 * 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)
1008 * Usage: 7
1009 *
1010 * @param string Table name present in TCA
1011 * @param array Record from $table
1012 * @return string Field value
1013 * @see getTCAtypes()
1014 */
1015 public static function getTCAtypeValue($table, $rec) {
1016 global $TCA;
1017
1018 // 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.
1019 t3lib_div::loadTCA($table);
1020 if ($TCA[$table]) {
1021 $field = $TCA[$table]['ctrl']['type'];
1022 $fieldValue = $field ? ($rec[$field] ? $rec[$field] : 0) : 0;
1023 if (!is_array($TCA[$table]['types'][$fieldValue])) $fieldValue = 1;
1024 return $fieldValue;
1025 }
1026 }
1027
1028 /**
1029 * Parses a part of the field lists in the "types"-section of $TCA arrays, namely the "special configuration" at index 3 (position 4)
1030 * Elements are splitted by ":" and within those parts, parameters are splitted by "|".
1031 * 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
1032 * Usage: 5
1033 *
1034 * @param string Content from the "types" configuration of TCA (the special configuration) - see description of function
1035 * @param string The ['defaultExtras'] value from field configuration
1036 * @return array
1037 */
1038 public static function getSpecConfParts($str, $defaultExtras) {
1039
1040 // Add defaultExtras:
1041 $specConfParts = t3lib_div::trimExplode(':', $defaultExtras.':'.$str, 1);
1042
1043 $reg = array();
1044 if (count($specConfParts)) {
1045 foreach($specConfParts as $k2 => $v2) {
1046 unset($specConfParts[$k2]);
1047 if (preg_match('/(.*)\[(.*)\]/', $v2, $reg)) {
1048 $specConfParts[trim($reg[1])] = array(
1049 'parameters' => t3lib_div::trimExplode('|', $reg[2], 1)
1050 );
1051 } else {
1052 $specConfParts[trim($v2)] = 1;
1053 }
1054 }
1055 } else {
1056 $specConfParts = array();
1057 }
1058 return $specConfParts;
1059 }
1060
1061 /**
1062 * Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value.
1063 * Better see it in action! Find example in Inside TYPO3
1064 * Usage: 6
1065 *
1066 * @param array Array of "[key] = [value]" strings to convert.
1067 * @return array
1068 */
1069 public static function getSpecConfParametersFromArray($pArr) {
1070 $out = array();
1071 if (is_array($pArr)) {
1072 reset($pArr);
1073 while(list($k, $v) = each($pArr)) {
1074 $parts = explode('=', $v, 2);
1075 if (count($parts)==2) {
1076 $out[trim($parts[0])] = trim($parts[1]);
1077 } else {
1078 $out[$k] = $v;
1079 }
1080 }
1081 }
1082 return $out;
1083 }
1084
1085 /**
1086 * Finds the Data Structure for a FlexForm field
1087 * 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.
1088 * Usage: 5
1089 *
1090 * @param array Field config array
1091 * @param array Record data
1092 * @param string The table name
1093 * @param string Optional fieldname passed to hook object
1094 * @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.
1095 * @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)
1096 * @return mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.
1097 * @see t3lib_TCEforms::getSingleField_typeFlex()
1098 */
1099 public static function getFlexFormDS($conf, $row, $table, $fieldName = '', $WSOL = TRUE, $newRecordPidValue = 0) {
1100 global $TYPO3_CONF_VARS;
1101
1102 // Get pointer field etc from TCA-config:
1103 $ds_pointerField = $conf['ds_pointerField'];
1104 $ds_array = $conf['ds'];
1105 $ds_tableField = $conf['ds_tableField'];
1106 $ds_searchParentField = $conf['ds_pointerField_searchParent'];
1107
1108 // Find source value:
1109 $dataStructArray = '';
1110 if (is_array($ds_array)) { // If there is a data source array, that takes precedence
1111 // If a pointer field is set, take the value from that field in the $row array and use as key.
1112 if ($ds_pointerField) {
1113
1114 // Up to two pointer fields can be specified in a comma separated list.
1115 $pointerFields = t3lib_div::trimExplode(',', $ds_pointerField);
1116 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.
1117 if($ds_array[$row[$pointerFields[0]].','.$row[$pointerFields[1]]]) { // Check if we have a DS for the combination of both pointer fields values
1118 $srcPointer = $row[$pointerFields[0]].','.$row[$pointerFields[1]];
1119 } elseif($ds_array[$row[$pointerFields[1]].',*']) { // Check if we have a DS for the value of the first pointer field suffixed with ",*"
1120 $srcPointer = $row[$pointerFields[1]].',*';
1121 } elseif($ds_array['*,'.$row[$pointerFields[1]]]) { // Check if we have a DS for the value of the second pointer field prefixed with "*,"
1122 $srcPointer = '*,'.$row[$pointerFields[1]];
1123 } 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)
1124 $srcPointer = $row[$pointerFields[0]];
1125 }
1126 } else {
1127 $srcPointer = $row[$pointerFields[0]];
1128 }
1129
1130 $srcPointer = isset($ds_array[$srcPointer]) ? $srcPointer : 'default';
1131 } else $srcPointer = 'default';
1132
1133 // 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.
1134 if (substr($ds_array[$srcPointer], 0, 5)=='FILE:') {
1135 $file = t3lib_div::getFileAbsFileName(substr($ds_array[$srcPointer], 5));
1136 if ($file && @is_file($file)) {
1137 $dataStructArray = t3lib_div::xml2array(t3lib_div::getUrl($file));
1138 } else $dataStructArray = 'The file "'.substr($ds_array[$srcPointer], 5).'" in ds-array key "'.$srcPointer.'" was not found ("'.$file.'")'; // Error message.
1139 } else {
1140 $dataStructArray = t3lib_div::xml2array($ds_array[$srcPointer]);
1141 }
1142
1143 } elseif ($ds_pointerField) { // If pointer field AND possibly a table/field is set:
1144 // Value of field pointed to:
1145 $srcPointer = $row[$ds_pointerField];
1146
1147 // Searching recursively back if 'ds_pointerField_searchParent' is defined (typ. a page rootline, or maybe a tree-table):
1148 if ($ds_searchParentField && !$srcPointer) {
1149 $rr = t3lib_BEfunc::getRecord($table, $row['uid'], 'uid,'.$ds_searchParentField); // Get the "pid" field - we cannot know that it is in the input record! ###NOTE_A###
1150 if ($WSOL) {
1151 t3lib_BEfunc::workspaceOL($table, $rr);
1152 t3lib_BEfunc::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!
1153 }
1154 $uidAcc = array(); // Used to avoid looping, if any should happen.
1155 $subFieldPointer = $conf['ds_pointerField_searchParent_subField'];
1156 while(!$srcPointer) {
1157
1158 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1159 'uid,'.$ds_pointerField.','.$ds_searchParentField.($subFieldPointer?','.$subFieldPointer:''),
1160 $table,
1161 'uid='.intval($newRecordPidValue ? $newRecordPidValue : $rr[$ds_searchParentField]).t3lib_BEfunc::deleteClause($table) ###NOTE_A###
1162 );
1163 $newRecordPidValue = 0;
1164 $rr = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
1165 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1166
1167 // break if no result from SQL db or if looping...
1168 if (!is_array($rr) || isset($uidAcc[$rr['uid']])) break;
1169 $uidAcc[$rr['uid']] = 1;
1170
1171 if ($WSOL) {
1172 t3lib_BEfunc::workspaceOL($table, $rr);
1173 t3lib_BEfunc::fixVersioningPid($table, $rr, TRUE);
1174 }
1175 $srcPointer = ($subFieldPointer && $rr[$subFieldPointer]) ? $rr[$subFieldPointer] : $rr[$ds_pointerField];
1176 }
1177 }
1178
1179 // If there is a srcPointer value:
1180 if ($srcPointer) {
1181 if (t3lib_div::testInt($srcPointer)) { // If integer, then its a record we will look up:
1182 list($tName, $fName) = explode(':', $ds_tableField, 2);
1183 if ($tName && $fName && is_array($GLOBALS['TCA'][$tName])) {
1184 $dataStructRec = t3lib_BEfunc::getRecord($tName, $srcPointer);
1185 if ($WSOL) {
1186 t3lib_BEfunc::workspaceOL($tName, $dataStructRec);
1187 }
1188 $dataStructArray = t3lib_div::xml2array($dataStructRec[$fName]);
1189 } else $dataStructArray = 'No tablename ('.$tName.') or fieldname ('.$fName.') was found an valid!';
1190 } else { // Otherwise expect it to be a file:
1191 $file = t3lib_div::getFileAbsFileName($srcPointer);
1192 if ($file && @is_file($file)) {
1193 $dataStructArray = t3lib_div::xml2array(t3lib_div::getUrl($file));
1194 } else $dataStructArray = 'The file "'.$srcPointer.'" was not found ("'.$file.'")'; // Error message.
1195 }
1196 } else $dataStructArray = 'No source value in fieldname "'.$ds_pointerField.'"'; // Error message.
1197 } else $dataStructArray = 'No proper configuration!';
1198
1199 // Hook for post-processing the Flexform DS. Introduces the possibility to configure Flexforms via TSConfig
1200 if (is_array ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'])) {
1201 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'] as $classRef) {
1202 $hookObj = t3lib_div::getUserObj($classRef);
1203 if (method_exists($hookObj, 'getFlexFormDS_postProcessDS')) {
1204 $hookObj->getFlexFormDS_postProcessDS($dataStructArray, $conf, $row, $table, $fieldName);
1205 }
1206 }
1207 }
1208
1209 return $dataStructArray;
1210 }
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229 /*******************************************
1230 *
1231 * Caching related
1232 *
1233 *******************************************/
1234
1235 /**
1236 * Stores the string value $data in the 'cache_hash' cache with the
1237 * hash key, $hash, and visual/symbolic identification, $ident
1238 * IDENTICAL to the function by same name found in t3lib_page:
1239 * Usage: 2
1240 *
1241 * @param string 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
1242 * @param string The data string. If you want to store an array, then just serialize it first.
1243 * @param string $ident is just a textual identification in order to inform about the content!
1244 * @return void
1245 */
1246 public static function storeHash($hash, $data, $ident) {
1247 if (TYPO3_UseCachingFramework) {
1248 $GLOBALS['typo3CacheManager']->getCache('cache_hash')->set(
1249 $hash,
1250 $data,
1251 array('ident_' . $ident),
1252 0 // unlimited lifetime
1253 );
1254 } else {
1255 $insertFields = array(
1256 'hash' => $hash,
1257 'content' => $data,
1258 'ident' => $ident,
1259 'tstamp' => $GLOBALS['EXEC_TIME']
1260 );
1261 $GLOBALS['TYPO3_DB']->exec_DELETEquery('cache_hash', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($hash, 'cache_hash'));
1262 $GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_hash', $insertFields);
1263 }
1264 }
1265
1266 /**
1267 * Returns string value stored for the hash string in the cache "cache_hash"
1268 * Can be used to retrieved a cached value
1269 *
1270 * IDENTICAL to the function by same name found in t3lib_page
1271 *
1272 * @param string The hash-string which was used to store the data value
1273 * @return string
1274 */
1275 public static function getHash($hash, $expTime = 0) {
1276 $hashContent = null;
1277 if (TYPO3_UseCachingFramework) {
1278 $contentHashCache = $GLOBALS['typo3CacheManager']->getCache('cache_hash');
1279 $cacheEntry = $contentHashCache->get($hash);
1280
1281 if ($cacheEntry) {
1282 $hashContent = $cacheEntry;
1283 }
1284 } else {
1285 $expTime = intval($expTime);
1286 if ($expTime) {
1287 $whereAdd = ' AND tstamp > '.(time()-$expTime);
1288 }
1289 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('content', 'cache_hash', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($hash, 'cache_hash').$whereAdd);
1290 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
1291 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1292
1293 $hashContent = (is_array($row) ? $row['content'] : null);
1294 }
1295 return $hashContent;
1296 }
1297
1298
1299
1300
1301
1302
1303
1304
1305 /*******************************************
1306 *
1307 * TypoScript related
1308 *
1309 *******************************************/
1310
1311 /**
1312 * Returns the Page TSconfig for page with id, $id
1313 * Requires class "t3lib_TSparser"
1314 * Usage: 26 (spec. in ext info_pagetsconfig)
1315 *
1316 * @param integer Page uid for which to create Page TSconfig
1317 * @param array If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
1318 * @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.
1319 * @return array Page TSconfig
1320 * @see t3lib_TSparser
1321 */
1322 public static function getPagesTSconfig($id, $rootLine = '', $returnPartArray = 0) {
1323 $id = intval($id);
1324 if (!is_array($rootLine)) {
1325 $rootLine = t3lib_BEfunc::BEgetRootLine($id, '', TRUE);
1326 }
1327 ksort($rootLine); // Order correctly
1328 $TSdataArray = array();
1329 $TSdataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig']; // Setting default configuration:
1330 foreach($rootLine as $k => $v) {
1331 $TSdataArray['uid_'.$v['uid']] = $v['TSconfig'];
1332 }
1333 $TSdataArray = t3lib_TSparser::checkIncludeLines_array($TSdataArray);
1334 if ($returnPartArray) {
1335 return $TSdataArray;
1336 }
1337
1338 // Parsing the page TS-Config (or getting from cache)
1339 $pageTS = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
1340 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['TSconfigConditions']) {
1341 /* @var $parseObj t3lib_TSparser_TSconfig */
1342 $parseObj = t3lib_div::makeInstance('t3lib_TSparser_TSconfig');
1343 $res = $parseObj->parseTSconfig($pageTS, 'PAGES', $id, $rootLine);
1344 if ($res) {
1345 $TSconfig = $res['TSconfig'];
1346 }
1347 } else {
1348 $hash = md5('pageTS:' . $pageTS);
1349 $cachedContent = t3lib_BEfunc::getHash($hash);
1350 $TSconfig = array();
1351 if (isset($cachedContent)) {
1352 $TSconfig = unserialize($cachedContent);
1353 } else {
1354 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
1355 $parseObj->parse($pageTS);
1356 $TSconfig = $parseObj->setup;
1357 t3lib_BEfunc::storeHash($hash, serialize($TSconfig), 'PAGES_TSconfig');
1358 }
1359 }
1360
1361 // get User TSconfig overlay
1362 $userTSconfig = $GLOBALS['BE_USER']->userTS['page.'];
1363 if (is_array($userTSconfig)) {
1364 $TSconfig = t3lib_div::array_merge_recursive_overrule($TSconfig, $userTSconfig);
1365 }
1366 return $TSconfig;
1367 }
1368
1369 /**
1370 * Updates Page TSconfig for a page with $id
1371 * 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.
1372 * $impParams can be supplied as already known Page TSconfig, otherwise it's calculated.
1373 *
1374 * THIS DOES NOT CHECK ANY PERMISSIONS. SHOULD IT?
1375 * More documentation is needed.
1376 *
1377 * Usage: 1 (ext. direct_mail)
1378 *
1379 * @param integer Page id
1380 * @param array Page TS array to write
1381 * @param string Prefix for object paths
1382 * @param array [Description needed.]
1383 * @return void
1384 * @internal
1385 * @see implodeTSParams(), getPagesTSconfig()
1386 */
1387 public static function updatePagesTSconfig($id, $pageTS, $TSconfPrefix, $impParams = '') {
1388 $id = intval($id);
1389 if (is_array($pageTS) && $id>0) {
1390 if (!is_array($impParams)) {
1391 $impParams =t3lib_BEfunc::implodeTSParams(t3lib_BEfunc::getPagesTSconfig($id));
1392 }
1393 reset($pageTS);
1394 $set = array();
1395 while(list($f, $v) = each($pageTS)) {
1396 $f = $TSconfPrefix.$f;
1397 if ((!isset($impParams[$f])&&trim($v)) || strcmp(trim($impParams[$f]), trim($v))) {
1398 $set[$f] = trim($v);
1399 }
1400 }
1401 if (count($set)) {
1402 // Get page record and TS config lines
1403 $pRec = t3lib_befunc::getRecord('pages', $id);
1404 $TSlines = explode(LF, $pRec['TSconfig']);
1405 $TSlines = array_reverse($TSlines);
1406 // Reset the set of changes.
1407 reset($set);
1408 while(list($f, $v) = each($set)) {
1409 reset($TSlines);
1410 $inserted = 0;
1411 while(list($ki, $kv) = each($TSlines)) {
1412 if (substr($kv, 0, strlen($f)+1)==$f.'=') {
1413 $TSlines[$ki] = $f.'='.$v;
1414 $inserted = 1;
1415 break;
1416 }
1417 }
1418 if (!$inserted) {
1419 $TSlines = array_reverse($TSlines);
1420 $TSlines[] = $f.'='.$v;
1421 $TSlines = array_reverse($TSlines);
1422 }
1423 }
1424 $TSlines = array_reverse($TSlines);
1425
1426 // store those changes
1427 $TSconf = implode(LF, $TSlines);
1428
1429 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('pages', 'uid='.intval($id), array('TSconfig' => $TSconf));
1430 }
1431 }
1432 }
1433
1434 /**
1435 * Implodes a multi dimensional TypoScript array, $p, into a one-dimentional array (return value)
1436 * Usage: 3
1437 *
1438 * @param array TypoScript structure
1439 * @param string Prefix string
1440 * @return array Imploded TypoScript objectstring/values
1441 */
1442 public static function implodeTSParams($p, $k = '') {
1443 $implodeParams = array();
1444 if (is_array($p)) {
1445 reset($p);
1446 while(list($kb, $val) = each($p)) {
1447 if (is_array($val)) {
1448 $implodeParams = array_merge($implodeParams, t3lib_BEfunc::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.t3lib_BEfunc::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.t3lib_BEfunc::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 t3lib_BEfunc::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 while(list($uid, $row) = each($usernames)) {
1541 $userN = $uid;
1542 $set = 0;
1543 if ($row['uid']!=$GLOBALS['BE_USER']->user['uid']) {
1544 reset($groupArray);
1545 while(list(,$v) = each($groupArray)) {
1546 if ($v && t3lib_div::inList($row['usergroup_cached_list'], $v)) {
1547 $userN = $row['username'];
1548 $set = 1;
1549 }
1550 }
1551 } else {
1552 $userN = $row['username'];
1553 $set = 1;
1554 }
1555 $usernames[$uid]['username'] = $userN;
1556 if ($excludeBlindedFlag && !$set) {unset($usernames[$uid]);}
1557 }
1558 }
1559 return $usernames;
1560 }
1561
1562 /**
1563 * Corresponds to blindUserNames but works for groups instead
1564 * Usage: 2 (module web_perm)
1565 *
1566 * @param array Group names
1567 * @param array Group names (reference)
1568 * @param boolean If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1569 * @return array
1570 */
1571 public static function blindGroupNames($groups, $groupArray, $excludeBlindedFlag = 0) {
1572 if (is_array($groups) && is_array($groupArray)) {
1573 while(list($uid, $row) = each($groups)) {
1574 $groupN = $uid;
1575 $set = 0;
1576 if (t3lib_div::inArray($groupArray, $uid)) {
1577 $groupN = $row['title'];
1578 $set = 1;
1579 }
1580 $groups[$uid]['title'] = $groupN;
1581 if ($excludeBlindedFlag && !$set) {unset($groups[$uid]);}
1582 }
1583 }
1584 return $groups;
1585 }
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599 /*******************************************
1600 *
1601 * Output related
1602 *
1603 *******************************************/
1604
1605 /**
1606 * Returns the difference in days between input $tstamp and $EXEC_TIME
1607 * Usage: 2 (class t3lib_BEfunc)
1608 *
1609 * @param integer Time stamp, seconds
1610 * @return integer
1611 */
1612 public static function daysUntil($tstamp) {
1613 $delta_t = $tstamp-$GLOBALS['EXEC_TIME'];
1614 return ceil($delta_t/(3600*24));
1615 }
1616
1617 /**
1618 * Returns $tstamp formatted as "ddmmyy" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'])
1619 * Usage: 11
1620 *
1621 * @param integer Time stamp, seconds
1622 * @return string Formatted time
1623 */
1624 public static function date($tstamp) {
1625 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], (int)$tstamp);
1626 }
1627
1628 /**
1629 * Returns $tstamp formatted as "ddmmyy hhmm" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'] AND $TYPO3_CONF_VARS['SYS']['hhmm'])
1630 * Usage: 28
1631 *
1632 * @param integer Time stamp, seconds
1633 * @return string Formatted time
1634 */
1635 public static function datetime($value) {
1636 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'], $value);
1637 }
1638
1639 /**
1640 * Returns $value (in seconds) formatted as hh:mm:ss
1641 * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
1642 * Usage: 1 (class t3lib_BEfunc)
1643 *
1644 * @param integer Time stamp, seconds
1645 * @param boolean Output hh:mm:ss. If false: hh:mm
1646 * @return string Formatted time
1647 */
1648 public static function time($value, $withSeconds = TRUE) {
1649 $hh = floor($value/3600);
1650 $min = floor(($value-$hh*3600)/60);
1651 $sec = $value-$hh*3600-$min*60;
1652 $l = sprintf('%02d', $hh).':'.sprintf('%02d', $min);
1653 if ($withSeconds) {
1654 $l .= ':'.sprintf('%02d', $sec);
1655 }
1656 return $l;
1657 }
1658
1659 /**
1660 * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
1661 * Usage: 15
1662 *
1663 * @param integer $seconds could be the difference of a certain timestamp and time()
1664 * @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")
1665 * @return string Formatted time
1666 */
1667 public static function calcAge($seconds, $labels = 'min|hrs|days|yrs') {
1668 $labelArr = explode('|', $labels);
1669 $prefix = '';
1670 if ($seconds<0) {$prefix = '-'; $seconds = abs($seconds);}
1671 if ($seconds<3600) {
1672 $seconds = round ($seconds/60).' '.trim($labelArr[0]);
1673 } elseif ($seconds<24*3600) {
1674 $seconds = round ($seconds/3600).' '.trim($labelArr[1]);
1675 } elseif ($seconds<365*24*3600) {
1676 $seconds = round ($seconds/(24*3600)).' '.trim($labelArr[2]);
1677 } else {
1678 $seconds = round ($seconds/(365*24*3600)).' '.trim($labelArr[3]);
1679 }
1680 return $prefix.$seconds;
1681 }
1682
1683 /**
1684 * Returns a formatted timestamp if $tstamp is set.
1685 * The date/datetime will be followed by the age in parenthesis.
1686 * Usage: 3
1687 *
1688 * @param integer Time stamp, seconds
1689 * @param integer 1/-1 depending on polarity of age.
1690 * @param string $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm"
1691 * @return string
1692 */
1693 public static function dateTimeAge($tstamp, $prefix = 1, $date = '') {
1694 return $tstamp ?
1695 ($date=='date' ? t3lib_BEfunc::date($tstamp) : t3lib_BEfunc::datetime($tstamp)) .
1696 ' (' . t3lib_BEfunc::calcAge($prefix * ($GLOBALS['EXEC_TIME'] - $tstamp), $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears')) . ')'
1697 : '';
1698 }
1699
1700 /**
1701 * Returns either title = '' or alt = '' attribute. This depends on the client browser and whether it supports title = '' or not (which is the default)
1702 * If no $content is given only the attribute name is returned.
1703 * The returned attribute with content will have a leading space char.
1704 * Warning: Be careful to submit empty $content var - that will return just the attribute name!
1705 * Usage: 0
1706 *
1707 * @param string String to set as title-attribute. If no $content is given only the attribute name is returned.
1708 * @param boolean If $hsc is set, then content of the attribute is htmlspecialchar()'ed (which is good for XHTML and other reasons...)
1709 * @return string
1710 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.5 - The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead!
1711 */
1712 public static function titleAttrib($content = '', $hsc = 0) {
1713 t3lib_div::logDeprecatedFunction();
1714
1715 global $CLIENT;
1716 $attrib= ($CLIENT['BROWSER']=='net'&&$CLIENT['VERSION']<5)||$CLIENT['BROWSER']=='konqu' ? 'alt' : 'title';
1717 return strcmp($content, '')?' '.$attrib.'="'.($hsc?htmlspecialchars($content):$content).'"' : $attrib;
1718 }
1719
1720 /**
1721 * Returns alt="" and title="" attributes with the value of $content.
1722 * Usage: 7
1723 *
1724 * @param string Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
1725 * @return string
1726 */
1727 public static function titleAltAttrib($content) {
1728 $out = '';
1729 $out.=' alt="'.htmlspecialchars($content).'"';
1730 $out.=' title="'.htmlspecialchars($content).'"';
1731 return $out;
1732 }
1733
1734 /**
1735 * 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
1736 * All $TYPO3_CONF_VARS['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
1737 * Thumbsnails are linked to the show_item.php script which will display further details.
1738 * Usage: 7
1739 *
1740 * @param array $row is the database row from the table, $table.
1741 * @param string Table name for $row (present in TCA)
1742 * @param string $field is pointing to the field with the list of image files
1743 * @param string Back path prefix for image tag src="" field
1744 * @param string Optional: $thumbScript os by default 'thumbs.php' if you don't set it otherwise
1745 * @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!)
1746 * @param boolean If set, uploaddir is NOT prepended with "../"
1747 * @param string Optional: $tparams is additional attributes for the image tags
1748 * @param integer Optional: $size is [w]x[h] of the thumbnail. 56 is default.
1749 * @return string Thumbnail image tag.
1750 */
1751 public static function thumbCode($row, $table, $field, $backPath, $thumbScript = '', $uploaddir = NULL, $abs = 0, $tparams = '', $size = '') {
1752 global $TCA;
1753 // Load table.
1754 t3lib_div::loadTCA($table);
1755
1756 // Find uploaddir automatically
1757 $uploaddir = (is_null($uploaddir)) ? $TCA[$table]['columns'][$field]['config']['uploadfolder'] : $uploaddir;
1758 $uploaddir = preg_replace('#/$#','', $uploaddir);
1759
1760 // Set thumbs-script:
1761 if (!$GLOBALS['TYPO3_CONF_VARS']['GFX']['thumbnails']) {
1762 $thumbScript = 'gfx/notfound_thumb.gif';
1763 } elseif(!$thumbScript) {
1764 $thumbScript = 'thumbs.php';
1765 }
1766 // Check and parse the size parameter
1767 $sizeParts = array();
1768 if ($size = trim($size)) {
1769 $sizeParts = explode('x', $size.'x'.$size);
1770 if(!intval($sizeParts[0])) $size = '';
1771 }
1772
1773 // Traverse files:
1774 $thumbs = explode(',', $row[$field]);
1775 $thumbData = '';
1776 while(list(,$theFile) = each($thumbs)) {
1777 if (trim($theFile)) {
1778 $fI = t3lib_div::split_fileref($theFile);
1779 $ext = $fI['fileext'];
1780 // New 190201 start
1781 $max = 0;
1782 if (t3lib_div::inList('gif,jpg,png', $ext)) {
1783 $imgInfo = @getimagesize(PATH_site.$uploaddir.'/'.$theFile);
1784 if (is_array($imgInfo)) {$max = max($imgInfo[0], $imgInfo[1]);}
1785 }
1786 // use the original image if it's size fits to the thumbnail size
1787 if ($max && $max<=(count($sizeParts)&&max($sizeParts)?max($sizeParts):56)) {
1788 $theFile = $url = ($abs?'':'../').($uploaddir?$uploaddir.'/':'').trim($theFile);
1789 $onClick = 'top.launchView(\''.$theFile.'\',\'\',\''.$backPath.'\');return false;';
1790 $thumbData.= '<a href="#" onclick="'.htmlspecialchars($onClick).'"><img src="'.$backPath.$url.'" '.$imgInfo[3].' hspace="2" border="0" title="'.trim($url).'"'.$tparams.' alt="" /></a> ';
1791 // New 190201 stop
1792 } elseif ($ext=='ttf' || t3lib_div::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $ext)) {
1793 $theFile_abs = PATH_site.($uploaddir?$uploaddir.'/':'').trim($theFile);
1794 $theFile = ($abs?'':'../').($uploaddir?$uploaddir.'/':'').trim($theFile);
1795
1796 if (!is_readable($theFile_abs)) {
1797 $flashMessage = t3lib_div::makeInstance(
1798 't3lib_FlashMessage',
1799 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:warning.file_missing_text') . ' <abbr title="' . $theFile_abs . '">' . $theFile . '</abbr>',
1800 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:warning.file_missing'),
1801 t3lib_FlashMessage::ERROR
1802 );
1803 $thumbData .= $flashMessage->render();
1804 continue;
1805 }
1806
1807 $check = basename($theFile_abs).':'.filemtime($theFile_abs).':'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
1808 $params = '&file='.rawurlencode($theFile);
1809 $params.= $size?'&size='.$size:'';
1810 $params.= '&md5sum='.t3lib_div::shortMD5($check);
1811
1812 $url = $thumbScript.'?&dummy='.$GLOBALS['EXEC_TIME'].$params;
1813 $onClick = 'top.launchView(\''.$theFile.'\',\'\',\''.$backPath.'\');return false;';
1814 $thumbData.= '<a href="#" onclick="'.htmlspecialchars($onClick).'"><img src="'.htmlspecialchars($backPath.$url).'" hspace="2" border="0" title="'.trim($theFile).'"'.$tparams.' alt="" /></a> ';
1815 } else {
1816 $icon = t3lib_BEfunc::getFileIcon($ext);
1817 $url = 'gfx/fileicons/'.$icon;
1818 $thumbData.= '<img src="'.$backPath.$url.'" hspace="2" border="0" title="'.trim($theFile).'"'.$tparams.' alt="" /> ';
1819 }
1820 }
1821 }
1822 return $thumbData;
1823 }
1824
1825 /**
1826 * Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
1827 * Usage: 3
1828 *
1829 * @param string $thumbScript must point to "thumbs.php" relative to the script position
1830 * @param string $theFile must be the proper reference to the file thumbs.php should show
1831 * @param string $tparams are additional attributes for the image tag
1832 * @param integer $size is the size of the thumbnail send along to "thumbs.php"
1833 * @return string Image tag
1834 */
1835 public static function getThumbNail($thumbScript, $theFile, $tparams = '', $size = '') {
1836 $check = basename($theFile).':'.filemtime($theFile).':'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
1837 $params = '&file='.rawurlencode($theFile);
1838 $params.= trim($size)?'&size='.trim($size):'';
1839 $params.= '&md5sum='.t3lib_div::shortMD5($check);
1840
1841 $url = $thumbScript.'?&dummy='.$GLOBALS['EXEC_TIME'].$params;
1842 $th = '<img src="'.htmlspecialchars($url).'" title="'.trim(basename($theFile)).'"'.($tparams?" ".$tparams:"").' alt="" />';
1843 return $th;
1844 }
1845
1846 /**
1847 * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
1848 * Usage: 8
1849 *
1850 * @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)
1851 * @param string $perms_clause is used to get the record path of the shortcut page, if any (and doktype==4)
1852 * @param boolean If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already
1853 * @return string
1854 */
1855 public static function titleAttribForPages($row, $perms_clause = '', $includeAttrib = 1) {
1856 global $TCA, $LANG;
1857 $parts = array();
1858 $parts[] = 'id='.$row['uid'];
1859 if ($row['alias']) $parts[] = $LANG->sL($TCA['pages']['columns']['alias']['label']).' '.$row['alias'];
1860 if ($row['pid']<0) $parts[] = 'v#1.'.$row['t3ver_id'];
1861
1862 switch($row['t3ver_state']) {
1863 case 1:
1864 $parts[] = 'PLH WSID#'.$row['t3ver_wsid'];
1865 break;
1866 case 2:
1867 $parts[] = 'Deleted element!';
1868 break;
1869 case 3:
1870 $parts[] = 'NEW LOCATION (PLH) WSID#'.$row['t3ver_wsid'];
1871 break;
1872 case 4:
1873 $parts[] = 'OLD LOCATION (PNT) WSID#'.$row['t3ver_wsid'];
1874 break;
1875 case -1:
1876 $parts[] = 'New element!';
1877 break;
1878 }
1879
1880 if ($row['doktype']=='3') {
1881 $parts[] = $LANG->sL($TCA['pages']['columns']['url']['label']).' '.$row['url'];
1882 } elseif ($row['doktype']=='4') {
1883 if ($perms_clause) {
1884 $label = t3lib_BEfunc::getRecordPath(intval($row['shortcut']), $perms_clause, 20);
1885 } else {
1886 $lRec = t3lib_BEfunc::getRecordWSOL('pages', intval($row['shortcut']), 'title');
1887 $label = $lRec['title'];
1888 }
1889 if ($row['shortcut_mode']>0) {
1890 $label.=', '.$LANG->sL($TCA['pages']['columns']['shortcut_mode']['label']).' '.
1891 $LANG->sL(t3lib_BEfunc::getLabelFromItemlist('pages', 'shortcut_mode', $row['shortcut_mode']));
1892 }
1893 $parts[] = $LANG->sL($TCA['pages']['columns']['shortcut']['label']).' '.$label;
1894 } elseif ($row['doktype']=='7') {
1895 if ($perms_clause) {
1896 $label = t3lib_BEfunc::getRecordPath(intval($row['mount_pid']), $perms_clause, 20);
1897 } else {
1898 $lRec = t3lib_BEfunc::getRecordWSOL('pages', intval($row['mount_pid']), 'title');
1899 $label = $lRec['title'];
1900 }
1901 $parts[] = $LANG->sL($TCA['pages']['columns']['mount_pid']['label']).' '.$label;
1902 if ($row['mount_pid_ol']) {
1903 $parts[] = $LANG->sL($TCA['pages']['columns']['mount_pid_ol']['label']);
1904 }
1905 }
1906 if ($row['nav_hide']) $parts[] = rtrim($LANG->sL($TCA['pages']['columns']['nav_hide']['label']), ':');
1907 if ($row['hidden']) $parts[] = $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.hidden');
1908 if ($row['starttime']) $parts[] = $LANG->sL($TCA['pages']['columns']['starttime']['label']).' '.t3lib_BEfunc::dateTimeAge($row['starttime'], -1, 'date');
1909 if ($row['endtime']) $parts[] = $LANG->sL($TCA['pages']['columns']['endtime']['label']).' '.t3lib_BEfunc::dateTimeAge($row['endtime'], -1, 'date');
1910 if ($row['fe_group']) {
1911 $fe_groups = array();
1912 foreach (t3lib_div::intExplode(',', $row['fe_group']) as $fe_group) {
1913 if ($fe_group<0) {
1914 $fe_groups[] = $LANG->sL(t3lib_BEfunc::getLabelFromItemlist('pages', 'fe_group', $fe_group));
1915 } else {
1916 $lRec = t3lib_BEfunc::getRecordWSOL('fe_groups', $fe_group, 'title');
1917 $fe_groups[] = $lRec['title'];
1918 }
1919 }
1920 $label = implode(', ', $fe_groups);
1921 $parts[] = $LANG->sL($TCA['pages']['columns']['fe_group']['label']).' '.$label;
1922 }
1923 $out = htmlspecialchars(implode(' - ', $parts));
1924 return $includeAttrib ? 'title="'.$out.'"' : $out;
1925 }
1926
1927 /**
1928 * Returns title-attribute information for ANY record (from a table defined in TCA of course)
1929 * 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.
1930 * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
1931 * Usage: 10
1932 *
1933 * @param array Table row; $row is a row from the table, $table
1934 * @param string Table name
1935 * @return string
1936 */
1937 public static function getRecordIconAltText($row, $table = 'pages') {
1938 if ($table=='pages') {
1939 $out = t3lib_BEfunc::titleAttribForPages($row, '', 0);
1940 } else {
1941 $ctrl = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns'];
1942
1943 $out = 'id='.$row['uid']; // Uid is added
1944 if ($table=='pages' && $row['alias']) {
1945 $out.=' / '.$row['alias'];
1946 }
1947 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'] && $row['pid']<0) {
1948 $out.=' - v#1.'.$row['t3ver_id'];
1949 }
1950 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
1951 switch($row['t3ver_state']) {
1952 case 1:
1953 $out.= ' - PLH WSID#'.$row['t3ver_wsid'];
1954 break;
1955 case 2:
1956 $out.= ' - Deleted element!';
1957 break;
1958 case 3:
1959 $out.= ' - NEW LOCATION (PLH) WSID#'.$row['t3ver_wsid'];
1960 break;
1961 case 4:
1962 $out.= ' - OLD LOCATION (PNT) WSID#'.$row['t3ver_wsid'];
1963 break;
1964 case -1:
1965 $out.= ' - New element!';
1966 break;
1967 }
1968 }
1969
1970 if ($ctrl['disabled']) { // Hidden ...
1971 $out.=($row[$ctrl['disabled']]?' - '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.hidden'):'');
1972 }
1973 if ($ctrl['starttime']) {
1974 if ($row[$ctrl['starttime']] > $GLOBALS['EXEC_TIME']) {
1975 $out.=' - '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.starttime').':'.t3lib_BEfunc::date($row[$ctrl['starttime']]).' ('.t3lib_BEfunc::daysUntil($row[$ctrl['starttime']]).' '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.days').')';
1976 }
1977 }
1978 if ($row[$ctrl['endtime']]) {
1979 $out.=' - '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.endtime').': '.t3lib_BEfunc::date($row[$ctrl['endtime']]).' ('.t3lib_BEfunc::daysUntil($row[$ctrl['endtime']]).' '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.days').')';
1980 }
1981 }
1982 return htmlspecialchars($out);
1983 }
1984
1985 /**
1986 * Returns the label of the first found entry in an "items" array from $TCA (tablename = $table/fieldname = $col) where the value is $key
1987 * Usage: 9
1988 *
1989 * @param string Table name, present in $TCA
1990 * @param string Field name, present in $TCA
1991 * @param string items-array value to match
1992 * @return string Label for item entry
1993 */
1994 public static function getLabelFromItemlist($table, $col, $key) {
1995 global $TCA;
1996 // Load full TCA for $table
1997 t3lib_div::loadTCA($table);
1998
1999 // Check, if there is an "items" array:
2000 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$col]) && is_array($TCA[$table]['columns'][$col]['config']['items'])) {
2001 // Traverse the items-array...
2002 reset($TCA[$table]['columns'][$col]['config']['items']);
2003 while(list($k, $v) = each($TCA[$table]['columns'][$col]['config']['items'])) {
2004 // ... and return the first found label where the value was equal to $key
2005 if (!strcmp($v[1], $key)) return $v[0];
2006 }
2007 }
2008 }
2009
2010 /**
2011 * Returns the label-value for fieldname $col in table, $table
2012 * 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 = '<b>|</b>' and the fieldname was 'not_found_field' then the return value would be '<b>not_found_field</b>'
2013 * Usage: 17
2014 *
2015 * @param string Table name, present in $TCA
2016 * @param string Field name
2017 * @param string Wrap value - set function description
2018 * @return string
2019 */
2020 public static function getItemLabel($table, $col, $printAllWrap = '') {
2021 global $TCA;
2022 // Load full TCA for $table
2023 t3lib_div::loadTCA($table);
2024 // Check if column exists
2025 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$col])) {
2026 // Re
2027 return $TCA[$table]['columns'][$col]['label'];
2028 }
2029 if ($printAllWrap) {
2030 $parts = explode('|', $printAllWrap);
2031 return $parts[0].$col.$parts[1];
2032 }
2033 }
2034
2035 /**
2036 * Returns the "title"-value in record, $row, from table, $table
2037 * The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
2038 * Usage: 26
2039 *
2040 * @param string Table name, present in TCA
2041 * @param array Row from table
2042 * @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
2043 * @param boolean If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
2044 * @return string
2045 */
2046 public static function getRecordTitle($table, $row, $prep = FALSE, $forceResult = TRUE) {
2047 global $TCA;
2048 if (is_array($TCA[$table])) {
2049
2050 // If configured, call userFunc
2051 if ($TCA[$table]['ctrl']['label_userFunc']) {
2052 $params['table'] = $table;
2053 $params['row'] = $row;
2054 $params['title'] = '';
2055
2056 t3lib_div::callUserFunction($TCA[$table]['ctrl']['label_userFunc'], $params, $this);
2057 $t = $params['title'];
2058 } else {
2059
2060 // No userFunc: Build label
2061 $t = t3lib_BEfunc::getProcessedValue($table, $TCA[$table]['ctrl']['label'], $row[$TCA[$table]['ctrl']['label']], 0, 0, false, $row['uid'], $forceResult);
2062 if ($TCA[$table]['ctrl']['label_alt'] && ($TCA[$table]['ctrl']['label_alt_force'] || !strcmp($t, ''))) {
2063 $altFields = t3lib_div::trimExplode(',', $TCA[$table]['ctrl']['label_alt'], 1);
2064 $tA = array();
2065 if (!empty($t)) $tA[] = $t;
2066 foreach ($altFields as $fN) {
2067 $t = trim(strip_tags($row[$fN]));
2068 if (strcmp($t, '')) {
2069 $t = t3lib_BEfunc::getProcessedValue($table, $fN, $t, 0, 0, false, $row['uid']);
2070 if (!$TCA[$table]['ctrl']['label_alt_force']) {
2071 break;
2072 }
2073 $tA[] = $t;
2074 }
2075 }
2076 if ($TCA[$table]['ctrl']['label_alt_force']) {
2077 $t = implode(', ', $tA);
2078 }
2079 }
2080 }
2081
2082 // If the current result is empty, set it to '[No title]' (localized) and prepare for output if requested
2083 if ($prep || $forceResult) {
2084 if ($prep) {
2085 $t = t3lib_BEfunc::getRecordTitlePrep($t);
2086 }
2087 if (!strcmp(trim($t), '')) {
2088 $t = t3lib_BEfunc::getNoRecordTitle($prep);
2089 }
2090 }
2091
2092 return $t;
2093 }
2094 }
2095
2096 /**
2097 * Crops a title string to a limited lenght and if it really was cropped, wrap it in a <span title="...">|</span>,
2098 * which offers a tooltip with the original title when moving mouse over it.
2099 *
2100 * @param string $title: The title string to be cropped
2101 * @param integer $titleLength: Crop title after this length - if not set, BE_USER->uc['titleLen'] is used
2102 * @return string The processed title string, wrapped in <span title="...">|</span> if cropped
2103 */
2104 public static function getRecordTitlePrep($title, $titleLength = 0) {
2105 // If $titleLength is not a valid positive integer, use BE_USER->uc['titleLen']:
2106 if (!$titleLength || !t3lib_div::testInt($titleLength) || $titleLength < 0) {
2107 $titleLength = $GLOBALS['BE_USER']->uc['titleLen'];
2108 }
2109 $titleOrig = htmlspecialchars($title);
2110 $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($title, $titleLength));
2111 // If title was cropped, offer a tooltip:
2112 if ($titleOrig != $title) {
2113 $title = '<span title="'.$titleOrig.'">'.$title.'</span>';
2114 }
2115 return $title;
2116 }
2117
2118 /**
2119 * Get a localized [No title] string, wrapped in <em>|</em> if $prep is true.
2120 *
2121 * @param boolean $prep: Wrap result in <em>|</em>
2122 * @return string Localized [No title] string
2123 */
2124 public static function getNoRecordTitle($prep = FALSE) {
2125 $noTitle = '['.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title', 1).']';
2126 if ($prep) $noTitle = '<em>'.$noTitle.'</em>';
2127 return $noTitle;
2128 }
2129
2130 /**
2131 * Returns a human readable output of a value from a record
2132 * 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.
2133 * $table/$col is tablename and fieldname
2134 * REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
2135 * Usage: 24
2136 *
2137 * @param string Table name, present in TCA
2138 * @param string Field name, present in TCA
2139 * @param string $value is the value of that field from a selected record
2140 * @param integer $fixed_lgd_chars is the max amount of characters the value may occupy
2141 * @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")
2142 * @param boolean If set, no records will be looked up, UIDs are just shown.
2143 * @param integer uid of the current record
2144 * @param boolean If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
2145 * @return string
2146 */
2147 public static function getProcessedValue($table, $col, $value, $fixed_lgd_chars = 0, $defaultPassthrough = 0, $noRecordLookup = FALSE, $uid = 0, $forceResult = TRUE) {
2148 global $TCA;
2149 global $TYPO3_CONF_VARS;
2150
2151 if ($col == 'uid') {
2152 // no need to load TCA as uid is not in TCA-array
2153 return $value;
2154 }
2155 // Load full TCA for $table
2156 t3lib_div::loadTCA($table);
2157 // Check if table and field is configured:
2158 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$col])) {
2159 // Depending on the fields configuration, make a meaningful output value.
2160 $theColConf = $TCA[$table]['columns'][$col]['config'];
2161
2162 /*****************
2163 *HOOK: pre-processing the human readable output from a record
2164 ****************/
2165 if (is_array ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'])) {
2166 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'] as $_funcRef) {
2167 t3lib_div::callUserFunction($_funcRef,$theColConf,$this);
2168 }
2169 }
2170
2171 $l = '';
2172 switch((string)$theColConf['type']) {
2173 case 'radio':
2174 $l = t3lib_BEfunc::getLabelFromItemlist($table,$col,$value);
2175 $l = $GLOBALS['LANG']->sL($l);
2176 break;
2177 case 'select':
2178 if ($theColConf['MM']) {
2179 // Display the title of MM related records in lists
2180 if ($noRecordLookup) {
2181 $MMfield = $theColConf['foreign_table'].'.uid';
2182 } else {
2183 $MMfields = array($theColConf['foreign_table'].'.'.$TCA[$theColConf['foreign_table']]['ctrl']['label']);
2184 foreach (t3lib_div::trimExplode(',', $TCA[$theColConf['foreign_table']]['ctrl']['label_alt'], 1) as $f) {
2185 $MMfields[] = $theColConf['foreign_table'].'.'.$f;
2186 }
2187 $MMfield = join(',',$MMfields);
2188 }
2189
2190 $dbGroup = t3lib_div::makeInstance('t3lib_loadDBGroup');
2191 $dbGroup->start($value, $theColConf['foreign_table'], $theColConf['MM'], $uid, $table, $theColConf);
2192 $selectUids = $dbGroup->tableArray[$theColConf['foreign_table']];
2193
2194 if (is_array($selectUids) && count($selectUids)>0) {
2195 $MMres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
2196 'uid, '.$MMfield,
2197 $theColConf['foreign_table'],
2198 'uid IN ('.implode(',', $selectUids).')'
2199 );
2200 while($MMrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($MMres)) {
2201 $mmlA[] = ($noRecordLookup?$MMrow['uid']:t3lib_BEfunc::getRecordTitle($theColConf['foreign_table'], $MMrow, FALSE, $forceResult));
2202 }
2203 $GLOBALS['TYPO3_DB']->sql_free_result($MMres);
2204
2205 if (is_array($mmlA)) {
2206 $l = implode('; ', $mmlA);
2207 } else {
2208 $l = '';
2209 }
2210 } else {
2211 $l = 'N/A';
2212 }
2213 } else {
2214 $l = t3lib_BEfunc::getLabelFromItemlist($table, $col, $value);
2215 $l = $GLOBALS['LANG']->sL($l);
2216 if ($theColConf['foreign_table'] && !$l && $TCA[$theColConf['foreign_table']]) {
2217 if ($noRecordLookup) {
2218 $l = $value;
2219 } else {
2220 $rParts = t3lib_div::trimExplode(',', $value, 1);
2221 reset($rParts);
2222 $lA = array();
2223 while(list(,$rVal) = each($rParts)) {
2224 $rVal = intval($rVal);
2225 if ($rVal>0) {
2226 $r = t3lib_BEfunc::getRecordWSOL($theColConf['foreign_table'], $rVal);
2227 } else {
2228 $r = t3lib_BEfunc::getRecordWSOL($theColConf['neg_foreign_table'], -$rVal);
2229 }
2230 if (is_array($r)) {
2231 $lA[] = $GLOBALS['LANG']->sL($rVal>0?$theColConf['foreign_table_prefix']:$theColConf['neg_foreign_table_prefix']).t3lib_BEfunc::getRecordTitle($rVal>0?$theColConf['foreign_table']:$theColConf['neg_foreign_table'], $r, FALSE, $forceResult);
2232 } else {
2233 $lA[] = $rVal?'['.$rVal.'!]':'';
2234 }
2235 }
2236 $l = implode(', ', $lA);
2237 }
2238 }
2239 }
2240 break;
2241 case 'group':
2242 $l = implode(', ', t3lib_div::trimExplode(',', $value, 1));
2243 break;
2244 case 'check':
2245 if (!is_array($theColConf['items']) || count($theColConf['items'])==1) {
2246 $l = $value ? $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xml:yes') : $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xml:no');
2247 } else {
2248 reset($theColConf['items']);
2249 $lA = Array();
2250 while(list($key, $val) = each($theColConf['items'])) {
2251 if ($value & pow(2, $key)) {$lA[] = $GLOBALS['LANG']->sL($val[0]);}
2252 }
2253 $l = implode(', ', $lA);
2254 }
2255 break;
2256 case 'input':
2257 if (isset($value)) {
2258 if (t3lib_div::inList($theColConf['eval'], 'date')) {
2259 $l = t3lib_BEfunc::date($value) .
2260 ' (' .
2261 ($GLOBALS['EXEC_TIME'] - $value > 0 ? '-' : '') .
2262 t3lib_BEfunc::calcAge(abs($GLOBALS['EXEC_TIME'] - $value), $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears')) .
2263 ')';
2264 } elseif (t3lib_div::inList($theColConf['eval'], 'time')) {
2265 $l = t3lib_BEfunc::time($value, FALSE);
2266 } elseif (t3lib_div::inList($theColConf['eval'], 'timesec')) {
2267 $l = t3lib_BEfunc::time($value);
2268 } elseif (t3lib_div::inList($theColConf['eval'], 'datetime')) {
2269 $l = t3lib_BEfunc::datetime($value);
2270 } else {
2271 $l = $value;
2272 }
2273 }
2274 break;
2275 case 'flex':
2276 $l = strip_tags($value);
2277 break;
2278 default:
2279 if ($defaultPassthrough) {
2280 $l = $value;
2281 } elseif ($theColConf['MM']) {
2282 $l = 'N/A';
2283 } elseif ($value) {
2284 $l = t3lib_div::fixed_lgd_cs(strip_tags($value), 200);
2285 }
2286 break;
2287 }
2288
2289 // If this field is a password field, then hide the password by changing it to a random number of asterisk (*)
2290 if (stristr($theColConf['eval'], 'password')) {
2291 unset($l);
2292 $randomNumber = rand(5, 12);
2293 for ($i=0; $i < $randomNumber; $i++) {
2294 $l .= '*';
2295 }
2296 }
2297
2298 /*****************
2299 *HOOK: post-processing the human readable output from a record
2300 ****************/
2301 if (is_array ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'])) {
2302 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'] as $_funcRef) {
2303 $params = array(
2304 'value' => $l,
2305 'colConf' => $theColConf
2306 );
2307 $l = t3lib_div::callUserFunction($_funcRef, $params, $this);
2308 }
2309 }
2310
2311 if ($fixed_lgd_chars) {
2312 return t3lib_div::fixed_lgd_cs($l, $fixed_lgd_chars);
2313 } else {
2314 return $l;
2315 }
2316 }
2317 }
2318
2319 /**
2320 * 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.
2321 * Usage: 2
2322 *
2323 * @param string Table name, present in TCA
2324 * @param string Field name
2325 * @param string Field value
2326 * @param integer $fixed_lgd_chars is the max amount of characters the value may occupy
2327 * @param integer uid of the current record
2328 * @param boolean If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
2329 * @return string
2330 * @see getProcessedValue()
2331 */
2332 public static function getProcessedValueExtra($table, $fN, $fV, $fixed_lgd_chars = 0, $uid = 0, $forceResult = TRUE) {
2333 global $TCA;
2334 $fVnew = t3lib_BEfunc::getProcessedValue($table, $fN, $fV, $fixed_lgd_chars, 0, 0, $uid, $forceResult);
2335 if (!isset($fVnew)) {
2336 if (is_array($TCA[$table])) {
2337 if ($fN==$TCA[$table]['ctrl']['tstamp'] || $fN==$TCA[$table]['ctrl']['crdate']) {
2338 $fVnew = t3lib_BEfunc::datetime($fV);
2339 } elseif ($fN=='pid'){
2340 $fVnew = t3lib_BEfunc::getRecordPath($fV, '1=1', 20); // Fetches the path with no regard to the users permissions to select pages.
2341 } else {
2342 $fVnew = $fV;
2343 }
2344 }
2345 }
2346 return $fVnew;
2347 }
2348
2349 /**
2350 * Returns file icon name (from $FILEICONS) for the fileextension $ext
2351 * Usage: 10
2352 *
2353 * @param string File extension, lowercase
2354 * @return string File icon filename
2355 */
2356 public static function getFileIcon($ext) {
2357 return $GLOBALS['FILEICONS'][$ext] ? $GLOBALS['FILEICONS'][$ext] : $GLOBALS['FILEICONS']['default'];
2358 }
2359
2360 /**
2361 * Returns fields for a table, $table, which would typically be interesting to select
2362 * This includes uid, the fields defined for title, icon-field.
2363 * 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)
2364 * Usage: 3
2365 *
2366 * @param string Table name, present in TCA
2367 * @param string Table prefix
2368 * @param array Preset fields (must include prefix if that is used)
2369 * @return string List of fields.
2370 */
2371 public static function getCommonSelectFields($table, $prefix = '', $fields = array()) {
2372 global $TCA;
2373 $fields[] = $prefix.'uid';
2374 $fields[] = $prefix.$TCA[$table]['ctrl']['label'];
2375
2376 if ($TCA[$table]['ctrl']['label_alt']) {
2377 $secondFields = t3lib_div::trimExplode(',', $TCA[$table]['ctrl']['label_alt'], 1);
2378 foreach($secondFields as $fieldN) {
2379 $fields[] = $prefix.$fieldN;
2380 }
2381 }
2382 if ($TCA[$table]['ctrl']['versioningWS']) {
2383 $fields[] = $prefix.'t3ver_id';
2384 $fields[] = $prefix.'t3ver_state';
2385 $fields[] = $prefix.'t3ver_wsid';
2386 $fields[] = $prefix.'t3ver_count';
2387 }
2388
2389 if ($TCA[$table]['ctrl']['selicon_field']) $fields[] = $prefix.$TCA[$table]['ctrl']['selicon_field'];
2390 if ($TCA[$table]['ctrl']['typeicon_column']) $fields[] = $prefix.$TCA[$table]['ctrl']['typeicon_column'];
2391
2392 if (is_array($TCA[$table]['ctrl']['enablecolumns'])) {
2393 if ($TCA[$table]['ctrl']['enablecolumns']['disabled']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['disabled'];
2394 if ($TCA[$table]['ctrl']['enablecolumns']['starttime']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['starttime'];
2395 if ($TCA[$table]['ctrl']['enablecolumns']['endtime']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['endtime'];
2396 if ($TCA[$table]['ctrl']['enablecolumns']['fe_group']) $fields[] = $prefix.$TCA[$table]['ctrl']['enablecolumns']['fe_group'];
2397 }
2398
2399 return implode(',', array_unique($fields));
2400 }
2401
2402 /**
2403 * 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
2404 * <form>-tags must be supplied separately
2405 * 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.
2406 * Usage: 1 (ext. direct_mail)
2407 *
2408 * @param array Field configuration code.
2409 * @param array Defaults
2410 * @param string Prefix for formfields
2411 * @return string HTML for a form.
2412 */
2413 public static function makeConfigForm($configArray, $defaults, $dataPrefix) {
2414 $params = $defaults;
2415 if (is_array($configArray)) {
2416 reset($configArray);
2417 $lines = array();
2418 while(list($fname, $config) = each($configArray)) {
2419 if (is_array($config)) {
2420 $lines[$fname] = '<strong>'.htmlspecialchars($config[1]).'</strong><br />';
2421 $lines[$fname].=$config[2].'<br />';
2422 switch($config[0]) {
2423 case 'string':
2424 case 'short':
2425 $formEl = '<input type="text" name="'.$dataPrefix.'['.$fname.']" value="'.$params[$fname].'"'.$GLOBALS['TBE_TEMPLATE']->formWidth($config[0]=='short'?24:48).' />';
2426 break;
2427 case 'check':
2428 $formEl = '<input type="hidden" name="'.$dataPrefix.'['.$fname.']" value="0" /><input type="checkbox" name="'.$dataPrefix.'['.$fname.']" value="1"'.($params[$fname]?' checked="checked"':'').' />';
2429 break;
2430 case 'comment':
2431 $formEl = '';
2432 break;
2433 case 'select':
2434 reset($config[3]);
2435 $opt = array();
2436 while(list($k, $v) = each($config[3])) {
2437 $opt[] = '<option value="'.htmlspecialchars($k).'"'.($params[$fname]==$k?' selected="selected"':'').'>'.htmlspecialchars($v).'</option>';
2438 }
2439 $formEl = '<select name="'.$dataPrefix.'['.$fname.']">'.implode('', $opt).'</select>';
2440 break;
2441 default:
2442 debug($config);
2443 break;
2444 }
2445 $lines[$fname].=$formEl;
2446 $lines[$fname].='<br /><br />';
2447 } else {
2448 $lines[$fname] = '<hr />';
2449 if ($config) $lines[$fname].='<strong>'.strtoupper(htmlspecialchars($config)).'</strong><br />';
2450 if ($config) $lines[$fname].='<br />';
2451 }
2452 }
2453 }
2454 $out = implode('', $lines);
2455 $out.='<input type="submit" name="submit" value="Update configuration" />';
2456 return $out;
2457 }
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471 /*******************************************
2472 *
2473 * Backend Modules API functions
2474 *
2475 *******************************************/
2476
2477 /**
2478 * Returns help-text icon if configured for.
2479 * TCA_DESCR must be loaded prior to this function and $BE_USER must have 'edit_showFieldHelp' set to 'icon', otherwise nothing is returned
2480 * Usage: 6
2481 *
2482 * @param string Table name
2483 * @param string Field name
2484 * @param string Back path
2485 * @param boolean Force display of icon nomatter BE_USER setting for help
2486 * @return string HTML content for a help icon/text
2487 */
2488 public static function helpTextIcon($table, $field, $BACK_PATH, $force = 0) {
2489 global $TCA_DESCR, $BE_USER;
2490
2491 $onClick = 'vHWin=window.open(\''.$BACK_PATH.'view_help.php?tfID='.($table.'.'.$field).'\',\'viewFieldHelp\',\'height=400,width=600,status=0,menubar=0,scrollbars=1\');vHWin.focus();return false;';
2492 if (is_array($TCA_DESCR[$table]) && is_array($TCA_DESCR[$table]['columns'][$field]) && (isset($BE_USER->uc['edit_showFieldHelp']) || $force)) {
2493 if ($BE_USER->uc['edit_showFieldHelp'] == 'icon') {
2494 $text = t3lib_BEfunc::helpText($table, $field, $BACK_PATH, '');
2495 $text = '<span class="typo3-csh-inline">'.$GLOBALS['LANG']->hscAndCharConv($text, false).'</span>';
2496 }
2497 return '<a class="typo3-csh-link" href="#" onclick="'.htmlspecialchars($onClick).'"><img'.t3lib_iconWorks::skinImg($BACK_PATH, 'gfx/helpbubble.gif', 'width="14" height="14"').' hspace="2" border="0" class="typo3-csh-icon" alt="" />'.$text.'</a>';
2498 }
2499 }
2500
2501
2502 /**
2503 * Returns CSH help text (description), if configured for.
2504 * TCA_DESCR must be loaded prior to this function and $BE_USER must have "edit_showFieldHelp" set to "text",
2505 * otherwise nothing is returned
2506 * Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text.
2507 * Usage: 4
2508 *
2509 * @param string Table name
2510 * @param string Field name
2511 * @param string Back path
2512 * @param string DEPRECATED: Additional style-attribute content for wrapping table (now: only in function cshItem needed)
2513 * @return string HTML content for help text
2514 */
2515 public static function helpText($table, $field, $BACK_PATH, $styleAttrib = '') {
2516 global $TCA_DESCR, $BE_USER;
2517 $output = '';
2518
2519 if (is_array($TCA_DESCR[$table]) && is_array($TCA_DESCR[$table]['columns'][$field])) {
2520 $data = $TCA_DESCR[$table]['columns'][$field];
2521 // add see also arrow
2522 if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
2523 $arrow = '<img'.t3lib_iconWorks::skinImg($BACK_PATH, 'gfx/rel_db.gif', 'width="13" height="12"').' class="absmiddle" alt="" />';
2524 }
2525 // add description text
2526 if ($data['description'] || $arrow) {
2527 $output = '<span class="paragraph">'.nl2br(htmlspecialchars($data['description'])).$arrow.'</span>';
2528 }
2529
2530 // put header before the rest of the text
2531 if ($data['alttitle']) {
2532 $output = '<span class="header">'.$data['alttitle'].'</span><br />'.$output;
2533 }
2534 }
2535 return $output;
2536 }
2537
2538
2539 /**
2540 * API for getting CSH icons/text for use in backend modules.
2541 * TCA_DESCR will be loaded if it isn't already
2542 * Usage: ?
2543 *
2544 * @param string Table name ('_MOD_'+module name)
2545 * @param string Field name (CSH locallang main key)
2546 * @param string Back path
2547 * @param string Wrap code for icon-mode, splitted by "|". Not used for full-text mode.
2548 * @param boolean If set, the full text will never be shown (only icon).
2549 * Useful for places where it will break the page if the table with full text is shown.
2550 * @param string Additional style-attribute content for wrapping table (full text mode only)
2551 * @return string HTML content for help text
2552 * @see helpText(), helpTextIcon()
2553 */
2554 public static function cshItem($table, $field, $BACK_PATH, $wrap = '', $onlyIconMode = FALSE, $styleAttrib = '') {
2555 global $TCA_DESCR, $LANG, $BE_USER;
2556
2557 if ($BE_USER->uc['edit_showFieldHelp']) {
2558 $LANG->loadSingleTableDescription($table);
2559
2560 if (is_array($TCA_DESCR[$table])) {
2561 // Creating CSH icon and short description:
2562 $fullText = t3lib_BEfunc::helpText($table, $field, $BACK_PATH, '');
2563 $icon = t3lib_BEfunc::helpTextIcon($table, $field, $BACK_PATH);
2564
2565 if ($fullText && !$onlyIconMode && $BE_USER->uc['edit_showFieldHelp'] == 'text') {
2566
2567 // Additional styles?
2568 $params = $styleAttrib ? ' style="'.$styleAttrib.'"' : '';
2569
2570 // Compile table with CSH information:
2571 $fullText = '<table border="0" cellpadding="0" cellspacing="0" class="typo3-csh-inline"'.$params.'>
2572 <tr>
2573 <td valign="top" width="14">'.$icon.'</td>
2574 <td valign="top">'.$fullText.'</td>
2575 </tr>
2576 </table>';
2577
2578 $output = $LANG->hscAndCharConv($fullText, false);
2579 } else {
2580 $output = $icon;
2581
2582 if ($output && $wrap) {
2583 $wrParts = explode('|', $wrap);
2584 $output = $wrParts[0].$output.$wrParts[1];
2585 }
2586 }
2587
2588 return $output;
2589 }
2590 }
2591 }
2592
2593 /**
2594 * 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.
2595 * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
2596 * Usage: 35
2597 *
2598 * @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.
2599 * @param string $backPath must point back to the TYPO3_mainDir directory (where alt_doc.php is)
2600 * @param string $requestUri is an optional returnUrl you can set - automatically set to REQUEST_URI.
2601 * @return string
2602 * @see template::issueCommand()
2603 */
2604 public static function editOnClick($params, $backPath = '', $requestUri = '') {
2605 $retUrl = 'returnUrl='.($requestUri==-1?"'+T3_THIS_LOCATION+'":rawurlencode($requestUri?$requestUri:t3lib_div::getIndpEnv('REQUEST_URI')));
2606 return "window.location.href='".$backPath."alt_doc.php?".$retUrl.$params."'; return false;";
2607 }
2608
2609 /**
2610 * Returns a JavaScript string for viewing the page id, $id
2611 * 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.
2612 * Usage: 8
2613 *
2614 * @param integer $id is page id
2615 * @param string $backpath must point back to TYPO3_mainDir (where the site is assumed to be one level above)
2616 * @param array If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
2617 * @param string $anchor is optional anchor to the URL
2618 * @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!
2619 * @param string Additional GET variables.
2620 * @param boolean If true, then the preview window will gain the focus.
2621 * @return string
2622 */
2623 public static function viewOnClick($id, $backPath = '', $rootLine = '', $anchor = '', $altUrl = '', $addGetVars = '', $switchFocus = TRUE) {
2624
2625 $viewScriptPreviewEnabled = '/' . TYPO3_mainDir . 'mod/user/ws/wsol_preview.php?id=';
2626 $viewScriptPreviewDisabled = '/index.php?id=';
2627 if ($altUrl) {
2628 $viewScriptPreviewEnabled = $viewScriptPreviewDisabled = $altUrl;
2629 }
2630
2631 // Look if a fixed preview language should be added:
2632 $viewLanguageOrder = $GLOBALS['BE_USER']->getTSConfigVal('options.view.languageOrder');
2633 if (strlen($viewLanguageOrder)) {
2634 $suffix = '';
2635
2636 // Find allowed languages (if none, all are allowed!)
2637 if (!$GLOBALS['BE_USER']->user['admin'] &&
2638 strlen($GLOBALS['BE_USER']->groupData['allowed_languages'])) {
2639 $allowed_languages = array_flip(explode(',', $GLOBALS['BE_USER']->groupData['allowed_languages']));
2640 }
2641
2642 // Traverse the view order, match first occurence:
2643 $lOrder = t3lib_div::intExplode(',', $viewLanguageOrder);
2644 foreach($lOrder as $langUid) {
2645 if (is_array($allowed_languages) && count($allowed_languages)) {
2646 if (isset($allowed_languages[$langUid])) { // Choose if set.
2647 $suffix = '&L=' . $langUid;
2648 break;
2649 }
2650 } else { // All allowed since no lang. are listed.
2651 $suffix = '&L=' . $langUid;
2652 break;
2653 }
2654 }
2655 // Add it:
2656 $addGetVars .= $suffix;
2657 }
2658
2659 // check if we need to preview a mount point
2660 $sys_page = t3lib_div::makeInstance('t3lib_pageSelect');
2661 $sys_page->init(FALSE);
2662 $mountPointInfo = $sys_page->getMountPointInfo($id);
2663 if ($mountPointInfo && $mountPointInfo['overlay']) {
2664 $id = $mountPointInfo['mount_pid'];
2665 $addGetVars .= '&MP=' . $mountPointInfo['MPvar'];
2666 }
2667
2668 $viewDomain = t3lib_BEfunc::getViewDomain($id, $rootLine);
2669 $urlPreviewEnabled = $viewDomain . $viewScriptPreviewEnabled . $id . $addGetVars . $anchor;
2670 $urlPreviewDisabled = $viewDomain . $viewScriptPreviewDisabled . $id . $addGetVars . $anchor;
2671
2672 return "var previewWin=window.open(top.TYPO3.configuration.inWorkspace !== 0 && top.TYPO3.configuration.workspaceFrontendPreviewEnabled ?'" .
2673 $urlPreviewEnabled . "':'" . $urlPreviewDisabled .
2674 "','newTYPO3frontendWindow');" . ( $switchFocus ? 'previewWin.focus();' : '');
2675 }
2676
2677 /**
2678 * Builds the frontend view domain for a given page ID with a given root
2679 * line.
2680 *
2681 * @param integer $pageId the page ID to use, must be > 0
2682 * @param array $rootLine the root line structure to use
2683 *
2684 * @return string the full domain including the protocol http:// or https://, but without the trailing '/'
2685 *
2686 * @author Michael Klapper <michael.klapper@aoemedia.de>
2687 */
2688 public static function getViewDomain($pageId, $rootLine = null) {
2689 $domain = rtrim(t3lib_div::getIndpEnv('TYPO3_SITE_URL'), '/');
2690
2691 if (!is_array($rootLine)) {
2692 $rootLine = t3lib_BEfunc::BEgetRootLine($pageId);
2693 }
2694
2695 // checks alternate domains
2696 if (count($rootLine) > 0) {
2697 $urlParts = parse_url($domain);
2698 if (t3lib_BEfunc::getDomainStartPage($urlParts['host'], $urlParts['path'])) {
2699 $protocol = t3lib_div::getIndpEnv('TYPO3_SSL') ? 'https://' : 'http://';
2700 $domain = $protocol . t3lib_BEfunc::firstDomainRecord($rootLine);
2701 }
2702 }
2703
2704 return $domain;
2705 }
2706
2707 /**
2708 * Returns the merged User/Page TSconfig for page id, $id.
2709 * Please read details about module programming elsewhere!
2710 * Usage: 15
2711 *
2712 * @param integer Page uid
2713 * @param string $TSref is an object string which determines the path of the TSconfig to return.
2714 * @return array
2715 */
2716 public static function getModTSconfig($id, $TSref) {
2717 $pageTS_modOptions = $GLOBALS['BE_USER']->getTSConfig($TSref, t3lib_BEfunc::getPagesTSconfig($id));
2718 $BE_USER_modOptions = $GLOBALS['BE_USER']->getTSConfig($TSref);
2719 $modTSconfig = t3lib_div::array_merge_recursive_overrule($pageTS_modOptions, $BE_USER_modOptions);
2720 return $modTSconfig;
2721 }
2722
2723 /**
2724 * Returns a selector box "function menu" for a module
2725 * Requires the JS function jumpToUrl() to be available
2726 * See Inside TYPO3 for details about how to use / make Function menus
2727 * Usage: 50
2728 *
2729 * @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=...
2730 * @param string $elementName it the form elements name, probably something like "SET[...]"
2731 * @param string $currentValue is the value to be selected currently.
2732 * @param array $menuItems is an array with the menu items for the selector box
2733 * @param string $script is the script to send the &id to, if empty it's automatically found
2734 * @param string $addParams is additional parameters to pass to the script.
2735 * @return string HTML code for selector box
2736 */
2737 public static function getFuncMenu($mainParams, $elementName, $currentValue, $menuItems, $script = '', $addparams = '') {
2738 if (is_array($menuItems)) {
2739 if (!is_array($mainParams)) {
2740 $mainParams = array('id' => $mainParams);
2741 }
2742 $mainParams = t3lib_div::implodeArrayForUrl('', $mainParams);
2743
2744 if (!$script) {
2745 $script = basename(PATH_thisScript);
2746 $mainParams.= (t3lib_div::_GET('M') ? '&M='.rawurlencode(t3lib_div::_GET('M')) : '');
2747 }
2748
2749 $options = array();
2750 foreach($menuItems as $value => $label) {
2751 $options[] = '<option value="'.htmlspecialchars($value).'"'.(!strcmp($currentValue, $value)?' selected="selected"':'').'>'.
2752 t3lib_div::deHSCentities(htmlspecialchars($label)).
2753 '</option>';
2754 }
2755 if (count($options)) {
2756 $onChange = 'jumpToUrl(\''.$script.'?'.$mainParams.$addparams.'&'.$elementName.'=\'+this.options[this.selectedIndex].value,this);';
2757 return '
2758
2759 <!-- Function Menu of module -->
2760 <select name="'.$elementName.'" onchange="'.htmlspecialchars($onChange).'">
2761 '.implode('
2762 ',$options).'
2763 </select>
2764 ';
2765 }
2766 }
2767 }
2768
2769 /**
2770 * Checkbox function menu.
2771 * Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.
2772 * Usage: 34
2773 *
2774 * @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=...
2775 * @param string $elementName it the form elements name, probably something like "SET[...]"
2776 * @param string $currentValue is the value to be selected currently.
2777 * @param string $script is the script to send the &id to, if empty it's automatically found
2778 * @param string $addParams is additional parameters to pass to the script.
2779 * @param string Additional attributes for the checkbox input tag
2780 * @return string HTML code for checkbox
2781 * @see getFuncMenu()
2782 */
2783 public static function getFuncCheck($mainParams, $elementName, $currentValue, $script = '', $addparams = '', $tagParams = '') {
2784 if (!is_array($mainParams)) {
2785 $mainParams = array('id' => $mainParams);
2786 }
2787 $mainParams = t3lib_div::implodeArrayForUrl('', $mainParams);
2788
2789 if (!$script) {
2790 $script = basename(PATH_thisScript);
2791 $mainParams.= (t3lib_div::_GET('M') ? '&M='.rawurlencode(t3lib_div::_GET('M')) : '');
2792 }
2793
2794 $onClick = 'jumpToUrl(\''.$script.'?'.$mainParams.$addparams.'&'.$elementName.'=\'+(this.checked?1:0),this);';
2795 return '<input type="checkbox" class="checkbox" name="'.$elementName.'"'.($currentValue?' checked="checked"':'').' onclick="'.htmlspecialchars($onClick).'"'.($tagParams?' '.$tagParams:'').' />';
2796 }
2797
2798 /**
2799 * Input field function menu
2800 * Works like ->getFuncMenu() / ->getFuncCheck() but displays a input field instead which updates the script "onchange"
2801 * Usage: 1
2802 *
2803 * @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=...
2804 * @param string $elementName it the form elements name, probably something like "SET[...]"
2805 * @param string $currentValue is the value to be selected currently.
2806 * @param integer Relative size of input field, max is 48
2807 * @param string $script is the script to send the &id to, if empty it's automatically found
2808 * @param string $addParams is additional parameters to pass to the script.
2809 * @return string HTML code for input text field.
2810 * @see getFuncMenu()
2811 */
2812 public static function getFuncInput($mainParams, $elementName, $currentValue, $size = 10, $script = "", $addparams = "") {
2813 if (!is_array($mainParams)) {
2814 $mainParams = array('id' => $mainParams);
2815 }
2816 $mainParams = t3lib_div::implodeArrayForUrl('', $mainParams);
2817
2818 if (!$script) {
2819 $script = basename(PATH_thisScript);
2820 $mainParams.= (t3lib_div::_GET('M') ? '&M='.rawurlencode(t3lib_div::_GET('M')) : '');
2821 }
2822
2823 $onChange = 'jumpToUrl(\''.$script.'?'.$mainParams.$addparams.'&'.$elementName.'=\'+escape(this.value),this);';
2824 return '<input type="text"'.$GLOBALS['TBE_TEMPLATE']->formWidth($size).' name="'.$elementName.'" value="'.htmlspecialchars($currentValue).'" onchange="'.htmlspecialchars($onChange).'" />';
2825 }
2826
2827 /**
2828 * Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig)
2829 * See Inside TYPO3 about how to program modules and use this API.
2830 * Usage: 4
2831 *
2832 * @param array Module TS config array
2833 * @param array Array of items from which to remove items.
2834 * @param string $TSref points to the "object string" in $modTSconfig
2835 * @return array The modified $itemArray is returned.
2836 */
2837 public static function unsetMenuItems($modTSconfig, $itemArray, $TSref) {
2838 // Getting TS-config options for this module for the Backend User:
2839 $conf = $GLOBALS['BE_USER']->getTSConfig($TSref, $modTSconfig);
2840 if (is_array($conf['properties'])) {
2841 reset($conf['properties']);
2842 while(list($key, $val) = each($conf['properties'])) {
2843 if (!$val) {
2844 unset($itemArray[$key]);
2845 }
2846 }
2847 }
2848 return $itemArray;
2849 }
2850
2851 /**
2852 * Call to update the page tree frame (or something else..?) after
2853 * t3lib_BEfunc::getSetUpdateSignal('updatePageTree') -> will set the page tree to be updated.
2854 * t3lib_BEfunc::getSetUpdateSignal() -> will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
2855 * please use the setUpdateSignal function instead now, as it allows you to add more parameters
2856 * Usage: 11
2857 *
2858 * @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.
2859 * @return string HTML code (<script> section)
2860 * @see t3lib_BEfunc::getUpdateSignalCode()
2861 * @see t3lib_BEfunc::setUpdateSignal()
2862 * @deprecated since TYPO3 4.2, this function will be removed in TYPO3 4.5, use the setUpdateSignal function instead, as it allows you to add more parameters
2863 */
2864 public static function getSetUpdateSignal($set = '') {
2865 t3lib_div::logDeprecatedFunction();
2866
2867 // kept for backwards compatibility if $set is empty, use "getUpdateSignalCode()" instead
2868 if ($set) {
2869 return t3lib_BEfunc::setUpdateSignal($set);
2870 } else {
2871 return t3lib_BEfunc::getUpdateSignalCode();
2872 }
2873 }
2874
2875
2876 /**
2877 * Call to update the page tree frame (or something else..?) after
2878 * use 'updatePageTree' as a first parameter will set the page tree to be updated.
2879 * Usage: 10
2880 *
2881 * @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.
2882 * @param mixed Additional information for the update signal, used to only refresh a branch of the tree
2883 * @return void
2884 * @see t3lib_BEfunc::getUpdateSignalCode()
2885 */
2886 public static function setUpdateSignal($set = '', $params = '') {
2887 global $BE_USER;
2888 $modData = $BE_USER->getModuleData('t3lib_BEfunc::getUpdateSignal', 'ses');
2889
2890 if ($set) {
2891 $modData[$set] = array(
2892 'set' => $set,
2893 'parameter' => $params);
2894 } else { // clear the module data
2895 $modData = array();
2896 }
2897 $BE_USER->pushModuleData('t3lib_BEfunc::getUpdateSignal', $modData);
2898 }
2899
2900
2901 /**
2902 * Call to update the page tree frame (or something else..?) if this is set by the function
2903 * setUpdateSignal(). It will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
2904 * Usage: 1
2905 *
2906 * @return string HTML javascript code
2907 * @see t3lib_BEfunc::setUpdateSignal()
2908 */
2909 public static function getUpdateSignalCode() {
2910 $signals = array();
2911 $modData = $GLOBALS['BE_USER']->getModuleData('t3lib_BEfunc::getUpdateSignal', 'ses');
2912 if (!count($modData)) {
2913 return '';
2914 }
2915
2916 // Hook: Allows to let TYPO3 execute your JS code
2917 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['updateSignalHook'])) {
2918 $updateSignals = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['updateSignalHook'];
2919 } else {
2920 $updateSignals = array();
2921 }
2922
2923 // loop through all setUpdateSignals and get the JS code
2924 foreach ($modData as $set => $val) {
2925 if (isset($updateSignals[$set])) {
2926 $params = array('set' => $set, 'parameter' => $val['parameter'], 'JScode' => '');
2927 $ref = NULL;
2928 t3lib_div::callUserFunction($updateSignals[$set], $params, $ref);
2929 $signals[] = $params['JScode'];
2930 } else if ($set == 'updatePageTree' || $set == 'updateFolderTree') {
2931 $signals[] = '
2932 if (top && top.content && top.content.nav_frame && top.content.nav_frame.Tree) {
2933 top.content.nav_frame.Tree.refresh();
2934 }';
2935 }
2936 }
2937
2938 $content = implode(LF, $signals);
2939
2940 t3lib_BEfunc::setUpdateSignal(); // for backwards compatibility, should be replaced
2941 return $content;
2942 }
2943
2944
2945 /**
2946 * Returns an array which is most backend modules becomes MOD_SETTINGS containing values from function menus etc. determining the function of the module.
2947 * This is kind of session variable management framework for the backend users.
2948 * If a key from MOD_MENU is set in the CHANGED_SETTINGS array (eg. a value is passed to the script from the outside), this value is put into the settings-array
2949 * Ultimately, see Inside TYPO3 for how to use this function in relation to your modules.
2950 * Usage: 23
2951 *
2952 * @param array MOD_MENU is an array that defines the options in menus.
2953 * @param array CHANGED_SETTINGS represents the array used when passing values to the script from the menus.
2954 * @param string modName is the name of this module. Used to get the correct module data.
2955 * @param string If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
2956 * @param string dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
2957 * @param string List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
2958 * @return array The array $settings, which holds a key for each MOD_MENU key and the values of each key will be within the range of values for each menuitem
2959 */
2960 public static function getModuleData($MOD_MENU, $CHANGED_SETTINGS, $modName, $type = '', $dontValidateList = '', $setDefaultList = '') {
2961
2962 if ($modName && is_string($modName)) {
2963 // GETTING stored user-data from this module:
2964 $settings = $GLOBALS['BE_USER']->getModuleData($modName, $type);
2965
2966 $changed = 0;
2967 if (!is_array($settings)) {
2968 $changed = 1;
2969 $settings = array();
2970 }
2971 if (is_array($MOD_MENU)) {
2972 foreach ($MOD_MENU as $key=>$var) {
2973
2974 // If a global var is set before entering here. eg if submitted, then it's substituting the current value the array.
2975 if (is_array($CHANGED_SETTINGS) && isset($CHANGED_SETTINGS[$key])) {
2976 if (is_array($CHANGED_SETTINGS[$key])) {
2977 $serializedSettings = serialize($CHANGED_SETTINGS[$key]);
2978 if (strcmp($settings[$key], $serializedSettings)) {
2979 $settings[$key] = $serializedSettings;
2980 $changed = 1;
2981 }
2982 } else {
2983 if (strcmp($settings[$key], $CHANGED_SETTINGS[$key]) ) {
2984 $settings[$key] = $CHANGED_SETTINGS[$key];
2985 $changed = 1;
2986 }
2987 }
2988 }
2989
2990 // If the $var is an array, which denotes the existence of a menu, we check if the value is permitted
2991 if (is_array($var) && (!$dontValidateList || !t3lib_div::inList($dontValidateList, $key))) {
2992 // If the setting is an array or not present in the menu-array, MOD_MENU, then the default value is inserted.
2993 if (is_array($settings[$key]) || !isset($MOD_MENU[$key][$settings[$key]])) {
2994 $settings[$key] = (string)key($var);
2995 $changed = 1;
2996 }
2997 }
2998 if ($setDefaultList && !is_array($var)) { // Sets default values (only strings/checkboxes, not menus)
2999 if (t3lib_div::inList($setDefaultList, $key) && !isset($settings[$key])) {
3000 $settings[$key] = (string)$var;