X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FXML.php;h=4eed3a85f84eb511b0859521d75be1a34a99a760;hb=e52e505a481ed6f7e3766725d709b5f0653b036b;hp=7ecf85acd07f9ae2bc7f24de05daad94537c0b40;hpb=cb34f066922e3b956251d32e7366fce61b47f642;p=friendica.git diff --git a/src/Util/XML.php b/src/Util/XML.php index 7ecf85acd0..4eed3a85f8 100644 --- a/src/Util/XML.php +++ b/src/Util/XML.php @@ -1,20 +1,38 @@ . + * */ + namespace Friendica\Util; -use DomXPath; +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 @@ -24,7 +42,7 @@ class XML * * @return string The created XML */ - public static function from_array($array, &$xml, $remove_header = false, $namespaces = array(), $root = true) + public static function fromArray($array, &$xml, $remove_header = false, $namespaces = [], $root = true) { if ($root) { foreach ($array as $key => $value) { @@ -34,9 +52,9 @@ class XML if (is_array($value)) { $root = new SimpleXMLElement("<".$key."/>"); - self::from_array($value, $root, $remove_header, $namespaces, false); + self::fromArray($value, $root, $remove_header, $namespaces, false); } else { - $root = new SimpleXMLElement("<".$key.">".xmlify($value).""); + $root = new SimpleXMLElement("<".$key.">".self::escape($value).""); } $dom = dom_import_simplexml($root)->ownerDocument; @@ -53,6 +71,7 @@ class XML } } + $element = null; foreach ($array as $key => $value) { if (!isset($element) && isset($xml)) { $element = $xml; @@ -103,25 +122,26 @@ class XML } 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::from_array($value, $element, $remove_header, $namespaces, false); + 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 * @param string $elementname Name of the XML element of the target + * @return void */ 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) { @@ -131,84 +151,86 @@ class XML } /** - * @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 create_element($doc, $element, $value = "", $attributes = array()) + 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 add_element($doc, $parent, $element, $value = "", $attributes = array()) + public static function addElement(\DOMDocument $doc, $parent, $element, $value = "", $attributes = []) { - $element = self::create_element($doc, $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 * @param integer $recursion_depth recursion counter for internal use - default 0 * internal use, recursion counter * - * @return array | sring The array from the xml element or the string + * @return array | string The array from the xml element or the string */ - public static function element_to_array($xml_element, &$recursion_depth=0) + public static function elementToArray($xml_element, &$recursion_depth = 0) { // If we're getting too deep, bail out if ($recursion_depth > 512) { return(null); } + $xml_element_copy = ''; if (!is_string($xml_element) && !is_array($xml_element) && (get_class($xml_element) == 'SimpleXMLElement') ) { - $xml_element_copy = $xml_element; - $xml_element = get_object_vars($xml_element); + $xml_element_copy = $xml_element; + $xml_element = get_object_vars($xml_element); } if (is_array($xml_element)) { - $result_array = array(); + $result_array = []; if (count($xml_element) <= 0) { return (trim(strval($xml_element_copy))); } foreach ($xml_element as $key => $value) { $recursion_depth++; - $result_array[strtolower($key)] = self::element_to_array($value, $recursion_depth); + $result_array[strtolower($key)] = self::elementToArray($value, $recursion_depth); $recursion_depth--; } if ($recursion_depth == 0) { $temp_array = $result_array; - $result_array = array( + $result_array = [ strtolower($xml_element_copy->getName()) => $temp_array, - ); + ]; } return ($result_array); @@ -218,35 +240,36 @@ class XML } /** - * @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::to_array() will 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/ * Portions significantly re-written by mike@macgirvin.com for Friendica * (namespaces, lowercase tags, get_attribute default changed, more...) * - * Examples: $array = Xml::to_array(file_get_contents('feed.xml')); - * $array = Xml::to_array(file_get_contents('feed.xml', true, 1, 'attribute')); + * Examples: $array = Xml::toArray(file_get_contents('feed.xml')); + * $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 to_array($contents, $namespaces = true, $get_attributes = 1, $priority = 'attribute') + public static function toArray($contents, $namespaces = true, $get_attributes = 1, $priority = 'attribute') { if (!$contents) { - return array(); + return []; } if (!function_exists('xml_parser_create')) { - logger('Xml::to_array: parser function missing'); - return array(); + Logger::log('Xml::toArray: parser function missing'); + return []; } @@ -260,8 +283,8 @@ class XML } if (! $parser) { - logger('Xml::to_array: xml_parser_create: no resource'); - return array(); + Logger::log('Xml::toArray: xml_parser_create: no resource'); + return []; } xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8"); @@ -272,33 +295,30 @@ class XML @xml_parser_free($parser); if (! $xml_values) { - logger('Xml::to_array: libxml: parse error: ' . $contents, LOGGER_DATA); + Logger::log('Xml::toArray: libxml: parse error: ' . $contents, Logger::DATA); foreach (libxml_get_errors() as $err) { - logger('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 = array(); - $parents = array(); - $opened_tags = array(); - $arr = array(); + $xml_array = []; $current = &$xml_array; // Reference // Go through the tags. - $repeated_tag_index = array(); // Multiple tags with same name will be turned into an array + $repeated_tag_index = []; // Multiple tags with same name will be turned into an array foreach ($xml_values as $data) { - unset($attributes, $value); // Remove existing values, or there will be trouble - - // This command will extract these variables into the foreach scope - // tag(string), type(string), level(int), attributes(array). - extract($data); // We could use the array by itself, but this cooler. + $tag = $data['tag']; + $type = $data['type']; + $level = $data['level']; + $attributes = isset($data['attributes']) ? $data['attributes'] : null; + $value = isset($data['value']) ? $data['value'] : null; - $result = array(); - $attributes_data = array(); + $result = []; + $attributes_data = []; if (isset($value)) { if ($priority == 'tag') { @@ -343,7 +363,7 @@ class XML $current[$tag][$repeated_tag_index[$tag.'_'.$level]] = $result; $repeated_tag_index[$tag.'_'.$level]++; } else { // This section will make the value an array if multiple tags with the same name appear together - $current[$tag] = array($current[$tag], $result); // This will combine the existing item and the new item together to make an array + $current[$tag] = [$current[$tag], $result]; // This will combine the existing item and the new item together to make an array $repeated_tag_index[$tag.'_'.$level] = 2; if (isset($current[$tag.'_attr'])) { // The attribute of the last(0th) tag must be moved as well @@ -373,7 +393,7 @@ class XML } $repeated_tag_index[$tag.'_'.$level]++; } else { // If it is not an array... - $current[$tag] = array($current[$tag], $result); //...Make it an array using using the existing value and the new value + $current[$tag] = [$current[$tag], $result]; //...Make it an array using using the existing value and the new value $repeated_tag_index[$tag.'_'.$level] = 1; if ($priority == 'tag' and $get_attributes) { if (isset($current[$tag.'_attr'])) { // The attribute of the last(0th) tag must be moved as well @@ -398,17 +418,116 @@ class XML } /** - * @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); + $xpath = new DOMXPath($doc); $list = $xpath->query("//".$node); foreach ($list as $child) { $child->parentNode->removeChild($child); } } + + /** + * Parse XML string + * + * @param string $s + * @param boolean $suppress_log + * @return Object + */ + public static function parseString(string $s, bool $suppress_log = false) + { + libxml_use_internal_errors(true); + + $x = @simplexml_load_string($s); + if (!$x) { + 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(DOMXPath $xpath, $element, $context = null) + { + $result = $xpath->evaluate($element, $context); + if (!is_object($result)) { + return ''; + } + + $first_item = $result->item(0); + if (!is_object($first_item)) { + return ''; + } + + return $first_item->nodeValue; + } + + public static function getFirstAttributes(DOMXPath $xpath, $element, $context = null) + { + $result = $xpath->query($element, $context); + if (!is_object($result)) { + return false; + } + + $first_item = $result->item(0); + if (!is_object($first_item)) { + return false; + } + + return $first_item->attributes; + } + + /** + * 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); + } }