Adding newer xmlreader code to it's own file so that it can be turned and off until remaining bugs are fixed

1 files changed, 222 insertions, 0 deletions

diff --git a/etc/inc/xmlreader.inc b/etc/inc/xmlreader.inc
new file mode 100644
index 0000000..7627c4b
--- /dev/null
+++ b/etc/inc/xmlreader.inc
@@ -0,0 +1,222 @@
+<?php
+/* $Id$ */
+/*
+	xmlparse.inc
+	functions to parse/dump configuration files in XML format
+	part of m0n0wall (http://m0n0.ch/wall)
+
+	Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>.
+	All rights reserved.
+
+	Redistribution and use in source and binary forms, with or without
+	modification, are permitted provided that the following conditions are met:
+
+	1. Redistributions of source code must retain the above copyright notice,
+	   this list of conditions and the following disclaimer.
+
+	2. Redistributions in binary form must reproduce the above copyright
+	   notice, this list of conditions and the following disclaimer in the
+	   documentation and/or other materials provided with the distribution.
+
+	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS 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
+	AUTHOR 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.
+*/
+
+/*
+	pfSense_MODULE:	utils
+*/
+
+/* The following items will be treated as arrays in config.xml */
+function listtags() {
+  /* 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 = explode(" ",
+		"alias aliasurl allowedip authserver bridged ca cacert cert config container ".
+		"columnitem depends_on_package disk dnsserver dnsupdate domainoverrides ".
+		"dyndns earlyshellcmd element encryption-algorithm-option field ".
+		"fieldname hash-algorithm-option gateway_item gateway_group gif gre ".
+		"group hosts member ifgroupentry igmpentry interface_array item key lagg " .
+		"lbaction lbpool l7rules lbprotocol ".
+		"member menu tab mobilekey monitor_type mount ntpserver onetoone ".
+		"openvpn-server openvpn-client openvpn-csc " .
+		"option ppp package passthrumac phase1 phase2 priv proxyarpnet qinqentry queue ".
+		"pages pipe roll route row rrddatafile rule schedule service servernat servers ".
+		"serversdisabled earlyshellcmd shellcmd staticmap subqueue timerange ".
+		"tunnel user vip virtual_server vlan winsserver wolentry widget  "
+		);
+	return array_flip($ret);
+}
+
+/* Package XML tags that should be treat as a list not as a traditional array */
+function listtags_pkg() {
+	$ret = array("depends_on_package", "onetoone", "queue", "rule", "servernat", "alias", "additional_files_needed", "tab", "template", "menu", "rowhelperfield", "service", "step", "package", "columnitem", "option", "item", "field", "package", "file");
+
+	return array_flip($ret);
+}
+
+function add_elements(&$cfgarray, &$parser) {
+        global $listtags;
+        while ($parser->read()) {
+                switch ($parser->nodeType) {
+                case XMLReader::WHITESPACE:
+                        //$type = "WHITESPACE";
+                        break;
+                case XMLReader::SIGNIFICANT_WHITESPACE:
+                        //$type = "SIGNIFICANT_WHITESPACE";
+                        break;
+                case XMLReader::ELEMENT:
+                        if ($parser->isEmptyElement) {
+                                $cfgarray[$parser->name] = "";
+                        } else {
+                                if (isset($listtags[$parser->name]))
+                                        add_elements($cfgarray[$parser->name][], $parser);
+                                else {
+                                        add_elements($cfgarray[$parser->name], $parser);
+					if (!isset($cfgarray[$parser->name]))
+						$cfgarray[$parser->name] = array();
+				}
+                        }
+                        break;
+                case XMLReader::TEXT:
+		case XMLReader::CDATA:
+                        $cfgarray = $parser->value;
+                        break;
+                case XMLReader::END_ELEMENT:
+                        return;
+                        break;
+                default:
+                        break;
+                }
+
+        }
+}
+
+function parse_xml_config($cffile, $rootobj, $isstring = "false") {
+	global $listtags;
+	$listtags = listtags();
+        if (isset($GLOBALS['custom_listtags'])) {
+          foreach($GLOBALS['custom_listtags'] as $tag) {
+            $listtags[$tag] = $tag;
+          }
+        }
+	return parse_xml_config_raw($cffile, $rootobj);
+}
+
+function parse_xml_config_pkg($cffile, $rootobj, $isstring = "false") {
+	global $listtags;
+	$listtags = listtags_pkg();
+        if (isset($GLOBALS['custom_listtags_pkg'])) {
+          foreach($GLOBALS['custom_listtags_pkg'] as $tag) {
+            $listtags[$tag] = $tag;
+          }
+        }
+	return parse_xml_config_raw($cffile, $rootobj, $isstring);
+}
+
+function parse_xml_config_raw($cffile, $rootobj, $isstring = "false") {
+
+	$parsedcfg = array();
+
+	$par = new XMLReader();
+	if ($par->open($cffile)) {
+		add_elements($parsedcfg, $par);
+		$par->close();
+	} else
+		log_error("Error returned while trying to parse {$cffile}");
+
+	return $parsedcfg[$rootobj];
+}
+
+function dump_xml_config_sub($arr, $indent) {
+
+	global $listtags;
+
+	$xmlconfig = "";
+
+	foreach ($arr as $ent => $val) {
+		if (is_array($val)) {
+			/* is it just a list of multiple values? */
+			if (isset($listtags[strtolower($ent)])) {
+				foreach ($val as $cval) {
+					if (is_array($cval)) {
+						$xmlconfig .= str_repeat("\t", $indent);
+						$xmlconfig .= "<$ent>\n";
+						$xmlconfig .= dump_xml_config_sub($cval, $indent + 1);
+						$xmlconfig .= str_repeat("\t", $indent);
+						$xmlconfig .= "</$ent>\n";
+					} else {
+						$xmlconfig .= str_repeat("\t", $indent);
+						if($cval === false) continue;
+						if(($cval === true) || ($cval === "")) {
+							$xmlconfig .= "<$ent/>\n";
+						} else {
+							$xmlconfig .= "<$ent>" . htmlspecialchars($cval) . "</$ent>\n";
+					}
+				}
+				}
+			} else {
+				/* 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);
+				$xmlconfig .= "<$ent>" . htmlspecialchars($val) . "</$ent>\n";
+			}
+		}
+	}
+
+	return $xmlconfig;
+}
+
+function dump_xml_config($arr, $rootobj) {
+	global $listtags;
+	$listtags = listtags();
+        if (isset($GLOBALS['custom_listtags'])) {
+          foreach($GLOBALS['custom_listtags'] as $tag) {
+            $listtags[$tag] = $tag;
+          }
+        }
+	return dump_xml_config_raw($arr, $rootobj);
+}
+
+function dump_xml_config_pkg($arr, $rootobj) {
+	global $listtags;
+	$listtags = listtags_pkg();
+        if (isset($GLOBALS['custom_listtags_pkg'])) {
+          foreach($GLOBALS['custom_listtags_pkg'] as $tag) {
+            $listtags[$tag] = $tag;
+          }
+        }
+	return dump_xml_config_raw($arr, $rootobj);
+}
+
+function dump_xml_config_raw($arr, $rootobj) {
+
+	$xmlconfig = "<?xml version=\"1.0\"?" . ">\n";
+	$xmlconfig .= "<$rootobj>\n";
+
+	$xmlconfig .= dump_xml_config_sub($arr, 1);
+
+	$xmlconfig .= "</$rootobj>\n";
+
+	return $xmlconfig;
+}
+
+?>