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