3 * package.xml parsing class, package.xml version 1.0
9 * @author Greg Beaver <cellog@php.net>
10 * @copyright 1997-2009 The Authors
11 * @license http://opensource.org/licenses/bsd-license.php New BSD License
12 * @link http://pear.php.net/package/PEAR
13 * @since File available since Release 1.4.0a1
16 * package.xml abstraction class
18 require_once 'PEAR/PackageFile/v1.php';
20 * Parser for package.xml version 1.0
23 * @author Greg Beaver <cellog@php.net>
24 * @copyright 1997-2009 The Authors
25 * @license http://opensource.org/licenses/bsd-license.php New BSD License
26 * @version Release: @PEAR-VER@
27 * @link http://pear.php.net/package/PEAR
28 * @since Class available since Release 1.4.0a1
30 class PEAR_PackageFile_Parser_v1
36 * BC hack to allow PEAR_Common::infoFromString() to sort of
37 * work with the version 2.0 format - there's no filelist though
38 * @param PEAR_PackageFile_v2
40 function fromV2($packagefile)
42 $info = $packagefile->getArray(true);
43 $ret = new PEAR_PackageFile_v1;
44 $ret->fromArray($info['old']);
47 function setConfig(&$c)
50 $this->_registry = &$c->getRegistry();
53 function setLogger(&$l)
59 * @param string contents of package.xml file, version 1.0
60 * @return bool success of parsing
62 function &parse($data, $file, $archive = false)
64 if (!extension_loaded('xml')) {
65 return PEAR::raiseError('Cannot create xml parser for parsing package.xml, no xml extension');
67 $xp = xml_parser_create();
69 $a = &PEAR::raiseError('Cannot create xml parser for parsing package.xml');
72 xml_set_object($xp, $this);
73 xml_set_element_handler($xp, '_element_start_1_0', '_element_end_1_0');
74 xml_set_character_data_handler($xp, '_pkginfo_cdata_1_0');
75 xml_parser_set_option($xp, XML_OPTION_CASE_FOLDING, false);
77 $this->element_stack = array();
78 $this->_packageInfo = array('provides' => array());
79 $this->current_element = false;
80 unset($this->dir_install);
81 $this->_packageInfo['filelist'] = array();
82 $this->filelist =& $this->_packageInfo['filelist'];
83 $this->dir_names = array();
84 $this->in_changelog = false;
87 $this->_isValid = true;
89 if (!xml_parse($xp, $data, 1)) {
90 $code = xml_get_error_code($xp);
91 $line = xml_get_current_line_number($xp);
93 $a = PEAR::raiseError(sprintf("XML error: %s at line %d",
94 $str = xml_error_string($code), $line), 2);
100 $pf = new PEAR_PackageFile_v1;
101 $pf->setConfig($this->_config);
102 if (isset($this->_logger)) {
103 $pf->setLogger($this->_logger);
105 $pf->setPackagefile($file, $archive);
106 $pf->fromArray($this->_packageInfo);
112 * Unindent given string
114 * @param string $str The string that has to be unindented.
118 function _unIndent($str)
120 // remove leading newlines
121 $str = preg_replace('/^[\r\n]+/', '', $str);
122 // find whitespace at the beginning of the first line
123 $indent_len = strspn($str, " \t");
124 $indent = substr($str, 0, $indent_len);
126 // remove the same amount of whitespace from following lines
127 foreach (explode("\n", $str) as $line) {
128 if (substr($line, 0, $indent_len) == $indent) {
129 $data .= substr($line, $indent_len) . "\n";
130 } elseif (trim(substr($line, 0, $indent_len))) {
131 $data .= ltrim($line);
137 // Support for package DTD v1.0:
138 // {{{ _element_start_1_0()
141 * XML parser callback for ending elements. Used for version 1.0
144 * @param resource $xp XML parser resource
145 * @param string $name name of ending element
151 function _element_start_1_0($xp, $name, $attribs)
153 array_push($this->element_stack, $name);
154 $this->current_element = $name;
155 $spos = sizeof($this->element_stack) - 2;
156 $this->prev_element = ($spos >= 0) ? $this->element_stack[$spos] : '';
157 $this->current_attributes = $attribs;
161 if ($this->in_changelog) {
164 if (array_key_exists('name', $attribs) && $attribs['name'] != '/') {
165 $attribs['name'] = preg_replace(array('!\\\\+!', '!/+!'), array('/', '/'),
167 if (strrpos($attribs['name'], '/') === strlen($attribs['name']) - 1) {
168 $attribs['name'] = substr($attribs['name'], 0,
169 strlen($attribs['name']) - 1);
171 if (strpos($attribs['name'], '/') === 0) {
172 $attribs['name'] = substr($attribs['name'], 1);
174 $this->dir_names[] = $attribs['name'];
176 if (isset($attribs['baseinstalldir'])) {
177 $this->dir_install = $attribs['baseinstalldir'];
179 if (isset($attribs['role'])) {
180 $this->dir_role = $attribs['role'];
184 if ($this->in_changelog) {
187 if (isset($attribs['name'])) {
189 if (count($this->dir_names)) {
190 foreach ($this->dir_names as $dir) {
194 $path .= preg_replace(array('!\\\\+!', '!/+!'), array('/', '/'),
196 unset($attribs['name']);
197 $this->current_path = $path;
198 $this->filelist[$path] = $attribs;
199 // Set the baseinstalldir only if the file don't have this attrib
200 if (!isset($this->filelist[$path]['baseinstalldir']) &&
201 isset($this->dir_install))
203 $this->filelist[$path]['baseinstalldir'] = $this->dir_install;
206 if (!isset($this->filelist[$path]['role']) && isset($this->dir_role)) {
207 $this->filelist[$path]['role'] = $this->dir_role;
212 if (!$this->in_changelog) {
213 $this->filelist[$this->current_path]['replacements'][] = $attribs;
217 $this->_packageInfo['maintainers'] = array();
218 $this->m_i = 0; // maintainers array index
221 // compatibility check
222 if (!isset($this->_packageInfo['maintainers'])) {
223 $this->_packageInfo['maintainers'] = array();
226 $this->_packageInfo['maintainers'][$this->m_i] = array();
227 $this->current_maintainer =& $this->_packageInfo['maintainers'][$this->m_i];
230 $this->_packageInfo['changelog'] = array();
231 $this->c_i = 0; // changelog array index
232 $this->in_changelog = true;
235 if ($this->in_changelog) {
236 $this->_packageInfo['changelog'][$this->c_i] = array();
237 $this->current_release = &$this->_packageInfo['changelog'][$this->c_i];
239 $this->current_release = &$this->_packageInfo;
243 if (!$this->in_changelog) {
244 $this->_packageInfo['release_deps'] = array();
248 // dependencies array index
249 if (!$this->in_changelog) {
251 isset($attribs['type']) ? ($attribs['type'] = strtolower($attribs['type'])) : false;
252 $this->_packageInfo['release_deps'][$this->d_i] = $attribs;
255 case 'configureoptions':
256 if (!$this->in_changelog) {
257 $this->_packageInfo['configure_options'] = array();
260 case 'configureoption':
261 if (!$this->in_changelog) {
262 $this->_packageInfo['configure_options'][] = $attribs;
266 if (empty($attribs['type']) || empty($attribs['name'])) {
269 $attribs['explicit'] = true;
270 $this->_packageInfo['provides']["$attribs[type];$attribs[name]"] = $attribs;
273 if (isset($attribs['version'])) {
274 $this->_packageInfo['xsdversion'] = trim($attribs['version']);
276 $this->_packageInfo['xsdversion'] = '1.0';
278 if (isset($attribs['packagerversion'])) {
279 $this->_packageInfo['packagerversion'] = $attribs['packagerversion'];
286 // {{{ _element_end_1_0()
289 * XML parser callback for ending elements. Used for version 1.0
292 * @param resource $xp XML parser resource
293 * @param string $name name of ending element
299 function _element_end_1_0($xp, $name)
301 $data = trim($this->cdata);
304 switch ($this->prev_element) {
306 $this->_packageInfo['package'] = $data;
309 $this->current_maintainer['name'] = $data;
314 $this->_packageInfo['extends'] = $data;
317 $this->_packageInfo['summary'] = $data;
320 $data = $this->_unIndent($this->cdata);
321 $this->_packageInfo['description'] = $data;
324 $this->current_maintainer['handle'] = $data;
327 $this->current_maintainer['email'] = $data;
330 $this->current_maintainer['role'] = $data;
333 if ($this->in_changelog) {
334 $this->current_release['version'] = $data;
336 $this->_packageInfo['version'] = $data;
340 if ($this->in_changelog) {
341 $this->current_release['release_date'] = $data;
343 $this->_packageInfo['release_date'] = $data;
347 // try to "de-indent" release notes in case someone
348 // has been over-indenting their xml ;-)
349 // Trim only on the right side
350 $data = rtrim($this->_unIndent($this->cdata));
351 if ($this->in_changelog) {
352 $this->current_release['release_notes'] = $data;
354 $this->_packageInfo['release_notes'] = $data;
358 if ($this->in_changelog) {
359 $this->current_release['release_warnings'] = $data;
361 $this->_packageInfo['release_warnings'] = $data;
365 if ($this->in_changelog) {
366 $this->current_release['release_state'] = $data;
368 $this->_packageInfo['release_state'] = $data;
372 if ($this->in_changelog) {
373 $this->current_release['release_license'] = $data;
375 $this->_packageInfo['release_license'] = $data;
379 if ($data && !$this->in_changelog) {
380 $this->_packageInfo['release_deps'][$this->d_i]['name'] = $data;
384 if ($this->in_changelog) {
387 array_pop($this->dir_names);
390 if ($this->in_changelog) {
395 if (count($this->dir_names)) {
396 foreach ($this->dir_names as $dir) {
401 $this->filelist[$path] = $this->current_attributes;
402 // Set the baseinstalldir only if the file don't have this attrib
403 if (!isset($this->filelist[$path]['baseinstalldir']) &&
404 isset($this->dir_install))
406 $this->filelist[$path]['baseinstalldir'] = $this->dir_install;
409 if (!isset($this->filelist[$path]['role']) && isset($this->dir_role)) {
410 $this->filelist[$path]['role'] = $this->dir_role;
415 if (empty($this->_packageInfo['maintainers'][$this->m_i]['role'])) {
416 $this->_packageInfo['maintainers'][$this->m_i]['role'] = 'lead';
421 if ($this->in_changelog) {
426 $this->in_changelog = false;
429 array_pop($this->element_stack);
430 $spos = sizeof($this->element_stack) - 1;
431 $this->current_element = ($spos > 0) ? $this->element_stack[$spos] : '';
436 // {{{ _pkginfo_cdata_1_0()
439 * XML parser callback for character data. Used for version 1.0
442 * @param resource $xp XML parser resource
443 * @param string $name character data
449 function _pkginfo_cdata_1_0($xp, $data)
451 if (isset($this->cdata)) {
452 $this->cdata .= $data;