Module::setupBasicLogging() - Code Metrics - Inspection of "inspection fixes" - cloud-solutions/zend-sentry - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (e0770e)

by Markus

created 2016-11-11 15:29 UTC

Module::setupBasicLogging() A

↳ Parent: Module

Complexity

Conditions	2
Paths	1

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
c	3
b	2
f	0
dl	0
loc	23
rs	9.0856
cc	2
eloc	16
nc	1
nop	1

<?php

/**
 * cloud solutions ZendSentry
 *
 * This source file is part of the cloud solutions ZendSentry package
 *
 * @package    ZendSentry\Module
 * @license    New BSD License {@link /docs/LICENSE}
 * @copyright  Copyright (c) 2013, cloud solutions OÜ
 */

namespace ZendSentry;

use Zend\EventManager\EventManager;
use Zend\Mvc\MvcEvent;
use ZendSentry\Mvc\View\Http\ExceptionStrategy as SentryHttpStrategy;
use ZendSentry\Mvc\View\Console\ExceptionStrategy as SentryConsoleStrategy;
use Zend\Mvc\View\Http\ExceptionStrategy;
use Raven_Client as Raven;
use Zend\Log\Logger;

/**
 * Class Module
 *
 * @package ZendSentry
 */
class Module
{
    /**
     * Translates Zend Framework log levels to Raven log levels.
     */
    private $logLevels = array(
        7 => Raven::DEBUG,
        6 => Raven::INFO,
        5 => Raven::INFO,
        4 => Raven::WARNING,
        3 => Raven::ERROR,
        2 => Raven::FATAL,
        1 => Raven::FATAL,
        0 => Raven::FATAL,
    );

    /**
     * @var Raven $ravenClient
     */
    protected $ravenClient;

    /**
     * @var ZendSentry $zendSentry
     */
    protected $zendSentry;

    /**
     * @var $config
     */
    protected $config;

    /**
     * @var EventManager $eventManager
     */
    protected $eventManager;

    /**
     * @param MvcEvent $event
     */
    public function onBootstrap(MvcEvent $event)
    {
        // Setup RavenClient (provided by Sentry) and Sentry (provided by this module)
        $this->config = $event->getApplication()->getServiceManager()->get('Config');

        if (!$this->config['zend-sentry']['use-module']) {
            return;
        }

        if (isset($this->config['zend-sentry']['raven-config']) && is_array($this->config['zend-sentry']['raven-config'])) {
            $ravenConfig = $this->config['zend-sentry']['raven-config'];
        } else {
            $ravenConfig = array();
        }

        $sentryApiKey = $this->config['zend-sentry']['sentry-api-key'];
        $ravenClient = new Raven($sentryApiKey, $ravenConfig);

        // Register the RavenClient as a application wide service
        /** @noinspection PhpUndefinedMethodInspection */
        $event->getApplication()->getServiceManager()->setService('raven', $ravenClient);
        $this->ravenClient = $ravenClient;
        $this->zendSentry = new ZendSentry($ravenClient);

        // Get the eventManager and set it as a member for convenience
        $this->eventManager = $event->getApplication()->getEventManager();

        // If ZendSentry is configured to use the custom logger, attach the listener
        if ($this->config['zend-sentry']['attach-log-listener']) {
            $this->setupBasicLogging($event);
        }

        // If ZendSentry is configured to log exceptions, a few things need to be set up
        if ($this->config['zend-sentry']['handle-exceptions']) {
            $this->setupExceptionLogging($event);
        }

        // If ZendSentry is configured to log errors, register it as error handler
        if ($this->config['zend-sentry']['handle-errors']) {
            $errorReportingLevel = (isset($this->config['zend-sentry']['error-reporting'])) ? $this->config['zend-sentry']['error-reporting'] : -1;
            $this->zendSentry->registerErrorHandler($this->config['zend-sentry']['call-existing-error-handler'], $errorReportingLevel);
        }

        // If ZendSentry is configured to log shutdown errors, register it
        if ($this->config['zend-sentry']['handle-shutdown-errors']) {
            $this->zendSentry->registerShutdownFunction();
        }

        // If ZendSentry is configured to log Javascript errors, add needed scripts to the view
        if ($this->config['zend-sentry']['handle-javascript-errors']) {
            $this->setupJavascriptLogging($event);
        }
    }

    /**
     * @return array
     */
    public function getAutoloaderConfig()
    {
        return array('Zend\Loader\StandardAutoloader' => array('namespaces' => array(
            __NAMESPACE__ => __DIR__.'/src/'.__NAMESPACE__,
        )));
    }

