1. sfWebDebugLogger.class.php
  2. /**
 * sfWebDebugLogger logs messages into the web debug toolbar.
 *
 * @package    symfony
 * @subpackage log
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWebDebugLogger.class.php 22853 2009-10-07 12:11:15Z fabien $
 */
  3. class sfWebDebugLogger extends sfVarLogger
  4. {
  5.   protected
  6.     $context       = null,
  7.     $webDebugClass = null,
  8.     $webDebug      = null;
  10.   /**
  11.    * Initializes this logger.
  12.    *
  13.    * Available options:
  14.    *
  15.    *  * web_debug_class: The web debug class (sfWebDebug by default)
  16.    *
  17.    * @param  sfEventDispatcher $dispatcher  A sfEventDispatcher instance
  18.    * @param  array             $options     An array of options.
  19.    *
  20.    * @return Boolean           true, if initialization completes successfully, otherwise false.
  21.    *
  22.    * @see sfVarLogger
  23.    */
  24.   public function initialize(sfEventDispatcher $dispatcher, $options = array())
  25.   {
  26.     $this->context = sfContext::getInstance();
  28.     $this->webDebugClass = isset($options['web_debug_class']) ? $options['web_debug_class'] : 'sfWebDebug';
  30.     if (sfConfig::get('sf_web_debug'))
  31.     {
  32.       $dispatcher->connect('context.load_factories', array($this, 'listenForLoadFactories'));
  33.       $dispatcher->connect('response.filter_content', array($this, 'filterResponseContent'));
  34.     }
  36.     $this->registerErrorHandler();
  38.     return parent::initialize($dispatcher, $options);
  39.   }
  41.   /**
  42.    * Registers logger with PHP error handler.
  43.    */
  44.   protected function registerErrorHandler()
  45.   {
  46.     set_error_handler(array($this,'handlePhpError'));
  47.   }
  49.   /**
  50.    * PHP error handler send PHP errors to log.
  51.    *
  52.    * PHP user space error handler can not handle E_ERROR, E_PARSE,
  53.    * E_CORE_ERROR, E_CORE_WARNING, E_COMPILE_ERROR, E_COMPILE_WARNING,
  54.    * and most of E_STRICT.
  55.    *
  56.    * @param string $errno      The level of the error raised, as an integer.
  57.    * @param string $errstr     The error message, as a string.
  58.    * @param string $errfile    The filename that the error was raised in, as a string.
  59.    * @param string $errline    The line number the error was raised at, as an integer.
  60.    * @param array  $errcontext An array that points to the active symbol table at the point the error occurred.
  61.    */
  62.   public function handlePhpError($errno, $errstr, $errfile, $errline, $errcontext = array())
  63.   {
  64.     if (($errno & error_reporting()) == 0)
  65.     {
  66.       return false;
  67.     }
  69.     $message = sprintf(' %%s at %s on line %s (%s)', $errfile, $errline, $errstr);
  70.     switch ($errno)
  71.     {
  72.       case E_STRICT:
  73.         $this->dispatcher->notify(new sfEvent($this, 'application.log', array('priority' => sfLogger::ERR, sprintf($message, 'Strict notice'))));
  74.         break;
  75.       case E_NOTICE:
  76.         $this->dispatcher->notify(new sfEvent($this, 'application.log', array('priority' => sfLogger::NOTICE, sprintf($message, 'Notice'))));
  77.         break;
  78.       case E_WARNING:
  79.         $this->dispatcher->notify(new sfEvent($this, 'application.log', array('priority' => sfLogger::WARNING, sprintf($message, 'Warning'))));
  80.         break;
  81.       case E_RECOVERABLE_ERROR:
  82.         $this->dispatcher->notify(new sfEvent($this, 'application.log', array('priority' => sfLogger::ERR, sprintf($message, 'Error'))));
  83.         break;
  84.     }
  86.     return false; // do not prevent default error handling
  87.   }
  89.   /**
  90.    * Listens for the context.load_factories event.
  91.    * 
  92.    * @param sfEvent $event
  93.    */
  94.   public function listenForLoadFactories(sfEvent $event)
  95.   {
  96.     $path = sprintf('%s/%s/images', $event->getSubject()->getRequest()->getRelativeUrlRoot(), sfConfig::get('sf_web_debug_web_dir'));
  97.     $path = str_replace('//', '/', $path);
  99.     $this->webDebug = new $this->webDebugClass($this->dispatcher, $this, array(
  100.       'image_root_path'    => $path,
  101.       'request_parameters' => $event->getSubject()->getRequest()->getParameterHolder()->getAll(),
  102.     ));
  103.   }
  105.   /**
  106.    * Listens to the response.filter_content event.
  107.    *
  108.    * @param  sfEvent $event   The sfEvent instance
  109.    * @param  string  $content The response content
  110.    *
  111.    * @return string  The filtered response content
  112.    */
  113.   public function filterResponseContent(sfEvent $event, $content)
  114.   {
  115.     if (!sfConfig::get('sf_web_debug'))
  116.     {
  117.       return $content;
  118.     }
  120.     // log timers information
  121.     $messages = array();
  122.     foreach (sfTimerManager::getTimers() as $name => $timer)
  123.     {
  124.       $messages[] = sprintf('%s %.2f ms (%d)', $name, $timer->getElapsedTime() * 1000, $timer->getCalls());
  125.     }
  126.     $this->dispatcher->notify(new sfEvent($this, 'application.log', $messages));
  128.     // don't add debug toolbar:
  129.     // * for XHR requests
  130.     // * if response status code is in the 3xx range
  131.     // * if not rendering to the client
  132.     // * if HTTP headers only
  133.     $response = $event->getSubject();
  134.     $request  = $this->context->getRequest();
  135.     if (
  136.       null === $this->webDebug
  137.       ||
  138.       !$this->context->has('request')
  139.       ||
  140.       !$this->context->has('response')
  141.       ||
  142.       !$this->context->has('controller')
  143.       ||
  144.       $request->isXmlHttpRequest()
  145.       ||
  146.       strpos($response->getContentType(), 'html') === false
  147.       ||
  148.       '3' == substr($response->getStatusCode(), 0, 1)
  149.       ||
  150.       $this->context->getController()->getRenderMode() != sfView::RENDER_CLIENT
  151.       ||
  152.       $response->isHeaderOnly()
  153.     )
  154.     {
  155.       return $content;
  156.     }
  158.     return $this->webDebug->injectToolbar($content);
  159.   }
  160. }
Debug toolbar