t3lib/class.t3lib_befunc.php

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