Follow-up to bugfix #12324: Renamed sanitizeBackEndUrl() to sanitizeLocalUrl() in...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_loadmodules.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 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 * This document provides a class that loads the modules for the TYPO3 interface.
29 *
30 * $Id$
31 * Modifications by Rene Fritz, 2001
32 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 * @internal
36 */
37 /**
38 * [CLASS/FUNCTION INDEX of SCRIPT]
39 *
40 *
41 *
42 * 79: class t3lib_loadModules
43 * 99: function load($modulesArray,$BE_USER='')
44 * 370: function checkExtensionModule($name)
45 * 389: function checkMod($name, $fullpath)
46 * 471: function checkModAccess($name,$MCONF)
47 * 495: function checkModWorkspace($name,$MCONF)
48 * 519: function parseModulesArray($arr)
49 * 548: function cleanName ($str)
50 * 559: function getRelativePath($baseDir,$destDir)
51 *
52 * TOTAL FUNCTIONS: 8
53 * (This index is automatically created/updated by the extension "extdeveval")
54 *
55 */
56
57
58
59
60
61
62
63
64
65
66
67
68 /**
69 * Load Backend Interface modules
70 *
71 * Typically instantiated like this:
72 * $this->loadModules = t3lib_div::makeInstance('t3lib_loadModules');
73 * $this->loadModules->load($TBE_MODULES);
74 *
75 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
76 * @package TYPO3
77 * @subpackage t3lib
78 */
79 class t3lib_loadModules {
80 var $modules = Array(); // After the init() function this array will contain the structure of available modules for the backend user.
81 var $absPathArray = array(); // Array with paths pointing to the location of modules from extensions
82
83 var $modListGroup = Array(); // this array will hold the elements that should go into the select-list of modules for groups...
84 var $modListUser = Array(); // this array will hold the elements that should go into the select-list of modules for users...
85
86 /**
87 * The backend user for use internally
88 *
89 * @var t3lib_beUserAuth
90 */
91 var $BE_USER;
92 var $observeWorkspaces = FALSE; // If set true, workspace "permissions" will be observed so non-allowed modules will not be included in the array of modules.
93
94
95 /**
96 * Init.
97 * The outcome of the load() function will be a $this->modules array populated with the backend module structure available to the BE_USER
98 * Further the global var $LANG will have labels and images for the modules loaded in an internal array.
99 *
100 * @param array $modulesArray should be the global var $TBE_MODULES, $BE_USER can optionally be set to an alternative Backend user object than the global var $BE_USER (which is the currently logged in user)
101 * @param object Optional backend user object to use. If not set, the global BE_USER object is used.
102 * @return void
103 */
104 function load($modulesArray,$BE_USER='') {
105 // Setting the backend user for use internally
106 if (is_object($BE_USER)) {
107 $this->BE_USER = $BE_USER;
108 } else {
109 $this->BE_USER = $GLOBALS['BE_USER'];
110 }
111
112 /*
113
114 $modulesArray might look like this when entering this function.
115 Notice the two modules added by extensions - they have a path attached
116
117 Array
118 (
119 [web] => list,info,perm,func
120 [file] => list
121 [user] =>
122 [tools] => em,install,txphpmyadmin
123 [help] => about
124 [_PATHS] => Array
125 (
126 [tools_install] => /www/htdocs/typo3/32/coreinstall/typo3/ext/install/mod/
127 [tools_txphpmyadmin] => /www/htdocs/typo3/32/coreinstall/typo3/ext/phpmyadmin/modsub/
128 )
129
130 )
131
132 */
133 //
134 $this->absPathArray = $modulesArray['_PATHS'];
135 unset($modulesArray['_PATHS']);
136
137 /*
138 With the above data for modules the result of this function call will be:
139
140 Array
141 (
142 [web] => Array
143 (
144 [0] => list
145 [1] => info
146 [2] => perm
147 [3] => func
148 )
149
150 [file] => Array
151 (
152 [0] => list
153 )
154
155 [user] => 1
156 [tools] => Array
157 (
158 [0] => em
159 [1] => install
160 [2] => txphpmyadmin
161 )
162
163 [help] => Array
164 (
165 [0] => about
166 )
167
168 )
169 */
170 $theMods = $this->parseModulesArray($modulesArray);
171
172 /*
173 Originally modules were found in typo3/mod/
174 User defined modules were found in ../typo3conf/
175
176 Today almost all modules reside in extensions and they are found by the _PATHS array of the incoming $TBE_MODULES array
177 */
178 // Setting paths for 1) core modules (old concept from mod/) and 2) user-defined modules (from ../typo3conf)
179 $paths = array();
180 $paths['defMods'] = PATH_typo3.'mod/'; // Path of static modules
181 $paths['userMods'] = PATH_typo3.'../typo3conf/'; // local modules (maybe frontend specific)
182
183 // Traverses the module setup and creates the internal array $this->modules
184 foreach($theMods as $mods => $subMod) {
185 $path = NULL;
186
187 $extModRelPath = $this->checkExtensionModule($mods);
188 if ($extModRelPath) { // EXTENSION module:
189 $theMainMod = $this->checkMod($mods,PATH_site.$extModRelPath);
190 if (is_array($theMainMod) || $theMainMod!='notFound') {
191 $path = 1; // ... just so it goes on... submodules cannot be within this path!
192 }
193 } else { // 'CLASSIC' module
194 // Checking for typo3/mod/ module existence...
195 $theMainMod = $this->checkMod($mods,$paths['defMods'].$mods);
196 if (is_array($theMainMod) || $theMainMod!='notFound') {
197 $path = $paths['defMods'];
198 } else {
199 // If not typo3/mod/ then it could be user-defined in typo3conf/ ...?
200 $theMainMod = $this->checkMod($mods,$paths['userMods'].$mods);
201 if (is_array($theMainMod) || $theMainMod!='notFound') {
202 $path = $paths['userMods'];
203 }
204 }
205 }
206
207 // if $theMainMod is not set (false) there is no access to the module !(?)
208 if ($theMainMod && !is_null($path)) {
209 $this->modules[$mods] = $theMainMod;
210
211 // SUBMODULES - if any - are loaded
212 if (is_array($subMod)) {
213 foreach($subMod as $valsub) {
214 $extModRelPath = $this->checkExtensionModule($mods.'_'.$valsub);
215 if ($extModRelPath) { // EXTENSION submodule:
216 $theTempSubMod = $this->checkMod($mods.'_'.$valsub,PATH_site.$extModRelPath);
217 if (is_array($theTempSubMod)) { // default sub-module in either main-module-path, be it the default or the userdefined.
218 $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
219 }
220 } else { // 'CLASSIC' submodule
221 // Checking for typo3/mod/xxx/ module existence...
222 // FIXME what about $path = 1; from above and using $path as string here?
223 $theTempSubMod = $this->checkMod($mods.'_'.$valsub,$path.$mods.'/'.$valsub);
224 if (is_array($theTempSubMod)) { // default sub-module in either main-module-path, be it the default or the userdefined.
225 $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
226 } elseif ($path == $paths['defMods']) { // If the submodule did not exist in the default module path, then check if there is a submodule in the submodule path!
227 $theTempSubMod = $this->checkMod($mods.'_'.$valsub,$paths['userMods'].$mods.'/'.$valsub);
228 if (is_array($theTempSubMod)) {
229 $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
230 }
231 }
232 }
233 }
234 }
235 } else { // This must be done in order to fill out the select-lists for modules correctly!!
236 if (is_array($subMod)) {
237 foreach($subMod as $valsub) {
238 // FIXME path can only be NULL here, or not?
239 $this->checkMod($mods.'_'.$valsub,$path.$mods.'/'.$valsub);
240 }
241 }
242 }
243 }
244 /*
245 At this point $this->modules should look like this:
246 Only modules which were accessible to the $BE_USER is listed in this array.
247
248 Array
249 (
250 [web] => Array
251 (
252 [name] => web
253 [script] => dummy.php
254 [defaultMod] => list
255 [sub] => Array
256 (
257 [list] => Array
258 (
259 [name] => web_list
260 [script] => mod/web/list/../../../db_list.php
261 )
262
263 [info] => Array
264 (
265 [name] => web_info
266 [script] => mod/web/info/index.php
267 )
268
269 [perm] => Array
270 (
271 [name] => web_perm
272 [script] => mod/web/perm/index.php
273 )
274
275 [func] => Array
276 (
277 [name] => web_func
278 [script] => mod/web/func/index.php
279 )
280
281 )
282
283 )
284
285 [file] => Array
286 (
287 [name] => file
288 [script] => dummy.php
289 [sub] => Array
290 (
291 [list] => Array
292 (
293 [name] => file_list
294 [script] => mod/file/list/../../../file_list.php
295 )
296
297 )
298
299 )
300
301 [user] => Array
302 (
303 [name] => user
304 [script] => dummy.php
305 [defaultMod] => task
306 )
307
308 [tools] => Array
309 (
310 [name] => tools
311 [script] => dummy.php
312 [sub] => Array
313 (
314 [em] => Array
315 (
316 [name] => tools_em
317 [script] => mod/tools/em/index.php
318 )
319
320 [install] => Array
321 (
322 [name] => tools_install
323 [script] => ext/install/mod/../../../install/index.php
324 )
325
326 [txphpmyadmin] => Array
327 (
328 [name] => tools_txphpmyadmin
329 [script] => ext/phpmyadmin/modsub/index.php
330 )
331
332 )
333
334 )
335
336 [help] => Array
337 (
338 [name] => help
339 [script] => dummy.php
340 [defaultMod] => welcome
341 [sub] => Array
342 (
343 [about] => Array
344 (
345 [name] => help_about
346 [script] => mod/help/about/index.php
347 )
348
349 )
350
351 )
352
353 )
354
355 */
356
357 #debug($this->modules);
358 #debug($GLOBALS['LANG']->moduleLabels);
359 }
360
361 /**
362 * If the module name ($name) is a module from an extension (has path in $this->absPathArray) then that path is returned relative to PATH_site
363 *
364 * @param string Module name
365 * @return string If found, the relative path from PATH_site
366 */
367 function checkExtensionModule($name) {
368 global $TYPO3_LOADED_EXT;
369
370 if (isset($this->absPathArray[$name])) {
371 return rtrim(substr($this->absPathArray[$name],strlen(PATH_site)), '/');
372 }
373 }
374
375 /**
376 * Here we check for the module.
377 * Return values:
378 * 'notFound': If the module was not found in the path (no "conf.php" file)
379 * false: If no access to the module (access check failed)
380 * array(): Configuration array, in case a valid module where access IS granted exists.
381 *
382 * @param string Module name
383 * @param string Absolute path to module
384 * @return mixed See description of function
385 */
386 function checkMod($name, $fullpath) {
387 if ($name == 'user_ws' && !t3lib_extMgm::isLoaded('version')) {
388 return FALSE;
389 }
390
391 // Check for own way of configuring module
392 if (is_array($GLOBALS['TBE_MODULES'][$name]['configureModuleFunction'])) {
393 $obj = $GLOBALS['TBE_MODULES'][$name]['configureModuleFunction'];
394 if (is_callable($obj)) {
395 return call_user_func($obj, $name, $fullpath);
396 }
397 }
398
399 $modconf = array();
400 $path = preg_replace('/\/[^\/.]+\/\.\.\//', '/', $fullpath); // because 'path/../path' does not work
401 if (@is_dir($path) && file_exists($path.'/conf.php')) {
402 $MCONF = array();
403 $MLANG = array();
404 include($path.'/conf.php'); // The conf-file is included. This must be valid PHP.
405 if (!$MCONF['shy'] && $this->checkModAccess($name,$MCONF) && $this->checkModWorkspace($name,$MCONF)) {
406 $modconf['name']=$name;
407 // language processing. This will add module labels and image reference to the internal ->moduleLabels array of the LANG object.
408 if (is_object($GLOBALS['LANG'])) {
409 // $MLANG['default']['tabs_images']['tab'] is for modules the reference to the module icon.
410 // Here the path is transformed to an absolute reference.
411 if ($MLANG['default']['tabs_images']['tab']) {
412
413 // Initializing search for alternative icon:
414 $altIconKey = 'MOD:'.$name.'/'.$MLANG['default']['tabs_images']['tab']; // Alternative icon key (might have an alternative set in $TBE_STYLES['skinImg']
415 $altIconAbsPath = is_array($GLOBALS['TBE_STYLES']['skinImg'][$altIconKey]) ? t3lib_div::resolveBackPath(PATH_typo3.$GLOBALS['TBE_STYLES']['skinImg'][$altIconKey][0]) : '';
416
417 // Setting icon, either default or alternative:
418 if ($altIconAbsPath && @is_file($altIconAbsPath)) {
419 $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$altIconAbsPath);
420 } else {
421 // Setting default icon:
422 $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$fullpath.'/'.$MLANG['default']['tabs_images']['tab']);
423 }
424
425 // Finally, setting the icon with correct path:
426 if (substr($MLANG['default']['tabs_images']['tab'],0,3)=='../') {
427 $MLANG['default']['tabs_images']['tab'] = PATH_site.substr($MLANG['default']['tabs_images']['tab'],3);
428 } else {
429 $MLANG['default']['tabs_images']['tab'] = PATH_typo3.$MLANG['default']['tabs_images']['tab'];
430 }
431 }
432
433 // If LOCAL_LANG references are used for labels of the module:
434 if ($MLANG['default']['ll_ref']) {
435 // Now the 'default' key is loaded with the CURRENT language - not the english translation...
436 $MLANG['default']['labels']['tablabel'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_labels_tablabel');
437 $MLANG['default']['labels']['tabdescr'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_labels_tabdescr');
438 $MLANG['default']['tabs']['tab'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_tabs_tab');
439 $GLOBALS['LANG']->addModuleLabels($MLANG['default'],$name.'_');
440 } else { // ... otherwise use the old way:
441 $GLOBALS['LANG']->addModuleLabels($MLANG['default'],$name.'_');
442 $GLOBALS['LANG']->addModuleLabels($MLANG[$GLOBALS['LANG']->lang],$name.'_');
443 }
444 }
445
446 // Default script setup
447 if ($MCONF['script']==='_DISPATCH') {
448 if ($MCONF['extbase']) {
449 $modconf['script'] = 'mod.php?M=Tx_' . rawurlencode($name);
450 } else {
451 $modconf['script'] = 'mod.php?M=' . rawurlencode($name);
452 }
453 } elseif ($MCONF['script'] && file_exists($path.'/'.$MCONF['script'])) {
454 $modconf['script'] = $this->getRelativePath(PATH_typo3,$fullpath.'/'.$MCONF['script']);
455 } else {
456 $modconf['script'] = 'dummy.php';
457 }
458 // Default tab setting
459 if ($MCONF['defaultMod']) {
460 $modconf['defaultMod'] = $MCONF['defaultMod'];
461 }
462 // Navigation Frame Script (GET params could be added)
463 if ($MCONF['navFrameScript']) {
464 $navFrameScript = explode('?', $MCONF['navFrameScript']);
465 $navFrameScript = $navFrameScript[0];
466 if (file_exists($path.'/'.$navFrameScript)) {
467 $modconf['navFrameScript'] = $this->getRelativePath(PATH_typo3,$fullpath.'/'.$MCONF['navFrameScript']);
468 }
469 }
470 // additional params for Navigation Frame Script: "&anyParam=value&moreParam=1"
471 if ($MCONF['navFrameScriptParam']) {
472 $modconf['navFrameScriptParam'] = $MCONF['navFrameScriptParam'];
473 }
474 } else return false;
475 } else $modconf = 'notFound';
476 return $modconf;
477 }
478
479 /**
480 * Returns true if the internal BE_USER has access to the module $name with $MCONF (based on security level set for that module)
481 *
482 * @param string Module name
483 * @param array MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has)
484 * @return boolean True if access is granted for $this->BE_USER
485 */
486 function checkModAccess($name,$MCONF) {
487 if ($MCONF['access']) {
488 $access=strtolower($MCONF['access']);
489 // Checking if admin-access is required
490 if (strstr($access,'admin')) { // If admin-permissions is required then return true if user is admin
491 if ($this->BE_USER->isAdmin()) {return true;}
492 }
493 // This will add modules to the select-lists of user and groups
494 if (strstr($access,'user')) { $this->modListUser[]=$name; }
495 if (strstr($access,'group')) { $this->modListGroup[]=$name; }
496 // This checks if a user is permitted to access the module
497 if ($this->BE_USER->isAdmin() || $this->BE_USER->check('modules',$name)) {return true;} // If admin you can always access a module
498
499 } else return true; // If conf[access] is not set, then permission IS granted!
500 }
501
502 /**
503 * Check if a module is allowed inside the current workspace for be user
504 * Processing happens only if $this->observeWorkspaces is TRUE
505 *
506 * @param string Module name
507 * @param array MCONF array (module configuration array) from the modules conf.php file (contains settings about workspace restrictions)
508 * @return boolean True if access is granted for $this->BE_USER
509 */
510 function checkModWorkspace($name,$MCONF) {
511 if ($this->observeWorkspaces) {
512 $status = TRUE;
513 if ($MCONF['workspaces']) {
514 $status = FALSE;
515 if (($this->BE_USER->workspace===0 && t3lib_div::inList($MCONF['workspaces'],'online')) ||
516 ($this->BE_USER->workspace===-1 && t3lib_div::inList($MCONF['workspaces'],'offline')) ||
517 ($this->BE_USER->workspace>0 && t3lib_div::inList($MCONF['workspaces'],'custom'))) {
518 $status = TRUE;
519 }
520 } elseif ($this->BE_USER->workspace===-99) {
521 $status = FALSE;
522 }
523 return $status;
524 } else return TRUE;
525 }
526
527 /**
528 * Parses the moduleArray ($TBE_MODULES) into a internally useful structure.
529 * Returns an array where the keys are names of the module and the values may be true (only module) or an array (of submodules)
530 *
531 * @param array moduleArray ($TBE_MODULES)
532 * @return array Output structure with available modules
533 */
534 function parseModulesArray($arr) {
535 $theMods = Array();
536 if (is_array($arr)) {
537 foreach($arr as $mod => $subs) {
538 $mod = $this->cleanName($mod); // clean module name to alphanum
539 if ($mod) {
540 if ($subs) {
541 $subsArr = t3lib_div::trimExplode(',', $subs);
542 foreach($subsArr as $subMod) {
543 $subMod = $this->cleanName($subMod);
544 if ($subMod) {
545 $theMods[$mod][] = $subMod;
546 }
547 }
548 } else {
549 $theMods[$mod] = 1;
550 }
551 }
552 }
553 }
554 return $theMods;
555 }
556
557 /**
558 * The $str is cleaned so that it contains alphanumerical characters only. Modules must only consist of these characters
559 *
560 * @param string String to clean up
561 * @return string
562 */
563 function cleanName ($str) {
564 return preg_replace('/[^a-z0-9]/i','',$str);
565 }
566
567 /**
568 * Get relative path for $destDir compared to $baseDir
569 *
570 * @param string Base directory
571 * @param string Destination directory
572 * @return string The relative path of destination compared to base.
573 */
574 function getRelativePath($baseDir,$destDir){
575 // By Rene Fritz
576 // a special case , the dirs are equals
577 if ($baseDir == $destDir){
578 return './';
579 }
580
581 $baseDir = ltrim($baseDir, '/'); // remove beginning
582 $destDir = ltrim($destDir, '/');
583
584 $found = true;
585 $slash_pos=0;
586
587 do {
588 $slash_pos = strpos ($destDir, '/');
589 if (substr($destDir, 0, $slash_pos) == substr($baseDir, 0, $slash_pos)){
590 $baseDir = substr($baseDir, $slash_pos+1);
591 $destDir = substr($destDir, $slash_pos+1);
592 } else {
593 $found = false;
594 }
595 } while($found == true);
596
597 $slashes = strlen ($baseDir) - strlen (str_replace('/', '', $baseDir));
598 for($i=0;$i < $slashes;$i++) {
599 $destDir = '../'.$destDir;
600 }
601 return $destDir;
602 }
603 }
604
605
606 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_loadmodules.php']) {
607 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_loadmodules.php']);
608 }
609
610 ?>