Xoops.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program 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.
*/

use Xoops\Core\Request;
use Xoops\Core\FixedGroups;

class Xoops
{
    const VERSION = 'XOOPS 2.6.0-Alpha 3';

    public $sessionManager = null;

    public $module = null;

    public $config = array();

    public $moduleConfig = array();

    public $moduleDirname = '';

    public $user = '';

    public $userIsAdmin = false;

    public $option = array();

    private $tpl = null;

    private $theme = null;

    public $paths = array(
        'XOOPS'  => array(), 'www' => array(), 'var' => array(), 'lib' => array(), 'modules' => array(),
        'themes' => array(), 'media' => array()
    );

    public $tpl_name = '';

    private $kernelHandlers = array();

    private $moduleHandlers = array();

    private $activeModules = null;

    private $moduleConfigs = array();

    public $isAdminSide = false;

    private function __construct()
    {
        $root = \XoopsBaseConfig::get('root-path');
        $lib = \XoopsBaseConfig::get('lib-path');
        $var = \XoopsBaseConfig::get('var-path');

        $url = \XoopsBaseConfig::get('url');

        $this->paths['www'] = array($root, $url);
        $this->paths['var'] = array($var, null);
        $this->paths['lib'] = array($lib, $url . '/browse.php');
        $this->paths['XOOPS'] = array($lib, $url . '/browse.php');

        $this->paths['assets'] = array(\XoopsBaseConfig::get('asset-path'), \XoopsBaseConfig::get('asset-url'));
        $this->paths['images'] = array($root . '/images', $url . '/images');
        $this->paths['install'] = array($root . '/install', $url . '/install');
        $this->paths['language'] = array($root . '/language', $url . '/language');
        $this->paths['locale'] = array($root . '/locale', $url . '/locale');
        $this->paths['media'] = array(\XoopsBaseConfig::get('media-path'), \XoopsBaseConfig::get('media-url'));
        $this->paths['modules'] = array($root . '/modules', $url . '/modules');
        $this->paths['themes'] = array(\XoopsBaseConfig::get('themes-path'), \XoopsBaseConfig::get('themes-url'));
        $this->paths['uploads'] = array(\XoopsBaseConfig::get('uploads-path'), \XoopsBaseConfig::get('uploads-url'));

        $this->paths['XOOPS'] = array(\XoopsBaseConfig::get('lib-path'), \XoopsBaseConfig::get('url') . '/browse.php');
        $this->paths['www'] = array(\XoopsBaseConfig::get('root-path'), \XoopsBaseConfig::get('url'));
        $this->paths['var'] = array(\XoopsBaseConfig::get('var-path'), null);
        $this->paths['lib'] = array(\XoopsBaseConfig::get('lib-path'), \XoopsBaseConfig::get('url') . '/browse.php');
        $this->paths['modules'] = array(\XoopsBaseConfig::get('root-path') . '/modules', \XoopsBaseConfig::get('url') . '/modules');
        $this->paths['themes'] = array(\XoopsBaseConfig::get('root-path') . '/themes', \XoopsBaseConfig::get('url') . '/themes');
        $this->paths['media'] = array(\XoopsBaseConfig::get('root-path') . '/media', \XoopsBaseConfig::get('url') . '/media');
        $this->paths['assets'] = array(\XoopsBaseConfig::get('root-path') . '/assets', \XoopsBaseConfig::get('url') . '/assets');
        $this->pathTranslation();
    }

    public static function getInstance()
    {
        static $instance;
        if (!isset($instance)) {
            $class = __CLASS__;
            $instance = new $class();
        }
        return $instance;
    }

    public function db()
    {
        return \Xoops\Core\Database\Factory::getConnection();
    }

    public function cache($cacheName = 'default')
    {
        static $cacheManager;

        if (!isset($cacheManager)) {
            $cacheManager = new \Xoops\Core\Cache\CacheManager();
        }

        return $cacheManager->getCache($cacheName);
    }

    public function logger()
    {
        return \Xoops\Core\Logger::getInstance();
    }


    public function events()
    {
        return \Xoops\Core\Events::getInstance();
    }

    public function preload()
    {
        return $this->events();
    }

    public function assets()
    {
        static $instance;
        if (!isset($instance)) {
            $instance = new \Xoops\Core\Assets;
        }
        return $instance;
    }

    public function service($service)
    {
        static $instance;
        if (!isset($instance)) {
            $instance = \Xoops\Core\Service\Manager::getInstance();
        }
        return $instance->locate($service);
    }

    public function registry()
    {
        static $instance;
        if (!isset($instance)) {
            $instance = new \Xoops\Core\Registry();
        }
        return $instance;
    }

    public function security()
    {
        static $instance;
        if (!isset($instance)) {
            $instance = new \Xoops\Core\Security();
        }
        return $instance;
    }

    public function tpl()
    {
        return $this->tpl;
    }

    public function setTpl(XoopsTpl $tpl)
    {
        return $this->tpl = $tpl;
    }

