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