Edit File by line

<?php // phpcs:ignoreFile

[0] Fix | Delete

/**

[1] Fix | Delete

* Encodes XML data.

[2] Fix | Delete

[3] Fix | Delete

* Based on code from the Symfony package

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

* Permission is hereby granted, free of charge, to any person obtaining a copy

[8] Fix | Delete

* of this software and associated documentation files (the "Software"), to deal

[9] Fix | Delete

* in the Software without restriction, including without limitation the rights

[10] Fix | Delete

* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

[11] Fix | Delete

* copies of the Software, and to permit persons to whom the Software is furnished

[12] Fix | Delete

* to do so, subject to the following conditions:

[13] Fix | Delete

[14] Fix | Delete

* The above copyright notice and this permission notice shall be included in all

[15] Fix | Delete

* copies or substantial portions of the Software.

[16] Fix | Delete

[17] Fix | Delete

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

[18] Fix | Delete

* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

[19] Fix | Delete

* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

[20] Fix | Delete

* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

[21] Fix | Delete

* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

[22] Fix | Delete

* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

[23] Fix | Delete

* THE SOFTWARE.

[24] Fix | Delete

[25] Fix | Delete

* @author Jordi Boggiano <j.boggiano@seld.be>

[26] Fix | Delete

* @author John Wards <jwards@whiteoctober.co.uk>

[27] Fix | Delete

* @author Fabian Vogler <fabian@equivalence.ch>

[28] Fix | Delete

* @author Kévin Dunglas <dunglas@gmail.com>

[29] Fix | Delete

[30] Fix | Delete

class Advanced_Ads_XmlEncoder

[31] Fix | Delete

{

[32] Fix | Delete

/**

[33] Fix | Delete

* @var DOMDocument

[34] Fix | Delete

[35] Fix | Delete

private $dom;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* @var Advanced_Ads_XmlEncoder

[39] Fix | Delete

[40] Fix | Delete

private static $instance;

[41] Fix | Delete

[42] Fix | Delete

private function __construct() {}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* @return Advanced_Ads_XmlEncoder

[46] Fix | Delete

[47] Fix | Delete

public static function get_instance()

[48] Fix | Delete

{

[49] Fix | Delete

if ( ! isset(self::$instance) ) {

[50] Fix | Delete

self::$instance = new self;

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

return self::$instance;

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

[57] Fix | Delete

public function encode( $data, $options = []) {

[58] Fix | Delete

if ( ! extension_loaded( 'simplexml' ) ) {

[59] Fix | Delete

throw new Exception( sprintf( __( 'The %s extension(s) is not loaded', 'advanced-ads' ), 'simplexml' ) );

[60] Fix | Delete

}

[61] Fix | Delete

if ( ! extension_loaded( 'dom' ) ) {

[62] Fix | Delete

throw new Exception( sprintf( __( 'The %s extension(s) is not loaded', 'advanced-ads' ), 'dom' ) );

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

$this->dom = new DOMDocument();

[66] Fix | Delete

$this->dom->preserveWhiteSpace = false;

[67] Fix | Delete

$this->dom->formatOutput = true;

[68] Fix | Delete

if (isset($options['encoding'])) {

[69] Fix | Delete

$this->dom->encoding = $options['encoding'];

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

if ( ! is_array($data) ) {

[73] Fix | Delete

throw new UnexpectedValueException( _x( 'The data must be an array', 'import_export', 'advanced-ads' ) );

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

if (isset($options['skip_root'])) {

[77] Fix | Delete

$this->buildXml($this->dom, $data );

[78] Fix | Delete

} else {

[79] Fix | Delete

// create root <advads-export> tag

[80] Fix | Delete

$root = $this->dom->createElement('advads-export');

[81] Fix | Delete

$this->dom->appendChild($root);

[82] Fix | Delete

$this->buildXml($root, $data );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

[86] Fix | Delete

return $this->dom->saveXML();

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Parse the data and convert it to DOMElements.

[91] Fix | Delete

[92] Fix | Delete

private function buildXml(DOMNode $parentNode, $data ) {

[93] Fix | Delete

$append = true;

[94] Fix | Delete

[95] Fix | Delete

foreach ($data as $key => $data) {

[96] Fix | Delete

if (is_numeric($key) ) {

[97] Fix | Delete

$append = $this->appendNode($parentNode, $data, 'item', $key);

[98] Fix | Delete

} elseif ( $this->isElementNameValid($key) ) {

[99] Fix | Delete

$append = $this->appendNode($parentNode, $data, $key);

[100] Fix | Delete

}

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

return $append;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Selects the type of node to create and appends it to the parent.

[109] Fix | Delete

[110] Fix | Delete

* @param DOMNode $parentNode

[111] Fix | Delete

* @param array|object $data

[112] Fix | Delete

* @param string $nodeName

[113] Fix | Delete

* @param string $key

[114] Fix | Delete

[115] Fix | Delete

* @return bool

[116] Fix | Delete

[117] Fix | Delete

private function appendNode(DOMNode $parentNode, $data, $nodeName, $key = null) {

[118] Fix | Delete

$node = $this->dom->createElement($nodeName);

[119] Fix | Delete

[120] Fix | Delete

if (null !== $key) {

[121] Fix | Delete

$node->setAttribute('key', $key);

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

$appendNode = false;

[125] Fix | Delete

if (is_array($data)) {

[126] Fix | Delete

$node->setAttribute('type', 'array' );

[127] Fix | Delete

$appendNode = $this->buildXml($node, $data);

[128] Fix | Delete

} elseif (is_numeric($data)) {

[129] Fix | Delete

$node->setAttribute('type', is_string( $data) ? 'string' : 'numeric' );

[130] Fix | Delete

$appendNode = $this->appendText($node, (string) $data);

[131] Fix | Delete

} elseif (is_string($data)) {

[132] Fix | Delete

$node->setAttribute('type', 'string');

[133] Fix | Delete

$appendNode = $this->needsCdataWrapping($data) ? $this->appendCData($node, $data) : $this->appendText($node, $data);

[134] Fix | Delete

} elseif (is_bool($data)) {

[135] Fix | Delete

$node->setAttribute('type', 'boolean');

[136] Fix | Delete

$appendNode = $this->appendText($node, (int) $data);

[137] Fix | Delete

} elseif (is_null($data)) {

[138] Fix | Delete

$node->setAttribute('type', 'null');

[139] Fix | Delete

$appendNode = $this->appendText($node, '');

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

if ($appendNode) {

[143] Fix | Delete

$parentNode->appendChild($node);

[144] Fix | Delete

} else {

[145] Fix | Delete

/* translators: %s node data */

