-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
XML.php
283 lines (272 loc) · 10.4 KB
/
XML.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
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
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
/**
* VersionControl_SVN_Info allows for XML formatted output. XML_Parser is used to
* manipulate that output.
*
* +----------------------------------------------------------------------+
* | This LICENSE is in the BSD license style. |
* | http://www.opensource.org/licenses/bsd-license.php |
* | |
* | Redistribution and use in source and binary forms, with or without |
* | modification, are permitted provided that the following conditions |
* | are met: |
* | |
* | * Redistributions of source code must retain the above copyright |
* | notice, this list of conditions and the following disclaimer. |
* | |
* | * Redistributions in binary form must reproduce the above |
* | copyright notice, this list of conditions and the following |
* | disclaimer in the documentation and/or other materials provided |
* | with the distribution. |
* | |
* | * Neither the name of Clay Loveless nor the names of contributors |
* | may be used to endorse or promote products derived from this |
* | software without specific prior written permission. |
* | |
* | 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. |
* +----------------------------------------------------------------------+
*
* PHP version 5
*
* @category VersionControl
* @package VersionControl_SVN
* @author Alexander Opitz <opitz.alexander@gmail.com>
* @copyright 2012 Alexander Opitz
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @link http://pear.php.net/package/VersionControl_SVN
*/
require_once 'VersionControl/SVN/Parser/Exception.php';
/**
* Class VersionControl_SVN_Parser_Info - XML Parser for Subversion Info output
*
* @category VersionControl
* @package VersionControl_SVN
* @author Alexander Opitz <opitz.alexander@gmail.com>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version @version@
* @link http://pear.php.net/package/VersionControl_SVN
*/
class VersionControl_SVN_Parser_XML
{
/**
* @var array $xmlPathConfig The XML configuration (like a DTD).
*/
protected $xmlPathConfig = array();
/**
* Parses given xml by xmlPathConfig of this class.
*
* @param string $xml The XML as string.
*
* @return array The processed xml as array.
* @throws VersionControl_SVN_Parser_Exception If XML isn't parseable.
*/
public function getParsed($xml)
{
$reader = new XMLReader();
$reader->xml($xml);
if (false === $reader) {
throw new VersionControl_SVN_Parser_Exception(
'Cannot instantiate XMLReader'
);
}
$data = self::getParsedBody(
$reader, $this->xmlPathConfig
);
$reader->close();
return $data;
}
/**
* Function to read out the xml body element.
*
* @param XMLReader $reader Instance of the XMLReader.
* @param array $xmlPathConfig Configuration for this XML file.
*
* @return array The data parsed from XML
* @throws VersionControl_SVN_Parser_Exception If XML doesn't match config.
*/
protected static function getParsedBody(
XMLReader $reader, array $xmlPathConfig
) {
$xmlBodyEntry = key($xmlPathConfig);
while ($reader->read()) {
if (XMLReader::ELEMENT === $reader->nodeType
&& $xmlBodyEntry === $reader->name
) {
return self::getParsedEntry(
$reader, $xmlBodyEntry, $xmlPathConfig[$xmlBodyEntry]
);
}
}
throw new VersionControl_SVN_Parser_Exception(
'XML ends before body end tag.'
);
}
/**
* Function to read out the xml entry element.
*
* @param XMLReader $reader Instance of the XMLReader.
* @param string $xmlEntry Name of the entry.
* @param array $xmlPathConfig Configuration for this XML file.
*
* @return array The data parsed from XML
* @throws VersionControl_SVN_Parser_Exception If XML doesn't match config.
*/
protected static function getParsedEntry(
XMLReader $reader, $xmlEntry, array $xmlPathConfig
) {
// @var array $data The array of entry data
$data = array();
while ($reader->read()) {
if (XMLReader::ELEMENT === $reader->nodeType
) {
if (isset($xmlPathConfig['path'][$reader->name])) {
$config = $xmlPathConfig['path'][$reader->name];
$elementData = self::getParsedElement(
$reader,
$reader->name,
$config
);
if (isset($config['quantifier'])
&& ($config['quantifier'] == '+'
|| $config['quantifier'] == '*')
) {
$data[$reader->name][] = $elementData;
} else {
$data[$reader->name] = $elementData;
}
} else {
self::parseBlindEntry($reader, $reader->name);
}
}
if (XMLReader::END_ELEMENT === $reader->nodeType
&& $xmlEntry === $reader->name
) {
return $data;
}
}
throw new VersionControl_SVN_Parser_Exception(
'XML ends before entry end tag. 2'
);
}
/**
* Function to read out the xml element.
*
* @param XMLReader $reader Instance of the XMLReader.
* @param string $xmlEntry Name of the entry.
* @param array $xmlPathConfig Configuration for this XML file.
*
* @return array The data parsed from XML
* @throws VersionControl_SVN_Parser_Exception If XML doesn't match config.
*/
protected static function getParsedElement(
XMLReader $reader, $xmlEntry, array $xmlPathConfig
) {
// @var array $data The array of element data
$data = array();
if (isset($xmlPathConfig['attribute'])) {
foreach($xmlPathConfig['attribute'] as $attribute) {
$data[$attribute] = $reader->getAttribute($attribute);
}
}
if ($reader->isEmptyElement) {
return $data;
}
if (isset($xmlPathConfig['config'])
&& 'string' === $xmlPathConfig['config']
) {
if (count($data) > 0) {
$data = array_merge(
array('text' => self::getParsedString($reader, $xmlEntry)),
$data
);
} else {
$data = self::getParsedString($reader, $xmlEntry);
}
} else {
$data = array_merge(
self::getParsedEntry($reader, $xmlEntry, $xmlPathConfig),
$data
);
}
return $data;
}
/**
* Function to read out a string from a XML entry.
*
* @param XMLReader $reader Instance of the XMLReader.
* @param string $xmlEntry Name of the entry.
*
* @return string The string which should be read.
* @throws VersionControl_SVN_Parser_Exception If XML doesn't match config.
*/
protected static function getParsedString(
XMLReader $reader, $xmlEntry
) {
// @var string|null $data The text from an entry.
$data = null;
if ($reader->isEmptyElement) {
return $data;
}
while ($reader->read()) {
if (XMLReader::ELEMENT === $reader->nodeType
) {
self::parseBlindEntry($reader, $reader->name);
}
if (XMLReader::TEXT === $reader->nodeType
) {
$data = $reader->value;
}
if (XMLReader::END_ELEMENT === $reader->nodeType
&& $xmlEntry === $reader->name
) {
return $data;
}
}
throw new VersionControl_SVN_Parser_Exception(
'XML ends before entry end tag. 3'
);
}
/**
* Function to read out all XML entries, which aren't configured.
*
* @param XMLReader $reader Instance of the XMLReader.
* @param string $xmlEntry Name of the entry.
*
* @return void
* @throws VersionControl_SVN_Parser_Exception If XML doesn't match config.
*/
protected static function parseBlindEntry(
XMLReader $reader, $xmlEntry
) {
if ($reader->isEmptyElement) {
return;
}
while ($reader->read()) {
if (XMLReader::ELEMENT === $reader->nodeType
) {
self::parseBlindEntry($reader, $reader->name);
}
if (XMLReader::END_ELEMENT === $reader->nodeType
&& $xmlEntry === $reader->name
) {
return;
}
}
throw new VersionControl_SVN_Parser_Exception(
'XML ends before entry end tag. 4'
);
}
}
?>