Fixed bug #15383: [Unit tests] Add tests for t3lib_div::validEmail
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_loadmodules.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 * 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 // unset the array for calling external backend module dispatchers in typo3/mod.php
137 unset($modulesArray['_dispatcher']);
138 // unset the array for calling backend modules based on external backend module dispatchers in typo3/mod.php
139 unset($modulesArray['_configuration']);
140
141 $theMods = $this->parseModulesArray($modulesArray);
142
143 /*
144 Originally modules were found in typo3/mod/
145 User defined modules were found in ../typo3conf/
146
147 Today almost all modules reside in extensions and they are found by the _PATHS array of the incoming $TBE_MODULES array
148 */
149 // Setting paths for 1) core modules (old concept from mod/) and 2) user-defined modules (from ../typo3conf)
150 $paths = array();
151 $paths['defMods'] = PATH_typo3.'mod/'; // Path of static modules
152 $paths['userMods'] = PATH_typo3.'../typo3conf/'; // local modules (maybe frontend specific)
153
154 // Traverses the module setup and creates the internal array $this->modules
155 foreach($theMods as $mods => $subMod) {
156 $path = NULL;
157
158 $extModRelPath = $this->checkExtensionModule($mods);
159 if ($extModRelPath) { // EXTENSION module:
160 $theMainMod = $this->checkMod($mods,PATH_site.$extModRelPath);
161 if (is_array($theMainMod) || $theMainMod!='notFound') {
162 $path = 1; // ... just so it goes on... submodules cannot be within this path!
163 }
164 } else { // 'CLASSIC' module
165 // Checking for typo3/mod/ module existence...
166 $theMainMod = $this->checkMod($mods,$paths['defMods'].$mods);
167 if (is_array($theMainMod) || $theMainMod!='notFound') {
168 $path = $paths['defMods'];
169 } else {
170 // If not typo3/mod/ then it could be user-defined in typo3conf/ ...?
171 $theMainMod = $this->checkMod($mods,$paths['userMods'].$mods);
172 if (is_array($theMainMod) || $theMainMod!='notFound') {
173 $path = $paths['userMods'];
174 }
175 }
176 }
177
178 // if $theMainMod is not set (false) there is no access to the module !(?)
179 if ($theMainMod && !is_null($path)) {
180 $this->modules[$mods] = $theMainMod;
181
182 // SUBMODULES - if any - are loaded
183 if (is_array($subMod)) {
184 foreach($subMod as $valsub) {
185 $extModRelPath = $this->checkExtensionModule($mods.'_'.$valsub);
186 if ($extModRelPath) { // EXTENSION submodule:
187 $theTempSubMod = $this->checkMod($mods.'_'.$valsub,PATH_site.$extModRelPath);
188 if (is_array($theTempSubMod)) { // default sub-module in either main-module-path, be it the default or the userdefined.
189 $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
190 }
191 } else { // 'CLASSIC' submodule
192 // Checking for typo3/mod/xxx/ module existence...
193 // FIXME what about $path = 1; from above and using $path as string here?
194 $theTempSubMod = $this->checkMod($mods.'_'.$valsub,$path.$mods.'/'.$valsub);
195 if (is_array($theTempSubMod)) { // default sub-module in either main-module-path, be it the default or the userdefined.
196 $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
197 } 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!
198 $theTempSubMod = $this->checkMod($mods.'_'.$valsub,$paths['userMods'].$mods.'/'.$valsub);
199 if (is_array($theTempSubMod)) {
200 $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
201 }
202 }
203 }
204 }
205 }
206 } else { // This must be done in order to fill out the select-lists for modules correctly!!
207 if (is_array($subMod)) {
208 foreach($subMod as $valsub) {
209 // FIXME path can only be NULL here, or not?
210 $this->checkMod($mods.'_'.$valsub,$path.$mods.'/'.$valsub);
211 }
212 }
213 }
214 }
215 }
216
217 /**
218 * 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
219 *
220 * @param string Module name
221 * @return string If found, the relative path from PATH_site
222 */
223 function checkExtensionModule($name) {
224 global $TYPO3_LOADED_EXT;
225
226 if (isset($this->absPathArray[$name])) {
227 return rtrim(substr($this->absPathArray[$name],strlen(PATH_site)), '/');
228 }
229 }
230
231 /**
232 * Here we check for the module.
233 * Return values:
234 * 'notFound': If the module was not found in the path (no "conf.php" file)
235 * false: If no access to the module (access check failed)
236 * array(): Configuration array, in case a valid module where access IS granted exists.
237 *
238 * @param string Module name
239 * @param string Absolute path to module
240 * @return mixed See description of function
241 */
242 function checkMod($name, $fullpath) {
243 if ($name == 'user_ws' && !t3lib_extMgm::isLoaded('version')) {
244 return FALSE;
245 }
246
247 // Check for own way of configuring module
248 if (is_array($GLOBALS['TBE_MODULES']['_configuration'][$name]['configureModuleFunction'])) {
249 $obj = $GLOBALS['TBE_MODULES']['_configuration'][$name]['configureModuleFunction'];
250 if (is_callable($obj)) {
251 return call_user_func($obj, $name, $fullpath);
252 }
253 }
254
255 $modconf = array();
256 $path = preg_replace('/\/[^\/.]+\/\.\.\//', '/', $fullpath); // because 'path/../path' does not work
257 if (@is_dir($path) && file_exists($path.'/conf.php')) {
258 $MCONF = array();
259 $MLANG = array();
260 include($path.'/conf.php'); // The conf-file is included. This must be valid PHP.
261 if (!$MCONF['shy'] && $this->checkModAccess($name,$MCONF) && $this->checkModWorkspace($name,$MCONF)) {
262 $modconf['name']=$name;
263 // language processing. This will add module labels and image reference to the internal ->moduleLabels array of the LANG object.
264 if (is_object($GLOBALS['LANG'])) {
265 // $MLANG['default']['tabs_images']['tab'] is for modules the reference to the module icon.
266 // Here the path is transformed to an absolute reference.
267 if ($MLANG['default']['tabs_images']['tab']) {
268
269 // Initializing search for alternative icon:
270 $altIconKey = 'MOD:'.$name.'/'.$MLANG['default']['tabs_images']['tab']; // Alternative icon key (might have an alternative set in $TBE_STYLES['skinImg']
271 $altIconAbsPath = is_array($GLOBALS['TBE_STYLES']['skinImg'][$altIconKey]) ? t3lib_div::resolveBackPath(PATH_typo3.$GLOBALS['TBE_STYLES']['skinImg'][$altIconKey][0]) : '';
272
273 // Setting icon, either default or alternative:
274 if ($altIconAbsPath && @is_file($altIconAbsPath)) {
275 $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$altIconAbsPath);
276 } else {
277 // Setting default icon:
278 $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$fullpath.'/'.$MLANG['default']['tabs_images']['tab']);
279 }
280
281 // Finally, setting the icon with correct path:
282 if (substr($MLANG['default']['tabs_images']['tab'],0,3)=='../') {
283 $MLANG['default']['tabs_images']['tab'] = PATH_site.substr($MLANG['default']['tabs_images']['tab'],3);
284 } else {
285 $MLANG['default']['tabs_images']['tab'] = PATH_typo3.$MLANG['default']['tabs_images']['tab'];
286 }
287 }
288
289 // If LOCAL_LANG references are used for labels of the module:
290 if ($MLANG['default']['ll_ref']) {
291 // Now the 'default' key is loaded with the CURRENT language - not the english translation...
292 $MLANG['default']['labels']['tablabel'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_labels_tablabel');
293 $MLANG['default']['labels']['tabdescr'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_labels_tabdescr');
294 $MLANG['default']['tabs']['tab'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_tabs_tab');
295 $GLOBALS['LANG']->addModuleLabels($MLANG['default'],$name.'_');
296 } else { // ... otherwise use the old way:
297 $GLOBALS['LANG']->addModuleLabels($MLANG['default'],$name.'_');
298 $GLOBALS['LANG']->addModuleLabels($MLANG[$GLOBALS['LANG']->lang],$name.'_');
299 }
300 }
301
302 // Default script setup
303 if ($MCONF['script']==='_DISPATCH') {
304 if ($MCONF['extbase']) {
305 $modconf['script'] = 'mod.php?M=Tx_' . rawurlencode($name);
306 } else {
307 $modconf['script'] = 'mod.php?M=' . rawurlencode($name);
308 }
309 } elseif ($MCONF['script'] && file_exists($path.'/'.$MCONF['script'])) {
310 $modconf['script'] = $this->getRelativePath(PATH_typo3,$fullpath.'/'.$MCONF['script']);
311 } else {
312 $modconf['script'] = 'dummy.php';
313 }
314 // Default tab setting
315 if ($MCONF['defaultMod']) {
316 $modconf['defaultMod'] = $MCONF['defaultMod'];
317 }
318 // Navigation Frame Script (GET params could be added)
319 if ($MCONF['navFrameScript']) {
320 $navFrameScript = explode('?', $MCONF['navFrameScript']);
321 $navFrameScript = $navFrameScript[0];
322 if (file_exists($path.'/'.$navFrameScript)) {
323 $modconf['navFrameScript'] = $this->getRelativePath(PATH_typo3,$fullpath.'/'.$MCONF['navFrameScript']);
324 }
325 }
326 // additional params for Navigation Frame Script: "&anyParam=value&moreParam=1"
327 if ($MCONF['navFrameScriptParam']) {
328 $modconf['navFrameScriptParam'] = $MCONF['navFrameScriptParam'];
329 }
330 } else return false;
331 } else $modconf = 'notFound';
332 return $modconf;
333 }
334
335 /**
336 * Returns true if the internal BE_USER has access to the module $name with $MCONF (based on security level set for that module)
337 *
338 * @param string Module name
339 * @param array MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has)
340 * @return boolean True if access is granted for $this->BE_USER
341 */
342 function checkModAccess($name,$MCONF) {
343 if ($MCONF['access']) {
344 $access=strtolower($MCONF['access']);
345 // Checking if admin-access is required
346 if (strstr($access,'admin')) { // If admin-permissions is required then return true if user is admin
347 if ($this->BE_USER->isAdmin()) {return true;}
348 }
349 // This will add modules to the select-lists of user and groups
350 if (strstr($access,'user')) { $this->modListUser[]=$name; }
351 if (strstr($access,'group')) { $this->modListGroup[]=$name; }
352 // This checks if a user is permitted to access the module
353 if ($this->BE_USER->isAdmin() || $this->BE_USER->check('modules',$name)) {return true;} // If admin you can always access a module
354
355 } else return true; // If conf[access] is not set, then permission IS granted!
356 }
357
358 /**
359 * Check if a module is allowed inside the current workspace for be user
360 * Processing happens only if $this->observeWorkspaces is TRUE
361 *
362 * @param string Module name
363 * @param array MCONF array (module configuration array) from the modules conf.php file (contains settings about workspace restrictions)
364 * @return boolean True if access is granted for $this->BE_USER
365 */
366 function checkModWorkspace($name,$MCONF) {
367 if ($this->observeWorkspaces) {
368 $status = TRUE;
369 if ($MCONF['workspaces']) {
370 $status = FALSE;
371 if (($this->BE_USER->workspace===0 && t3lib_div::inList($MCONF['workspaces'],'online')) ||
372 ($this->BE_USER->workspace===-1 && t3lib_div::inList($MCONF['workspaces'],'offline')) ||
373 ($this->BE_USER->workspace>0 && t3lib_div::inList($MCONF['workspaces'],'custom'))) {
374 $status = TRUE;
375 }
376 } elseif ($this->BE_USER->workspace===-99) {
377 $status = FALSE;
378 }
379 return $status;
380 } else return TRUE;
381 }
382
383 /**
384 * Parses the moduleArray ($TBE_MODULES) into a internally useful structure.
385 * Returns an array where the keys are names of the module and the values may be true (only module) or an array (of submodules)
386 *
387 * @param array moduleArray ($TBE_MODULES)
388 * @return array Output structure with available modules
389 */
390 function parseModulesArray($arr) {
391 $theMods = Array();
392 if (is_array($arr)) {
393 foreach($arr as $mod => $subs) {
394 $mod = $this->cleanName($mod); // clean module name to alphanum
395 if ($mod) {
396 if ($subs) {
397 $subsArr = t3lib_div::trimExplode(',', $subs);
398 foreach($subsArr as $subMod) {
399 $subMod = $this->cleanName($subMod);
400 if ($subMod) {
401 $theMods[$mod][] = $subMod;
402 }
403 }
404 } else {
405 $theMods[$mod] = 1;
406 }
407 }
408 }
409 }
410 return $theMods;
411 }
412
413 /**
414 * The $str is cleaned so that it contains alphanumerical characters only. Modules must only consist of these characters
415 *
416 * @param string String to clean up
417 * @return string
418 */
419 function cleanName ($str) {
420 return preg_replace('/[^a-z0-9]/i','',$str);
421 }
422
423 /**
424 * Get relative path for $destDir compared to $baseDir
425 *
426 * @param string Base directory
427 * @param string Destination directory
428 * @return string The relative path of destination compared to base.
429 */
430 function getRelativePath($baseDir,$destDir){
431 // By Rene Fritz
432 // a special case , the dirs are equals
433 if ($baseDir == $destDir){
434 return './';
435 }
436
437 $baseDir = ltrim($baseDir, '/'); // remove beginning
438 $destDir = ltrim($destDir, '/');
439
440 $found = true;
441 $slash_pos=0;
442
443 do {
444 $slash_pos = strpos ($destDir, '/');
445 if (substr($destDir, 0, $slash_pos) == substr($baseDir, 0, $slash_pos)){
446 $baseDir = substr($baseDir, $slash_pos+1);
447 $destDir = substr($destDir, $slash_pos+1);
448 } else {
449 $found = false;
450 }
451 } while($found == true);
452
453 $slashes = strlen ($baseDir) - strlen (str_replace('/', '', $baseDir));
454 for($i=0;$i < $slashes;$i++) {
455 $destDir = '../'.$destDir;
456 }
457 return $destDir;
458 }
459 }
460
461
462 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_loadmodules.php']) {
463 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_loadmodules.php']);
464 }
465
466 ?>