Merge pull request #171 from briantist/master

Added Filer package.

3 files changed, 435 insertions, 0 deletions

diff --git a/config/filer/filer.inc b/config/filer/filer.inc
new file mode 100644
index 00000000..906928f2
--- /dev/null
+++ b/config/filer/filer.inc
@@ -0,0 +1,193 @@
+<?php
+/* ========================================================================== */
+/*
+	filerinc
+    part of pfSense (http://www.pfSense.com)
+    Copyright (C) 2010 Scott Ullrich <sullrich@gmail.com>
+    Copyright (C) 2011 Marcello Coutinho
+    Copyright (C) 2011 Brian Scholer
+    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.
+                                                                              */
+/* ========================================================================== */
+
+
+function filer_install() {
+	// reserved
+}
+
+function filer_deinstall() {
+	// reserved
+}
+
+function filer_start() {
+	global $g, $config;
+	
+	// reserved
+}
+
+function sync_package_filer() {
+	global $config, $g;
+	
+	if($config['installedpackages']['filer']['config']!="") {
+		foreach($config['installedpackages']['filer']['config'] as $file) {
+			$fname = $file['fullfile'];
+			$fdata = base64_decode($file['filedata']);
+			if($file['mod']) {
+				if(!preg_match("/0?[0-7]{3}/", $file['mod'])) 
+					$mod = 0700;
+				else
+					$mod = octdec($file['mod']);
+			}
+			conf_mount_rw();
+			$fhnd = fopen($fname, 'w');
+			fwrite($fhnd, $fdata);
+			fclose($fhnd);
+			if($mod)
+				chmod($fname, $mod);
+			conf_mount_ro();
+		}
+	}
+	
+	filer_sync_on_changes();
+}
+
+/* Uses XMLRPC to synchronize the changes to a remote node */
+function filer_sync_on_changes() {
+	global $config, $g;
+	
+	log_error("[filer] filer_xmlrpc_sync.php is starting.");
+	$synconchanges = $config['installedpackages']['filersync']['config'][0]['synconchanges'];	
+	if(!$synconchanges) 
+		return;
+	foreach ($config['installedpackages']['filersync']['config'] as $rs ){
+		foreach($rs['row'] as $sh){
+			$sync_to_ip = $sh['ipaddress'];
+			$password = $sh['password'];
+			if($sh['username'])
+				$username = $sh['username'];
+			else
+				$username = 'admin';
+			if($password && $sync_to_ip)
+				filer_do_xmlrpc_sync($sync_to_ip, $username, $password);
+			}
+	}
+	log_error("[filer] filer_xmlrpc_sync.php is ending.");
+}
+/* Do the actual XMLRPC sync */
+function filer_do_xmlrpc_sync($sync_to_ip, $username, $password) {
+	global $config, $g;
+
+	if(!$username)
+		return;
+		
+	if(!$password)
+		return;
+
+	if(!$sync_to_ip)
+		return;
+
+	$xmlrpc_sync_neighbor = $sync_to_ip;
+    if($config['system']['webgui']['protocol'] != "") {
+		$synchronizetoip = $config['system']['webgui']['protocol'];
+		$synchronizetoip .= "://";
+    }
+    $port = $config['system']['webgui']['port'];
+    /* if port is empty lets rely on the protocol selection */
+    if($port == "") {
+		if($config['system']['webgui']['protocol'] == "http") 
+			$port = "80";
+		else 
+			$port = "443";
+    }
+	$synchronizetoip .= $sync_to_ip;
+
+	/* xml will hold the sections to sync */
+	$xml = array();
+	$xml['filer'] = $config['installedpackages']['filer'];
+	
+	/* assemble xmlrpc payload */
+	$params = array(
+		XML_RPC_encode($password),
+		XML_RPC_encode($xml)
+	);
+
+	/* set a few variables needed for sync code borrowed from filter.inc */
+	$url = $synchronizetoip;
+	log_error("Beginning Filer XMLRPC sync to {$url}:{$port}.");
+	$method = 'pfsense.merge_installedpackages_section_xmlrpc';
+	$msg = new XML_RPC_Message($method, $params);
+	$cli = new XML_RPC_Client('/xmlrpc.php', $url, $port);
+	$cli->setCredentials($username, $password);
+	if($g['debug'])
+		$cli->setDebug(1);
+	/* send our XMLRPC message and timeout after 250 seconds */
+	$resp = $cli->send($msg, "250");
+	if(!$resp) {
+		$error = "A communications error occurred while attempting filer XMLRPC sync with {$url}:{$port}.";
+		log_error($error);
+		file_notice("sync_settings", $error, "filer Settings Sync", "");
+	} elseif($resp->faultCode()) {
+		$cli->setDebug(1);
+		$resp = $cli->send($msg, "250");
+		$error = "An error code was received while attempting filer XMLRPC sync with {$url}:{$port} - Code " . $resp->faultCode() . ": " . $resp->faultString();
+		log_error($error);
+		file_notice("sync_settings", $error, "filer Settings Sync", "");
+	} else {
+		log_error("filer XMLRPC sync successfully completed with {$url}:{$port}.");
+	}
+	
+	/* tell filer to reload our settings on the destionation sync host. */
+	$method = 'pfsense.exec_php';
+	$execcmd  = "require_once('/usr/local/pkg/filer.inc');\n";
+	$execcmd .= "sync_package_filer();";
+	/* assemble xmlrpc payload */
+	$params = array(
+		XML_RPC_encode($password),
+		XML_RPC_encode($execcmd)
+	);
+	
+	log_error("filer XMLRPC reload data {$url}:{$port}.");
+	$msg = new XML_RPC_Message($method, $params);
+	$cli = new XML_RPC_Client('/xmlrpc.php', $url, $port);
+	$cli->setCredentials($username, $password);
+	$resp = $cli->send($msg, "250");
+	if(!$resp) {
+		$error = "A communications error occurred while attempting filer XMLRPC sync with {$url}:{$port} (pfsense.exec_php).";
+		log_error($error);
+		file_notice("sync_settings", $error, "filer Settings Sync", "");
+	} elseif($resp->faultCode()) {
+		$cli->setDebug(1);
+		$resp = $cli->send($msg, "250");
+		$error = "An error code was received while attempting filer XMLRPC sync with {$url}:{$port} - Code " . $resp->faultCode() . ": " . $resp->faultString();
+		log_error($error);
+		file_notice("sync_settings", $error, "filer Settings Sync", "");
+	} else {
+		log_error("filer XMLRPC reload data success with {$url}:{$port} (pfsense.exec_php).");
+	}
+	
+}
+
+?>
diff --git a/config/filer/filer.xml b/config/filer/filer.xml
new file mode 100644
index 00000000..f772feb2
--- /dev/null
+++ b/config/filer/filer.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE packagegui SYSTEM "./schema/packages.dtd">
+<?xml-stylesheet type="text/xsl" href="./xsl/package.xsl"?>
+<packagegui>
+        <copyright>
+        <![CDATA[
+/* ========================================================================== */
+/*
+    filer.xml
+    part of pfSense (http://www.pfSense.com)
+    Copyright (C) 2010 Scott Ullrich <sullrich@gmail.com>
+    Copyright (C) 2011 Brian Scholer
+    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.
+                                                                              */
+/* ========================================================================== */
+        ]]>
+        </copyright>
+    <description>Describe your package here</description>
+    <requirements>Describe your package requirements here</requirements>
+    <faq>Currently there are no FAQ items provided.</faq>
+	<name>filer</name>
+	<version>0.5</version>
+	<title>Filer</title>
+	<include_file>/usr/local/pkg/filer.inc</include_file>
+	<additional_files_needed>
+		<prefix>/usr/local/pkg/</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/filer/filer.inc</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/pkg/</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/filer/filer_sync.xml</item>
+	</additional_files_needed>
+	<menu>
+		<name>Filer</name>
+		<tooltiptext>Filer</tooltiptext>
+		<section>Diagnostics</section>
+		<configfile>filer.xml</configfile>
+	</menu>
+	<tabs>
+		<tab>
+			<text>Files</text>
+			<url>/pkg.php?xml=filer.xml</url>
+			<active/>
+		</tab>
+		<tab>
+			<text>XMLRPC Sync</text>
+			<url>/pkg_edit.php?xml=filer_sync.xml</url>
+			<active/>
+		</tab>
+	</tabs>
+	
+	<adddeleteeditpagefields>
+		<columnitem>
+			<fielddescr>File</fielddescr>
+			<fieldname>fullfile</fieldname>
+		</columnitem>
+		<columnitem>
+			<fielddescr>Permissions</fielddescr>
+			<fieldname>mod</fieldname>
+		</columnitem>
+		<columnitem>
+			<fielddescr>Description</fielddescr>
+			<fieldname>description</fieldname>
+		</columnitem>	
+	</adddeleteeditpagefields>
+	<fields>
+		<field>
+			<fielddescr>Full path to the file</fielddescr>
+			<fieldname>fullfile</fieldname>
+			<type>input</type>
+			<required/>
+		</field>
+		<field>
+			<fielddescr>Permissions</fielddescr>
+			<fieldname>mod</fieldname>
+			<type>input</type>
+			<description>Blank leaves the permissions alone.</description>
+		</field>
+		<field>
+			<fielddescr>Description</fielddescr>
+			<fieldname>description</fieldname>
+			<description>Enter a description for this file.</description>
+			<type>input</type>
+		</field>
+		<field>
+			<fielddescr>File Contents</fielddescr>
+			<fieldname>filedata</fieldname>
+			<description>Paste the files contents here.</description>
+			<type>textarea</type>
+			<encoding>base64</encoding>
+			<cols>60</cols>
+			<rows>30</rows>
+			<required/>
+		</field>
+	</fields>
+	<custom_php_install_command>
+		filer_install();
+	</custom_php_install_command>
+	<custom_php_command_before_form>
+	</custom_php_command_before_form>
+	<custom_delete_php_command>
+		sync_package_filer();
+	</custom_delete_php_command>	
+	<custom_php_resync_config_command>
+		sync_package_filer();
+	</custom_php_resync_config_command>
+</packagegui>
\ No newline at end of file
diff --git a/config/filer/filer_sync.xml b/config/filer/filer_sync.xml
new file mode 100644
index 00000000..ae8e48ba
--- /dev/null
+++ b/config/filer/filer_sync.xml
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE packagegui SYSTEM "../schema/packages.dtd">
+<?xml-stylesheet type="text/xsl" href="../xsl/package.xsl"?>
+<packagegui>
+        <copyright>
+        <![CDATA[
+/* ========================================================================== */
+/*
+    filer_sync.xml
+    part of pfSense (http://www.pfSense.com)
+    Copyright (C) 2008 Scott Ullrich <sullrich@gmail.com>
+    Copyright (C) 2011 Marcello Coutinho
+    Copyright (C) 2011 Brian Scholer
+    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.
+                                                                              */
+/* ========================================================================== */
+        ]]>
+        </copyright>
+    <description>Describe your package here</description>
+    <requirements>Describe your package requirements here</requirements>
+    <faq>Currently there are no FAQ items provided.</faq>
+	<name>filersync</name>
+	<version>1.1</version>
+	<title>Filer: Sync</title>
+	<include_file>/usr/local/pkg/filer.inc</include_file>
+	<tabs>
+		<tab>
+			<text>Files</text>
+			<url>/pkg.php?xml=filer.xml</url>
+			<active/>
+		</tab>
+		<tab>
+			<text>XMLRPC Sync</text>
+			<url>/pkg_edit.php?xml=filer_sync.xml</url>
+			<active/>
+		</tab>
+	</tabs>
+	<fields>
+		<field>
+			<type>listtopic</type>
+			<fieldname>temp</fieldname>
+			<name>Enable Filer configuration sync</name>
+		</field>		
+		<field>
+			<fielddescr>Automatically sync Filer configuration changes</fielddescr>
+			<fieldname>synconchanges</fieldname>
+			<description>pfSense will automatically sync changes to the hosts defined below. Blank user assumes 'admin'.</description>
+			<type>checkbox</type>
+		</field>
+		<field>
+			<fielddescr>Remote Servers</fielddescr>
+			<fieldname>none</fieldname>
+			<type>rowhelper</type>
+			<rowhelper>
+			<rowhelperfield>
+				<fielddescr>IP Address</fielddescr>
+				<fieldname>ipaddress</fieldname>
+				<description>IP Address of remote server</description>
+				<type>input</type>
+				<size>20</size>
+				<required/>
+			</rowhelperfield>
+			<rowhelperfield>
+				<fielddescr>User Name</fielddescr>
+				<fieldname>username</fieldname>
+				<description>user name of remote server</description>
+				<type>input</type>
+				<size>20</size>
+			</rowhelperfield>
+			<rowhelperfield>
+				<fielddescr>Password</fielddescr>
+				<fieldname>password</fieldname>
+				<description>Password for remote server.</description>
+				<type>password</type>
+				<size>20</size>
+				<required/>
+			</rowhelperfield>
+			</rowhelper>
+		</field>
+	</fields>
+	<custom_php_resync_config_command>
+		filer_sync_on_changes();		
+	</custom_php_resync_config_command>
+	<custom_php_command_before_form>	
+		unset($_POST['temp']);
+	</custom_php_command_before_form>
+</packagegui>
\ No newline at end of file