    public function theme($tpl_name = null)
    {
        if (!isset($this->theme)) {
            if ($tpl_name) {
                $tpl_info = $this->getTplInfo($tpl_name);
                $this->tpl_name = $tpl_info['tpl_name'];
            } else {
                $tpl_name = 'module:system/system_dummy.tpl';
                $tpl_info = $this->getTplInfo($tpl_name);
                $this->tpl_name = $tpl_info['tpl_name'];
            }
            if (!$this->isAdminSide) {
                $xoopsThemeFactory = null;
                $xoopsThemeFactory = new XoopsThemeFactory();
                $xoopsThemeFactory->allowedThemes = $this->getConfig('theme_set_allowed');
                $xoopsThemeFactory->defaultTheme = $this->getConfig('theme_set');
                $this->setTheme($xoopsThemeFactory->createInstance(array('contentTemplate' => $this->tpl_name)));
            } else {
                $adminThemeFactory = new XoopsAdminThemeFactory();
                $this->setTheme($adminThemeFactory->createInstance(array(
                    'folderName'      => 'default', 'themesPath' => 'modules/system/themes',
                    'contentTemplate' => $this->tpl_name
                )));
                //$this->theme()->loadLocalization('admin');
                list($cssAssets, $jsAssets) = $this->theme()->getLocalizationAssets('admin');
                if (!empty($cssAssets)) {
                    $this->theme()->addBaseStylesheetAssets($cssAssets);
                }
                if (!empty($jsAssets)) {
                    $this->theme()->addBaseScriptAssets($jsAssets);
                }
            }
        } else {
            if ($tpl_name) {
                $tpl_info = $this->getTplInfo($tpl_name);
                $this->tpl_name = $tpl_info['tpl_name'];
                $this->theme->contentTemplate = $this->tpl_name;
            }
        }
        $GLOBALS['xoTheme'] = $this->theme;
        return $this->theme;
    }

    public function setTheme(XoopsTheme $theme)
    {
        return $this->theme = $theme;
    }

    public function path($url, $virtual = false)
    {
        $url = $this->normalizePath($url);
        $rootPath = $this->normalizePath(\XoopsBaseConfig::get('root-path') . '/');
        if (0 === strpos($url, $rootPath)) {
            $url = substr($url, strlen($rootPath));
        }
        //$url = ltrim($url, '/');
        $parts = explode('/', $url, 2);
        $root = isset($parts[0]) ? $parts[0] : '';
        $path = isset($parts[1]) ? $parts[1] : '';
        if (!isset($this->paths[$root])) {
            list($root, $path) = array('www', $url);
        }
        if (!$virtual) { // Returns a physical path
            $path = $this->paths[$root][0] . '/' . $path;
            //$path = str_replace('/', DIRECTORY_SEPARATOR, $path);
            return $path;
        }
        return !isset($this->paths[$root][1]) ? '' : ($this->paths[$root][1] . '/' . $path);
    }

    public function normalizePath($path)
    {
        return str_replace('\\', '/', $path);
    }

    public function url($url)
    {
        return (false !== strpos($url, '://') ? $url : $this->path($url, true));
    }

    public function buildUrl($url, $params = array())
    {
        if ($url == '.') {
            $url = $_SERVER['REQUEST_URI'];
        }
        $split = explode('?', $url);
        if (count($split) > 1) {
            list($url, $query) = $split;
            parse_str($query, $query);
            $params = array_merge($query, $params);
        }
        if (!empty($params)) {
            foreach ($params as $k => $v) {
                $params[$k] = $k . '=' . rawurlencode($v);
            }
            $url .= '?' . implode('&', $params);
        }
        return $url;
    }

    public function pathExists($path, $error_type)
    {
        if (XoopsLoad::fileExists($path)) {
            return $path;
        } else {
            $this->logger()->log(
                \Psr\Log\LogLevel::WARNING,
                \XoopsLocale::E_FILE_NOT_FOUND,
                array($path, $error_type)
            );

            //trigger_error(XoopsLocale::E_FILE_NOT_FOUND, $error_type);
            return false;
        }
    }

    public function gzipCompression()
    {
        if (empty($_SERVER['SERVER_NAME']) || substr(PHP_SAPI, 0, 3) == 'cli') {
            $this->setConfig('gzip_compression', 0);
        }

        if ($this->getConfig('gzip_compression') == 1 && extension_loaded('zlib') && !ini_get('zlib.output_compression')) {
            if (@ini_get('zlib.output_compression_level') < 0) {
                ini_set('zlib.output_compression_level', 6);
            }
            ob_start('ob_gzhandler');
        }
    }

    public function pathTranslation()
    {
        if (!isset($_SERVER['PATH_TRANSLATED']) && isset($_SERVER['SCRIPT_FILENAME'])) {
            $_SERVER['PATH_TRANSLATED'] = $_SERVER['SCRIPT_FILENAME']; // For Apache CGI
        } else {
            if (isset($_SERVER['PATH_TRANSLATED']) && !isset($_SERVER['SCRIPT_FILENAME'])) {
                $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED']; // For IIS/2K now I think :-(
            }
        }
        if (empty($_SERVER['REQUEST_URI'])) { // Not defined by IIS
            // Under some configs, IIS makes SCRIPT_NAME point to php.exe :-(
            if (!($_SERVER['REQUEST_URI'] = @$_SERVER['PHP_SELF'])) {
                $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'];
            }
            if (isset($_SERVER['QUERY_STRING'])) {
                $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
            }
        }
    }

    public function themeSelect()
    {
        $xoopsThemeSelect = Request::getString('xoops_theme_select', '', 'POST');
        if (!empty($xoopsThemeSelect) && in_array($xoopsThemeSelect, $this->getConfig('theme_set_allowed'))) {
            $this->setConfig('theme_set', $xoopsThemeSelect);
            $_SESSION['xoopsUserTheme'] = $xoopsThemeSelect;
        } else {
            if (!empty($_SESSION['xoopsUserTheme']) && in_array($_SESSION['xoopsUserTheme'], $this->getConfig('theme_set_allowed'))) {
                $this->setConfig('theme_set', $_SESSION['xoopsUserTheme']);
            }
        }
    }

