Merge pull request #11 from bessl/patch-2
[gitphp.git] / include / DebugLog.class.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<?php
/**
 * Debug logging class
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 */
class GitPHP_DebugLog implements GitPHP_Observer_Interface
{
        /**
         * Stores whether logging is enabled
         *
         * @var boolean
         */
        protected $enabled = false;
 
        /**
         * Stores whether benchmarking is enabled
         *
         * @var boolean
         */
        protected $benchmark = false;
 
        /**
         * Stores the starting instant
         *
         * @var float
         */
        protected $startTime;
 
        /**
         * Stores the starting memory
         *
         * @var int
         */
        protected $startMem;
 
        /**
         * Stores the log entries
         *
         * @var string[]
         */
        protected $entries = array();
 
        /**
         * Stores the timers
         *
         * @var float[]
         */
        protected $timers = array();
 
        /**
         * @return GitPHP_DebugLog
         */
        public static function GetInstance()
        {
                static $instance;
                if (!$instance) $instance = new self();
                return $instance;
        }
 
        /**
         * You must use GetInstance()
         */
        private function __construct()
        {
        }
 
        /**
         * Constructor
         *
         * @param boolean $enabled whether log should be enabled
         * @param boolean $benchmark whether benchmarking should be enabled
         */
        public function init($enabled = false, $benchmark = false)
        {
                $this->startTime = microtime(true);
                $this->startMem = memory_get_usage();
 
                $this->enabled = $enabled;
                $this->benchmark = $benchmark;
        }
 
        /**
         * Sets start time
         *
         * @param float $start starting microtime
         */
        public function SetStartTime($start)
        {
                $this->startTime = $start;
        }
 
        /**
         * Sets start memory
         *
         * @param integer $start starting memory
         */
        public function SetStartMemory($start)
        {
                $this->startMem = $start;
        }
 
        /**
         * Shortcut to start timer
         */
        public function TimerStart()
        {
                if (!$this->benchmark) return;
                $this->Log('', '', 'start');
        }
 
        /**
         * Shortcut to stop timer
         *
         * @param $msg
         * @param $msg_data
         */
        public function TimerStop($msg, $msg_data = '')
        {
                if (!$this->benchmark) return;
                $this->Log($msg, $msg_data, 'stop');
        }
 
        /**
         * Log an entry
         *
         * @param string $msg message to log
         */
        public function Log($msg, $msg_data = '', $type = 'ts')
        {
                if (!$this->enabled)
                        return;
 
                $entry = array();
 
                if ($type == 'start') {
                        array_push($this->timers, microtime(true));
                        return;
                } else if ($type == 'stop') {
                        $timer = array_pop($this->timers);
                        $entry['time'] = $duration = microtime(true) - $timer;
                        foreach ($this->timers as &$item) $item += $duration;
                } else {
                        if ($this->benchmark) {
                                $entry['time'] = (microtime(true) - $this->startTime);
                                $entry['reltime'] = true;
                                $entry['mem'] = memory_get_usage();
                        }
                }
 
                $entry['name'] = $msg;
                $entry['value'] = $msg_data;
                $bt = explode("\n", new Exception());
                array_shift($bt);
                array_shift($bt);
                $entry['bt'] = implode("\n", $bt);
                $this->entries[] = $entry;
        }
 
        /**
         * Gets whether logging is enabled
         *
         * @return boolean true if logging is enabled
         */
        public function GetEnabled()
        {
                return $this->enabled;
        }
 
        /**
         * Sets whether logging is enabled
         *
         * @param boolean $enable true if logging is enabled
         */
        public function SetEnabled($enable)
        {
                $this->enabled = $enable;
        }
 
        /**
         * Gets whether benchmarking is enabled
         *
         * @return boolean true if benchmarking is enabled
         */
        public function GetBenchmark()
        {
                return $this->benchmark;
        }
 
        /**
         * Sets whether benchmarking is enabled
         *
         * @param boolean $bench true if benchmarking is enabled
         */
        public function SetBenchmark($bench)
        {
                $this->benchmark = $bench;
        }
 
        /**
         * Clears the log
         */
        public function Clear()
        {
                $this->entries = array();
        }
 
        /**
         * Gets the log entries
         *
         * @return array entry data
         */
        public function GetEntries()
        {
                return $this->entries;
        }
 
        /**
         * Notify that observable object changed
         *
         * @param GitPHP_Observable_Interface $object object
         * @param int $changeType type of change
         * @param array $args argument array
         */
        public function ObjectChanged($object, $changeType, $args = array())
        {
                if ($changeType !== GitPHP_Observer_Interface::LoggableChange)
                        return;
 
                if (!$this->enabled)
                        return;
 
                if (!isset($args[0]) || empty($args[0]))
                        return;
 
                $msg = $args[0];
                $msg_data = !empty($args[1]) ? $args[1] : '';
                $type = !empty($args[2]) ? $args[2] : 'ts';
 
                $this->Log($msg, $msg_data, $type);
        }
 
}
 
comments