classes/plbacktrace.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 /** Ligth debugging tool to generate execution backtrace
  23  */
  24 class PlBacktrace
  25 {
  26     static public $bt = array();
  27
  28     public $traces    = array();
  29     public $totaltime = 0.0;
  30     public $error     = false;
  31
  32     function __construct($name, array $init = array(), $sizef = 'rows', $timef = 'exectime', $errorf = 'error')
  33     {
  34         PlBacktrace::$bt[$name] = $this;
  35         foreach ($init as &$entry) {
  36             $this->add($entry, $sizef, $timef, $errorf);
  37         }
  38     }
  39
  40     private function fixCharset($action)
  41     {
  42         if (!is_string($action)) {
  43             return $action;
  44         } else {
  45             return is_utf8($action) ? $action : utf8_encode($action);
  46         }
  47     }
  48
  49     private function add(array &$entry, $sizef = 'rows', $timef = 'exectime', $errorf = 'error')
  50     {
  51         $trace = array();
  52         $trace['action'] = $this->fixCharset($entry['action']);
  53         unset($entry['action']);
  54         $trace['exectime'] = @$entry[$timef];
  55         $this->totaltime += $trace['exectime'];
  56         unset($entry[$timef]);
  57         $trace['rows'] = @$entry[$sizef];
  58         unset($entry[$sizef]);
  59         $trace['error'] = $this->fixCharset(@$entry[$errorf]);
  60         unset($entry[$errorf]);
  61         if ($trace['error']) {
  62             $this->error = true;
  63         }
  64         $trace['data'] = array($this->fixCharset($entry));
  65         $this->traces[] =& $trace;
  66     }
  67
  68     public function newEvent($action, $rows = 0, $error = null, array $userdata = array())
  69     {
  70         $trace = array('action' => $this->fixCharset($action), 'time' => 0);
  71         $this->traces[] =& $trace;
  72         $this->update($rows, $error, $userdata);
  73     }
  74
  75     public function start($action)
  76     {
  77         $this->traces[] =  array('action' => $this->fixCharset($action), 'starttime' => microtime(true));;
  78     }
  79
  80     public function stop($rows = 0, $error = null, array $userdata = array())
  81     {
  82         $time = microtime(true);
  83         if (!$this->traces) {
  84             return;
  85         }
  86         $trace =& $this->traces[count($this->traces) - 1];
  87         $trace['exectime'] = $time - $trace['starttime'];
  88         unset($trace['starttime']);
  89         $this->totaltime += $trace['exectime'];
  90         $this->update($rows, $error, $userdata);
  91     }
  92
  93     public function update($rows = 0, $error = null, array $userdata = array())
  94     {
  95         $trace =& $this->traces[count($this->traces) - 1];
  96         $trace['rows']  = $rows;
  97         $trace['error'] = $this->fixCharset($error);
  98         array_walk_recursive($userdata, array($this, 'fixCharset'));
  99         $trace['data']  = $userdata;
 100         if ($trace['error']) {
 101             $this->error = true;
 102         }
 103     }
 104
 105     public static function clean()
 106     {
 107         foreach (PlBacktrace::$bt as $name=>&$entry) {
 108             if (!$entry->traces) {
 109                 unset(PlBacktrace::$bt[$name]);
 110             }
 111         }
 112     }
 113 }
 114
 115 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 116 ?>