fd74e24eb2cfbabdf832b6ba92fcf5ffe6edd8c3
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_page.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 * Contains a class with "Page functions" mainly for the frontend
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
32 * XHTML-trans compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 109: class t3lib_pageSelect
42 * 134: function init($show_hidden)
43 *
44 * SECTION: Selecting page records
45 * 184: function getPage($uid, $disableGroupAccessCheck=FALSE)
46 * 200: function getPage_noCheck($uid)
47 * 216: function getFirstWebPage($uid)
48 * 234: function getPageIdFromAlias($alias)
49 * 250: function getPageOverlay($pageInput,$lUid=-1)
50 * 314: function getRecordOverlay($table,$row,$sys_language_content,$OLmode='')
51 *
52 * SECTION: Page related: Menu, Domain record, Root line
53 * 413: function getMenu($uid,$fields='*',$sortField='sorting',$addWhere='',$checkShortcuts=1)
54 * 471: function getDomainStartPage($domain, $path='',$request_uri='')
55 * 519: function getRootLine($uid, $MP='', $ignoreMPerrors=FALSE)
56 * 640: function getPathFromRootline($rl,$len=20)
57 * 661: function getExtURL($pagerow,$disable=0)
58 * 685: function getMountPointInfo($pageId, $pageRec=FALSE, $prevMountPids=array(), $firstPageUid=0)
59 *
60 * SECTION: Selecting records in general
61 * 762: function checkRecord($table,$uid,$checkPage=0)
62 * 797: function getRawRecord($table,$uid,$fields='*',$noWSOL=FALSE)
63 * 823: function getRecordsByField($theTable,$theField,$theValue,$whereClause='',$groupBy='',$orderBy='',$limit='')
64 *
65 * SECTION: Caching and standard clauses
66 * 875: function getHash($hash,$expTime=0)
67 * 898: function storeHash($hash,$data,$ident)
68 * 916: function deleteClause($table)
69 * 936: function enableFields($table,$show_hidden=-1,$ignore_array=array(),$noVersionPreview=FALSE)
70 * 1008: function getMultipleGroupsWhereClause($field, $table)
71 *
72 * SECTION: Versioning Preview
73 * 1055: function fixVersioningPid($table,&$rr)
74 * 1096: function versionOL($table,&$row)
75 * 1151: function getWorkspaceVersionOfRecord($workspace, $table, $uid, $fields='*')
76 *
77 * TOTAL FUNCTIONS: 24
78 * (This index is automatically created/updated by the extension "extdeveval")
79 *
80 */
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99 /**
100 * Page functions, a lot of sql/pages-related functions
101 * Mainly used in the frontend but also in some cases in the backend.
102 * It's important to set the right $where_hid_del in the object so that the functions operate properly
103 *
104 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
105 * @package TYPO3
106 * @subpackage t3lib
107 * @see tslib_fe::fetch_the_id()
108 */
109 class t3lib_pageSelect {
110 var $urltypes = Array('','http://','ftp://','mailto:','https://');
111 var $where_hid_del = ' AND pages.deleted=0'; // This is not the final clauses. There will normally be conditions for the hidden,starttime and endtime fields as well. You MUST initialize the object by the init() function
112 var $where_groupAccess = ''; // Clause for fe_group access
113 var $sys_language_uid = 0;
114
115 // Versioning preview related:
116 var $versioningPreview = FALSE; // If true, preview of other record versions is allowed. THIS MUST ONLY BE SET IF the page is not cached and truely previewed by a backend user!!!
117 var $versioningWorkspaceId = 0; // Workspace ID for preview
118
119
120
121 // Internal, dynamic:
122 var $error_getRootLine = ''; // Error string set by getRootLine()
123 var $error_getRootLine_failPid = 0; // Error uid set by getRootLine()
124
125
126 /**
127 * init() MUST be run directly after creating a new template-object
128 * This sets the internal variable $this->where_hid_del to the correct where clause for page records taking deleted/hidden/starttime/endtime/t3ver_state into account
129 *
130 * @param boolean If $show_hidden is true, the hidden-field is ignored!! Normally this should be false. Is used for previewing.
131 * @return void
132 * @see tslib_fe::fetch_the_id(), tx_tstemplateanalyzer::initialize_editor()
133 */
134 function init($show_hidden) {
135 $this->where_groupAccess = '';
136 $this->where_hid_del = ' AND pages.deleted=0 ';
137 if (!$show_hidden) {
138 $this->where_hid_del.= 'AND pages.hidden=0 ';
139 }
140 $this->where_hid_del.= 'AND (pages.starttime<='.$GLOBALS['SIM_EXEC_TIME'].') AND (pages.endtime=0 OR pages.endtime>'.$GLOBALS['SIM_EXEC_TIME'].') ';
141
142 // Filter out new place-holder pages in case we are NOT in a versioning preview (that means we are online!)
143 if (!$this->versioningPreview) {
144 $this->where_hid_del.= ' AND NOT(pages.t3ver_state=1)';
145 } else {
146 // 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.
147 $this->versioningPreview_where_hid_del = $this->where_hid_del; // Copy where_hid_del to other variable (used in relation to versionOL())
148 $this->where_hid_del = ' AND pages.deleted=0 '; // Clear where_hid_del
149 }
150 }
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 /*******************************************
169 *
170 * Selecting page records
171 *
172 ******************************************/
173
174 /**
175 * Returns the $row for the page with uid = $uid (observing ->where_hid_del)
176 * Any pages_language_overlay will be applied before the result is returned.
177 * If no page is found an empty array is returned.
178 *
179 * @param integer The page id to look up.
180 * @param boolean If set, the check for group access is disabled. VERY rarely used
181 * @return array The page row with overlayed localized fields. Empty it no page.
182 * @see getPage_noCheck()
183 */
184 function getPage($uid, $disableGroupAccessCheck=FALSE) {
185 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'pages', 'uid='.intval($uid).$this->where_hid_del.($disableGroupAccessCheck ? '' : $this->where_groupAccess));
186 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
187 $this->versionOL('pages',$row);
188 if (is_array($row)) return $this->getPageOverlay($row);
189 }
190 return Array();
191 }
192
193 /**
194 * Return the $row for the page with uid = $uid WITHOUT checking for ->where_hid_del (start- and endtime or hidden). Only "deleted" is checked!
195 *
196 * @param integer The page id to look up
197 * @return array The page row with overlayed localized fields. Empty it no page.
198 * @see getPage()
199 */
200 function getPage_noCheck($uid) {
201 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'pages', 'uid='.intval($uid).$this->deleteClause('pages'));
202 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
203 $this->versionOL('pages',$row);
204 if (is_array($row)) return $this->getPageOverlay($row);
205 }
206 return Array();
207 }
208
209 /**
210 * Returns the $row of the first web-page in the tree (for the default menu...)
211 *
212 * @param integer The page id for which to fetch first subpages (PID)
213 * @return mixed If found: The page record (with overlayed localized fields, if any). If NOT found: blank value (not array!)
214 * @see tslib_fe::fetch_the_id()
215 */
216 function getFirstWebPage($uid) {
217 $output = '';
218 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'pages', 'pid='.intval($uid).$this->where_hid_del.$this->where_groupAccess, '', 'sorting', '1');
219 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
220 $this->versionOL('pages',$row);
221 if (is_array($row)) $output = $this->getPageOverlay($row);
222 }
223 $GLOBALS['TYPO3_DB']->sql_free_result($res);
224 return $output;
225 }
226
227 /**
228 * Returns a pagerow for the page with alias $alias
229 *
230 * @param string The alias to look up the page uid for.
231 * @return integer Returns page uid (integer) if found, otherwise 0 (zero)
232 * @see tslib_fe::checkAndSetAlias(), tslib_cObj::typoLink()
233 */
234 function getPageIdFromAlias($alias) {
235 $alias = strtolower($alias);
236 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'alias='.$GLOBALS['TYPO3_DB']->fullQuoteStr($alias, 'pages').' AND pid>=0 AND pages.deleted=0'); // "AND pid>=0" because of versioning (means that aliases sent MUST be online!)
237 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
238 return $row['uid'];
239 }
240 return 0;
241 }
242
243 /**
244 * Returns the relevant page overlay record fields
245 *
246 * @param mixed If $pageInput is an integer, it's the pid of the pageOverlay record and thus the page overlay record is returned. If $pageInput is an array, it's a page-record and based on this page record the language record is found and OVERLAYED before the page record is returned.
247 * @param integer Language UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0
248 * @return array Page row which is overlayed with language_overlay record (or the overlay record alone)
249 */
250 function getPageOverlay($pageInput,$lUid=-1) {
251
252 // Initialize:
253 if ($lUid<0) $lUid = $this->sys_language_uid;
254 $row = NULL;
255
256 // If language UID is different from zero, do overlay:
257 if ($lUid) {
258 $fieldArr = explode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['pageOverlayFields']);
259 if (is_array($pageInput)) {
260 $page_id = $pageInput['uid']; // Was the whole record
261 $fieldArr = array_intersect($fieldArr,array_keys($pageInput)); // Make sure that only fields which exist in the incoming record are overlaid!
262 } else {
263 $page_id = $pageInput; // Was the id
264 }
265
266 if (count($fieldArr)) {
267 /*
268 NOTE to enabledFields('pages_language_overlay'):
269 Currently the showHiddenRecords of TSFE set will allow pages_language_overlay records to be selected as they are child-records of a page.
270 However you may argue that the showHiddenField flag should determine this. But that's not how it's done right now.
271 */
272
273 // Selecting overlay record:
274 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
275 implode(',',$fieldArr),
276 'pages_language_overlay',
277 'pid='.intval($page_id).'
278 AND sys_language_uid='.intval($lUid).
279 $this->enableFields('pages_language_overlay'),
280 '',
281 '',
282 '1'
283 );
284 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
285 $this->versionOL('pages_language_overlay',$row);
286
287 if (is_array($row)) {
288 $row['_PAGES_OVERLAY'] = TRUE;
289
290 // Unset vital fields that are NOT allowed to be overlaid:
291 unset($row['uid']);
292 unset($row['pid']);
293 }
294 }
295 }
296
297 // Create output:
298 if (is_array($pageInput)) {
299 return is_array($row) ? array_merge($pageInput,$row) : $pageInput; // If the input was an array, simply overlay the newfound array and return...
300 } else {
301 return is_array($row) ? $row : array(); // always an array in return
302 }
303 }
304
305 /**
306 * Creates language-overlay for records in general (where translation is found in records from the same table)
307 *
308 * @param string Table name
309 * @param array Record to overlay. Must containt uid, pid and $table]['ctrl']['languageField']
310 * @param integer Pointer to the sys_language uid for content on the site.
311 * @param string Overlay mode. If "hideNonTranslated" then records without translation will not be returned un-translated but unset (and return value is false)
312 * @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.
313 */
314 function getRecordOverlay($table,$row,$sys_language_content,$OLmode='') {
315 global $TCA;
316
317 if ($row['uid']>0 && $row['pid']>0) {
318 if ($TCA[$table] && $TCA[$table]['ctrl']['languageField'] && $TCA[$table]['ctrl']['transOrigPointerField']) {
319 if (!$TCA[$table]['ctrl']['transOrigPointerTable']) { // Will not be able to work with other tables (Just didn't implement it yet; Requires a scan over all tables [ctrl] part for first FIND the table that carries localization information for this table (which could even be more than a single table) and then use that. Could be implemented, but obviously takes a little more....)
320
321 // Will try to overlay a record only if the sys_language_content value is larger than zero.
322 if ($sys_language_content>0) {
323
324 // Must be default language or [All], otherwise no overlaying:
325 if ($row[$TCA[$table]['ctrl']['languageField']]<=0) {
326
327 // Select overlay record:
328 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
329 '*',
330 $table,
331 'pid='.intval($row['pid']).
332 ' AND '.$TCA[$table]['ctrl']['languageField'].'='.intval($sys_language_content).
333 ' AND '.$TCA[$table]['ctrl']['transOrigPointerField'].'='.intval($row['uid']).
334 $this->enableFields($table),
335 '',
336 '',
337 '1'
338 );
339 $olrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
340 $this->versionOL($table,$olrow);
341 #debug($row);
342 #debug($olrow);
343 // Merge record content by traversing all fields:
344 if (is_array($olrow)) {
345 foreach($row as $fN => $fV) {
346 if ($fN!='uid' && $fN!='pid' && isset($olrow[$fN])) {
347
348 if ($GLOBALS['TSFE']->TCAcachedExtras[$table]['l10n_mode'][$fN]!='exclude'
349 && ($GLOBALS['TSFE']->TCAcachedExtras[$table]['l10n_mode'][$fN]!='mergeIfNotBlank' || strcmp(trim($olrow[$fN]),''))) {
350 $row[$fN] = $olrow[$fN];
351 }
352 } elseif ($fN=='uid') {
353 $row['_LOCALIZED_UID'] = $olrow['uid'];
354 }
355 }
356 } elseif ($OLmode==='hideNonTranslated' && $row[$TCA[$table]['ctrl']['languageField']]==0) { // Unset, if non-translated records should be hidden. ONLY done if the source record really is default language and not [All] in which case it is allowed.
357 unset($row);
358 }
359
360 // 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.
361 } elseif ($sys_language_content!=$row[$TCA[$table]['ctrl']['languageField']]) {
362 unset($row);
363 }
364 } else {
365 // When default language is displayed, we never want to return a record carrying another language!:
366 if ($row[$TCA[$table]['ctrl']['languageField']]>0) {
367 unset($row);
368 }
369 }
370 }
371 }
372 }
373
374 return $row;
375 }
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394 /*******************************************
395 *
396 * Page related: Menu, Domain record, Root line
397 *
398 ******************************************/
399
400 /**
401 * Returns an array with pagerows for subpages with pid=$uid (which is pid here!). This is used for menus.
402 * If there are mount points in overlay mode the _MP_PARAM field is set to the corret MPvar.
403 * If the $uid being input does in itself require MPvars to define a correct rootline these must be handled externally to this function.
404 *
405 * @param integer The page id for which to fetch subpages (PID)
406 * @param string List of fields to select. Default is "*" = all
407 * @param string The field to sort by. Default is "sorting"
408 * @param string Optional additional where clauses. Like "AND title like '%blabla%'" for instance.
409 * @param boolean check if shortcuts exist, checks by default
410 * @return array Array with key/value pairs; keys are page-uid numbers. values are the corresponding page records (with overlayed localized fields, if any)
411 * @see tslib_fe::getPageShortcut(), tslib_menu::makeMenu(), tx_wizardcrpages_webfunc_2, tx_wizardsortpages_webfunc_2
412 */
413 function getMenu($uid,$fields='*',$sortField='sorting',$addWhere='',$checkShortcuts=1) {
414
415 $output = Array();
416 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($fields, 'pages', 'pid='.intval($uid).$this->where_hid_del.$this->where_groupAccess.' '.$addWhere, '', $sortField);
417 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
418 $this->versionOL('pages',$row);
419
420 if (is_array($row)) {
421 // Keep mount point:
422 $origUid = $row['uid'];
423 $mount_info = $this->getMountPointInfo($origUid, $row); // $row MUST have "uid", "pid", "doktype", "mount_pid", "mount_pid_ol" fields in it
424 if (is_array($mount_info) && $mount_info['overlay']) { // There is a valid mount point.
425 $mp_row = $this->getPage($mount_info['mount_pid']); // Using "getPage" is OK since we need the check for enableFields AND for type 2 of mount pids we DO require a doktype < 200!
426 if (count($mp_row)) {
427 $row = $mp_row;
428 $row['_MP_PARAM'] = $mount_info['MPvar'];
429 } else unset($row); // If the mount point could not be fetched with respect to enableFields, unset the row so it does not become a part of the menu!
430 }
431
432 // if shortcut, look up if the target exists and is currently visible
433 if ($row['doktype'] == 4 && ($row['shortcut'] || $row['shortcut_mode']) && $checkShortcuts) {
434 if ($row['shortcut_mode'] == 0) {
435 $searchField = 'uid';
436 $searchUid = intval($row['shortcut']);
437 } else { // check subpages - first subpage or random subpage
438 $searchField = 'pid';
439 // If a shortcut mode is set and no valid page is given to select subpags from use the actual page.
440 $searchUid = intval($row['shortcut'])?intval($row['shortcut']):$row['uid'];
441 }
442 $res2 = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', $searchField.'='.$searchUid.$this->where_hid_del.$this->where_groupAccess.' '.$addWhere, '', $sortField);
443 if (!$GLOBALS['TYPO3_DB']->sql_num_rows($res2)) {
444 unset($row);
445 }
446 $GLOBALS['TYPO3_DB']->sql_free_result($res2);
447 } elseif ($row['doktype'] == 4 && $checkShortcuts) {
448 // Neither shortcut target nor mode is set. Remove the page from the menu.
449 unset($row);
450 }
451
452 // Add to output array after overlaying language:
453 if (is_array($row)) {
454 $output[$origUid] = $this->getPageOverlay($row);
455 }
456 }
457 }
458 return $output;
459 }
460
461 /**
462 * Will find the page carrying the domain record matching the input domain.
463 * Might exit after sending a redirect-header IF a found domain record instructs to do so.
464 *
465 * @param string Domain name to search for. Eg. "www.typo3.com". Typical the HTTP_HOST value.
466 * @param string Path for the current script in domain. Eg. "/somedir/subdir". Typ. supplied by t3lib_div::getIndpEnv('SCRIPT_NAME')
467 * @param string Request URI: Used to get parameters from if they should be appended. Typ. supplied by t3lib_div::getIndpEnv('REQUEST_URI')
468 * @return mixed If found, returns integer with page UID where found. Otherwise blank. Might exit if location-header is sent, see description.
469 * @see tslib_fe::findDomainRecord()
470 */
471 function getDomainStartPage($domain, $path='',$request_uri='') {
472 $domain = explode(':',$domain);
473 $domain = strtolower(ereg_replace('\.$','',$domain[0]));
474 // Removing extra trailing slashes
475 $path = trim(ereg_replace('\/[^\/]*$','',$path));
476 // Appending to domain string
477 $domain.= $path;
478 $domain = ereg_replace('\/*$','',$domain);
479
480 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
481 'pages.uid,sys_domain.redirectTo,sys_domain.prepend_params',
482 'pages,sys_domain',
483 'pages.uid=sys_domain.pid
484 AND sys_domain.hidden=0
485 AND (sys_domain.domainName='.$GLOBALS['TYPO3_DB']->fullQuoteStr($domain, 'sys_domain').' OR sys_domain.domainName='.$GLOBALS['TYPO3_DB']->fullQuoteStr($domain.'/', 'sys_domain').') '.
486 $this->where_hid_del.$this->where_groupAccess,
487 '',
488 '',
489 1
490 );
491 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
492 if ($row['redirectTo']) {
493 $rURL = $row['redirectTo'];
494 if ($row['prepend_params']) {
495 $rURL = ereg_replace('\/$','',$rURL);
496 $prependStr = ereg_replace('^\/','',substr($request_uri,strlen($path)));
497 $rURL.= '/'.$prependStr;
498 }
499 Header('Location: '.t3lib_div::locationHeaderUrl($rURL));
500 exit;
501 } else {
502 return $row['uid'];
503 }
504 }
505 }
506
507 /**
508 * Returns array with fields of the pages from here ($uid) and back to the root
509 * NOTICE: This function only takes deleted pages into account! So hidden, starttime and endtime restricted pages are included no matter what.
510 * Further: If any "recycler" page is found (doktype=255) then it will also block for the rootline)
511 * If you want more fields in the rootline records than default such can be added by listing them in $GLOBALS['TYPO3_CONF_VARS']['FE']['addRootLineFields']
512 *
513 * @param integer The page uid for which to seek back to the page tree root.
514 * @param string Commalist of MountPoint parameters, eg. "1-2,3-4" etc. Normally this value comes from the GET var, MP
515 * @param boolean If set, some errors related to Mount Points in root line are ignored.
516 * @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.
517 * @see tslib_fe::getPageAndRootline()
518 */
519 function getRootLine($uid, $MP='', $ignoreMPerrors=FALSE) {
520
521 // Initialize:
522 $selFields = t3lib_div::uniqueList('pid,uid,t3ver_oid,t3ver_wsid,t3ver_state,t3ver_swapmode,title,alias,nav_title,media,layout,hidden,starttime,endtime,fe_group,extendToSubpages,doktype,TSconfig,storage_pid,is_siteroot,mount_pid,mount_pid_ol,fe_login_mode,'.$GLOBALS['TYPO3_CONF_VARS']['FE']['addRootLineFields']);
523 $this->error_getRootLine = '';
524 $this->error_getRootLine_failPid = 0;
525
526 // Splitting the $MP parameters if present
527 $MPA = array();
528 if ($MP) {
529 $MPA = explode(',',$MP);
530 reset($MPA);
531 while(list($MPAk) = each($MPA)) {
532 $MPA[$MPAk] = explode('-', $MPA[$MPAk]);
533 }
534 }
535
536 $loopCheck = 0;
537 $theRowArray = Array();
538 $uid = intval($uid);
539
540 while ($uid!=0 && $loopCheck<20) { // Max 20 levels in the page tree.
541 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($selFields, 'pages', 'uid='.intval($uid).' AND pages.deleted=0 AND pages.doktype!=255');
542 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
543 $this->versionOL('pages',$row);
544 $this->fixVersioningPid('pages',$row);
545
546 if (is_array($row)) {
547 // 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:
548 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids'] && $row['doktype']==7 && !$ignoreMPerrors) {
549 $mount_info = $this->getMountPointInfo($row['uid'], $row);
550 if ($loopCheck>0 || $mount_info['overlay']) {
551 $this->error_getRootLine = 'Illegal Mount Point found in rootline';
552 return array();
553 }
554 }
555
556 $uid = $row['pid']; // Next uid
557
558 if (count($MPA) && $GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids']) {
559 $curMP = end($MPA);
560 if (!strcmp($row['uid'],$curMP[0])) {
561
562 array_pop($MPA);
563 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($selFields, 'pages', 'uid='.intval($curMP[1]).' AND pages.deleted=0 AND pages.doktype!=255');
564 $mp_row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
565
566 $this->versionOL('pages',$mp_row);
567 $this->fixVersioningPid('pages',$mp_row);
568
569 if (is_array($mp_row)) {
570 $mount_info = $this->getMountPointInfo($mp_row['uid'], $mp_row);
571 if (is_array($mount_info) && $mount_info['mount_pid']==$curMP[0]) {
572 $uid = $mp_row['pid']; // Setting next uid
573
574 if ($mount_info['overlay']) { // Symlink style: Keep mount point (current row).
575 $row['_MOUNT_OL'] = TRUE; // Set overlay mode:
576 $row['_MOUNT_PAGE'] = array(
577 'uid' => $mp_row['uid'],
578 'pid' => $mp_row['pid'],
579 'title' => $mp_row['title'],
580 );
581 } else { // Normal operation: Insert the mount page row in rootline instead mount point.
582 if ($loopCheck>0) {
583 $row = $mp_row;
584 } else {
585 $this->error_getRootLine = 'Current Page Id is a mounted page of the overlay type and cannot be accessed directly!';
586 return array(); // Matching the page id (first run, $loopCheck = 0) with the MPvar is ONLY allowed if the mount point is the "overlay" type (otherwise it could be forged!)
587 }
588 }
589
590 $row['_MOUNTED_FROM'] = $curMP[0];
591 $row['_MP_PARAM'] = $mount_info['MPvar'];
592 } else {
593 $this->error_getRootLine = 'MP var was corrupted';
594 return array(); // The MP variables did NOT connect proper mount points:
595 }
596 } else {
597 $this->error_getRootLine = 'No moint point record found according to PID in MP var';
598 return array(); // The second PID in MP var was NOT a valid page.
599 }
600 }
601 }
602 }
603 // Add row to rootline with language overlaid:
604 $theRowArray[] = $this->getPageOverlay($row);
605 } else {
606 $this->error_getRootLine = 'Broken rootline';
607 $this->error_getRootLine_failPid = $uid;
608 return array(); // broken rootline.
609 }
610
611 $loopCheck++;
612 }
613
614 // If the MPA array is NOT empty, we have to return an error; All MP elements were not resolved!
615 if (count($MPA)) {
616 $this->error_getRootLine = 'MP value remain!';
617 return array();
618 }
619
620 // Create output array (with reversed order of numeric keys):
621 $output = Array();
622 $c = count($theRowArray);
623 foreach($theRowArray as $key => $val) {
624 $c--;
625 $output[$c] = $val;
626 }
627
628 return $output;
629 }
630
631 /**
632 * Creates a "path" string for the input root line array titles.
633 * Used for writing statistics.
634 *
635 * @param array A rootline array!
636 * @param integer The max length of each title from the rootline.
637 * @return string The path in the form "/page title/This is another pageti.../Another page"
638 * @see tslib_fe::getConfigArray()
639 */
640 function getPathFromRootline($rl,$len=20) {
641 if (is_array($rl)) {
642 $c=count($rl);
643 $path = '';
644 for ($a=0;$a<$c;$a++) {
645 if ($rl[$a]['uid']) {
646 $path.='/'.t3lib_div::fixed_lgd_cs(strip_tags($rl[$a]['title']),$len);
647 }
648 }
649 return $path;
650 }
651 }
652
653 /**
654 * Returns the URL type for the input page row IF the doktype is 3 and not disabled.
655 *
656 * @param array The page row to return URL type for
657 * @param boolean A flag to simply disable any output from here.
658 * @return string The URL type from $this->urltypes array. False if not found or disabled.
659 * @see tslib_fe::setExternalJumpUrl()
660 */
661 function getExtURL($pagerow,$disable=0) {
662 if ($pagerow['doktype']==3 && !$disable) {
663 $redirectTo = $this->urltypes[$pagerow['urltype']].$pagerow['url'];
664
665 // If relative path, prefix Site URL:
666 $uI = parse_url($redirectTo);
667 if (!$uI['scheme'] && substr($redirectTo,0,1)!='/') { // relative path assumed now...
668 $redirectTo = t3lib_div::getIndpEnv('TYPO3_SITE_URL').$redirectTo;
669 }
670 return $redirectTo;
671 }
672 }
673
674 /**
675 * Returns MountPoint id for page
676 * Does a recursive search if the mounted page should be a mount page itself. It has a run-away break so it can't go into infinite loops.
677 *
678 * @param integer Page id for which to look for a mount pid. Will be returned only if mount pages are enabled, the correct doktype (7) is set for page and there IS a mount_pid (which has a valid record that is not deleted...)
679 * @param array Optional page record for the page id. If not supplied it will be looked up by the system. Must contain at least uid,pid,doktype,mount_pid,mount_pid_ol
680 * @param array Array accumulating formerly tested page ids for mount points. Used for recursivity brake.
681 * @param integer The first page id.
682 * @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.
683 * @see tslib_menu
684 */
685 function getMountPointInfo($pageId, $pageRec=FALSE, $prevMountPids=array(), $firstPageUid=0) {
686 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids']) {
687
688 // Get pageRec if not supplied:
689 if (!is_array($pageRec)) {
690 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,pid,doktype,mount_pid,mount_pid_ol,t3ver_state', 'pages', 'uid='.intval($pageId).' AND pages.deleted=0 AND pages.doktype!=255');
691 $pageRec = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
692 $this->versionOL('pages',$pageRec); // Only look for version overlay if page record is not supplied; This assumes that the input record is overlaid with preview version, if any!
693 }
694
695 // Set first Page uid:
696 if (!$firstPageUid) $firstPageUid = $pageRec['uid'];
697
698 // Look for mount pid value plus other required circumstances:
699 $mount_pid = intval($pageRec['mount_pid']);
700 if (is_array($pageRec) && $pageRec['doktype']==7 && $mount_pid>0 && !in_array($mount_pid, $prevMountPids)) {
701
702 // Get the mount point record (to verify its general existence):
703 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,pid,doktype,mount_pid,mount_pid_ol,t3ver_state', 'pages', 'uid='.$mount_pid.' AND pages.deleted=0 AND pages.doktype!=255');
704 $mount_rec = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
705 $this->versionOL('pages',$mount_rec);
706
707 if (is_array($mount_rec)) {
708 // Look for recursive mount point:
709 $prevMountPids[] = $mount_pid;
710 $recursiveMountPid = $this->getMountPointInfo($mount_pid, $mount_rec, $prevMountPids, $firstPageUid);
711
712 // Return mount point information:
713 return $recursiveMountPid ?
714 $recursiveMountPid :
715 array(
716 'mount_pid' => $mount_pid,
717 'overlay' => $pageRec['mount_pid_ol'],
718 'MPvar' => $mount_pid.'-'.$firstPageUid,
719 'mount_point_rec' => $pageRec,
720 'mount_pid_rec' => $mount_rec,
721 );
722 } else {
723 return -1; // Means, there SHOULD have been a mount point, but there was none!
724 }
725 }
726 }
727
728 return FALSE;
729 }
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747 /*********************************
748 *
749 * Selecting records in general
750 *
751 **********************************/
752
753 /**
754 * Checks if a record exists and is accessible.
755 * The row is returned if everything's OK.
756 *
757 * @param string The table name to search
758 * @param integer The uid to look up in $table
759 * @param boolean If checkPage is set, it's also required that the page on which the record resides is accessible
760 * @return mixed Returns array (the record) if OK, otherwise blank/0 (zero)
761 */
762 function checkRecord($table,$uid,$checkPage=0) {
763 global $TCA;
764 $uid=intval($uid);
765 if (is_array($TCA[$table])) {
766 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $table, 'uid='.intval($uid).$this->enableFields($table));
767 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
768 $this->versionOL($table,$row);
769 $GLOBALS['TYPO3_DB']->sql_free_result($res);
770
771 if (is_array($row)) {
772 if ($checkPage) {
773 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'uid='.intval($row['pid']).$this->enableFields('pages'));
774 if ($GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
775 return $row;
776 } else {
777 return 0;
778 }
779 } else {
780 return $row;
781 }
782 }
783 }
784 }
785 }
786
787 /**
788 * Returns record no matter what - except if record is deleted
789 *
790 * @param string The table name to search
791 * @param integer The uid to look up in $table
792 * @param string The fields to select, default is "*"
793 * @param boolean If set, no version overlay is applied
794 * @return mixed Returns array (the record) if found, otherwise blank/0 (zero)
795 * @see getPage_noCheck()
796 */
797 function getRawRecord($table,$uid,$fields='*',$noWSOL=FALSE) {
798 global $TCA;
799 $uid = intval($uid);
800 if (is_array($TCA[$table]) || $table=='pages') { // Excluding pages here so we can ask the function BEFORE TCA gets initialized. Support for this is followed up in deleteClause()...
801 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($fields, $table, 'uid='.intval($uid).$this->deleteClause($table));
802 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
803 if (!$noWSOL) {
804 $this->versionOL($table,$row);
805 }
806 if (is_array($row)) return $row;
807 }
808 }
809 }
810
811 /**
812 * Selects records based on matching a field (ei. other than UID) with a value
813 *
814 * @param string The table name to search, eg. "pages" or "tt_content"
815 * @param string The fieldname to match, eg. "uid" or "alias"
816 * @param string The value that fieldname must match, eg. "123" or "frontpage"
817 * @param string Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
818 * @param string Optional GROUP BY field(s), if none, supply blank string.
819 * @param string Optional ORDER BY field(s), if none, supply blank string.
820 * @param string Optional LIMIT value ([begin,]max), if none, supply blank string.
821 * @return mixed Returns array (the record) if found, otherwise blank/0 (zero)
822 */
823 function getRecordsByField($theTable,$theField,$theValue,$whereClause='',$groupBy='',$orderBy='',$limit='') {
824 global $TCA;
825 if (is_array($TCA[$theTable])) {
826 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
827 '*',
828 $theTable,
829 $theField.'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($theValue, $theTable).
830 $this->deleteClause($theTable).' '.
831 $whereClause, // whereClauseMightContainGroupOrderBy
832 $groupBy,
833 $orderBy,
834 $limit
835 );
836 $rows = array();
837 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
838 #$this->versionOL($theTable,$row); // not used since records here are fetched based on other fields than uid!
839 if (is_array($row)) $rows[] = $row;
840 }
841 $GLOBALS['TYPO3_DB']->sql_free_result($res);
842 if (count($rows)) return $rows;
843 }
844 }
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859 /*********************************
860 *
861 * Caching and standard clauses
862 *
863 **********************************/
864
865 /**
866 * Returns string value stored for the hash string in the table "cache_hash"
867 * Can be used to retrieved a cached value
868 * Can be used from your frontend plugins if you like. Is also used to store the parsed TypoScript template structures. You can call it directly like t3lib_pageSelect::getHash()
869 *
870 * @param string The hash-string which was used to store the data value
871 * @param integer Allowed expiretime in seconds. Basically a record is selected only if it is not older than this value in seconds. If expTime is not set, the hashed value will never expire.
872 * @return string The "content" field of the "cache_hash" table row.
873 * @see tslib_TStemplate::start(), storeHash()
874 */
875 function getHash($hash,$expTime=0) {
876 //
877 $expTime = intval($expTime);
878 if ($expTime) {
879 $whereAdd = ' AND tstamp > '.(time()-$expTime);
880 }
881 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('content', 'cache_hash', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($hash, 'cache_hash').$whereAdd);
882 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
883 $GLOBALS['TYPO3_DB']->sql_free_result($res);
884 return $row['content'];
885 }
886 }
887
888 /**
889 * Stores a string value in the cache_hash table identified by $hash.
890 * Can be used from your frontend plugins if you like. You can call it directly like t3lib_pageSelect::storeHash()
891 *
892 * @param string 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
893 * @param string The data string. If you want to store an array, then just serialize it first.
894 * @param string $ident is just a textual identification in order to inform about the content! May be 20 characters long.
895 * @return void
896 * @see tslib_TStemplate::start(), getHash()
897 */
898 function storeHash($hash,$data,$ident) {
899 $insertFields = array(
900 'hash' => $hash,
901 'content' => $data,
902 'ident' => $ident,
903 'tstamp' => time()
904 );
905 $GLOBALS['TYPO3_DB']->exec_DELETEquery('cache_hash', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($hash, 'cache_hash'));
906 $GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_hash', $insertFields);
907 }
908
909 /**
910 * Returns the "AND NOT deleted" clause for the tablename given IF $TCA configuration points to such a field.
911 *
912 * @param string Tablename
913 * @return string
914 * @see enableFields()
915 */
916 function deleteClause($table) {
917 global $TCA;
918 if (!strcmp($table,'pages')) { // Hardcode for pages because TCA might not be loaded yet (early frontend initialization)
919 return ' AND pages.deleted=0';
920 } else {
921 return $TCA[$table]['ctrl']['delete'] ? ' AND '.$table.'.'.$TCA[$table]['ctrl']['delete'].'=0' : '';
922 }
923 }
924
925 /**
926 * Returns a part of a WHERE clause which will filter out records with start/end times or hidden/fe_groups fields set to values that should de-select them according to the current time, preview settings or user login. Definitely a frontend function.
927 * Is using the $TCA arrays "ctrl" part where the key "enablefields" determines for each table which of these features applies to that table.
928 *
929 * @param string Table name found in the $TCA array
930 * @param integer If $show_hidden is set (0/1), any hidden-fields in records are ignored. NOTICE: If you call this function, consider what to do with the show_hidden parameter. Maybe it should be set? See tslib_cObj->enableFields where it's implemented correctly.
931 * @param array Array you can pass where keys can be "disabled", "starttime", "endtime", "fe_group" (keys from "enablefields" in TCA) and if set they will make sure that part of the clause is not added. Thus disables the specific part of the clause. For previewing etc.
932 * @param boolean If set, enableFields will be applied regardless of any versioning preview settings which might otherwise disable enableFields
933 * @return string The clause starting like " AND ...=... AND ...=..."
934 * @see tslib_cObj::enableFields(), deleteClause()
935 */
936 function enableFields($table,$show_hidden=-1,$ignore_array=array(),$noVersionPreview=FALSE) {
937 global $TYPO3_CONF_VARS;
938
939 if ($show_hidden==-1 && is_object($GLOBALS['TSFE'])) { // If show_hidden was not set from outside and if TSFE is an object, set it based on showHiddenPage and showHiddenRecords from TSFE
940 $show_hidden = $table=='pages' ? $GLOBALS['TSFE']->showHiddenPage : $GLOBALS['TSFE']->showHiddenRecords;
941 }
942 if ($show_hidden==-1) $show_hidden=0; // If show_hidden was not changed during the previous evaluation, do it here.
943
944 $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
945 $query='';
946 if (is_array($ctrl)) {
947
948 // Delete field check:
949 if ($ctrl['delete']) {
950 $query.=' AND '.$table.'.'.$ctrl['delete'].'=0';
951 }
952
953 // Filter out new place-holder records in case we are NOT in a versioning preview (that means we are online!)
954 if ($ctrl['versioningWS'] && !$this->versioningPreview) {
955 $query.=' AND '.$table.'.t3ver_state!=1'; // Shadow state for new items MUST be ignored!
956 }
957
958 // Enable fields:
959 if (is_array($ctrl['enablecolumns'])) {
960 if (!$this->versioningPreview || !$ctrl['versioningWS'] || $noVersionPreview) { // In case of versioning-preview, enableFields are ignored (checked in versionOL())
961 if ($ctrl['enablecolumns']['disabled'] && !$show_hidden && !$ignore_array['disabled']) {
962 $field = $table.'.'.$ctrl['enablecolumns']['disabled'];
963 $query.=' AND '.$field.'=0';
964 }
965 if ($ctrl['enablecolumns']['starttime'] && !$ignore_array['starttime']) {
966 $field = $table.'.'.$ctrl['enablecolumns']['starttime'];
967 $query.=' AND ('.$field.'<='.$GLOBALS['SIM_EXEC_TIME'].')';
968 }
969 if ($ctrl['enablecolumns']['endtime'] && !$ignore_array['endtime']) {
970 $field = $table.'.'.$ctrl['enablecolumns']['endtime'];
971 $query.=' AND ('.$field.'=0 OR '.$field.'>'.$GLOBALS['SIM_EXEC_TIME'].')';
972 }
973 if ($ctrl['enablecolumns']['fe_group'] && !$ignore_array['fe_group']) {
974 $field = $table.'.'.$ctrl['enablecolumns']['fe_group'];
975 $query.= t3lib_pageSelect::getMultipleGroupsWhereClause($field, $table);
976 }
977
978 // Call hook functions for additional enableColumns
979 // It is used by the extension ingmar_accessctrl which enables assigning more than one usergroup to content and page records
980 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_page.php']['addEnableColumns'])) {
981 $_params = array(
982 'table' => $table,
983 'show_hidden' => $show_hidden,
984 'ignore_array' => $ignore_array,
985 'ctrl' => $ctrl
986 );
987 foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_page.php']['addEnableColumns'] as $_funcRef) {
988 $query .= t3lib_div::callUserFunction($_funcRef,$_params,$this);
989 }
990 }
991 }
992 }
993 } else {
994 die ('NO entry in the $TCA-array for the table "'.$table.'". This means that the function enableFields() is called with an invalid table name as argument.');
995 }
996
997 return $query;
998 }
999
1000 /**
1001 * Creating where-clause for checking group access to elements in enableFields function
1002 *
1003 * @param string Field with group list
1004 * @param string Table name
1005 * @return string AND sql-clause
1006 * @see enableFields()
1007 */
1008 function getMultipleGroupsWhereClause($field, $table) {
1009 $memberGroups = t3lib_div::intExplode(',',$GLOBALS['TSFE']->gr_list);
1010 $orChecks=array();
1011 $orChecks[]=$field.'=\'\''; // If the field is empty, then OK
1012 $orChecks[]=$field.'=\'0\''; // If the field contsains zero, then OK
1013
1014 foreach($memberGroups as $value) {
1015 $orChecks[] = $GLOBALS['TYPO3_DB']->listQuery($field, $value, $table);
1016 }
1017
1018 return ' AND ('.implode(' OR ',$orChecks).')';
1019 }
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035 /*********************************
1036 *
1037 * Versioning Preview
1038 *
1039 **********************************/
1040
1041 /**
1042 * Finding online PID for offline version record
1043 * ONLY active when backend user is previewing records. MUST NEVER affect a site served which is not previewed by backend users!!!
1044 * Will look if the "pid" value of the input record is -1 (it is an offline version) and if the table supports versioning; if so, it will translate the -1 PID into the PID of the original record
1045 * Used whenever you are tracking something back, like making the root line.
1046 * Principle; Record offline! => Find online?
1047 *
1048 * @param string Table name
1049 * @param array Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
1050 * @return void (Passed by ref).
1051 * @see t3lib_BEfunc::fixVersioningPid(), versionOL(), getRootLine()
1052 */
1053 function fixVersioningPid($table,&$rr) {
1054 global $TCA;
1055
1056 if ($this->versioningPreview && is_array($rr) && $rr['pid']==-1 && ($table=='pages' || $TCA[$table]['ctrl']['versioningWS'])) { // Have to hardcode it for "pages" table since TCA is not loaded at this moment!
1057
1058 // Check values for t3ver_oid and t3ver_wsid:
1059 if (isset($rr['t3ver_oid']) && isset($rr['t3ver_wsid'])) { // If "t3ver_oid" is already a field, just set this:
1060 $oid = $rr['t3ver_oid'];
1061 $wsid = $rr['t3ver_wsid'];
1062 } else { // Otherwise we have to expect "uid" to be in the record and look up based on this:
1063 $newPidRec = $this->getRawRecord($table,$rr['uid'],'t3ver_oid,t3ver_wsid',TRUE);
1064 if (is_array($newPidRec)) {
1065 $oid = $newPidRec['t3ver_oid'];
1066 $wsid = $newPidRec['t3ver_wsid'];
1067 }
1068 }
1069
1070 // If workspace ids matches and ID of current online version is found, look up the PID value of that:
1071 if ($oid && !strcmp((int)$wsid,$this->versioningWorkspaceId)) {
1072 $oidRec = $this->getRawRecord($table,$oid,'pid',TRUE);
1073
1074 if (is_array($oidRec)) {
1075 # 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!
1076 $rr['_ORIG_pid'] = $rr['pid'];
1077 $rr['pid'] = $oidRec['pid'];
1078 }
1079 }
1080 }
1081 }
1082
1083 /**
1084 * Versioning Preview Overlay
1085 * ONLY active when backend user is previewing records. MUST NEVER affect a site served which is not previewed by backend users!!!
1086 * Generally ALWAYS used when records are selected based on uid or pid. If records are selected on other fields than uid or pid (eg. "email = ....") then usage might produce undesired results and that should be evaluated on individual basis.
1087 * Principle; Record online! => Find offline?
1088 *
1089 * @param string Table name
1090 * @param array Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_state" fields must exist! The record MAY be set to FALSE in which case the calling function should act as if the record is forbidden to access!
1091 * @return void (Passed by ref).
1092 * @see fixVersioningPid(), t3lib_BEfunc::workspaceOL()
1093 */
1094 function versionOL($table,&$row) {
1095 global $TCA;
1096
1097 if ($this->versioningPreview && is_array($row)) {
1098 if ($wsAlt = $this->getWorkspaceVersionOfRecord($this->versioningWorkspaceId, $table, $row['uid'], implode(',',array_keys($row)))) { // implode(',',array_keys($row)) = Using fields from original record to make sure no additional fields are selected. This is best for eg. getPageOverlay()
1099 if (is_array($wsAlt)) {
1100
1101 // Always fix PID (like in fixVersioningPid() above). [This is usually not the important factor for versioning OL]
1102 $wsAlt['_ORIG_pid'] = $wsAlt['pid']; // Keep the old (-1) - indicates it was a version...
1103 $wsAlt['pid'] = $row['pid']; // Set in the online versions PID.
1104
1105 // "element" and "page" type versions:
1106 // For versions of single elements or page+content, preserve online UID and PID (this will produce true "overlay" of element _content_, not any references)
1107 // For page+content the "_ORIG_uid" should actually be used as PID for selection of tables with "versioning_followPages" enabled.
1108 if ($table!=='pages' || $wsAlt['t3ver_swapmode']<=0) {
1109 $wsAlt['_ORIG_uid'] = $wsAlt['uid'];
1110 $wsAlt['uid'] = $row['uid'];
1111
1112 // Translate page alias as well so links are pointing to the _online_ page:
1113 if ($table==='pages') {
1114 $wsAlt['alias'] = $row['alias'];
1115 }
1116 } else {
1117 // "branch" versions:
1118 // Keeping overlay uid and pid so references are changed. This is only for page-versions with BRANCH below!
1119 $wsAlt['_ONLINE_uid'] = $row['uid']; // The UID of the versionized record is kept and the uid of the online version is stored
1120 }
1121
1122 // Changing input record to the workspace version alternative:
1123 $row = $wsAlt;
1124
1125 // Check if it is deleted in workspace:
1126 if ((int)$row['t3ver_state']===2) {
1127 $row = FALSE; // Unset record if it turned out to be deleted in workspace
1128 }
1129 } else {
1130 // No version found, then check if t3ver_state =1 (online version is dummy-representation)
1131 if ($wsAlt==-1 || (int)$row['t3ver_state']===1) {
1132 $row = FALSE; // Unset record if it turned out to be "hidden"
1133 }
1134 }
1135 }
1136 }
1137 }
1138
1139 /**
1140 * Select the version of a record for a workspace
1141 *
1142 * @param integer Workspace ID
1143 * @param string Table name to select from
1144 * @param integer Record uid for which to find workspace version.
1145 * @param string Field list to select
1146 * @return array If found, return record, otherwise false. Returns 1 if version was sought for but not found, returns -1 if record existed but had enableFields that would disable it.
1147 * @see t3lib_befunc::getWorkspaceVersionOfRecord()
1148 */
1149 function getWorkspaceVersionOfRecord($workspace, $table, $uid, $fields='*') {
1150 global $TCA;
1151
1152 if ($workspace!==0 && ($table=='pages' || $TCA[$table]['ctrl']['versioningWS'])) { // Have to hardcode it for "pages" table since TCA is not loaded at this moment!
1153
1154 // Setting up enableFields for version record:
1155 if ($table=='pages') {
1156 $enFields = $this->versioningPreview_where_hid_del;
1157 } else {
1158 $enFields = $this->enableFields($table,-1,array(),TRUE);
1159 }
1160
1161 // Select workspace version of record, only testing for deleted.
1162 list($newrow) = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
1163 $fields,
1164 $table,
1165 'pid=-1 AND
1166 t3ver_oid='.intval($uid).' AND
1167 t3ver_wsid='.intval($workspace).
1168 $this->deleteClause($table)
1169 );
1170
1171 // If version found, check if it could have been selected with enableFields on as well:
1172 if (is_array($newrow)) {
1173 if ($GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
1174 'uid',
1175 $table,
1176 'pid=-1 AND
1177 t3ver_oid='.intval($uid).' AND
1178 t3ver_wsid='.intval($workspace).
1179 $enFields
1180 )) {
1181 return $newrow; // Return offline version, tested for its enableFields.
1182 } else {
1183 return -1; // Return -1 because version was de-selected due to its enableFields.
1184 }
1185 } else {
1186 // OK, so no workspace version was found. Then check if online version can be selected with full enable fields and if so, return 1:
1187 if ($GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
1188 'uid',
1189 $table,
1190 'uid='.intval($uid).$enFields
1191 )) {
1192 return 1; // Means search was done, but no version found.
1193 } else {
1194 return -1; // Return -1 because the current record was de-selected due to its enableFields.
1195 }
1196 }
1197 }
1198
1199 return FALSE; // No look up in database because versioning not enabled / or workspace not offline
1200 }
1201 }
1202
1203
1204
1205 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_page.php']) {
1206 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_page.php']);
1207 }
1208 ?>