From be9645dd7f1852401f22580932327a0f425db42d Mon Sep 17 00:00:00 2001 From: Mark Date: Sun, 9 Feb 2014 21:34:05 +0400 Subject: [PATCH 1/4] mail panel added --- extensions/debug/Module.php | 1 + extensions/debug/assets/main.css | 11 ++ extensions/debug/controllers/DefaultController.php | 10 ++ extensions/debug/models/search/Mail.php | 121 +++++++++++++++++++++ extensions/debug/panels/MailPanel.php | 91 ++++++++++++++++ .../debug/views/default/panels/mail/_item.php | 38 +++++++ .../debug/views/default/panels/mail/detail.php | 55 ++++++++++ .../debug/views/default/panels/mail/summary.php | 9 ++ 8 files changed, 336 insertions(+) create mode 100644 extensions/debug/models/search/Mail.php create mode 100644 extensions/debug/panels/MailPanel.php create mode 100644 extensions/debug/views/default/panels/mail/_item.php create mode 100644 extensions/debug/views/default/panels/mail/detail.php create mode 100644 extensions/debug/views/default/panels/mail/summary.php diff --git a/extensions/debug/Module.php b/extensions/debug/Module.php index ae166bd..c475387 100644 --- a/extensions/debug/Module.php +++ b/extensions/debug/Module.php @@ -161,6 +161,7 @@ class Module extends \yii\base\Module 'log' => ['class' => 'yii\debug\panels\LogPanel'], 'profiling' => ['class' => 'yii\debug\panels\ProfilingPanel'], 'db' => ['class' => 'yii\debug\panels\DbPanel'], + 'mail' => ['class' => 'yii\debug\panels\MailPanel'], ]; } } diff --git a/extensions/debug/assets/main.css b/extensions/debug/assets/main.css index 54babe7..c881ca8 100644 --- a/extensions/debug/assets/main.css +++ b/extensions/debug/assets/main.css @@ -73,3 +73,14 @@ a.desc:after { .sort-ordinal a.desc:after { content: "\e156"; } + +.mail-sorter { + margin-top: 7px; +} + +.mail-sorter li { + list-style: none; + float: left; + width: 12%; + font-weight: bold; +} diff --git a/extensions/debug/controllers/DefaultController.php b/extensions/debug/controllers/DefaultController.php index c2ef235..b280748 100644 --- a/extensions/debug/controllers/DefaultController.php +++ b/extensions/debug/controllers/DefaultController.php @@ -93,6 +93,16 @@ class DefaultController extends Controller ]); } + public function actionDownloadMail($file) + { + $filePath = Yii::getAlias($this->module->panels['mail']->mailPath) . '/' . $file; + + if (!is_file($filePath)) { + throw new NotFoundHttpException('Mail file not found'); + } + + Yii::$app->response->sendFile($filePath); + } private $_manifest; diff --git a/extensions/debug/models/search/Mail.php b/extensions/debug/models/search/Mail.php new file mode 100644 index 0000000..59d310c --- /dev/null +++ b/extensions/debug/models/search/Mail.php @@ -0,0 +1,121 @@ + 'From', + 'to' => 'To', + 'reply' => 'Reply', + 'cc' => 'Copy receiver', + 'bcc' => 'Hidden copy receiver', + 'subject' => 'Subject', + 'charset' => 'Charset' + ]; + } + + /** + * Returns data provider with filled models. Filter applied if needed. + * @param array $params + * @param array $models + * @return \yii\data\ArrayDataProvider + */ + public function search($params, $models) + { + $dataProvider = new ArrayDataProvider([ + 'allModels' => $models, + 'pagination' => [ + 'pageSize' => 5, + ], + 'sort' => [ + 'attributes' => ['from', 'to', 'reply', 'cc', 'bcc', 'subject', 'body', 'charset'], + ], + ]); + + if (!($this->load($params) && $this->validate())) { + return $dataProvider; + } + + $filter = new Filter(); + $this->addCondition($filter, 'from', true); + $this->addCondition($filter, 'to', true); + $this->addCondition($filter, 'reply', true); + $this->addCondition($filter, 'cc', true); + $this->addCondition($filter, 'bcc', true); + $this->addCondition($filter, 'subject', true); + $this->addCondition($filter, 'body', true); + $this->addCondition($filter, 'charset', true); + $dataProvider->allModels = $filter->filter($models); + + return $dataProvider; + } +} diff --git a/extensions/debug/panels/MailPanel.php b/extensions/debug/panels/MailPanel.php new file mode 100644 index 0000000..85ed504 --- /dev/null +++ b/extensions/debug/panels/MailPanel.php @@ -0,0 +1,91 @@ +message->getSwiftMessage(); + $textBody = $message->getBody(); + $fileName = $event->sender->generateMessageFileName(); + + FileHelper::createDirectory(Yii::getAlias($this->mailPath)); + file_put_contents(Yii::getAlias($this->mailPath) . '/' . $fileName, $message->toString()); + + $this->_messages[] = [ + 'isSuccessful' => $event->isSuccessful, + 'time' => $message->getDate(), + 'headers' => $message->getHeaders(), + 'from' => $this->convertParams($message->getFrom()), + 'to' => $this->convertParams($message->getTo()), + 'reply' => $this->convertParams($message->getReplyTo()), + 'cc' => $this->convertParams($message->getCc()), + 'bcc' => $this->convertParams($message->getBcc()), + 'subject' => $message->getSubject(), + 'body' => $textBody, + 'charset' => $message->getCharset(), + 'file' => $fileName, + ]; + }); + } + + public function getName() + { + return 'Mail'; + } + + public function getSummary() + { + return Yii::$app->view->render('panels/mail/summary', ['panel' => $this, 'mailCount' => count($this->data)]); + } + + public function getDetail() + { + $searchModel = new Mail(); + $dataProvider = $searchModel->search(Yii::$app->request->get(), $this->data); + + return Yii::$app->view->render('panels/mail/detail', [ + 'panel' => $this, + 'dataProvider' => $dataProvider, + 'searchModel' => $searchModel + ]); + } + + public function save() + { + return $this->_messages; + } + + private function convertParams($attr) + { + if (is_array($attr)) { + $attr = implode(', ', array_keys($attr)); + } + return $attr; + } + +} diff --git a/extensions/debug/views/default/panels/mail/_item.php b/extensions/debug/views/default/panels/mail/_item.php new file mode 100644 index 0000000..fd485c9 --- /dev/null +++ b/extensions/debug/views/default/panels/mail/_item.php @@ -0,0 +1,38 @@ + 'yii\i18n\Formatter']) : Yii::$app->formatter; + +echo DetailView::widget([ + 'model' => $model, + 'attributes' => [ + 'headers', + 'from', + 'to', + 'charset', + [ + 'name' => 'time', + 'value' => $timeFormatter->asDateTime($model['time'], 'short'), + ], + 'subject', + [ + 'name' => 'body', + 'label' => 'Text body', + ], + [ + 'name' => 'isSuccessful', + 'label' => 'Successfully sent', + 'value' => $model['isSuccessful'] ? 'Yes' : 'No' + ], + 'reply', + 'bcc', + 'cc', + [ + 'name' => 'file', + 'format' => 'html', + 'value' => Html::a('Download eml', ['download-mail', 'file' => $model['file']]), + ], + ], +]); diff --git a/extensions/debug/views/default/panels/mail/detail.php b/extensions/debug/views/default/panels/mail/detail.php new file mode 100644 index 0000000..59d0d13 --- /dev/null +++ b/extensions/debug/views/default/panels/mail/detail.php @@ -0,0 +1,55 @@ + $dataProvider, + 'itemView' => 'panels/mail/_item', + 'layout' => "{summary}\n{items}\n{pager}\n", + ]); +$listView->sorter = ['options' => ['class'=>'mail-sorter']]; +?> + +

