458 lines
16 KiB
PHP
458 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* package.xml parsing class, package.xml version 1.0
|
|
*
|
|
* PHP versions 4 and 5
|
|
*
|
|
* @category pear
|
|
* @package PEAR
|
|
* @author Greg Beaver <cellog@php.net>
|
|
* @copyright 1997-2009 The Authors
|
|
* @license http://opensource.org/licenses/bsd-license.php New BSD License
|
|
* @link http://pear.php.net/package/PEAR
|
|
* @since File available since Release 1.4.0a1
|
|
*/
|
|
/**
|
|
* package.xml abstraction class
|
|
*/
|
|
require_once 'PEAR/PackageFile/v1.php';
|
|
/**
|
|
* Parser for package.xml version 1.0
|
|
* @category pear
|
|
* @package PEAR
|
|
* @author Greg Beaver <cellog@php.net>
|
|
* @copyright 1997-2009 The Authors
|
|
* @license http://opensource.org/licenses/bsd-license.php New BSD License
|
|
* @version Release: @PEAR-VER@
|
|
* @link http://pear.php.net/package/PEAR
|
|
* @since Class available since Release 1.4.0a1
|
|
*/
|
|
class PEAR_PackageFile_Parser_v1
|
|
{
|
|
var $_registry;
|
|
var $_config;
|
|
var $_logger;
|
|
/**
|
|
* BC hack to allow PEAR_Common::infoFromString() to sort of
|
|
* work with the version 2.0 format - there's no filelist though
|
|
* @param PEAR_PackageFile_v2
|
|
*/
|
|
function fromV2($packagefile)
|
|
{
|
|
$info = $packagefile->getArray(true);
|
|
$ret = new PEAR_PackageFile_v1;
|
|
$ret->fromArray($info['old']);
|
|
}
|
|
|
|
function setConfig(&$c)
|
|
{
|
|
$this->_config = &$c;
|
|
$this->_registry = &$c->getRegistry();
|
|
}
|
|
|
|
function setLogger(&$l)
|
|
{
|
|
$this->_logger = &$l;
|
|
}
|
|
|
|
/**
|
|
* @param string contents of package.xml file, version 1.0
|
|
* @return bool success of parsing
|
|
*/
|
|
function &parse($data, $file, $archive = false)
|
|
{
|
|
if (!extension_loaded('xml')) {
|
|
return PEAR::raiseError('Cannot create xml parser for parsing package.xml, no xml extension');
|
|
}
|
|
$xp = xml_parser_create();
|
|
if (!$xp) {
|
|
$a = &PEAR::raiseError('Cannot create xml parser for parsing package.xml');
|
|
return $a;
|
|
}
|
|
xml_set_object($xp, $this);
|
|
xml_set_element_handler($xp, '_element_start_1_0', '_element_end_1_0');
|
|
xml_set_character_data_handler($xp, '_pkginfo_cdata_1_0');
|
|
xml_parser_set_option($xp, XML_OPTION_CASE_FOLDING, false);
|
|
|
|
$this->element_stack = array();
|
|
$this->_packageInfo = array('provides' => array());
|
|
$this->current_element = false;
|
|
unset($this->dir_install);
|
|
$this->_packageInfo['filelist'] = array();
|
|
$this->filelist =& $this->_packageInfo['filelist'];
|
|
$this->dir_names = array();
|
|
$this->in_changelog = false;
|
|
$this->d_i = 0;
|
|
$this->cdata = '';
|
|
$this->_isValid = true;
|
|
|
|
if (!xml_parse($xp, $data, 1)) {
|
|
$code = xml_get_error_code($xp);
|
|
$line = xml_get_current_line_number($xp);
|
|
xml_parser_free($xp);
|
|
$a = PEAR::raiseError(sprintf("XML error: %s at line %d",
|
|
$str = xml_error_string($code), $line), 2);
|
|
return $a;
|
|
}
|
|
|
|
xml_parser_free($xp);
|
|
|
|
$pf = new PEAR_PackageFile_v1;
|
|
$pf->setConfig($this->_config);
|
|
if (isset($this->_logger)) {
|
|
$pf->setLogger($this->_logger);
|
|
}
|
|
$pf->setPackagefile($file, $archive);
|
|
$pf->fromArray($this->_packageInfo);
|
|
return $pf;
|
|
}
|
|
// {{{ _unIndent()
|
|
|
|
/**
|
|
* Unindent given string
|
|
*
|
|
* @param string $str The string that has to be unindented.
|
|
* @return string
|
|
* @access private
|
|
*/
|
|
function _unIndent($str)
|
|
{
|
|
// remove leading newlines
|
|
$str = preg_replace('/^[\r\n]+/', '', $str);
|
|
// find whitespace at the beginning of the first line
|
|
$indent_len = strspn($str, " \t");
|
|
$indent = substr($str, 0, $indent_len);
|
|
$data = '';
|
|
// remove the same amount of whitespace from following lines
|
|
foreach (explode("\n", $str) as $line) {
|
|
if (substr($line, 0, $indent_len) == $indent) {
|
|
$data .= substr($line, $indent_len) . "\n";
|
|
} elseif (trim(substr($line, 0, $indent_len))) {
|
|
$data .= ltrim($line);
|
|
}
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
// Support for package DTD v1.0:
|
|
// {{{ _element_start_1_0()
|
|
|
|
/**
|
|
* XML parser callback for ending elements. Used for version 1.0
|
|
* packages.
|
|
*
|
|
* @param resource $xp XML parser resource
|
|
* @param string $name name of ending element
|
|
*
|
|
* @return void
|
|
*
|
|
* @access private
|
|
*/
|
|
function _element_start_1_0($xp, $name, $attribs)
|
|
{
|
|
array_push($this->element_stack, $name);
|
|
$this->current_element = $name;
|
|
$spos = sizeof($this->element_stack) - 2;
|
|
$this->prev_element = ($spos >= 0) ? $this->element_stack[$spos] : '';
|
|
$this->current_attributes = $attribs;
|
|
$this->cdata = '';
|
|
switch ($name) {
|
|
case 'dir':
|
|
if ($this->in_changelog) {
|
|
break;
|
|
}
|
|
if (array_key_exists('name', $attribs) && $attribs['name'] != '/') {
|
|
$attribs['name'] = preg_replace(array('!\\\\+!', '!/+!'), array('/', '/'),
|
|
$attribs['name']);
|
|
if (strrpos($attribs['name'], '/') === strlen($attribs['name']) - 1) {
|
|
$attribs['name'] = substr($attribs['name'], 0,
|
|
strlen($attribs['name']) - 1);
|
|
}
|
|
if (strpos($attribs['name'], '/') === 0) {
|
|
$attribs['name'] = substr($attribs['name'], 1);
|
|
}
|
|
$this->dir_names[] = $attribs['name'];
|
|
}
|
|
if (isset($attribs['baseinstalldir'])) {
|
|
$this->dir_install = $attribs['baseinstalldir'];
|
|
}
|
|
if (isset($attribs['role'])) {
|
|
$this->dir_role = $attribs['role'];
|
|
}
|
|
break;
|
|
case 'file':
|
|
if ($this->in_changelog) {
|
|
break;
|
|
}
|
|
if (isset($attribs['name'])) {
|
|
$path = '';
|
|
if (count($this->dir_names)) {
|
|
foreach ($this->dir_names as $dir) {
|
|
$path .= $dir . '/';
|
|
}
|
|
}
|
|
$path .= preg_replace(array('!\\\\+!', '!/+!'), array('/', '/'),
|
|
$attribs['name']);
|
|
unset($attribs['name']);
|
|
$this->current_path = $path;
|
|
$this->filelist[$path] = $attribs;
|
|
// Set the baseinstalldir only if the file don't have this attrib
|
|
if (!isset($this->filelist[$path]['baseinstalldir']) &&
|
|
isset($this->dir_install))
|
|
{
|
|
$this->filelist[$path]['baseinstalldir'] = $this->dir_install;
|
|
}
|
|
// Set the Role
|
|
if (!isset($this->filelist[$path]['role']) && isset($this->dir_role)) {
|
|
$this->filelist[$path]['role'] = $this->dir_role;
|
|
}
|
|
}
|
|
break;
|
|
case 'replace':
|
|
if (!$this->in_changelog) {
|
|
$this->filelist[$this->current_path]['replacements'][] = $attribs;
|
|
}
|
|
break;
|
|
case 'maintainers':
|
|
$this->_packageInfo['maintainers'] = array();
|
|
$this->m_i = 0; // maintainers array index
|
|
break;
|
|
case 'maintainer':
|
|
// compatibility check
|
|
if (!isset($this->_packageInfo['maintainers'])) {
|
|
$this->_packageInfo['maintainers'] = array();
|
|
$this->m_i = 0;
|
|
}
|
|
$this->_packageInfo['maintainers'][$this->m_i] = array();
|
|
$this->current_maintainer =& $this->_packageInfo['maintainers'][$this->m_i];
|
|
break;
|
|
case 'changelog':
|
|
$this->_packageInfo['changelog'] = array();
|
|
$this->c_i = 0; // changelog array index
|
|
$this->in_changelog = true;
|
|
break;
|
|
case 'release':
|
|
if ($this->in_changelog) {
|
|
$this->_packageInfo['changelog'][$this->c_i] = array();
|
|
$this->current_release = &$this->_packageInfo['changelog'][$this->c_i];
|
|
} else {
|
|
$this->current_release = &$this->_packageInfo;
|
|
}
|
|
break;
|
|
case 'deps':
|
|
if (!$this->in_changelog) {
|
|
$this->_packageInfo['release_deps'] = array();
|
|
}
|
|
break;
|
|
case 'dep':
|
|
// dependencies array index
|
|
if (!$this->in_changelog) {
|
|
$this->d_i++;
|
|
isset($attribs['type']) ? ($attribs['type'] = strtolower($attribs['type'])) : false;
|
|
$this->_packageInfo['release_deps'][$this->d_i] = $attribs;
|
|
}
|
|
break;
|
|
case 'configureoptions':
|
|
if (!$this->in_changelog) {
|
|
$this->_packageInfo['configure_options'] = array();
|
|
}
|
|
break;
|
|
case 'configureoption':
|
|
if (!$this->in_changelog) {
|
|
$this->_packageInfo['configure_options'][] = $attribs;
|
|
}
|
|
break;
|
|
case 'provides':
|
|
if (empty($attribs['type']) || empty($attribs['name'])) {
|
|
break;
|
|
}
|
|
$attribs['explicit'] = true;
|
|
$this->_packageInfo['provides']["$attribs[type];$attribs[name]"] = $attribs;
|
|
break;
|
|
case 'package' :
|
|
if (isset($attribs['version'])) {
|
|
$this->_packageInfo['xsdversion'] = trim($attribs['version']);
|
|
} else {
|
|
$this->_packageInfo['xsdversion'] = '1.0';
|
|
}
|
|
if (isset($attribs['packagerversion'])) {
|
|
$this->_packageInfo['packagerversion'] = $attribs['packagerversion'];
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
// }}}
|
|
// {{{ _element_end_1_0()
|
|
|
|
/**
|
|
* XML parser callback for ending elements. Used for version 1.0
|
|
* packages.
|
|
*
|
|
* @param resource $xp XML parser resource
|
|
* @param string $name name of ending element
|
|
*
|
|
* @return void
|
|
*
|
|
* @access private
|
|
*/
|
|
function _element_end_1_0($xp, $name)
|
|
{
|
|
$data = trim($this->cdata);
|
|
switch ($name) {
|
|
case 'name':
|
|
switch ($this->prev_element) {
|
|
case 'package':
|
|
$this->_packageInfo['package'] = $data;
|
|
break;
|
|
case 'maintainer':
|
|
$this->current_maintainer['name'] = $data;
|
|
break;
|
|
}
|
|
break;
|
|
case 'extends' :
|
|
$this->_packageInfo['extends'] = $data;
|
|
break;
|
|
case 'summary':
|
|
$this->_packageInfo['summary'] = $data;
|
|
break;
|
|
case 'description':
|
|
$data = $this->_unIndent($this->cdata);
|
|
$this->_packageInfo['description'] = $data;
|
|
break;
|
|
case 'user':
|
|
$this->current_maintainer['handle'] = $data;
|
|
break;
|
|
case 'email':
|
|
$this->current_maintainer['email'] = $data;
|
|
break;
|
|
case 'role':
|
|
$this->current_maintainer['role'] = $data;
|
|
break;
|
|
case 'version':
|
|
if ($this->in_changelog) {
|
|
$this->current_release['version'] = $data;
|
|
} else {
|
|
$this->_packageInfo['version'] = $data;
|
|
}
|
|
break;
|
|
case 'date':
|
|
if ($this->in_changelog) {
|
|
$this->current_release['release_date'] = $data;
|
|
} else {
|
|
$this->_packageInfo['release_date'] = $data;
|
|
}
|
|
break;
|
|
case 'notes':
|
|
// try to "de-indent" release notes in case someone
|
|
// has been over-indenting their xml ;-)
|
|
// Trim only on the right side
|
|
$data = rtrim($this->_unIndent($this->cdata));
|
|
if ($this->in_changelog) {
|
|
$this->current_release['release_notes'] = $data;
|
|
} else {
|
|
$this->_packageInfo['release_notes'] = $data;
|
|
}
|
|
break;
|
|
case 'warnings':
|
|
if ($this->in_changelog) {
|
|
$this->current_release['release_warnings'] = $data;
|
|
} else {
|
|
$this->_packageInfo['release_warnings'] = $data;
|
|
}
|
|
break;
|
|
case 'state':
|
|
if ($this->in_changelog) {
|
|
$this->current_release['release_state'] = $data;
|
|
} else {
|
|
$this->_packageInfo['release_state'] = $data;
|
|
}
|
|
break;
|
|
case 'license':
|
|
if ($this->in_changelog) {
|
|
$this->current_release['release_license'] = $data;
|
|
} else {
|
|
$this->_packageInfo['release_license'] = $data;
|
|
}
|
|
break;
|
|
case 'dep':
|
|
if ($data && !$this->in_changelog) {
|
|
$this->_packageInfo['release_deps'][$this->d_i]['name'] = $data;
|
|
}
|
|
break;
|
|
case 'dir':
|
|
if ($this->in_changelog) {
|
|
break;
|
|
}
|
|
array_pop($this->dir_names);
|
|
break;
|
|
case 'file':
|
|
if ($this->in_changelog) {
|
|
break;
|
|
}
|
|
if ($data) {
|
|
$path = '';
|
|
if (count($this->dir_names)) {
|
|
foreach ($this->dir_names as $dir) {
|
|
$path .= $dir . '/';
|
|
}
|
|
}
|
|
$path .= $data;
|
|
$this->filelist[$path] = $this->current_attributes;
|
|
// Set the baseinstalldir only if the file don't have this attrib
|
|
if (!isset($this->filelist[$path]['baseinstalldir']) &&
|
|
isset($this->dir_install))
|
|
{
|
|
$this->filelist[$path]['baseinstalldir'] = $this->dir_install;
|
|
}
|
|
// Set the Role
|
|
if (!isset($this->filelist[$path]['role']) && isset($this->dir_role)) {
|
|
$this->filelist[$path]['role'] = $this->dir_role;
|
|
}
|
|
}
|
|
break;
|
|
case 'maintainer':
|
|
if (empty($this->_packageInfo['maintainers'][$this->m_i]['role'])) {
|
|
$this->_packageInfo['maintainers'][$this->m_i]['role'] = 'lead';
|
|
}
|
|
$this->m_i++;
|
|
break;
|
|
case 'release':
|
|
if ($this->in_changelog) {
|
|
$this->c_i++;
|
|
}
|
|
break;
|
|
case 'changelog':
|
|
$this->in_changelog = false;
|
|
break;
|
|
}
|
|
array_pop($this->element_stack);
|
|
$spos = sizeof($this->element_stack) - 1;
|
|
$this->current_element = ($spos > 0) ? $this->element_stack[$spos] : '';
|
|
$this->cdata = '';
|
|
}
|
|
|
|
// }}}
|
|
// {{{ _pkginfo_cdata_1_0()
|
|
|
|
/**
|
|
* XML parser callback for character data. Used for version 1.0
|
|
* packages.
|
|
*
|
|
* @param resource $xp XML parser resource
|
|
* @param string $name character data
|
|
*
|
|
* @return void
|
|
*
|
|
* @access private
|
|
*/
|
|
function _pkginfo_cdata_1_0($xp, $data)
|
|
{
|
|
if (isset($this->cdata)) {
|
|
$this->cdata .= $data;
|
|
}
|
|
}
|
|
|
|
// }}}
|
|
}
|
|
?>
|