From f0963299311e5dc8d6d1174ca73c8e2aed53371f Mon Sep 17 00:00:00 2001 From: nishizoe Date: Wed, 9 Nov 2016 19:23:52 +0900 Subject: [PATCH 1/2] (fixed #1300) added PEAR/XML/Util.php --- lib/vendor/PEAR/XML/Util.php | 921 +++++++++++++++++++++++++++++++++++ 1 file changed, 921 insertions(+) create mode 100644 lib/vendor/PEAR/XML/Util.php diff --git a/lib/vendor/PEAR/XML/Util.php b/lib/vendor/PEAR/XML/Util.php new file mode 100644 index 000000000..e3dbdeada --- /dev/null +++ b/lib/vendor/PEAR/XML/Util.php @@ -0,0 +1,921 @@ + + * All rights reserved. + * + * 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. + * * The name of the author may not 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. + * + * @category XML + * @package XML_Util + * @author Stephan Schmidt + * @copyright 2003-2008 Stephan Schmidt + * @license http://opensource.org/licenses/bsd-license New BSD License + * @version CVS: $Id$ + * @link http://pear.php.net/package/XML_Util + */ + +/** + * Error code for invalid chars in XML name + */ +define('XML_UTIL_ERROR_INVALID_CHARS', 51); + +/** + * Error code for invalid chars in XML name + */ +define('XML_UTIL_ERROR_INVALID_START', 52); + +/** + * Error code for non-scalar tag content + */ +define('XML_UTIL_ERROR_NON_SCALAR_CONTENT', 60); + +/** + * Error code for missing tag name + */ +define('XML_UTIL_ERROR_NO_TAG_NAME', 61); + +/** + * Replace XML entities + */ +define('XML_UTIL_REPLACE_ENTITIES', 1); + +/** + * Embedd content in a CData Section + */ +define('XML_UTIL_CDATA_SECTION', 5); + +/** + * Do not replace entitites + */ +define('XML_UTIL_ENTITIES_NONE', 0); + +/** + * Replace all XML entitites + * This setting will replace <, >, ", ' and & + */ +define('XML_UTIL_ENTITIES_XML', 1); + +/** + * Replace only required XML entitites + * This setting will replace <, " and & + */ +define('XML_UTIL_ENTITIES_XML_REQUIRED', 2); + +/** + * Replace HTML entitites + * @link http://www.php.net/htmlentities + */ +define('XML_UTIL_ENTITIES_HTML', 3); + +/** + * Collapse all empty tags. + */ +define('XML_UTIL_COLLAPSE_ALL', 1); + +/** + * Collapse only empty XHTML tags that have no end tag. + */ +define('XML_UTIL_COLLAPSE_XHTML_ONLY', 2); + +/** + * Utility class for working with XML documents + * + * @category XML + * @package XML_Util + * @author Stephan Schmidt + * @copyright 2003-2008 Stephan Schmidt + * @license http://opensource.org/licenses/bsd-license New BSD License + * @version Release: 1.3.0 + * @link http://pear.php.net/package/XML_Util + */ +class XML_Util +{ + /** + * Return API version + * + * @return string $version API version + */ + public static function apiVersion() + { + return '1.1'; + } + + /** + * Replace XML entities + * + * With the optional second parameter, you may select, which + * entities should be replaced. + * + * + * require_once 'XML/Util.php'; + * + * // replace XML entites: + * $string = XML_Util::replaceEntities('This string contains < & >.'); + * + * + * With the optional third parameter, you may pass the character encoding + * + * require_once 'XML/Util.php'; + * + * // replace XML entites in UTF-8: + * $string = XML_Util::replaceEntities( + * 'This string contains < & > as well as ä, ö, ß, à and ê', + * XML_UTIL_ENTITIES_HTML, + * 'UTF-8' + * ); + * + * + * @param string $string string where XML special chars + * should be replaced + * @param int $replaceEntities setting for entities in attribute values + * (one of XML_UTIL_ENTITIES_XML, + * XML_UTIL_ENTITIES_XML_REQUIRED, + * XML_UTIL_ENTITIES_HTML) + * @param string $encoding encoding value (if any)... + * must be a valid encoding as determined + * by the htmlentities() function + * + * @return string string with replaced chars + * @see reverseEntities() + */ + public static function replaceEntities( + $string, $replaceEntities = XML_UTIL_ENTITIES_XML, $encoding = 'ISO-8859-1' + ) { + switch ($replaceEntities) { + case XML_UTIL_ENTITIES_XML: + return strtr( + $string, + array( + '&' => '&', + '>' => '>', + '<' => '<', + '"' => '"', + '\'' => ''' + ) + ); + break; + case XML_UTIL_ENTITIES_XML_REQUIRED: + return strtr( + $string, + array( + '&' => '&', + '<' => '<', + '"' => '"' + ) + ); + break; + case XML_UTIL_ENTITIES_HTML: + return htmlentities($string, ENT_COMPAT, $encoding); + break; + } + return $string; + } + + /** + * Reverse XML entities + * + * With the optional second parameter, you may select, which + * entities should be reversed. + * + * + * require_once 'XML/Util.php'; + * + * // reverse XML entites: + * $string = XML_Util::reverseEntities('This string contains < & >.'); + * + * + * With the optional third parameter, you may pass the character encoding + * + * require_once 'XML/Util.php'; + * + * // reverse XML entites in UTF-8: + * $string = XML_Util::reverseEntities( + * 'This string contains < & > as well as' + * . ' ä, ö, ß, à and ê', + * XML_UTIL_ENTITIES_HTML, + * 'UTF-8' + * ); + * + * + * @param string $string string where XML special chars + * should be replaced + * @param int $replaceEntities setting for entities in attribute values + * (one of XML_UTIL_ENTITIES_XML, + * XML_UTIL_ENTITIES_XML_REQUIRED, + * XML_UTIL_ENTITIES_HTML) + * @param string $encoding encoding value (if any)... + * must be a valid encoding as determined + * by the html_entity_decode() function + * + * @return string string with replaced chars + * @see replaceEntities() + */ + public static function reverseEntities( + $string, $replaceEntities = XML_UTIL_ENTITIES_XML, $encoding = 'ISO-8859-1' + ) { + switch ($replaceEntities) { + case XML_UTIL_ENTITIES_XML: + return strtr( + $string, + array( + '&' => '&', + '>' => '>', + '<' => '<', + '"' => '"', + ''' => '\'' + ) + ); + break; + case XML_UTIL_ENTITIES_XML_REQUIRED: + return strtr( + $string, + array( + '&' => '&', + '<' => '<', + '"' => '"' + ) + ); + break; + case XML_UTIL_ENTITIES_HTML: + return html_entity_decode($string, ENT_COMPAT, $encoding); + break; + } + return $string; + } + + /** + * Build an xml declaration + * + * + * require_once 'XML/Util.php'; + * + * // get an XML declaration: + * $xmlDecl = XML_Util::getXMLDeclaration('1.0', 'UTF-8', true); + * + * + * @param string $version xml version + * @param string $encoding character encoding + * @param bool $standalone document is standalone (or not) + * + * @return string xml declaration + * @uses attributesToString() to serialize the attributes of the + * XML declaration + */ + public static function getXMLDeclaration( + $version = '1.0', $encoding = null, $standalone = null + ) { + $attributes = array( + 'version' => $version, + ); + // add encoding + if ($encoding !== null) { + $attributes['encoding'] = $encoding; + } + // add standalone, if specified + if ($standalone !== null) { + $attributes['standalone'] = $standalone ? 'yes' : 'no'; + } + + return sprintf( + '', + XML_Util::attributesToString($attributes, false) + ); + } + + /** + * Build a document type declaration + * + * + * require_once 'XML/Util.php'; + * + * // get a doctype declaration: + * $xmlDecl = XML_Util::getDocTypeDeclaration('rootTag','myDocType.dtd'); + * + * + * @param string $root name of the root tag + * @param string $uri uri of the doctype definition + * (or array with uri and public id) + * @param string $internalDtd internal dtd entries + * + * @return string doctype declaration + * @since 0.2 + */ + public static function getDocTypeDeclaration( + $root, $uri = null, $internalDtd = null + ) { + if (is_array($uri)) { + $ref = sprintf(' PUBLIC "%s" "%s"', $uri['id'], $uri['uri']); + } elseif (!empty($uri)) { + $ref = sprintf(' SYSTEM "%s"', $uri); + } else { + $ref = ''; + } + + if (empty($internalDtd)) { + return sprintf('', $root, $ref); + } else { + return sprintf("", $root, $ref, $internalDtd); + } + } + + /** + * Create string representation of an attribute list + * + * + * require_once 'XML/Util.php'; + * + * // build an attribute string + * $att = array( + * 'foo' => 'bar', + * 'argh' => 'tomato' + * ); + * + * $attList = XML_Util::attributesToString($att); + * + * + * @param array $attributes attribute array + * @param bool|array $sort sort attribute list alphabetically, + * may also be an assoc array containing + * the keys 'sort', 'multiline', 'indent', + * 'linebreak' and 'entities' + * @param bool $multiline use linebreaks, if more than + * one attribute is given + * @param string $indent string used for indentation of + * multiline attributes + * @param string $linebreak string used for linebreaks of + * multiline attributes + * @param int $entities setting for entities in attribute values + * (one of XML_UTIL_ENTITIES_NONE, + * XML_UTIL_ENTITIES_XML, + * XML_UTIL_ENTITIES_XML_REQUIRED, + * XML_UTIL_ENTITIES_HTML) + * + * @return string string representation of the attributes + * @uses replaceEntities() to replace XML entities in attribute values + * @todo allow sort also to be an options array + */ + public static function attributesToString( + $attributes, $sort = true, $multiline = false, + $indent = ' ', $linebreak = "\n", $entities = XML_UTIL_ENTITIES_XML + ) { + /* + * second parameter may be an array + */ + if (is_array($sort)) { + if (isset($sort['multiline'])) { + $multiline = $sort['multiline']; + } + if (isset($sort['indent'])) { + $indent = $sort['indent']; + } + if (isset($sort['linebreak'])) { + $multiline = $sort['linebreak']; + } + if (isset($sort['entities'])) { + $entities = $sort['entities']; + } + if (isset($sort['sort'])) { + $sort = $sort['sort']; + } else { + $sort = true; + } + } + $string = ''; + if (is_array($attributes) && !empty($attributes)) { + if ($sort) { + ksort($attributes); + } + if (!$multiline || count($attributes) == 1) { + foreach ($attributes as $key => $value) { + if ($entities != XML_UTIL_ENTITIES_NONE) { + if ($entities === XML_UTIL_CDATA_SECTION) { + $entities = XML_UTIL_ENTITIES_XML; + } + $value = XML_Util::replaceEntities($value, $entities); + } + $string .= ' ' . $key . '="' . $value . '"'; + } + } else { + $first = true; + foreach ($attributes as $key => $value) { + if ($entities != XML_UTIL_ENTITIES_NONE) { + $value = XML_Util::replaceEntities($value, $entities); + } + if ($first) { + $string .= ' ' . $key . '="' . $value . '"'; + $first = false; + } else { + $string .= $linebreak . $indent . $key . '="' . $value . '"'; + } + } + } + } + return $string; + } + + /** + * Collapses empty tags. + * + * @param string $xml XML + * @param int $mode Whether to collapse all empty tags (XML_UTIL_COLLAPSE_ALL) + * or only XHTML (XML_UTIL_COLLAPSE_XHTML_ONLY) ones. + * + * @return string XML + */ + public static function collapseEmptyTags($xml, $mode = XML_UTIL_COLLAPSE_ALL) + { + if ($mode == XML_UTIL_COLLAPSE_XHTML_ONLY) { + return preg_replace( + '/<(area|base(?:font)?|br|col|frame|hr|img|input|isindex|link|meta|' + . 'param)([^>]*)><\/\\1>/s', + '<\\1\\2 />', + $xml + ); + } else { + return preg_replace('/<(\w+)([^>]*)><\/\\1>/s', '<\\1\\2 />', $xml); + } + } + + /** + * Create a tag + * + * This method will call XML_Util::createTagFromArray(), which + * is more flexible. + * + * + * require_once 'XML/Util.php'; + * + * // create an XML tag: + * $tag = XML_Util::createTag('myNs:myTag', + * array('foo' => 'bar'), + * 'This is inside the tag', + * 'http://www.w3c.org/myNs#'); + * + * + * @param string $qname qualified tagname (including namespace) + * @param array $attributes array containg attributes + * @param mixed $content the content + * @param string $namespaceUri URI of the namespace + * @param int $replaceEntities whether to replace XML special chars in + * content, embedd it in a CData section + * or none of both + * @param bool $multiline whether to create a multiline tag where + * each attribute gets written to a single line + * @param string $indent string used to indent attributes + * (_auto indents attributes so they start + * at the same column) + * @param string $linebreak string used for linebreaks + * @param bool $sortAttributes Whether to sort the attributes or not + * + * @return string XML tag + * @see createTagFromArray() + * @uses createTagFromArray() to create the tag + */ + public static function createTag( + $qname, $attributes = array(), $content = null, + $namespaceUri = null, $replaceEntities = XML_UTIL_REPLACE_ENTITIES, + $multiline = false, $indent = '_auto', $linebreak = "\n", + $sortAttributes = true + ) { + $tag = array( + 'qname' => $qname, + 'attributes' => $attributes + ); + + // add tag content + if ($content !== null) { + $tag['content'] = $content; + } + + // add namespace Uri + if ($namespaceUri !== null) { + $tag['namespaceUri'] = $namespaceUri; + } + + return XML_Util::createTagFromArray( + $tag, $replaceEntities, $multiline, + $indent, $linebreak, $sortAttributes + ); + } + + /** + * Create a tag from an array. + * This method awaits an array in the following format + * 
+     * array(
+     *     // qualified name of the tag
+     *     'qname' => $qname
+     *
+     *     // namespace prefix (optional, if qname is specified or no namespace)
+     *     'namespace' => $namespace
+     *
+     *     // local part of the tagname (optional, if qname is specified)
+     *     'localpart' => $localpart,
+     *
+     *     // array containing all attributes (optional)
+     *     'attributes' => array(),
+     *
+     *     // tag content (optional)
+     *     'content' => $content,
+     *
+     *     // namespaceUri for the given namespace (optional)
+     *     'namespaceUri' => $namespaceUri
+     * )
+     *
+ * + * + * require_once 'XML/Util.php'; + * + * $tag = array( + * 'qname' => 'foo:bar', + * 'namespaceUri' => 'http://foo.com', + * 'attributes' => array('key' => 'value', 'argh' => 'fruit&vegetable'), + * 'content' => 'I\'m inside the tag', + * ); + * // creating a tag with qualified name and namespaceUri + * $string = XML_Util::createTagFromArray($tag); + * + * + * @param array $tag tag definition + * @param int $replaceEntities whether to replace XML special chars in + * content, embedd it in a CData section + * or none of both + * @param bool $multiline whether to create a multiline tag where each + * attribute gets written to a single line + * @param string $indent string used to indent attributes + * (_auto indents attributes so they start + * at the same column) + * @param string $linebreak string used for linebreaks + * @param bool $sortAttributes Whether to sort the attributes or not + * + * @return string XML tag + * + * @see createTag() + * @uses attributesToString() to serialize the attributes of the tag + * @uses splitQualifiedName() to get local part and namespace of a qualified name + * @uses createCDataSection() + * @uses raiseError() + */ + public static function createTagFromArray( + $tag, $replaceEntities = XML_UTIL_REPLACE_ENTITIES, + $multiline = false, $indent = '_auto', $linebreak = "\n", + $sortAttributes = true + ) { + if (isset($tag['content']) && !is_scalar($tag['content'])) { + return XML_Util::raiseError( + 'Supplied non-scalar value as tag content', + XML_UTIL_ERROR_NON_SCALAR_CONTENT + ); + } + + if (!isset($tag['qname']) && !isset($tag['localPart'])) { + return XML_Util::raiseError( + 'You must either supply a qualified name ' + . '(qname) or local tag name (localPart).', + XML_UTIL_ERROR_NO_TAG_NAME + ); + } + + // if no attributes hav been set, use empty attributes + if (!isset($tag['attributes']) || !is_array($tag['attributes'])) { + $tag['attributes'] = array(); + } + + if (isset($tag['namespaces'])) { + foreach ($tag['namespaces'] as $ns => $uri) { + $tag['attributes']['xmlns:' . $ns] = $uri; + } + } + + if (!isset($tag['qname'])) { + // qualified name is not given + + // check for namespace + if (isset($tag['namespace']) && !empty($tag['namespace'])) { + $tag['qname'] = $tag['namespace'] . ':' . $tag['localPart']; + } else { + $tag['qname'] = $tag['localPart']; + } + } elseif (isset($tag['namespaceUri']) && !isset($tag['namespace'])) { + // namespace URI is set, but no namespace + + $parts = XML_Util::splitQualifiedName($tag['qname']); + + $tag['localPart'] = $parts['localPart']; + if (isset($parts['namespace'])) { + $tag['namespace'] = $parts['namespace']; + } + } + + if (isset($tag['namespaceUri']) && !empty($tag['namespaceUri'])) { + // is a namespace given + if (isset($tag['namespace']) && !empty($tag['namespace'])) { + $tag['attributes']['xmlns:' . $tag['namespace']] + = $tag['namespaceUri']; + } else { + // define this Uri as the default namespace + $tag['attributes']['xmlns'] = $tag['namespaceUri']; + } + } + + // check for multiline attributes + if ($multiline === true) { + if ($indent === '_auto') { + $indent = str_repeat(' ', (strlen($tag['qname'])+2)); + } + } + + // create attribute list + $attList = XML_Util::attributesToString( + $tag['attributes'], + $sortAttributes, $multiline, $indent, $linebreak + ); + if (!isset($tag['content']) || (string)$tag['content'] == '') { + $tag = sprintf('<%s%s />', $tag['qname'], $attList); + } else { + switch ($replaceEntities) { + case XML_UTIL_ENTITIES_NONE: + break; + case XML_UTIL_CDATA_SECTION: + $tag['content'] = XML_Util::createCDataSection($tag['content']); + break; + default: + $tag['content'] = XML_Util::replaceEntities( + $tag['content'], $replaceEntities + ); + break; + } + $tag = sprintf( + '<%s%s>%s', $tag['qname'], $attList, $tag['content'], + $tag['qname'] + ); + } + return $tag; + } + + /** + * Create a start element + * + * + * require_once 'XML/Util.php'; + * + * // create an XML start element: + * $tag = XML_Util::createStartElement('myNs:myTag', + * array('foo' => 'bar') ,'http://www.w3c.org/myNs#'); + * + * + * @param string $qname qualified tagname (including namespace) + * @param array $attributes array containg attributes + * @param string $namespaceUri URI of the namespace + * @param bool $multiline whether to create a multiline tag where each + * attribute gets written to a single line + * @param string $indent string used to indent attributes (_auto indents + * attributes so they start at the same column) + * @param string $linebreak string used for linebreaks + * @param bool $sortAttributes Whether to sort the attributes or not + * + * @return string XML start element + * @see createEndElement(), createTag() + */ + public static function createStartElement( + $qname, $attributes = array(), $namespaceUri = null, + $multiline = false, $indent = '_auto', $linebreak = "\n", + $sortAttributes = true + ) { + // if no attributes hav been set, use empty attributes + if (!isset($attributes) || !is_array($attributes)) { + $attributes = array(); + } + + if ($namespaceUri != null) { + $parts = XML_Util::splitQualifiedName($qname); + } + + // check for multiline attributes + if ($multiline === true) { + if ($indent === '_auto') { + $indent = str_repeat(' ', (strlen($qname)+2)); + } + } + + if ($namespaceUri != null) { + // is a namespace given + if (isset($parts['namespace']) && !empty($parts['namespace'])) { + $attributes['xmlns:' . $parts['namespace']] = $namespaceUri; + } else { + // define this Uri as the default namespace + $attributes['xmlns'] = $namespaceUri; + } + } + + // create attribute list + $attList = XML_Util::attributesToString( + $attributes, $sortAttributes, + $multiline, $indent, $linebreak + ); + $element = sprintf('<%s%s>', $qname, $attList); + return $element; + } + + /** + * Create an end element + * + * + * require_once 'XML/Util.php'; + * + * // create an XML start element: + * $tag = XML_Util::createEndElement('myNs:myTag'); + * + * + * @param string $qname qualified tagname (including namespace) + * + * @return string XML end element + * @see createStartElement(), createTag() + */ + public static function createEndElement($qname) + { + $element = sprintf('', $qname); + return $element; + } + + /** + * Create an XML comment + * + * + * require_once 'XML/Util.php'; + * + * // create an XML start element: + * $tag = XML_Util::createComment('I am a comment'); + * + * + * @param string $content content of the comment + * + * @return string XML comment + */ + public static function createComment($content) + { + $comment = sprintf('', $content); + return $comment; + } + + /** + * Create a CData section + * + * + * require_once 'XML/Util.php'; + * + * // create a CData section + * $tag = XML_Util::createCDataSection('I am content.'); + * + * + * @param string $data data of the CData section + * + * @return string CData section with content + */ + public static function createCDataSection($data) + { + return sprintf( + '', + preg_replace('/\]\]>/', ']]]]>', strval($data)) + ); + } + + /** + * Split qualified name and return namespace and local part + * + * + * require_once 'XML/Util.php'; + * + * // split qualified tag + * $parts = XML_Util::splitQualifiedName('xslt:stylesheet'); + * + * the returned array will contain two elements: + * 
+     * array(
+     *     'namespace' => 'xslt',
+     *     'localPart' => 'stylesheet'
+     * );
+     *
+ * + * @param string $qname qualified tag name + * @param string $defaultNs default namespace (optional) + * + * @return array array containing namespace and local part + */ + public static function splitQualifiedName($qname, $defaultNs = null) + { + if (strstr($qname, ':')) { + $tmp = explode(':', $qname); + return array( + 'namespace' => $tmp[0], + 'localPart' => $tmp[1] + ); + } + return array( + 'namespace' => $defaultNs, + 'localPart' => $qname + ); + } + + /** + * Check, whether string is valid XML name + * + *

XML names are used for tagname, attribute names and various + * other, lesser known entities.

+ *

An XML name may only consist of alphanumeric characters, + * dashes, undescores and periods, and has to start with a letter + * or an underscore.

+ * + * + * require_once 'XML/Util.php'; + * + * // verify tag name + * $result = XML_Util::isValidName('invalidTag?'); + * if (is_a($result, 'PEAR_Error')) { + * print 'Invalid XML name: ' . $result->getMessage(); + * } + * + * + * @param string $string string that should be checked + * + * @return mixed true, if string is a valid XML name, PEAR error otherwise + * + * @todo support for other charsets + * @todo PEAR CS - unable to avoid 85-char limit on second preg_match + */ + public static function isValidName($string) + { + // check for invalid chars + if (!preg_match('/^[[:alpha:]_]\\z/', $string{0})) { + return XML_Util::raiseError( + 'XML names may only start with letter or underscore', + XML_UTIL_ERROR_INVALID_START + ); + } + + // check for invalid chars + $match = preg_match( + '/^([[:alpha:]_]([[:alnum:]\-\.]*)?:)?' + . '[[:alpha:]_]([[:alnum:]\_\-\.]+)?\\z/', + $string + ); + if (!$match) { + return XML_Util::raiseError( + 'XML names may only contain alphanumeric ' + . 'chars, period, hyphen, colon and underscores', + XML_UTIL_ERROR_INVALID_CHARS + ); + } + // XML name is valid + return true; + } + + /** + * Replacement for XML_Util::raiseError + * + * Avoids the necessity to always require + * PEAR.php + * + * @param string $msg error message + * @param int $code error code + * + * @return PEAR_Error + * @todo PEAR CS - should this use include_once instead? + */ + public static function raiseError($msg, $code) + { + include_once 'PEAR.php'; + return PEAR::raiseError($msg, $code); + } +} +?> From 41920884f52d558429b2e4d97ffc04c324d28fe2 Mon Sep 17 00:00:00 2001 From: nishizoe Date: Wed, 11 Jan 2017 19:11:35 +0900 Subject: [PATCH 2/2] =?UTF-8?q?(fixed=20#1300)=20PEAR/XML/Util.php=20?= =?UTF-8?q?=E3=81=AE=E3=83=90=E3=83=BC=E3=82=B8=E3=83=A7=E3=83=B3=E3=82=92?= =?UTF-8?q?=201.2.3=20=E3=81=AB=E5=A4=89=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lib/vendor/PEAR/XML/Util.php | 330 +++++++++++++++++------------------ 1 file changed, 160 insertions(+), 170 deletions(-) diff --git a/lib/vendor/PEAR/XML/Util.php b/lib/vendor/PEAR/XML/Util.php index e3dbdeada..6895e1014 100644 --- a/lib/vendor/PEAR/XML/Util.php +++ b/lib/vendor/PEAR/XML/Util.php @@ -1,4 +1,7 @@ , ", ' and & */ define('XML_UTIL_ENTITIES_XML', 1); /** - * Replace only required XML entitites + * replace only required XML entitites * This setting will replace <, " and & */ define('XML_UTIL_ENTITIES_XML_REQUIRED', 2); /** - * Replace HTML entitites + * replace HTML entitites * @link http://www.php.net/htmlentities */ define('XML_UTIL_ENTITIES_HTML', 3); @@ -108,30 +111,33 @@ define('XML_UTIL_COLLAPSE_XHTML_ONLY', 2); /** - * Utility class for working with XML documents + * utility class for working with XML documents * + * @category XML * @package XML_Util * @author Stephan Schmidt * @copyright 2003-2008 Stephan Schmidt * @license http://opensource.org/licenses/bsd-license New BSD License - * @version Release: 1.3.0 + * @version Release: 1.2.3 * @link http://pear.php.net/package/XML_Util */ class XML_Util { /** - * Return API version + * return API version * * @return string $version API version + * @access public + * @static */ - public static function apiVersion() + function apiVersion() { return '1.1'; } /** - * Replace XML entities + * replace XML entities * * With the optional second parameter, you may select, which * entities should be replaced. @@ -166,33 +172,27 @@ public static function apiVersion() * by the htmlentities() function * * @return string string with replaced chars - * @see reverseEntities() + * @access public + * @static + * @see reverseEntities() */ - public static function replaceEntities( - $string, $replaceEntities = XML_UTIL_ENTITIES_XML, $encoding = 'ISO-8859-1' - ) { + function replaceEntities($string, $replaceEntities = XML_UTIL_ENTITIES_XML, + $encoding = 'ISO-8859-1') + { switch ($replaceEntities) { case XML_UTIL_ENTITIES_XML: - return strtr( - $string, - array( - '&' => '&', - '>' => '>', - '<' => '<', - '"' => '"', - '\'' => ''' - ) - ); + return strtr($string, array( + '&' => '&', + '>' => '>', + '<' => '<', + '"' => '"', + '\'' => ''' )); break; case XML_UTIL_ENTITIES_XML_REQUIRED: - return strtr( - $string, - array( - '&' => '&', - '<' => '<', - '"' => '"' - ) - ); + return strtr($string, array( + '&' => '&', + '<' => '<', + '"' => '"' )); break; case XML_UTIL_ENTITIES_HTML: return htmlentities($string, ENT_COMPAT, $encoding); @@ -202,7 +202,7 @@ public static function replaceEntities( } /** - * Reverse XML entities + * reverse XML entities * * With the optional second parameter, you may select, which * entities should be reversed. @@ -238,33 +238,27 @@ public static function replaceEntities( * by the html_entity_decode() function * * @return string string with replaced chars - * @see replaceEntities() + * @access public + * @static + * @see replaceEntities() */ - public static function reverseEntities( - $string, $replaceEntities = XML_UTIL_ENTITIES_XML, $encoding = 'ISO-8859-1' - ) { + function reverseEntities($string, $replaceEntities = XML_UTIL_ENTITIES_XML, + $encoding = 'ISO-8859-1') + { switch ($replaceEntities) { case XML_UTIL_ENTITIES_XML: - return strtr( - $string, - array( - '&' => '&', - '>' => '>', - '<' => '<', - '"' => '"', - ''' => '\'' - ) - ); + return strtr($string, array( + '&' => '&', + '>' => '>', + '<' => '<', + '"' => '"', + ''' => '\'' )); break; case XML_UTIL_ENTITIES_XML_REQUIRED: - return strtr( - $string, - array( - '&' => '&', - '<' => '<', - '"' => '"' - ) - ); + return strtr($string, array( + '&' => '&', + '<' => '<', + '"' => '"' )); break; case XML_UTIL_ENTITIES_HTML: return html_entity_decode($string, ENT_COMPAT, $encoding); @@ -274,7 +268,7 @@ public static function reverseEntities( } /** - * Build an xml declaration + * build an xml declaration * * * require_once 'XML/Util.php'; @@ -288,12 +282,13 @@ public static function reverseEntities( * @param bool $standalone document is standalone (or not) * * @return string xml declaration - * @uses attributesToString() to serialize the attributes of the - * XML declaration + * @access public + * @static + * @uses attributesToString() to serialize the attributes of the XML declaration */ - public static function getXMLDeclaration( - $version = '1.0', $encoding = null, $standalone = null - ) { + function getXMLDeclaration($version = '1.0', $encoding = null, + $standalone = null) + { $attributes = array( 'version' => $version, ); @@ -306,14 +301,12 @@ public static function getXMLDeclaration( $attributes['standalone'] = $standalone ? 'yes' : 'no'; } - return sprintf( - '', - XML_Util::attributesToString($attributes, false) - ); + return sprintf('', + XML_Util::attributesToString($attributes, false)); } /** - * Build a document type declaration + * build a document type declaration * * * require_once 'XML/Util.php'; @@ -328,11 +321,12 @@ public static function getXMLDeclaration( * @param string $internalDtd internal dtd entries * * @return string doctype declaration - * @since 0.2 + * @access public + * @static + * @since 0.2 */ - public static function getDocTypeDeclaration( - $root, $uri = null, $internalDtd = null - ) { + function getDocTypeDeclaration($root, $uri = null, $internalDtd = null) + { if (is_array($uri)) { $ref = sprintf(' PUBLIC "%s" "%s"', $uri['id'], $uri['uri']); } elseif (!empty($uri)) { @@ -349,7 +343,7 @@ public static function getDocTypeDeclaration( } /** - * Create string representation of an attribute list + * create string representation of an attribute list * * * require_once 'XML/Util.php'; @@ -381,13 +375,14 @@ public static function getDocTypeDeclaration( * XML_UTIL_ENTITIES_HTML) * * @return string string representation of the attributes - * @uses replaceEntities() to replace XML entities in attribute values - * @todo allow sort also to be an options array + * @access public + * @static + * @uses replaceEntities() to replace XML entities in attribute values + * @todo allow sort also to be an options array */ - public static function attributesToString( - $attributes, $sort = true, $multiline = false, - $indent = ' ', $linebreak = "\n", $entities = XML_UTIL_ENTITIES_XML - ) { + function attributesToString($attributes, $sort = true, $multiline = false, + $indent = ' ', $linebreak = "\n", $entities = XML_UTIL_ENTITIES_XML) + { /* * second parameter may be an array */ @@ -415,7 +410,7 @@ public static function attributesToString( if ($sort) { ksort($attributes); } - if (!$multiline || count($attributes) == 1) { + if ( !$multiline || count($attributes) == 1) { foreach ($attributes as $key => $value) { if ($entities != XML_UTIL_ENTITIES_NONE) { if ($entities === XML_UTIL_CDATA_SECTION) { @@ -451,23 +446,26 @@ public static function attributesToString( * or only XHTML (XML_UTIL_COLLAPSE_XHTML_ONLY) ones. * * @return string XML + * @access public + * @static + * @todo PEAR CS - unable to avoid "space after open parens" error + * in the IF branch */ - public static function collapseEmptyTags($xml, $mode = XML_UTIL_COLLAPSE_ALL) + function collapseEmptyTags($xml, $mode = XML_UTIL_COLLAPSE_ALL) { if ($mode == XML_UTIL_COLLAPSE_XHTML_ONLY) { return preg_replace( '/<(area|base(?:font)?|br|col|frame|hr|img|input|isindex|link|meta|' . 'param)([^>]*)><\/\\1>/s', '<\\1\\2 />', - $xml - ); + $xml); } else { return preg_replace('/<(\w+)([^>]*)><\/\\1>/s', '<\\1\\2 />', $xml); } } /** - * Create a tag + * create a tag * * This method will call XML_Util::createTagFromArray(), which * is more flexible. @@ -498,15 +496,16 @@ public static function collapseEmptyTags($xml, $mode = XML_UTIL_COLLAPSE_ALL) * @param bool $sortAttributes Whether to sort the attributes or not * * @return string XML tag - * @see createTagFromArray() - * @uses createTagFromArray() to create the tag + * @access public + * @static + * @see createTagFromArray() + * @uses createTagFromArray() to create the tag */ - public static function createTag( - $qname, $attributes = array(), $content = null, + function createTag($qname, $attributes = array(), $content = null, $namespaceUri = null, $replaceEntities = XML_UTIL_REPLACE_ENTITIES, $multiline = false, $indent = '_auto', $linebreak = "\n", - $sortAttributes = true - ) { + $sortAttributes = true) + { $tag = array( 'qname' => $qname, 'attributes' => $attributes @@ -522,15 +521,13 @@ public static function createTag( $tag['namespaceUri'] = $namespaceUri; } - return XML_Util::createTagFromArray( - $tag, $replaceEntities, $multiline, - $indent, $linebreak, $sortAttributes - ); + return XML_Util::createTagFromArray($tag, $replaceEntities, $multiline, + $indent, $linebreak, $sortAttributes); } /** - * Create a tag from an array. - * This method awaits an array in the following format + * create a tag from an array + * this method awaits an array in the following format * 
      * array(
      *     // qualified name of the tag
@@ -579,31 +576,27 @@ public static function createTag(
      * @param bool   $sortAttributes  Whether to sort the attributes or not
      *
      * @return string XML tag
-     *
-     * @see  createTag()
+     * @access public
+     * @static
+     * @see createTag()
      * @uses attributesToString() to serialize the attributes of the tag
      * @uses splitQualifiedName() to get local part and namespace of a qualified name
      * @uses createCDataSection()
      * @uses raiseError()
      */
-    public static function createTagFromArray(
-        $tag, $replaceEntities = XML_UTIL_REPLACE_ENTITIES,
+    function createTagFromArray($tag, $replaceEntities = XML_UTIL_REPLACE_ENTITIES,
         $multiline = false, $indent = '_auto', $linebreak = "\n",
-        $sortAttributes = true
-    ) {
+        $sortAttributes = true)
+    {
         if (isset($tag['content']) && !is_scalar($tag['content'])) {
-            return XML_Util::raiseError(
-                'Supplied non-scalar value as tag content',
-                XML_UTIL_ERROR_NON_SCALAR_CONTENT
-            );
+            return XML_Util::raiseError('Supplied non-scalar value as tag content',
+            XML_UTIL_ERROR_NON_SCALAR_CONTENT);
         }
 
         if (!isset($tag['qname']) && !isset($tag['localPart'])) {
-            return XML_Util::raiseError(
-                'You must either supply a qualified name '
+            return XML_Util::raiseError('You must either supply a qualified name '
                 . '(qname) or local tag name (localPart).',
-                XML_UTIL_ERROR_NO_TAG_NAME
-            );
+                XML_UTIL_ERROR_NO_TAG_NAME);
         }
 
         // if no attributes hav been set, use empty attributes
@@ -640,8 +633,8 @@ public static function createTagFromArray(
         if (isset($tag['namespaceUri']) && !empty($tag['namespaceUri'])) {
             // is a namespace given
             if (isset($tag['namespace']) && !empty($tag['namespace'])) {
-                $tag['attributes']['xmlns:' . $tag['namespace']]
-                    = $tag['namespaceUri'];
+                $tag['attributes']['xmlns:' . $tag['namespace']] =
+                    $tag['namespaceUri'];
             } else {
                 // define this Uri as the default namespace
                 $tag['attributes']['xmlns'] = $tag['namespaceUri'];
@@ -656,10 +649,8 @@ public static function createTagFromArray(
         }
 
         // create attribute list
-        $attList = XML_Util::attributesToString(
-            $tag['attributes'],
-            $sortAttributes, $multiline, $indent, $linebreak
-        );
+        $attList = XML_Util::attributesToString($tag['attributes'],
+            $sortAttributes, $multiline, $indent, $linebreak);
         if (!isset($tag['content']) || (string)$tag['content'] == '') {
             $tag = sprintf('<%s%s />', $tag['qname'], $attList);
         } else {
@@ -670,21 +661,18 @@ public static function createTagFromArray(
                 $tag['content'] = XML_Util::createCDataSection($tag['content']);
                 break;
             default:
-                $tag['content'] = XML_Util::replaceEntities(
-                    $tag['content'], $replaceEntities
-                );
+                $tag['content'] = XML_Util::replaceEntities($tag['content'],
+                    $replaceEntities);
                 break;
             }
-            $tag = sprintf(
-                '<%s%s>%s', $tag['qname'], $attList, $tag['content'],
-                $tag['qname']
-            );
+            $tag = sprintf('<%s%s>%s', $tag['qname'], $attList, $tag['content'],
+                $tag['qname']);
         }
         return $tag;
     }
 
     /**
-     * Create a start element
+     * create a start element
      *
      * 
      * require_once 'XML/Util.php';
@@ -705,13 +693,14 @@ public static function createTagFromArray(
      * @param bool   $sortAttributes Whether to sort the attributes or not
      *
      * @return string XML start element
-     * @see    createEndElement(), createTag()
+     * @access public
+     * @static
+     * @see createEndElement(), createTag()
      */
-    public static function createStartElement(
-        $qname, $attributes = array(), $namespaceUri = null,
+    function createStartElement($qname, $attributes = array(), $namespaceUri = null,
         $multiline = false, $indent = '_auto', $linebreak = "\n",
-        $sortAttributes = true
-    ) {
+        $sortAttributes = true)
+    {
         // if no attributes hav been set, use empty attributes
         if (!isset($attributes) || !is_array($attributes)) {
             $attributes = array();
@@ -739,16 +728,14 @@ public static function createStartElement(
         }
 
         // create attribute list
-        $attList = XML_Util::attributesToString(
-            $attributes, $sortAttributes,
-            $multiline, $indent, $linebreak
-        );
+        $attList = XML_Util::attributesToString($attributes, $sortAttributes,
+            $multiline, $indent, $linebreak);
         $element = sprintf('<%s%s>', $qname, $attList);
         return  $element;
     }
 
     /**
-     * Create an end element
+     * create an end element
      *
      * 
      * require_once 'XML/Util.php';
@@ -760,16 +747,18 @@ public static function createStartElement(
      * @param string $qname qualified tagname (including namespace)
      *
      * @return string XML end element
-     * @see    createStartElement(), createTag()
+     * @access public
+     * @static
+     * @see createStartElement(), createTag()
      */
-    public static function createEndElement($qname)
+    function createEndElement($qname)
     {
         $element = sprintf('', $qname);
         return $element;
     }
 
     /**
-     * Create an XML comment
+     * create an XML comment
      *
      * 
      * require_once 'XML/Util.php';
@@ -781,15 +770,17 @@ public static function createEndElement($qname)
      * @param string $content content of the comment
      *
      * @return string XML comment
+     * @access public
+     * @static
      */
-    public static function createComment($content)
+    function createComment($content)
     {
         $comment = sprintf('', $content);
         return $comment;
     }
 
     /**
-     * Create a CData section
+     * create a CData section
      *
      * 
      * require_once 'XML/Util.php';
@@ -801,17 +792,18 @@ public static function createComment($content)
      * @param string $data data of the CData section
      *
      * @return string CData section with content
+     * @access public
+     * @static
      */
-    public static function createCDataSection($data)
+    function createCDataSection($data)
     {
-        return sprintf(
-            '',
-            preg_replace('/\]\]>/', ']]]]>', strval($data))
-        );
+        return sprintf('',
+            preg_replace('/\]\]>/', ']]]]>', strval($data)));
+
     }
 
     /**
-     * Split qualified name and return namespace and local part
+     * split qualified name and return namespace and local part
      *
      * 
      * require_once 'XML/Util.php';
@@ -831,8 +823,10 @@ public static function createCDataSection($data)
      * @param string $defaultNs default namespace (optional)
      *
      * @return array array containing namespace and local part
+     * @access public
+     * @static
      */
-    public static function splitQualifiedName($qname, $defaultNs = null)
+    function splitQualifiedName($qname, $defaultNs = null)
     {
         if (strstr($qname, ':')) {
             $tmp = explode(':', $qname);
@@ -848,7 +842,7 @@ public static function splitQualifiedName($qname, $defaultNs = null)
     }
 
     /**
-     * Check, whether string is valid XML name
+     * check, whether string is valid XML name
      *
      * 
XML names are used for tagname, attribute names and various
      * other, lesser known entities.

@@ -869,39 +863,33 @@ public static function splitQualifiedName($qname, $defaultNs = null)
      * @param string $string string that should be checked
      *
      * @return mixed true, if string is a valid XML name, PEAR error otherwise
-     *
+     * @access public
+     * @static
      * @todo support for other charsets
      * @todo PEAR CS - unable to avoid 85-char limit on second preg_match
      */
-    public static function isValidName($string)
+    function isValidName($string)
     {
         // check for invalid chars
         if (!preg_match('/^[[:alpha:]_]\\z/', $string{0})) {
-            return XML_Util::raiseError(
-                'XML names may only start with letter or underscore',
-                XML_UTIL_ERROR_INVALID_START
-            );
+            return XML_Util::raiseError('XML names may only start with letter '
+                . 'or underscore', XML_UTIL_ERROR_INVALID_START);
         }
 
         // check for invalid chars
-        $match = preg_match(
-            '/^([[:alpha:]_]([[:alnum:]\-\.]*)?:)?'
-            . '[[:alpha:]_]([[:alnum:]\_\-\.]+)?\\z/',
-            $string
-        );
-        if (!$match) {
-            return XML_Util::raiseError(
-                'XML names may only contain alphanumeric '
+        if (!preg_match('/^([[:alpha:]_]([[:alnum:]\-\.]*)?:)?[[:alpha:]_]([[:alnum:]\_\-\.]+)?\\z/',
+            $string)
+        ) {
+            return XML_Util::raiseError('XML names may only contain alphanumeric '
                 . 'chars, period, hyphen, colon and underscores',
-                XML_UTIL_ERROR_INVALID_CHARS
-            );
+                XML_UTIL_ERROR_INVALID_CHARS);
         }
         // XML name is valid
         return true;
     }
 
     /**
-     * Replacement for XML_Util::raiseError
+     * replacement for XML_Util::raiseError
      *
      * Avoids the necessity to always require
      * PEAR.php
@@ -910,11 +898,13 @@ public static function isValidName($string)
      * @param int    $code error code
      *
      * @return PEAR_Error
-     * @todo   PEAR CS - should this use include_once instead?
+     * @access public
+     * @static
+     * @todo PEAR CS - should this use include_once instead?
      */
-    public static function raiseError($msg, $code)
+    function raiseError($msg, $code)
     {
-        include_once 'PEAR.php';
+        require_once 'PEAR.php';
         return PEAR::raiseError($msg, $code);
     }
 }