[146] Fix | Delete

throw new UnexpectedValueException( sprintf( _x( 'An unexpected value could not be serialized: %s', 'import_export', 'advanced-ads' ), var_export($data, true) ) );

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return $appendNode;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

final protected function appendText(DOMNode $node, $val) {

[153] Fix | Delete

$nodeText = $this->dom->createTextNode($val);

[154] Fix | Delete

$node->appendChild($nodeText);

[155] Fix | Delete

[156] Fix | Delete

return true;

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

final protected function appendCData(DOMNode $node, $val) {

[160] Fix | Delete

$nodeText = $this->dom->createCDATASection($val);

[161] Fix | Delete

$node->appendChild($nodeText);

[162] Fix | Delete

[163] Fix | Delete

return true;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Checks if a value contains any characters which would require CDATA wrapping.

[168] Fix | Delete

[169] Fix | Delete

* @param string $val

[170] Fix | Delete

[171] Fix | Delete

* @return bool

[172] Fix | Delete

[173] Fix | Delete

private function needsCdataWrapping($val) {

[174] Fix | Delete

return preg_match('/[<>&]/', $val);

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Checks the name is a valid xml element name.

[179] Fix | Delete

[180] Fix | Delete

* @param string $name

[181] Fix | Delete

[182] Fix | Delete

* @return bool

[183] Fix | Delete

[184] Fix | Delete

final protected function isElementNameValid($name) {

[185] Fix | Delete

return $name && false === strpos($name, ' ') && preg_match('#^[\pL_][\pL0-9._:-]*$#ui', $name);

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Decode XML data.

[190] Fix | Delete

[191] Fix | Delete

* @throws Exception If an extension is lt loaded.

[192] Fix | Delete

* @throws UnexpectedValueException If XML data is invalid.

[193] Fix | Delete

[194] Fix | Delete

* @param string $data XML data.

[195] Fix | Delete

* @return array Decoded XML data.

[196] Fix | Delete

[197] Fix | Delete

public function decode( $data ) {

[198] Fix | Delete

if ( ! extension_loaded( 'simplexml' ) ) {

[199] Fix | Delete

/* translators: %s: A name of not loaded extension. */

[200] Fix | Delete

throw new Exception( sprintf( __( 'The %s extension(s) is not loaded', 'advanced-ads' ), 'simplexml' ) );

[201] Fix | Delete

}

[202] Fix | Delete

if ( ! extension_loaded( 'dom' ) ) {

[203] Fix | Delete

/* translators: %s: A name of not loaded extension. */

[204] Fix | Delete

throw new Exception( sprintf( __( 'The %s extension(s) is not loaded', 'advanced-ads' ), 'dom' ) );

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

[208] Fix | Delete

if ('' === trim($data)) {

[209] Fix | Delete

throw new UnexpectedValueException( _x( 'Invalid XML data, it can not be empty', 'import_export', 'advanced-ads' ) );

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

$internal_errors = libxml_use_internal_errors( true );

[213] Fix | Delete

[214] Fix | Delete

if ( LIBXML_VERSION < 20900 ) {

[215] Fix | Delete

// The `libxml_disable_entity_loading` function has been deprecated in PHP 8.0 because in

[216] Fix | Delete

// libxml >= 2.9.0 (that is required by PHP 8), external entity loading is disabled by default,

[217] Fix | Delete

// so this function is no longer needed to protect against XXE attacks.

[218] Fix | Delete

// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.libxml_disable_entity_loaderDeprecated

[219] Fix | Delete

$disable_entities = libxml_disable_entity_loader( true );

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

libxml_clear_errors();

[223] Fix | Delete

[224] Fix | Delete

$dom = new DOMDocument();

[225] Fix | Delete

[226] Fix | Delete

if ( strpos( $data, '<advads-export>' ) === false ) {

[227] Fix | Delete

$data = preg_replace('/^<\?xml.*?\?>/', '', $data );

[228] Fix | Delete

$data = '<advads-export>' . $data . '</advads-export>';

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

$dom->loadXML($data, LIBXML_NONET | LIBXML_NOBLANKS);

[232] Fix | Delete

[233] Fix | Delete

libxml_use_internal_errors( $internal_errors );

[234] Fix | Delete

[235] Fix | Delete

if ( LIBXML_VERSION < 20900 ) {

[236] Fix | Delete

// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.libxml_disable_entity_loaderDeprecated -- see L215ff. for an explanation

[237] Fix | Delete

libxml_disable_entity_loader( $disable_entities );

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

if ($error = libxml_get_last_error()) {

[241] Fix | Delete

libxml_clear_errors();

[242] Fix | Delete

[243] Fix | Delete

/* translators: %s error messages while trying to decode xml file */

[244] Fix | Delete

throw new UnexpectedValueException( sprintf( _x( 'XML error: %s', 'import_export', 'advanced-ads' ), $error->message ) );

[245] Fix | Delete

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

// <advads-export>

[249] Fix | Delete

$rootNode = $dom->firstChild;

[250] Fix | Delete

[251] Fix | Delete

if ($rootNode->hasChildNodes()) {

[252] Fix | Delete

return $this->parseXml($rootNode);

[253] Fix | Delete

}

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

/**

[257] Fix | Delete

* Parse the input DOMNode into an array or a string.

[258] Fix | Delete

[259] Fix | Delete

* @param DOMNode $node xml to parse

[260] Fix | Delete

[261] Fix | Delete

* @return array|string

[262] Fix | Delete

[263] Fix | Delete

private function parseXml(DOMNode $node) {

[264] Fix | Delete

// Parse the input DOMNode value (content and children) into an array or a string

[265] Fix | Delete

$data = [];

[266] Fix | Delete

if ( $node->hasAttributes() ) {

[267] Fix | Delete

foreach ($node->attributes as $attr) {

[268] Fix | Delete

if (ctype_digit($attr->nodeValue)) {

[269] Fix | Delete

$data['@'.$attr->nodeName] = (int) $attr->nodeValue;

[270] Fix | Delete

} else {

[271] Fix | Delete

$data['@'.$attr->nodeName] = $attr->nodeValue;

[272] Fix | Delete

}

[273] Fix | Delete

}

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

$text_type = isset($data['@type']) ? $data['@type'] : null;

[277] Fix | Delete

unset( $data['@type'] );

[278] Fix | Delete

[279] Fix | Delete

// Parse the input DOMNode value (content and children) into an array or a string.

[280] Fix | Delete

if (!$node->hasChildNodes()) {

[281] Fix | Delete

$value = $node->nodeValue;

[282] Fix | Delete

} elseif (1 === $node->childNodes->length && in_array($node->firstChild->nodeType, [XML_TEXT_NODE, XML_CDATA_SECTION_NODE])) {

[283] Fix | Delete

$value = $node->firstChild->nodeValue;

[284] Fix | Delete

} else {

[285] Fix | Delete

[286] Fix | Delete

[287] Fix | Delete

$value = [];

[288] Fix | Delete

[289] Fix | Delete

foreach ($node->childNodes as $subnode) {

[290] Fix | Delete

$val = $this->parseXml($subnode);

[291] Fix | Delete

[292] Fix | Delete

if ('item' === $subnode->nodeName && is_array($val) && isset($val['@key'])) {

[293] Fix | Delete

$a = $val['@key'];

[294] Fix | Delete

if (isset($val['#'])) {

[295] Fix | Delete

$value[$a] = $val['#'] !== 'null' ? $val['#'] : null;

[296] Fix | Delete

} else {

[297] Fix | Delete

$value[$a] = $val !== 'null' ? $val : null;

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

} else {

[301] Fix | Delete

$value[$subnode->nodeName][] = $val === 'null' ? null : $val;

[302] Fix | Delete

}

[303] Fix | Delete

}

[304] Fix | Delete

foreach ($value as $key => $val) {

[305] Fix | Delete

if (is_array($val) && 1 === count($val)) {

[306] Fix | Delete

$value[$key] = current($val);

[307] Fix | Delete

} else if ( is_array( $value[$key] ) && isset( $value[$key]['@key'] ) ) {

[308] Fix | Delete

unset( $value[$key]['@key'] );

[309] Fix | Delete

}

[310] Fix | Delete

}

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

if (!count($data)) {

[314] Fix | Delete

$value = $this->changeType( $value, $text_type );

[315] Fix | Delete

return $value;

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

if (!is_array($value)) {

[319] Fix | Delete

$value = $this->changeType( $value, $text_type );

[320] Fix | Delete

$data['#'] = $value;

[321] Fix | Delete

return $data;

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

if (1 === count($value) && key($value)) {

[325] Fix | Delete

$data[key($value)] = current($value);

[326] Fix | Delete

[327] Fix | Delete

return $data;

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

foreach ($value as $key => $val) {

[331] Fix | Delete

$data[$key] = $val;

[332] Fix | Delete

}

[333] Fix | Delete

[334] Fix | Delete

return $data;

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

private function changeType( $text, $type ) {

[338] Fix | Delete

if ( $type === 'string' ) return (string) $text;

[339] Fix | Delete

if ( $type === 'numeric' ) return 0 + $text;

[340] Fix | Delete

if ( $type === 'boolean' ) return (boolean) $text;

[341] Fix | Delete

if ( $type === 'array' && $text=== '' ) return [];

[342] Fix | Delete

if ( $type === 'null' ) return 'null';

[343] Fix | Delete

return $text;

[344] Fix | Delete

}

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete