/src/typo3_src-4.2.0alpha1/t3lib/class.t3lib_loadmodules.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_loadModules {
        var $modules = Array();         // After the init() function this array will contain the structure of available modules for the backend user.
        var $absPathArray = array();    // Array with paths pointing to the location of modules from extensions

        var $modListGroup = Array();            // this array will hold the elements that should go into the select-list of modules for groups...
        var $modListUser = Array();             // this array will hold the elements that should go into the select-list of modules for users...

        var $BE_USER = '';
        var $observeWorkspaces = FALSE;         // If set true, workspace "permissions" will be observed so non-allowed modules will not be included in the array of modules.


        function load($modulesArray,$BE_USER='')        {
                        // Setting the backend user for use internally
                if (is_object($BE_USER))        {
                        $this->BE_USER = $BE_USER;
                } else {
                        $this->BE_USER = $GLOBALS['BE_USER'];
                }

                        /*

                         $modulesArray might look like this when entering this function.
                         Notice the two modules added by extensions - they have a path attached

                        Array
                        (
                            [web] => list,info,perm,func
                            [file] => list
                            [doc] =>
                            [user] =>
                            [tools] => em,install,txphpmyadmin
                            [help] => about
                            [_PATHS] => Array
                                (
                                    [tools_install] => /www/htdocs/typo3/32/coreinstall/typo3/ext/install/mod/
                                    [tools_txphpmyadmin] => /www/htdocs/typo3/32/coreinstall/typo3/ext/phpmyadmin/modsub/
                                )

                        )

                         */
                        //
                $this->absPathArray = $modulesArray['_PATHS'];
                unset($modulesArray['_PATHS']);

                        /*
                                With the above data for modules the result of this function call will be:

                                Array
                                (
                                    [web] => Array
                                        (
                                            [0] => list
                                            [1] => info
                                            [2] => perm
                                            [3] => func
                                        )

                                    [file] => Array
                                        (
                                            [0] => list
                                        )

                                    [doc] => 1
                                    [user] => 1
                                    [tools] => Array
                                        (
                                            [0] => em
                                            [1] => install
                                            [2] => txphpmyadmin
                                        )

                                    [help] => Array
                                        (
                                            [0] => about
                                        )

                                )
                        */
                $theMods = $this->parseModulesArray($modulesArray);

                        /*
                                Originally modules were found in typo3/mod/
                                User defined modules were found in ../typo3conf/

                                Today almost all modules reside in extensions and they are found by the _PATHS array of the incoming $TBE_MODULES array
                        */
                        // Setting paths for 1) core modules (old concept from mod/) and 2) user-defined modules (from ../typo3conf)
                $paths = array();
                $paths['defMods'] = PATH_typo3.'mod/';  // Path of static modules
                $paths['userMods'] = PATH_typo3.'../typo3conf/';  // local modules (maybe frontend specific)

                        // Traverses the module setup and creates the internal array $this->modules
                foreach($theMods as $mods => $subMod)   {
                        $path = NULL;

                        $extModRelPath = $this->checkExtensionModule($mods);
                        if ($extModRelPath)     {       // EXTENSION module:
                                $theMainMod = $this->checkMod($mods,PATH_site.$extModRelPath);
                                if (is_array($theMainMod) || $theMainMod!='notFound')   {
                                        $path = 1;      // ... just so it goes on... submodules cannot be within this path!
                                }
                        } else {        // 'CLASSIC' module
                                        // Checking for typo3/mod/ module existence...
                                $theMainMod = $this->checkMod($mods,$paths['defMods'].$mods);
                                if (is_array($theMainMod) || $theMainMod!='notFound')   {
                                        $path = $paths['defMods'];
                                } else {
                                                // If not typo3/mod/ then it could be user-defined in typo3conf/ ...?
                                        $theMainMod = $this->checkMod($mods,$paths['userMods'].$mods);
                                        if (is_array($theMainMod) || $theMainMod!='notFound')   {
                                                $path = $paths['userMods'];
                                        }
                                }
                        }

                                // if $theMainMod is not set (false) there is no access to the module !(?)
                        if ($theMainMod && !is_null($path))     {
                                $this->modules[$mods] = $theMainMod;

                                        // SUBMODULES - if any - are loaded (The 'doc' module cannot have submodules...)
                                if ($mods!='doc' && is_array($subMod))  {
                                        foreach($subMod as $valsub)     {
                                                $extModRelPath = $this->checkExtensionModule($mods.'_'.$valsub);
                                                if ($extModRelPath)     {       // EXTENSION submodule:
                                                        $theTempSubMod = $this->checkMod($mods.'_'.$valsub,PATH_site.$extModRelPath);
                                                        if (is_array($theTempSubMod))   {       // default sub-module in either main-module-path, be it the default or the userdefined.
                                                                $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
                                                        }
                                                } else {        // 'CLASSIC' submodule
                                                                // Checking for typo3/mod/xxx/ module existence...
// FIXME what about $path = 1; from above and using $path as string here?
                                                        $theTempSubMod = $this->checkMod($mods.'_'.$valsub,$path.$mods.'/'.$valsub);
                                                        if (is_array($theTempSubMod))   {       // default sub-module in either main-module-path, be it the default or the userdefined.
                                                                $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
                                                        } 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!
                                                                $theTempSubMod = $this->checkMod($mods.'_'.$valsub,$paths['userMods'].$mods.'/'.$valsub);
                                                                if (is_array($theTempSubMod))   {
                                                                        $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
                                                                }
                                                        }
                                                }
                                        }
                                }
                        } else {        // This must be done in order to fill out the select-lists for modules correctly!!
                                if ($mods!='doc' && is_array($subMod))  {
                                        foreach($subMod as $valsub)     {
// FIXME path can only be NULL here, or not?
                                                $this->checkMod($mods.'_'.$valsub,$path.$mods.'/'.$valsub);
                                        }
                                }
                        }
                }
        /*
                At this point $this->modules should look like this:
                Only modules which were accessible to the $BE_USER is listed in this array.

                Array
                (
                    [web] => Array
                        (
                            [name] => web
                            [script] => dummy.php
                            [defaultMod] => list
                            [sub] => Array
                                (
                                    [list] => Array
                                        (
                                            [name] => web_list
                                            [script] => mod/web/list/../../../db_list.php
                                        )

                                    [info] => Array
                                        (
                                            [name] => web_info
                                            [script] => mod/web/info/index.php
                                        )

                                    [perm] => Array
                                        (
                                            [name] => web_perm
                                            [script] => mod/web/perm/index.php
                                        )

                                    [func] => Array
                                        (
                                            [name] => web_func
                                            [script] => mod/web/func/index.php
                                        )

                                )

                        )

                    [file] => Array
                        (
                            [name] => file
                            [script] => dummy.php
                            [sub] => Array
                                (
                                    [list] => Array
                                        (
                                            [name] => file_list
                                            [script] => mod/file/list/../../../file_list.php
                                        )

                                )

                        )

                    [doc] => Array
                        (
                            [name] => doc
                            [script] => mod/doc/../../alt_doc.php
                        )

                    [user] => Array
                        (
                            [name] => user
                            [script] => dummy.php
                            [defaultMod] => task
                        )

                    [tools] => Array
                        (
                            [name] => tools
                            [script] => dummy.php
                            [sub] => Array
                                (
                                    [em] => Array
                                        (
                                            [name] => tools_em
                                            [script] => mod/tools/em/index.php
                                        )

                                    [install] => Array
                                        (
                                            [name] => tools_install
                                            [script] => ext/install/mod/../../../install/index.php
                                        )

                                    [txphpmyadmin] => Array
                                        (
                                            [name] => tools_txphpmyadmin
                                            [script] => ext/phpmyadmin/modsub/index.php
                                        )

                                )

                        )

                    [help] => Array
                        (
                            [name] => help
                            [script] => dummy.php
                            [defaultMod] => welcome
                            [sub] => Array
                                (
                                    [about] => Array
                                        (
                                            [name] => help_about
                                            [script] => mod/help/about/index.php
                                        )

                                )

                        )

                )

        */

#debug($this->modules);
#debug($GLOBALS['LANG']->moduleLabels);
        }

        function checkExtensionModule($name)    {
                global $TYPO3_LOADED_EXT;

                if (isset($this->absPathArray[$name]))  {
                        return ereg_replace ('\/$', '', substr($this->absPathArray[$name],strlen(PATH_site)));
                }
        }

        function checkMod($name, $fullpath)     {
                $modconf=Array();
                $path = ereg_replace ('/[^/.]+/\.\./', '/', $fullpath); // because 'path/../path' does not work
                if (@is_dir($path) && @file_exists($path.'/conf.php'))  {
                        $MCONF = array();
                        $MLANG = array();
                        include($path.'/conf.php');     // The conf-file is included. This must be valid PHP.
                        if (!$MCONF['shy'] && $this->checkModAccess($name,$MCONF) && $this->checkModWorkspace($name,$MCONF))    {
                                $modconf['name']=$name;
                                        // language processing. This will add module labels and image reference to the internal ->moduleLabels array of the LANG object.
                                if (is_object($GLOBALS['LANG']))        {
                                                // $MLANG['default']['tabs_images']['tab'] is for modules the reference to the module icon.
                                                // Here the path is transformed to an absolute reference.
                                        if ($MLANG['default']['tabs_images']['tab'])    {

                                                        // Initializing search for alternative icon:
                                                $altIconKey = 'MOD:'.$name.'/'.$MLANG['default']['tabs_images']['tab'];         // Alternative icon key (might have an alternative set in $TBE_STYLES['skinImg']
                                                $altIconAbsPath = is_array($GLOBALS['TBE_STYLES']['skinImg'][$altIconKey]) ? t3lib_div::resolveBackPath(PATH_typo3.$GLOBALS['TBE_STYLES']['skinImg'][$altIconKey][0]) : '';

                                                        // Setting icon, either default or alternative:
                                                if ($altIconAbsPath && @is_file($altIconAbsPath))       {
                                                        $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$altIconAbsPath);
                                                } else {
                                                                // Setting default icon:
                                                        $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$fullpath.'/'.$MLANG['default']['tabs_images']['tab']);
                                                }

                                                        // Finally, setting the icon with correct path:
                                                if (substr($MLANG['default']['tabs_images']['tab'],0,3)=='../') {
                                                        $MLANG['default']['tabs_images']['tab'] = PATH_site.substr($MLANG['default']['tabs_images']['tab'],3);
                                                } else {
                                                        $MLANG['default']['tabs_images']['tab'] = PATH_typo3.$MLANG['default']['tabs_images']['tab'];
                                                }
                                        }

                                                // If LOCAL_LANG references are used for labels of the module:
                                        if ($MLANG['default']['ll_ref'])        {
                                                        // Now the 'default' key is loaded with the CURRENT language - not the english translation...
                                                $MLANG['default']['labels']['tablabel'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_labels_tablabel');
                                                $MLANG['default']['labels']['tabdescr'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_labels_tabdescr');
                                                $MLANG['default']['tabs']['tab'] = $GLOBALS['LANG']->sL($MLANG['default']['ll_ref'].':mlang_tabs_tab');
                                                $GLOBALS['LANG']->addModuleLabels($MLANG['default'],$name.'_');
                                        } else {        // ... otherwise use the old way:
                                                $GLOBALS['LANG']->addModuleLabels($MLANG['default'],$name.'_');
                                                $GLOBALS['LANG']->addModuleLabels($MLANG[$GLOBALS['LANG']->lang],$name.'_');
                                        }
                                }

                                        // Default script setup
                                if ($MCONF['script']==='_DISPATCH')     {
                                        $modconf['script'] = 'mod.php?M='.rawurlencode($name);
                                } elseif ($MCONF['script'] && @file_exists($path.'/'.$MCONF['script'])) {
                                        $modconf['script'] = $this->getRelativePath(PATH_typo3,$fullpath.'/'.$MCONF['script']);
                                } else {
                                        $modconf['script'] = 'dummy.php';
                                }
                                        // Default tab setting
                                if ($MCONF['defaultMod'])       {
                                        $modconf['defaultMod'] = $MCONF['defaultMod'];
                                }
                                        // Navigation Frame Script (GET params could be added)
                                if ($MCONF['navFrameScript']) {
                                        $navFrameScript = explode('?', $MCONF['navFrameScript']);
                                        $navFrameScript = $navFrameScript[0];
                                        if (@file_exists($path.'/'.$navFrameScript))    {
                                                $modconf['navFrameScript'] = $this->getRelativePath(PATH_typo3,$fullpath.'/'.$MCONF['navFrameScript']);
                                        }
                                }
                                        // additional params for Navigation Frame Script: "&anyParam=value&moreParam=1"
                                if ($MCONF['navFrameScriptParam']) {
                                        $modconf['navFrameScriptParam'] = $MCONF['navFrameScriptParam'];
                                }
                        } else return false;
                } else $modconf = 'notFound';
                return $modconf;
        }

        function checkModAccess($name,$MCONF)   {
                if ($MCONF['access'])   {
                        $access=strtolower($MCONF['access']);
                                // Checking if admin-access is required
                        if (strstr($access,'admin'))    {       // If admin-permissions is required then return true if user is admin
                                if ($this->BE_USER->isAdmin())  {return true;}
                        }
                                // This will add modules to the select-lists of user and groups
                        if (strstr($access,'user'))     {       $this->modListUser[]=$name;             }
                        if (strstr($access,'group'))    {       $this->modListGroup[]=$name;    }
                                // This checks if a user is permitted to access the module
                        if ($this->BE_USER->isAdmin() || $this->BE_USER->check('modules',$name))        {return true;}  // If admin you can always access a module

                } else return true;     // If conf[access] is not set, then permission IS granted!
        }

        function checkModWorkspace($name,$MCONF)        {
                if ($this->observeWorkspaces)   {
                        $status = TRUE;
                        if ($MCONF['workspaces'])       {
                                $status = FALSE;
                                if (($this->BE_USER->workspace===0 && t3lib_div::inList($MCONF['workspaces'],'online')) ||
                                        ($this->BE_USER->workspace===-1 && t3lib_div::inList($MCONF['workspaces'],'offline')) ||
                                        ($this->BE_USER->workspace>0 && t3lib_div::inList($MCONF['workspaces'],'custom')))      {
                                                $status = TRUE;
                                }
                        } elseif ($this->BE_USER->workspace===-99)      {
                                $status = FALSE;
                        }
                        return $status;
                } else return TRUE;
        }

        function parseModulesArray($arr)        {
                $theMods = Array();
                if (is_array($arr))     {
                        foreach($arr as $mod => $subs)  {
                                $mod = $this->cleanName($mod);          // clean module name to alphanum
                                if ($mod)       {
                                        if ($subs)      {
                                                $subsArr = t3lib_div::trimExplode(',', $subs);
                                                foreach($subsArr as $subMod)    {
                                                        $subMod = $this->cleanName($subMod);
                                                        if ($subMod)    {
                                                                $theMods[$mod][] = $subMod;
                                                        }
                                                }
                                        } else {
                                                $theMods[$mod] = 1;
                                        }
                                }
                        }
                }
                return $theMods;
        }

        function cleanName ($str)       {
                return preg_replace('/[^a-z0-9]/i','',$str);
        }

        function getRelativePath($baseDir,$destDir){
                        // By Rene Fritz
                        // a special case , the dirs are equals
                if ($baseDir == $destDir){
                        return './';
                }

                $baseDir = ereg_replace ('^/', '', $baseDir);   // remove beginning
                $destDir = ereg_replace ('^/', '', $destDir);

                $found = true;
                $slash_pos=0;

                do {
                        $slash_pos = strpos ($destDir, '/');
                        if (substr($destDir, 0, $slash_pos) == substr($baseDir, 0, $slash_pos)){
                                $baseDir = substr($baseDir, $slash_pos+1);
                                $destDir = substr($destDir, $slash_pos+1);
                        } else {
                                $found = false;
                        }
                } while($found == true);

                $slashes = strlen ($baseDir) - strlen (str_replace('/', '', $baseDir));
                for($i=0;$i < $slashes;$i++)    {
                        $destDir = '../'.$destDir;
                }
                return $destDir;
        }
}


if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_loadmodules.php'])       {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_loadmodules.php']);
}
?>

---

This documentation has been generated automatically from TYPO3 source code using Doxygen and is provided as is by Cast Iron Coding as a courtesy to other TYPO3 developers and users. Please consider Cast Iron Coding — a full-service web development agency in Portland, Oregon specializing in TYPO3 extension development — for all of your TYPO3 development and consulting needs!