    public function getTplInfo($tpl_name)
    {
        $parts = array();
        $ret = false;
        $matched = preg_match('#(\w+):(\w+)/(.*)$#', $tpl_name, $parts);
        if ($matched) {
            $names = array('tpl_name', 'type', 'module', 'file');
            $ret = array();
            for ($i=0; $i<4; ++$i) {
                 $ret[$names[$i]] = $parts[$i];
            }
        } else {
            // this should be eleminated
            $this->events()->triggerEvent('debug.log', "Sloppy template: " . $tpl_name);
            $ret = array();
            $ret['type'] = $this->isAdminSide ? 'admin' : 'module';
            $info = explode(':', $tpl_name);
            if (count($info) == 2) {
                $ret['type'] = $info[0];
                $tpl_name = str_replace($ret['type'] . ':', '', $tpl_name);
            }

            if ($ret['type'] == 'db') {
                //For legacy compatibility
                $ret['type'] = $this->isAdminSide ? 'admin' : 'module';
            }

            $info = explode('|', $tpl_name);
            if (count($info) == 2) {
                $ret['module'] = $info[0];
                $ret['file'] = $info[1];
            } else {
                $ret['module'] = 'system';
                $ret['file'] = $tpl_name;
                if ($this->isModule()) {
                    $ret['module'] = $this->module->getVar('dirname', 'n');
                }
            }
            $ret['tpl_name'] = $ret['type'] . ':' . $ret['module'] . '/' . $ret['file'];
        }

        return $ret;
    }

    public function header($tpl_name = null)
    {
        static $included = false;
        if ($included) {
            return false;
        }
        $included = true;

        $this->events()->triggerEvent('core.header.start');

        //For legacy
        if (!$tpl_name && isset($this->option['template_main'])) {
            $tpl_name = $this->option['template_main'];
            $this->deprecated('XoopsOption \'template_main\' is deprecated, please use $xoops->header(\'templatename.tpl\') instead');
        }
        $this->theme($tpl_name);
        $this->tpl()->assign('xoops', $this);

        if ($this->isAdminSide) {
            $this->events()->triggerEvent('system.class.gui.header');
            include_once $this->path('modules/system/themes/default/default.php');
            $gui = new XoopsGuiDefault();
            $gui->header();
        } else {
            $this->events()->triggerEvent('core.header.addmeta');
            // Temporary solution for start page redirection
            if (defined("XOOPS_STARTPAGE_REDIRECTED")) {
                $smarty = $repeat = null;
                $this->theme()
                        ->headContent(null, "<base href='" . \XoopsBaseConfig::get('url') . '/modules/' . $this->getConfig('startpage') . "/' />", $smarty, $repeat);
            }

            if (@is_object($this->theme()->plugins['XoopsThemeBlocksPlugin'])) {
                $aggreg = $this->theme()->plugins['XoopsThemeBlocksPlugin'];
                // Backward compatibility code for pre 2.0.14 themes
                $this->tpl()->assignByRef('xoops_lblocks', $aggreg->blocks['canvas_left']);
                $this->tpl()->assignByRef('xoops_rblocks', $aggreg->blocks['canvas_right']);
                $this->tpl()->assignByRef('xoops_ccblocks', $aggreg->blocks['page_topcenter']);
                $this->tpl()->assignByRef('xoops_clblocks', $aggreg->blocks['page_topleft']);
                $this->tpl()->assignByRef('xoops_crblocks', $aggreg->blocks['page_topright']);
                $this->tpl()->assign('xoops_showlblock', !empty($aggreg->blocks['canvas_left']));
                $this->tpl()->assign('xoops_showrblock', !empty($aggreg->blocks['canvas_right']));
                $this->tpl()
                        ->assign('xoops_showcblock', !empty($aggreg->blocks['page_topcenter']) || !empty($aggreg->blocks['page_topleft']) || !empty($aggreg->blocks['page_topright']));
            }

            // Sets cache time
            if ($this->isModule()) {
                $cache_times = $this->getConfig('module_cache');
                $this->theme()->contentCacheLifetime = isset($cache_times[$this->module->getVar('mid')]) ? $cache_times[$this->module->getVar('mid')] : 0;
                // Tricky solution for setting cache time for homepage
            } else {
                if ($this->tpl_name == 'module:system/system_homepage.tpl') {
                    // $this->theme->contentCacheLifetime = 604800;
                }
            }
            $this->events()->triggerEvent('core.header.checkcache');
            if ($this->theme()->checkCache()) {
                exit();
            }
        }

        if (!isset($this->tpl_name) && $this->isModule()) {
            ob_start();
        }

        $this->events()->triggerEvent('core.header.end');
        return true;
    }

    public function footer()
    {
        static $included = false;
        if ($included) {
            return false;
        }
        $included = true;

        $this->events()->triggerEvent('core.footer.start');

        if (!headers_sent()) {
            header('Content-Type:text/html; charset=' . XoopsLocale::getCharset());
            header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
            header('Cache-Control: private, no-cache');
            header('Pragma: no-cache');
        }

        if (isset($this->option['template_main']) && $this->option['template_main'] != $this->theme()->contentTemplate) {
            trigger_error("xoopsOption[template_main] should be defined before including header.php", E_USER_WARNING);
            $this->theme()->contentTemplate = $this->tpl_name;
        }
        $this->theme()->render();
        $this->events()->triggerEvent('core.footer.end');
        exit();
    }

    public function isModule()
    {
        return $this->module instanceof XoopsModule ? true : false;
    }

    public function isUser()
    {
        return $this->user instanceof XoopsUser ? true : false;
    }

    public function isAdmin()
    {
        return $this->userIsAdmin;
    }

    public function getHandlerBlock($optional = false)
    {
        return $this->getHandler('block', $optional);
    }

    public function getHandlerBlockmodulelink($optional = false)
    {
        return $this->getHandler('blockmodulelink', $optional);
    }

    public function getHandlerConfig($optional = false)
    {
        return $this->getHandler('config', $optional);
    }

    public function getHandlerConfigitem($optional = false)
    {
        return $this->getHandler('configitem', $optional);
    }

    public function getHandlerConfigoption($optional = false)
    {
        return $this->getHandler('configoption', $optional);
    }