    /**
     * @return mixed
     */
    public function getConfig()
    {
        return include __DIR__.'/config/module.config.php';
    }/** @noinspection PhpUnusedParameterInspection */
    /** @noinspection PhpUnusedParameterInspection */

    /**
     * Gives us the possibility to write logs to Sentry from anywhere in the application
     * Doesn't use the ZF compatible Log Writer because we want to return the Sentry event ID
     * ZF Logging doesn't provide the possibility to return values from writers
     *
     * @param MvcEvent $event
     */
    protected function setupBasicLogging(MvcEvent $event)
    {
        // Get the shared event manager and attach a logging listener for the log event on application level
        $sharedManager = $this->eventManager->getSharedManager();
        $raven = $this->ravenClient;
        $logLevels = $this->logLevels;

        $sharedManager->attach('*', 'log', function($event) use ($raven, $logLevels) {
            /** @var $event MvcEvent */
            if (is_object($event->getTarget())) {
                $target = get_class($event->getTarget());
            } else {
                $target = (string) $event->getTarget();
            }
            $message  = $event->getParam('message', 'No message provided');
            $priority = (int) $event->getParam('priority', Logger::INFO);
            $message  = sprintf('%s: %s', $target, $message);
            $tags     = $event->getParam('tags', array());
            $eventID = $raven->captureMessage($message, array(), array('tags' => $tags, 'level' => $logLevels[$priority]));

            return $eventID;
        }, 2);
    }

    /**
     * 1. Registers Sentry as exception handler
     * 2. Replaces the default ExceptionStrategy so Exception that are caught by Zend Framework can still be logged
     *
     * @param MvcEvent $event
     */
    protected function setupExceptionLogging(MvcEvent $event)
    {
        // Register Sentry as exception handler for exception that bubble up to the top
        $this->zendSentry->registerExceptionHandler($this->config['zend-sentry']['call-existing-exception-handler']);

        // Replace the default ExceptionStrategy with ZendSentry's strategy
        if ($event->getApplication()->getServiceManager()->has('HttpExceptionStrategy')) {
            /** @var $exceptionStrategy ExceptionStrategy */
            $exceptionStrategy = $event->getApplication()->getServiceManager()->get('HttpExceptionStrategy');
            $exceptionStrategy->detach($this->eventManager);
        }
        
        // Check if script is running in console
        $exceptionStrategy = (PHP_SAPI == 'cli') ? (new SentryConsoleStrategy()) : (new SentryHttpStrategy());
        $exceptionStrategy->attach($this->eventManager);
        $exceptionStrategy->setDisplayExceptions($this->config['zend-sentry']['display-exceptions']);
        $exceptionStrategy->setDefaultExceptionMessage($this->config['zend-sentry'][(PHP_SAPI == 'cli') ? 'default-exception-console-message' : 'default-exception-message']);

        $ravenClient = $this->ravenClient;

        // Attach an exception listener for the ZendSentry exception strategy, can be triggered from anywhere else too
        $this->eventManager->getSharedManager()->attach('*', 'logException', function($event) use ($ravenClient) {
            /** @var $event MvcEvent */
            $exception = $event->getParam('exception');
            $tags = $event->getParam('tags', array());
            $eventID = $ravenClient->captureException($exception, array('tags' => $tags));
            return $eventID;
        });
    }

    /**
     * Adds the necessary javascript, tries to prepend
     *
     * @param MvcEvent $event
     */
    protected function setupJavascriptLogging(MvcEvent $event)
    {
        $viewHelper = $event->getApplication()->getServiceManager()->get('viewhelpermanager')->get('headscript');
        /** @noinspection PhpUndefinedMethodInspection */
        $viewHelper->offsetSetFile(0, '//cdn.ravenjs.com/3.8.0/raven.min.js');
        $publicApiKey = $this->convertKeyToPublic($this->config['zend-sentry']['sentry-api-key']);
        /** @noinspection PhpUndefinedMethodInspection */
        $viewHelper->offsetSetScript(1, sprintf("Raven.config('%s').install()", $publicApiKey));
    }

    /**
     * @param string $key
     * @return string $publicKey
     */
    private function convertKeyToPublic($key)
    {
        // Find private part
        $start = strpos($key, ':', 6);
        $end = strpos($key, '@');
        $privatePart = substr($key, $start, $end - $start);

        // Replace it with an empty string
        $publicKey = str_replace($privatePart, '', $key);

        return $publicKey;
    }
}


