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