    public function getHandlerGroup($optional = false)
    {
        return $this->getHandler('group', $optional);
    }

    public function getHandlerGroupperm($optional = false)
    {
        return $this->getHandler('groupperm', $optional);
    }

    public function getHandlerMember($optional = false)
    {
        return $this->getHandler('member', $optional);
    }

    public function getHandlerMembership($optional = false)
    {
        return $this->getHandler('membership', $optional);
    }

    public function getHandlerModule($optional = false)
    {
        return $this->getHandler('module', $optional);
    }

    public function getHandlerOnline($optional = false)
    {
        return $this->getHandler('online', $optional);
    }

    public function getHandlerPrivmessage($optional = false)
    {
        return $this->getHandler('privmessage', $optional);
    }

    public function getHandlerRanks($optional = false)
    {
        return $this->getHandler('ranks', $optional);
    }

    public function session()
    {
        if ($this->sessionManager === null) {
            $this->sessionManager = new \Xoops\Core\Session\Manager();
        }
        return $this->sessionManager;
    }

    public function getHandlerTplfile($optional = false)
    {
        return $this->getHandler('tplfile', $optional);
    }

    public function getHandlerTplset($optional = false)
    {
        return $this->getHandler('tplset', $optional);
    }

    public function getHandlerUser($optional = false)
    {
        return $this->getHandler('user', $optional);
    }

    public function getHandler($name, $optional = false)
    {
        $name = strtolower(trim($name));
        $class = '';
        if (!isset($this->kernelHandlers[$name])) {
            $class = 'Xoops' . ucfirst($name) . 'Handler';
            if (class_exists($class)) {
                $this->kernelHandlers[$name] = new $class($this->db());
            }
        }
        if (!isset($this->kernelHandlers[$name])) {
            $this->logger()->log(
                $optional ? \Psr\Log\LogLevel::WARNING : \Psr\Log\Loglevel::ERROR,
                'Class <strong>' . $class . '</strong> does not exist<br />Handler Name: ' . $name
            );
        } else {
            return $this->kernelHandlers[$name];
        }
        return false;
    }

    public function getModuleHandler($name = null, $module_dir = null, $optional = false)
    {
        // if $module_dir is not specified
        if (!isset($module_dir)) {
            // if a module is loaded
            if ($this->module instanceof XoopsModule) {
                $module_dir = $this->module->getVar('dirname', 'n');
            } else {
                trigger_error('No Module is loaded', E_USER_ERROR);
            }
        } else {
            $module_dir = trim($module_dir);
        }
        $name = (!isset($name)) ? $module_dir : trim($name);
        if (!isset($this->moduleHandlers[$module_dir][$name])) {
            if (XoopsLoad::fileExists($hnd_file = \XoopsBaseConfig::get('root-path') . "/modules/{$module_dir}/class/{$name}.php")) {
                include_once $hnd_file;
            }
            $class = ucfirst(strtolower($module_dir)) . ucfirst($name) . 'Handler';
            if (class_exists($class)) {
                $this->moduleHandlers[$module_dir][$name] = new $class($this->db());
            }
        }
        if (!isset($this->moduleHandlers[$module_dir][$name])) {
            trigger_error('Handler does not exist<br />Module: ' . $module_dir . '<br />Name: ' . $name, $optional ? E_USER_WARNING : E_USER_ERROR);
        }
        if (isset($this->moduleHandlers[$module_dir][$name])) {
            return $this->moduleHandlers[$module_dir][$name];
        }
        return false;
    }

    public function getModuleForm($obj, $name, $module_dir = null)
    {
        if (empty($name)) {
            return false;
        }
        if (empty($module_dir)) {
            if ($this->isModule()) {
                $module_dir = $this->module->getVar('dirname', 'n');
            } else {
                return false;
            }
        }
        if (XoopsLoad::fileExists($hnd_file = \XoopsBaseConfig::get('root-path') . "/modules/{$module_dir}/class/form/{$name}.php")) {
            include_once $hnd_file;
            $class = ucfirst(strtolower($module_dir)) . ucfirst($name) . 'Form';
            if (class_exists($class)) {
                $instance = new $class($obj);
                if ($instance instanceof \Xoops\Form\Form) {
                    return $instance;
                }
            }
        }
        return false;
    }

    public function getModuleHelper($dirname)
    {
        return \Xoops\Module\Helper::getHelper($dirname);
    }

    public function loadLanguage($name, $domain = '', $language = null)
    {
        if (empty($name)) {
            return false;
        }

        $language = empty($language) ? XoopsLocale::getLegacyLanguage() : $language;
        // expanded domain to multiple categories, e.g. module:Fsystem, framework:filter, etc.
        if ((empty($domain) || 'global' == $domain)) {
            $path = '';
        } else {
            $path = (is_array($domain)) ? array_shift($domain) . '/' : "modules/{$domain}/";
        }
        $path .= 'language';

        if (!XoopsLoad::fileExists($file = $this->path("{$path}/{$language}/{$name}.php"))) {
            if (!XoopsLoad::fileExists($file = $this->path("{$path}/english/{$name}.php"))) {
                return false;
            }
        }
        $ret = include_once $file;
        return $ret;
    }

    public static function loadLocale($domain = 'xoops', $locale = null)
    {
        return Xoops_Locale::loadLocale($domain, $locale);
    }

    public function translate($key, $dirname = 'xoops')
    {
        return Xoops_Locale::translate($key, $dirname);
    }

    public function getActiveModules()
    {
        if (is_array($this->activeModules)) {
            return $this->activeModules;
        }

        try {
            if (!$this->activeModules = $this->cache()->read('system/modules/active')) {
                $this->activeModules = $this->setActiveModules();
            }
        } catch (\Exception $e) {
            $this->activeModules = array();
        }
        return $this->activeModules;
    }

