Yii2Debug.php

Go to the documentation of this file.

<?php

class Yii2Debug extends CApplicationComponent
{
        public $allowedIPs = array('127.0.0.1', '::1');
        public $accessExpression;
        public $panels = array();
        public $logPath;
        public $historySize = 50;
        public $enabled = true;
        public $moduleId = 'debug';
        public $internalUrls = true;
        public $highlightCode = true;
        public $showConfig = false;
        public $hiddenConfigOptions = array(
                'components/db/username',
                'components/db/password',
        );

        private $_tag;

        public function init()
        {
                parent::init();
                if (!$this->enabled) return;

                Yii::setPathOfAlias('yii2-debug', dirname(__FILE__));
                Yii::app()->setImport(array(
                        'yii2-debug.*',
                        'yii2-debug.panels.*',
                ));

                if ($this->logPath === null) {
                        $this->logPath = Yii::app()->getRuntimePath() . '/debug';
                }

                $panels = array();
                foreach (CMap::mergeArray($this->corePanels(), $this->panels) as $id => $config) {
                        if (!isset($config['highlightCode'])) $config['highlightCode'] = $this->highlightCode;
                        $panels[$id] = Yii::createComponent($config, $this, $id);
                }
                $this->panels = $panels;

                Yii::app()->setModules(array(
                        $this->moduleId => array(
                                'class' => 'Yii2DebugModule',
                                'owner' => $this,
                        ),
                ));

                if ($this->internalUrls && (Yii::app()->getUrlManager()->urlFormat == 'path')) {
                        $rules = array();
                        foreach ($this->coreUrlRules() as $key => $value) {
                                $rules[$this->moduleId . '/' . $key] = $this->moduleId . '/' . $value;
                        }
                        Yii::app()->getUrlManager()->addRules($rules, false);
                }

                Yii::app()->attachEventHandler('onEndRequest', array($this, 'onEndRequest'));
                $this->initToolbar();
        }

        public function getTag()
        {
                if ($this->_tag === null) $this->_tag = uniqid();
                return $this->_tag;
        }

        protected function corePanels()
        {
                return array(
                        'config' => array(
                                'class' => 'Yii2ConfigPanel',
                        ),
                        'request' => array(
                                'class' => 'Yii2RequestPanel',
                        ),
                        'log' => array(
                                'class' => 'Yii2LogPanel',
                        ),
                        'profiling' => array(
                                'class' => 'Yii2ProfilingPanel',
                        ),
                        'db' => array(
                                'class' => 'Yii2DbPanel',
                        ),
                );
        }

        protected function coreUrlRules()
        {
                return array(
                        '' => 'default/index',
                        '<tag:[0-9a-f]+>/<action:toolbar|explain>' => 'default/<action>',
                        '<tag:[0-9a-f]+>/<panel:\w+>' => 'default/view',
                        'latest/<panel:\w+>' => 'default/view',
                        '<action:\w+>' => 'default/<action>',
                );
        }

        protected function initToolbar()
        {
                if (!$this->checkAccess()) return;
                $assetsUrl = CHtml::asset(dirname(__FILE__) . '/assets');
                /* @var CClientScript $cs */
                $cs = Yii::app()->getClientScript();
                $cs->registerCoreScript('jquery');
                $url = Yii::app()->createUrl($this->moduleId . '/default/toolbar', array('tag' => $this->getTag()));
                $cs->registerScript(__CLASS__ . '#toolbar', <<<JS
(function($){
        $('<div>').appendTo('body').load('$url', function(){
                if (window.localStorage && localStorage.getItem('yii2-debug-toolbar') == 'minimized') {
                        $('#yii2-debug-toolbar').hide();
                        $('#yii2-debug-toolbar-min').show();
                } else {
                        $('#yii2-debug-toolbar-min').hide();
                        $('#yii2-debug-toolbar').show();
                }
                $('#yii2-debug-toolbar .yii2-debug-toolbar-toggler').click(function(){
                        $('#yii2-debug-toolbar').hide();
                        $('#yii2-debug-toolbar-min').show();
                        if (window.localStorage) {
                                localStorage.setItem('yii2-debug-toolbar', 'minimized');
                        }
                });
                $('#yii2-debug-toolbar-min .yii2-debug-toolbar-toggler').click(function(){
                        $('#yii2-debug-toolbar-min').hide();
                        $('#yii2-debug-toolbar').show();
                        if (window.localStorage) {
                                localStorage.setItem('yii2-debug-toolbar', 'maximized');
                        }
                });
        });
})(jQuery);
JS
                );
        }

