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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
|
<?php
/**
* $Id: aaf7d77e9952319b9598d786c556be005d34c188 $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
require_once 'phing/BuildLogger.php';
require_once 'phing/listener/DefaultLogger.php';
require_once 'phing/system/util/Timer.php';
/**
* Generates a file in the current directory with
* an XML description of what happened during a build.
* The default filename is "log.xml", but this can be overridden
* with the property <code>XmlLogger.file</code>.
*
* @author Michiel Rook <mrook@php.net>
* @version $Id: aaf7d77e9952319b9598d786c556be005d34c188 $
* @package phing.listener
*/
class XmlLogger implements BuildLogger {
/** XML element name for a build. */
const BUILD_TAG = "build";
/** XML element name for a target. */
const TARGET_TAG = "target";
/** XML element name for a task. */
const TASK_TAG = "task";
/** XML element name for a message. */
const MESSAGE_TAG = "message";
/** XML attribute name for a name. */
const NAME_ATTR = "name";
/** XML attribute name for a time. */
const TIME_ATTR = "time";
/** XML attribute name for a message priority. */
const PRIORITY_ATTR = "priority";
/** XML attribute name for a file location. */
const LOCATION_ATTR = "location";
/** XML attribute name for an error description. */
const ERROR_ATTR = "error";
/** XML element name for a stack trace. */
const STACKTRACE_TAG = "stacktrace";
/**
* @var DOMDocument The XML document created by this logger.
*/
private $doc;
/**
* @var int Start time for entire build.
*/
private $buildTimerStart = 0;
/**
* @var DOMElement Top-level (root) build element
*/
private $buildElement;
/**
* @var array DOMElement[] The parent of the element being processed.
*/
private $elementStack = array();
/**
* @var array int[] Array of millisecond times for the various elements being processed.
*/
private $timesStack = array();
/**
* @var int
*/
private $msgOutputLevel = Project::MSG_DEBUG;
/**
* @var OutputStream Stream to use for standard output.
*/
private $out;
/**
* @var OutputStream Stream to use for error output.
*/
private $err;
/**
* @var string Name of filename to create.
*/
private $outFilename;
/**
* Constructs a new BuildListener that logs build events to an XML file.
*/
public function __construct() {
$this->doc = new DOMDocument("1.0", "UTF-8");
$this->doc->formatOutput = true;
}
/**
* Fired when the build starts, this builds the top-level element for the
* document and remembers the time of the start of the build.
*
* @param BuildEvent Ignored.
*/
function buildStarted(BuildEvent $event) {
$this->buildTimerStart = Phing::currentTimeMillis();
$this->buildElement = $this->doc->createElement(XmlLogger::BUILD_TAG);
array_push($this->elementStack, $this->buildElement);
array_push($this->timesStack, $this->buildTimerStart);
}
/**
* Fired when the build finishes, this adds the time taken and any
* error stacktrace to the build element and writes the document to disk.
*
* @param BuildEvent $event An event with any relevant extra information.
* Will not be <code>null</code>.
*/
public function buildFinished(BuildEvent $event) {
$elapsedTime = Phing::currentTimeMillis() - $this->buildTimerStart;
$this->buildElement->setAttribute(XmlLogger::TIME_ATTR, DefaultLogger::formatTime($elapsedTime));
if ($event->getException() != null) {
$this->buildElement->setAttribute(XmlLogger::ERROR_ATTR, $event->getException()->getMessage());
$errText = $this->doc->createCDATASection($event->getException()->getTraceAsString());
$stacktrace = $this->doc->createElement(XmlLogger::STACKTRACE_TAG);
$stacktrace->appendChild($errText);
$this->buildElement->appendChild($stacktrace);
}
$this->doc->appendChild($this->buildElement);
$outFilename = $event->getProject()->getProperty("XmlLogger.file");
if ($outFilename == null) {
$outFilename = "log.xml";
}
try {
$stream = $this->out;
if ($stream === null) {
$stream = new FileOutputStream($outFilename);
}
// Yes, we could just stream->write() but this will eventually be the better
// way to do this (when we need to worry about charset conversions.
$writer = new OutputStreamWriter($stream);
$writer->write($this->doc->saveXML());
$writer->close();
} catch (IOException $exc) {
try {
$stream->close(); // in case there is a stream open still ...
} catch (Exception $x) {}
throw new BuildException("Unable to write log file.", $exc);
}
// cleanup:remove the buildElement
$this->buildElement = null;
array_pop($this->elementStack);
array_pop($this->timesStack);
}
/**
* Fired when a target starts building, remembers the current time and the name of the target.
*
* @param BuildEvent $event An event with any relevant extra information.
* Will not be <code>null</code>.
*/
public function targetStarted(BuildEvent $event) {
$target = $event->getTarget();
$targetElement = $this->doc->createElement(XmlLogger::TARGET_TAG);
$targetElement->setAttribute(XmlLogger::NAME_ATTR, $target->getName());
array_push($this->timesStack, Phing::currentTimeMillis());
array_push($this->elementStack, $targetElement);
}
/**
* Fired when a target finishes building, this adds the time taken
* to the appropriate target element in the log.
*
* @param BuildEvent $event An event with any relevant extra information.
* Will not be <code>null</code>.
*/
public function targetFinished(BuildEvent $event) {
$targetTimerStart = array_pop($this->timesStack);
$targetElement = array_pop($this->elementStack);
$elapsedTime = Phing::currentTimeMillis() - $targetTimerStart;
$targetElement->setAttribute(XmlLogger::TIME_ATTR, DefaultLogger::formatTime($elapsedTime));
$parentElement = $this->elementStack[ count($this->elementStack) - 1 ];
$parentElement->appendChild($targetElement);
}
/**
* Fired when a task starts building, remembers the current time and the name of the task.
*
* @param BuildEvent $event An event with any relevant extra information.
* Will not be <code>null</code>.
*/
public function taskStarted(BuildEvent $event) {
$task = $event->getTask();
$taskElement = $this->doc->createElement(XmlLogger::TASK_TAG);
$taskElement->setAttribute(XmlLogger::NAME_ATTR, $task->getTaskName());
$taskElement->setAttribute(XmlLogger::LOCATION_ATTR, $task->getLocation()->toString());
array_push($this->timesStack, Phing::currentTimeMillis());
array_push($this->elementStack, $taskElement);
}
/**
* Fired when a task finishes building, this adds the time taken
* to the appropriate task element in the log.
*
* @param BuildEvent $event An event with any relevant extra information.
* Will not be <code>null</code>.
*/
public function taskFinished(BuildEvent $event) {
$taskTimerStart = array_pop($this->timesStack);
$taskElement = array_pop($this->elementStack);
$elapsedTime = Phing::currentTimeMillis() - $taskTimerStart;
$taskElement->setAttribute(XmlLogger::TIME_ATTR, DefaultLogger::formatTime($elapsedTime));
$parentElement = $this->elementStack[ count($this->elementStack) - 1 ];
$parentElement->appendChild($taskElement);
}
/**
* Fired when a message is logged, this adds a message element to the
* most appropriate parent element (task, target or build) and records
* the priority and text of the message.
*
* @param BuildEvent An event with any relevant extra information.
* Will not be <code>null</code>.
*/
public function messageLogged(BuildEvent $event)
{
$priority = $event->getPriority();
if ($priority > $this->msgOutputLevel) {
return;
}
$messageElement = $this->doc->createElement(XmlLogger::MESSAGE_TAG);
switch ($priority) {
case Project::MSG_ERR:
$name = "error";
break;
case Project::MSG_WARN:
$name = "warn";
break;
case Project::MSG_INFO:
$name = "info";
break;
default:
$name = "debug";
break;
}
$messageElement->setAttribute(XmlLogger::PRIORITY_ATTR, $name);
if (function_exists('mb_convert_encoding'))
{
$messageConverted = mb_convert_encoding($event->getMessage(), 'UTF-8');
}
else
{
$messageConverted = utf8_encode($event->getMessage());
}
$messageText = $this->doc->createCDATASection($messageConverted);
$messageElement->appendChild($messageText);
if (!empty($this->elementStack)) {
$this->elementStack[count($this->elementStack)-1]->appendChild($messageElement);
}
}
/**
* Set the msgOutputLevel this logger is to respond to.
*
* Only messages with a message level lower than or equal to the given
* level are output to the log.
*
* <p> Constants for the message levels are in Project.php. The order of
* the levels, from least to most verbose, is:
*
* <ul>
* <li>Project::MSG_ERR</li>
* <li>Project::MSG_WARN</li>
* <li>Project::MSG_INFO</li>
* <li>Project::MSG_VERBOSE</li>
* <li>Project::MSG_DEBUG</li>
* </ul>
*
* The default message level for DefaultLogger is Project::MSG_ERR.
*
* @param int $level The logging level for the logger.
* @see BuildLogger#setMessageOutputLevel()
*/
public function setMessageOutputLevel($level) {
$this->msgOutputLevel = (int) $level;
}
/**
* Sets the output stream.
* @param OutputStream $output
* @see BuildLogger#setOutputStream()
*/
public function setOutputStream(OutputStream $output) {
$this->out = $output;
}
/**
* Sets the error stream.
* @param OutputStream $err
* @see BuildLogger#setErrorStream()
*/
public function setErrorStream(OutputStream $err) {
$this->err = $err;
}
}
|