pfSense

<?php

/*

	xmlparse.inc

	functions to parse/dump configuration files in XML format

	Copyright (c) 2004-2016 Electric Sheep Fencing, LLC.

	All rights reserved.

	originally part of m0n0wall (http://m0n0.ch/wall)

	All rights reserved.

	modification, are permitted provided that the following conditions are met:

	   this list of conditions and the following disclaimer.

	   the documentation and/or other materials provided with the

	   distribution.

	3. All advertising materials mentioning features or use of this software

	   must display the following acknowledgment:

	   "This product includes software developed by the pfSense Project

	   for use in the pfSense® software distribution. (http://www.pfsense.org/).

	4. The names "pfSense" and "pfSense Project" must not be used to

	   endorse or promote products derived from this software without

	   prior written permission. For written permission, please contact

	   coreteam@pfsense.org.

	5. Products derived from this software may not be called "pfSense"

	   nor may "pfSense" appear in their names without prior written

	   permission of the Electric Sheep Fencing, LLC.

	6. Redistributions of any form whatsoever must retain the following

	   acknowledgment:

	"This product includes software developed by the pfSense Project

	for use in the pfSense software distribution (http://www.pfsense.org/).

	THIS SOFTWARE IS PROVIDED BY THE pfSense PROJECT ``AS IS'' AND ANY

	EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

	PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE pfSense PROJECT OR

	ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

	NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

	HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

	STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

	OF THE POSSIBILITY OF SUCH DAMAGE.

	 * Please keep this list alpha sorted and no longer than 80 characters

	 * I know it's a pain, but it's a pain to find stuff too if it's not

	 */

	$ret = array(

		'bridged', 'build_port_path',

		'ca', 'cacert', 'cert', 'crl', 'clone', 'config', 'container', 'columnitem',

		'depends_on_package', 'disk', 'dnsserver', 'dnsupdate', 'domainoverrides', 'dyndns',

		'earlyshellcmd', 'element', 'encryption-algorithm-option',

		'field', 'fieldname',

		'gateway_item', 'gateway_group', 'gif', 'gre', 'group',

		'hash-algorithm-option', 'hosts', 'member', 'ifgroupentry', 'igmpentry', 'interface_array', 'item', 'key',

		'lagg', 'lbaction', 'lbpool', 'l7rules', 'lbprotocol',

		'member', 'menu', 'tab', 'mobilekey', 'monitor_type', 'mount',

		'package', 'passthrumac', 'phase1', 'phase2', 'ppp', 'pppoe', 'priv', 'proxyarpnet', 'pool',

		'winsserver', 'wolentry', 'widget'

	);

	$ptr =& $parsedcfg;

	foreach ($curpath as $path) {

		$ptr =& $ptr[$path];

	}

	/* is it an element that belongs to a list? */

		/* is there an array already? */

		if (!is_array($ptr)) {

			/* make an array */

			$ptr = array();

		}

		array_push($curpath, count($ptr));

	} else if (isset($ptr)) {

		/* multiple entries not allowed for this element, bail out */

		    xml_get_current_line_number($parser)));

	$depth++;

	$havedata = $depth;

}

function endElement($parser, $name) {

	global $depth, $curpath, $parsedcfg, $havedata, $listtags;

	if ($havedata == $depth) {

		$ptr =& $parsedcfg;

		foreach ($curpath as $path) {

			$ptr =& $ptr[$path];

		}

		$ptr = "";

	}

	array_pop($curpath);

	$depth--;

}