        protected function onEndRequest($event)
        {
                $this->processDebug();
        }

        protected function processDebug()
        {
                $path = $this->logPath;
                if (!is_dir($path)) mkdir($path);

                $indexFile = "$path/index.data";
                $manifest = array();
                if (is_file($indexFile)) {
                        $manifest = unserialize(file_get_contents($indexFile));
                }

                $data = array();
                foreach ($this->panels as $panel) {
                        $data[$panel->getId()] = $panel->save();
                        if (isset($panel->filterData)) {
                                $data[$panel->getId()] = $panel->evaluateExpression(
                                        $panel->filterData,
                                        array('data' => $data[$panel->getId()])
                                );
                        }
                        $panel->load($data[$panel->getId()]);
                }

                $statusCode = null;
                if (isset($this->panels['request']) && isset($this->panels['request']->data['statusCode'])) {
                        $statusCode = $this->panels['request']->data['statusCode'];
                }

                $request = Yii::app()->getRequest();
                $manifest[$this->getTag()] = $data['summary'] = array(
                        'tag' => $this->getTag(),
                        'url' => $request->getHostInfo() . $request->getUrl(),
                        'ajax' => $request->getIsAjaxRequest(),
                        'method' => $request->getRequestType(),
                        'code' => $statusCode,
                        'ip' => $request->getUserHostAddress(),
                        'time' => time(),
                );
                $this->resizeHistory($manifest);

                file_put_contents("$path/{$this->getTag()}.data", serialize($data));
                file_put_contents($indexFile, serialize($manifest));
        }

        protected function resizeHistory(&$manifest)
        {
                $tags = array_keys($manifest);
                $count = 0;
                foreach ($tags as $tag) {
                        if (!$this->getLock($tag)) $count++;
                }
                if ($count > $this->historySize + 10) {
                        $path = $this->logPath;
                        $n = $count - $this->historySize;
                        foreach ($tags as $tag) {
                                if (!$this->getLock($tag)) {
                                        @unlink("$path/$tag.data");
                                        unset($manifest[$tag]);
                                        if (--$n <= 0) break;
                                }
                        }
                }
        }

        public function checkAccess()
        {
                if (
                        $this->accessExpression !== null &&
                        !$this->evaluateExpression($this->accessExpression)
                ) {
                        return false;
                }
                $ip = Yii::app()->getRequest()->getUserHostAddress();
                foreach ($this->allowedIPs as $filter) {
                        if (
                                $filter === '*' || $filter === $ip || (
                                        ($pos = strpos($filter, '*')) !== false &&
                                        !strncmp($ip, $filter, $pos)
                                )
                        ) {
                                return true;
                        }
                }
                return false;
        }

        public static function dump($data)
        {
                Yii::log(serialize($data), CLogger::LEVEL_INFO, Yii2LogPanel::CATEGORY_DUMP);
        }

        private $_locks;

        public function getLock($tag)
        {
                if ($this->_locks === null) {
                        $locksFile = $this->logPath . '/locks.data';
                        if (is_file($locksFile)) {
                                $this->_locks = array_flip(unserialize(file_get_contents($locksFile)));
                        } else {
                                $this->_locks = array();
                        }
                }
                return isset($this->_locks[$tag]);
        }

        public function setLock($tag, $value)
        {
                $value = !!$value;
                if ($this->getLock($tag) !== $value) {
                        if ($value) {
                                $this->_locks[$tag] = true;
                        } else {
                                unset($this->_locks[$tag]);
                        }
                        $locksFile = $this->logPath . '/locks.data';
                        file_put_contents($locksFile, serialize(array_keys($this->_locks)));
                }
        }

        public static function prepareData($data)
        {
                static $parents = array();

                $result = array();
                if (is_array($data) || $data instanceof CMap) {
                        foreach ($data as $key => $value) {
                                $result[$key] = self::prepareData($value);
                        }
                } elseif (is_object($data)) {
                        if (!in_array($data, $parents, true)) {
                                array_push($parents, $data);
                                $result['class'] = get_class($data);
                                if ($data instanceof CActiveRecord) {
                                        foreach ($data->attributes as $field => $value) {
                                                $result[$field] = $value;
                                        }
                                }
                                foreach (get_object_vars($data) as $key => $value) {
                                        $result[$key] = self::prepareData($value);
                                }
                                array_pop($parents);
                        } else {
                                $result = get_class($data) . '()';
                        }
                } else {
                        $result = $data;
                }
                return $result;
        }
}