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
|
<?php
/**
* $Id: XmlLogger.php,v 1.3 2005/02/11 10:51:21 mrook Exp $
*
* 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/listener/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 <michiel@trendserver.nl>
* @version $Id: XmlLogger.php,v 1.3 2005/02/11 10:51:21 mrook Exp $
* @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";
private $doc = NULL;
private $buildStartTime = 0;
private $targetStartTime = 0;
private $taskStartTime = 0;
private $buildElement = NULL;
private $msgOutputLevel = PROJECT_MSG_DEBUG;
/**
* Constructs a new BuildListener that logs build events to an XML file.
*/
function __construct()
{
$this->doc = new DOMDocument();
$this->doc->formatOutput = true;
$this->buildTimer = new Timer();
$this->targetTimer = new Timer();
$this->taskTimer = new Timer();
}
/**
* 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);
}
/**
* 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 An event with any relevant extra information.
* Will not be <code>null</code>.
*/
function buildFinished(BuildEvent $event)
{
$this->buildTimer->stop();
$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()->toString());
$errText = $this->doc->createCDATASection($event->getException()->getTraceAsString());
$stacktrace = $this->doc->createElement(XmlLogger::STACKTRACE_TAG);
$stacktrace->appendChild($errText);
$this->buildElement->appendChild($stacktrace);
}
$outFilename = $event->getProject()->getProperty("XmlLogger.file");
if ($outFilename == "")
{
$outFilename = "log.xml";
}
$writer = new FileWriter($outFilename);
$writer->write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
$writer->write($this->doc->saveXML($this->buildElement));
$writer->close();
}
/**
* Fired when a target starts building, remembers the current time and the name of the target.
*
* @param BuildEvent An event with any relevant extra information.
* Will not be <code>null</code>.
*/
function targetStarted(BuildEvent $event)
{
$target = $event->getTarget();
$this->targetTimerStart = Phing::currentTimeMillis();
$this->targetElement = $this->doc->createElement(XmlLogger::TARGET_TAG);
$this->targetElement->setAttribute(XmlLogger::NAME_ATTR, $target->getName());
}
/**
* Fired when a target finishes building, this adds the time taken
* to the appropriate target element in the log.
*
* @param BuildEvent An event with any relevant extra information.
* Will not be <code>null</code>.
*/
function targetFinished(BuildEvent $event)
{
$target = $event->getTarget();
$elapsedTime = Phing::currentTimeMillis() - $this->targetTimerStart;
$this->targetElement->setAttribute(XmlLogger::TIME_ATTR, DefaultLogger::_formatTime($elapsedTime));
$this->buildElement->appendChild($this->targetElement);
}
/**
* Fired when a task starts building, remembers the current time and the name of the task.
*
* @param BuildEvent An event with any relevant extra information.
* Will not be <code>null</code>.
*/
function taskStarted(BuildEvent $event)
{
$task = $event->getTask();
$this->taskTimerStart = Phing::currentTimeMillis();
$this->taskElement = $this->doc->createElement(XmlLogger::TASK_TAG);
$this->taskElement->setAttribute(XmlLogger::NAME_ATTR, $task->getTaskName());
$this->taskElement->setAttribute(XmlLogger::LOCATION_ATTR, $task->getLocation()->toString());
}
/**
* Fired when a task finishes building, this adds the time taken
* to the appropriate task element in the log.
*
* @param BuildEvent An event with any relevant extra information.
* Will not be <code>null</code>.
*/
function taskFinished(BuildEvent $event)
{
$task = $event->getTask();
$elapsedTime = Phing::currentTimeMillis() - $this->taskTimerStart;
$this->taskElement->setAttribute(XmlLogger::TIME_ATTR, DefaultLogger::_formatTime($elapsedTime));
$this->targetElement->appendChild($this->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>.
*/
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);
$messageText = $this->doc->createCDATASection($event->getMessage());
$messageElement->appendChild($messageText);
if ($event->getTask() != null)
{
$this->taskElement->appendChild($messageElement);
}
else
if ($event->getTarget() != null)
{
$this->targetElement->appendChild($messageElement);
}
else
if ($this->buildElement != null)
{
$this->buildElement->appendChild($messageElement);
}
}
/**
* Set the logging level when using this as a Logger
*/
function setMessageOutputLevel($level)
{
$this->msgOutputLevel = $level;
}
};
?>
|
