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