t3lib/class.t3lib_befunc.php

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