function cData($parser, $data) {

	global $depth, $curpath, $parsedcfg, $havedata;

	$data = trim($data, "\t\n\r");

	if ($data != "") {

		$ptr =& $parsedcfg;

		foreach ($curpath as $path) {

			$ptr =& $ptr[$path];

		}

		if (is_string($ptr)) {

			if (trim($data, " ") != "") {

			}

		}

	}

		foreach ($GLOBALS['custom_listtags'] as $tag) {

			$listtags[$tag] = $tag;

		}

	}

		foreach ($GLOBALS['custom_listtags_pkg'] as $tag) {

			$listtags[$tag] = $tag;

		}

	}

	$depth = 0;

	$havedata = 0;

	$xml_parser = xml_parser_create();

	xml_set_element_handler($xml_parser, "startElement", "endElement");

	xml_set_character_data_handler($xml_parser, "cdata");

	if (!($fp = fopen($cffile, "r"))) {

		if (!xml_parse($xml_parser, $data, feof($fp))) {

				xml_get_current_line_number($xml_parser),

				$cffile));

		}

	}

	xml_parser_free($xml_parser);

		foreach ($rootobj as $rootobj_name) {

			if ($parsedcfg[$rootobj_name]) {

		}

			log_error(sprintf(gettext("XML error: no %s object found!") . "\n", implode(" or ", $rootobj)));

			return -1;

		}

		return $parsedcfg[$rootobj_name];

	} else {

		return $parsedcfg;

function dump_xml_config_sub($arr, $indent) {

	global $listtags;

	foreach ($arr as $ent => $val) {

		if (is_array($val)) {

			/* is it just a list of multiple values? */

					if (is_array($cval)) {

							$xmlconfig .= str_repeat("\t", $indent);

							$xmlconfig .= "<$ent/>\n";

						} else {

							$xmlconfig .= str_repeat("\t", $indent);

							$xmlconfig .= "<$ent>\n";

							$xmlconfig .= dump_xml_config_sub($cval, $indent + 1);

							$xmlconfig .= str_repeat("\t", $indent);

							$xmlconfig .= "</$ent>\n";

						}

							continue;

						}

						    (substr($ent, 0, 6) == "detail") ||

						    (substr($ent, 0, 12) == "login_banner") ||

						    (substr($ent, 0, 9) == "ldap_attr") ||

						    (substr($ent, 0, 9) == "ldap_bind") ||

						    (substr($ent, 0, 11) == "ldap_basedn") ||

						    (substr($ent, 0, 18) == "ldap_authcn") ||

						    (substr($ent, 0, 19) == "ldap_extended_query")) {

				}

				$xmlconfig .= str_repeat("\t", $indent);

				$xmlconfig .= "<$ent/>\n";

				/* it's an array */

				$xmlconfig .= str_repeat("\t", $indent);

				$xmlconfig .= "<$ent>\n";

				$xmlconfig .= dump_xml_config_sub($val, $indent + 1);

				$xmlconfig .= str_repeat("\t", $indent);

				$xmlconfig .= "</$ent>\n";

			}

		} else {

			if ((is_bool($val) && ($val == true)) || ($val === "")) {

				$xmlconfig .= str_repeat("\t", $indent);

				$xmlconfig .= "<$ent/>\n";

			} else if (!is_bool($val)) {

				$xmlconfig .= str_repeat("\t", $indent);

				    (substr($ent, 0, 6) == "detail") ||

				    (substr($ent, 0, 12) == "login_banner") ||

				    (substr($ent, 0, 9) == "ldap_attr") ||

				    (substr($ent, 0, 9) == "ldap_bind") ||

				    (substr($ent, 0, 11) == "ldap_basedn") ||

				    (substr($ent, 0, 18) == "ldap_authcn") ||

		}

	}

}

function dump_xml_config($arr, $rootobj) {

		foreach ($GLOBALS['custom_listtags'] as $tag) {

			$listtags[$tag] = $tag;

		}

	}

}

function dump_xml_config_pkg($arr, $rootobj) {

	global $listtags;

		foreach ($GLOBALS['custom_listtags_pkg'] as $tag) {

			$listtags[$tag] = $tag;

		}

	}

}

function dump_xml_config_raw($arr, $rootobj) {

	$xmlconfig = "<?xml version=\"1.0\"?" . ">\n";

	$xmlconfig .= "<$rootobj>\n";

}