<?php
/**
- * @file src/Util/XML.php
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Util;
-use Friendica\Core\Logger;
use DOMXPath;
+use Friendica\Core\Logger;
+use Friendica\Core\System;
use SimpleXMLElement;
/**
- * @brief This class contain methods to work with XML data
+ * This class contain methods to work with XML data
*/
class XML
{
/**
- * @brief Creates an XML structure out of a given array
+ * Creates an XML structure out of a given array
*
* @param array $array The array of the XML structure that will be generated
* @param object $xml The createdXML will be returned by reference
$root = new SimpleXMLElement("<".$key."/>");
self::fromArray($value, $root, $remove_header, $namespaces, false);
} else {
- $root = new SimpleXMLElement("<".$key.">".xmlify($value)."</".$key.">");
+ $root = new SimpleXMLElement("<".$key.">".self::escape($value)."</".$key.">");
}
$dom = dom_import_simplexml($root)->ownerDocument;
}
if (!is_array($value)) {
- $element = $xml->addChild($key, 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);
}
/**
- * @brief Copies an XML object
+ * Copies an XML object
*
* @param object $source The XML source
* @param object $target The XML target
public static function copy(&$source, &$target, $elementname)
{
if (count($source->children()) == 0) {
- $target->addChild($elementname, xmlify($source));
+ $target->addChild($elementname, self::escape($source));
} else {
$child = $target->addChild($elementname);
foreach ($source->children() as $childfield => $childentry) {
}
/**
- * @brief Create an XML element
+ * 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, xmlify($value));
+ $element = $doc->createElement($element, self::escape($value));
foreach ($attributes as $key => $value) {
$attribute = $doc->createAttribute($key);
- $attribute->value = xmlify($value);
+ $attribute->value = self::escape($value);
$element->appendChild($attribute);
}
return $element;
}
/**
- * @brief Create an XML and append it to the parent object
+ * 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);
}
/**
- * @brief Convert an XML document to a normalised, case-corrected array
+ * Convert an XML document to a normalised, case-corrected array
* used by webfinger
*
* @param object $xml_element The XML document
}
/**
- * @brief Convert the given XML text to an array in the XML structure.
+ * Convert the given XML text to an array in the XML structure.
*
* Xml::toArray() will convert the given XML text to an array in the XML structure.
* Link: http://www.bin-co.com/php/scripts/xml2array/
* (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')
{
@xml_parser_free($parser);
if (! $xml_values) {
- Logger::log('Xml::toArray: libxml: parse error: ' . $contents, LOGGER_DATA);
+ Logger::log('Xml::toArray: libxml: parse error: ' . $contents, Logger::DATA);
foreach (libxml_get_errors() as $err) {
- Logger::log('libxml: parse: ' . $err->code . " at " . $err->line . ":" . $err->column . " : " . $err->message, LOGGER_DATA);
+ Logger::log('libxml: parse: ' . $err->code . " at " . $err->line . ":" . $err->column . " : " . $err->message, Logger::DATA);
}
libxml_clear_errors();
return;
//Initializations
$xml_array = [];
- $parents = [];
- $opened_tags = [];
- $arr = [];
$current = &$xml_array; // Reference
}
/**
- * @brief Delete a node in a XML object
+ * 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);
}
}
- public static function parseString($s, $strict = true)
+ /**
+ * Parse XML string
+ *
+ * @param string $s
+ * @param boolean $suppress_log
+ * @return Object
+ */
+ public static function parseString(string $s, bool $suppress_log = false)
{
- // the "strict" parameter is deactivated
libxml_use_internal_errors(true);
$x = @simplexml_load_string($s);
if (!$x) {
- Logger::log('libxml: parse: error: ' . $s, LOGGER_DATA);
- foreach (libxml_get_errors() as $err) {
- Logger::log('libxml: parse: ' . $err->code." at ".$err->line.":".$err->column." : ".$err->message, LOGGER_DATA);
+ if (!$suppress_log) {
+ Logger::error('Error(s) while parsing XML string.', ['callstack' => System::callstack()]);
+ foreach (libxml_get_errors() as $err) {
+ 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)) {
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)) {
return $first_item->attributes;
}
+
+ public static function getFirstValue($xpath, $search, $context)
+ {
+ $result = $xpath->query($search, $context);
+ if (!is_object($result)) {
+ return '';
+ }
+
+ $first_item = $result->item(0);
+ if (!is_object($first_item)) {
+ return '';
+ }
+
+ return $first_item->nodeValue;
+ }
+
+ /**
+ * escape text ($str) for XML transport
+ *
+ * @param string $str
+ * @return string Escaped text.
+ */
+ public static function escape($str)
+ {
+ $buffer = htmlspecialchars($str, ENT_QUOTES, 'UTF-8');
+ $buffer = trim($buffer);
+
+ return $buffer;
+ }
+
+ /**
+ * undo an escape
+ *
+ * @param string $s xml escaped text
+ * @return string unescaped text
+ */
+ public static function unescape($s)
+ {
+ $ret = htmlspecialchars_decode($s, ENT_QUOTES);
+ return $ret;
+ }
+
+ /**
+ * apply escape() to all values of array $val, recursively
+ *
+ * @param array $val
+ * @return array|string
+ */
+ public static function arrayEscape($val)
+ {
+ if (is_bool($val)) {
+ return $val ? 'true' : 'false';
+ } elseif (is_array($val)) {
+ return array_map('XML::arrayEscape', $val);
+ }
+
+ return self::escape((string) $val);
+ }
}