zabbix2-agent - code style cleanup

- Fix copyright header
- Fix file permissions
- Nuke unused/useless tags
- Improve some descriptions.
- Move User Parameters to advancedfield.

1 files changed, 87 insertions, 51 deletions

diff --git a/config/zabbix2/zabbix2-agent.xml b/config/zabbix2/zabbix2-agent.xml
index 3d2400ad..d59f99f2 100644
--- a/config/zabbix2/zabbix2-agent.xml
+++ b/config/zabbix2/zabbix2-agent.xml
@@ -1,47 +1,51 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE packagegui SYSTEM "../schema/packages.dtd">
+<?xml-stylesheet type="text/xsl" href="../xsl/package.xsl"?>
 <packagegui>
-<copyright>
+	<copyright>
 	<![CDATA[
 /* $Id$ */
-/* ========================================================================== */
+/* ====================================================================================== */
 /*
-    zabbix2-agent.xml
-    part of the Zabbix package for pfSense
-    Copyright (C) 2013 Danilo G. Baio
+	zabbix2-agent.xml
+	part of pfSense (https://www.pfSense.org/)
+	Copyright (C) 2013 Danilo G. Baio
 	Copyright (C) 2013 Marcello Coutinho
-	
-    All rights reserved.            
-			                                                                  */
-/* ========================================================================== */
+	Copyright (C) 2015 ESF, LLC
+	All rights reserved.
+*/
+/* ====================================================================================== */
 /*
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
+	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.
+	1. Redistributions of source code must retain the above copyright notice,
+	   this list of conditions and the following disclaimer.
 
-    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.
-                                                                              */
-/* ========================================================================== */
+	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>
 	<name>zabbixagent</name>
 	<title>Services: Zabbix-2 Agent</title>
 	<category>Monitoring</category>
-	<version>0.8.3</version>
+	<version>0.8.4</version>
 	<include_file>/usr/local/pkg/zabbix2.inc</include_file>
 	<addedit_string>Zabbix Agent has been created/modified.</addedit_string>
 	<delete_string>Zabbix Agent has been deleted.</delete_string>
@@ -49,7 +53,6 @@
 	<additional_files_needed>
 		<item>https://packages.pfsense.org/packages/config/zabbix2/zabbix2.inc</item>
 		<prefix>/usr/local/pkg/</prefix>
-		<chmod>0755</chmod>
 	</additional_files_needed>
 	<menu>
 		<name>Zabbix-2 Agent</name>
@@ -61,7 +64,7 @@
 		<name>zabbix_agentd</name>
 		<rcfile>zabbix2_agentd.sh</rcfile>
 		<executable>zabbix_agentd</executable>
-		<description>Zabbix Agent host monitor daemon</description>
+		<description>Zabbix Agent Host Monitor Daemon</description>
 	</service>
 	<tabs>
 		<tab>
@@ -70,6 +73,7 @@
 			<active />
 		</tab>
 	</tabs>
+	<advanced_options>enabled</advanced_options>
 	<fields>
 		<field>
 			<name>Zabbix2 Agent Settings</name>
@@ -78,27 +82,27 @@
 		<field>
 			<fielddescr>Enable</fielddescr>
 			<fieldname>agentenabled</fieldname>
-			<description>Enable Zabbix2 Agent service</description>
+			<description>Enable Zabbix2 Agent service.</description>
 			<type>checkbox</type>
 		</field>
 		<field>
 			<fielddescr>Server</fielddescr>
 			<fieldname>server</fieldname>
-			<description>List of comma delimited IP addresses (or hostnames) of ZABBIX servers</description>
+			<description>List of comma delimited IP addresses (or hostnames) of Zabbix servers.</description>
 			<type>input</type>
 			<size>60</size>
 		</field>
 		<field>
 			<fielddescr>Server Active</fielddescr>
 			<fieldname>serveractive</fieldname>
-			<description>List of comma delimited IP:port (or hostname:port) pairs of Zabbix servers for active checks</description>
+			<description>List of comma delimited IP:port (or hostname:port) pairs of Zabbix servers for active checks.</description>
 			<type>input</type>
 			<size>60</size>
 		</field>
 		<field>
 			<fielddescr>Hostname</fielddescr>
 			<fieldname>hostname</fieldname>
-			<description>Unique hostname. Required for active checks and must match hostname as configured on the Zabbix server (case sensitive).</description>
+			<description>Unique, case sensitive hostname. Required for active checks and must match hostname as configured on the Zabbix server.</description>
 			<type>input</type>
 			<size>60</size>
 		</field>
@@ -108,7 +112,7 @@
 			<default_value>0.0.0.0</default_value>
 			<type>input</type>
 			<size>60</size>
-			<description>Listen IP for connections from the server (default 0.0.0.0 for all interfaces)</description>
+			<description>Listen IP for connections from the server. (Default: 0.0.0.0 - all interfaces)</description>
 		</field>
 		<field>
 			<fielddescr>Listen Port</fielddescr>
@@ -116,7 +120,7 @@
 			<default_value>10050</default_value>
 			<type>input</type>
 			<size>5</size>
-			<description>Listen port for connections from the server (default 10050)</description>
+			<description>Listen port for connections from the server. (Default: 10050)</description>
 		</field>
 		<field>
 			<fielddescr>Refresh Active Checks</fielddescr>
@@ -124,7 +128,7 @@
 			<default_value>120</default_value>
 			<type>input</type>
 			<size>5</size>
-			<description>The agent will refresh list of active checks once per 120 (default) seconds.</description>
+			<description>The agent will refresh list of active checks once per this number of seconds. (Default: 120)</description>
 		</field>
 		<field>
 			<fielddescr>Timeout</fielddescr>
@@ -132,7 +136,13 @@
 			<default_value>3</default_value>
 			<type>input</type>
 			<size>5</size>
-			<description>Timeout (default 3). Do not spend more that Timeout seconds on getting requested value (1-30). The agent does not kill timeouted User Parameters processes!</description>
+			<description>
+				<![CDATA[
+				Do not spend more that N seconds on getting requested value.<br />
+				Note: The agent does not kill timeouted User Parameters processes!<br />
+				(Default: 3. Valid range: 1-30)
+				]]>
+			</description>
 		</field>
 		<field>
 			<fielddescr>Buffer Send</fielddescr>
@@ -140,7 +150,12 @@
 			<default_value>5</default_value>
 			<type>input</type>
 			<size>5</size>
-			<description>Buffer Send (default 5). Do not keep data longer than N seconds in buffer (1-3600).</description>
+			<description>
+				<![CDATA[
+				Do not keep data longer than N seconds in buffer.<br />
+				(Default: 5. Valid range: 1-3600)
+				]]>
+			</description>
 		</field>
 		<field>
 			<fielddescr>Buffer Size</fielddescr>
@@ -148,7 +163,12 @@
 			<default_value>100</default_value>
 			<type>input</type>
 			<size>5</size>
-			<description>Buffer Size (default 100). Maximum number of values in a memory buffer (2-65535). The agent will send all collected data to Zabbix server or proxy if the buffer is full.</description>
+			<description>
+				<![CDATA[
+				Maximum number of values in the memory buffer. The agent will send all collected data to Zabbix server or proxy if the buffer is full.<br />
+				(Default: 100. Valid range: 2-65535)
+				]]>
+			</description>
 		</field>
 		<field>
 			<fielddescr>Start Agents</fielddescr>
@@ -156,7 +176,13 @@
 			<default_value>3</default_value>
 			<type>input</type>
 			<size>5</size>
-			<description>Start Agents (default 3). Number of pre-forked instances of zabbix_agentd that process passive checks (0-100).If set to 0, disables passive checks and the agent will not listen on any TCP port.</description>
+			<description>
+				<![CDATA[
+				Number of pre-forked instances of zabbix_agentd that process passive checks.<br />
+				Note: Setting to 0 disables passive checks and the agent will not listen on any TCP port.<br />
+				(Default: 3. Valid range: 0-100)
+				]]>
+			</description>
 		</field>
 		<field>
 			<fielddescr>User Parameters</fielddescr>
@@ -165,15 +191,25 @@
 			<type>textarea</type>
 			<rows>5</rows>
 			<cols>50</cols>
-			<description>User-defined parameter to monitor. There can be several user-defined parameters. Value has form, example: UserParameter=users,who|wc -l</description>
+			<description>
+				<![CDATA[
+				User-defined parameter(s) to monitor. There can be multiple user-defined parameters.<br />
+				Example: <em>UserParameter=users,who|wc -l</em>
+				]]>
+			</description>
+			<advancedfield/>
 		</field>
 	</fields>
-	<custom_php_install_command>sync_package_zabbix2();</custom_php_install_command>
-	<custom_php_command_before_form></custom_php_command_before_form>
-	<custom_php_after_head_command></custom_php_after_head_command>
-	<custom_php_after_form_command></custom_php_after_form_command>
-	<custom_php_validation_command>validate_input_zabbix2($_POST, $input_errors);</custom_php_validation_command>
-	<custom_add_php_command></custom_add_php_command>
-	<custom_php_resync_config_command>sync_package_zabbix2();</custom_php_resync_config_command>
-	<custom_php_deinstall_command>php_deinstall_zabbix2_agent();</custom_php_deinstall_command>
+	<custom_php_install_command>
+		sync_package_zabbix2();
+	</custom_php_install_command>
+	<custom_php_validation_command>
+		validate_input_zabbix2($_POST, $input_errors);
+	</custom_php_validation_command>
+	<custom_php_resync_config_command>
+		sync_package_zabbix2();
+	</custom_php_resync_config_command>
+	<custom_php_deinstall_command>
+		php_deinstall_zabbix2_agent();
+	</custom_php_deinstall_command>
 </packagegui>