TYPO3 Core

<?php

/***************************************************************

/**

* Contains a class with "Page functions" mainly for the frontend

*

*

*

* 109: class t3lib_pageSelect

*

*

*

*

*

*

* TOTAL FUNCTIONS: 24

* (This index is automatically created/updated by the extension "extdeveval")

*/

/**

* Page functions, a lot of sql/pages-related functions

* Mainly used in the frontend but also in some cases in the backend.

* @see tslib_fe::fetch_the_id()

*/

class t3lib_pageSelect {

var $sys_language_uid = 0;

// Versioning preview related:

var $workspaceCache = array();

// Internal, dynamic:

// Internal caching

protected $cache_getRootLine = array();

const DOKTYPE_ADVANCED = 2; // @deprecated since TYPO3 4.2

const DOKTYPE_LINK = 3;

const DOKTYPE_SHORTCUT = 4;

const DOKTYPE_BE_USER_SECTION = 6;

const DOKTYPE_MOUNTPOINT = 7;

const DOKTYPE_SPACER = 199;

* @return void

* @see tslib_fe::fetch_the_id(), tx_tstemplateanalyzer::initialize_editor()

*/

$this->where_groupAccess = '';

$this->where_hid_del = ' AND pages.deleted=0 ';

}

$this->where_hid_del .= 'AND pages.starttime<=' . $GLOBALS['SIM_ACCESS_TIME'] . ' AND (pages.endtime=0 OR pages.endtime>' . $GLOBALS['SIM_ACCESS_TIME'] . ') ';

// Filter out new/deleted place-holder pages in case we are NOT in a versioning preview (that means we are online!)

$this->where_hid_del .= ' AND NOT pages.t3ver_state>0';

} else {

// For version previewing, make sure that enable-fields are not de-selecting hidden pages - we need versionOL() to unset them only if the overlay record instructs us to.

}

}

/*******************************************

*

* Selecting page records

* @return array The page row with overlayed localized fields. Empty it no page.

* @see getPage_noCheck()

*/

// Hook to manipulate the page uid for special overlay handling

if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_page.php']['getPage'])) {

foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_page.php']['getPage'] as $classRef) {

return $this->cache_getPage[$uid][$cacheKey];

}

$result = array();

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

if ($row) {

if (is_array($row)) {

$result = $this->getPageOverlay($row);

}

* @return array The page row with overlayed localized fields. Empty array if no page.

* @see getPage()

*/

if ($this->cache_getPage_noCheck[$uid]) {

return $this->cache_getPage_noCheck[$uid];

}

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$result = array();

if ($row) {

if (is_array($row)) {

$result = $this->getPageOverlay($row);

}

* @return mixed If found: The page record (with overlayed localized fields, if any). If NOT found: blank value (not array!)

* @see tslib_fe::fetch_the_id()

*/

$output = '';

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$output = $this->getPageOverlay($row);

}

}

* @return integer Returns page uid (integer) if found, otherwise 0 (zero)

* @see tslib_fe::checkAndSetAlias(), tslib_cObj::typoLink()

*/

$alias = strtolower($alias);

if ($this->cache_getPageIdFromAlias[$alias]) {

return $this->cache_getPageIdFromAlias[$alias];

}

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$this->cache_getPageIdFromAlias[$alias] = $row['uid'];

return $row['uid'];

}

* @param integer Language UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0

* @return array Page row which is overlayed with language_overlay record (or the overlay record alone)

*/

// Initialize:

$row = NULL;

if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_page.php']['getPageOverlay'])) {

}

// If language UID is different from zero, do overlay:

$fieldArr = explode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['pageOverlayFields']);

} else {

}

/*

NOTE to enabledFields('pages_language_overlay'):

Currently the showHiddenRecords of TSFE set will allow pages_language_overlay records to be selected as they are child-records of a page.

// Selecting overlay record:

$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$row['_PAGES_OVERLAY'] = TRUE;

// Unset vital fields that are NOT allowed to be overlaid:

}

// Create output:

} else {

}

}

* @param string Overlay mode. If "hideNonTranslated" then records without translation will not be returned un-translated but unset (and return value is false)

* @return mixed Returns the input record, possibly overlaid with a translation. But if $OLmode is "hideNonTranslated" then it will return false if no translation is found.

*/

global $TCA;

if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_page.php']['getRecordOverlay'])) {

if (!($hookObject instanceof t3lib_pageSelect_getRecordOverlayHook)) {

throw new UnexpectedValueException('$hookObject must implement interface t3lib_pageSelect_getRecordOverlayHook', 1269881658);

}

}

}

// Will try to overlay a record only if the sys_language_content value is larger than zero.

// Must be default language or [All], otherwise no overlaying:

