* @since 2.0 */ class Module extends \yii\base\Module { /** * @var array the list of IPs that are allowed to access this module. * Each array element represents a single IP filter which can be either an IP address * or an address with wildcard (e.g. 192.168.0.*) to represent a network segment. * The default value is `['127.0.0.1', '::1']`, which means the module can only be accessed * by localhost. */ public $allowedIPs = ['127.0.0.1', '::1']; /** * @var string the namespace that controller classes are in. */ public $controllerNamespace = 'yii\debug\controllers'; /** * @var LogTarget */ public $logTarget; /** * @var array|Panel[] */ public $panels = []; /** * @var string the directory storing the debugger data files. This can be specified using a path alias. */ public $dataPath = '@runtime/debug'; /** * @var integer the maximum number of debug data files to keep. If there are more files generated, * the oldest ones will be removed. */ public $historySize = 50; public function init() { parent::init(); $this->dataPath = Yii::getAlias($this->dataPath); $this->logTarget = Yii::$app->getLog()->targets['debug'] = new LogTarget($this); // do not initialize view component before application is ready (needed when debug in preload) Yii::$app->on(Application::EVENT_BEFORE_REQUEST, function() { Yii::$app->getView()->on(View::EVENT_END_BODY, [$this, 'renderToolbar']); }); $this->panels = array_merge($this->corePanels(), $this->panels); foreach ($this->panels as $id => $config) { $config['module'] = $this; $config['id'] = $id; $this->panels[$id] = Yii::createObject($config); } } public function beforeAction($action) { Yii::$app->getView()->off(View::EVENT_END_BODY, [$this, 'renderToolbar']); unset(Yii::$app->getLog()->targets['debug']); $this->logTarget = null; if ($this->checkAccess($action)) { return parent::beforeAction($action); } elseif ($action->id === 'toolbar') { return false; } else { throw new AccessDeniedHttpException('You are not allowed to access this page.'); } } public function renderToolbar($event) { if (!$this->checkAccess() || Yii::$app->getRequest()->getIsAjax()) { return; } $url = Yii::$app->getUrlManager()->createUrl($this->id . '/default/toolbar', [ 'tag' => $this->logTarget->tag, ]); echo ''; /** @var View $view */ $view = $event->sender; echo ''; echo ''; } protected function checkAccess() { $ip = Yii::$app->getRequest()->getUserIP(); foreach ($this->allowedIPs as $filter) { if ($filter === '*' || $filter === $ip || (($pos = strpos($filter, '*')) !== false && !strncmp($ip, $filter, $pos))) { return true; } } Yii::warning('Access to debugger is denied due to IP address restriction. The requested IP is ' . $ip, __METHOD__); return false; } protected function corePanels() { return [ 'config' => ['class' => 'yii\debug\panels\ConfigPanel'], 'request' => ['class' => 'yii\debug\panels\RequestPanel'], 'log' => ['class' => 'yii\debug\panels\LogPanel'], 'profiling' => ['class' => 'yii\debug\panels\ProfilingPanel'], 'db' => ['class' => 'yii\debug\panels\DbPanel'], ]; } }