/src/etc/inc/xmlreader.inc - Annotate - pfSense - pfSense bugtracker

| Branch: | Tag: | Revision:

root/src/etc/inc/xmlreader.inc @ d800d0f5

-cb8
+<?php
 /*
-acd654a
+ * xmlreader.inc
+ *
  * part of pfSense (https://www.pfsense.org)
-a2396a6
+ * Copyright (c) 2004-2016 Rubicon Communications, LLC (Netgate)
-acd654a
+ * All rights reserved.
+ *
  * originally part of m0n0wall (http://m0n0.ch/wall)
-            aaec5634
+ * Copyright (c) 2003-2004 Manuel Kasper <mk@neon1.net>.
-acd654a
+ * 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.
+ *
  * 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.
  */
-cb8
+            Scott Ullrich
 /* The following items will be treated as arrays in config.xml */
 function listtags() {
-a8c829
+	/*
-            79262830
+	 * 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
 	 */
-            b79ea46a
+	$ret = array(
-a8c829
+		'acls', 'alias', 'aliasurl', 'allowedip', 'allowedhostname', 'authserver',
 		'bridged', 'build_port_path',
 		'ca', 'cacert', 'cert', 'crl', 'clone', 'config', 'container', 'columnitem',
-            b89bc607
+		'checkipservice',
-a8c829
+		'depends_on_package', 'disk', 'dnsserver', 'dnsupdate', 'domainoverrides', 'dyndns',
 		'earlyshellcmd', 'element', 'encryption-algorithm-option',
 		'field', 'fieldname',
 		'gateway_item', 'gateway_group', 'gif', 'gre', 'group',
-            f3d9f32b
+		'hash-algorithm-option', 'hosts', 'ifgroupentry', 'igmpentry', 'interface_array', 'item', 'key',
-a8c829
+		'lagg', 'lbaction', 'lbpool', 'l7rules', 'lbprotocol',
 		'member', 'menu', 'tab', 'mobilekey', 'monitor_type', 'mount',
 		'npt', 'ntpserver',
 		'onetoone', 'openvpn-server', 'openvpn-client', 'openvpn-csc', 'option',
 		'package', 'passthrumac', 'phase1', 'phase2', 'ppp', 'pppoe', 'priv', 'proxyarpnet', 'pool',
 		'qinqentry', 'queue',
 		'pages', 'pipe', 'radnsserver', 'roll', 'route', 'row', 'rrddatafile', 'rule',
 		'schedule', 'service', 'servernat', 'servers',
 		'serversdisabled', 'shellcmd', 'staticmap', 'subqueue',
 		'timerange', 'tunnel', 'user', 'vip', 'virtual_server', 'vlan',
 		'winsserver', 'wolentry', 'widget'
 	);
-cb8
+	return array_flip($ret);
+}
 /* Package XML tags that should be treat as a list not as a traditional array */
 function listtags_pkg() {
-            b79ea46a
+	$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');
-cb8
+            Scott Ullrich
 	return array_flip($ret);
+}
 function add_elements(&$cfgarray, &$parser) {
-            79262830
+	global $listtags;
 	while ($parser->read()) {
 		switch ($parser->nodeType) {
 			case XMLReader::WHITESPACE:
 			case XMLReader::SIGNIFICANT_WHITESPACE:
 				break;
 			case XMLReader::ELEMENT:
 				if (isset($listtags[strtolower($parser->name)])) {
 					$cfgref =& $cfgarray[$parser->name][count($cfgarray[$parser->name])];
 					if (!$parser->isEmptyElement) {
-            ddfe5e43
+						add_elements($cfgref, $parser);
-            79262830
+					} else {
 						$cfgref = array();
+					}
 				} else {
 					if (isset($cfgarray[$parser->name]) && (!is_array($cfgarray[$parser->name]) || !isset($cfgarray[$parser->name][0]))) {
 						$nodebkp = $cfgarray[$parser->name];
 						$cfgarray[$parser->name] = array();
 						$cfgarray[$parser->name][] = $nodebkp;
 						$cfgref =& $cfgarray[$parser->name][0];
 						unset($nodebkp);
 					} else {
 						$cfgref =& $cfgarray[$parser->name];
+					}
 					if ($parser->isEmptyElement) {
 						if (is_array($cfgref)) {
 							$cfgref[] = array();
 						} else {
 							$cfgref = "";
+						}
 					} else {
 						if (is_array($cfgref)) {
 							$cfgref =& $cfgarray[$parser->name][count($cfgarray[$parser->name])];
 							add_elements($cfgref, $parser);
 						} else {
 							add_elements($cfgref, $parser);
+						}
+					}
-            ddfe5e43
+            Ermal
-ffb5ccd
+            Ermal
-            79262830
+				$i = 0;
 				while ($parser->moveToAttributeNo($i)) {
 					$cfgref[$parser->name] = $parser->value;
 					$i++;
+				}
 				break;
 			case XMLReader::TEXT:
 			case XMLReader::CDATA:
 				$cfgarray = $parser->value;
 				break;
 			case XMLReader::END_ELEMENT:
 				return;
 				break;
 			default:
 				break;
+		}
-            ab83fce0
+            Ermal
-cb8
+            Scott Ullrich
 function parse_xml_config($cffile, $rootobj, $isstring = "false") {
 	global $listtags;
-            b79ea46a
+            Ermal
-cb8
+	$listtags = listtags();
-            79262830
+	if (isset($GLOBALS['custom_listtags'])) {
 		foreach ($GLOBALS['custom_listtags'] as $tag) {
 			$listtags[$tag] = $tag;
+		}
+	}
-            ab83fce0
+            Ermal
-cb8
+	return parse_xml_config_raw($cffile, $rootobj);
+}
 function parse_xml_config_pkg($cffile, $rootobj, $isstring = "false") {
 	global $listtags;
-            b79ea46a
+            Ermal
-cb8
+	$listtags = listtags_pkg();
-            79262830
+	if (isset($GLOBALS['custom_listtags_pkg'])) {
 		foreach ($GLOBALS['custom_listtags_pkg'] as $tag) {
 			$listtags[$tag] = $tag;
+		}
+	}
-cb8
+	return parse_xml_config_raw($cffile, $rootobj, $isstring);
+}
 function parse_xml_config_raw($cffile, $rootobj, $isstring = "false") {
-            b79ea46a
+	global $listtags;
-cb8
+            Scott Ullrich
 	$parsedcfg = array();
 	$par = new XMLReader();
-            ab83fce0
+	if ($par->open($cffile, "UTF-8", LIBXML_NOERROR | LIBXML_NOWARNING)) {
-cb8
+		add_elements($parsedcfg, $par);
 		$par->close();
-            79262830
+	} else {
-cfa35df
+		log_error(sprintf(gettext("Error returned while trying to parse %s"), $cffile));
-            79262830
+            Phil Davis
-cb8
+            Scott Ullrich
-c289f
+	if ($rootobj) {
-            79262830
+		if (!is_array($rootobj)) {
-c289f
+			$rootobj = array($rootobj);
-            79262830
+            Phil Davis
 		foreach ($rootobj as $rootobj_name) {
 			if ($parsedcfg[$rootobj_name]) {
-c289f
+				break;
-            79262830
+            Phil Davis
+		}
-c289f
+		return $parsedcfg[$rootobj_name];
 	} else {
 		return $parsedcfg;
+	}
-cb8
+            Scott Ullrich
-            ab83fce0
+function dump_xml_config_sub(& $writer, $arr) {
-            79262830
+	global $listtags;
 	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)) {
 						if (empty($cval)) {
-            e5f9360f
+							$writer->startElement($ent);
 							$writer->endElement();
-            79262830
+						} else {
 							$writer->startElement($ent);
 							dump_xml_config_sub($writer, $cval);
 							$writer->endElement();
+						}
 					} else {
 						if ($cval === false) {
 							continue;
+						}
 						if ((is_bool($val) && ($val == true)) || ($val === "")) {
-            e5f9360f
+							$writer->startElement($ent);
 							$writer->endElement();
-            79262830
+						} else if (!is_bool($val)) {
-            ab83fce0
+							$writer->writeElement($ent, $cval);
-            79262830
+            Phil Davis
+					}
+				}
 			} else if (empty($val)) {
-            e5f9360f
+				$writer->startElement($ent);
 				$writer->endElement();
-            79262830
+			} else {
 				/* it's an array */
 				$writer->startElement($ent);
 				dump_xml_config_sub($writer, $val);
 				$writer->endElement();
+			}
 		} else {
 			if ((is_bool($val) && ($val == true)) || ($val === "")) {
-            e5f9360f
+				$writer->startElement($ent);
 				$writer->endElement();
-            79262830
+			} else if (!is_bool($val)) {
 				$writer->writeElement($ent, $val);
+			}
+		}
+	}
-cb8
+            Scott Ullrich
 function dump_xml_config($arr, $rootobj) {
 	global $listtags;
-            b79ea46a
+            Ermal
-cb8
+	$listtags = listtags();
-            79262830
+	if (isset($GLOBALS['custom_listtags'])) {
 		foreach ($GLOBALS['custom_listtags'] as $tag) {
 			$listtags[$tag] = $tag;
+		}
+	}
-            e5f9360f
+            Steve Beaver
-cb8
+	return dump_xml_config_raw($arr, $rootobj);
+}
 function dump_xml_config_pkg($arr, $rootobj) {
 	global $listtags;
-            b79ea46a
+            Ermal
-cb8
+	$listtags = listtags_pkg();
-            79262830
+	if (isset($GLOBALS['custom_listtags_pkg'])) {
 		foreach ($GLOBALS['custom_listtags_pkg'] as $tag) {
 			$listtags[$tag] = $tag;
+		}
+	}
-cb8
+	return dump_xml_config_raw($arr, $rootobj);
+}
 function dump_xml_config_raw($arr, $rootobj) {
-            79262830
+	$writer = new XMLWriter();
 	$writer->openMemory();
 	$writer->setIndent(true);
 	$writer->setIndentString("\t");
 	$writer->startDocument("1.0", "UTF-8");
 	$writer->startElement($rootobj);
-cb8
+            Scott Ullrich
-            79262830
+	dump_xml_config_sub($writer, $arr);
-cb8
+            Scott Ullrich
-            79262830
+	$writer->endElement();
 	$writer->endDocument();
 	$xmlconfig = $writer->outputMemory(true);
-            b79ea46a
+            Ermal
-            79262830
+	return $xmlconfig;
-cb8
+            Scott Ullrich
 ?>

Project

General

Profile

pfSense