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