preload.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 Psr\Log\LogLevel;
use Xoops\Core\PreloadItem;

class DebugbarPreload extends PreloadItem
{
    private static $registry = array();

    private static function getConfigs()
    {
        static $configs = null;

        if (is_null($configs)) {
            $xoops = Xoops::getInstance();
            $user_groups = $xoops->getUserGroups();
            $moduleperm_handler = $xoops->getHandlerGroupperm();
            $helper = $xoops->getModuleHelper('debugbar');
            $mid = $helper->getModule()->getVar('mid');
            if ($moduleperm_handler->checkRight('use_debugbar', 0, $user_groups, $mid)) {
                // get default settings
                $configs['debugbar_enable'] = $helper->getConfig('debugbar_enable');
                $configs['debug_smarty_enable'] = $helper->getConfig('debug_smarty_enable');
                // override with settings
                $uchelper = $xoops->getModuleHelper('userconfigs');
                if ($xoops->isUser() && $uchelper) {
                    $config_handler = $uchelper->getHandlerConfig();
                    $user_configs =
                        $config_handler->getConfigsByUser($xoops->user->getVar('uid'), $mid);
                    if (array_key_exists('debugbar_enable', $user_configs)) {
                        $configs['debugbar_enable'] = $user_configs['debugbar_enable'];
                    }
                    if (array_key_exists('debug_smarty_enable', $user_configs)) {
                        $configs['debug_smarty_enable'] = $user_configs['debug_smarty_enable'];
                    }
                }
            } else {
                // user has no permissions, turn everything off
                $configs['debugbar_enable'] = 0;
                $configs['debug_smarty_enable'] = 0;
            }
        }

        return $configs;
    }

    public static function eventCoreException($e)
    {
        DebugbarLogger::getInstance()->addException($e);
    }

    public static function eventCoreIncludeCommonClassmaps($args)
    {
        $path = dirname(__DIR__);
        XoopsLoad::addMap(array(
            'debugbarlogger' => $path . '/class/debugbarlogger.php',
        ));
    }

    public static function eventCoreIncludeCommonStart($args)
    {
        $logger = DebugbarLogger::getInstance();

        $logger->enable();//until we get a db connection debug is enabled
        //if (isset($_SERVER['REQUEST_TIME_FLOAT'])) {
        //    $logger->getDebugbar()['time']->addMeasure('Loading', $_SERVER['REQUEST_TIME_FLOAT'], microtime(true));
        //}
        $logger->startTime();
        $logger->startTime('XOOPS Boot');
    }

    public static function eventCoreDatabaseNoconn($args)
    {
        if (class_exists('DebugbarLogger')) {
            /* @var $db Xoops\Core\Database\Connection */
            $db = $args[0];
            DebugbarLogger::getInstance()->log(LogLevel::ALERT, $db->error(), array('errno' => $db->errno()));
        }
    }

    public static function eventCoreDatabaseNodb($args)
    {
        if (class_exists('DebugbarLogger')) {
            /* @var $db Xoops\Core\Database\Connection */
            $db = $args[0];
            DebugbarLogger::getInstance()->log(LogLevel::ALERT, $db->error(), array('errno' => $db->errno()));
        }
    }

    public static function eventCoreIncludeCommonAuthSuccess()
    {
        $xoops = Xoops::getInstance();
        $logger = DebugbarLogger::getInstance();
        $configs = self::getConfigs();
        if ($configs['debugbar_enable']) {
            $xoops->loadLocale();
            $xoops->loadLanguage('main', 'debugbar');
            $logger->enable();
        } else {
            $logger->disable();
        }
    }

    public static function eventCoreIncludeCommonEnd($args)
    {
        $logger = DebugbarLogger::getInstance();
        $logger->stopTime('XOOPS Boot');
        $logger->startTime('Module init');
    }

    public static function eventCoreTemplateConstructStart($args)
    {
        $tpl = $args[0];
        $configs = self::getConfigs();
        if ($configs['debugbar_enable']) {
            $tpl->debugging_ctrl = 'URL';
        }
        if ($configs['debug_smarty_enable']) {
                $tpl->debugging = true;
        }
    }

    public static function eventCoreThemeRenderStart($args)
    {
        DebugbarLogger::getInstance()->startTime('Page rendering');
    }

    public static function eventCoreThemeRenderEnd($args)
    {
        DebugbarLogger::getInstance()->stopTime('Page rendering');
        DebugbarLogger::getInstance()->addSmarty();
    }

    public static function eventCoreThemeCheckcacheSuccess($args)
    {
        $template = $args[0];
        $theme = $args[1];
        DebugbarLogger::getInstance()->addExtra(
            $template,
            sprintf('Cached (regenerates every %d seconds)', $theme->contentCacheLifetime)
        );
    }

    public static function eventCoreThemeblocksBuildblockStart($args)
    {
        /* @var $block XoopsBlock */
        $block = $args[0];
        $isCached= $args[1];
        //Logger::getInstance()->addBlock($block->getVar('name'), $isCached, $block->getVar('bcachetime'));
        $context = array('channel'=>'Blocks', 'cached'=>$isCached, 'cachetime'=>$block->getVar('bcachetime'));
        DebugbarLogger::getInstance()->log(LogLevel::INFO, $block->getVar('name'), $context);

    }

    public static function eventCoreDeprecated($args)
    {
        $message = $args[0];
        DebugbarLogger::getInstance()->log(LogLevel::WARNING, $message, array('channel'=>'Deprecated'));
    }

    public static function eventCoreDisableerrorreporting($args)
    {
        DebugbarLogger::getInstance()->disable();
    }

    public static function eventCoreHeaderStart($args)
    {
        $logger = DebugbarLogger::getInstance();
        $logger->stopTime('Module init');
        $logger->startTime('XOOPS output init');
    }

    public static function eventCoreHeaderEnd($args)
    {
        $logger = DebugbarLogger::getInstance();
        $logger->stopTime('XOOPS output init');
        $logger->startTime('Module display');
    }

    public static function eventCoreFooterStart($args)
    {
        $logger = DebugbarLogger::getInstance();
        $logger->stopTime('Module display');
    }

    public static function eventCoreFooterEnd($args)
    {
        $logger = DebugbarLogger::getInstance();
        $logger->stopTime();
    }

    public static function eventCoreIncludeFunctionsRedirectheaderStart($args)
    {
        DebugbarLogger::getInstance()->stackData();
    }

    public static function eventCoreSecurityValidatetokenEnd($args)
    {
        $logger = DebugbarLogger::getInstance();
        $logs = $args[0];
        foreach ($logs as $log) {
            $context = array('channel'=>'Extra', 'name'=>$log[0]);
            $logger->log(LogLevel::INFO, $log[1], $context);
        }
    }

    public static function eventCoreModuleAddlog($args)
    {
        $context = array('channel'=>'Extra', 'name'=>$args[0]);
        DebugbarLogger::getInstance()->log(LogLevel::DEBUG, $args[1], $context);

    }

    public static function eventDebugLog($args)
    {
        DebugbarLogger::getInstance()->dump($args);
    }

    public static function eventDebugTimerStart($args)
    {
        DebugbarLogger::getInstance()->startTime($args[0], $args[1]);
    }

    public static function eventDebugTimerStop($args)
    {
        DebugbarLogger::getInstance()->stopTime($args);
    }
}