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