gplcart\modules\error_notifier\ErrorNotifier

Complexity

Total Complexity

27

Size/Duplication

Total Lines	197
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	hookRouteList()	0	9	1
A	hookCron()	0	4	1
A	hookTemplate()	0	7	2
A	setEmailReport()	0	10	4
A	sendEmail()	0	11	1
A	getEmailErrorMessages()	0	12	2
A	setLiveReport()	0	15	3
B	prepareMessages()	0	23	6
A	getLiveErrorMessages()	0	18	4
A	getFormattedErrorMessages()	0	13	2

<?php

/**
 * @package Error Notifier
 * @author Iurii Makukh <gplcart.software@gmail.com>
 * @copyright Copyright (c) 2017, Iurii Makukh <gplcart.software@gmail.com>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\error_notifier;

use gplcart\core\Module;

/**
 * Main class for Error Notifier module
 */
class ErrorNotifier extends Module
{

    /**
     * Constructor
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Implements hook "route.list"
     * @param array $routes
     */
    public function hookRouteList(array &$routes)
    {
        $routes['admin/module/settings/error_notifier'] = array(
            'access' => 'module_edit',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\error_notifier\\controllers\\Settings', 'editSettings')
            )
        );
    }

    /**
     * Implements hook "cron"
     * @param \gplcart\core\Controller $controller
     */
    public function hookCron($controller)
    {
        $this->setEmailReport($controller);
    }

    /**
     * Implements hook "template.output"
     * @param string $template
     * @param array $data
     * @param \gplcart\core\Controller $controller
     */
    public function hookTemplate($template, array &$data, $controller)
    {
        $limit = 'layout/body';
        if (substr($template, -strlen($limit)) === $limit) {
            $this->setLiveReport($data, $controller);
        }
    }

    /**
     * Sends last PHP errors via Email
     * @param \gplcart\core\Controller $controller
     */
    protected function setEmailReport($controller)
    {
        $settings = $this->config->module('error_notifier');
        if (!empty($settings['email']) && !empty($settings['recipient'])) {
            $messages = $this->getEmailErrorMessages($settings, $controller);
            if (!empty($messages)) {
                $this->sendEmail($settings, $messages, $controller);
            }
        }
    }

    /**
     * Sends an E-mail
     * @param array $settings
     * @param array $messages
     * @param \gplcart\core\Controller $controller
     */
    protected function sendEmail(array $settings, array $messages, $controller)
    {
        /* @var $mailer \gplcart\core\models\Mail */
        $mailer = $this->getInstance('gplcart\\core\\models\Mail');

        $subject = 'Last PHP errors';
        $body = implode("\r\n", $messages);
        $from = $controller->getStore('data.email.0');

        $mailer->send($settings['recipient'], $subject, $body, $from);
    }

    /**
     * Returns an array of PHP errors to send via Email
     * @param array $settings
     * @param \gplcart\core\Controller $controller
     * @return array
     */
    protected function getEmailErrorMessages(array $settings, $controller)
    {
        if (empty($settings['email_limit'])) {
            $settings['email_limit'] = null; // Unlimited
        }

        /* @var $logger \gplcart\core\Logger */
        $logger = $this->getInstance('gplcart\\core\\Logger');
        $errors = $logger->selectPhpErrors($settings['email_limit']);

        return $this->getFormattedErrorMessages($errors, $controller);
    }

    /**
     * Sets live error reporting
     * @param array $data
     * @param \gplcart\core\Controller $controller
     */
    protected function setLiveReport(array &$data, $controller)
    {
        $settings = $this->config->module('error_notifier');
        $messages = $this->getLiveErrorMessages($settings, $controller);

        if (empty($messages)) {
            return null;
        }

        $this->prepareMessages($messages, $settings, $controller);

        foreach ($messages as $message) {
            $data['_messages']['warning'][] = $message;
        }
    }

    /**
     * Prepare an array of messages
     * @param array $messages
     * @param array $settings
     * @param \gplcart\core\Controller $controller
     */
    protected function prepareMessages(&$messages, $settings, $controller)
    {
        if ($controller->path('^admin/report/events$')) {
            $messages = array(); // Suppress errors on admin/report/events page
            return null;
        }

        $remaining = count($messages) - $settings['live_limit'];

        if (!empty($settings['live_limit']) && $remaining > 0) {
            $messages = array_slice($messages, 0, $settings['live_limit']);
            $messages[] = $controller->text('...and @remaining more', array('@remaining' => $remaining));
        }

        if ($controller->access('report_events')) {
            $message = $controller->text('<a href="@href">see saved errors</a>', array('@href' => $controller->url('admin/report/events', array('type' => 'php_error'))));
            if ($settings['live'] == 2) {
                $vars = array('@href' => $controller->url('admin/report/events', array('clear' => true, 'target' => $controller->path())));
                $message .= ' | ' . $controller->text('<a href="@href">clear all saved errors</a>', $vars);
            }
            $messages[] = $message;
        }
    }

    /**
     * Returns an array of PHP errors for live reporting
     * @param array $settings
     * @param \gplcart\core\Controller $controller
     * @return array
     */
    protected function getLiveErrorMessages(array $settings, $controller)
    {
        if (empty($settings['live'])) {
            return array();
        }

        /* @var $logger \gplcart\core\Logger */
        $logger = $this->getInstance('gplcart\\core\\Logger');

        $errors = array();
        if ($settings['live'] == 1) {
            $errors = $logger->getPhpErrors(false);
        } else if ($settings['live'] == 2) {
            $errors = $logger->selectPhpErrors();
        }

        return $this->getFormattedErrorMessages($errors, $controller);
    }

    /**
     * Returns an array of formatted error messages
     * @param array $errors
     * @param \gplcart\core\Controller $controller
     * @return array
     */
    protected function getFormattedErrorMessages(array $errors, $controller)
    {
        $messages = array();
        foreach ($errors as $error) {
            $vars = array(
                '@line' => $error['line'],
                '@message' => $error['message'],
                '@file' => gplcart_relative_path($error['file'])
            );
            $messages[] = $controller->text('@message on line @line in @file', $vars);
        }
        return $messages;
    }

}