/core/web/includes/modules.inc.php

<?php
/**
 * (c) 2004-2007 Linbox / Free&ALter Soft, http://linbox.com
 * (c) 2007-2008 Mandriva, http://www.mandriva.com
 *
 * $Id$
 *
 * This file is part of Mandriva Management Console (MMC).
 *
 * MMC 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.
 *
 * MMC 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with MMC; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
?>
<?php

define('__ROOT__', dirname(dirname(__FILE__)));
require_once(__ROOT__."/site.php");
require_once("ModulesGenerator.php");

/**
 * return an array of all subdirs in a dir
 *
 * @param $dir directory usually "modules/"
 * @return an array of String with a list of dirs
 */
function fetchModulesList($dir) {

    $ret = array();
    $registerList = array();
    
    if (isset($_SESSION["supportModList"])) {
        foreach($_SESSION["supportModList"] as $module) {
            if (file_exists($dir.$module.'/infoPackage.inc.php') &&
                hasCorrectModuleAcl($module)) {
                    $ret[] = $dir.$module;
                    $registerList[] = $module;
            }
        }
        sort($ret);
        sort($registerList);
    }
    
    /* register modulesList in $_SESSION */
    $_SESSION["modulesList"] = $registerList;
    return $ret;
}

/**
 *
 * Read main ini file
 *
 */
function fetchIniFile() {
    global $conf;
    $INI = __sysconfdir__."/mmc/mmc.ini";
    $conf = array();
    if (is_readable($INI)) {
        $conf = array_merge_recursive(parse_ini_file($INI, TRUE),$conf);
    } else {
        print "MMC: Can't read $INI configuration file. Please check your installation.";
        exit();
    }
    /* If password is obfusctated, decode it */
    if (isset($conf["global"]["password"])) {
        $value = $conf["global"]["password"];
        /* We only support base64 encoded password */
        if (preg_match('/^{base64}(.+)$/', $value, $matches)) {
            $value = base64_decode($matches[1]);
            if ($value === False) {
                print "MMC: Can't decode base64 encoded password. Please check your installation.";
                exit();
            }
            $conf["global"]["password"] = $value;
        }
    }

    /* Put the quantities proposed in the selector for the maxperpage value in
       an array */
    if (isset($conf["global"]["pagination"])) {
        $conf["global"]["pagination"] = explode(' ', $conf["global"]["pagination"]);
    } else {
        /* Default values */
        $conf["global"]["pagination"] = array(10, 20, 50, 100);
    }

    if (!isset($conf["global"]["community"])) {
        $conf["global"]["community"] = True;
    }
    /* Set default option for MMC agent access */
    foreach ($conf as $key => $value) {
        if (strstr($key, "server_")) {
            if (!isset($conf[$key]["verifypeer"])) {
                $conf[$key]["verifypeer"] = 0;
                $conf[$key]["cacert"] = "";
                $conf[$key]["localcert"] = "";
            }
            if (!isset($conf[$key]["cacert"])) {
                $conf[$key]["cacert"] = "";
            }
            if (!isset($conf[$key]["localcert"])) {
                $conf[$key]["localcert"] = "";
            }
            /* Set default socket I/O timeout to 5 minutes */
            if (!isset($conf[$key]["timeout"])) {
                $conf[$key]["timeout"] = 300;
            }
            if (($conf[$key]["verifypeer"] == 1)
                && ($conf[$key]["cacert"] == "")
                && ($conf[$key]["localcert"] == "")) {
                printf("The entry %s is missing the cacert and localcert options.", $key);
                exit;
            }
            if (isset($conf[$key]["forgotPassword"]) && $conf[$key]["forgotPassword"])
                $conf[$key]["forgotPassword"] = true;
            else
                $conf[$key]["forgotPassword"] = false;
        }
    }

}


/**
 * include infoPackage.inc.php from directory
 * @param $dirA directory array returned by fetchModulesList
 */
function includeInfoPackage($dirA) {
    foreach ($dirA as $path) {
        if (file_exists("$path/infoPackage.inc.php")) {
            require_once("$path/infoPackage.inc.php");
        }
    }

    $MMCApp =& MMCApp::getInstance();
    $MMCApp->process();
}


function insert_without_delete($arr,$ind,$value) {
    if (isset($arr[$ind])) {
        return insert_without_delete($arr,$ind+1,$value);
    } else {
        $arr[$ind] = $value;
        return $arr;
    }
}

function getSorted($objlist) {
    $prio = array();
   foreach ($objlist as $obj) {
            $prio = insert_without_delete($prio,$obj->getPriority(),$obj);
    }

    ksort($prio);
    return $prio;
}


/**
 * Build and Display the top navigation bar
 * The top navigation bar is made of sub-modules icons.
 */
