* Fixed SSL problem and many other minor things
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / class.tslib_fe.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasper@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 * Class for the built TypoScript based Front End
29 *
30 * This class has a lot of functions and internal variable which are use from index_ts.php.
31 * The class is instantiated as $GLOBALS['TSFE'] in index_ts.php.
32 * The use of this class should be inspired by the order of function calls as found in index_ts.php.
33 *
34 * $Id$
35 * Revised for TYPO3 3.6 June/2003 by Kasper Skaarhoj
36 * XHTML compliant
37 *
38 * @author Kasper Skaarhoj <kasper@typo3.com>
39 */
40 /**
41 * [CLASS/FUNCTION INDEX of SCRIPT]
42 *
43 *
44 *
45 * 178: class tslib_fe
46 * 332: function tslib_fe($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='',$MP='',$RDCT='')
47 * 362: function connectToMySQL()
48 * 398: function sendRedirect()
49 *
50 * SECTION: Initializing, resolving page id
51 * 436: function initFEuser()
52 * 490: function checkAlternativeIdMethods()
53 * 543: function clear_preview()
54 * 556: function determineId()
55 * 637: function fetch_the_id()
56 * 743: function getPageAndRootline()
57 * 805: function getPageShortcut($SC,$mode,$thisUid,$itera=20,$pageLog=array())
58 * 850: function checkRootlineForIncludeSection()
59 * 883: function checkEnableFields($row)
60 * 901: function checkPagerecordForIncludeSection($row)
61 * 913: function setIDfromArgV()
62 * 929: function getPageAndRootlineWithDomain($domainStartPage)
63 * 957: function findDomainRecord($recursive=0)
64 * 978: function pageNotFoundHandler($code,$header='')
65 * 1000: function checkAndSetAlias()
66 * 1015: function idPartsAnalyze($str)
67 * 1040: function mergingWithGetVars($GET_VARS)
68 *
69 * SECTION: Template and caching related functions.
70 * 1088: function makeCacheHash()
71 * 1110: function cHashParams($addQueryParams)
72 * 1131: function initTemplate()
73 * 1143: function getFromCache()
74 * 1201: function getHash()
75 * 1220: function getConfigArray()
76 *
77 * SECTION: Further initialization and data processing
78 * 1334: function getCompressedTCarray()
79 * 1371: function includeTCA($TCAloaded=1)
80 * 1397: function settingLanguage()
81 * 1437: function checkDataSubmission()
82 * 1464: function fe_tce()
83 * 1478: function locDataCheck($locationData)
84 * 1494: function sendFormmail()
85 * 1512: function checkJumpUrl()
86 * 1594: function jumpUrl()
87 * 1637: function setUrlIdToken()
88 *
89 * SECTION: Page generation; cache handling
90 * 1680: function isGeneratePage()
91 * 1690: function tempPageCacheContent()
92 * 1721: function realPageCacheContent()
93 * 1743: function setPageCacheContent($c,$d,$t)
94 * 1766: function clearPageCacheContent()
95 * 1776: function clearPageCacheContent_pidList($pidList)
96 * 1787: function setSysLastChanged()
97 *
98 * SECTION: Page generation; rendering and inclusion
99 * 1823: function generatePage_preProcessing()
100 * 1859: function generatePage_whichScript()
101 * 1871: function generatePage_postProcessing()
102 * 1929: function INTincScript()
103 * 1987: function INTincScript_loadJSCode()
104 * 2028: function isINTincScript()
105 * 2037: function isSearchIndexPage()
106 * 2046: function doXHTML_cleaning()
107 *
108 * SECTION: Finished off; outputting, storing session data, statistics...
109 * 2078: function isOutputting()
110 * 2089: function processOutput()
111 * 2141: function isEXTincScript()
112 * 2150: function storeSessionData()
113 * 2160: function setParseTime()
114 * 2172: function statistics()
115 * 2266: function previewInfo()
116 * 2287: function beLoginLinkIPList()
117 *
118 * SECTION: Various internal API functions
119 * 2342: function makeSimulFileName($inTitle,$page,$type,$addParams='',$no_cache='')
120 * 2389: function simulateStaticDocuments_pEnc_onlyP_proc($linkVars)
121 * 2417: function getSimulFileName()
122 * 2430: function encryptEmail($string,$back=0)
123 * 2447: function checkFileInclude($incFile)
124 * 2462: function newCObj()
125 * 2475: function setAbsRefPrefix()
126 * 2491: function printError($label,$header='Error!')
127 * 2502: function updateMD5paramsRecord($hash)
128 * 2513: function tidyHTML($content)
129 *
130 * SECTION: Various external API functions - for use in plugins etc.
131 * 2574: function getStorageSiterootPids()
132 * 2589: function getPagesTSconfig()
133 * 2622: function setJS($key,$content='')
134 * 2660: function setCSS($key,$content)
135 * 2675: function make_seed()
136 * 2688: function uniqueHash($str='')
137 * 2697: function set_no_cache()
138 * 2707: function set_cache_timeout_default($seconds)
139 * 2723: function plainMailEncoded($email,$subject,$message,$headers='')
140 * 2746: function sL($input)
141 * 2783: function csConv($str,$from='')
142 * 2802: function readLLfile($fileRef)
143 * 2817: function getLLL($index,$LOCAL_LANG)
144 * 2831: function initLLvars()
145 *
146 * TOTAL FUNCTIONS: 83
147 * (This index is automatically created/updated by the extension "extdeveval")
148 *
149 */
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171 /**
172 * Main frontend class, instantiated in the index_ts.php script as the global object TSFE
173 *
174 * @author Kasper Skaarhoj <kasper@typo3.com>
175 * @package TYPO3
176 * @subpackage tslib
177 */
178 class tslib_fe {
179
180 // CURRENT PAGE:
181 var $id=''; // The page id (int)
182 var $type=''; // RO The type (int)
183 var $idParts=array(); // Loaded with the id, exploded by ','
184 var $cHash=''; // The submitted cHash
185 var $no_cache=''; // Page will not be cached. Write only true. Never clear value (some other code might have reasons to set it true)
186 var $rootLine=''; // The rootLine (all the way to tree root, not only the current site!) (array)
187 var $page=''; // The pagerecord (array)
188 var $contentPid=0; // This will normally point to the same value as id, but can be changed to point to another page from which content will then be displayed instead.
189 var $sys_page=''; // The object with pagefunctions (object)
190 var $jumpurl='';
191 var $pageNotFound=0; // Is set to 1 if a pageNotFound handler could have been called.
192 var $domainStartPage=0; // Domain start page
193 var $MP='';
194 var $RDCT='';
195 var $page_cache_reg1=0; // This can be set from applications as a way to tag cached versions of a page and later perform some external cache management, like clearing only a part of the cache of a page...
196 var $siteScript=''; // Contains the value of the current script path that activated the frontend. Typically "index.php" but by rewrite rules it could be something else! Used for Speaking Urls / Simulate Static Documents.
197
198 // USER
199 var $fe_user=''; // The user (object)
200 var $loginUser=''; // Global falg indicating that a front-end user is logged in. This is set only if a user really IS logged in. The group-list may show other groups (like added by IP filter or so) even though there is no user.
201 var $gr_list=''; // (RO=readonly) The group list, sorted numerically. Group '0,-1' is the default group, but other groups may be added by other means than a user being logged in though...
202 var $beUserLogin=''; // Flag that indicates if a Backend user is logged in!
203
204 // PREVIEW
205 var $fePreview=''; // Flag indication that preview is active. This is based on the login of a backend user and whether the backend user has read access to the current page.
206 var $showHiddenPage=''; // Flag indicating that hidden pages should be shown, selected and so on. This goes for almost all selection of pages!
207 var $showHiddenRecords=''; // Flag indicating that hidden records should be shown. This includes sys_template, pages_language_overlay and even fe_groups in addition to all other regular content. So in effect, this includes everything except pages.
208 var $simUserGroup='0'; // Value that contains the simulated usergroup if any
209
210 // CONFIGURATION
211 var $TYPO3_CONF_VARS=array(); // The configuration array as set up in t3lib/config_default.php. Should be an EXACT copy of the global array.
212 var $config=''; // 'CONFIG' object from TypoScript. Array generated based on the TypoScript configuration of the current page. Saved with the cached pages.
213
214 // TEMPLATE / CACHE
215 var $tmpl=''; // The TypoScript template object. Used to parse the TypoScript template
216 var $cacheTimeOutDefault=''; // Is set to the time-to-live time of cached pages. If false, default is 60*60*24, which is 24 hours.
217 var $cacheContentFlag=''; // Set internally if cached content is fetched from the database
218 var $all=''; // $all used by template fetching system. This array is an identification of the template. If $this->all is empty it's because the template-data is not cached, which it must be.
219 var $sPre=''; // toplevel - objArrayName, eg 'page'
220 var $pSetup=''; // TypoScript configuration of the page-object pointed to by sPre. $this->tmpl->setup[$this->sPre.'.']
221 var $newHash=''; // This hash is unique to the template, the $this->id and $this->type vars and the gr_list (list of groups). Used to get and later store the cached data
222 var $getMethodUrlIdToken=''; // If config.ftu (Frontend Track User) is set in TypoScript for the current page, the string value of this var is substituted in the rendered source-code with the string, '&ftu=[token...]' which enables GET-method usertracking as opposed to cookie based
223 var $noCacheBeforePageGen=''; // This flag is set before inclusion of pagegen.php IF no_cache is set. If this flag is set after the inclusion of pagegen.php, no_cache is forced to be set. This is done in order to make sure that php-code from pagegen does not falsely clear the no_cache flag.
224 var $tempContent=''; // This flag indicates if temporary content went into the cache during page-generation.
225 var $forceTemplateParsing=''; // Boolean, passed to TypoScript template class and tells it to render the template forcibly
226 var $cHash_array=array(); // The array which cHash_calc is based on, see ->makeCacheHash().
227 var $hash_base=''; // Loaded with the serialized array that is used for generating a hashstring for the cache
228 var $pagesTSconfig=''; // May be set to the pagesTSconfig
229 // PAGE-GENERATION / cOBJ
230 /*
231 Eg. insert JS-functions in this array ($additionalHeaderData) to include them once. Use associative keys.
232 Keys in use:
233 JSFormValidate : <script type="text/javascript" src="'.$GLOBALS["TSFE"]->absRefPrefix.'t3lib/jsfunc.validateform.js"></script>
234 JSincludeFormupdate : <script type="text/javascript" src="t3lib/jsfunc.updateform.js"></script>
235 JSMenuCode, JSMenuCode_menu : JavaScript for the JavaScript menu
236 JSCode : reserved
237 JSImgCode : reserved
238 */
239 var $defaultBodyTag='<body bgcolor="#FFFFFF">'; // Default bodytag, if nothing else is set. This can be overridden by applications like TemplaVoila.
240 var $additionalHeaderData=array(); // used to accumulate additional HTML-code for the header-section, <head>...</head>. Insert either associative keys (like additionalHeaderData['myStyleSheet'], see reserved keys above) or num-keys (like additionalHeaderData[] = '...')
241 var $additionalJavaScript=array(); // used to accumulate additional JavaScript-code. Works like additionalHeaderData. Reserved keys at 'openPic' and 'mouseOver'
242 var $additionalCSS=array(); // used to accumulate additional Style code. Works like additionalHeaderData.
243 var $JSeventFuncCalls = array( // you can add JavaScript functions to each entry in these arrays. Please see how this is done in the GMENU_LAYERS script. The point is that many applications on a page can set handlers for onload, onmouseover and onmouseup
244 'onmousemove' => array(),
245 'onmouseup' => array(),
246 'onload' => array(),
247 );
248 var $JSCode=''; // Depreciated, use additionalJavaScript instead.
249 var $JSImgCode=''; // Used to accumulate JavaScript loaded images (by menus)
250 var $divSection=''; // Used to accumulate DHTML-layers.
251
252 // RENDERING configuration, settings from TypoScript is loaded into these vars. See pagegen.php
253 var $debug=''; // Debug flag, may output special debug html-code.
254 var $intTarget=''; // Default internal target
255 var $extTarget=''; // Default external target
256 var $MP_defaults=array(); // Keys are page ids and values are default &MP (mount point) values to set when using the linking features...)
257 var $spamProtectEmailAddresses=0; // If set, typolink() function encrypts email addresses. Is set in pagegen-class.
258 var $absRefPrefix=''; // Absolute Reference prefix
259 var $absRefPrefix_force=0; // Absolute Reference prefix force flag. This is set, if the type and id is retrieve from PATH_INFO and thus we NEED to prefix urls with at least '/'
260 var $compensateFieldWidth=''; // Factor for form-field widths compensation
261 var $lockFilePath=''; // Lock file path
262 var $ATagParams=''; // <A>-tag parameters
263 var $sWordRegEx=''; // Search word regex, calculated if there has been search-words send. This is used to mark up the found search words on a page when jumped to from a link in a search-result.
264 var $sWordList=''; // Is set to the incoming array sword_list in case of a page-view jumped to from a search-result.
265 var $linkVars=''; // A string prepared for insertion in all links on the page as url-parameters. Based on configuration in TypoScript where you defined which GET_VARS you would like to pass on.
266 var $excludeCHashVars=''; // A string set with a comma list of additional GET vars which should NOT be included in the cHash calculation. These vars should otherwise be detected and involved in caching, eg. through a condition in TypoScript.
267 var $displayEditIcons=''; // If set, edit icons are rendered aside content records. Must be set only if the ->beUserLogin flag is set and set_no_cache() must be called as well.
268 var $displayFieldEditIcons=''; // If set, edit icons are rendered aside individual fields of content. Must be set only if the ->beUserLogin flag is set and set_no_cache() must be called as well.
269 var $sys_language_uid=0; // Site language, 0 (zero) is default, int+ is uid pointing to a sys_language record.
270 var $sys_language_isocode = ''; // Is set to the iso code of the sys_language if that is properly defined by the sys_language record representing the sys_language_uid. (Requires the extension "static_info_tables")
271
272 // RENDERING data
273 var $applicationData=Array(); // 'Global' Storage for various applications. Keys should be 'tx_'.extKey for extensions.
274 var $register=Array();
275 var $registerStack=Array(); // Stack used for storing array and retrieving register arrays (see LOAD_REGISTER and CLEAR_REGISTER)
276 var $cObjectDepthCounter = 50; // Checking that the function is not called eternally. This is done by interrupting at a depth of 50
277 var $recordRegister = Array(); // used by cObj->RECORDS and cObj->CONTENT to ensure the a records is NOT rendered twice through it!
278 var $currentRecord = ''; // This is set to the [table]:[uid] of the latest record rendered. Note that class tslib_cObj has an equal value, but that is pointing to the record delivered in the $data-array of the tslib_cObj instance, if the cObjects CONTENT or RECORD created that instance
279 var $accessKey =array(); // Used by class tslib_menu to keep track of access-keys.
280 var $imagesOnPage=array(); // Numerical array where image filenames are added if they are referenced in the rendered document. This includes only TYPO3 generated/inserted images.
281 var $lastImageInfo=array(); // Is set in tslib_cObj->cImage() function to the info-array of the most recent rendered image. The information is used in tslib_cObj->IMGTEXT
282 var $uniqueCounter=0; // Used to generate page-unique keys. Point is that uniqid() functions is very slow, so a unikey key is made based on this, see function uniqueHash()
283 var $uniqueString='';
284 var $indexedDocTitle=''; // This value will be used as the title for the page in the indexer (if indexing happens)
285 var $altPageTitle=''; // Alternative page title (normally the title of the page record). Can be set from applications you make.
286 var $pEncAllowedParamNames=array(); // An array that holds parameter names (keys) of GET parameters which MAY be MD5/base64 encoded with simulate_static_documents method.
287
288 // Page content render object
289 var $cObj =''; // is instantiated object of tslib_cObj
290
291 // Character set (charset) conversion object:
292 var $csConvObj; // An instance of the "t3lib_cs" class. May be used by any application.
293 var $defaultCharSet='iso-8859-1'; // The default charset used in the frontend if nothing else is set.
294
295 // CONTENT accumulation
296 var $content=''; // All page content is accumulated in this variable. See pagegen.php
297
298 // GENERAL
299 var $clientInfo=''; // Set to the browser: net / msie if 4+ browsers
300 var $scriptParseTime=0;
301 var $TCAloaded = 0; // Set ONLY if the full TCA is loaded
302
303 // LANG:
304 var $lang=''; // Set to the system language key (used on the site)
305 var $langSplitIndex=0; // Set to the index number of the language key
306 var $labelsCharset=''; // Charset of the labels from locallang (based on $this->lang)
307 var $siteCharset=''; // Charset of the website.
308 var $convCharsetToFrom=''; // Set to the charsets to convert from/to IF there are any difference. Otherwise this stays a string
309 var $LL_labels_cache=array();
310 var $LL_files_cache=array();
311
312
313
314
315
316 /**
317 * Class constructor
318 * Takes a number of GET/POST input variable as arguments and stores them internally.
319 * The processing of these variables goes on later in this class.
320 * Also sets internal clientInfo array (browser information) and a unique string (->uniqueString) for this script instance; A md5 hash of the microtime()
321 *
322 * @param array The global $TYPO3_CONF_VARS array. Will be set internally in ->TYPO3_CONF_VARS
323 * @param mixed The value of t3lib_div::_GP('id')
324 * @param integer The value of t3lib_div::_GP('type')
325 * @param boolean The value of t3lib_div::_GP('no_cache'), evaluated to 1/0
326 * @param string The value of t3lib_div::_GP('cHash')
327 * @param string The value of t3lib_div::_GP('jumpurl')
328 * @param string The value of t3lib_div::_GP('MP')
329 * @param string The value of t3lib_div::_GP('RDCT')
330 * @return void
331 * @see index_ts.php
332 */
333 function tslib_fe($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='',$MP='',$RDCT='') {
334
335 // Setting some variables:
336 $this->TYPO3_CONF_VARS = $TYPO3_CONF_VARS;
337 $this->id = $id;
338 $this->type = $type;
339 $this->no_cache = $no_cache ? 1 : 0;
340 $this->cHash = $cHash;
341 $this->jumpurl = $jumpurl;
342 $this->MP = $this->TYPO3_CONF_VARS['FE']['enable_mount_pids'] ? $MP : '';
343 $this->RDCT = $RDCT;
344 $this->clientInfo = t3lib_div::clientInfo();
345 $this->uniqueString=md5(microtime());
346
347 $this->csConvObj = t3lib_div::makeInstance('t3lib_cs');
348
349 // Call post processing function for constructor:
350 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'])) {
351 $_params = array('pObj' => &$this);
352 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'] as $_funcRef) {
353 t3lib_div::callUserFunction($_funcRef,$_params,$this);
354 }
355 }
356 }
357
358 /**
359 * Connect to SQL database
360 * May exit after outputting an error message or some JavaScript redirecting to the install tool.
361 *
362 * @return void
363 */
364 function connectToMySQL() {
365 if ($GLOBALS['TYPO3_DB']->sql_pconnect(TYPO3_db_host, TYPO3_db_username, TYPO3_db_password)) {
366 if (!TYPO3_db) {
367 $this->printError('No database selected','Database Error');
368 // Redirects to the Install Tool:
369 echo '<script type="text/javascript">
370 /*<![CDATA[*/
371 document.location = "'.TYPO3_mainDir.'install/index.php?mode=123&step=1&password=joh316";
372 /*]]>*/
373 </script>';
374 exit;
375 } elseif (!$GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db)) {
376 $this->printError('Cannot connect to the current database, "'.TYPO3_db.'"','Database Error');
377 exit;
378 }
379 } else {
380 if (!TYPO3_db) {
381 // Redirects to the Install Tool:
382 echo '<script type="text/javascript">
383 /*<![CDATA[*/
384 document.location = "'.TYPO3_mainDir.'install/index.php?mode=123&step=1&password=joh316";
385 /*]]>*/
386 </script>';
387 exit;
388 }
389 $this->printError('The current username, password or host was not accepted when the connection to the database was attempted to be established!','Database Error');
390 exit;
391 }
392 }
393
394 /**
395 * Looks up the value of $this->RDCT in the database and if it is found to be associated with a redirect URL then the redirection is carried out with a 'Location:' header
396 * May exit after sending a location-header.
397 *
398 * @return void
399 */
400 function sendRedirect() {
401 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('params', 'cache_md5params', 'md5hash="'.$GLOBALS['TYPO3_DB']->quoteStr($this->RDCT, 'cache_md5params').'"');
402 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
403 $this->updateMD5paramsRecord($this->RDCT);
404 header('Location: '.$row['params']);
405 exit;
406 }
407 }
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426 /********************************************
427 *
428 * Initializing, resolving page id
429 *
430 ********************************************/
431
432
433 /**
434 * Initializes the front-end login user.
435 *
436 * @return void
437 */
438 function initFEuser() {
439 $this->fe_user = t3lib_div::makeInstance('tslib_feUserAuth');
440
441 $this->fe_user->lockIP = $this->TYPO3_CONF_VARS['FE']['lockIP'];
442 $this->fe_user->checkPid = $this->TYPO3_CONF_VARS['FE']['checkFeUserPid'];
443 $this->fe_user->checkPid_value = $GLOBALS['TYPO3_DB']->cleanIntList(t3lib_div::_GP('pid')); // List of pid's acceptable
444
445 // Check if a session is transferred:
446 if (t3lib_div::_GP('FE_SESSION_KEY')) {
447 $fe_sParts = explode('-',t3lib_div::_GP('FE_SESSION_KEY'));
448 if (!strcmp(md5($fe_sParts[0].'/'.$this->TYPO3_CONF_VARS['SYS']['encryptionKey']), $fe_sParts[1])) { // If the session key hash check is OK:
449 $GLOBALS['HTTP_COOKIE_VARS'][$this->fe_user->name]=$fe_sParts[0];
450 $this->fe_user->forceSetCookie=1;
451 }
452 }
453
454 if ($this->TYPO3_CONF_VARS['FE']['dontSetCookie']) {
455 $this->fe_user->dontSetCookie=1;
456 }
457
458 $this->fe_user->start();
459 $this->fe_user->unpack_uc('');
460 $this->fe_user->fetchSessionData(); // Gets session data
461 $recs = t3lib_div::_GP('recs');
462 if (is_array($recs)) { // If any record registration is submitted, register the record.
463 $this->fe_user->record_registration($recs);
464 }
465
466 // For every 60 seconds the is_online timestamp is updated.
467 if (is_array($this->fe_user->user) && $this->fe_user->user['is_online']<($GLOBALS['EXEC_TIME']-60)) {
468 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('fe_users', 'uid='.intval($this->fe_user->user['uid']), array('is_online' => $GLOBALS['EXEC_TIME']));
469 }
470 }
471
472 /**
473 * Provides ways to bypass the '?id=[xxx]&type=[xx]' format, using either PATH_INFO or virtual HTML-documents (using Apache mod_rewrite)
474 *
475 * Two options:
476 * 1) Apache mod_rewrite: Here a .htaccess file maps all .html-files to index.php and then we extract the id and type from the name of that HTML-file.
477 * 2) Use PATH_INFO (also Apache) to extract id and type from that var. Does not require any special modules compiled with apache.
478 *
479 * Support for RewriteRule to generate (simulateStaticDocuments)
480 * With the mod_rewrite compiled into apache, put these lines into a .htaccess in this directory:
481 * RewriteEngine On
482 * RewriteRule ^[^/]*\.html$ index.php
483 * The url must end with '.html' and the format must comply with either of these:
484 * 1: '[title].[id].[type].html' - title is just for easy recognition in the logfile!; no practical use of the title for TYPO3.
485 * 2: '[id].[type].html' - above, but title is omitted; no practical use of the title for TYPO3.
486 * 3: '[id].html' - only id, type is set to the default, zero!
487 * NOTE: In all case 'id' may be the uid-number OR the page alias (if any)
488 *
489 * @return void
490 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&cHash=4ad9d7acb4
491 */
492 function checkAlternativeIdMethods() {
493
494 $this->siteScript = t3lib_div::getIndpEnv('TYPO3_SITE_SCRIPT');
495
496 // Resolving of "simulateStaticDocuments" URLs:
497 if ($this->siteScript && substr($this->siteScript,0,9)!='index.php') { // If there has been a redirect (basically; we arrived here otherwise than via "index.php" in the URL) this can happend either due to a CGI-script or because of reWrite rule. Earlier we used $GLOBALS['HTTP_SERVER_VARS']['REDIRECT_URL'] to check but
498 $uParts = parse_url($this->siteScript); // Parse the path:
499 $fI = t3lib_div::split_fileref($uParts['path']);
500
501 if (!$fI['path'] && $fI['file'] && substr($fI['file'],-5)=='.html') {
502 $parts = explode('.',$fI['file']);
503 $pCount = count($parts);
504 if ($pCount>2) {
505 $this->type = intval($parts[$pCount-2]);
506 $this->id = $parts[$pCount-3];
507 } else {
508 $this->type = 0;
509 $this->id = $parts[0];
510 }
511 }
512 }
513
514 // If PATH_INFO
515 if (t3lib_div::getIndpEnv('PATH_INFO')) { // If pathinfo contains stuff...
516 $parts=t3lib_div::trimExplode('/',t3lib_div::getIndpEnv('PATH_INFO'),1);
517 $parts[]='html';
518 $pCount = count($parts);
519 if ($pCount>2) {
520 $this->type = intval($parts[$pCount-2]);
521 $this->id = $parts[$pCount-3];
522 } else {
523 $this->type = 0;
524 $this->id = $parts[0];
525 }
526 $this->absRefPrefix_force=1;
527 }
528
529 // Call post processing function for custom URL methods.
530 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'])) {
531 $_params = array('pObj' => &$this);
532 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'] as $_funcRef) {
533 t3lib_div::callUserFunction($_funcRef,$_params,$this);
534 }
535 }
536 }
537
538 /**
539 * Clears the preview-flags, sets sim_exec_time to current time.
540 * Hidden pages must be hidden as default, $GLOBALS['SIM_EXEC_TIME'] is set to $GLOBALS['EXEC_TIME'] in t3lib/config_default.inc. Alter it by adding or subtracting seconds.
541 *
542 * @return void
543 */
544 function clear_preview() {
545 $this->showHiddenPage = 0;
546 $this->showHiddenRecords = 0;
547 $GLOBALS['SIM_EXEC_TIME'] = $GLOBALS['EXEC_TIME'];
548 $this->fePreview = 0;
549 }
550
551 /**
552 * Determines the id and evaluates any preview settings
553 * Basically this function is about determining whether a backend user is logged in, if he has read access to the page and if he's previewing the page. That all determines which id to show and how to initialize the id.
554 *
555 * @return void
556 */
557 function determineId() {
558
559 // Getting ARG-v values if some
560 $this->setIDfromArgV();
561
562 // If there is a Backend login we are going to check for any preview settings:
563 $GLOBALS['TT']->push('beUserLogin','');
564 if ($this->beUserLogin) {
565 $this->fePreview = $GLOBALS['BE_USER']->extGetFeAdminValue('preview');
566
567 // If admin panel preview is enabled...
568 if ($this->fePreview) {
569 $fe_user_OLD_USERGROUP = $this->fe_user->user['usergroup'];
570
571 $this->showHiddenPage = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','showHiddenPages');
572 $this->showHiddenRecords = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','showHiddenRecords');
573 // simulate date
574 $simTime = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','simulateDate');
575 if ($simTime) $GLOBALS['SIM_EXEC_TIME']=$simTime;
576 // simulate user
577 $simUserGroup = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','simulateUserGroup');
578 $this->simUserGroup = $simUserGroup;
579 if ($simUserGroup) $this->fe_user->user['usergroup']=$simUserGroup;
580 if (!$simUserGroup && !$simTime && !$this->showHiddenPage && !$this->showHiddenRecords) {
581 $this->fePreview=0;
582 }
583 }
584
585 // Now it's investigated if the raw page-id points to a hidden page and if so, the flag is set.
586 // This does not require the preview flag to be set in the admin panel
587 if ($this->id) {
588 $idQ = t3lib_div::testInt($this->id) ? 'uid="'.intval($this->id).'"' : 'alias="'.$GLOBALS['TYPO3_DB']->quoteStr($this->id, 'pages').'"';
589 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('hidden', 'pages', $idQ.' AND hidden AND NOT deleted');
590 if ($GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
591 $this->fePreview = 1; // The preview flag is set only if the current page turns out to actually be hidden!
592 $this->showHiddenPage = 1;
593 }
594 }
595
596 if ($this->fePreview) { // If the front-end is showing a preview, caching MUST be disabled.
597 $this->set_no_cache();
598 }
599 }
600 $GLOBALS['TT']->pull();
601
602 // Now, get the id, validate access etc:
603 $this->fetch_the_id();
604
605 // Check if backend user has read access to this page. If not, recalculate the id.
606 if ($this->beUserLogin && $this->fePreview) {
607 if (!$GLOBALS['BE_USER']->doesUserHaveAccess($this->page,1)) {
608 // Resetting
609 $this->clear_preview();
610 $this->fe_user->user['usergroup'] = $fe_user_OLD_USERGROUP;
611 // Fetching the id again, now with the preview settings reset.
612 $this->fetch_the_id();
613 }
614 }
615 // Final cleaning.
616 $this->id=$this->contentPid=intval($this->id); // Make sure it's an integer
617 $this->type=intval($this->type); // Make sure it's an integer
618
619
620 // Call post processing function for id determination:
621 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'])) {
622 $_params = array('pObj' => &$this);
623 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'] as $_funcRef) {
624 t3lib_div::callUserFunction($_funcRef,$_params,$this);
625 }
626 }
627 }
628
629 /**
630 * Get The Page ID
631 * This gets the id of the page, checks if the page is in the domain and if the page is accessible
632 * Sets variables such as $this->sys_page, $this->loginUser, $this->gr_list, $this->id, $this->type, $this->domainStartPage, $this->idParts
633 *
634 * @return void
635 * @access private
636 */
637 function fetch_the_id() {
638 $GLOBALS['TT']->push('fetch_the_id initialize/','');
639
640 // Initialize the page-select functions.
641 $this->sys_page = t3lib_div::makeInstance('t3lib_pageSelect');
642 $this->sys_page->init($this->showHiddenPage);
643
644 // Sets ->loginUser and ->gr_list based on front-end user status.
645 $this->fe_user->showHiddenRecords = $this->showHiddenRecords; // This affects the hidden-flag selecting the fe_groups for the user!
646 if (is_array($this->fe_user->user) && $this->fe_user->fetchGroupData()) {
647 $this->loginUser=1; // global flag!
648 $this->gr_list = '0,-2'; // group -2 is not an existing group, but denotes a 'default' group when a user IS logged in. This is used to let elements be shown for all logged in users!
649 $gr_array = $this->fe_user->groupData['uid'];
650 } else {
651 $this->loginUser=0;
652 $this->gr_list = '0,-1'; // group -1 is not an existing group, but denotes a 'default' group when not logged in. This is used to let elements be hidden, when a user is logged in!
653 $gr_array=array();
654 }
655
656 // ADD group-numbers if the IPmask matches.
657 if (is_array($this->TYPO3_CONF_VARS['FE']['IPmaskMountGroups'])) {
658 foreach($this->TYPO3_CONF_VARS['FE']['IPmaskMountGroups'] as $IPel) {
659 if (t3lib_div::getIndpEnv('REMOTE_ADDR') && $IPel[0] && t3lib_div::cmpIP(t3lib_div::getIndpEnv('REMOTE_ADDR'),$IPel[0])) {$gr_array[]=intval($IPel[1]);}
660 }
661 }
662
663 // Clean up.
664 $gr_array = array_unique($gr_array); // Make unique...
665 sort($gr_array); // sort
666 if (count($gr_array)) {
667 $this->gr_list.=','.implode(',',$gr_array);
668 }
669
670 // Sets sys_page where-clause
671 $this->sys_page->where_hid_del.=' AND doktype<200 AND fe_group IN ('.$this->gr_list.')';
672
673 // Splitting $this->id by a period (.). First part is 'id' and second part - if exists - will overrule the &type param if given
674 $pParts = explode('.',$this->id);
675 $this->id = $pParts[0]; // Set it.
676 if (isset($pParts[1])) {$this->type=$pParts[1];}
677
678 // Splitting $this->id by a comma (,). First part is 'id' and other parts are just stored for use in scripts.
679 $this->idParts = explode(',',$this->id);
680
681 // Splitting by a '+' sign - used for base64/md5 methods of parameter encryption for simulate static documents.
682 list($pgID,$SSD_p)=explode('+',$this->idParts[0],2);
683 if ($SSD_p) { $this->idPartsAnalyze($SSD_p); }
684 $this->id = $pgID; // Set id
685
686 // If $this->id is a string, it's an alias
687 $this->checkAndSetAlias();
688
689 // The id and type is set to the integer-value - just to be sure...
690 $this->id = intval($this->id);
691 $this->type = intval($this->type);
692 $GLOBALS['TT']->pull();
693
694 // We find the first page belonging to the current domain
695 $GLOBALS['TT']->push('fetch_the_id domain/','');
696 $this->domainStartPage = $this->findDomainRecord($this->TYPO3_CONF_VARS['SYS']['recursiveDomainSearch']); // the page_id of the current domain
697 if (!$this->id) {
698 if ($this->domainStartPage) {
699 $this->id = $this->domainStartPage; // If the id was not previously set, set it to the id of the domain.
700 } else {
701 $theFirstPage = $this->sys_page->getFirstWebPage($this->id); // Find the first 'visible' page in that domain
702 if ($theFirstPage) {
703 $this->id = $theFirstPage['uid'];
704 } else {
705 $this->printError('No pages are found on the rootlevel!');
706 exit;
707 }
708 }
709 }
710 $GLOBALS['TT']->pull();
711
712 $GLOBALS['TT']->push('fetch_the_id rootLine/','');
713 $requestedId = $this->id; // We store the originally requested id
714 $this->getPageAndRootlineWithDomain($this->domainStartPage);
715 $GLOBALS['TT']->pull();
716
717 if ($this->pageNotFound && $this->TYPO3_CONF_VARS['FE']['pageNotFound_handling']) {
718 $this->pageNotFoundHandler($this->TYPO3_CONF_VARS['FE']['pageNotFound_handling'],$this->TYPO3_CONF_VARS['FE']['pageNotFound_handling_statheader']);
719 }
720
721 // set no_cache if set
722 if ($this->page['no_cache']) {
723 $this->set_no_cache();
724 }
725 // Init SYS_LASTCHANGED
726 $this->register['SYS_LASTCHANGED'] = intval($this->page['tstamp']);
727 }
728
729 /**
730 * Gets the page and rootline arrays based on the id, $this->id
731 *
732 * If the id does not correspond to a proper page, the 'previous' valid page in the rootline is found
733 * If the page is a shortcut (doktype=4), the ->id is loaded with that id
734 *
735 * Whether or not the ->id is changed to the shortcut id or the previous id in rootline (eg if a page is hidden), the ->page-array and ->rootline is found and must also be valid.
736 *
737 * Sets or manipulates internal variables such as: $this->id, $this->page, $this->rootLine, $this->MP, $this->pageNotFound
738 *
739 * @return void
740 * @access private
741 */
742 function getPageAndRootline() {
743 $this->page = $this->sys_page->getPage($this->id);
744 if (!count($this->page)) {
745 // If no page, we try to find the page before in the rootLine.
746 $this->pageNotFound=1; // Page is 'not found' in case the id itself was not an accessible page. code 1
747 $this->rootLine = $this->sys_page->getRootLine($this->id,$this->MP);
748 if (count($this->rootLine)) {
749 $c=count($this->rootLine)-1;
750 while($c>0) {
751 $c--;
752 $this->id=$this->rootLine[$c]['uid'];
753 $this->page = $this->sys_page->getPage($this->id);
754 if (count($this->page)){break;}
755 }
756 }
757 // If still no page...
758 if (!count($this->page)) {
759 $this->printError('The requested page does not exist!');
760 exit;
761 }
762 }
763 // Is the ID a link to another page??
764 if ($this->page['doktype']==4) {
765 $this->MP=''; // We need to clear MP if the page is a shortcut. Reason is if the short cut goes to another page, then we LEAVE the rootline which the MP expects.
766 $this->page = $this->getPageShortcut($this->page['shortcut'],$this->page['shortcut_mode'],$this->page['uid']);
767 $this->id = $this->page['uid'];
768 }
769 // Gets the rootLine
770 $this->rootLine = $this->sys_page->getRootLine($this->id,$this->MP);
771
772 // If not rootline we're off...
773 if (!count($this->rootLine)) {
774 $this->printError('The requested page didn\'t have a proper connection to the tree-root!');
775 exit;
776 }
777
778 // Checking for include section regarding the hidden/starttime/endtime/fe_user (that is access control of a whole subbranch!)
779 if ($this->checkRootlineForIncludeSection()) {
780 if (!count($this->rootLine)) {
781 $this->printError('The requested page was not accessible!');
782 exit;
783 } else {
784 $el = reset($this->rootLine);
785 $this->id = $el['uid'];
786 $this->page = $this->sys_page->getPage($this->id);
787 $this->rootLine = $this->sys_page->getRootLine($this->id,$this->MP);
788 }
789 }
790 }
791
792 /**
793 * Get page shortcut; Finds the records pointed to by input value $SC (the shortcut value)
794 *
795 * @param integer The value of the "shortcut" field from the pages record
796 * @param integer The shortcut mode: 1 and 2 will select either first subpage or random subpage; the default is the page pointed to by $SC
797 * @param integer The current page UID of the page which is a shortcut
798 * @param integer Safety feature which makes sure that the function is calling itself recursively max 20 times (since this function can find shortcuts to other shortcuts to other shortcuts...)
799 * @param array An array filled with previous page uids tested by the function - new page uids are evaluated against this to avoid going in circles.
800 * @return mixed Returns the page record of the page that the shortcut pointed to.
801 * @access private
802 * @see getPageAndRootline()
803 */
804 function getPageShortcut($SC,$mode,$thisUid,$itera=20,$pageLog=array()) {
805 $idArray = t3lib_div::intExplode(',',$SC);
806 switch($mode) {
807 case 1:
808 case 2:
809 $pageArray = $this->sys_page->getMenu($idArray[0]?$idArray[0]:$thisUid,'*','sorting','AND pages.doktype<199 AND pages.doktype!=6');
810 $pO=0;
811 if ($mode==2 && count($pageArray)) { // random
812 $this->make_seed();
813 $randval = intval(rand(0,count($pageArray)-1));
814 $pO=$randval;
815 }
816 $c=0;
817 reset($pageArray);
818 while(list(,$pV)=each($pageArray)) {
819 if ($c==$pO) {
820 $page = $pV;
821 break;
822 }
823 $c++;
824 }
825 break;
826 default:
827 $page = $this->sys_page->getPage($idArray[0]);
828 break;
829 }
830 if ($page['doktype']==4) {
831 if (!in_array($page['uid'],$pageLog) && $itera>0) {
832 $pageLog[] = $page['uid'];
833 $page = $this->getPageShortcut($page['shortcut'],$page['shortcut_mode'],$page['uid'],$itera-1,$pageLog);
834 } else {
835 $pageLog[] = $page['uid'];
836 $this->printError('Page shortcuts were looping in uids '.implode(',',$pageLog).'...!');
837 exit;
838 }
839 }
840 return $page;
841 }
842
843 /**
844 * Checks the current rootline for defined sections.
845 *
846 * @return boolean
847 * @access private
848 */
849 function checkRootlineForIncludeSection() {
850 $c=count($this->rootLine);
851 $removeTheRestFlag=0;
852 for ($a=0;$a<$c;$a++) {
853 if (!$this->checkPagerecordForIncludeSection($this->rootLine[$a])) {
854 $removeTheRestFlag=1;
855 }
856 if ($this->rootLine[$a]['doktype']==6) {
857 if ($this->beUserLogin) { // If there is a backend user logged in, check if he has read access to the page:
858 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'uid='.intval($this->id).' AND '.$GLOBALS['BE_USER']->getPagePermsClause(1));
859 list($isPage) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
860 if (!$isPage) $removeTheRestFlag=1; // If there was no page selected, the user apparently did not have read access to the current PAGE (not position in rootline) and we set the remove-flag...
861 } else { // Dont go here, if there is no backend user logged in.
862 $removeTheRestFlag=1;
863 }
864 }
865 if ($removeTheRestFlag) {
866 $this->pageNotFound=2; // Page is 'not found' in case a subsection was found and not accessible, code 2
867 unset($this->rootLine[$a]);
868 }
869 }
870 return $removeTheRestFlag;
871 }
872
873 /**
874 * Checks page record for enableFields
875 * Returns true if enableFields does not disable the page record.
876 * Takes notice of the ->showHiddenPage flag and uses SIM_EXEC_TIME for start/endtime evaluation
877 *
878 * @param array The page record to evaluate (needs fields; hidden, starttime, endtime, fe_group)
879 * @return boolean True, if record is viewable.
880 * @see tslib_cObj::getTreeList(), checkPagerecordForIncludeSection()
881 */
882 function checkEnableFields($row) {
883 if ((!$row['hidden'] || $this->showHiddenPage)
884 && $row['starttime']<=$GLOBALS['SIM_EXEC_TIME']
885 && ($row['endtime']==0 || $row['endtime']>$GLOBALS['SIM_EXEC_TIME'])
886 && t3lib_div::inList($this->gr_list,$row['fe_group'])
887 ) {
888 return 1;
889 }
890 }
891
892 /**
893 * Checks page record for include section
894 *
895 * @param array The page record to evaluate (needs fields;extendToSubpages + hidden, starttime, endtime, fe_group)
896 * @return boolean Returns true if either extendToSubpages is not checked or if the enableFields does not disable the page record.
897 * @access private
898 * @see checkEnableFields(), tslib_cObj::getTreeList(), checkRootlineForIncludeSection()
899 */
900 function checkPagerecordForIncludeSection($row) {
901 return (!$row['extendToSubpages'] || $this->checkEnableFields($row)) ? 1 : 0;
902 }
903
904 /**
905 * This checks if there are ARGV-parameters in the QUERY_STRING and if so, those are used for the id
906 * $this->id must be 'false' in order for any processing to happen in here
907 * If an id/alias value is extracted from the QUERY_STRING it is set in $this->id
908 *
909 * @return void
910 * @access private
911 */
912 function setIDfromArgV() {
913 if (!$this->id) {
914 list($theAlias) = explode('&',t3lib_div::getIndpEnv('QUERY_STRING'));
915 $theAlias = trim($theAlias);
916 $this->id = $theAlias ? $theAlias : 0;
917 }
918 }
919
920 /**
921 * Gets ->page and ->rootline information based on ->id. ->id may change during this operation.
922 * If not inside domain, then default to first page in domain.
923 *
924 * @param integer Page uid of the page where the found domain record is (pid of the domain record)
925 * @return void
926 * @access private
927 */
928 function getPageAndRootlineWithDomain($domainStartPage) {
929 $this->getPageAndRootline();
930
931 // Checks if the $domain-startpage is in the rootLine. This is necessary so that references to page-id's from other domains are not possible.
932 if ($domainStartPage && is_array($this->rootLine)) {
933 reset ($this->rootLine);
934 $idFound = 0;
935 while(list($key,$val)=each($this->rootLine)) {
936 if ($val['uid']==$domainStartPage) {
937 $idFound=1;
938 break;
939 }
940 }
941 if (!$idFound) {
942 $this->pageNotFound=3; // Page is 'not found' in case the id was outside the domain, code 3
943 $this->id = $domainStartPage;
944 $this->getPageAndRootline(); //re-get the page and rootline if the id was not found.
945 }
946 }
947 }
948
949 /**
950 * Looking up a domain record based on HTTP_HOST
951 *
952 * @param boolean If set, it looks "recursively" meaning that a domain like "123.456.typo3.com" would find a domain record like "typo3.com" if "123.456.typo3.com" or "456.typo3.com" did not exist.
953 * @return integer Returns the page id of the page where the domain record was found.
954 * @access private
955 */
956 function findDomainRecord($recursive=0) {
957 if ($recursive) {
958 $host = explode('.',t3lib_div::getIndpEnv('HTTP_HOST'));
959 while(count($host)) {
960 $pageUid = $this->sys_page->getDomainStartPage(implode('.',$host),t3lib_div::getIndpEnv('SCRIPT_NAME'),t3lib_div::getIndpEnv('REQUEST_URI'));
961 if ($pageUid) return $pageUid; else array_shift($host);
962 }
963 return $pageUid;
964 } else {
965 return $this->sys_page->getDomainStartPage(t3lib_div::getIndpEnv('HTTP_HOST'),t3lib_div::getIndpEnv('SCRIPT_NAME'),t3lib_div::getIndpEnv('REQUEST_URI'));
966 }
967 }
968
969 /**
970 * Page not found handler.
971 * Exits.
972 *
973 * @param mixed Which type of handling; If a true PHP-boolean and TRUE then a ->printError message is outputted. If integer an error message with that number is shown. Otherwise the $code value is expected to be a "Location:" header value.
974 * @param string If set, this is passed directly to the PHP function, header()
975 * @return void (The function exists!)
976 */
977 function pageNotFoundHandler($code,$header='') {
978 if ($header) {header($header);}
979
980 if (gettype($code)=='boolean' || !strcmp($code,1)) {
981 $this->printError('The page did not exist or was inaccessible.');
982 exit;
983 } else if (t3lib_div::testInt($code)) {
984 $this->printError('Error '.$code);
985 exit;
986 } else {
987 header('Location: '.t3lib_div::locationHeaderUrl($code));
988 exit;
989 }
990 }
991
992 /**
993 * Fetches the integer page id for a page alias.
994 * Looks if ->id is not an integer and if so it will search for a page alias and if found the page uid of that page is stored in $this->id
995 *
996 * @return void
997 * @access private
998 */
999 function checkAndSetAlias() {
1000 if ($this->id && !t3lib_div::testInt($this->id)) {
1001 $aid = $this->sys_page->getPageIdFromAlias($this->id);
1002 if ($aid) {$this->id=$aid;}
1003 }
1004 }
1005
1006 /**
1007 * Analyzes the second part of a id-string (after the "+"), looking for B6 or M5 encoding and if found it will resolve it and restore the variables in global $_GET (but NOT $_GET - yet)
1008 * If values for ->cHash, ->no_cache, ->jumpurl and ->MP is found, they are also loaded into the internal vars of this class.
1009 *
1010 * @param string String to analyze
1011 * @return void
1012 * @access private
1013 */
1014 function idPartsAnalyze($str) {
1015 $GET_VARS = '';
1016 switch(substr($str,0,2)) {
1017 case 'B6':
1018 $addParams = base64_decode(str_replace('_','=',str_replace('-','/',substr($str,2))));
1019 parse_str($addParams,$GET_VARS);
1020 break;
1021 case 'M5':
1022 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('params', 'cache_md5params', 'md5hash="'.$GLOBALS['TYPO3_DB']->quoteStr(substr($str,2), 'cache_md5params').'"');
1023 $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
1024
1025 $this->updateMD5paramsRecord(substr($str,2));
1026 parse_str($row['params'],$GET_VARS);
1027 break;
1028 }
1029
1030 $this->mergingWithGetVars($GET_VARS);
1031 }
1032
1033 /**
1034 * Merging values into the global $HTTP_GET_VARS/$_GET
1035 *
1036 * @param array Array of key/value pairs that will be merged into the current GET-vars. (Non-escaped values)
1037 * @return void
1038 */
1039 function mergingWithGetVars($GET_VARS) {
1040 if (is_array($GET_VARS)) {
1041 $realGet = t3lib_div::_GET(); // Getting $_GET var, unescaped.
1042 if (!is_array($realGet)) $realGet = array();
1043
1044 // Merge new values on top:
1045 $realGet = t3lib_div::array_merge_recursive_overrule($realGet,$GET_VARS);
1046
1047 // Write values back to $_GET:
1048 t3lib_div::_GETset($realGet);
1049
1050 // Setting these specifically (like in the init-function):
1051 if (isset($GET_VARS['type'])) $this->type = intval($GET_VARS['type']);
1052 if (isset($GET_VARS['cHash'])) $this->cHash = $GET_VARS['cHash'];
1053 if (isset($GET_VARS['jumpurl'])) $this->jumpurl = $GET_VARS['jumpurl'];
1054 if (isset($GET_VARS['MP'])) $this->MP = $this->TYPO3_CONF_VARS['FE']['enable_mount_pids'] ? $GET_VARS['MP'] : '';
1055
1056 if (isset($GET_VARS['no_cache']) && $GET_VARS['no_cache']) $this->set_no_cache();
1057 }
1058 }
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076 /********************************************
1077 *
1078 * Template and caching related functions.
1079 *
1080 *******************************************/
1081
1082 /**
1083 * Calculates a hash string based on additional parameters in the url. This is used to cache pages with more parameters than just id and type
1084 *
1085 * @return void
1086 */
1087 function makeCacheHash() {
1088 $GET = t3lib_div::_GET();
1089 if ($this->cHash && is_array($GET)) {
1090 $pA = $this->cHashParams(t3lib_div::implodeArrayForUrl('',$GET));
1091 $this->cHash_array = $pA;
1092 $cHash_calc = t3lib_div::shortMD5(serialize($this->cHash_array));
1093 #debug(array($cHash_calc,$this->cHash,$pA));
1094 if ($cHash_calc!=$this->cHash) {
1095 $this->set_no_cache();
1096 $GLOBALS['TT']->setTSlogMessage('The incoming cHash "'.$this->cHash.'" and calculated cHash "'.$cHash_calc.'" did not match, so caching was disabled. The fieldlist used was "'.implode(array_keys($pA),',').'"',2);
1097 }
1098 }
1099 }
1100
1101 /**
1102 * Splits the input query-parameters into an array with certain parameters filtered out.
1103 * Used to create the cHash value
1104 *
1105 * @param string Query-parameters: "&xxx=yyy&zzz=uuu"
1106 * @return array Array with key/value pairs of query-parameters WITHOUT a certain list of variable names (like id, type, no_cache etc) and WITH a variable, encryptionKey, specific for this server/installation
1107 * @access private
1108 * @see makeCacheHash(), tslib_cObj::typoLink()
1109 */
1110 function cHashParams($addQueryParams) {
1111 $params = explode('&',substr($addQueryParams,1)); // Splitting parameters up
1112
1113 // Make array:
1114 $pA = array();
1115 foreach($params as $theP) {
1116 $pKV = explode('=', $theP); // SPlitting single param by '=' sign
1117 if (!t3lib_div::inList('id,type,no_cache,cHash,MP,ftu',$pKV[0])) {
1118 $pA[$pKV[0]] = (string)rawurldecode($pKV[1]);
1119 }
1120 }
1121 $pA['encryptionKey'] = $this->TYPO3_CONF_VARS['SYS']['encryptionKey'];
1122 ksort($pA);
1123 return $pA;
1124 }
1125
1126 /**
1127 * Initialize the TypoScript template parser
1128 *
1129 * @return void
1130 */
1131 function initTemplate() {
1132 $this->tmpl = t3lib_div::makeInstance('t3lib_TStemplate');
1133 $this->tmpl->init();
1134 $this->tmpl->tt_track= $this->beUserLogin ? 1 : 0;
1135 }
1136
1137 /**
1138 * See if page is in cache and get it if so
1139 * Stores the page content in $this->content if something is found.
1140 *
1141 * @return void
1142 */
1143 function getFromCache() {
1144 $this->tmpl->getCurrentPageData();
1145 $cc=Array();
1146 if (is_array($this->tmpl->currentPageData)) {
1147 // BE CAREFULL to change the content of the cc-array. This array is serialized and an md5-hash based on this is used for caching the page.
1148 // If this hash is not the same in here in this section and after page-generation the page will not be properly cached!
1149
1150 $cc['all'] = $this->tmpl->currentPageData['all'];
1151 $cc['rowSum'] = $this->tmpl->currentPageData['rowSum'];
1152 $cc['rootLine'] = $this->tmpl->currentPageData['rootLine']; // This rootline is used with templates only (matching()-function)
1153 $this->all = $this->tmpl->matching($cc); // This array is an identification of the template. If $this->all is empty it's because the template-data is not cached, which it must be.
1154 ksort($this->all);
1155 }
1156
1157 $this->content=''; // clearing the content-variable, which will hold the pagecontent
1158 unset($this->config); // Unsetting the lowlevel config
1159 $this->cacheContentFlag=0;
1160 if ($this->all && !$this->no_cache) {
1161 $this->newHash = $this->getHash();
1162
1163 $GLOBALS['TT']->push('Cache Query','');
1164 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1165 'S.*',
1166 'cache_pages AS S,pages AS P',
1167 'S.hash="'.$GLOBALS['TYPO3_DB']->quoteStr($this->newHash, 'cache_pages').'"
1168 AND S.page_id=P.uid
1169 AND S.expires > '.intval($GLOBALS['EXEC_TIME']).'
1170 AND NOT P.deleted
1171 AND NOT P.hidden
1172 AND P.starttime<='.intval($GLOBALS['EXEC_TIME']).'
1173 AND (P.endtime=0 OR P.endtime>'.intval($GLOBALS['EXEC_TIME']).')'
1174 );
1175 $GLOBALS['TT']->pull();
1176 $GLOBALS['TT']->push('Cache Row','');
1177 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1178 $this->config = unserialize($row['cache_data']); // Fetches the lowlevel config stored with the cached data
1179 $this->content = $row['HTML']; // Getting the content
1180 $this->cacheContentFlag=1; // Setting flag, so we know, that some cached content is gotten.
1181
1182 if ($this->TYPO3_CONF_VARS['FE']['debug'] || $this->config['config']['debug']) {
1183 $this->content.=chr(10).'<!-- Cached page generated '.Date('d/m Y H:i', $row['tstamp']).'. Expires '.Date('d/m Y H:i', $row['expires']).' -->';
1184 }
1185 }
1186 $GLOBALS['TT']->pull();
1187
1188 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1189 }
1190 }
1191
1192 /**
1193 * Calculates the cache-hash
1194 * This hash is unique to the template, the variables ->id, ->type, ->gr_list (list of groups), ->MP (Mount Points) and cHash array
1195 * Used to get and later store the cached data.
1196 *
1197 * @return string MD5 hash of $this->hash_base which is a serialized version of there variables.
1198 * @access private
1199 * @see getFromCache()
1200 */
1201 function getHash() {
1202 $this->hash_base = serialize(
1203 array(
1204 'all' => $this->all,
1205 'id' => intval($this->id),
1206 'type' => intval($this->type),
1207 'gr_list' => $this->gr_list,
1208 'MP' => $this->MP,
1209 'cHash' => $this->cHash_array
1210 )
1211 );
1212 return md5($this->hash_base);
1213 }
1214
1215 /**
1216 * Checks if config-array exists already but if not, gets it
1217 *
1218 * @return void
1219 */
1220 function getConfigArray() {
1221 if (!is_array($this->config) || is_array($this->config['INTincScript']) || $this->forceTemplateParsing) { // If config is not set by the cache (which would be a major mistake somewhere) OR if INTincScripts-include-scripts have been registered, then we must parse the template in order to get it
1222 $GLOBALS['TT']->push('Parse template','');
1223
1224 // Force parsing, if set?:
1225 $this->tmpl->forceTemplateParsing = $this->forceTemplateParsing;
1226
1227 // Start parsing the TS template. Might return cached version.
1228 $this->tmpl->start($this->rootLine);
1229 $GLOBALS['TT']->pull();
1230
1231 if ($this->tmpl->loaded) {
1232 $GLOBALS['TT']->push('Setting the config-array','');
1233 // t3lib_div::print_array($this->tmpl->setup);
1234 $this->sPre = $this->tmpl->setup['types.'][$this->type]; // toplevel - objArrayName
1235 $this->pSetup = $this->tmpl->setup[$this->sPre.'.'];
1236
1237 if (!is_array($this->pSetup)) {
1238 $this->printError('The page is not configured! [type= '.$this->type.']['.$this->sPre.']');
1239 exit;
1240 } else {
1241 $this->config['config']=Array();
1242
1243 // Filling the config-array.
1244 if (is_array($this->tmpl->setup['config.'])) {
1245 $this->config['config'] = $this->tmpl->setup['config.'];
1246 }
1247 if (is_array($this->pSetup['config.'])) {
1248 reset($this->pSetup['config.']);
1249 while(list($theK,$theV)=each($this->pSetup['config.'])) {
1250 $this->config['config'][$theK] = $theV;
1251 }
1252 }
1253 // if .simulateStaticDocuments was not present, the default value will rule.
1254 if (!isset($this->config['config']['simulateStaticDocuments'])) {
1255 $this->config['config']['simulateStaticDocuments'] = $this->TYPO3_CONF_VARS['FE']['simulateStaticDocuments'];
1256 }
1257
1258 // Processing for the config_array:
1259 $this->config['rootLine'] = $this->tmpl->rootLine;
1260 $this->config['mainScript'] = trim($this->config['config']['mainScript']) ? trim($this->config['config']['mainScript']) : 'index.php';
1261
1262 // STAT:
1263 $theLogFile = $this->TYPO3_CONF_VARS['FE']['logfile_dir'].$this->config['config']['stat_apache_logfile'];
1264 if ($this->config['config']['stat_apache'] &&
1265 $this->config['config']['stat_apache_logfile'] &&
1266 !strstr($this->config['config']['stat_apache_logfile'],'/') &&
1267 @is_dir($this->TYPO3_CONF_VARS['FE']['logfile_dir']) && @is_file($theLogFile) && @is_writeable($theLogFile)) {
1268 $this->config['stat_vars']['logFile'] = $theLogFile;
1269 $shortTitle = substr(ereg_replace('[^\.[:alnum:]_-]','_',$this->page['title']),0,30);
1270 $pageName = $this->config['config']['stat_apache_pagenames'] ? $this->config['config']['stat_apache_pagenames'] : '[path][title]--[uid].html';
1271 $pageName = str_replace('[title]', $shortTitle ,$pageName);
1272 $pageName = str_replace('[uid]',$this->page['uid'],$pageName);
1273 $pageName = str_replace('[alias]',$this->page['alias'],$pageName);
1274 $pageName = str_replace('[type]',$this->page['type'],$pageName);
1275 $temp = $this->config['rootLine'];
1276 array_pop($temp);
1277 $len = t3lib_div::intInRange($this->config['config']['stat_titleLen'],1,100,20);
1278 $pageName = str_replace('[path]', ereg_replace('[^\.[:alnum:]\/_-]','_',$this->sys_page->getPathFromRootline($temp,$len)).'/' ,$pageName);
1279 $this->config['stat_vars']['pageName'] = $pageName;
1280 }
1281 $this->config['FEData'] = $this->tmpl->setup['FEData'];
1282 $this->config['FEData.'] = $this->tmpl->setup['FEData.'];
1283 }
1284 $GLOBALS['TT']->pull();
1285 } else {
1286 $this->printError('No template found!');
1287 exit;
1288 }
1289 }
1290 // No cache
1291 if ($this->config['config']['no_cache']) {$this->set_no_cache();} // Set $this->no_cache true if the config.no_cache value is set!
1292
1293 // Check PATH_INFO url
1294 if ($this->absRefPrefix_force && strcmp($this->config['config']['simulateStaticDocuments'],'PATH_INFO')) {
1295 $redirectUrl = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').'index.php?id='.$this->id.'&type='.$this->type;
1296 if ($this->config['config']['simulateStaticDocuments_dontRedirectPathInfoError']) {
1297 $this->printError('PATH_INFO was not configured for this website, and the URL tries to find the page by PATH_INFO!<br /><br /><a href="'.htmlspecialchars($redirectUrl).'">Click here to get to the right page.</a>','Error: PATH_INFO not configured');
1298 } else {
1299 header('Location: '.t3lib_div::locationHeaderUrl($redirectUrl));
1300 }
1301 exit;
1302 // $this->set_no_cache(); // Set no_cache if PATH_INFO is NOT used as simulateStaticDoc. and if absRefPrefix_force shows that such an URL has been passed along.
1303 }
1304 }
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319 /********************************************
1320 *
1321 * Further initialization and data processing
1322 * (jumpurl/submission of forms)
1323 *
1324 *******************************************/
1325
1326 /**
1327 * Get the compressed $TCA array for use in the front-end
1328 * A compressed $TCA array holds only the ctrl- and feInterface-part for each table. But the column-definitions are omitted in order to save some memory and be more efficient.
1329 * Operates on the global variable, $TCA
1330 *
1331 * @return void
1332 * @see includeTCA()
1333 */
1334 function getCompressedTCarray() {
1335 global $TCA;
1336
1337 $GLOBALS['TT']->push('Get Compressed TC array');
1338 if (!$this->TCAloaded) {
1339 $tempHash = md5('tables.php:'.
1340 filemtime(TYPO3_extTableDef_script ? PATH_typo3conf.TYPO3_extTableDef_script : PATH_t3lib.'stddb/tables.php').
1341 (TYPO3_extTableDef_script?filemtime(PATH_typo3conf.TYPO3_extTableDef_script):'').
1342 ($GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE'] ? filemtime(PATH_typo3conf.$GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE'].'_ext_tables.php') : '')
1343 );
1344 $TCA = unserialize($this->sys_page->getHash($tempHash, 0));
1345 if (!$TCA) {
1346 $this->includeTCA(0);
1347 reset($TCA);
1348 $newTc=Array();
1349 while(list($key,$val)=each($TCA)) {
1350 $newTc[$key]['ctrl'] = $val['ctrl'];
1351 $newTc[$key]['feInterface']=$val['feInterface'];
1352 }
1353 $TCA=$newTc;
1354 $this->sys_page->storeHash($tempHash, serialize($newTc), 'SHORT TC');
1355 }
1356 }
1357 $GLOBALS['TT']->pull();
1358 }
1359
1360 /**
1361 * Includes full TCA.
1362 * Normally in the frontend only a part of the global $TCA array is loaded, for instance the "ctrL" part. Thus it doesn't take up too much memory.
1363 * If you need the FULL TCA available for some reason (like plugins using it) you should call this function which will include the FULL TCA.
1364 * Global vars $TCA, $PAGES_TYPES, $LANG_GENERAL_LABELS can/will be affected.
1365 * The flag $this->TCAloaded will make sure that such an inclusion happens only once since; If $this->TCAloaded is set, nothing is included.
1366 *
1367 * @param boolean Probably, keep hands of this value. Just don't set it. (This may affect the first-ever time this function is called since if you set it to zero/false any subsequent call will still trigger the inclusion; In other words, this value will be set in $this->TCAloaded after inclusion and therefore if its false, another inclusion will be possible on the next call. See ->getCompressedTCarray())
1368 * @return void
1369 * @see getCompressedTCarray()
1370 */
1371 function includeTCA($TCAloaded=1) {
1372 global $TCA, $PAGES_TYPES, $LANG_GENERAL_LABELS, $TBE_MODULES;
1373 if (!$this->TCAloaded) {
1374 $TCA = Array();
1375 include (TYPO3_tables_script ? PATH_typo3conf.TYPO3_tables_script : PATH_t3lib.'stddb/tables.php');
1376 // Extension additions
1377 if ($GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE']) {
1378 include(PATH_typo3conf.$GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE'].'_ext_tables.php');
1379 } else {
1380 include(PATH_t3lib.'stddb/load_ext_tables.php');
1381 }
1382 // ext-script
1383 if (TYPO3_extTableDef_script) {
1384 include (PATH_typo3conf.TYPO3_extTableDef_script);
1385 }
1386 $this->TCAloaded = $TCAloaded;
1387 }
1388 }
1389
1390 /**
1391 * Setting the language key that'll be used by the current page.
1392 * In this function it should be checked, 1) that this language exists, 2) that a page_overlay_record exists, .. and if not the default language, 0 (zero), should be set.
1393 *
1394 * @return void
1395 * @access private
1396 */
1397 function settingLanguage() {
1398 $this->sys_language_uid = intval($this->config['config']['sys_language_uid']);
1399 $olRec = $this->sys_page->getPageOverlay($this->id,$this->sys_language_uid);
1400
1401 if (!count($olRec)) {
1402 $this->sys_language_uid=0;
1403 } else {
1404 $this->page = $this->sys_page->getPageOverlay($this->page,$this->sys_language_uid);
1405 }
1406 $this->sys_page->sys_language_uid = $this->sys_language_uid;
1407
1408 // Updating content of the two rootLines IF the language key is set!
1409 if ($this->sys_language_uid && is_array($this->tmpl->rootLine)) {
1410 reset($this->tmpl->rootLine);
1411 while(list($rLk)=each($this->tmpl->rootLine)) {
1412 $this->tmpl->rootLine[$rLk] = $this->sys_page->getPageOverlay($this->tmpl->rootLine[$rLk]);
1413 }
1414 }
1415 if ($this->sys_language_uid && is_array($this->rootLine)) {
1416 reset($this->rootLine);
1417 while(list($rLk)=each($this->rootLine)) {
1418 $this->rootLine[$rLk] = $this->sys_page->getPageOverlay($this->rootLine[$rLk]);
1419 }
1420 }
1421
1422 // Finding the ISO code:
1423 if (t3lib_extMgm::isLoaded('static_info_tables') && $this->sys_language_uid) {
1424 $sys_language_row = $this->sys_page->getRawRecord('sys_language',$this->sys_language_uid,'static_lang_isocode');
1425 if (is_array($sys_language_row) && $sys_language_row['static_lang_isocode']) {
1426 $stLrow = $this->sys_page->getRawRecord('static_languages',$sys_language_row['static_lang_isocode'],'lg_iso_2');
1427 $this->sys_language_isocode=$stLrow['lg_iso_2'];
1428 }
1429 }
1430 }
1431
1432 /**
1433 * Checks if any email-submissions or submission via the fe_tce
1434 *
1435 * @return string 'email' if a formmail has been send, 'fe_tce' if front-end data submission (like forums, guestbooks) is send. '' if none.
1436 */
1437 function checkDataSubmission() {
1438 global $HTTP_POST_VARS;
1439
1440 if ($HTTP_POST_VARS['formtype_db'] || $HTTP_POST_VARS['formtype_mail']) {
1441 $refInfo=parse_url(t3lib_div::getIndpEnv('HTTP_REFERER'));
1442 if (t3lib_div::getIndpEnv('TYPO3_HOST_ONLY')==$refInfo['host'] || $this->TYPO3_CONF_VARS['SYS']['doNotCheckReferer']) {
1443 if ($this->locDataCheck($HTTP_POST_VARS['locationData'])) {
1444 $ret = '';
1445 if ($HTTP_POST_VARS['formtype_mail']) {
1446 $ret = 'email';
1447 } elseif ($HTTP_POST_VARS['formtype_db'] && is_array($HTTP_POST_VARS['data'])) {
1448 $ret = 'fe_tce';
1449 }
1450 $GLOBALS['TT']->setTSlogMessage('"Check Data Submission": Return value: '.$ret,0);
1451 return $ret;
1452 }
1453 } else $GLOBALS['TT']->setTSlogMessage('"Check Data Submission": HTTP_HOST and REFERER HOST did not match when processing submitted formdata!',3);
1454 }
1455 }
1456
1457 /**
1458 * Processes submitted user data (obsolete "Frontend TCE")
1459 *
1460 * @return void
1461 * @see tslib_feTCE
1462 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=342&cHash=fdf55adb3b
1463 */
1464 function fe_tce() {
1465 $fe_tce = t3lib_div::makeInstance('tslib_feTCE');
1466 $fe_tce->start(t3lib_div::_POST('data'),$this->config['FEData.']);
1467 $fe_tce->includeScripts();
1468 }
1469
1470 /**
1471 * Checks if a formmail submission can be sent as email
1472 *
1473 * @param string The input from $GLOBALS['HTTP_POST_VARS']['locationData']
1474 * @return void
1475 * @access private
1476 * @see checkDataSubmission()
1477 */
1478 function locDataCheck($locationData) {
1479 $locData = explode(':',$locationData);
1480 if (!$locData[1] || $this->sys_page->checkRecord($locData[1],$locData[2],1)) {
1481 if (count($this->sys_page->getPage($locData[0]))) { // $locData[1] -check means that a record is checked only if the locationData has a value for a record else than the page.
1482 return 1;
1483 } else $GLOBALS['TT']->setTSlogMessage('LocationData Error: The page pointed to by location data ('.$locationData.') was not accessible.',2);
1484 } else $GLOBALS['TT']->setTSlogMessage('LocationData Error: Location data ('.$locationData.') record pointed to was not accessible.',2);
1485 }
1486
1487 /**
1488 * Sends the emails from the formmail content object.
1489 *
1490 * @return void
1491 * @access private
1492 * @see checkDataSubmission()
1493 */
1494 function sendFormmail() {
1495 $formmail = t3lib_div::makeInstance('t3lib_formmail');
1496
1497 $EMAIL_VARS = t3lib_div::_POST();
1498 unset($EMAIL_VARS['locationData']);
1499 unset($EMAIL_VARS['formtype_mail']);
1500
1501 // Hook for preprocessing of the content for formmails:
1502 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['sendFormmail-PreProcClass'])) {
1503 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['sendFormmail-PreProcClass'] as $_classRef) {
1504 $_procObj = &t3lib_div::getUserObj($_classRef);
1505 $EMAIL_VARS = $_procObj->sendFormmail_preProcessVariables($EMAIL_VARS,$this);
1506 }
1507 }
1508
1509 $formmail->start($EMAIL_VARS);
1510 $formmail->sendtheMail();
1511 $GLOBALS['TT']->setTSlogMessage('"Formmail" invoked, sending mail to '.$EMAIL_VARS['recipient'],0);
1512 }
1513
1514 /**
1515 * Checks if jumpurl is set.
1516 * This function also takes care of jumpurl utilized by the Direct Mail module (ext: direct_mail) which may set an integer value for jumpurl which refers to a link in a certain mail-record, mid
1517 *
1518 * @return void
1519 */
1520 function checkJumpUrl() {
1521 global $TCA;
1522
1523 $mid = t3lib_div::_GP('mid'); // mail id, if direct mail link
1524 $rid = t3lib_div::_GP('rid'); // recipient id, if direct mail link
1525 if ((strcmp($this->jumpurl,'') && ((t3lib_div::getIndpEnv('HTTP_REFERER') || $this->TYPO3_CONF_VARS['SYS']['doNotCheckReferer']) || $mid)) || ($this->jumpurl = $this->sys_page->getExtURL($this->page,$this->config['config']['disablePageExternalUrl']))) {
1526 if ($mid && is_array($TCA['sys_dmail'])) { // Yes, it's OK if the link comes from a direct mail. AND sys_dmail module has installed the table, sys_dmail (and therefore we expect sys_dmail_maillog as well!)
1527 $temp_recip=explode('_',$rid);
1528 $url_id=0;
1529 if (t3lib_div::testInt($this->jumpurl)) {
1530 $temp_res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('mailContent', 'sys_dmail', 'uid='.intval($mid));
1531 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($temp_res)) {
1532 $temp_unpackedMail = unserialize($row['mailContent']);
1533 $url_id=$this->jumpurl;
1534 if ($this->jumpurl>=0) {
1535 $responseType=1; // Link (number)
1536 $this->jumpurl = $temp_unpackedMail['html']['hrefs'][$url_id]['absRef'];
1537 } else {
1538 $responseType=2; // Link (number, plaintext)
1539 $this->jumpurl = $temp_unpackedMail['plain']['link_ids'][abs($url_id)];
1540 }
1541 switch($temp_recip[0]) {
1542 case 't':
1543 $theTable = 'tt_address';
1544 break;
1545 case 'f':
1546 $theTable = 'fe_users';
1547 break;
1548 default:
1549 $theTable='';
1550 break;
1551 }
1552 if ($theTable) {
1553 $recipRow = $this->sys_page->getRawRecord($theTable,$temp_recip[1]);
1554 if (is_array($recipRow)) {
1555 // debug($recipRow);
1556 $authCode = t3lib_div::stdAuthCode($recipRow['uid']);
1557 $rowFieldsArray = explode(',', 'uid,name,title,email,phone,www,address,company,city,zip,country,fax,firstname');
1558 reset($rowFieldsArray);
1559 while(list(,$substField)=each($rowFieldsArray)) {
1560 $this->jumpurl = str_replace('###USER_'.$substField.'###', $recipRow[$substField], $this->jumpurl);
1561 }
1562 $this->jumpurl = str_replace('###SYS_TABLE_NAME###', $tableNameChar, $this->jumpurl); // Put in the tablename of the userinformation
1563 $this->jumpurl = str_replace('###SYS_MAIL_ID###', $mid, $this->jumpurl); // Put in the uid of the mail-record
1564 $this->jumpurl = str_replace('###SYS_AUTHCODE###', $authCode, $this->jumpurl);
1565
1566 // debug($this->jumpurl);
1567 }
1568 }
1569 }
1570
1571 $GLOBALS['TYPO3_DB']->sql_free_result($temp_res);
1572
1573 if (!$this->jumpurl) die('Error: No further link. Please report error to the mail sender.');
1574 } else {
1575 $responseType=-1; // received (url, dmailerping)
1576 }
1577 if ($responseType!=0) {
1578 $insertFields = array(
1579 'mid' => intval($mid),
1580 'rtbl' => $temp_recip[0],
1581 'rid' => intval($temp_recip[1]),
1582 'tstamp' => time(),
1583 'url' => $this->jumpurl,
1584 'response_type' => intval($responseType),
1585 'url_id' => intval($url_id)
1586 );
1587
1588 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_dmail_maillog', $insertFields);
1589 }
1590 }
1591 } else {
1592 unset($this->jumpurl);
1593 }
1594 }
1595
1596 /**
1597 * Sends a header 'Location' to jumpurl, if jumpurl is set.
1598 * Will exit if a location header is sent (for instance if JumpUrl was triggered)
1599 *
1600 * @return void
1601 */
1602 function jumpUrl() {
1603 if ($this->jumpurl) {
1604 if (t3lib_div::_GP('juSecure')) {
1605 $hArr = array(
1606 $this->jumpurl,
1607 t3lib_div::_GP('locationData'),
1608 $this->TYPO3_CONF_VARS['SYS']['encryptionKey']
1609 );
1610 $calcJuHash=t3lib_div::shortMD5(serialize($hArr));
1611 $locationData = t3lib_div::_GP('locationData');
1612 $juHash = t3lib_div::_GP('juHash');
1613 if ($juHash == $calcJuHash) {
1614 if ($this->locDataCheck($locationData)) {
1615 $this->jumpurl = rawurldecode($this->jumpurl); // 211002 - goes with cObj->filelink() rawurlencode() of filenames so spaces can be allowed.
1616 if (@is_file($this->jumpurl)) {
1617 $mimeType = t3lib_div::_GP('mimeType');
1618 $mimeType = $mimeType ? $mimeType : 'application/octet-stream';
1619 Header('Content-Type: '.$mimeType);
1620 Header('Content-Disposition: attachment; filename='.basename($this->jumpurl));
1621 readfile($this->jumpurl);
1622 exit;
1623 } else die('jumpurl Secure: "'.$this->jumpurl.'" was not a valid file!');
1624 } else die('jumpurl Secure: locationData, '.$locationData.', was not accessible.');
1625 } else die('jumpurl Secure: Calculated juHash, '.$calcJuHash.', did not match the submitted juHash.');
1626 } else {
1627 $TSConf = $this->getPagesTSconfig();
1628 if ($TSConf['TSFE.']['jumpUrl_transferSession']) {
1629 $uParts = parse_url($this->jumpurl);
1630 $params = '&FE_SESSION_KEY='.rawurlencode($this->fe_user->id.'-'.md5($this->fe_user->id.'/'.$this->TYPO3_CONF_VARS['SYS']['encryptionKey']));
1631 $this->jumpurl.=($uParts['query']?'':'?').$params; // Add the session parameter ...
1632 }
1633 Header('Location: '.$this->jumpurl);
1634 exit;
1635 }
1636 }
1637 }
1638
1639 /**
1640 * Sets the URL_ID_TOKEN in the internal var, $this->getMethodUrlIdToken
1641 *
1642 * @return void
1643 * @access private
1644 */
1645 function setUrlIdToken() {
1646 if ($this->config['config']['ftu']) {
1647 $this->getMethodUrlIdToken = $this->TYPO3_CONF_VARS['FE']['get_url_id_token'];
1648 } else {
1649 $this->getMethodUrlIdToken = '';
1650 }
1651 }
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 /********************************************
1677 *
1678 * Page generation; cache handling
1679 *
1680 *******************************************/
1681
1682 /**
1683 * Returns true if the page should be generated
1684 * That is if jumpurl is not set and the cacheContentFlag is not set.
1685 *
1686 * @return boolean
1687 */
1688 function isGeneratePage() {
1689 return (!$this->cacheContentFlag && !$this->jumpurl);
1690 }
1691
1692 /**
1693 * Temp cache content
1694 * The temporary cache will expire after a few seconds (typ. 30) or will be cleared by the rendered page, which will also clear and rewrite the cache.
1695 *
1696 * @return void
1697 */
1698 function tempPageCacheContent() {
1699 $this->tempContent=0;
1700 if (!$this->no_cache) {
1701 $seconds=30;
1702 $stdMsg = '
1703 <html>
1704 <head>
1705 <title>'.htmlspecialchars($this->tmpl->printTitle($this->page['title'])).'</title>
1706 <meta http-equiv=Refresh Content="3; Url='.htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')).'" />
1707 </head>
1708 <body bgcolor="white">
1709 <font size="1" face="VERDANA,ARIAL,HELVETICA" color="#cccccc">
1710 <div align="center">
1711 <b>Page is being generated.</b><br />
1712 If this message does not disappear within '.$seconds.' seconds, please reload.
1713 </div>
1714 </font>
1715 </body>
1716 </html>';
1717 $temp_content = $this->config['config']['message_page_is_being_generated'] ? $this->config['config']['message_page_is_being_generated'] : $stdMsg;
1718
1719 $this->setPageCacheContent($temp_content,'',$GLOBALS['EXEC_TIME']+$seconds);
1720 $this->tempContent=1; // This flag shows that temporary content is put in the cache
1721 }
1722 }
1723
1724 /**
1725 * Set cache content to $this->content
1726 *
1727 * @return void
1728 */
1729 function realPageCacheContent() {
1730 $cache_timeout = $this->page['cache_timeout'] ? $this->page['cache_timeout'] : ($this->cacheTimeOutDefault ? $this->cacheTimeOutDefault : 60*60*24); // seconds until a cached page is too old
1731 $timeOutTime = $GLOBALS['EXEC_TIME']+$cache_timeout;
1732 if ($this->config['config']['cache_clearAtMidnight']) {
1733 $midnightTime = mktime (0,0,0,date('m',$timeOutTime),date('d',$timeOutTime),date('Y',$timeOutTime));
1734 if ($midnightTime > time()) { // If the midnight time of the expire-day is greater than the current time, we may set the timeOutTime to the new midnighttime.
1735 $timeOutTime=$midnightTime;
1736 }
1737 }
1738 $this->config['hash_base'] = $this->hash_base;
1739 $this->setPageCacheContent($this->content,$this->config,$timeOutTime);
1740 }
1741
1742 /**
1743 * Sets cache content; Inserts the content string into the cache_pages table.
1744 *
1745 * @param string The content to store in the HTML field of the cache table
1746 * @param mixed The additional cache_data array, fx. $this->config
1747 * @param integer Timestamp
1748 * @return void
1749 * @see realPageCacheContent(), tempPageCacheContent()
1750 */
1751 function setPageCacheContent($c,$d,$t) {
1752 $this->clearPageCacheContent();
1753
1754 $insertFields = array(
1755 'hash' => $this->newHash,
1756 'page_id' => $this->id,
1757 'HTML' => $c,
1758 'cache_data' => serialize($d),
1759 'expires' => $t,
1760 'tstamp' => time()
1761 );
1762 if ($this->page_cache_reg1) {
1763 $insertFields['reg1'] = intval($this->page_cache_reg1);
1764 }
1765
1766 $GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_pages', $insertFields);
1767 }
1768
1769 /**
1770 * Clears cache content (for $this->newHash)
1771 *
1772 * @return void
1773 */
1774 function clearPageCacheContent() {
1775 $GLOBALS['TYPO3_DB']->exec_DELETEquery('cache_pages', 'hash="'.$GLOBALS['TYPO3_DB']->quoteStr($this->newHash, 'cache_pages').'"');
1776 }
1777
1778 /**
1779 * Clears cache content for a list of page ids
1780 *
1781 * @param string A list of INTEGER numbers which points to page uids for which to clear entries in the cache_pages table (page content cache)
1782 * @return void
1783 */
1784 function clearPageCacheContent_pidList($pidList) {
1785 $GLOBALS['TYPO3_DB']->exec_DELETEquery('cache_pages', 'page_id IN ('.$GLOBALS['TYPO3_DB']->cleanIntList($pidList).')');
1786 }
1787
1788 /**
1789 * Sets sys last changed
1790 * Setting the SYS_LASTCHANGED value in the pagerecord: This value will thus be set to the highest tstamp of records rendered on the page. This includes all records with no regard to hidden records, userprotection and so on.
1791 *
1792 * @return void
1793 * @see tslib_cObj::lastChanged()
1794 */
1795 function setSysLastChanged() {
1796 if ($this->page['SYS_LASTCHANGED'] < intval($this->register['SYS_LASTCHANGED'])) {
1797 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('pages', 'uid='.intval($this->id), array('SYS_LASTCHANGED' => intval($this->register['SYS_LASTCHANGED'])));
1798 }
1799 }
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820 /********************************************
1821 *
1822 * Page generation; rendering and inclusion
1823 *
1824 *******************************************/
1825
1826 /**
1827 * Does some processing BEFORE the pagegen script is included.
1828 *
1829 * @return void
1830 */
1831 function generatePage_preProcessing() {
1832 ksort($this->all);
1833 // Same codeline as in getFromCache(). BUT $this->all has been set in the meantime, so we can't just skip this line and let it be set above! Keep this line!
1834 $this->newHash = $this->getHash();
1835
1836 // Here we put some temporary stuff in the cache in order to let the first hit generate the page. The temporary cache will expire after a few seconds (typ. 30) or will be cleared by the rendered page, which will also clear and rewrite the cache.
1837 $this->tempPageCacheContent();
1838
1839 // Setting locale
1840 if ($this->config['config']['locale_all']) {
1841 # Change by Rene Fritz, 22/10 2002
1842 # there`s the problem that PHP parses float values in scripts wrong if the locale LC_NUMERIC is set to something with a komma as decimal point
1843 # this does not work in php 4.2.3
1844 #setlocale('LC_ALL',$this->config['config']['locale_all']);
1845 #setlocale('LC_NUMERIC','en_US');
1846
1847 # so we set all except LC_NUMERIC
1848 setlocale(LC_COLLATE,$this->config['config']['locale_all']);
1849 setlocale(LC_CTYPE,$this->config['config']['locale_all']);
1850 setlocale(LC_MONETARY,$this->config['config']['locale_all']);
1851 setlocale(LC_TIME,$this->config['config']['locale_all']);
1852 }
1853
1854 // Setting cache_timeout_default. May be overridden by PHP include scritps.
1855 $this->cacheTimeOutDefault = intval($this->config['config']['cache_period']);
1856
1857 // page is generated
1858 $this->no_cacheBeforePageGen = $this->no_cache;
1859 }
1860
1861 /**
1862 * Determines to include custom or pagegen.php script
1863 * returns script-filename if a TypoScript (config) script is defined and should be include instead of pagegen.php
1864 *
1865 * @return string The relative filepath of "config.pageGenScript" if found and allowed
1866 */
1867 function generatePage_whichScript() {
1868 if (!$this->TYPO3_CONF_VARS['FE']['noPHPscriptInclude'] && $this->config['config']['pageGenScript']) {
1869 return $this->tmpl->getFileName($this->config['config']['pageGenScript']);
1870 }
1871 }
1872
1873 /**
1874 * Does some processing AFTER the pagegen script is included.
1875 * This includes calling tidy (if configured), XHTML cleaning (if configured), caching the page, indexing the page (if configured) and setting sysLastChanged
1876 *
1877 * @return void
1878 */
1879 function generatePage_postProcessing() {
1880 // This is to ensure, that the page is NOT cached if the no_cache parameter was set before the page was generated. This is a safety precaution, as it could have been unset by some script.
1881 if ($this->no_cacheBeforePageGen) $this->set_no_cache();
1882
1883 // Tidy up the code, if flag...
1884 if ($this->TYPO3_CONF_VARS['FE']['tidy_option'] == 'all') {
1885 $GLOBALS['TT']->push('Tidy, all','');
1886 $this->content = $this->tidyHTML($this->content);
1887 $GLOBALS['TT']->pull();
1888 }
1889
1890 // XHTML-clean the code, if flag set
1891 if ($this->doXHTML_cleaning() == 'all') {
1892 $GLOBALS['TT']->push('XHTML clean, all','');
1893 $XHTML_clean = t3lib_div::makeInstance('t3lib_parsehtml');
1894 $this->content = $XHTML_clean->XHTML_clean($this->content);
1895 $GLOBALS['TT']->pull();
1896 }
1897
1898 // Fix local anchors in links, if flag set
1899 if ($this->doLocalAnchorFix() == 'all') {
1900 $GLOBALS['TT']->push('Local anchor fix, all','');
1901 $this->prefixLocalAnchorsWithScript();
1902 $GLOBALS['TT']->pull();
1903 }
1904
1905 // Hook for post-processing of page content cached/non-cached:
1906 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['contentPostProc-all'])) {
1907 $_params = array('pObj' => &$this);
1908 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['contentPostProc-all'] as $_funcRef) {
1909 t3lib_div::callUserFunction($_funcRef,$_params,$this);
1910 }
1911 }
1912
1913 // Storing page
1914 if (!$this->no_cache) {
1915 // Tidy up the code, if flag...
1916 if ($this->TYPO3_CONF_VARS['FE']['tidy_option'] == 'cached') {
1917 $GLOBALS['TT']->push('Tidy, cached','');
1918 $this->content = $this->tidyHTML($this->content);
1919 $GLOBALS['TT']->pull();
1920 }
1921 // XHTML-clean the code, if flag set
1922 if ($this->doXHTML_cleaning() == 'cached') {
1923 $GLOBALS['TT']->push('XHTML clean, cached','');
1924 $XHTML_clean = t3lib_div::makeInstance('t3lib_parsehtml');
1925 $this->content = $XHTML_clean->XHTML_clean($this->content);
1926 $GLOBALS['TT']->pull();
1927 }
1928 // Fix local anchors in links, if flag set
1929 if ($this->doLocalAnchorFix() == 'cached') {
1930 $GLOBALS['TT']->push('Local anchor fix, cached','');
1931 $this->prefixLocalAnchorsWithScript();
1932 $GLOBALS['TT']->pull();
1933 }
1934
1935 // Hook for post-processing of page content before being cached:
1936 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['contentPostProc-cached'])) {
1937 $_params = array('pObj' => &$this);
1938 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['contentPostProc-cached'] as $_funcRef) {
1939 t3lib_div::callUserFunction($_funcRef,$_params,$this);
1940 }
1941 }
1942
1943 $this->realPageCacheContent();
1944 } elseif ($this->tempContent) { // If there happens to be temporary content in the cache and the cache was not cleared due to new content put in it... ($this->no_cache=0)
1945 $this->clearPageCacheContent();
1946 }
1947
1948 if ($this->isSearchIndexPage()) {
1949 $GLOBALS['TT']->push('Index page','');
1950 $indexer = t3lib_div::makeInstance('tx_indexedsearch_indexer');
1951 $indexer->init($this->content,$this->config['config'],$this->id,$this->type,$this->gr_list,$this->cHash_array,$this->register['SYS_LASTCHANGED'],$this->config['rootLine']);
1952 $indexer->indexTypo3PageContent();
1953 $GLOBALS['TT']->pull();
1954 } elseif ($this->config['config']['index_enable'] && $this->no_cache) {
1955 $GLOBALS['TT']->push('Index page','');
1956 $GLOBALS['TT']->setTSlogMessage('Index page? No, page was set to "no_cache" and so cannot be indexed.');
1957 $GLOBALS['TT']->pull();
1958 }
1959 $this->setSysLastChanged();
1960 }
1961
1962 /**
1963 * Processes the INTinclude-scripts
1964 *
1965 * @return void
1966 */
1967 function INTincScript() {
1968 $GLOBALS['TT']->push('Split content');
1969 $INTiS_splitC = explode('<!--INT_SCRIPT.',$this->content); // Splits content with the key.
1970 $this->content='';
1971 $GLOBALS['TT']->setTSlogMessage('Parts: '.count($INTiS_splitC));
1972 $GLOBALS['TT']->pull();
1973
1974 // Depreciated stuff:
1975 $this->additionalHeaderData = is_array($this->config['INTincScript_ext']['additionalHeaderData']) ? $this->config['INTincScript_ext']['additionalHeaderData'] : array();
1976 $this->additionalJavaScript = $this->config['INTincScript_ext']['additionalJavaScript'];
1977 $this->additionalCSS = $this->config['INTincScript_ext']['additionalCSS'];
1978 $this->JSCode = $this->additionalHeaderData['JSCode'];
1979 $this->JSImgCode = $this->additionalHeaderData['JSImgCode'];
1980 $this->divSection='';
1981
1982 $INTiS_config = $GLOBALS['TSFE']->config['INTincScript'];
1983 reset($INTiS_splitC);
1984 while(list($INTiS_c,$INTiS_cPart)=each($INTiS_splitC)) {
1985 if (substr($INTiS_cPart,32,3)=='-->') { // If the split had a comment-end after 32 characters it's probably a split-string
1986 $GLOBALS['TT']->push('Include '.$INTiS_config[$INTiS_key]['file'],'');
1987 $INTiS_key = 'INT_SCRIPT.'.substr($INTiS_cPart,0,32);
1988 $incContent='';
1989 if (is_array($INTiS_config[$INTiS_key])) {
1990 $INTiS_cObj = unserialize($INTiS_config[$INTiS_key]['cObj']);
1991 $INTiS_cObj->INT_include=1;
1992 switch($INTiS_config[$INTiS_key]['type']) {
1993 case 'SCRIPT':
1994 $incContent=$INTiS_cObj->PHP_SCRIPT($INTiS_config[$INTiS_key]['conf']);
1995 break;
1996 case 'COA':
1997 $incContent=$INTiS_cObj->COBJ_ARRAY($INTiS_config[$INTiS_key]['conf']);
1998 break;
1999 case 'FUNC':
2000 $incContent=$INTiS_cObj->USER($INTiS_config[$INTiS_key]['conf']);
2001 break;
2002 }
2003 }
2004 $this->content.= $incContent;
2005 $this->content.= substr($INTiS_cPart,35);
2006 $GLOBALS['TT']->pull($incContent);
2007 } else {
2008 $this->content.= ($c?'<!--INT_SCRIPT.':'').$INTiS_cPart;
2009 }
2010 }
2011 $GLOBALS['TT']->push('Substitute header section');
2012 $this->INTincScript_loadJSCode();
2013 $this->content = str_replace('<!--HD_'.$this->config['INTincScript_ext']['divKey'].'-->', implode($this->additionalHeaderData,chr(10)), $this->content);
2014 $this->content = str_replace('<!--TDS_'.$this->config['INTincScript_ext']['divKey'].'-->', $this->divSection, $this->content);
2015 $this->setAbsRefPrefix();
2016 $GLOBALS['TT']->pull();
2017 }
2018
2019 /**
2020 * Loads the JavaScript code for INTincScript
2021 *
2022 * @return void
2023 * @access private
2024 */
2025 function INTincScript_loadJSCode() {
2026 if ($this->JSImgCode) { // If any images added, then add them to the javascript section
2027 $this->additionalHeaderData['JSImgCode']='
2028 <script type="text/javascript">
2029 /*<![CDATA[*/
2030 <!--
2031 if (version == "n3") {
2032 '.trim($this->JSImgCode).'
2033 }
2034 // -->
2035 /*]]>*/
2036 </script>';
2037 }
2038 if ($this->JSCode || count($this->additionalJavaScript)) { // Add javascript
2039 $this->additionalHeaderData['JSCode']='
2040 <script type="text/javascript">
2041 /*<![CDATA[*/
2042 <!--
2043 '.implode($this->additionalJavaScript,chr(10)).'
2044 '.trim($this->JSCode).'
2045 // -->
2046 /*]]>*/
2047 </script>';
2048 }
2049 if (count($this->additionalCSS)) { // Add javascript
2050 $this->additionalHeaderData['_CSS']='
2051 <style type="text/css">
2052 /*<![CDATA[*/
2053 <!--
2054 '.implode($this->additionalCSS,chr(10)).'
2055 // -->
2056 /*]]>*/
2057 </style>';
2058 }
2059 }
2060
2061 /**
2062 * Determines if there are any INTincScripts to include
2063 *
2064 * @return boolean Returns true if scripts are found (and not jumpurl)
2065 */
2066 function isINTincScript() {
2067 return (is_array($this->config['INTincScript']) && !$this->jumpurl);
2068 }
2069
2070 /**
2071 * Returns true if page should be indexed.
2072 *
2073 * @return boolean
2074 */
2075 function isSearchIndexPage() {
2076 return t3lib_extMgm::isLoaded('indexed_search') && $this->config['config']['index_enable'] && !$this->no_cache;
2077 }
2078
2079 /**
2080 * Returns the mode of XHTML cleaning
2081 *
2082 * @return string Keyword: "all", "cached" or "output"
2083 */
2084 function doXHTML_cleaning() {
2085 return $this->config['config']['xhtml_cleaning'];
2086 }
2087
2088 /**
2089 * Returns the mode of Local Anchor prefixing
2090 *
2091 * @return string Keyword: "all", "cached" or "output"
2092 */
2093 function doLocalAnchorFix() {
2094 return $this->config['config']['prefixLocalAnchors'];
2095 }
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112 /********************************************
2113 *
2114 * Finished off; outputting, storing session data, statistics...
2115 *
2116 *******************************************/
2117
2118 /**
2119 * Determines if content should be outputted.
2120 * Outputting content is done only if jumpurl is NOT set.
2121 *
2122 * @return boolean Returns true if $this->jumpurl is not set.
2123 */
2124 function isOutputting() {
2125 return (!$this->jumpurl);
2126 }
2127
2128 /**
2129 * Processes the output before it's actually outputted. Sends headers also.
2130 * This includes substituting the USERNAME comment, getMethodUrlIdToken, sending additional headers (as defined in the TypoScript "config.additionalheaders" object), tidy'ing content, XHTML cleaning content (if configured)
2131 * Works on $this->content
2132 *
2133 * @return void
2134 */
2135 function processOutput() {
2136 // Substitutes username mark with the username
2137 if ($this->fe_user->user['uid']) {
2138 $token = trim($this->config['config']['USERNAME_substToken']);
2139 $this->content = str_replace($token ? $token : '<!--###USERNAME###-->',$this->fe_user->user['username'],$this->content);
2140 }
2141 // Substitutes get_URL_ID in case of GET-fallback
2142 if ($this->getMethodUrlIdToken) {
2143 $this->content = str_replace($this->getMethodUrlIdToken, $this->fe_user->get_URL_ID, $this->content);
2144 }
2145
2146 // Set header for charset-encoding if set. Added by RL 17.10.03
2147 if ($this->config['config']['metaCharset']) {
2148 $headLine = 'Content-Type:text/html;charset='.trim ($this->config['config']['metaCharset']);
2149 header ($headLine);
2150 }
2151
2152 // Set headers, if any
2153 if ($this->config['config']['additionalHeaders']) {
2154 $headerArray = explode('|', $this->config['config']['additionalHeaders']);
2155 while(list(,$headLine)=each($headerArray)) {
2156 $headLine = trim($headLine);
2157 header($headLine);
2158 }
2159 }
2160
2161 // Tidy up the code, if flag...
2162 if ($this->TYPO3_CONF_VARS['FE']['tidy_option'] == 'output') {
2163 $GLOBALS['TT']->push('Tidy, output','');
2164 $this->content = $this->tidyHTML($this->content);
2165 $GLOBALS['TT']->pull();
2166 }
2167 // XHTML-clean the code, if flag set
2168 if ($this->doXHTML_cleaning() == 'output') {
2169 $GLOBALS['TT']->push('XHTML clean, output','');
2170 $XHTML_clean = t3lib_div::makeInstance('t3lib_parsehtml');
2171 $this->content = $XHTML_clean->XHTML_clean($this->content);
2172 $GLOBALS['TT']->pull();
2173 }
2174 // Fix local anchors in links, if flag set
2175 if ($this->doLocalAnchorFix() == 'output') {
2176 $GLOBALS['TT']->push('Local anchor fix, output','');
2177 $this->prefixLocalAnchorsWithScript();
2178 $GLOBALS['TT']->pull();
2179 }
2180
2181 // Hook for post-processing of page content before output:
2182 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['contentPostProc-output'])) {
2183 $_params = array('pObj' => &$this);
2184 foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['contentPostProc-output'] as $_funcRef) {
2185 t3lib_div::callUserFunction($_funcRef,$_params,$this);
2186 }
2187 }
2188
2189 /* if ($this->beUserLogin && t3lib_div::_GP('ADMCMD_view')) { // This is a try to change target=_top to target=_self if pages are shown in the Web>View module...
2190 $this->content = str_replace('target="_top"','target="_self"',$this->content);
2191 $this->content = str_replace('target=_top','target="_self"',$this->content);
2192 }*/
2193 }
2194
2195 /**
2196 * Determines if any EXTincScripts should be included
2197 *
2198 * @return boolean True, if external php scripts should be included (set by PHP_SCRIPT_EXT cObjects)
2199 * @see tslib_cObj::PHP_SCRIPT
2200 */
2201 function isEXTincScript() {
2202 return is_array($this->config['EXTincScript']);
2203 }
2204
2205 /**
2206 * Stores session data for the front end user
2207 *
2208 * @return void
2209 */
2210 function storeSessionData() {
2211 $this->fe_user->storeSessionData();
2212 }
2213
2214 /**
2215 * Sets the parsetime of the page.
2216 *
2217 * @return void
2218 * @access private
2219 */
2220 function setParseTime() {
2221 // Compensates for the time consumed with Back end user initialization.
2222 $this->scriptParseTime = $GLOBALS['TT']->convertMicrotime($GLOBALS['TYPO3_MISC']['microtime_end'])
2223 - $GLOBALS['TT']->convertMicrotime($GLOBALS['TYPO3_MISC']['microtime_start'])
2224 - ($GLOBALS['TT']->convertMicrotime($GLOBALS['TYPO3_MISC']['microtime_BE_USER_end'])-$GLOBALS['TT']->convertMicrotime($GLOBALS['TYPO3_MISC']['microtime_BE_USER_start']));
2225 }
2226
2227 /**
2228 * Saves hit statistics
2229 *
2230 * @return void
2231 */
2232 function statistics() {
2233 if ($this->config['config']['stat'] &&
2234 (!strcmp('',$this->config['config']['stat_typeNumList']) || t3lib_div::inList(str_replace(' ','',$this->config['config']['stat_typeNumList']), $this->type)) &&
2235 (!$this->config['config']['stat_excludeBEuserHits'] || !$this->beUserLogin) &&
2236 (!$this->config['config']['stat_excludeIPList'] || !t3lib_div::inList(str_replace(' ','',$this->config['config']['stat_excludeIPList']), t3lib_div::getIndpEnv('REMOTE_ADDR')))) {
2237 $GLOBALS['TT']->push('Stat');
2238 if (t3lib_extMgm::isLoaded('sys_stat') && $this->config['config']['stat_mysql']) {
2239
2240 // Jumpurl:
2241 $sword = t3lib_div::_GP('sword');
2242 if ($sword) {
2243 $jumpurl_msg = 'sword:'.$sword;
2244 } elseif ($this->jumpurl) {
2245 $jumpurl_msg = 'jumpurl:'.$this->jumpurl;
2246 } else {
2247 $jumpurl_msg = '';
2248 }
2249
2250 // Flags: bits: 0 = BE_user, 1=Cached page?
2251 $flags=0;
2252 if ($this->beUserLogin) {$flags|=1;}
2253 if ($this->cacheContentFlag) {$flags|=2;}
2254
2255 // Ref url:
2256 $refUrl = t3lib_div::getIndpEnv('HTTP_REFERER');
2257 $thisUrl = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR');
2258 if (t3lib_div::isFirstPartOfStr($refUrl,$thisUrl)) {
2259 $refUrl='[LOCAL]';
2260 }
2261
2262 $insertFields = array(
2263 'page_id' => intval($this->id), // id
2264 'page_type' => intval($this->type), // type
2265 'jumpurl' => $jumpurl_msg, // jumpurl message
2266 'feuser_id' => $this->fe_user->user['uid'], // fe_user id, integer
2267 'cookie' => $this->fe_user->id, // cookie as set or retrieve. If people has cookies disabled this will vary all the time...
2268 'sureCookie' => hexdec(substr($this->fe_user->cookieId,0,8)), // This is the cookie value IF the cookie WAS actually set. However the first hit where the cookie is set will thus NOT be logged here. So this lets you select for a session of at least two clicks...
2269 'rl0' => $this->config['rootLine'][0]['uid'], // RootLevel 0 uid
2270 'rl1' => $this->config['rootLine'][1]['uid'], // RootLevel 1 uid
2271 'client_browser' => $GLOBALS['CLIENT']['BROWSER'], // Client browser (net, msie, opera)
2272 'client_version' => $GLOBALS['CLIENT']['VERSION'], // Client version (double value)
2273 'client_os' => $GLOBALS['CLIENT']['SYSTEM'], // Client Operating system (win, mac, unix)
2274 'parsetime' => intval($this->scriptParseTime), // Parsetime for the page.
2275 'flags' => $flags, // Flags: Is be user logged in? Is page cached?
2276 'IP' => t3lib_div::getIndpEnv('REMOTE_ADDR'), // Remote IP address
2277 'host' => t3lib_div::getIndpEnv('REMOTE_HOST'), // Remote Host Address
2278 'referer' => $refUrl, // Referer URL
2279 'browser' => t3lib_div::getIndpEnv('HTTP_USER_AGENT'), // User Agent Info.
2280 'tstamp' => $GLOBALS['EXEC_TIME'] // Time stamp
2281 );
2282
2283 $GLOBALS['TT']->push('Store SQL');
2284 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_stat', $insertFields);
2285 $GLOBALS['TT']->pull();
2286 }
2287
2288 // Apache:
2289 if ($this->config['config']['stat_apache'] && $this->config['stat_vars']['pageName']) {
2290 if (@is_file($this->config['stat_vars']['logFile']) && TYPO3_OS!='WIN') {
2291 $LogLine = ((t3lib_div::getIndpEnv('REMOTE_HOST') && !$this->config['config']['stat_apache_noHost']) ? t3lib_div::getIndpEnv('REMOTE_HOST') : t3lib_div::getIndpEnv('REMOTE_ADDR')).' - - '.Date('[d/M/Y:H:i:s +0000]',$GLOBALS['EXEC_TIME']).' "GET '.$this->config['stat_vars']['pageName'].' HTTP/1.1" 200 '.strlen($this->content);
2292 if (!$this->config['config']['stat_apache_notExtended']) {
2293 $LogLine.= ' "'.t3lib_div::getIndpEnv('HTTP_REFERER').'" "'.t3lib_div::getIndpEnv('HTTP_USER_AGENT').'"';
2294 }
2295
2296 switch($this->TYPO3_CONF_VARS['FE']['logfile_write']) {
2297 case 'fputs':
2298 $GLOBALS['TT']->push('Write to log file (fputs)');
2299 $logfilehandle = fopen(PATH_site.$this->config['stat_vars']['logFile'], 'a');
2300 fputs($logfilehandle, $LogLine."\n");
2301 @fclose($logfilehandle);
2302 $GLOBALS['TT']->pull();
2303 break;
2304 default:
2305 $GLOBALS['TT']->push('Write to log file (echo)');
2306 $execCmd = 'echo "'.addslashes($LogLine).'" >> '.PATH_site.$this->config['stat_vars']['logFile'];
2307 exec($execCmd);
2308 $GLOBALS['TT']->pull();
2309 break;
2310 }
2311
2312 $GLOBALS['TT']->setTSlogMessage('Writing to logfile: OK',0);
2313 } else {
2314 $GLOBALS['TT']->setTSlogMessage('Writing to logfile: Error - logFile did not exist or OS is Windows!',3);
2315 }
2316 }
2317 $GLOBALS['TT']->pull();
2318 }
2319 }
2320
2321 /**
2322 * Outputs preview info.
2323 *
2324 * @return void
2325 */
2326 function previewInfo() {
2327 if ($this->fePreview) {
2328 $stdMsg = '
2329 <br />
2330 <div align="center">
2331 <table border="3" bordercolor="black" cellpadding="2" bgcolor="red">
2332 <tr>
2333 <td>&nbsp;&nbsp;<font face="Verdana" size="1"><b>PREVIEW!</b></font>&nbsp;&nbsp;</td>
2334 </tr>
2335 </table>
2336 </div>';
2337 $temp_content = $this->config['config']['message_preview'] ? $this->config['config']['message_preview'] : $stdMsg;
2338 echo $temp_content;
2339 }
2340 }
2341
2342 /**
2343 * Returns a link to the login screen with redirect to the front-end
2344 *
2345 * @return string HTML, a tag for a link to the backend.
2346 */
2347 function beLoginLinkIPList() {
2348 if ($this->config['config']['beLoginLinkIPList']) {
2349 if (t3lib_div::cmpIP(t3lib_div::getIndpEnv('REMOTE_ADDR'), $this->config['config']['beLoginLinkIPList'])) {
2350 $label = !$this->beUserLogin ? $this->config['config']['beLoginLinkIPList_login'] : $this->config['config']['beLoginLinkIPList_logout'];
2351 if ($label) {
2352 if (!$this->beUserLogin) {
2353 $link = '<a href="'.htmlspecialchars(TYPO3_mainDir.'index.php?redirect_url='.rawurlencode(t3lib_div::getIndpEnv("REQUEST_URI"))).'">'.$label.'</a>';
2354 } else {
2355 $link = '<a href="'.htmlspecialchars(TYPO3_mainDir.'index.php?L=OUT&redirect_url='.rawurlencode(t3lib_div::getIndpEnv("REQUEST_URI"))).'">'.$label.'</a>';
2356 }
2357 return $link;
2358 }
2359 }
2360 }
2361 }
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384 /********************************************
2385 *
2386 * Various internal API functions
2387 *
2388 *******************************************/
2389
2390
2391 /**
2392 * Make simulation filename (without the ".html" ending, only body of filename)
2393 *
2394 * @param string The page title to use
2395 * @param mixed The page id (integer) or alias (string)
2396 * @param integer The type number
2397 * @param string Query-parameters to encode (will be done only if caching is enabled and TypoScript configured for it. I don't know it this makes much sense in fact...)
2398 * @param boolean The "no_cache" status of the link.
2399 * @return string The body of the filename.
2400 * @see getSimulFileName(), t3lib_tstemplate::linkData(), tslib_frameset::frameParams()
2401 */
2402 function makeSimulFileName($inTitle,$page,$type,$addParams='',$no_cache='') {
2403 $titleChars = intval($this->config['config']['simulateStaticDocuments_addTitle']);
2404 $out='';
2405 if ($titleChars) {
2406 $out = t3lib_div::convUmlauts($inTitle);
2407 $out= ereg_replace('[^[:alnum:]_-]','_',trim(substr($out,0,$titleChars)));
2408 $out= ereg_replace('_*$','',$out);
2409 $out= ereg_replace('^_*','',$out);
2410 if ($out) $out.='.';
2411 }
2412 $enc='';
2413 if (strcmp($addParams,'') && !$no_cache) {
2414 switch ((string)$this->config['config']['simulateStaticDocuments_pEnc']) {
2415 case 'md5':
2416 $md5=substr(md5($addParams),0,10);
2417 $enc='+M5'.$md5;
2418
2419 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('md5hash', 'cache_md5params', 'md5hash="'.$GLOBALS['TYPO3_DB']->quoteStr($md5, 'cache_md5params').'"');
2420 if (!$GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
2421 $insertFields = array(
2422 'md5hash' => $md5,
2423 'tstamp' => time(),
2424 'type' => 1,
2425 'params' => $addParams
2426 );
2427
2428 $GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_md5params', $insertFields);
2429 }
2430 break;
2431 case 'base64':
2432 $enc='+B6'.str_replace('=','_',str_replace('/','-',base64_encode($addParams)));
2433 break;
2434 }
2435 }
2436 // Setting page and type number:
2437 $url = $out.$page.$enc;
2438 $url.= ($type || $out || !$this->config['config']['simulateStaticDocuments_noTypeIfNoTitle']) ? '.'.$type : '';
2439 return $url;
2440 }
2441
2442 /**
2443 * Processes a query-string with GET-parameters and returns two strings, one with the parameters that CAN be encoded and one array with those which can't be encoded (encoded by the M5 or B6 methods)
2444 *
2445 * @param string Query string to analyse
2446 * @return array Two num keys returned, first is the parameters that MAY be encoded, second is the non-encodable parameters.
2447 * @see makeSimulFileName(), t3lib_tstemplate::linkData()
2448 */
2449 function simulateStaticDocuments_pEnc_onlyP_proc($linkVars) {
2450 $remainLinkVars='';
2451 if (strcmp($linkVars,'')) {
2452 $p = explode('&',$linkVars);
2453 sort($p); // This sorts the parameters - and may not be needed and further it will generate new MD5 hashes in many cases. Maybe not so smart. Hmm?
2454 $rem=array();
2455 foreach($p as $k => $v) {
2456 if ((string)$v) {
2457 list($pName) = explode('=',$v,2);
2458 if (!$this->pEncAllowedParamNames[$pName]) {
2459 unset($p[$k]);
2460 $rem[]=$v;
2461 }
2462 } else unset($p[$k]);
2463 }
2464
2465 $linkVars = count($p) ? '&'.implode('&',$p) : '';
2466 $remainLinkVars = count($rem) ? '&'.implode('&',$rem) : '';
2467 }
2468 return array($linkVars, $remainLinkVars);
2469 }
2470
2471 /**
2472 * Returns the simulated static file name (*.html) for the current page (using the page record in $this->page)
2473 *
2474 * @return string The filename (without path)
2475 * @see makeSimulFileName(), publish.php
2476 */
2477 function getSimulFileName() {
2478 $url='';
2479 $url.=$this->makeSimulFileName($this->page['title'], $this->page['alias']?$this->page['alias']:$this->id, $this->type).'.html';
2480 return $url;
2481 }
2482
2483 /**
2484 * Encryption of email addresses for <A>-tags See the spam protection setup in TS 'config.'
2485 *
2486 * @param string Input string to en/decode: "mailto:blabla@bla.com"
2487 * @param boolean If set, the process is reversed, effectively decoding, not encoding.
2488 * @return string encoded/decoded version of $string
2489 */
2490 function encryptEmail($string,$back=0) {
2491 $out = '';
2492 for ($a=0; $a<strlen($string); $a++) {
2493 $charValue = ord(substr($string,$a,1));
2494 $charValue+= intval($GLOBALS['TSFE']->spamProtectEmailAddresses)*($back?-1:1);
2495 $out.= chr($charValue);
2496 }
2497 return $out;
2498 }
2499
2500 /**
2501 * Checks if a PHPfile may be included.
2502 *
2503 * @param string Relative path to php file
2504 * @return boolean Returns true if $GLOBALS['TYPO3_CONF_VARS']['FE']['noPHPscriptInclude'] is not set OR if the file requested for inclusion is found in one of the allowed paths.
2505 * @see tslib_cObj::PHP_SCRIPT(), tslib_feTCE::includeScripts(), tslib_menu::includeMakeMenu()
2506 */
2507 function checkFileInclude($incFile) {
2508 return !$this->TYPO3_CONF_VARS['FE']['noPHPscriptInclude']
2509 || substr($incFile,0,14)=='media/scripts/'
2510 || substr($incFile,0,4+strlen(TYPO3_mainDir))==TYPO3_mainDir.'ext/'
2511 || substr($incFile,0,7+strlen(TYPO3_mainDir))==TYPO3_mainDir.'sysext/'
2512 || substr($incFile,0,14)=='typo3conf/ext/';
2513 }
2514
2515 /**
2516 * Creates an instance of tslib_cObj in $this->cObj
2517 * This instance is used to start the rendering of the TypoScript template structure
2518 *
2519 * @return void
2520 * @see pagegen.php
2521 */
2522 function newCObj() {
2523 $this->cObj =t3lib_div::makeInstance('tslib_cObj');
2524 $this->cObj->start($this->page,'pages');
2525 }
2526
2527 /**
2528 * Substitute the path's to files in the media/ folder like icons used in static_template of TypoScript
2529 * Works on $this->content
2530 *
2531 * @return void
2532 * @access private
2533 * @see pagegen.php, INTincScript()
2534 */
2535 function setAbsRefPrefix() {
2536 if ($this->absRefPrefix) {
2537 $this->content = str_replace('"media/', '"'.$this->absRefPrefix.'media/', $this->content);
2538 $this->content = str_replace('"fileadmin/', '"'.$this->absRefPrefix.'fileadmin/', $this->content);
2539 }
2540 }
2541
2542 /**
2543 * Prints error msg/header.
2544 * Echoes out the HTML content
2545 *
2546 * @param string Message string
2547 * @param string Header string
2548 * @return void
2549 * @see t3lib_timeTrack::debug_typo3PrintError()
2550 */
2551 function printError($label,$header='Error!') {
2552 t3lib_timeTrack::debug_typo3PrintError($header,$label,0);
2553 }
2554
2555 /**
2556 * Updates the tstamp field of a cache_md5params record to the current time.
2557 *
2558 * @param string The hash string identifying the cache_md5params record for which to update the "tstamp" field to the current time.
2559 * @return void
2560 * @access private
2561 */
2562 function updateMD5paramsRecord($hash) {
2563 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('cache_md5params', 'md5hash="'.$GLOBALS['TYPO3_DB']->quoteStr($hash, 'cache_md5params').'"', array('tstamp' => time()));
2564 }
2565
2566 /**
2567 * Pass the content through tidy - a little program that cleans up HTML-code
2568 * Requires $this->TYPO3_CONF_VARS['FE']['tidy'] to be true and $this->TYPO3_CONF_VARS['FE']['tidy_path'] to contain the filename/path of tidy including clean-up arguments for tidy. See default value in TYPO3_CONF_VARS in t3lib/config_default.php
2569 *
2570 * @param string The page content to clean up. Will be written to a temporary file which "tidy" is then asked to clean up. File content is read back and returned.
2571 * @return string Returns the
2572 */
2573 function tidyHTML($content) {
2574 if ($this->TYPO3_CONF_VARS['FE']['tidy'] && $this->TYPO3_CONF_VARS['FE']['tidy_path']) {
2575 $oldContent = $content;
2576 $fname = t3lib_div::tempnam('Typo3_Tidydoc_'); // Create temporary name
2577 @unlink ($fname); // Delete if exists, just to be safe.
2578 $fp = fopen ($fname,'wb'); // Open for writing
2579 fputs ($fp, $content); // Put $content
2580 @fclose ($fp); // Close
2581
2582 exec ($this->TYPO3_CONF_VARS['FE']['tidy_path'].' '.$fname, $output); // run the $content through 'tidy', which formats the HTML to nice code.
2583 @unlink ($fname); // Delete the tempfile again
2584 $content = implode($output,chr(10));
2585 if (!trim($content)) {
2586 $content = $oldContent; // Restore old content due empty return value.
2587 $GLOBALS['TT']->setTSlogMessage('"tidy" returned an empty value!',2);
2588 }
2589 $GLOBALS['TT']->setTSlogMessage('"tidy" content lenght: '.strlen($content),0);
2590 }
2591 return $content;
2592 }
2593
2594 /**
2595 * Substitutes all occurencies of <a href="#"... in $this->content with <a href="[path-to-url]#"...
2596 *
2597 * @return void Works directly on $this->content
2598 */
2599 function prefixLocalAnchorsWithScript() {
2600 $scriptPath = substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_URL'),strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL')));
2601 $this->content = eregi_replace('(<(a|area)[[:space:]]+href=")(#[^"]*")','\1'.htmlspecialchars($scriptPath).'\3',$this->content);
2602 }
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631 /********************************************
2632 *
2633 * Various external API functions - for use in plugins etc.
2634 *
2635 *******************************************/
2636
2637
2638 /**
2639 * Traverses the ->rootLine and returns an array with the first occurrance of storage pid and siteroot pid
2640 *
2641 * @return array Array with keys '_STORAGE_PID' and '_SITEROOT' set to the first occurances found.
2642 */
2643 function getStorageSiterootPids() {
2644 $res=array();
2645 reset($this->rootLine);
2646 while(list(,$rC)=each($this->rootLine)) {
2647 if (!$res['_STORAGE_PID']) $res['_STORAGE_PID']=intval($rC['storage_pid']);
2648 if (!$res['_SITEROOT']) $res['_SITEROOT']=$rC['is_siteroot']?intval($rC['uid']):0;
2649 }
2650 return $res;
2651 }
2652
2653 /**
2654 * Returns the pages TSconfig array based on the currect ->rootLine
2655 *
2656 * @return array
2657 */
2658 function getPagesTSconfig() {
2659 if (!is_array($this->pagesTSconfig)) {
2660 reset($this->rootLine);
2661 $TSdataArray = array();
2662 $TSdataArray[] = $this->TYPO3_CONF_VARS['BE']['defaultPageTSconfig']; // Setting default configuration:
2663 while(list($k,$v)=each($this->rootLine)) {
2664 $TSdataArray[]=$v['TSconfig'];
2665 }
2666 // Parsing the user TS (or getting from cache)
2667 $TSdataArray = t3lib_TSparser::checkIncludeLines_array($TSdataArray);
2668 $userTS = implode($TSdataArray,chr(10).'[GLOBAL]'.chr(10));
2669 $hash = md5('pageTS:'.$userTS);
2670 $cachedContent = $this->sys_page->getHash($hash,0);
2671 if (isset($cachedContent)) {
2672 $this->pagesTSconfig = unserialize($cachedContent);
2673 } else {
2674 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
2675 $parseObj->parse($userTS);
2676 $this->pagesTSconfig = $parseObj->setup;
2677 $this->sys_page->storeHash($hash,serialize($this->pagesTSconfig),'PAGES_TSconfig');
2678 }
2679 }
2680 return $this->pagesTSconfig;
2681 }
2682
2683 /**
2684 * Sets JavaScript code in the additionalJavaScript array
2685 *
2686 * @param string $key is the key in the array, for num-key let the value be empty. Note reserved keys 'openPic' and 'mouseOver'
2687 * @param string $content is the content if you want any
2688 * @return void
2689 * @see tslib_gmenu::writeMenu(), tslib_cObj::imageLinkWrap()
2690 */
2691 function setJS($key,$content='') {
2692 if ($key) {
2693 switch($key) {
2694 case 'mouseOver':
2695 $this->additionalJavaScript[$key]=
2696 ' // JS function for mouse-over
2697 function over(name,imgObj) { //
2698 if (version == "n3" && document[name]) {document[name].src = eval(name+"_h.src");}
2699 else if (imgObj) {imgObj.src = eval(name+"_h.src");}
2700 }
2701 // JS function for mouse-out
2702 function out(name,imgObj) { //
2703 if (version == "n3" && document[name]) {document[name].src = eval(name+"_n.src");}
2704 else if (imgObj) {imgObj.src = eval(name+"_n.src");}
2705 }';
2706 break;
2707 case 'openPic':
2708 $this->additionalJavaScript[$key]=
2709 ' function openPic(url,winName,winParams) { //
2710 var theWindow = window.open(url,winName,winParams);
2711 if (theWindow) {theWindow.focus();}
2712 }';
2713 break;
2714 default:
2715 $this->additionalJavaScript[$key]=$content;
2716 break;
2717 }
2718 }
2719 }
2720
2721 /**
2722 * Sets CSS data in the additionalCSS array
2723 *
2724 * @param string $key is the key in the array, for num-key let the value be empty
2725 * @param string $content is the content if you want any
2726 * @return void
2727 * @see setJS(), tslib_pibase::pi_setClassStyle()
2728 */
2729 function setCSS($key,$content) {
2730 if ($key) {
2731 switch($key) {
2732 default:
2733 $this->additionalCSS[$key]=$content;
2734 break;
2735 }
2736 }
2737 }
2738
2739 /**
2740 * Seeds the random number engine.
2741 *
2742 * @return void
2743 */
2744 function make_seed() {
2745 list($usec, $sec) = explode(' ', microtime());
2746 $seedV = (float)$sec + ((float)$usec * 100000);
2747 srand($seedV);
2748 }
2749
2750 /**
2751 * Returns a unique md5 hash.
2752 * There is no special magic in this, the only point is that you don't have to call md5(uniqid()) which is slow and by this you are sure to get a unique string each time in a little faster way.
2753 *
2754 * @param string Some string to include in what is hashed. Not significant at all.
2755 * @return string MD5 hash of ->uniqueString, input string and uniqueCounter
2756 */
2757 function uniqueHash($str='') {
2758 return md5($this->uniqueString.'_'.$str.$this->uniqueCounter++);
2759 }
2760
2761 /**
2762 * Sets the cache-flag to 1. Could be called from user-included php-files in order to ensure that a page is not cached.
2763 *
2764 * @return void
2765 */
2766 function set_no_cache() {
2767 $this->no_cache = 1;
2768 }
2769
2770 /**
2771 * Sets the cache-timeout in seconds
2772 *
2773 * @param integer cache-timeout in seconds
2774 * @return void
2775 */
2776 function set_cache_timeout_default($seconds) {
2777 $this->cacheTimeOutDefault = intval($seconds);
2778 }
2779
2780 /**
2781 * Substitute function for the PHP mail() function.
2782 * It will encode the email with the setting of TS 'config.notification_email_encoding' (base64 or none)
2783 * It will also find all links to http:// in the text and substitute with a shorter link using the redirect feature which stores the long link in the database. Depends on configuration in TS 'config.notification_email_urlmode'
2784 *
2785 * @param string recipient email address (or list of)
2786 * @param string The subject
2787 * @param string The message
2788 * @param string The headers (string with lines)
2789 * @return void
2790 * @see t3lib_div::plainMailEncoded()
2791 */
2792 function plainMailEncoded($email,$subject,$message,$headers='') {
2793 $urlmode=$this->config['config']['notification_email_urlmode']; // '76', 'all', ''
2794
2795 if ($urlmode) {
2796 $message=t3lib_div::substUrlsInPlainText($message,$urlmode);
2797 }
2798
2799 t3lib_div::plainMailEncoded(
2800 $email,
2801 $subject,
2802 $message,
2803 $headers,
2804 $this->config['config']['notification_email_encoding'],
2805 $this->config['config']['notification_email_charset']?$this->config['config']['notification_email_charset']:'ISO-8859-1'
2806 );
2807 }
2808
2809 /**
2810 * Split Label function for front-end applications.
2811 *
2812 * @param string Key string. Accepts the "LLL:" prefix.
2813 * @return string Label value, if any.
2814 */
2815 function sL($input) {
2816 if (!$this->lang) $this->initLLvars();
2817
2818 if (strcmp(substr($input,0,4),'LLL:')) {
2819 $t = explode('|',$input);
2820 return $t[$this->langSplitIndex] ? $t[$this->langSplitIndex] : $t[0];
2821 } else {
2822 if (!isset($this->LL_labels_cache[$this->lang][$input])) { // If cached label
2823 $restStr = trim(substr($input,4));
2824 $extPrfx='';
2825 if (!strcmp(substr($restStr,0,4),'EXT:')) {
2826 $restStr = trim(substr($restStr,4));
2827 $extPrfx='EXT:';
2828 }
2829 $parts = explode(':',$restStr);
2830 $parts[0]=$extPrfx.$parts[0];
2831 if (!isset($this->LL_files_cache[$parts[0]])) { // Getting data if not cached
2832 $this->LL_files_cache[$parts[0]] = $this->readLLfile($parts[0]);
2833 }
2834 $this->LL_labels_cache[$this->lang][$input] = $this->csConv($this->getLLL($parts[1],$this->LL_files_cache[$parts[0]]));
2835 }
2836 return $this->LL_labels_cache[$this->lang][$input];
2837 }
2838 }
2839
2840 /**
2841 * Converts the charset of the input string if applicable.
2842 * The "from" charset is determined by the TYPO3 system charset for the current language key ($this->lang)
2843 * The "to" charset is determined by the currently used charset for the page which is "iso-8859-1" by default or set by $GLOBALS['TSFE']->config['config']['metaCharset']
2844 * Only if there is a difference between the two charsets will a conversion be made
2845 * The conversion is done real-time - no caching for performance at this point!
2846 *
2847 * @param string String to convert charset for
2848 * @param string Optional "from" charset.
2849 * @return string Output string, converted if needed.
2850 * @see initLLvars(), t3lib_cs
2851 */
2852 function csConv($str,$from='') {
2853 if (!$this->lang) $this->initLLvars();
2854
2855 if ($from) {
2856 $output = $this->csConvObj->conv($str,$this->csConvObj->parse_charset($from),$this->siteCharset,1);
2857 return $output ? $output : $str;
2858 } elseif (is_array($this->convCharsetToFrom)) {
2859 return $this->csConvObj->conv($str,$this->convCharsetToFrom['from'],$this->convCharsetToFrom['to'],1);
2860 } else {
2861 return $str;
2862 }
2863 }
2864
2865 /**
2866 * Read locallang files - for frontend applications
2867 *
2868 * @param string Reference to a relative filename to include.
2869 * @return array Returns the $LOCAL_LANG array found in the file. If no array found, returns empty array.
2870 */
2871 function readLLfile($fileRef) {
2872 $file = t3lib_div::getFileAbsFileName($fileRef);
2873 if (@is_file($file)) {
2874 include($file);
2875 }
2876 return is_array($LOCAL_LANG)?$LOCAL_LANG:array();
2877 }
2878
2879 /**
2880 * Returns 'locallang' label - may need initializing by initLLvars
2881 *
2882 * @param string Local_lang key for which to return label (language is determined by $this->lang)
2883 * @param array The locallang array in which to search
2884 * @return string Label value of $index key.
2885 */
2886 function getLLL($index,$LOCAL_LANG) {
2887 if (strcmp($LOCAL_LANG[$this->lang][$index],'')) {
2888 return $LOCAL_LANG[$this->lang][$index];
2889 } else {
2890 return $LOCAL_LANG['default'][$index];
2891 }
2892 }
2893
2894 /**
2895 * Initializing the getLL variables needed.
2896 * Sets $this->langSplitIndex based on $this->config['config']['language']
2897 *
2898 * @return void
2899 */
2900 function initLLvars() {
2901 $this->lang = $this->config['config']['language'] ? $this->config['config']['language'] : 'default';
2902
2903 $ls = explode('|',TYPO3_languages);
2904 while(list($i,$v)=each($ls)) {
2905 if ($v==$this->lang) {$this->langSplitIndex=$i; break;}
2906 }
2907
2908 // Setting charsets:
2909 $this->siteCharset = $this->csConvObj->parse_charset($GLOBALS['TSFE']->config['config']['metaCharset'] ? $GLOBALS['TSFE']->config['config']['metaCharset'] : $GLOBALS['TSFE']->defaultCharSet);
2910 $this->labelsCharset = $this->csConvObj->parse_charset($this->csConvObj->charSetArray[$this->lang] ? $this->csConvObj->charSetArray[$this->lang] : 'iso-8859-1');
2911 if ($this->siteCharset != $this->labelsCharset) {
2912 $this->convCharsetToFrom=array(
2913 'from' => $this->labelsCharset,
2914 'to' => $this->siteCharset
2915 );
2916 }
2917 }
2918 }
2919
2920
2921
2922 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['tslib/class.tslib_fe.php']) {
2923 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['tslib/class.tslib_fe.php']);
2924 }
2925 ?>