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 MonologPreload extends PreloadItem
{
    private static $registry = array();

    private static $configs = null;

    private static function getConfigs()
    {
        $xoops = \Xoops::getInstance();
        if (array_key_exists('monolog_default_configs', self::$configs)
            && self::$configs['monolog_default_configs'] == true) {
            self::$configs = $xoops->getModuleConfigs('monolog');
        }
        /*
        if (!array_key_exists('phpfire_enable', self::$configs)) {
            $user_groups = $xoops->getUserGroups();
            $moduleperm_handler = $xoops->getHandlerGroupperm();
            $helper = $xoops->getModuleHelper('monolog');
            $mid = $helper->getModule()->getVar('mid');
            self::$configs['phpfire_enable'] = false;

            if ($moduleperm_handler->checkRight('use_monolog', 0, $user_groups, $mid)) {
                // only other settings are in user config
                $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('phpfire_enable', $user_configs)) {
                        self::$configs['phpfire_enable'] = $user_configs['phpfire_enable'];
                    }
                }
            } else {
                // user has no permissions, turn everything off
                self::$configs['phpfire_enable'] = false;
            }
        }
        */

        return self::$configs;
    }

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

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

    public static function eventCoreIncludeCommonSecurity($args)
    {
        $cache = \Xoops::getInstance()->cache();
        $key = 'system/module/configs/monolog';

        self::$configs=array();
        self::$configs['monolog_enable'] = false;
        self::$configs['monolog_default_configs']=true;

        // we will not regenerate this on a miss - will wait until auth is complete
        $monolog_configs = $cache->read($key);
        if ($monolog_configs!==false) {
            self::$configs = $monolog_configs;
        }
        $logger = MonologLogger::getInstance();

        if (self::$configs['monolog_enable']) {
            $logger->setConfigs(self::$configs);
            $logger->enable();
        } else {
            // turn everything off
            self::$configs['include_blocks'] = false;
            self::$configs['include_deprecated'] = false;
            self::$configs['include_extra'] = false;
            self::$configs['include_queries'] = false;
            self::$configs['include_timers'] = false;
            $logger->setConfigs(self::$configs);
        }
        $logger->startTime();
        $logger->startTime('XOOPS Boot');
    }

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

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

    public static function eventCoreDatabaseQueryComplete($args)
    {
        $sql = $args['sql'];
        $context = array(
            'channel'=>'Queries',
            'query_time'=>$args['executionMS'],
            'params'=>$args['params'],
            'types'=>$args['types'],
        );

        MonologLogger::getInstance()->log(LogLevel::INFO, $sql, $context);
    }

    public static function eventCoreIncludeCommonConfigsSuccess($args)
    {
        $xoops = Xoops::getInstance();
        $xoops->loadLocale();
        $xoops->loadLanguage('main', 'monolog');
    }

    public static function eventCoreIncludeCommonAuthSuccess()
    {
        $logger = MonologLogger::getInstance();
        $configs = self::getConfigs();
        $logger->setConfigs($configs);
        if ($configs['monolog_enable']) {
            $logger->enable();
        } else {
            $logger->disable();
        }
    }

    public static function eventCoreIncludeCommonEnd($args)
    {
        $logger = MonologLogger::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)
    {
        MonologLogger::getInstance()->startTime('Page rendering');
    }

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

    public static function eventCoreThemeCheckcacheSuccess($args)
    {
        $template = $args[0];
        $theme = $args[1];
        MonologLogger::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];
        $context = array('channel'=>'Blocks', 'cached'=>$isCached, 'cachetime'=>$block->getVar('bcachetime'));
        MonologLogger::getInstance()->log(LogLevel::INFO, $block->getVar('name'), $context);

    }

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

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

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

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

    public static function eventCoreFooterStart($args)
    {
        $logger = MonologLogger::getInstance();
        $logger->stopTime('Module display');
        $logger->addExtra(
            _MD_MONOLOG_MEMORY,
            sprintf(
                _MD_MONOLOG_MEM_USAGE,
                (float) memory_get_usage(true)/1000000,
                (float) memory_get_peak_usage(true)/1000000
            )
        );
        $logger->addExtra(
            _MD_MONOLOG_INCLUDED_FILES,
            sprintf(_MD_MONOLOG_FILES, count(get_included_files()))
        );
        $logger->stopTime();
    }

    public static function eventCoreFooterEnd($args)
    {
        //$logger = MonologLogger::getInstance();

        //$logger->stopTime();
    }

    public static function eventCoreSecurityValidatetokenEnd($args)
    {
        $logger = MonologLogger::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]);
        MonologLogger::getInstance()->log(LogLevel::DEBUG, $args[1], $context);

    }

    public static function eventSystemPreferencesSave($args)
    {
        $configs = array();
        $cache = \Xoops::getInstance()->cache();
        $key = 'system/module/configs/monolog';

        if (isset($_REQUEST['monolog_enable'])) {
            $cache->delete($key);

            $helper = \Xoops::getInstance()->getModuleHelper('monolog');
            $configs['monolog_enable'] = (bool) $helper->getConfig('monolog_enable');
            $configs['include_blocks'] = (bool) $helper->getConfig('include_blocks');
            $configs['include_deprecated'] = (bool) $helper->getConfig('include_deprecated');
            $configs['include_extra'] = (bool) $helper->getConfig('include_extra');
            $configs['include_queries'] = (bool) $helper->getConfig('include_queries');
            $configs['include_timers'] = (bool) $helper->getConfig('include_timers');
            $configs['logging_threshold'] = $helper->getConfig('logging_threshold');
            $configs['log_file_path'] = $helper->getConfig('log_file_path');
            $configs['max_versions'] = (int) $helper->getConfig('max_versions');

            $cache->write($key, $configs);
        }

    }
}