    public function setActiveModules()
    {
        $module_handler = $this->getHandlerModule();
        $modules_array = $module_handler->getAll(new Criteria('isactive', 1), array('dirname'), false, false);
        $modules_active = array();
        foreach ($modules_array as $module) {
            $modules_active[$module['mid']] = $module['dirname'];
        }
        $this->cache()->write('system/modules/active', $modules_active);
        return $modules_active;
    }

    public function isActiveModule($dirname)
    {
        if (isset($dirname) && in_array($dirname, $this->getActiveModules())) {
            return true;
        }
        return false;
    }

    public function getModuleByDirname($dirname)
    {
        $key = "system/module/dirname/{$dirname}";
        if (!$module = $this->cache()->read($key)) {
            $module = $this->getHandlerModule()->getByDirname($dirname);
            $this->cache()->write($key, $module);
        }
        return $module;
    }

    public function getModuleById($id)
    {
        $key = "system/module/id/{$id}";
        if (!$module = $this->cache()->read($key)) {
            $module = $this->getHandlerModule()->getById($id);
            $this->cache()->write($key, $module);
        }
        return $module;
    }

    public function simpleHeader($closehead = true)
    {
        $this->events()->triggerEvent('core.header.start');
        $this->theme();
        $xoopsConfigMetaFooter = $this->getConfigs();
        $xoops = \Xoops::getInstance();

        if (!headers_sent()) {
            header('Content-Type:text/html; charset=' . XoopsLocale::getCharset());
            header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
            header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
            header('Cache-Control: no-store, no-cache, max-age=1, s-maxage=1, must-revalidate, post-check=0, pre-check=0');
            header("Pragma: no-cache");
        }

        echo "<!DOCTYPE html>\n";
        $xoops_url = \XoopsBaseConfig::get('url');
        echo '<html lang="' . XoopsLocale::getLangCode() . '">
              <head>
              <meta http-equiv="content-type" content="text/html; charset=' . XoopsLocale::getCharset() . '" />
              <meta name="robots" content="' . htmlspecialchars($xoopsConfigMetaFooter['meta_robots']) . '" />
              <meta name="keywords" content="' . htmlspecialchars($xoopsConfigMetaFooter['meta_keywords']) . '" />
              <meta name="description" content="' . htmlspecialchars($xoopsConfigMetaFooter['meta_description']) . '" />
              <meta name="rating" content="' . htmlspecialchars($xoopsConfigMetaFooter['meta_rating']) . '" />
              <meta name="author" content="' . htmlspecialchars($xoopsConfigMetaFooter['meta_author']) . '" />
              <meta name="generator" content="XOOPS" />
              <title>' . htmlspecialchars($this->getConfig('sitename')) . '</title>
              <script type="text/javascript" src="' . $xoops_url . '/include/xoops.js"></script>
              <script type="text/javascript" src="' . $xoops_url . '/media/jquery/jquery.js"></script>
              <script type="text/javascript" src="' . $xoops_url . '/media/bootstrap/js/bootstrap.min.js"></script>';
        $themecss = $this->getCss($this->getConfig('theme_set'));
        echo '<link rel="stylesheet" type="text/css" media="all" href="' . $xoops_url . '/xoops.css" />';
        $locale = $this->getConfig('locale');
        if (XoopsLoad::fileExists($this->path('locale/' . $locale . '/style.css'))) {
            echo '<link rel="stylesheet" type="text/css" media="all" href="' . $xoops_url . '/locale/' . $locale . '/style.css" />';
        }
        if ($themecss) {
            echo '<link rel="stylesheet" type="text/css" media="all" href="' . $themecss . '" />';
            //echo '<link rel="stylesheet" type="text/css" media="screen" href="' . $this->url('themes/' . $this->getConfig('theme_set') . '/media/bootstrap/css/bootstrap.css') .'" />';
            echo '<link rel="stylesheet" type="text/css" media="screen" href="' . $this->url('themes/' . $this->getConfig('theme_set') . '/media/bootstrap/css/xoops.bootstrap.css') .'" />';
        }
        if ($closehead) {
            echo '</head><body>';
        }
    }

    public function simpleFooter()
    {
        $this->events()->triggerEvent('core.header.footer');
        echo '</body></html>';
        ob_end_flush();
    }
    public function alert($type, $msg, $title = '/')
    {
        $tpl = new \XoopsTpl();
        $alert_msg = '';
        switch ($type) {
            case 'info':
            default:
                $tpl->assign('alert_type', 'alert-info');
                if ($title == '/') {
                    $title = XoopsLocale::INFORMATION;
                }
                break;

            case 'error':
                $tpl->assign('alert_type', 'alert-error');
                if ($title == '/') {
                    $title = XoopsLocale::ERROR;
                }
                break;

            case 'success':
                $tpl->assign('alert_type', 'alert-success');
                if ($title == '/') {
                    $title = XoopsLocale::SUCCESS;
                }
                break;

            case 'warning':
                $tpl->assign('alert_type', '');
                if ($title == '/') {
                    $title = XoopsLocale::WARNING;
                }
                break;
        }

        if ($title != '') {
            $tpl->assign('alert_title', $title);
        }
        if (!is_scalar($msg) && !is_array($msg)) {
            $msg = ''; // don't know what to do with this, so make it blank
        }
        if (is_array($msg)) {
            // if this is not a simple array of strings, this might not work
            $alert_msg = @implode("<br />", $msg);
        } else {
            $alert_msg = $msg;
        }
        if ($alert_msg == '') {
            return '';
        } else {
            $tpl->assign('alert_msg', $alert_msg);
            $ret = $tpl->fetch('module:system/system_alert.tpl');
            return $ret;
        }
    }

