system/libraries/Profiler.php

   1 <?php defined('SYSPATH') OR die('No direct access allowed.');
   2 /**
   3  * Adds useful information to the bottom of the current page for debugging and optimization purposes.
   4  *
   5  * Benchmarks   - The times and memory usage of benchmarks run by the Benchmark library.
   6  * Database     - The raw SQL and number of affected rows of Database queries.
   7  * Session Data - Data stored in the current session if using the Session library.
   8  * POST Data    - The name and values of any POST data submitted to the current page.
   9  * Cookie Data  - All cookies sent for the current request.
  10  *
  11  * $Id: Profiler.php 3917 2009-01-21 03:06:22Z zombor $
  12  *
  13  * @package    Profiler
  14  * @author     Kohana Team
  15  * @copyright  (c) 2007-2008 Kohana Team
  16  * @license    http://kohanaphp.com/license.html
  17  */
  18 class Profiler {
  19
  20         protected $profiles = array();
  21         protected $show;
  22
  23         public function __construct()
  24         {
  25                 if(isset($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest') {
  26                         Kohana::log('debug', 'Skipping init of Profiler, since the current request is ajaxish');
  27                         return;
  28                 }
  29                 // Add all built in profiles to event
  30                 Event::add('profiler.run', array($this, 'benchmarks'));
  31                 Event::add('profiler.run', array($this, 'database'));
  32                 Event::add('profiler.run', array($this, 'session'));
  33                 Event::add('profiler.run', array($this, 'post'));
  34                 Event::add('profiler.run', array($this, 'cookies'));
  35
  36                 // Add profiler to page output automatically
  37                 Event::add('system.display', array($this, 'render'));
  38         }
  39
  40         /**
  41          * Magic __call method. Creates a new profiler section object.
  42          *
  43          * @param   string   input type
  44          * @param   string   input name
  45          * @return  object
  46          */
  47         public function __call($method, $args)
  48         {
  49                 if ( ! $this->show OR (is_array($this->show) AND ! in_array($args[0], $this->show)))
  50                         return FALSE;
  51
  52                 // Class name
  53                 $class = 'Profiler_'.ucfirst($method);
  54
  55                 $class = new $class();
  56
  57                 $this->profiles[$args[0]] = $class;
  58
  59                 return $class;
  60         }
  61
  62         /**
  63          * Disables the profiler for this page only.
  64          * Best used when profiler is autoloaded.
  65          *
  66          * @return  void
  67          */
  68         public function disable()
  69         {
  70                 // Removes itself from the event queue
  71                 Event::clear('system.display', array($this, 'render'));
  72         }
  73
  74         /**
  75          * Render the profiler. Output is added to the bottom of the page by default.
  76          *
  77          * @param   boolean  return the output if TRUE
  78          * @return  void|string
  79          */
  80         public function render($return = FALSE)
  81         {
  82                 $start = microtime(TRUE);
  83
  84                 $get = isset($_GET['profiler']) ? explode(',', $_GET['profiler']) : array();
  85                 $this->show = empty($get) ? Kohana::config('profiler.show') : $get;
  86
  87                 Event::run('profiler.run', $this);
  88
  89                 $styles = '';
  90                 foreach ($this->profiles as $profile)
  91                 {
  92                         $styles .= $profile->styles();
  93                 }
  94
  95                 // Don't display if there's no profiles
  96                 if (empty($this->profiles))
  97                         return;
  98
  99                 // Load the profiler view
 100                 $data = array
 101                 (
 102                         'profiles' => $this->profiles,
 103                         'styles'   => $styles,
 104                         'execution_time' => microtime(TRUE) - $start
 105                 );
 106                 $view = new View('kohana_profiler', $data);
 107
 108                 // Return rendered view if $return is TRUE
 109                 if ($return == TRUE)
 110                         return $view->render();
 111
 112                 // Add profiler data to the output
 113                 if (stripos(Kohana::$output, '</body>') !== FALSE)
 114                 {
 115                         // Closing body tag was found, insert the profiler data before it
 116                         Kohana::$output = str_ireplace('</body>', $view->render().'</body>', Kohana::$output);
 117                 }
 118                 else
 119                 {
 120                         // Append the profiler data to the output
 121                         Kohana::$output .= $view->render();
 122                 }
 123         }
 124
 125         /**
 126          * Benchmark times and memory usage from the Benchmark library.
 127          *
 128          * @return  void
 129          */
 130         public function benchmarks()
 131         {
 132                 if ( ! $table = $this->table('benchmarks'))
 133                         return;
 134
 135                 $table->add_column();
 136                 $table->add_column('kp-column kp-data');
 137                 $table->add_column('kp-column kp-data');
 138                 $table->add_row(array('Benchmarks', 'Time', 'Memory'), 'kp-title', 'background-color: #FFE0E0');
 139
 140                 $benchmarks = Benchmark::get(TRUE);
 141
 142                 // Moves the first benchmark (total execution time) to the end of the array
 143                 $benchmarks = array_slice($benchmarks, 1) + array_slice($benchmarks, 0, 1);
 144
 145                 text::alternate();
 146                 foreach ($benchmarks as $name => $benchmark)
 147                 {
 148                         // Clean unique id from system benchmark names
 149                         $name = ucwords(str_replace(array('_', '-'), ' ', str_replace(SYSTEM_BENCHMARK.'_', '', $name)));
 150
 151                         $data = array($name, number_format($benchmark['time'], 3), number_format($benchmark['memory'] / 1024 / 1024, 2).'MB');
 152                         $class = text::alternate('', 'kp-altrow');
 153
 154                         if ($name == 'Total Execution')
 155                                 $class = 'kp-totalrow';
 156
 157                         $table->add_row($data, $class);
 158                 }
 159         }
 160
 161         /**
 162          * Database query benchmarks.
 163          *
 164          * @return  void
 165          */
 166         public function database()
 167         {
 168                 if ( ! $table = $this->table('database'))
 169                         return;
 170
 171                 $table->add_column();
 172                 $table->add_column('kp-column kp-data');
 173                 $table->add_column('kp-column kp-data');
 174                 $table->add_row(array('Queries', 'Time', 'Rows'), 'kp-title', 'background-color: #E0FFE0');
 175
 176                 $queries = Database::$benchmarks;
 177
 178                 text::alternate();
 179                 $total_time = $total_rows = 0;
 180                 foreach ($queries as $query)
 181                 {
 182                         $data = array($query['query'], number_format($query['time'], 3), $query['rows']);
 183                         $class = text::alternate('', 'kp-altrow');
 184                         $table->add_row($data, $class);
 185                         $total_time += $query['time'];
 186                         $total_rows += $query['rows'];
 187                 }
 188
 189                 $data = array('Total: ' . count($queries), number_format($total_time, 3), $total_rows);
 190                 $table->add_row($data, 'kp-totalrow');
 191         }
 192
 193         /**
 194          * Session data.
 195          *
 196          * @return  void
 197          */
 198         public function session()
 199         {
 200                 if (empty($_SESSION)) return;
 201
 202                 if ( ! $table = $this->table('session'))
 203                         return;
 204
 205                 $table->add_column('kp-name');
 206                 $table->add_column();
 207                 $table->add_row(array('Session', 'Value'), 'kp-title', 'background-color: #CCE8FB');
 208
 209                 text::alternate();
 210                 foreach($_SESSION as $name => $value)
 211                 {
 212                         if (is_object($value))
 213                         {
 214                                 $value = get_class($value).' [object]';
 215                         }
 216
 217                         $data = array($name, $value);
 218                         $class = text::alternate('', 'kp-altrow');
 219                         $table->add_row($data, $class);
 220                 }
 221         }
 222
 223         /**
 224          * POST data.
 225          *
 226          * @return  void
 227          */
 228         public function post()
 229         {
 230                 if (empty($_POST)) return;
 231
 232                 if ( ! $table = $this->table('post'))
 233                         return;
 234
 235                 $table->add_column('kp-name');
 236                 $table->add_column();
 237                 $table->add_row(array('POST', 'Value'), 'kp-title', 'background-color: #E0E0FF');
 238
 239                 text::alternate();
 240                 foreach($_POST as $name => $value)
 241                 {
 242                         $data = array($name, $value);
 243                         $class = text::alternate('', 'kp-altrow');
 244                         $table->add_row($data, $class);
 245                 }
 246         }
 247
 248         /**
 249          * Cookie data.
 250          *
 251          * @return  void
 252          */
 253         public function cookies()
 254         {
 255                 if (empty($_COOKIE)) return;
 256
 257                 if ( ! $table = $this->table('cookies'))
 258                         return;
 259
 260                 $table->add_column('kp-name');
 261                 $table->add_column();
 262                 $table->add_row(array('Cookies', 'Value'), 'kp-title', 'background-color: #FFF4D7');
 263
 264                 text::alternate();
 265                 foreach($_COOKIE as $name => $value)
 266                 {
 267                         $data = array($name, $value);
 268                         $class = text::alternate('', 'kp-altrow');
 269                         $table->add_row($data, $class);
 270                 }
 271         }
 272 }