1. sfWebDebug.class.php
  2. /**
 * sfWebDebug creates debug information for easy debugging in the browser.
 *
 * @package    symfony
 * @subpackage debug
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWebDebug.class.php 27284 2010-01-28 18:34:57Z Kris.Wallsmith $
 */
  3. class sfWebDebug
  4. {
  5.   protected
  6.     $dispatcher = null,
  7.     $logger     = null,
  8.     $options    = array(),
  9.     $panels     = array();
  11.   /**
  12.    * Constructor.
  13.    *
  14.    * Available options:
  15.    *
  16.    *  * image_root_path:    The image root path
  17.    *  * request_parameters: The current request parameters
  18.    *
  19.    * @param sfEventDispatcher $dispatcher The event dispatcher
  20.    * @param sfVarLogger       $logger     The logger
  21.    * @param array             $options    An array of options
  22.    */
  23.   public function __construct(sfEventDispatcher $dispatcher, sfVarLogger $logger, array $options = array())
  24.   {
  25.     $this->dispatcher = $dispatcher;
  26.     $this->logger     = $logger;
  27.     $this->options    = $options;
  29.     if (!isset($this->options['image_root_path']))
  30.     {
  31.       $this->options['image_root_path'] = '';
  32.     }
  34.     if (!isset($this->options['request_parameters']))
  35.     {
  36.       $this->options['request_parameters'] = array();
  37.     }
  39.     $this->configure();
  41.     $this->dispatcher->notify(new sfEvent($this, 'debug.web.load_panels'));
  42.   }
  44.   /**
  45.    * Configures the web debug toolbar.
  46.    */
  47.   public function configure()
  48.   {
  49.     $this->setPanel('symfony_version', new sfWebDebugPanelSymfonyVersion($this));
  50.     if (sfConfig::get('sf_debug') && sfConfig::get('sf_cache'))
  51.     {
  52.       $this->setPanel('cache', new sfWebDebugPanelCache($this));
  53.     }
  54.     if (sfConfig::get('sf_logging_enabled'))
  55.     {
  56.       $this->setPanel('config', new sfWebDebugPanelConfig($this));
  57.       $this->setPanel('view', new sfWebDebugPanelView($this));
  58.     }
  59.     $this->setPanel('logs', new sfWebDebugPanelLogs($this));
  60.     $this->setPanel('memory', new sfWebDebugPanelMemory($this));
  61.     if (sfConfig::get('sf_debug'))
  62.     {
  63.       $this->setPanel('time', new sfWebDebugPanelTimer($this));
  64.     }
  66.     $this->setPanel('mailer', new sfWebDebugPanelMailer($this));
  67.   }
  69.   /**
  70.    * Gets the logger.
  71.    *
  72.    * @return sfVarLogger The logger instance
  73.    */
  74.   public function getLogger()
  75.   {
  76.     return $this->logger;
  77.   }
  79.   /**
  80.    * Gets the event dispatcher.
  81.    *
  82.    * @return sfEventDispatcher The event dispatcher
  83.    */
  84.   public function getEventDispatcher()
  85.   {
  86.     return $this->dispatcher;
  87.   }
  89.   /**
  90.    * Gets the registered panels.
  91.    *
  92.    * @return array The panels
  93.    */
  94.   public function getPanels()
  95.   {
  96.     return $this->panels;
  97.   }
  99.   /**
  100.    * Sets a panel by name.
  101.    *
  102.    * @param string          $name  The panel name
  103.    * @param sfWebDebugPanel $panel The panel
  104.    */
  105.   public function setPanel($name, sfWebDebugPanel $panel)
  106.   {
  107.     $this->panels[$name] = $panel;
  108.   }
  110.   /**
  111.    * Removes a panel by name.
  112.    *
  113.    * @param string $name The panel name
  114.    */
  115.   public function removePanel($name)
  116.   {
  117.     unset($this->panels[$name]);
  118.   }
  120.   /**
  121.    * Gets an option value by name.
  122.    *
  123.    * @param string $name The option name
  124.    *
  125.    * @return mixed The option value
  126.    */
  127.   public function getOption($name, $default = null)
  128.   {
  129.     return isset($this->options[$name]) ? $this->options[$name] : $default;
  130.   }
  132.   /**
  133.    * Injects the web debug toolbar into a given HTML string.
  134.    *
  135.    * @param string $content The HTML content
  136.    *
  137.    * @return string The content with the web debug toolbar injected
  138.    */
  139.   public function injectToolbar($content)
  140.   {
  141.     $content = str_ireplace('</head>', '<style type="text/css">'.str_replace(array("\r", "\n"), ' ', $this->getStylesheet()).'</style></head>', $content);
  143.     $debug = $this->asHtml();
  144.     $count = 0;
  145.     $content = str_ireplace('</body>', '<script type="text/javascript">'.$this->getJavascript().'</script>'.$debug.'</body>', $content, $count);
  146.     if (!$count)
  147.     {
  148.       $content .= $debug;
  149.     }
  151.     return $content;
  152.   }
  154.   /**
  155.    * Returns the web debug toolbar as HTML.
  156.    *
  157.    * @return string The web debug toolbar HTML
  158.    */
  159.   public function asHtml()
  160.   {
  161.     $current = isset($this->options['request_parameters']['sfWebDebugPanel']) ? $this->options['request_parameters']['sfWebDebugPanel'] : null;
  163.     $titles = array();
  164.     $panels = array();
  165.     foreach ($this->panels as $name => $panel)
  166.     {
  167.       if ($title = $panel->getTitle())
  168.       {
  169.         if (($content = $panel->getPanelContent()) || $panel->getTitleUrl())
  170.         {
  171.           $id = sprintf('sfWebDebug%sDetails', $name);
  172.           $titles[] = sprintf('<li%s><a title="%s" href="%s"%s>%s</a></li>',
  173.             $panel->getStatus() ? ' class="sfWebDebug'.ucfirst($this->getPriority($panel->getStatus())).'"' : '',
  174.             $panel->getPanelTitle(),
  175.             $panel->getTitleUrl() ? $panel->getTitleUrl() : '#',
  176.             $panel->getTitleUrl() ? '' : ' onclick="sfWebDebugShowDetailsFor(\''.$id.'\'); return false;"',
  177.             $title
  178.           );
  179.           $panels[] = sprintf('<div id="%s" class="sfWebDebugTop" style="display:%s"><h1>%s</h1>%s</div>',
  180.             $id,
  181.             $name == $current ? 'block' : 'none',
  182.             $panel->getPanelTitle(),
  183.             $content
  184.           );
  185.         }
  186.         else
  187.         {
  188.           $titles[] = sprintf('<li>%s</li>', $title);
  189.         }
  190.       }
  191.     }
  193.     return '
  194.       <div id="sfWebDebug">
  195.         <div id="sfWebDebugBar">
  196.           <a href="#" onclick="sfWebDebugToggleMenu(); return false;"><img src="'.$this->options['image_root_path'].'/sf.png" alt="Debug toolbar" /></a>
  198.           <ul id="sfWebDebugDetails" class="sfWebDebugMenu">
  199.             '.implode("\n", $titles).'
  200.             <li class="last">
  201.               <a href="#" onclick="document.getElementById(\'sfWebDebug\').style.display=\'none\'; return false;"><img src="'.$this->options['image_root_path'].'/close.png" alt="Close" /></a>
  202.             </li>
  203.           </ul>
  204.         </div>
  206.         '.implode("\n", $panels).'
  207.       </div>
  208.     ';
  209.   }
  211.   /**
  212.    * Converts a priority value to a string.
  213.    *
  214.    * @param integer $value The priority value
  215.    *
  216.    * @return string The priority as a string
  217.    */
  218.   public function getPriority($value)
  219.   {
  220.     if ($value >= sfLogger::INFO)
  221.     {
  222.       return 'info';
  223.     }
  224.     else if ($value >= sfLogger::WARNING)
  225.     {
  226.       return 'warning';
  227.     }
  228.     else
  229.     {
  230.       return 'error';
  231.     }
  232.   }
  234.   /**
  235.    * Gets the javascript code to inject in the head tag.
  236.    *
  237.    * @param string The javascript code
  238.    */
  239.   public function getJavascript()
  240.   {
  241.     return <<<EOF
  242. /* <![CDATA[ */
  243. function sfWebDebugGetElementsByClassName(strClass, strTag, objContElm)
  244. {
  245.   // http://muffinresearch.co.uk/archives/2006/04/29/getelementsbyclassname-deluxe-edition/
  246.   strTag = strTag || "*";
  247.   objContElm = objContElm || document;
  248.   var objColl = (strTag == '*' && document.all) ? document.all : objContElm.getElementsByTagName(strTag);
  249.   var arr = new Array();
  250.   var delim = strClass.indexOf('|') != -1  ? '|' : ' ';
  251.   var arrClass = strClass.split(delim);
  252.   var j = objColl.length;
  253.   for (var i = 0; i < j; i++) {
  254.     if(objColl[i].className == undefined) continue;
  255.     var arrObjClass = objColl[i].className.split ? objColl[i].className.split(' ') : [];
  256.     if (delim == ' ' && arrClass.length > arrObjClass.length) continue;
  257.     var c = 0;
  258.     comparisonLoop:
  259.     {
  260.       var l = arrObjClass.length;
  261.       for (var k = 0; k < l; k++) {
  262.         var n = arrClass.length;
  263.         for (var m = 0; m < n; m++) {
  264.           if (arrClass[m] == arrObjClass[k]) c++;
  265.           if (( delim == '|' && c == 1) || (delim == ' ' && c == arrClass.length)) {
  266.             arr.push(objColl[i]);
  267.             break comparisonLoop;
  268.           }
  269.         }
  270.       }
  271.     }
  272.   }
  273.   return arr;
  274. }
  276. function sfWebDebugToggleMenu()
  277. {
  278.   var element = document.getElementById('sfWebDebugDetails');
  280.   var cacheElements = sfWebDebugGetElementsByClassName('sfWebDebugCache');
  281.   var mainCacheElements = sfWebDebugGetElementsByClassName('sfWebDebugActionCache');
  282.   var panelElements = sfWebDebugGetElementsByClassName('sfWebDebugTop');
  284.   if (element.style.display != 'none')
  285.   {
  286.     for (var i = 0; i < panelElements.length; ++i)
  287.     {
  288.       panelElements[i].style.display = 'none';
  289.     }
  291.     // hide all cache information
  292.     for (var i = 0; i < cacheElements.length; ++i)
  293.     {
  294.       cacheElements[i].style.display = 'none';
  295.     }
  296.     for (var i = 0; i < mainCacheElements.length; ++i)
  297.     {
  298.       mainCacheElements[i].style.border = 'none';
  299.     }
  300.   }
  301.   else
  302.   {
  303.     for (var i = 0; i < cacheElements.length; ++i)
  304.     {
  305.       cacheElements[i].style.display = '';
  306.     }
  307.     for (var i = 0; i < mainCacheElements.length; ++i)
  308.     {
  309.       mainCacheElements[i].style.border = '1px solid #f00';
  310.     }
  311.   }
  313.   sfWebDebugToggle('sfWebDebugDetails');
  314.   sfWebDebugToggle('sfWebDebugShowMenu');
  315.   sfWebDebugToggle('sfWebDebugHideMenu');
  316. }
  318. function sfWebDebugShowDetailsFor(element)
  319. {
  320.   if (typeof element == 'string')
  321.     element = document.getElementById(element);
  323.   var panelElements = sfWebDebugGetElementsByClassName('sfWebDebugTop');
  324.   for (var i = 0; i < panelElements.length; ++i)
  325.   {
  326.     if (panelElements[i] != element)
  327.     {
  328.       panelElements[i].style.display = 'none';
  329.     }
  330.   }
  332.   sfWebDebugToggle(element);
  333. }
  335. function sfWebDebugToggle(element)
  336. {
  337.   if (typeof element == 'string')
  338.     element = document.getElementById(element);
  340.   if (element)
  341.     element.style.display = element.style.display == 'none' ? '' : 'none';
  342. }
  344. function sfWebDebugToggleMessages(klass)
  345. {
  346.   var elements = sfWebDebugGetElementsByClassName(klass);
  348.   var x = elements.length;
  349.   for (var i = 0; i < x; ++i)
  350.   {
  351.     sfWebDebugToggle(elements[i]);
  352.   }
  353. }
  355. function sfWebDebugToggleAllLogLines(show, klass)
  356. {
  357.   var elements = sfWebDebugGetElementsByClassName(klass);
  358.   var x = elements.length;
  359.   for (var i = 0; i < x; ++i)
  360.   {
  361.     elements[i].style.display = show ? '' : 'none';
  362.   }
  363. }
  365. function sfWebDebugShowOnlyLogLines(type)
  366. {
  367.   var types = new Array();
  368.   types[0] = 'info';
  369.   types[1] = 'warning';
  370.   types[2] = 'error';
  371.   for (klass in types)
  372.   {
  373.     var elements = sfWebDebugGetElementsByClassName('sfWebDebug' + types[klass].substring(0, 1).toUpperCase() + types[klass].substring(1, types[klass].length));
  374.     var x = elements.length;
  375.     for (var i = 0; i < x; ++i)
  376.     {
  377.       if ('tr' == elements[i].tagName.toLowerCase())
  378.       {
  379.         elements[i].style.display = (type == types[klass]) ? '' : 'none';
  380.       }
  381.     }
  382.   }
  383. }
  384. /* ]]> */
  385. EOF;
  386.   }
  388.   /**
  389.    * Gets the stylesheet code to inject in the head tag.
  390.    *
  391.    * @param string The stylesheet code
  392.    */
  393.   public function getStylesheet()
  394.   {
  395.     return <<<EOF
  396. #sfWebDebug
  397. {
  398.   padding: 0;
  399.   margin: 0;
  400.   font-family: Arial, sans-serif;
  401.   font-size: 12px;
  402.   color: #333;
  403.   text-align: left;
  404.   line-height: 12px;
  405. }
  407. #sfWebDebug a, #sfWebDebug a:hover
  408. {
  409.   text-decoration: none;
  410.   border: none;
  411.   background-color: transparent;
  412.   color: #000;
  413. }
  415. #sfWebDebug img
  416. {
  417.   float: none;
  418.   margin: 0;
  419.   border: 0;
  420.   display: inline;
  421. }
  423. #sfWebDebugBar
  424. {
  425.   position: absolute;
  426.   margin: 0;
  427.   padding: 1px 0;
  428.   right: 0px;
  429.   top: 0px;
  430.   opacity: 0.80;
  431.   filter: alpha(opacity:80);
  432.   z-index: 10000;
  433.   white-space: nowrap;
  434.   background-color: #ddd;
  435. }
  437. #sfWebDebugBar[id]
  438. {
  439.   position: fixed;
  440. }
  442. #sfWebDebugBar img
  443. {
  444.   vertical-align: middle;
  445. }
  447. #sfWebDebugBar .sfWebDebugMenu
  448. {
  449.   padding: 5px;
  450.   padding-left: 0;
  451.   display: inline;
  452.   margin: 0;
  453. }
  455. #sfWebDebugBar .sfWebDebugMenu li
  456. {
  457.   display: inline;
  458.   list-style: none;
  459.   margin: 0;
  460.   padding: 0 6px;
  461. }
  463. #sfWebDebugBar .sfWebDebugMenu li.last
  464. {
  465.   margin: 0;
  466.   padding: 0;
  467.   border: 0;
  468. }
  470. #sfWebDebugDatabaseDetails li
  471. {
  472.   margin: 0;
  473.   margin-left: 30px;
  474.   padding: 5px 0;
  475. }
  477. #sfWebDebugShortMessages li
  478. {
  479.   margin-bottom: 10px;
  480.   padding: 5px;
  481.   background-color: #ddd;
  482. }
  484. #sfWebDebugShortMessages li
  485. {
  486.   list-style: none;
  487. }
  489. #sfWebDebugDetails
  490. {
  491.   margin-right: 7px;
  492. }
  494. #sfWebDebug pre
  495. {
  496.   line-height: 1.3;
  497.   margin-bottom: 10px;
  498. }
  500. #sfWebDebug h1
  501. {
  502.   font-size: 16px;
  503.   font-weight: bold;
  504.   margin: 20px 0;
  505.   padding: 0;
  506.   border: 0px;
  507.   background-color: #eee;
  508. }
  510. #sfWebDebug h2
  511. {
  512.   font-size: 14px;
  513.   font-weight: bold;
  514.   margin: 10px 0;
  515.   padding: 0;
  516.   border: 0px;
  517.   background: none;
  518. }
  520. #sfWebDebug h3
  521. {
  522.   font-size: 12px;
  523.   font-weight: bold;
  524.   margin: 10px 0;
  525.   padding: 0;
  526.   border: 0px;
  527.   background: none;
  528. }
  530. #sfWebDebug .sfWebDebugTop
  531. {
  532.   position: absolute;
  533.   left: 0px;
  534.   top: 0px;
  535.   width: 98%;
  536.   padding: 0 1%;
  537.   margin: 0;
  538.   z-index: 9999;
  539.   background-color: #efefef;
  540.   border-bottom: 1px solid #aaa;
  541. }
  543. #sfWebDebugLog
  544. {
  545.   margin: 0;
  546.   padding: 3px;
  547.   font-size: 11px;
  548. }
  550. #sfWebDebugLogMenu
  551. {
  552.   margin-bottom: 5px;
  553. }
  555. #sfWebDebugLogMenu li
  556. {
  557.   display: inline;
  558.   list-style: none;
  559.   margin: 0;
  560.   padding: 0 5px;
  561.   border-right: 1px solid #aaa;
  562. }
  564. #sfWebDebugConfigSummary
  565. {
  566.   display: inline;
  567.   padding: 5px;
  568.   background-color: #ddd;
  569.   border: 1px solid #aaa;
  570.   margin: 20px 0;
  571. }
  573. #sfWebDebugConfigSummary li
  574. {
  575.   list-style: none;
  576.   display: inline;
  577.   margin: 0;
  578.   padding: 0 5px;
  579. }
  581. #sfWebDebugConfigSummary li.last
  582. {
  583.   border: 0;
  584. }
  586. .sfWebDebugInfo, .sfWebDebugInfo td
  587. {
  588.   background-color: #ddd;
  589. }
  591. .sfWebDebugWarning, .sfWebDebugWarning td
  592. {
  593.   background-color: orange !important;
  594. }
  596. .sfWebDebugError, .sfWebDebugError td
  597. {
  598.   background-color: #f99 !important;
  599. }
  601. .sfWebDebugLogNumber
  602. {
  603.   width: 1%;
  604. }
  606. .sfWebDebugLogType
  607. {
  608.   width: 1%;
  609.   white-space: nowrap;
  610. }
  612. .sfWebDebugLogType, #sfWebDebug .sfWebDebugLogType a
  613. {
  614.   color: darkgreen;
  615. }
  617. #sfWebDebug .sfWebDebugLogType a:hover
  618. {
  619.   text-decoration: underline;
  620. }
  622. .sfWebDebugLogInfo
  623. {
  624.   color: blue;
  625. }
  627. .ison
  628. {
  629.   color: #3f3;
  630.   margin-right: 5px;
  631. }
  633. .isoff
  634. {
  635.   color: #f33;
  636.   margin-right: 5px;
  637.   text-decoration: line-through;
  638. }
  640. .sfWebDebugLogs
  641. {
  642.   padding: 0;
  643.   margin: 0;
  644.   border: 1px solid #999;
  645.   font-family: Arial;
  646.   font-size: 11px;
  647. }
  649. .sfWebDebugLogs tr
  650. {
  651.   padding: 0;
  652.   margin: 0;
  653.   border: 0;
  654. }
  656. .sfWebDebugLogs td
  657. {
  658.   margin: 0;
  659.   border: 0;
  660.   padding: 1px 3px;
  661.   vertical-align: top;
  662. }
  664. .sfWebDebugLogs th
  665. {
  666.   margin: 0;
  667.   border: 0;
  668.   padding: 3px 5px;
  669.   vertical-align: top;
  670.   background-color: #999;
  671.   color: #eee;
  672.   white-space: nowrap;
  673. }
  675. .sfWebDebugDebugInfo
  676. {
  677.   color: #999;
  678.   font-size: 11px;
  679.   margin: 5px 0 5px 10px;
  680.   padding: 2px 0 2px 5px;
  681.   border-left: 1px solid #aaa;
  682.   line-height: 1.25em;
  683. }
  685. .sfWebDebugDebugInfo .sfWebDebugLogInfo,
  686. .sfWebDebugDebugInfo a.sfWebDebugFileLink
  687. {
  688.   color: #333 !important;
  689. }
  691. .sfWebDebugCache
  692. {
  693.   padding: 0;
  694.   margin: 0;
  695.   font-family: Arial;
  696.   position: absolute;
  697.   overflow: hidden;
  698.   z-index: 995;
  699.   font-size: 9px;
  700.   padding: 2px;
  701.   filter:alpha(opacity=85);
  702.   -moz-opacity:0.85;
  703.   opacity: 0.85;
  704. }
  706. #sfWebDebugSymfonyVersion
  707. {
  708.   margin-left: 0;
  709.   padding: 1px 4px;
  710.   background-color: #666;
  711.   color: #fff;
  712. }
  714. #sfWebDebugviewDetails ul
  715. {
  716.   padding-left: 2em;
  717.   margin: .5em 0;
  718.   list-style: none;
  719. }
  721. #sfWebDebugviewDetails li
  722. {
  723.   margin-bottom: .5em;
  724. }
  726. #sfWebDebug .sfWebDebugDataType,
  727. #sfWebDebug .sfWebDebugDataType a
  728. {
  729.   color: #666;
  730.   font-style: italic;
  731. }
  733. #sfWebDebug .sfWebDebugDataType a:hover
  734. {
  735.   text-decoration: underline;
  736. }
  738. #sfWebDebugDatabaseLogs
  739. {
  740.   margin-bottom: 10px;
  741. }
  743. #sfWebDebugDatabaseLogs ol
  744. {
  745.   margin: 0;
  746.   padding: 0;
  747.   margin-left: 20px;
  748.   list-style: number;
  749. }
  751. #sfWebDebugDatabaseLogs li
  752. {
  753.   padding: 6px;
  754. }
  756. #sfWebDebugDatabaseLogs li:nth-child(odd)
  757. {
  758.   background-color: #CCC;
  759. }
  761. .sfWebDebugDatabaseQuery
  762. {
  763.   margin-bottom: .5em;
  764.   margin-top: 0;
  765. }
  767. .sfWebDebugDatabaseLogInfo
  768. {
  769.   color: #666;
  770.   font-size: 11px;
  771. }
  773. .sfWebDebugDatabaseQuery .sfWebDebugLogInfo
  774. {
  775.   color: #909;
  776.   font-weight: bold;
  777. }
  779. .sfWebDebugHighlight
  780. {
  781.   background: #FFC;
  782. }
  783. EOF;
  784.   }
  785. }
Debug toolbar