    public function confirm($hiddens, $action, $msg, $submit = '', $addtoken = true)
    {
        $tpl = new \XoopsTpl();
        $submit = ($submit != '') ? trim($submit) : XoopsLocale::A_SUBMIT;
        $tpl->assign('msg', $msg);
        $tpl->assign('action', $action);
        $tpl->assign('submit', $submit);
        $str_hiddens = '';
        foreach ($hiddens as $name => $value) {
            if (is_array($value)) {
                foreach ($value as $caption => $newvalue) {
                    $str_hiddens .= '<input type="radio" name="' . $name . '" value="' . htmlspecialchars($newvalue) . '" > ' . $caption . NWLINE;
                }
                $str_hiddens .= '<br />' . NWLINE;
            } else {
                $str_hiddens .= '<input type="hidden" name="' . $name . '" value="' . htmlspecialchars($value) . '" />' . NWLINE;
            }
        }
        if ($addtoken != false) {
            $tpl->assign('token', $this->security()->getTokenHTML());
        }
        $tpl->assign('hiddens', $str_hiddens);
        return $tpl->fetch('module:system/system_confirm.tpl');
    }

    public function getUserTimestamp($time, $timeoffset = '')
    {
        if ($timeoffset == '') {
            if ($this->isUser()) {
                $timeoffset = $this->user->getVar('timezone_offset');
            } else {
                $timeoffset = $this->getConfig('default_TZ');
            }
        }
        $usertimestamp = intval($time) + (floatval($timeoffset) - $this->getConfig('server_TZ')) * 3600;
        return (int)$usertimestamp;
    }

    public function userTimeToServerTime($timestamp, $userTZ = null)
    {
        if (!isset($userTZ)) {
            $userTZ = $this->getConfig('default_TZ');
        }
        $timestamp = $timestamp - (($userTZ - $this->getConfig('server_TZ')) * 3600);
        return (int)$timestamp;
    }

    public function getUserGroups()
    {
        $groups = $this->isUser() ? $this->user->getGroups() : array(FixedGroups::ANONYMOUS);

        return $groups;
    }

    public function makePass()
    {
        $makepass = '';
        $syllables = array(
            'er', 'in', 'tia', 'wol', 'fe', 'pre', 'vet', 'jo', 'nes', 'al', 'len', 'son', 'cha', 'ir', 'ler', 'bo',
            'ok', 'tio', 'nar', 'sim', 'ple', 'bla', 'ten', 'toe', 'cho', 'co', 'lat', 'spe', 'ak', 'er', 'po', 'co',
            'lor', 'pen', 'cil', 'li', 'ght', 'wh', 'at', 'the', 'he', 'ck', 'is', 'mam', 'bo', 'no', 'fi', 've', 'any',
            'way', 'pol', 'iti', 'cs', 'ra', 'dio', 'sou', 'rce', 'sea', 'rch', 'pa', 'per', 'com', 'bo', 'sp', 'eak',
            'st', 'fi', 'rst', 'gr', 'oup', 'boy', 'ea', 'gle', 'tr', 'ail', 'bi', 'ble', 'brb', 'pri', 'dee', 'kay',
            'en', 'be', 'se'
        );
        for ($count = 1; $count <= 4; ++$count) {
            if (1 == rand() % 10) {
                $makepass .= sprintf('%0.0f', (rand() % 50) + 1);
            } else {
                $makepass .= sprintf('%s', $syllables[rand() % 62]);
            }
        }
        return $makepass;
    }

