debug_logger.php
4.9 KB
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
<?php
/**
* Debug Logger
*
* Enhanced logging for debugging purposes. It is not recommended
* to be enabled on production systems without testing because of
* the somewhat increased memory, cpu and disk i/o overhead.
*
* Debug Logger listens for existing rcube::console() calls and
* introduces start and end tags as well as free form tagging
* which can redirect messages to files. The resulting log files
* provide timing and tag quantity results.
*
* Enable the plugin in config.inc.php and add your desired
* log types and files.
*
* @author Ziba Scott
* @website http://roundcube.net
*
* Example:
*
* // $config['debug_logger'][type of logging] = name of file in log_dir
* // The 'master' log includes timing information
* $config['debug_logger']['master'] = 'master';
* // If you want sql messages to also go into a separate file
* $config['debug_logger']['sql'] = 'sql';
*
* index.php (just after $RCMAIL->plugins->init()):
*
* rcube::console("my test","start");
* rcube::console("my message");
* rcube::console("my sql calls","start");
* rcube::console("cp -r * /dev/null","shell exec");
* rcube::console("select * from example","sql");
* rcube::console("select * from example","sql");
* rcube::console("select * from example","sql");
* rcube::console("end");
* rcube::console("end");
*
* logs/master (after reloading the main page):
*
* [17-Feb-2009 16:51:37 -0500] start: Task: mail.
* [17-Feb-2009 16:51:37 -0500] start: my test
* [17-Feb-2009 16:51:37 -0500] my message
* [17-Feb-2009 16:51:37 -0500] shell exec: cp -r * /dev/null
* [17-Feb-2009 16:51:37 -0500] start: my sql calls
* [17-Feb-2009 16:51:37 -0500] sql: select * from example
* [17-Feb-2009 16:51:37 -0500] sql: select * from example
* [17-Feb-2009 16:51:37 -0500] sql: select * from example
* [17-Feb-2009 16:51:37 -0500] end: my sql calls - 0.0018 seconds shell exec: 1, sql: 3,
* [17-Feb-2009 16:51:37 -0500] end: my test - 0.0055 seconds shell exec: 1, sql: 3,
* [17-Feb-2009 16:51:38 -0500] end: Task: mail. - 0.8854 seconds shell exec: 1, sql: 3,
*
* logs/sql (after reloading the main page):
*
* [17-Feb-2009 16:51:37 -0500] sql: select * from example
* [17-Feb-2009 16:51:37 -0500] sql: select * from example
* [17-Feb-2009 16:51:37 -0500] sql: select * from example
*/
class debug_logger extends rcube_plugin
{
protected $runlog;
function init()
{
require_once(__DIR__ . '/runlog/runlog.php');
$this->runlog = new runlog();
if (!rcmail::get_instance()->config->get('log_dir')) {
rcmail::get_instance()->config->set('log_dir', INSTALL_PATH . 'logs');
}
$log_config = rcmail::get_instance()->config->get('debug_logger', []);
$log_dir = rcmail::get_instance()->config->get('log_dir');
foreach ($log_config as $type => $file) {
$this->runlog->set_file($log_dir . '/' . $file, $type);
}
$start_string = '';
$action = rcmail::get_instance()->action;
$task = rcmail::get_instance()->task;
if ($action) {
$start_string .= "Action: {$action}. ";
}
if ($task) {
$start_string .= "Task: {$task}. ";
}
$this->runlog->start($start_string);
$this->add_hook('console', [$this, 'console']);
$this->add_hook('authenticate', [$this, 'authenticate']);
}
function authenticate($args)
{
$this->runlog->note('Authenticating '.$args['user'].'@'.$args['host']);
return $args;
}
function console($args)
{
$note = $args['args'][0];
if (!empty($args['args'][1])) {
$type = $args['args'][1];
}
else {
// This could be extended to detect types based on the
// file which called console. For now only rcube_imap/rcube_storage is supported
$bt = debug_backtrace();
$file = count($bt) >= 2 ? $bt[2]['file'] : '';
switch (basename($file)) {
case 'rcube_imap.php':
$type = 'imap';
break;
case 'rcube_storage.php':
$type = 'storage';
break;
default:
$type = false;
break;
}
}
switch ($note) {
case 'end':
$type = 'end';
break;
}
switch ($type) {
case 'start':
$this->runlog->start($note);
break;
case 'end':
$this->runlog->end();
break;
default:
$this->runlog->note($note, $type);
break;
}
return $args;
}
function __destruct()
{
if ($this->runlog) {
$this->runlog->end();
}
}
}