X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FXML.php;h=476ecb4b00e7f964325e647472afd8b6bcf345c6;hb=4b44aca50735dc047e495825bff7dfa717acb615;hp=6ba6d14f140ece90a8f4c0b6ae8408e6e98aceef;hpb=ae4aab872ff98151639729997306ed9a7a3aa1cf;p=friendica.git diff --git a/src/Util/XML.php b/src/Util/XML.php index 6ba6d14f14..476ecb4b00 100644 --- a/src/Util/XML.php +++ b/src/Util/XML.php @@ -4,8 +4,9 @@ */ namespace Friendica\Util; -use Friendica\Core\Logger; use DOMXPath; +use Friendica\Core\Logger; +use Friendica\Core\System; use SimpleXMLElement; /** @@ -36,7 +37,7 @@ class XML $root = new SimpleXMLElement("<".$key."/>"); self::fromArray($value, $root, $remove_header, $namespaces, false); } else { - $root = new SimpleXMLElement("<".$key.">".self::xmlify($value).""); + $root = new SimpleXMLElement("<".$key.">".self::escape($value).""); } $dom = dom_import_simplexml($root)->ownerDocument; @@ -104,7 +105,7 @@ class XML } if (!is_array($value)) { - $element = $xml->addChild($key, self::xmlify($value), $namespace); + $element = $xml->addChild($key, self::escape($value), $namespace); } elseif (is_array($value)) { $element = $xml->addChild($key, null, $namespace); self::fromArray($value, $element, $remove_header, $namespaces, false); @@ -123,7 +124,7 @@ class XML public static function copy(&$source, &$target, $elementname) { if (count($source->children()) == 0) { - $target->addChild($elementname, self::xmlify($source)); + $target->addChild($elementname, self::escape($source)); } else { $child = $target->addChild($elementname); foreach ($source->children() as $childfield => $childentry) { @@ -135,20 +136,20 @@ class XML /** * @brief Create an XML element * - * @param object $doc XML root - * @param string $element XML element name - * @param string $value XML value - * @param array $attributes array containing the attributes + * @param \DOMDocument $doc XML root + * @param string $element XML element name + * @param string $value XML value + * @param array $attributes array containing the attributes * - * @return object XML element object + * @return \DOMElement XML element object */ - public static function createElement($doc, $element, $value = "", $attributes = []) + public static function createElement(\DOMDocument $doc, $element, $value = "", $attributes = []) { - $element = $doc->createElement($element, self::xmlify($value)); + $element = $doc->createElement($element, self::escape($value)); foreach ($attributes as $key => $value) { $attribute = $doc->createAttribute($key); - $attribute->value = self::xmlify($value); + $attribute->value = self::escape($value); $element->appendChild($attribute); } return $element; @@ -157,14 +158,14 @@ class XML /** * @brief Create an XML and append it to the parent object * - * @param object $doc XML root + * @param \DOMDocument $doc XML root * @param object $parent parent object * @param string $element XML element name * @param string $value XML value * @param array $attributes array containing the attributes * @return void */ - public static function addElement($doc, $parent, $element, $value = "", $attributes = []) + public static function addElement(\DOMDocument $doc, $parent, $element, $value = "", $attributes = []) { $element = self::createElement($doc, $element, $value, $attributes); $parent->appendChild($element); @@ -230,17 +231,18 @@ class XML * (namespaces, lowercase tags, get_attribute default changed, more...) * * Examples: $array = Xml::toArray(file_get_contents('feed.xml')); - * $array = Xml::toArray(file_get_contents('feed.xml', true, 1, 'attribute')); + * $array = Xml::toArray(file_get_contents('feed.xml', true, 1, 'attribute')); * - * @param object $contents The XML text - * @param boolean $namespaces True or false include namespace information - * in the returned array as array elements. - * @param integer $get_attributes 1 or 0. If this is 1 the function will get the attributes as well as the tag values - - * this results in a different array structure in the return value. - * @param string $priority Can be 'tag' or 'attribute'. This will change the way the resulting - * array sturcture. For 'tag', the tags are given more importance. + * @param object $contents The XML text + * @param boolean $namespaces True or false include namespace information + * in the returned array as array elements. + * @param integer $get_attributes 1 or 0. If this is 1 the function will get the attributes as well as the tag values - + * this results in a different array structure in the return value. + * @param string $priority Can be 'tag' or 'attribute'. This will change the way the resulting + * array sturcture. For 'tag', the tags are given more importance. * * @return array The parsed XML in an array form. Use print_r() to see the resulting array structure. + * @throws \Exception */ public static function toArray($contents, $namespaces = true, $get_attributes = 1, $priority = 'attribute') { @@ -286,9 +288,6 @@ class XML //Initializations $xml_array = []; - $parents = []; - $opened_tags = []; - $arr = []; $current = &$xml_array; // Reference @@ -404,11 +403,11 @@ class XML /** * @brief Delete a node in a XML object * - * @param object $doc XML document + * @param \DOMDocument $doc XML document * @param string $node Node name * @return void */ - public static function deleteNode(&$doc, $node) + public static function deleteNode(\DOMDocument $doc, $node) { $xpath = new DOMXPath($doc); $list = $xpath->query("//".$node); @@ -424,16 +423,17 @@ class XML $x = @simplexml_load_string($s); if (!$x) { - Logger::log('libxml: parse: error: ' . $s, Logger::DATA); + Logger::error('Error(s) while parsing XML string.', ['callstack' => System::callstack()]); foreach (libxml_get_errors() as $err) { - Logger::log('libxml: parse: ' . $err->code." at ".$err->line.":".$err->column." : ".$err->message, Logger::DATA); + Logger::info('libxml error', ['code' => $err->code, 'position' => $err->line . ":" . $err->column, 'message' => $err->message]); } + Logger::debug('Erroring XML string', ['xml' => $s]); libxml_clear_errors(); } return $x; } - public static function getFirstNodeValue($xpath, $element, $context = null) + public static function getFirstNodeValue(DOMXPath $xpath, $element, $context = null) { $result = $xpath->evaluate($element, $context); if (!is_object($result)) { @@ -448,7 +448,7 @@ class XML return $first_item->nodeValue; } - public static function getFirstAttributes($xpath, $element, $context = null) + public static function getFirstAttributes(DOMXPath $xpath, $element, $context = null) { $result = $xpath->query($element, $context); if (!is_object($result)) { @@ -465,40 +465,44 @@ class XML /** * escape text ($str) for XML transport + * * @param string $str * @return string Escaped text. */ - public static function xmlify($str) + public static function escape($str) { - $buffer = htmlspecialchars($str, ENT_QUOTES, "UTF-8"); + $buffer = htmlspecialchars($str, ENT_QUOTES, 'UTF-8'); $buffer = trim($buffer); return $buffer; } /** - * undo an xmlify + * undo an escape + * * @param string $s xml escaped text * @return string unescaped text */ - public static function unxmlify($s) + public static function unescape($s) { $ret = htmlspecialchars_decode($s, ENT_QUOTES); return $ret; } /** - * apply xmlify() to all values of array $val, recursively + * apply escape() to all values of array $val, recursively + * * @param array $val - * @return array + * @return array|string */ - public static function arrayXmlify($val) + public static function arrayEscape($val) { if (is_bool($val)) { - return $val?"true":"false"; + return $val ? 'true' : 'false'; } elseif (is_array($val)) { - return array_map('XML::arrayXmlify', $val); + return array_map('XML::arrayEscape', $val); } - return self::xmlify((string) $val); + + return self::escape((string) $val); } }