    public function checkEmail($email, $antispam = false)
    {
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            return false;
        }
        if ($antispam) {
            $email = str_replace("@", " at ", $email);
            $email = str_replace(".", " dot ", $email);
        }
        return $email;
    }

    public function formatURL($url)
    {
        $url = trim($url);
        if ($url != '') {
            if (!preg_match('/^(https?|ftps?|ed2k)\:\/\//i', $url)) {
                $url = 'http://' . $url;
            }
        }
        return $url;
    }

    public function getBanner()
    {
        $options = '';
        $this->events()->triggerEvent('core.banner.display', array(&$options));
        return $options;
    }

    public function redirect($url, $time = 3, $message = '', $addredirect = true, $allowExternalLink = false)
    {
        $this->events()->triggerEvent('core.include.functions.redirectheader.start', array(
            $url, $time, $message, $addredirect, $allowExternalLink
        ));
        // if conditions are right, system preloads will exit on this call
        // so don't use it if you want to be called, use start version above.
        $this->events()->triggerEvent('core.include.functions.redirectheader', array(
            $url, $time, $message, $addredirect, $allowExternalLink
        ));

        $xoops_url = \XoopsBaseConfig::get('url');

        if (preg_match("/[\\0-\\31]|about:|script:/i", $url)) {
            if (!preg_match('/^\b(java)?script:([\s]*)history\.go\(-[0-9]*\)([\s]*[;]*[\s]*)$/si', $url)) {
                $url = $xoops_url;
            }
        }
        if (!$allowExternalLink && $pos = strpos($url, '://')) {
            $xoopsLocation = substr($xoops_url, strpos($xoops_url, '://') + 3);
            if (strcasecmp(substr($url, $pos + 3, strlen($xoopsLocation)), $xoopsLocation)) {
                $url = $xoops_url;
            }
        }
        if (!defined('XOOPS_CPFUNC_LOADED')) {
            $theme = 'default';
        } else {
            $theme = $this->getConfig('theme_set');
        }

        $xoopsThemeFactory = null;
        $xoopsThemeFactory = new XoopsThemeFactory();
        $xoopsThemeFactory->allowedThemes = $this->getConfig('theme_set_allowed');
        $xoopsThemeFactory->defaultTheme = $theme;
        $this->setTheme($xoopsThemeFactory->createInstance(array(
            "plugins" => array(), "renderBanner" => false
        )));
        $this->setTpl($this->theme()->template);
        $this->tpl()->assign(array(
            'xoops_theme'      => $theme, 'xoops_imageurl' => \XoopsBaseConfig::get('themes-url') . '/' . $theme . '/',
            'xoops_themecss'   => $this->getCss($theme),
            'xoops_requesturi' => htmlspecialchars($_SERVER['REQUEST_URI'], ENT_QUOTES),
            'xoops_sitename'   => htmlspecialchars($this->getConfig('sitename'), ENT_QUOTES),
            'xoops_slogan'     => htmlspecialchars($this->getConfig('slogan'), ENT_QUOTES),
            'xoops_dirname'    => $this->isModule() ? $this->module->getVar('dirname') : 'system',
            'xoops_pagetitle'  => $this->isModule() ? $this->module->getVar('name') : htmlspecialchars($this->getConfig('slogan'), ENT_QUOTES)
        ));

        $this->tpl()->assign('time', intval($time));
        if (!empty($_SERVER['REQUEST_URI']) && $addredirect && strstr($url, 'user.php')) {
            $joiner = (false===strpos($url, '?')) ? '?' : '&amp;';
            $url .= $joiner . 'xoops_redirect=' . urlencode($_SERVER['REQUEST_URI']);
        }
        $url = preg_replace("/&amp;/i", '&', htmlspecialchars($url, ENT_QUOTES));
        $this->tpl()->assign('url', $url);
        $message = trim($message) != '' ? $message : XoopsLocale::E_TAKING_YOU_BACK;
        $this->tpl()->assign('message', $message);
        $this->tpl()->assign('lang_ifnotreload', sprintf(XoopsLocale::F_IF_PAGE_NOT_RELOAD_CLICK_HERE, $url));

        $this->events()->triggerEvent('core.include.functions.redirectheader.end');
        $this->tpl()->display('module:system/system_redirect.tpl');
        exit();
    }

    public function getEnv($key)
    {
        $ret = '';
        if (array_key_exists($key, $_SERVER) && isset($_SERVER[$key])) {
            $ret = $_SERVER[$key];
            return $ret;
        }
        if (array_key_exists($key, $_ENV) && isset($_ENV[$key])) {
            $ret = $_ENV[$key];
            return $ret;
        }
        return $ret;
    }

    public function getCss($theme = '')
    {
        if ($theme == '') {
            $theme = $this->getConfig('theme_set');
        }
        $uagent = $this->getEnv('HTTP_USER_AGENT');
        if (stristr($uagent, 'mac')) {
            $str_css = 'styleMAC.css';
        } elseif (preg_match("/MSIE ([0-9]\.[0-9]{1,2})/i", $uagent)) {
            $str_css = 'style.css';
        } else {
            $str_css = 'styleNN.css';
        }
        $xoops_theme_path = \XoopsBaseConfig::get('themes-path');
        $xoops_theme_url = \XoopsBaseConfig::get('themes-url');
        if (is_dir($xoops_theme_path . '/' . $theme)) {
            if (XoopsLoad::fileExists($xoops_theme_path . '/' . $theme . '/' . $str_css)) {
                return $xoops_theme_url . '/' . $theme . '/' . $str_css;
            } elseif (XoopsLoad::fileExists($xoops_theme_path . '/' . $theme . '/style.css')) {
                return $xoops_theme_url . '/' . $theme . '/style.css';
            }
        }
        if (is_dir($xoops_theme_path . '/' . $theme . '/css')) {
            if (XoopsLoad::fileExists($xoops_theme_path . '/' . $theme . '/css/' . $str_css)) {
                return $xoops_theme_url . '/' . $theme . '/css/' . $str_css;
            } elseif (XoopsLoad::fileExists($xoops_theme_path . '/' . $theme . '/css/style.css')) {
                return $xoops_theme_url . '/' . $theme . '/css/style.css';
            }
        }
        return '';
    }

    public function getMailer()
    {
        static $mailer;
        if (is_object($mailer)) {
            return $mailer;
        }
        Xoops_Locale::loadMailerLocale();
        if (class_exists('XoopsMailerLocale')) {
            $mailer = new XoopsMailerLocale();
        } else {
            $mailer = new XoopsMailer();
        }
        return $mailer;
    }

    public function getRank($rank_id = 0, $posts = 0)
    {
        $myts = MyTextSanitizer::getInstance();
        $rank_id = intval($rank_id);
        $posts = intval($posts);
        $db = $this->db();
        $sql = $db->createXoopsQueryBuilder()
            ->select('r.rank_title AS title')
            ->addSelect('r.rank_image AS image')
            ->fromPrefix('ranks', 'r');
        $eb = $sql->expr();
        if ($rank_id != 0) {
            $sql->where($eb->eq('r.rank_id', ':rank'))
                ->setParameter(':rank', $rank_id, \PDO::PARAM_INT);
        } else {
            $sql->where($eb->lte('r.rank_min', ':posts'))
                ->andWhere($eb->gte('r.rank_max', ':posts'))
                ->andWhere($eb->eq('r.rank_special', 0))
                ->setParameter(':posts', $posts, \PDO::PARAM_INT);
        }

        $rank = $db->fetchAssoc($sql->getSql(), $sql->getParameters());

        $rank['title'] = $myts->htmlspecialchars($rank['title']);
        $rank['id'] = $rank_id;
        return $rank;

    }

    public function getOption($key)
    {
        $ret = '';
        if (isset($this->option[$key])) {
            $ret = $this->option[$key];
        }
        return $ret;
    }

    public function setOption($key, $value = null)
    {
        if (!is_null($value)) {
            $this->option[$key] = $value;
        }
    }

    public function getConfig($key)
    {
        return $this->getModuleConfig($key, 'system');
    }

    public function getConfigs()
    {
        return $this->getModuleConfigs('system');
    }

    public function addConfigs($configs, $dirname = 'system')
    {
        $dirname = trim(strtolower($dirname));
        if (empty($dirname)) {
            $dirname = $this->isModule() ? $this->module->getVar('dirname') : 'system';
        }
        if (!empty($dirname)) {
            $this->moduleConfigs[$dirname] = array_merge($this->moduleConfigs[$dirname], (array)$configs);
        }
    }

    public function setConfig($key, $value = null, $dirname = 'system')
    {
        if (!is_null($value)) {
            $dirname = trim(strtolower($dirname));
            if (empty($dirname)) {
                $dirname = $this->isModule() ? $this->module->getVar('dirname') : 'system';
            }
            $this->moduleConfigs[$dirname][$key] =& $value;
        }
    }

    public function appendConfig($key, array $values, $appendWithKey = false, $dirname = 'system')
    {
        $dirname = trim(strtolower($dirname));
        if (empty($dirname)) {
            $dirname = $this->isModule() ? $this->module->getVar('dirname') : 'system';
        }
        if ($appendWithKey) {
            foreach ($values as $key2 => $value) {
                if (!isset($this->moduleConfigs[$dirname][$key]) || !is_array($this->moduleConfigs[$dirname][$key])) {
                    $this->moduleConfigs[$dirname][$key] = array();
                }
                $this->moduleConfigs[$dirname][$key][$key2] =& $value;
            }
        } else {
            $this->moduleConfigs[$dirname][$key][] =& $values;
        }
    }

    public function getModuleConfig($key, $dirname = '')
    {
        $dirname = trim(strtolower($dirname));
        if (empty($dirname)) {
            $dirname = $this->isModule() ? $this->module->getVar('dirname') : 'system';
        }

        if (isset($this->moduleConfigs[$dirname][$key])) {
            return $this->moduleConfigs[$dirname][$key];
        }

        $this->getModuleConfigs($dirname);

        if (!isset($this->moduleConfigs[$dirname][$key])) {
            $this->moduleConfigs[$dirname][$key] = '';
        }
        return $this->moduleConfigs[$dirname][$key];
    }

    public function getModuleConfigs($dirname = '')
    {
        $dirname = trim($dirname);
        if (empty($dirname)) {
            $dirname = $this->isModule() ? $this->module->getVar('dirname') : 'system';
        }
        if (isset($this->moduleConfigs[$dirname])) {
            return $this->moduleConfigs[$dirname];
        }
        $this->moduleConfigs[$dirname] = array();
        $key = "system/module/configs/{$dirname}";
        if (!$configs = $this->cache()->read($key)) {
            $module = $this->getModuleByDirname($dirname);
            if (is_object($module)) {
                $configs = $this->getHandlerConfig()->getConfigsByModule($module->getVar('mid'));
                $this->cache()->write($key, $configs);
                $this->moduleConfigs[$dirname] =& $configs;
            }
        } else {
            $this->moduleConfigs[$dirname] =& $configs;
        }

        if ($this->isModule()) {
            //for legacy
            $this->moduleConfig =& $this->moduleConfigs[$this->module->getVar('dirname')];
        }
        if ($dirname == 'system') {
            $this->config =& $this->moduleConfigs['system'];
        }
        return $this->moduleConfigs[$dirname];
    }

    public function disableModuleCache()
    {
        if ($this->isModule()) {
            $this->appendConfig('module_cache', array($this->module->getVar('mid') => 0), true);
        }
    }

    public function getBaseDomain($url, $includeSubdomain = false, $returnObject = false)
    {
        $pslManager = new \Pdp\PublicSuffixListManager();
        $parser = new \Pdp\Parser($pslManager->getList());

        $url=mb_strtolower($url, 'UTF-8');

        try {
            // use php-domain-parser to give us just the domain
            $pdp = $parser->parseUrl($url);
            $host = $pdp->host->host;
        } catch (\Exception $e) {
            $this->events()->triggerEvent('core.exception', $e);
            return null;
        }
        // check for exceptions, localhost and ip address (v4 & v6)
        if (!empty($host)) {
            // localhost exception
            if ($host=='localhost') {
                return $returnObject ? $pdp->host : $host;
            }
            // Check for IPV6 URL (see http://www.ietf.org/rfc/rfc2732.txt)
            // strip brackets before validating
            if (substr($host, 0, 1)=='[' && substr($host, -1)==']') {
                $host = substr($host, 1, (strlen($host)-2));
            }
            // ip address exception
            if (filter_var($host, FILTER_VALIDATE_IP)) {
                return $returnObject ? new \Pdp\Uri\Url\Host(null, null, null, $host) : $host;
            }
        }

        $host = $pdp->host->registerableDomain;
        if (!empty($host) && $includeSubdomain) {
            $host = $pdp->host->host;
        }
        return $returnObject ? $pdp->host : $host;
    }

    public function templateTouch($tpl_id)
    {
        $tplfile = $this->getHandlerTplfile()->get($tpl_id);

        if (is_object($tplfile)) {
            $file = $tplfile->getVar('tpl_file', 'n');
            $module = $tplfile->getVar('tpl_module', 'n');
            $type = $tplfile->getVar('tpl_type', 'n');
            $tpl = new XoopsTpl();
            return $tpl->touch($type . ':' . $module . '/' . $file);
        }
        return false;
    }

    public function templateClearModuleCache($mid)
    {
        $module = $this->getModuleById($mid);
        $xoopsTpl = new XoopsTpl();
        $xoopsTpl->clearModuleCompileCache($module->getVar('dirname'));
    }

    public function deprecated($message)
    {
        $message = $this->logger()->sanitizePath($message);
        $this->events()->triggerEvent('core.deprecated', array($message));
    }

    public function disableErrorReporting()
    {
        //error_reporting(0);
        $this->events()->triggerEvent('core.disableerrorreporting');
    }
}