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