cacti/lib/xml.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2026 The Cacti Group                                 |
 |                                                                         |
 | This program is free software; you can redistribute it and/or           |
 | modify it under the terms of the GNU General Public License             |
 | as published by the Free Software Foundation; either version 2          |
 | 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 General Public License for more details.                            |
 +-------------------------------------------------------------------------+
 | Cacti: The Complete RRDtool-based Graphing Solution                     |
 +-------------------------------------------------------------------------+
 | This code is designed, written, and maintained by the Cacti Group. See  |
 | about.php and/or the AUTHORS file for specific developer information.   |
 +-------------------------------------------------------------------------+
 | http://www.cacti.net/                                                   |
 +-------------------------------------------------------------------------+
*/

/**
 * xml2array - Simple function to convert an XML string to an array
 *
 * @param string $data - The xml string
 *
 * @return mixed - The processed xml to an array
 */
function xml2array(string $data) : mixed {
	/**
	 * mvo voncken@mailandnews.com
	 * original ripped from  on the php-manual:gdemartini@bol.com.br
	 * to be used for data retrieval(result-structure is Data oriented)
	 */
	$p     = xml_parser_create();
	$vals  = [];
	$index = [];

	xml_parser_set_option($p, XML_OPTION_SKIP_WHITE, 1);
	xml_parser_set_option($p, XML_OPTION_CASE_FOLDING, 0);
	xml_parse_into_struct($p, $data, $vals, $index);

	if (version_compare(PHP_VERSION, '8.0', '<')) {
		xml_parser_free($p);
	}

	$tree = [];
	$i    = 0;
	$tree = get_children($vals, $i);

	return $tree;
}

function get_children(mixed $vals, int &$i) : array {
	$children = [];

	if (isset($vals[$i]['value'])) {
		if ($vals[$i]['value']) {
			array_push($children, $vals[$i]['value']);
		}
	}

	$prevtag = '';
	$j       = 0;

	while (++$i < cacti_count($vals)) {
		switch ($vals[$i]['type']) {
			case 'cdata':
				array_push($children, $vals[$i]['value']);

				break;
			case 'complete':
				/* if the value is an empty string, php doesn't include the 'value' key
				in its array, so we need to check for this first */
				if (isset($vals[$i]['value'])) {
					$children[$vals[$i]['tag']] = $vals[$i]['value'];
				} else {
					$children[$vals[$i]['tag']] = '';
				}

				break;
			case 'open':
				$j++;

				if ($prevtag != $vals[$i]['tag']) {
					$j       = 0;
					$prevtag = $vals[$i]['tag'];
				}

				$children[$vals[$i]['tag']] = get_children($vals,$i);

				break;
			case 'close':
				break 2;
		}
	}

	return $children;
}

function rrdxport2array(string $data) : array {
	// Bug force encoding to UTF-8
	$data = str_replace(['US-ASCII', 'ISO-8859-1'], 'UTF-8', $data);

	// bug #1436
	// scan XML for bad data RRDtool 1.2.30
	$array = explode("\n", $data);

	if (cacti_sizeof($array)) {
		if (str_starts_with(trim($array[0]), '<')) {
			// continue
		} else {
			$new_array = [];

			foreach ($array as $element) {
				if (str_starts_with(trim($element), '<')) {
					$new_array[] = $element;
				}
			}

			$array = $new_array;

			$data = implode("\n", $array);
		}
	}

	/* mvo voncken@mailandnews.com
	original ripped from  on the php-manual:gdemartini@bol.com.br
	to be used for data retrieval(result-structure is Data oriented) */
	$p     = xml_parser_create('UTF-8');
	$vals  = [];
	$index = [];
	xml_parser_set_option($p, XML_OPTION_SKIP_WHITE, 1);
	xml_parser_set_option($p, XML_OPTION_CASE_FOLDING, 0);
	xml_parser_set_option($p, XML_OPTION_TARGET_ENCODING, 'UTF-8');
	xml_parse_into_struct($p, $data, $vals, $index);

	if (version_compare(PHP_VERSION, '8.0', '<')) {
		xml_parser_free($p);
	}

	$tree   = [];
	$i      = 0;
	$column = 0;
	$row    = 0;
	$tree   = get_rrd_children($vals, $i, $column, $row);

	return $tree;
}

function get_rrd_children(mixed $vals, int &$i, int &$column, int &$row) : array {
	$children = [];

	if (isset($vals[$i]['value'])) {
		if ($vals[$i]['value']) {
			array_push($children, $vals[$i]['value']);
		}
	}

	$prevtag = '';
	$j       = 0;

	while (++$i < cacti_count($vals)) {
		switch ($vals[$i]['type']) {
			case 'cdata':
				array_push($children, $vals[$i]['value']);

				break;
			case 'complete':
				/* if the value is an empty string, php doesn't include the 'value' key
				in its array, so we need to check for this first */
				if (isset($vals[$i]['value'])) {
					switch($vals[$i]['tag']) {
						case 'entry':
							$column++;
							$children['col' . $column] = $vals[$i]['value'];

							break;
						case 't':
							$children['timestamp'] = $vals[$i]['value'];

							break;
						case 'v':
							$column++;
							$children['col' . $column] = $vals[$i]['value'];

							break;
						default:
							$children[$vals[$i]['tag']] = $vals[$i]['value'];
					}
				} else {
					$children[$vals[$i]['tag']] = '';
				}

				break;
			case 'open':
				$j++;

				if ($prevtag != $vals[$i]['tag']) {
					$j       = 0;
					$prevtag = $vals[$i]['tag'];
				}

				switch($vals[$i]['tag']) {
					case 'meta':
					case 'xport':
					case 'legend':
						$children[$vals[$i]['tag']] = get_rrd_children($vals,$i,$column,$row);

						break;
					case 'data':
						break;
					case 'row':
						$row++;
						$column                 = 0;
						$children['data'][$row] = get_rrd_children($vals,$i,$column,$row);

						break;
				}

				break;
			case 'close':
				break 2;
		}
	}

	return $children;
}