// Select overlay record:

$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(

'*',

$table,

'',

'',

'1'

);

$olrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

// Merge record content by traversing all fields:

if (is_array($olrow)) {

if (isset($olrow['_ORIG_pid'])) {

$row['_ORIG_pid'] = $olrow['_ORIG_pid'];

}

$row[$fN] = $olrow[$fN];

}

$row['_LOCALIZED_UID'] = $olrow['uid'];

}

}

unset($row);

}

// Otherwise, check if sys_language_content is different from the value of the record - that means a japanese site might try to display french content.

unset($row);

}

} else {

// When default language is displayed, we never want to return a record carrying another language!

unset($row);

}

}

if (!($hookObject instanceof t3lib_pageSelect_getRecordOverlayHook)) {

throw new UnexpectedValueException('$hookObject must implement interface t3lib_pageSelect_getRecordOverlayHook', 1269881659);

}

}

}

return $row;

}

/*******************************************

*

* Page related: Menu, Domain record, Root line

* @return array Array with key/value pairs; keys are page-uid numbers. values are the corresponding page records (with overlayed localized fields, if any)

* @see tslib_fe::getPageShortcut(), tslib_menu::makeMenu(), tx_wizardcrpages_webfunc_2, tx_wizardsortpages_webfunc_2

*/

$output = Array();

// Keep mount point:

$origUid = $row['uid'];

$row = $mp_row;

$row['_MP_PARAM'] = $mount_info['MPvar'];

}

// if shortcut, look up if the target exists and is currently visible

// check subpages - first subpage or random subpage

$searchField = 'pid';

// If a shortcut mode is set and no valid page is given to select subpags from use the actual page.

} elseif ($row['shortcut_mode'] == self::SHORTCUT_MODE_PARENT_PAGE) {

// shortcut to parent page

$searchField = 'uid';

'uid',

'pages',

$searchField . '=' . $searchUid .

);

if (!$count) {

unset($row);

}

// Add to output array after overlaying language:

$output[$origUid] = $this->getPageOverlay($row);

}

}

* @return mixed If found, returns integer with page UID where found. Otherwise blank. Might exit if location-header is sent, see description.

* @see tslib_fe::findDomainRecord()

*/

// Removing extra trailing slashes

// Appending to domain string

$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(

AND sys_domain.hidden=0

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$redirectUrl = $row['redirectTo'];

$redirectUrl = rtrim($redirectUrl, '/');

$redirectUrl .= '/' . $prependStr;

}

* @return array Array with page records from the root line as values. The array is ordered with the outer records first and root record in the bottom. The keys are numeric but in reverse order. So if you traverse/sort the array by the numeric keys order you will get the order from root and out. If an error is found (like eternal looping or invalid mountpoint) it will return an empty array.

* @see tslib_fe::getPageAndRootline()

*/

$cacheUid = $uid = intval($uid);

$cacheIgnoreMPerrors = ($ignoreMPerrors ? 1 : 0);

}

// Initialize:

$this->error_getRootLine = '';

$this->error_getRootLine_failPid = 0;

// Splitting the $MP parameters if present

$MPA = array();

foreach ($MPA as $MPAk => $v) {

$MPA[$MPAk] = explode('-', $MPA[$MPAk]);

}

$loopCheck = 0;

$theRowArray = Array();

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

// Mount Point page types are allowed ONLY a) if they are the outermost record in rootline and b) if the overlay flag is not set:

if ($GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids'] && $row['doktype'] == t3lib_pageSelect::DOKTYPE_MOUNTPOINT && !$ignoreMPerrors) {

$mount_info = $this->getMountPointInfo($row['uid'], $row);

$this->error_getRootLine = 'Illegal Mount Point found in rootline';

return array();

}

}

$curMP = end($MPA);

array_pop($MPA);

$mp_row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$mount_info = $this->getMountPointInfo($mp_row['uid'], $mp_row);

$row['_MOUNT_PAGE'] = array(

'uid' => $mp_row['uid'],

'pid' => $mp_row['pid'],

);

$row = $mp_row;

} else {

$this->error_getRootLine = 'Current Page Id is a mounted page of the overlay type and cannot be accessed directly!';

}

}

$row['_MP_PARAM'] = $mount_info['MPvar'];

} else {

$this->error_getRootLine = 'MP var was corrupted';

}

} else {

$this->error_getRootLine = 'No moint point record found according to PID in MP var';

}

}

}

} else {

$this->error_getRootLine = 'Broken rootline';

$this->error_getRootLine_failPid = $uid;

}

$loopCheck++;

}

// If the MPA array is NOT empty, we have to return an error; All MP elements were not resolved!

$this->error_getRootLine = 'MP value remain!';

return array();

}

// Create output array (with reversed order of numeric keys):

$output = Array();

$c = count($theRowArray);

$c--;

$output[$c] = $val;

}

* @return string The path in the form "/page title/This is another pageti.../Another page"

* @see tslib_fe::getConfigArray()

*/

$path = '';

}

}

return $path;

* @return string The URL type from $this->urltypes array. False if not found or disabled.

* @see tslib_fe::setExternalJumpUrl()

*/

if ($pagerow['doktype'] == t3lib_pageSelect::DOKTYPE_LINK && !$disable) {

// If relative path, prefix Site URL:

$uI = parse_url($redirectTo);

}

return $redirectTo;

}

* @return mixed Returns FALSE if no mount point was found, "-1" if there should have been one, but no connection to it, otherwise an array with information about mount pid and modes.

* @see tslib_menu

*/

$result = FALSE;

return $this->cache_getMountPointInfo[$pageId];

}

// Get pageRec if not supplied:

$pageRec = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

}

// Set first Page uid:

$firstPageUid = $pageRec['uid'];

}

// Look for mount pid value plus other required circumstances:

$mount_pid = intval($pageRec['mount_pid']);

// Get the mount point record (to verify its general existence):

$mountRec = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

// Look for recursive mount point:

$prevMountPids[] = $mount_pid;

$recursiveMountPid = $this->getMountPointInfo($mount_pid, $mountRec, $prevMountPids, $firstPageUid);

// Return mount point information:

$result = $recursiveMountPid ?

} else {

}

}

}

}

/*********************************

*

* Selecting records in general

* @param boolean If checkPage is set, it's also required that the page on which the record resides is accessible

* @return mixed Returns array (the record) if OK, otherwise blank/0 (zero)

*/

global $TCA;

$uid = intval($uid);

if (is_array($TCA[$table]) && $uid > 0) {

$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $table, 'uid = ' . $uid . $this->enableFields($table));

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$numRows = $GLOBALS['TYPO3_DB']->sql_num_rows($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

return $row;

} else {

return 0;

* @return mixed Returns array (the record) if found, otherwise blank/0 (zero)

* @see getPage_noCheck()

*/

global $TCA;

$uid = intval($uid);

// Excluding pages here so we can ask the function BEFORE TCA gets initialized. Support for this is followed up in deleteClause()...

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

if ($row) {

}

return $row;

}

}

* @param string Optional LIMIT value ([begin,]max), if none, supply blank string.

* @return mixed Returns array (the record) if found, otherwise nothing (void)

*/

global $TCA;

if (is_array($TCA[$theTable])) {

$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(

$rows = array();

#$this->versionOL($theTable,$row); // not used since records here are fetched based on other fields than uid!

$GLOBALS['TYPO3_DB']->sql_free_result($res);

return $rows;

}

}

}

/*********************************

*

* Caching and standard clauses

* @return string The "content" field of the "cache_hash" cache entry.

* @see tslib_TStemplate::start(), storeHash()

*/

$hashContent = null;

if (TYPO3_UseCachingFramework) {

} else {

$expTime = intval($expTime);

if ($expTime) {

}

$row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$hashContent = $row['content'];

}

}

'ident' => $ident,

'tstamp' => $GLOBALS['EXEC_TIME']

);

$GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_hash', $insertFields);

}

}

* @return string

* @see enableFields()

*/

global $TCA;

return ' AND pages.deleted=0';

} else {

}

}

* @return string The clause starting like " AND ...=... AND ...=..."

* @see tslib_cObj::enableFields(), deleteClause()

*/

global $TYPO3_CONF_VARS;

}

$ctrl = $GLOBALS['TCA'][$table]['ctrl'];

// Delete field check:

}

// Filter out new place-holder records in case we are NOT in a versioning preview (that means we are online!)

}

// Enable fields:

if (!$this->versioningPreview || !$ctrl['versioningWS'] || $noVersionPreview) { // In case of versioning-preview, enableFields are ignored (checked in versionOL())

if ($ctrl['enablecolumns']['disabled'] && !$show_hidden && !$ignore_array['disabled']) {

}

if ($ctrl['enablecolumns']['starttime'] && !$ignore_array['starttime']) {

$query .= ' AND ' . $field . '<=' . $GLOBALS['SIM_ACCESS_TIME'];

}

if ($ctrl['enablecolumns']['endtime'] && !$ignore_array['endtime']) {

}

if ($ctrl['enablecolumns']['fe_group'] && !$ignore_array['fe_group']) {

}

$_params = array(

'table' => $table,

'show_hidden' => $show_hidden,

'ignore_array' => $ignore_array,

'ctrl' => $ctrl

);

}

}

}

} else {

throw new InvalidArgumentException(

'There is no entry in the $TCA array for the table "' . $table .

1283790586

);

}

* @return string AND sql-clause

* @see enableFields()

*/

$orChecks[] = $GLOBALS['TYPO3_DB']->listQuery($field, $value, $table);

}

}

/*********************************

*

* Versioning Preview

* @return void (Passed by ref).

* @see t3lib_BEfunc::fixVersioningPid(), versionOL(), getRootLine()

*/

global $TCA;

// Check values for t3ver_oid and t3ver_wsid:

$oid = $rr['t3ver_oid'];

$wsid = $rr['t3ver_wsid'];

$oid = $newPidRec['t3ver_oid'];

$wsid = $newPidRec['t3ver_wsid'];

}

}

# SWAP uid as well? Well no, because when fixing a versioning PID happens it is assumed that this is a "branch" type page and therefore the uid should be kept (like in versionOL()). However if the page is NOT a branch version it should not happen - but then again, direct access to that uid should not happen!

$rr['_ORIG_pid'] = $rr['pid'];

$rr['pid'] = $oidRec['pid'];

}

// changing PID in case of moving pointer:

$rr['pid'] = $movePlhRec['pid'];

}

}

* @return void (Passed by ref).

* @see fixVersioningPid(), t3lib_BEfunc::workspaceOL()

*/

global $TCA;

// Always fix PID (like in fixVersioningPid() above). [This is usually not the important factor for versioning OL]

// "element" and "page" type versions:

// For versions of single elements or page+content, preserve online UID and PID (this will produce true "overlay" of element _content_, not any references)

// For page+content the "_ORIG_uid" should actually be used as PID for selection of tables with "versioning_followPages" enabled.

$wsAlt['_ORIG_uid'] = $wsAlt['uid'];

$wsAlt['uid'] = $row['uid'];

// Translate page alias as well so links are pointing to the _online_ page:

$wsAlt['alias'] = $row['alias'];

}

} else {

// "branch" versions:

// Keeping overlay uid and pid so references are changed. This is only for page-versions with BRANCH below!

}

// Changing input record to the workspace version alternative:

$row = $wsAlt;

// Check if it is deleted/new

}

// Check if move-pointer in workspace (unless if a move-placeholder is the reason why it appears!):

// You have to specifically set $unsetMovePointers in order to clear these because it is normally a display issue if it should be shown or not.

}

} else {

// No version found, then check if t3ver_state =1 (online version is dummy-representation)

// Notice, that unless $bypassEnableFieldsCheck is TRUE, the $row is unset if enablefields for BOTH the version AND the online record deselects it. See note for $bypassEnableFieldsCheck

}

}

}

* @return boolean True if overlay is made.

* @see t3lib_BEfunc::movePlhOl()

*/

global $TCA;

// If t3ver_move_id is not found, then find it... (but we like best if it is here...)

$moveID = $moveIDRec['t3ver_move_id'];

} else {

$moveID = $row['t3ver_move_id'];

}

// Find pointed-to record.

$origRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

$GLOBALS['TYPO3_DB']->sql_free_result($res);

$row = $origRow;

return TRUE;

}

* @return array If found, the record, otherwise nothing.

* @see t3lib_BEfunc::getMovePlaceholder()

*/

global $TCA;

// Select workspace version of record:

$rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(

$table,

'pid!=-1 AND

t3ver_state=3 AND

$this->deleteClause($table)

);

return $rows[0];

}

}

* @return mixed If found, return record, otherwise other value: Returns 1 if version was sought for but not found, returns -1/-2 if record (offline/online) existed but had enableFields that would disable it. Returns FALSE if not in workspace or no versioning for record. Notice, that the enablefields of the online record is also tested.

* @see t3lib_befunc::getWorkspaceVersionOfRecord()

*/

global $TCA;

// Setting up enableFields for version record:

$enFields = $this->versioningPreview_where_hid_del;

} else {

}

// Select workspace version of record, only testing for deleted.

$fields,

$table,

'pid=-1 AND

);

// If version found, check if it could have been selected with enableFields on as well:

if ($bypassEnableFieldsCheck || $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(

'uid',

$table,

'pid=-1 AND

)) {

} else {

}

} else {

// OK, so no workspace version was found. Then check if online version can be selected with full enable fields and if so, return 1:

if ($bypassEnableFieldsCheck || $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(

'uid',

$table,

} else {

}

}

}

}

/**

*/

function checkWorkspaceAccess($wsid) {

if (!$GLOBALS['BE_USER']) {

}

if (isset($this->workspaceCache[$wsid])) {

$ws = $this->workspaceCache[$wsid];

}