Module.php 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. <?php
  2. /**
  3. * @link http://www.yiiframework.com/
  4. * @copyright Copyright (c) 2008 Yii Software LLC
  5. * @license http://www.yiiframework.com/license/
  6. */
  7. namespace yii\debug;
  8. use Yii;
  9. use yii\base\Application;
  10. use yii\base\BootstrapInterface;
  11. use yii\helpers\Json;
  12. use yii\web\Response;
  13. use yii\helpers\Html;
  14. use yii\helpers\Url;
  15. use yii\web\View;
  16. use yii\web\ForbiddenHttpException;
  17. /**
  18. * The Yii Debug Module provides the debug toolbar and debugger
  19. *
  20. * @author Qiang Xue <qiang.xue@gmail.com>
  21. * @since 2.0
  22. */
  23. class Module extends \yii\base\Module implements BootstrapInterface
  24. {
  25. const DEFAULT_IDE_TRACELINE = '<a href="ide://open?url=file://{file}&line={line}">{text}</a>';
  26. /**
  27. * @var array the list of IPs that are allowed to access this module.
  28. * Each array element represents a single IP filter which can be either an IP address
  29. * or an address with wildcard (e.g. 192.168.0.*) to represent a network segment.
  30. * The default value is `['127.0.0.1', '::1']`, which means the module can only be accessed
  31. * by localhost.
  32. */
  33. public $allowedIPs = ['127.0.0.1', '::1'];
  34. /**
  35. * @var array the list of hosts that are allowed to access this module.
  36. * Each array element is a hostname that will be resolved to an IP address that is compared
  37. * with the IP address of the user. A use case is to use a dynamic DNS (DDNS) to allow access.
  38. * The default value is `[]`.
  39. */
  40. public $allowedHosts = [];
  41. /**
  42. * @inheritdoc
  43. */
  44. public $controllerNamespace = 'yii\debug\controllers';
  45. /**
  46. * @var LogTarget
  47. */
  48. public $logTarget;
  49. /**
  50. * @var array|Panel[] list of debug panels. The array keys are the panel IDs, and values are the corresponding
  51. * panel class names or configuration arrays. This will be merged with [[corePanels()]].
  52. * You may reconfigure a core panel via this property by using the same panel ID.
  53. * You may also disable a core panel by setting it to be false in this property.
  54. */
  55. public $panels = [];
  56. /**
  57. * @var string the name of the panel that should be visible when opening the debug panel.
  58. * The default value is 'log'.
  59. * @since 2.0.7
  60. */
  61. public $defaultPanel = 'log';
  62. /**
  63. * @var string the directory storing the debugger data files. This can be specified using a path alias.
  64. */
  65. public $dataPath = '@runtime/debug';
  66. /**
  67. * @var integer the permission to be set for newly created debugger data files.
  68. * This value will be used by PHP [[chmod()]] function. No umask will be applied.
  69. * If not set, the permission will be determined by the current environment.
  70. * @since 2.0.6
  71. */
  72. public $fileMode;
  73. /**
  74. * @var integer the permission to be set for newly created directories.
  75. * This value will be used by PHP [[chmod()]] function. No umask will be applied.
  76. * Defaults to 0775, meaning the directory is read-writable by owner and group,
  77. * but read-only for other users.
  78. * @since 2.0.6
  79. */
  80. public $dirMode = 0775;
  81. /**
  82. * @var integer the maximum number of debug data files to keep. If there are more files generated,
  83. * the oldest ones will be removed.
  84. */
  85. public $historySize = 50;
  86. /**
  87. * @var boolean whether to enable message logging for the requests about debug module actions.
  88. * You normally do not want to keep these logs because they may distract you from the logs about your applications.
  89. * You may want to enable the debug logs if you want to investigate how the debug module itself works.
  90. */
  91. public $enableDebugLogs = false;
  92. /**
  93. * @var mixed the string with placeholders to be be substituted or an anonymous function that returns the trace line string.
  94. * The placeholders are {file}, {line} and {text} and the string should be as follows:
  95. *
  96. * `File: {file} - Line: {line} - Text: {text}`
  97. *
  98. * The signature of the anonymous function should be as follows:
  99. *
  100. * ```php
  101. * function($trace, $panel) {
  102. * // compute line string
  103. * return $line;
  104. * }
  105. * ```
  106. * @since 2.0.7
  107. */
  108. public $traceLine = self::DEFAULT_IDE_TRACELINE;
  109. /**
  110. * @var string Yii logo URL
  111. */
  112. private static $_yiiLogo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAMAAAANIilAAAAC7lBMVEUAAACl034Cb7HlcjGRyT/H34fyy5PxqlSfzjwQeb5PmtX71HAMdrWOxkDzmU3qcDSPx0HzhUGNxT+/2lX2olDmUy/Q1l+TyD7rgjq21k3ZRzDQ4GGFw0Ghzz6MwOkKdrTA2lTzzMVjo9mhzkCIxUPk1MLynU7qWS33vmbP1rm011Fwqsj123/r44tUltTyq1aCxEOo0EL1tFuCw0Npp9v7xGVHkM8Ddrza0pvC3FboczHmXSvE21h+wkRkpNHvjkS92FPW3avpeDT2t1zX5GefzUD6wGQReLtMltPN417oczPZ0L+62FF+tuJgqtXZUzNzrN3s4Y7n65y72FLwmk7xjESr0kYof8MQe8DY5Gc6jMnN32DoaDLbTiLulUo1hsni45vuwnIigMXC21dqq8vKzaaBt+XU4mUMd7wDdr7xlUrU4a7A2VTD0LbVx5vvpFP/0m9godp/tuTD0LVyrsfZVDUuhMjkPChsrMt3suK92VDd52oEc7un0EKjzj7D21e01EuSyD2fzDvH3Fqu0kcDdL641k+x00rmXy0EdLiayzzynU2XyTzxmUur0ETshD7lZDDvkUbtiUDrgTvqfjrkWS292FPujEKAuObQ4GH3vWH1slr0r1j0pVLulEiPxj7oeDRnptn4zWrM31/1t13A2lb1rFb1qVS72FKHw0CLxD/qdTfnazL4wGPJ3VzwpFLpcjKFveljo9dfn9ZbntUYfcEIdr35w2XyoFH0ok/pfDZ9tONUmNRPltJIj89Ais388IL85Hn82nL80W33uV72tFy611DxlUnujkSCwkGlz0DqeTnocDJ3r99yrN1Xm9RFjc42hsorgsYhgMQPer/81XD5yGbT4mTriD/lbS3laCvjTiluqN5NktAxhMf853v84He/2VTgVCnmVSg8h8sHcrf6633+3nb8zGr2xmR/wEGcyzt3r+T/6n7tm01tqNnfSCnfPyO4zLmFwkDVRDGOweLP1aX55nrZTTOaxdjuY9uiAAAAfHRSTlMABv7+9hAJ/vMyGP2CbV5DOA+NbyYeG/DV0sC/ubaonYN5blZRQT41MSUk/v797+zj49PR0MXEw8PDu6imppqYlpOGhYN+bldWVFJROjAM+fPy8fDw8O7t6+vp5+Lh4N7e3Nvb2NPQ0MW8urm2rqiimJKFg3t5amZTT0k1ewExHwAABPVJREFUSMed1Xc81HEYB/DvhaOUEe29995777333ntv2sopUTQ4F104hRBSl8ohldCwOqfuuEiKaPdfz/P7/u6Syuu+ff727vM8z+8bhDHNB3TrXI38V6p1fvSosLBwgICd1qx/5cqVT8jrl9c1Wlm2qmFdgbWq5X316lXKq5dxu+ouyNWePevo6JjVd6il9T/soUPe3t48tyI0LeqWlpbk5oJ1dXVVKpNCH/e1/NO2rXXy5CEI5Y+6EZomn0tLSlS50OuaFZQUGuojl7vXtii/VQMnp5MQPW/+C6tUXDFnfeTubm4utVv+fud3EPTIUdfXYZVKpQULxTp75sz5h4PK7C4wO8zFCT1XbkxHG/cdZuaLqXV5Afb0xYW2etxsPxfg73htbEUPBhgXDgoKCg30kbu58Pai8/SW+o3t7e0TExPBYzuObkyXFk7SAnYFnBQYyPeePn3R2fnEiZsWPO5y6pQ9JpHXgPlHWlcLxWiTAh/LqX3wAOlNiYTXRzGn8F9I5LUx/052aLWOWVnwgQMfu7u7UQu9t26FhISYcpObHMdwHstxcR2uAc1ZSlgYsJsL7kutRCKT+XeyxWMfxHAeykE7OQGm6ecIOInaF3grmPkEWn8vL3FXIfxEnWMY8FTD5GYjeNwK3pbSCDEsTC30ysCK79/3HQY/MTggICABOZRTbYYHo9WuSiMjvhi/EWf90frGe3q2JmR8Ts65cwEJCVAOGgc3a6bD1vOVRj5wLVwY7U2dvR/vGRy1BB7TsgMH/HKAQzfVZlZEF0sjwHgtLC7GbySjvWCjojYS0vjIEcpBH8WTmwmIPmON4GEChksXF8MnotYX7NuMDGkb0vbaEeQ50E11A1R67SOnUzsjlsjgzvHx8cFRQKUFvQmpd/kaaD+sPoiYrqyfvDY39QPYOMTU1F8shn09g98WSOPi4szbEBuPy8BRY7V9l3L/34VDy2AvsdgXLfTGmZun9yY1PTw8Ll+DwenWI0j52A6awWGJzNQLj0VtenpsbHshWZXpQasTYO6ZJuTPCC3WQjFeix5LKpWap8dqNJohZHgmaA5DtQ35e6wtNnXS4wwojn2jUSimkH2ZtBpxnYp+67ce1pX7xBkF1KrV+S3IHIrxYuNJxbEd2SM4qoDDim/5+THrSD09bmzIn5eRPTiMNmYqLM2PDUMblNabzaE5PwbSZowHPdi0tsTQmKxor1EXFcXEDKnJf6q9xOBMCPvyVQG6aDGZhw80x8ZwK1h5ISzsRwe1Wt2B1MPHPZgYnqa3b1+4gOUKhUl/sP0Z7ITJycmowz5q3oxrfMBvvYBh6O7ZKcnvqY7dZuPXR8hQvOXSJdQc/7hhTB8TBjs6Ivz6pezsbKobmggYbJWOT1ADT8HFGxKW9LwTjRp4CujbTHj007t37kRHhGP5h5Tk5K0MduLce0/vvoyOjoiIuH4ddMoeBrzz2WvUMDrMDvpDFQa89Pkr4KCBo+7OYEdFpqLGcqqbMuDVaZGpqc/1OjycYerKohtpkZFl9ECG4qoihxvA9aN3ZDlXL5GDXR7Vr56BZtlYcAOwnQMdHXRPlmdd2U5kh5gffRHL0GSUXR5gKBeJ0tIiZ1UmLKlqlydygHD1s8EyYYe8PBFMjulVhbClEdy6kohLVTaJGEYW4eBr6MhsY1fi0ggoe7a3a7d84O6J5L8iNOiX3U+uoa/p8UPtoQAAAABJRU5ErkJggg==';
  113. /**
  114. * Returns the logo URL to be used in `<img src="`
  115. *
  116. * @return string the logo URL
  117. */
  118. public static function getYiiLogo()
  119. {
  120. return self::$_yiiLogo;
  121. }
  122. /**
  123. * Sets the logo URL to be used in `<img src="`
  124. *
  125. * @param string $logo the logo URL
  126. */
  127. public static function setYiiLogo($logo)
  128. {
  129. self::$_yiiLogo = $logo;
  130. }
  131. /**
  132. * @inheritdoc
  133. */
  134. public function init()
  135. {
  136. parent::init();
  137. $this->dataPath = Yii::getAlias($this->dataPath);
  138. $this->initPanels();
  139. }
  140. /**
  141. * Initializes panels.
  142. */
  143. protected function initPanels()
  144. {
  145. // merge custom panels and core panels so that they are ordered mainly by custom panels
  146. if (empty($this->panels)) {
  147. $this->panels = $this->corePanels();
  148. } else {
  149. $corePanels = $this->corePanels();
  150. foreach ($corePanels as $id => $config) {
  151. if (isset($this->panels[$id])) {
  152. unset($corePanels[$id]);
  153. }
  154. }
  155. $this->panels = array_filter(array_merge($corePanels, $this->panels));
  156. }
  157. foreach ($this->panels as $id => $config) {
  158. if (is_string($config)) {
  159. $config = ['class' => $config];
  160. }
  161. $config['module'] = $this;
  162. $config['id'] = $id;
  163. $this->panels[$id] = Yii::createObject($config);
  164. }
  165. }
  166. /**
  167. * @inheritdoc
  168. */
  169. public function bootstrap($app)
  170. {
  171. $this->logTarget = Yii::$app->getLog()->targets['debug'] = new LogTarget($this);
  172. // delay attaching event handler to the view component after it is fully configured
  173. $app->on(Application::EVENT_BEFORE_REQUEST, function () use ($app) {
  174. $app->getView()->on(View::EVENT_END_BODY, [$this, 'renderToolbar']);
  175. $app->getResponse()->on(Response::EVENT_AFTER_PREPARE, [$this, 'setDebugHeaders']);
  176. });
  177. $app->getUrlManager()->addRules([
  178. [
  179. 'class' => 'yii\web\UrlRule',
  180. 'route' => $this->id,
  181. 'pattern' => $this->id,
  182. ],
  183. [
  184. 'class' => 'yii\web\UrlRule',
  185. 'route' => $this->id . '/<controller>/<action>',
  186. 'pattern' => $this->id . '/<controller:[\w\-]+>/<action:[\w\-]+>',
  187. ]
  188. ], false);
  189. }
  190. /**
  191. * @inheritdoc
  192. */
  193. public function beforeAction($action)
  194. {
  195. if (!$this->enableDebugLogs) {
  196. foreach (Yii::$app->getLog()->targets as $target) {
  197. $target->enabled = false;
  198. }
  199. }
  200. if (!parent::beforeAction($action)) {
  201. return false;
  202. }
  203. // do not display debug toolbar when in debug view mode
  204. Yii::$app->getView()->off(View::EVENT_END_BODY, [$this, 'renderToolbar']);
  205. Yii::$app->getResponse()->off(Response::EVENT_AFTER_PREPARE, [$this, 'setDebugHeaders']);
  206. if ($this->checkAccess()) {
  207. $this->resetGlobalSettings();
  208. return true;
  209. } elseif ($action->id === 'toolbar') {
  210. // Accessing toolbar remotely is normal. Do not throw exception.
  211. return false;
  212. } else {
  213. throw new ForbiddenHttpException('You are not allowed to access this page.');
  214. }
  215. }
  216. /**
  217. * Setting headers to transfer debug data in AJAX requests
  218. * without interfering with the request itself.
  219. *
  220. * @param \yii\base\Event $event
  221. * @since 2.0.7
  222. */
  223. public function setDebugHeaders($event)
  224. {
  225. if (!$this->checkAccess() || !Yii::$app->getRequest()->getIsAjax()) {
  226. return;
  227. }
  228. $url = Url::toRoute(['/' . $this->id . '/default/view',
  229. 'tag' => $this->logTarget->tag,
  230. ]);
  231. $event->sender->getHeaders()
  232. ->set('X-Debug-Tag', $this->logTarget->tag)
  233. ->set('X-Debug-Duration', number_format((microtime(true) - YII_BEGIN_TIME) * 1000 + 1))
  234. ->set('X-Debug-Link', $url);
  235. }
  236. /**
  237. * Resets potentially incompatible global settings done in app config.
  238. */
  239. protected function resetGlobalSettings()
  240. {
  241. Yii::$app->assetManager->bundles = [];
  242. }
  243. /**
  244. * Gets toolbar HTML
  245. * @since 2.0.7
  246. */
  247. public function getToolbarHtml()
  248. {
  249. $url = Url::toRoute(['/' . $this->id . '/default/toolbar',
  250. 'tag' => $this->logTarget->tag,
  251. ]);
  252. return '<div id="yii-debug-toolbar" data-url="' . Html::encode($url) . '" style="display:none" class="yii-debug-toolbar-bottom"></div>';
  253. }
  254. /**
  255. * Renders mini-toolbar at the end of page body.
  256. *
  257. * @param \yii\base\Event $event
  258. */
  259. public function renderToolbar($event)
  260. {
  261. if (!$this->checkAccess() || Yii::$app->getRequest()->getIsAjax()) {
  262. return;
  263. }
  264. /* @var $view View */
  265. $view = $event->sender;
  266. echo $view->renderDynamic('return Yii::$app->getModule("debug")->getToolbarHtml();');
  267. // echo is used in order to support cases where asset manager is not available
  268. echo '<style>' . $view->renderPhpFile(__DIR__ . '/assets/toolbar.css') . '</style>';
  269. echo '<script>' . $view->renderPhpFile(__DIR__ . '/assets/toolbar.js') . '</script>';
  270. }
  271. /**
  272. * Checks if current user is allowed to access the module
  273. * @return bool if access is granted
  274. */
  275. protected function checkAccess()
  276. {
  277. $ip = Yii::$app->getRequest()->getUserIP();
  278. foreach ($this->allowedIPs as $filter) {
  279. if ($filter === '*' || $filter === $ip || (($pos = strpos($filter, '*')) !== false && !strncmp($ip, $filter, $pos))) {
  280. return true;
  281. }
  282. }
  283. foreach ($this->allowedHosts as $hostname) {
  284. $filter = gethostbyname($hostname);
  285. if ($filter === $ip) {
  286. return true;
  287. }
  288. }
  289. Yii::warning('Access to debugger is denied due to IP address restriction. The requesting IP address is ' . $ip, __METHOD__);
  290. return false;
  291. }
  292. /**
  293. * @return array default set of panels
  294. */
  295. protected function corePanels()
  296. {
  297. return [
  298. 'config' => ['class' => 'yii\debug\panels\ConfigPanel'],
  299. 'request' => ['class' => 'yii\debug\panels\RequestPanel'],
  300. 'log' => ['class' => 'yii\debug\panels\LogPanel'],
  301. 'profiling' => ['class' => 'yii\debug\panels\ProfilingPanel'],
  302. 'db' => ['class' => 'yii\debug\panels\DbPanel'],
  303. 'assets' => ['class' => 'yii\debug\panels\AssetPanel'],
  304. 'mail' => ['class' => 'yii\debug\panels\MailPanel'],
  305. 'timeline' => ['class' => 'yii\debug\panels\TimelinePanel']
  306. ];
  307. }
  308. /**
  309. * @inheritdoc
  310. * @since 2.0.7
  311. */
  312. protected function defaultVersion()
  313. {
  314. $packageInfo = Json::decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . 'composer.json'));
  315. $extensionName = $packageInfo['name'];
  316. if (isset(Yii::$app->extensions[$extensionName])) {
  317. return Yii::$app->extensions[$extensionName]['version'];
  318. }
  319. return parent::defaultVersion();
  320. }
  321. }