Email messages

+ +
+
+ 'btn btn-default', 'onclick'=>'$("#email-form").toggle();']) ?> +
+
+ renderSorter() ?> +
+
+ + + +run() ?> diff --git a/extensions/debug/views/default/panels/mail/summary.php b/extensions/debug/views/default/panels/mail/summary.php new file mode 100644 index 0000000..4e35ff8 --- /dev/null +++ b/extensions/debug/views/default/panels/mail/summary.php @@ -0,0 +1,9 @@ + +
+ Mail +
+ From e406f03eac849380db1c9ebadca2bf2550427723 Mon Sep 17 00:00:00 2001 From: Mark Date: Sun, 9 Feb 2014 21:35:34 +0400 Subject: [PATCH 2/4] changelog note --- extensions/debug/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/extensions/debug/CHANGELOG.md b/extensions/debug/CHANGELOG.md index 6f869b2..038586a 100644 --- a/extensions/debug/CHANGELOG.md +++ b/extensions/debug/CHANGELOG.md @@ -8,6 +8,7 @@ Yii Framework 2 debug extension Change Log - Bug #1504: Debug toolbar isn't loaded successfully in some environments when xdebug is enabled (qiangxue) - Bug #1747: Fixed problems with displaying toolbar on small screens (cebe) - Bug #1827: Debugger toolbar is loaded twice if an action is calling `run()` to execute another action (qiangxue) +- Enh #1667: Added mail panel (Ragazzo, 6pblcb) - Enh #2006: Added total queries count monitoring (o-rey, Ragazzo) 2.0.0 alpha, December 1, 2013 From b96fec7bb91a6990a3774a4d16b58691f9c43d52 Mon Sep 17 00:00:00 2001 From: Mark Date: Mon, 10 Feb 2014 23:49:36 +0400 Subject: [PATCH 3/4] fixed path traversal --- extensions/debug/controllers/DefaultController.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/debug/controllers/DefaultController.php b/extensions/debug/controllers/DefaultController.php index b280748..d531ed1 100644 --- a/extensions/debug/controllers/DefaultController.php +++ b/extensions/debug/controllers/DefaultController.php @@ -95,7 +95,7 @@ class DefaultController extends Controller public function actionDownloadMail($file) { - $filePath = Yii::getAlias($this->module->panels['mail']->mailPath) . '/' . $file; + $filePath = Yii::getAlias($this->module->panels['mail']->mailPath) . '/' . basename($file); if (!is_file($filePath)) { throw new NotFoundHttpException('Mail file not found'); From 157af3a37e78d878feee524871552a4182fb182d Mon Sep 17 00:00:00 2001 From: Mark Date: Tue, 11 Feb 2014 00:17:09 +0400 Subject: [PATCH 4/4] added check for file name --- extensions/debug/controllers/DefaultController.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/debug/controllers/DefaultController.php b/extensions/debug/controllers/DefaultController.php index d531ed1..9f64d40 100644 --- a/extensions/debug/controllers/DefaultController.php +++ b/extensions/debug/controllers/DefaultController.php @@ -97,7 +97,7 @@ class DefaultController extends Controller { $filePath = Yii::getAlias($this->module->panels['mail']->mailPath) . '/' . basename($file); - if (!is_file($filePath)) { + if ((mb_strpos($file, '\\') !== false || mb_strpos($file, '/') !== false) || !is_file($filePath)) { throw new NotFoundHttpException('Mail file not found'); }