function autoGenerateNavbar() {
    $MMCApp =& MMCApp::getInstance();

    $prio = array();

    foreach ($MMCApp->getModules() as $mod) {
        foreach ($mod->getSubmodules() as $submod) {
            $add = False;
            foreach($submod->getPages() as $page) {
                $add = $page->hasAccessAndVisible($mod, $submod);
                if ($add) break;
            }
            if ($add) $prio = insert_without_delete($prio,$submod->getPriority(),$submod);
        }
    }

    ksort($prio);

    foreach ($prio as $submod) {
        $submod->generateNavbar();
    }
}

/**
 * include publicFunc.php
 * @param $dirA directory array returned by fetchModulesList
 */
function includePublicFunc($dirA) {
    /* We use a global variable to check if the file has not been already included */
    if (!isset($GLOBALS["included"])) $GLOBALS["included"] = array();
        foreach ($dirA as $path) {
            $path = str_replace("//", "/", $path);
            if (file_exists("$path/includes/publicFunc.php") && ! in_array("$path/includes/publicFunc.php", $GLOBALS["included"])) {
            array_push($GLOBALS["included"], "$path/includes/publicFunc.php");
            include("$path/includes/publicFunc.php");
            }
    }
}

/**
 * include localCss from directory /!\ deprecated
 * @param $dirA directory array returned by fetchModulesList
 */
function includeLocalCss($dirA) {
    foreach ($dirA as $path) {
        if (file_exists("$path/localCss.php")) {
            include("$path/localCss.php");
            print"\n";
        }
    }
}

/**
 * @param $modules modules like base or samba
 * @param $submod sub modules like "users"
 * @param $action action like index or add
 * @return if action require noheader send
 */
function isNoHeader($pModules,$pSubmod,$pAction) {
    $MMCApp =&MMCApp::getInstance();
    $mod = $MMCApp->getModule($pModules);

    $submodo = $mod->_submod[$pSubmod];
    $actiono = $submodo->_pages[$pAction];
    return ($actiono->_options["noHeader"]||$actiono->_options["AJAX"]);
}

/**
 * Call the given function in all available plugins
 * @param $function The function name to execute
 * @param $paramArr The array of parameters for the function
 * @param $reverse  If true, the plugins are considered in reverse priority
 *
 * This function will try to call all _$plugins_$functionName function
 * The plugins are looked up according to their priority, and in reverse order if $reverse = True
 */
function callPluginFunction($function, $paramArr = null, $reverse = False) {

    /* Fetch and order available plugins for the current logged user */
    $list = $_SESSION["modulesList"];
    if ($reverse) $list = array_reverse($list);

    /*
      If the user try to change his/her password, we do it for each available
      module, and we bypass all ACL check
    */
    if (($function == "changeUserPasswd") || ($function == "baseEdit")) {
        /* Change password for all modules, even those where the user has no right. */
        $list = $_SESSION["supportModList"];
        global $conf;
        foreach($list as $module) {
            if (!function_exists("_" . $module . "_" . "changeUserPasswd"))
                includePublicFunc(array($conf["global"]["rootfsmodules"] . "/$module"));
        }
    }

    $result = array();
    foreach($list as $item) {
        $functionName = "_" . $item . "_" . $function;
        if (function_exists($functionName)) {
            $result[$item] = call_user_func_array($functionName, $paramArr);
            if (isXMLRPCError()) {
                /* Break the loop if there is an error */
                global $errorDesc;
                $result[$item] = $errorDesc;
                break;
            }
        }
    }

    return $result;
}


/**
 * render template view in template corresponding module
 * ex: module samba $view = add
 * render /modules/samba/views/add.tpl.php
 */
function renderTPL($view,$module = null) {
    if (!$module) {
        $module = $_GET["module"];
    }

    $template = "modules/$module/views/$view.tpl.php";

    if (file_exists($template)) {
        global $__TPLref;
        extract($__TPLref);
        //print_r($__TPLref);

        //print_r($users);
        require($template);
    } else {
        echo "<b>template render error Cannot find file \"$template\"</b>";

    }
}



    /**
     * some functions for template, render etc...
     */

    /**
     * array of value for template
     */
    $__TPLref = array();

    function setVar($name, $value) {
        global $__TPLref;
        $__TPLref[$name]=$value;
    }

    function getVar($name) {
        global $__TPLref;
        return $__TPLref[$name];
    }

    function eT($name) {
        global $__TPLref;
        echo $__TPLref[$name];
    }

    function redirectTo($url) {
        header('Location: '.$url);
    }

/**
 * list possible locale
 */
function list_system_locales($dir){
    /* Save current locale */
    $current = setlocale(LC_ALL, 0);
    $ret = array();
    $ret[] = "C";
    if (is_dir($dir)) {
        if ($dh = opendir($dir)) {
            while (($file = readdir($dh)) !== false) {
                if ((file_exists("$dir/$file/LC_MESSAGES/base.mo")) && (setlocale(LC_ALL, $file . ".UTF-8"))) {
                    $ret[]=$file;
                }
            }
        }
        closedir($dh);
    }
    $_SESSION['__locale'] = $ret;
    /* Restore current locale */
    setlocale(LC_ALL, $current);
    return $_SESSION['__locale'];
}

?>