1			<?php
2
3			/**
4			* cloud solutions ZendSentry
5			*
6			* This source file is part of the cloud solutions ZendSentry package
7			*
8			* @package ZendSentry\Module
9			* @license New BSD License {@link /docs/LICENSE}
10			* @copyright Copyright (c) 2013, cloud solutions OÜ
11			*/
12
13			namespace ZendSentry;
14
15			use Zend\EventManager\EventManager;
16			use Zend\Mvc\MvcEvent;
17			use ZendSentry\Mvc\View\Http\ExceptionStrategy as SentryHttpStrategy;
18			use ZendSentry\Mvc\View\Console\ExceptionStrategy as SentryConsoleStrategy;
19			use Zend\Mvc\View\Http\ExceptionStrategy;
20			use Raven_Client as Raven;
21			use Zend\Log\Logger;
22
23			/**
24			* Class Module
25			*
26			* @package ZendSentry
27			*/
28			class Module
29			{
30			/**
31			* Translates Zend Framework log levels to Raven log levels.
32			*/
33			private $logLevels = array(
34			7 => Raven::DEBUG,
35			6 => Raven::INFO,
36			5 => Raven::INFO,
37			4 => Raven::WARNING,
38			3 => Raven::ERROR,
39			2 => Raven::FATAL,
40			1 => Raven::FATAL,
41			0 => Raven::FATAL,
42			);
43
44			/**
45			* @var Raven $ravenClient
46			*/
47			protected $ravenClient;
48
49			/**
50			* @var ZendSentry $zendSentry
51			*/
52			protected $zendSentry;
53
54			/**
55			* @var $config
56			*/
57			protected $config;
58
59			/**
60			* @var EventManager $eventManager
61			*/
62			protected $eventManager;
63
64			/**
65			* @param MvcEvent $event
66			*/
67			public function onBootstrap(MvcEvent $event)
68			{
69			// Setup RavenClient (provided by Sentry) and Sentry (provided by this module)
70			$this->config = $event->getApplication()->getServiceManager()->get('Config');
71
72			if (!$this->config['zend-sentry']['use-module']) {
73			return;
74			}
75
76			if (isset($this->config['zend-sentry']['raven-config']) && is_array($this->config['zend-sentry']['raven-config'])) {
77			$ravenConfig = $this->config['zend-sentry']['raven-config'];
78			} else {
79			$ravenConfig = array();
80			}
81
82			$sentryApiKey = $this->config['zend-sentry']['sentry-api-key'];
83			$ravenClient = new Raven($sentryApiKey, $ravenConfig);
84
85			// Register the RavenClient as a application wide service
86			/** @noinspection PhpUndefinedMethodInspection */
87			$event->getApplication()->getServiceManager()->setService('raven', $ravenClient);
88			$this->ravenClient = $ravenClient;
89			$this->zendSentry = new ZendSentry($ravenClient);
90
91			// Get the eventManager and set it as a member for convenience
92			$this->eventManager = $event->getApplication()->getEventManager();
93
94			// If ZendSentry is configured to use the custom logger, attach the listener
95			if ($this->config['zend-sentry']['attach-log-listener']) {
96			$this->setupBasicLogging($event);
97			}
98
99			// If ZendSentry is configured to log exceptions, a few things need to be set up
100			if ($this->config['zend-sentry']['handle-exceptions']) {
101			$this->setupExceptionLogging($event);
102			}
103
104			// If ZendSentry is configured to log errors, register it as error handler
105			if ($this->config['zend-sentry']['handle-errors']) {
106			$errorReportingLevel = (isset($this->config['zend-sentry']['error-reporting'])) ? $this->config['zend-sentry']['error-reporting'] : -1;
107			$this->zendSentry->registerErrorHandler($this->config['zend-sentry']['call-existing-error-handler'], $errorReportingLevel);
108			}
109
110			// If ZendSentry is configured to log shutdown errors, register it
111			if ($this->config['zend-sentry']['handle-shutdown-errors']) {
112			$this->zendSentry->registerShutdownFunction();
113			}
114
115			// If ZendSentry is configured to log Javascript errors, add needed scripts to the view
116			if ($this->config['zend-sentry']['handle-javascript-errors']) {
117			$this->setupJavascriptLogging($event);
118			}
119			}
120
121			/**
122			* @return array
123			*/
124			public function getAutoloaderConfig()
125			{
126			return array('Zend\Loader\StandardAutoloader' => array('namespaces' => array(
127			__NAMESPACE__ => __DIR__.'/src/'.__NAMESPACE__,
128			)));
129			}
130
131			/**
132			* @return mixed
133			*/
134			public function getConfig()
135			{
136			return include __DIR__.'/config/module.config.php';
137			}/** @noinspection PhpUnusedParameterInspection */
138			/** @noinspection PhpUnusedParameterInspection */
139
140			/**
141			* Gives us the possibility to write logs to Sentry from anywhere in the application
142			* Doesn't use the ZF compatible Log Writer because we want to return the Sentry event ID
143			* ZF Logging doesn't provide the possibility to return values from writers
144			*
145			* @param MvcEvent $event
146			*/
147			protected function setupBasicLogging(MvcEvent $event)
148			{
149			// Get the shared event manager and attach a logging listener for the log event on application level
150			$sharedManager = $this->eventManager->getSharedManager();
151			$raven = $this->ravenClient;
152			$logLevels = $this->logLevels;
153
154			$sharedManager->attach('*', 'log', function($event) use ($raven, $logLevels) {
155			/** @var $event MvcEvent */
156			if (is_object($event->getTarget())) {
157			$target = get_class($event->getTarget());
158			} else {
159			$target = (string) $event->getTarget();
160			}
161			$message = $event->getParam('message', 'No message provided');
162			$priority = (int) $event->getParam('priority', Logger::INFO);
163			$message = sprintf('%s: %s', $target, $message);
164			$tags = $event->getParam('tags', array());
165			$eventID = $raven->captureMessage($message, array(), array('tags' => $tags, 'level' => $logLevels[$priority]));
166
167			return $eventID;
168			}, 2);
169			}
170
171			/**
172			* 1. Registers Sentry as exception handler
173			* 2. Replaces the default ExceptionStrategy so Exception that are caught by Zend Framework can still be logged
174			*
175			* @param MvcEvent $event
176			*/
177			protected function setupExceptionLogging(MvcEvent $event)
178			{
179			// Register Sentry as exception handler for exception that bubble up to the top
180			$this->zendSentry->registerExceptionHandler($this->config['zend-sentry']['call-existing-exception-handler']);
181
182			// Replace the default ExceptionStrategy with ZendSentry's strategy
183			if ($event->getApplication()->getServiceManager()->has('HttpExceptionStrategy')) {
184			/** @var $exceptionStrategy ExceptionStrategy */
185			$exceptionStrategy = $event->getApplication()->getServiceManager()->get('HttpExceptionStrategy');
186			$exceptionStrategy->detach($this->eventManager);
187			}
188
189			// Check if script is running in console
190			$exceptionStrategy = (PHP_SAPI == 'cli') ? (new SentryConsoleStrategy()) : (new SentryHttpStrategy());
191			$exceptionStrategy->attach($this->eventManager);
192			$exceptionStrategy->setDisplayExceptions($this->config['zend-sentry']['display-exceptions']);
193			$exceptionStrategy->setDefaultExceptionMessage($this->config['zend-sentry'][(PHP_SAPI == 'cli') ? 'default-exception-console-message' : 'default-exception-message']);
194
195			$ravenClient = $this->ravenClient;
196
197			// Attach an exception listener for the ZendSentry exception strategy, can be triggered from anywhere else too
198			$this->eventManager->getSharedManager()->attach('*', 'logException', function($event) use ($ravenClient) {
199			/** @var $event MvcEvent */
200			$exception = $event->getParam('exception');
201			$tags = $event->getParam('tags', array());
202			$eventID = $ravenClient->captureException($exception, array('tags' => $tags));
203			return $eventID;
204			});
205			}
206
207			/**
208			* Adds the necessary javascript, tries to prepend
209			*
210			* @param MvcEvent $event
211			*/
212			protected function setupJavascriptLogging(MvcEvent $event)
213			{
214			$viewHelper = $event->getApplication()->getServiceManager()->get('viewhelpermanager')->get('headscript');
215			/** @noinspection PhpUndefinedMethodInspection */
216			$viewHelper->offsetSetFile(0, '//cdn.ravenjs.com/3.8.0/raven.min.js');
217			$publicApiKey = $this->convertKeyToPublic($this->config['zend-sentry']['sentry-api-key']);
218			/** @noinspection PhpUndefinedMethodInspection */
219			$viewHelper->offsetSetScript(1, sprintf("Raven.config('%s').install()", $publicApiKey));
220			}
221
222			/**
223			* @param string $key
224			* @return string $publicKey
225			*/
226			private function convertKeyToPublic($key)
227			{
228			// Find private part
229			$start = strpos($key, ':', 6);
230			$end = strpos($key, '@');
231			$privatePart = substr($key, $start, $end - $start);
232
233			// Replace it with an empty string
234			$publicKey = str_replace($privatePart, '', $key);
235
236			return $publicKey;
237			}
238			}
239

cloud-solutions / zend-sentry

Branch — master (e0770e)

Module::setupBasicLogging() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like