Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / init.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * TYPO3 Backend initialization
29 *
30 * This script is called by every backend script.
31 * The script authenticates the backend user.
32 * In addition this script also initializes the database and other stuff by including the script localconf.php
33 *
34 * IMPORTANT:
35 * This script exits if no user is logged in!
36 * If you want the script to return even if no user is logged in,
37 * you must define the constant TYPO3_PROCEED_IF_NO_USER=1
38 * before you include this script.
39 *
40 *
41 * This script does the following:
42 * - extracts and defines path's
43 * - includes certain libraries
44 * - authenticates the user
45 * - sets the configuration values (localconf.php)
46 * - includes tables.php that sets more values and possibly overrides others
47 * - load the groupdata for the user and set filemounts / webmounts
48 *
49 * For a detailed description of this script, the scope of constants and variables in it,
50 * please refer to the document "Inside TYPO3"
51 *
52 * $Id$
53 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
54 *
55 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
56 * @package TYPO3
57 * @subpackage core
58 */
59
60 // *******************************
61 // Checking PHP version
62 // *******************************
63 if (version_compare(phpversion(), '5.2', '<')) die ('TYPO3 requires PHP 5.2.0 or higher.');
64
65
66 // *******************************
67 // Set error reporting
68 // *******************************
69 if (defined('E_DEPRECATED')) {
70 error_reporting(E_ALL ^ E_NOTICE ^ E_DEPRECATED);
71 } else {
72 error_reporting(E_ALL ^ E_NOTICE);
73 }
74
75 // *******************************
76 // Prevent any unwanted output that may corrupt AJAX/compression. Note: this does
77 // not interfeer with "die()" or "echo"+"exit()" messages!
78 // *******************************
79 ob_start();
80
81 // *******************************
82 // Define constants
83 // *******************************
84 define('TYPO3_OS', stristr(PHP_OS,'win')&&!stristr(PHP_OS,'darwin')?'WIN':'');
85 define('TYPO3_MODE','BE');
86 define('PATH_thisScript',str_replace('//','/', str_replace('\\','/', (PHP_SAPI=='cgi'||PHP_SAPI=='isapi' ||PHP_SAPI=='cgi-fcgi')&&($_SERVER['ORIG_PATH_TRANSLATED']?$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED'])? ($_SERVER['ORIG_PATH_TRANSLATED']?$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED']):($_SERVER['ORIG_SCRIPT_FILENAME']?$_SERVER['ORIG_SCRIPT_FILENAME']:$_SERVER['SCRIPT_FILENAME']))));
87 define('TYPO3_mainDir', 'typo3/'); // This is the directory of the backend administration for the sites of this TYPO3 installation.
88
89
90 // *******************************
91 // Fix BACK_PATH, if the TYPO3_mainDir is set to something else than
92 // typo3/, this is a workaround because the conf.php of the old modules
93 // still have "typo3/" hardcoded. Can be removed once we don't have to worry about
94 // legacy modules (with conf.php and $BACK_PATH) anymore. See RFC / Bug #13262 for more details.
95 // *******************************
96 if (isset($BACK_PATH) && strlen($BACK_PATH) > 0 && TYPO3_mainDir != 'typo3/' && substr($BACK_PATH, -7) == '/typo3/') {
97 $BACK_PATH = substr($BACK_PATH, 0, -6) . TYPO3_mainDir;
98 }
99
100 // *******************************
101 // Checking path
102 // *******************************
103 $temp_path = str_replace('\\','/',dirname(PATH_thisScript).'/');
104 $temp_modPath='';
105 // If TYPO3_MOD_PATH is defined we must calculate the modPath since init.php must be included by a module
106 if (substr($temp_path,-strlen(TYPO3_mainDir))!=TYPO3_mainDir) {
107 if (defined('TYPO3_MOD_PATH')) {
108 if (substr($temp_path,-strlen(TYPO3_MOD_PATH))==TYPO3_MOD_PATH) {
109 $temp_path=substr($temp_path,0,-strlen(TYPO3_MOD_PATH));
110 $temp_modPath=TYPO3_MOD_PATH;
111 } elseif (substr(TYPO3_MOD_PATH,0,13)=='../typo3conf/' && (substr(TYPO3_MOD_PATH,3)==substr($temp_path,-strlen(substr(TYPO3_MOD_PATH,3))))) {
112 $temp_path = substr($temp_path,0,-strlen(substr(TYPO3_MOD_PATH,3))).TYPO3_mainDir;
113 $temp_modPath=TYPO3_MOD_PATH;
114 }
115 if (!@is_dir($temp_path)) {
116 $temp_path='';
117 }
118 }
119 }
120
121 // OUTPUT error message and exit if there are problems with the path. Otherwise define constants and continue.
122 if (!$temp_path || substr($temp_path,-strlen(TYPO3_mainDir))!=TYPO3_mainDir) { // This must be the case in order to proceed
123 if (TYPO3_OS=='WIN') {
124 $thisPath_base = basename(substr($temp_path,-strlen(TYPO3_mainDir)));
125 $mainPath_base = basename(TYPO3_mainDir);
126 if (!strcasecmp($thisPath, $mainPath)) { // Seems like the requested URL is not case-specific. This may happen on Windows only. -case. Otherwise, redirect to the correct URL. TYPO3_mainDir must be lower-case!!
127 $script_name = (PHP_SAPI=='cgi'||PHP_SAPI=='cgi-fcgi')&&($_SERVER['ORIG_PATH_INFO']?$_SERVER['ORIG_PATH_INFO']:$_SERVER['PATH_INFO']) ? ($_SERVER['ORIG_PATH_INFO']?$_SERVER['ORIG_PATH_INFO']:$_SERVER['PATH_INFO']) : ($_SERVER['ORIG_SCRIPT_NAME']?$_SERVER['ORIG_SCRIPT_NAME']:$_SERVER['SCRIPT_NAME']); // Copied from t3lib_div::getIndpEnv()
128 header('Location: '.str_replace($thisPath_base, $mainPath_base, $script_name));
129 exit;
130 }
131 }
132
133 echo 'Error in init.php: Path to TYPO3 main dir could not be resolved correctly. <br /><br />';
134
135 echo '<font color="red"><strong>';
136 if (strstr($temp_path,'typo3_src')) {
137 echo 'It seems you are trying to run the TYPO3 source libraries DIRECTLY! You cannot do that.<br />
138 Please read the installation documents for more information.';
139 } else {
140 echo 'This happens if the last '.strlen(TYPO3_mainDir).' characters of this path, '.$temp_path.' ($temp_path), is NOT "'.TYPO3_mainDir.'" for some reason.<br />
141 You may have a strange server configuration.
142 Or maybe you didn\'t set constant TYPO3_MOD_PATH in your module?';
143 }
144 echo '</strong></font>';
145
146 echo '<br /><br />If you want to debug this issue, please edit typo3/init.php of your TYPO3 source and search for the die() call right after this line (search for this text to find)...';
147
148 // Remove this line if you want to debug this problem a little more...
149 die();
150 echo '<br /><br /><strong>If you expect any help from anybody on this issue, you should save this page as an html document and send it along with your request for help!</strong>';
151 echo '<hr /><pre>';
152 print_r(array(
153 'TYPO3_OS'=>TYPO3_OS,
154 'PATH_thisScript'=>PATH_thisScript,
155 'php_sapi_name()'=>PHP_SAPI,
156 'TYPO3_MOD_PATH'=>TYPO3_MOD_PATH,
157 'PATH_TRANSLATED'=>$_SERVER['PATH_TRANSLATED'],
158 'SCRIPT_FILENAME'=>$_SERVER['SCRIPT_FILENAME']
159 ));
160 echo '</pre><hr />';
161 phpinfo();
162 exit;
163 } else {
164 define('PATH_typo3', $temp_path); // Abs. path of the TYPO3 admin dir (PATH_site + TYPO3_mainDir).
165 define('PATH_typo3_mod', $temp_modPath); // Relative path (from the PATH_typo3) to a properly configured module
166 define('PATH_site', substr(PATH_typo3,0,-strlen(TYPO3_mainDir))); // Abs. path to directory with the frontend (one above the admin-dir)
167 $temp_path_t3lib = @is_dir(PATH_site.'t3lib/') ? PATH_site.'t3lib/' : PATH_typo3.'t3lib/';
168 define('PATH_t3lib', $temp_path_t3lib); // Abs. path to t3lib/ (general TYPO3 library) within the TYPO3 admin dir
169 define('PATH_typo3conf', PATH_site.'typo3conf/'); // Abs. TYPO3 configuration path (local, not part of source)
170
171 if (!defined('PATH_tslib')) {
172 if (@is_dir(PATH_site . TYPO3_mainDir . 'sysext/cms/tslib/')) {
173 define('PATH_tslib', PATH_site . TYPO3_mainDir . 'sysext/cms/tslib/');
174 } elseif (@is_dir(PATH_site . 'tslib/')) {
175 define('PATH_tslib', PATH_site . 'tslib/');
176 }
177 }
178 }
179
180 // *********************
181 // Unset variable(s) in global scope (fixes #13959)
182 // *********************
183 unset($error);
184
185 // *************************************************
186 // t3lib_div + extention management class included
187 // *************************************************
188 require_once(PATH_t3lib.'class.t3lib_div.php'); // The standard-library is included
189 require_once(PATH_t3lib.'class.t3lib_extmgm.php'); // Extension API Management library included
190
191 // ****************************************************
192 // Include configuration (localconf + ext_localconf)
193 // ****************************************************
194 require(PATH_t3lib.'config_default.php');
195 if (!defined ('TYPO3_db')) die ('The configuration file was not included.');
196
197
198
199
200 // *********************
201 // Error & Exception handling
202 // *********************
203 if ($TYPO3_CONF_VARS['SC_OPTIONS']['errors']['exceptionHandler'] !== '') {
204 if ($TYPO3_CONF_VARS['SYS']['errorHandler'] !== '') {
205 // register an error handler for the given errorHandlerErrors
206 $errorHandler = t3lib_div::makeInstance($TYPO3_CONF_VARS['SYS']['errorHandler'], $TYPO3_CONF_VARS['SYS']['errorHandlerErrors']);
207 // set errors which will be converted in an exception
208 $errorHandler->setExceptionalErrors($TYPO3_CONF_VARS['SC_OPTIONS']['errors']['exceptionalErrors']);
209 }
210 $exceptionHandler = t3lib_div::makeInstance($TYPO3_CONF_VARS['SC_OPTIONS']['errors']['exceptionHandler']);
211 }
212
213 /** @var TYPO3_DB t3lib_db */
214 $TYPO3_DB = t3lib_div::makeInstance('t3lib_DB');
215 $TYPO3_DB->debugOutput = $TYPO3_CONF_VARS['SYS']['sqlDebug'];
216
217 $CLIENT = t3lib_div::clientInfo(); // $CLIENT includes information about the browser/user-agent
218 $PARSETIME_START = t3lib_div::milliseconds(); // Is set to the system time in milliseconds. This could be used to output script parsetime in the end of the script
219
220 // ***********************************
221 // Initializing the Caching System
222 // ***********************************
223
224 if (TYPO3_UseCachingFramework) {
225 $typo3CacheManager = t3lib_div::makeInstance('t3lib_cache_Manager');
226 $typo3CacheFactory = t3lib_div::makeInstance('t3lib_cache_Factory');
227 $typo3CacheFactory->setCacheManager($typo3CacheManager);
228
229 t3lib_cache::initPageCache();
230 t3lib_cache::initPageSectionCache();
231 t3lib_cache::initContentHashCache();
232 }
233 // *************************
234 // CLI dispatch processing
235 // *************************
236 if (defined('TYPO3_cliMode') && TYPO3_cliMode && basename(PATH_thisScript)=='cli_dispatch.phpsh') {
237 // First, take out the first argument (cli-key)
238 $temp_cliScriptPath = array_shift($_SERVER['argv']);
239 $temp_cliKey = array_shift($_SERVER['argv']);
240 array_unshift($_SERVER['argv'],$temp_cliScriptPath);
241
242 // If cli_key was found in configuration, then set up the cliInclude path and module name:
243 if ($temp_cliKey) {
244 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['GLOBAL']['cliKeys'][$temp_cliKey])) {
245 define('TYPO3_cliInclude', t3lib_div::getFileAbsFileName($TYPO3_CONF_VARS['SC_OPTIONS']['GLOBAL']['cliKeys'][$temp_cliKey][0]));
246 $MCONF['name'] = $TYPO3_CONF_VARS['SC_OPTIONS']['GLOBAL']['cliKeys'][$temp_cliKey][1];
247 } else {
248 echo "The supplied 'cliKey' was not valid. Please use one of the available from this list:\n\n";
249 print_r(array_keys($TYPO3_CONF_VARS['SC_OPTIONS']['GLOBAL']['cliKeys']));
250 echo LF;
251 exit;
252 }
253 } else {
254 echo "Please supply a 'cliKey' as first argument. The following are available:\n\n";
255 print_r($TYPO3_CONF_VARS['SC_OPTIONS']['GLOBAL']['cliKeys']);
256 echo LF;
257 exit;
258 }
259 }
260
261
262 // **********************
263 // Check Hardcoded lock on BE:
264 // **********************
265 if ($TYPO3_CONF_VARS['BE']['adminOnly'] < 0) {
266 t3lib_BEfunc::typo3printError('Backend locked', 'Backend and Install Tool are locked for maintenance. [BE][adminOnly] is set to "' . intval($TYPO3_CONF_VARS['BE']['adminOnly']) . '".');
267 exit;
268 }
269 if (!(defined('TYPO3_cliMode') && TYPO3_cliMode) && @is_file(PATH_typo3conf.'LOCK_BACKEND')) {
270 if (TYPO3_PROCEED_IF_NO_USER == 2) {
271 // ajax poll for login, let him pass
272 } else {
273 $fContent = t3lib_div::getUrl(PATH_typo3conf.'LOCK_BACKEND');
274 if ($fContent) {
275 header('Location: '.$fContent); // Redirect
276 } else {
277 t3lib_BEfunc::typo3printError('Backend locked', 'Browser backend is locked for maintenance. Remove lock by removing the file "typo3conf/LOCK_BACKEND" or use CLI-scripts.');
278 }
279 exit;
280 }
281
282 }
283
284 // **********************
285 // Check IP
286 // **********************
287 if (trim($TYPO3_CONF_VARS['BE']['IPmaskList']) && !(defined('TYPO3_cliMode') && TYPO3_cliMode)) {
288 if (!t3lib_div::cmpIP(t3lib_div::getIndpEnv('REMOTE_ADDR'), $TYPO3_CONF_VARS['BE']['IPmaskList'])) {
289 header('Status: 404 Not Found'); // Send Not Found header - if the webserver can make use of it...
290 header('Location: http://'); // Just point us away from here...
291 exit; // ... and exit good!
292 }
293 }
294
295
296 // **********************
297 // Check SSL (https)
298 // **********************
299 if (intval($TYPO3_CONF_VARS['BE']['lockSSL']) && !(defined('TYPO3_cliMode') && TYPO3_cliMode)) {
300 if(intval($TYPO3_CONF_VARS['BE']['lockSSLPort'])) {
301 $sslPortSuffix = ':'.intval($TYPO3_CONF_VARS['BE']['lockSSLPort']);
302 } else {
303 $sslPortSuffix = '';
304 }
305 if ($TYPO3_CONF_VARS['BE']['lockSSL'] == 3) {
306 $requestStr = substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT'), strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL').TYPO3_mainDir));
307 if($requestStr == 'index.php' && !t3lib_div::getIndpEnv('TYPO3_SSL')) {
308 list(,$url) = explode('://',t3lib_div::getIndpEnv('TYPO3_REQUEST_URL'),2);
309 list($server,$address) = explode('/',$url,2);
310 header('Location: https://'.$server.$sslPortSuffix.'/'.$address);
311 exit;
312 }
313 } elseif (!t3lib_div::getIndpEnv('TYPO3_SSL') ) {
314 if ($TYPO3_CONF_VARS['BE']['lockSSL'] == 2) {
315 list(,$url) = explode('://',t3lib_div::getIndpEnv('TYPO3_SITE_URL').TYPO3_mainDir,2);
316 list($server,$address) = explode('/',$url,2);
317 header('Location: https://'.$server.$sslPortSuffix.'/'.$address);
318 } else {
319 header('Status: 404 Not Found'); // Send Not Found header - if the webserver can make use of it...
320 header('Location: http://'); // Just point us away from here...
321 }
322 exit; // ... and exit good!
323 }
324 }
325
326
327 // *******************************
328 // Checking environment
329 // *******************************
330 if (isset($_POST['GLOBALS']) || isset($_GET['GLOBALS'])) die('You cannot set the GLOBALS-array from outside the script.');
331 if (!get_magic_quotes_gpc()) {
332 t3lib_div::addSlashesOnArray($_GET);
333 t3lib_div::addSlashesOnArray($_POST);
334 $HTTP_GET_VARS = $_GET;
335 $HTTP_POST_VARS = $_POST;
336 }
337
338
339 // ********************************************
340 // Check if the install script should be run:
341 // ********************************************
342 if (defined('TYPO3_enterInstallScript') && TYPO3_enterInstallScript) {
343 if(!t3lib_extMgm::isLoaded('install')) {
344 die('Install Tool is not loaded as an extension.<br />You must add the key "install" to the list of installed extensions in typo3conf/localconf.php, $TYPO3_CONF_VARS[\'EXT\'][\'extList\'].');
345 }
346
347 require_once(t3lib_extMgm::extPath('install').'mod/class.tx_install.php');
348 $install_check = t3lib_div::makeInstance('tx_install');
349 $install_check->allowUpdateLocalConf = 1;
350 $install_check->init();
351 exit;
352 }
353
354
355 // *************************
356 // Connect to the database
357 // *************************
358 if ($TYPO3_DB->sql_pconnect(TYPO3_db_host, TYPO3_db_username, TYPO3_db_password)) {
359 if (!TYPO3_db) {
360 t3lib_BEfunc::typo3PrintError('Database Error', 'No database selected');
361 exit;
362 } elseif (!$TYPO3_DB->sql_select_db(TYPO3_db)) {
363 t3lib_BEfunc::typo3PrintError('Database Error', 'Cannot connect to the current database, "' . TYPO3_db . '"');
364 exit;
365 }
366 } else {
367 t3lib_BEfunc::typo3PrintError('Database Error', 'The current username, password or host was not accepted when the connection to the database was attempted to be established!');
368 exit;
369 }
370
371
372 // *******************************
373 // Checks for proper browser
374 // *******************************
375 if (!$CLIENT['BROWSER'] && !(defined('TYPO3_cliMode') && TYPO3_cliMode)) {
376 t3lib_BEfunc::typo3PrintError ('Browser error','Your browser version looks incompatible with this TYPO3 version!',0);
377 exit;
378 }
379
380
381 // ****************************************************
382 // Include tables customization (tables + ext_tables)
383 // ****************************************************
384 include (TYPO3_tables_script ? PATH_typo3conf.TYPO3_tables_script : PATH_t3lib.'stddb/tables.php');
385 // Extension additions
386 if ($TYPO3_LOADED_EXT['_CACHEFILE']) {
387 include (PATH_typo3conf.$TYPO3_LOADED_EXT['_CACHEFILE'].'_ext_tables.php');
388 } else {
389 include (PATH_t3lib.'stddb/load_ext_tables.php');
390 }
391 // extScript
392 if (TYPO3_extTableDef_script) {
393 include (PATH_typo3conf.TYPO3_extTableDef_script);
394 }
395
396 // load TYPO3 SpriteGenerating API
397 $spriteManager = t3lib_div::makeInstance('t3lib_SpriteManager', TRUE);
398 $spriteManager->loadCacheFile();
399
400
401 // *******************************
402 // BackEnd User authentication
403 // *******************************
404 /*
405 NOTICE:
406 if constant TYPO3_PROCEED_IF_NO_USER is defined true (in the mainscript), this script will return even though a user did not log in!
407 */
408 $BE_USER = t3lib_div::makeInstance('t3lib_beUserAuth'); // New backend user object
409 $BE_USER->warningEmail = $TYPO3_CONF_VARS['BE']['warning_email_addr'];
410 $BE_USER->lockIP = $TYPO3_CONF_VARS['BE']['lockIP'];
411 $BE_USER->auth_timeout_field = intval($TYPO3_CONF_VARS['BE']['sessionTimeout']);
412 $BE_USER->OS = TYPO3_OS;
413 $BE_USER->start(); // Object is initialized
414 $BE_USER->checkCLIuser();
415 $BE_USER->backendCheckLogin(); // Checking if there's a user logged in
416
417 // Setting the web- and filemount global vars:
418 $WEBMOUNTS = $BE_USER->returnWebmounts(); // ! WILL INCLUDE deleted mount pages as well!
419 $FILEMOUNTS = $BE_USER->returnFilemounts();
420
421 // *******************************
422 // $GLOBALS['LANG'] initialisation
423 // *******************************
424 $GLOBALS['LANG'] = t3lib_div::makeInstance('language');
425 $GLOBALS['LANG']->init($BE_USER->uc['lang']);
426
427
428 // ****************
429 // CLI processing
430 // ****************
431 if (defined('TYPO3_cliMode') && TYPO3_cliMode) {
432 // Status output:
433 if (!strcmp($_SERVER['argv'][1],'status')) {
434 echo "Status of TYPO3 CLI script:\n\n";
435 echo "Username [uid]: ".$BE_USER->user['username']." [".$BE_USER->user['uid']."]\n";
436 echo "Database: ".TYPO3_db.LF;
437 echo "PATH_site: ".PATH_site.LF;
438 echo LF;
439 exit;
440 }
441 }
442
443 // ****************
444 // compression
445 // ****************
446 ob_clean();
447 if (extension_loaded('zlib') && $TYPO3_CONF_VARS['BE']['compressionLevel']) {
448 if (t3lib_div::testInt($TYPO3_CONF_VARS['BE']['compressionLevel'])) {
449 @ini_set('zlib.output_compression_level', $TYPO3_CONF_VARS['BE']['compressionLevel']);
450 }
451 ob_start('ob_gzhandler');
452 }
453
454 ?>