squid3 - code style fixes, improve descriptions

1 files changed, 89 insertions, 60 deletions

diff --git a/config/squid3/34/squid_traffic.xml b/config/squid3/34/squid_traffic.xml
index 3439d598..f7dfa34e 100755
--- a/config/squid3/34/squid_traffic.xml
+++ b/config/squid3/34/squid_traffic.xml
@@ -2,57 +2,52 @@
 <!DOCTYPE packagegui SYSTEM "../schema/packages.dtd">
 <?xml-stylesheet type="text/xsl" href="../xsl/package.xsl"?>
 <packagegui>
-        <copyright>
-        <![CDATA[
+	<copyright>
+<![CDATA[
 /* $Id$ */
-/* ========================================================================== */
+/* ====================================================================================== */
 /*
-    authng.xml
-    part of pfSense (http://www.pfSense.com)
-    Copyright (C) 2007 to whom it may belong
-    Copyright (C) 2012-2014 Marcello Coutinho
-    All rights reserved.
-
-    Based on m0n0wall (http://m0n0.ch/wall)
-    Copyright (C) 2003-2006 Manuel Kasper <mk@neon1.net>.
-    All rights reserved.
-                                                                              */
-/* ========================================================================== */
+	squid_traffic.xml
+	part of pfSense (https://www.pfSense.org/)
+	Copyright (C) 2012-2014 Marcello Coutinho
+	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.
+	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.
+	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>
+
+	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>squidtraffic</name>
-	<version>none</version>
-	<title>Proxy server: Traffic management</title>
+	<version>0.3.5</version>
+	<title>Proxy server: Traffic Management</title>
 	<include_file>/usr/local/pkg/squid.inc</include_file>
 	<tabs>
-	<tab>
-		<text>General</text>
+		<tab>
+			<text>General</text>
 			<url>/pkg_edit.php?xml=squid.xml&amp;id=0</url>
 		</tab>
 		<tab>
@@ -85,7 +80,7 @@
 			<url>/pkg.php?xml=squid_users.xml</url>
 		</tab>
 		<tab>
-			<text>Real time</text>
+			<text>Real Time</text>
 			<url>/squid_monitor.php</url>
 		</tab>
 		<tab>
@@ -99,36 +94,57 @@
 			<type>listtopic</type>
 		</field>
 		<field>
-			<fielddescr>Maximum download size</fielddescr>
+			<fielddescr>Maximum Download Size</fielddescr>
 			<fieldname>max_download_size</fieldname>
-			<description>Limit the maximum total download size to the size specified here (in kilobytes). Set to 0 to disable.</description>
+			<description>
+				<![CDATA[
+				Limit the maximum total download size to the size specified here (in kilobytes).<br/>
+				Set to 0 to disable.
+				]]>
+			</description>
 			<type>input</type>
 			<size>10</size> 
 			<required/>
 			<default_value>0</default_value>
 		</field>
 		<field>
-			<fielddescr>Maximum upload size</fielddescr>
+			<fielddescr>Maximum Upload Size</fielddescr>
 			<fieldname>max_upload_size</fieldname>
-			<description>Limit the maximum total upload size to the size specified here (in kilobytes). Set to 0 to disable.</description>
+			<description>
+				<![CDATA[
+				Limit the maximum total upload size to the size specified here (in kilobytes).<br/>
+				Set to 0 to disable.
+				]]>
+			</description>
 			<type>input</type>
 			<size>10</size>
 			<required/>
 			<default_value>0</default_value>
 		</field>
 		<field>
-			<fielddescr>Overall bandwidth throttling</fielddescr>
+			<fielddescr>Overall Bandwidth Throttling</fielddescr>
 			<fieldname>overall_throttling</fieldname>
-			<description>This value specifies (in kilobytes per second) the bandwidth throttle for downloads. Users will gradually have their download speed increased according to this value. Set to 0 to disable bandwidth throttling.</description>
+			<description>
+				<![CDATA[
+				This value specifies the bandwidth throttle for downloads (in kilobytes per second).<br/>
+				Users will gradually have their download speed decreased according to this value.<br/>
+				Set to 0 to disable.
+				]]>
+			</description>
 			<type>input</type>
 			<size>10</size>
 			<required/>
 			<default_value>0</default_value>
 		</field>
 		<field>
-			<fielddescr>Per-host throttling</fielddescr>
+			<fielddescr>Per-Host Throttling</fielddescr>
 			<fieldname>perhost_throttling</fieldname>
-			<description>This value specifies the download throttling per host. Set to 0 to disable this.</description>
+			<description>
+				<![CDATA[
+				This value specifies the download throttling per host.<br/>
+				Set to 0 to disable.
+				]]>
+			</description>
 			<type>input</type>
 			<size>10</size>
 			<required/>
@@ -139,7 +155,7 @@
 			<type>listtopic</type>
 		</field>
 		<field>
-			<fielddescr>Throttle only specific extensions</fielddescr>
+			<fielddescr>Throttle Only Specific Extensions</fielddescr>
 			<fieldname>throttle_specific</fieldname>
 			<description>Leave this checked to be able to choose the extensions that throttling will be applied to. Otherwise, all files will be throttled.</description>
 			<type>checkbox</type>
@@ -147,25 +163,25 @@
 			<default_value>on</default_value>
 		</field>
 		<field>
-			<fielddescr>Throttle binary files</fielddescr>
+			<fielddescr>Throttle Binary Files</fielddescr>
 			<fieldname>throttle_binaries</fieldname>
 			<description>Check this to apply bandwidth throttle to binary files. This includes compressed archives and executables.</description>
 			<type>checkbox</type>
 		</field>
 		<field>
-			<fielddescr>Throttle CD images</fielddescr>
+			<fielddescr>Throttle CD/DVD Image Files</fielddescr>
 			<fieldname>throttle_cdimages</fieldname>
-			<description>Check this to apply bandwidth throttle to CD image files.</description>
+			<description>Check this to apply bandwidth throttle to CD/DVD image files.</description>
 			<type>checkbox</type>
 		</field>
 		<field>
-			<fielddescr>Throttle multimedia files</fielddescr>
+			<fielddescr>Throttle Multimedia Files</fielddescr>
 			<fieldname>throttle_multimedia</fieldname>
 			<description>Check this to apply bandwidth throttle to multimedia files, such as movies or songs.</description>
 			<type>checkbox</type>
 		</field>
 		<field>
-			<fielddescr>Throttle other extensions</fielddescr>
+			<fielddescr>Throttle Other Extensions</fielddescr>
 			<fieldname>throttle_others</fieldname>
 			<description>Comma-separated list of extensions to apply bandwidth throttle to.</description>
 			<type>input</type>
@@ -176,9 +192,22 @@
 			<type>listtopic</type>
 		</field>
 		<field>
+		<field>
+			<type>info</type>
+			<description>
+				<![CDATA[
+				The cache by default continues downloading aborted requests which are almost completed.<br/>
+				This may be undesirable on slow links and/or very busy caches. Impatient users may tie up file descriptors and
+				bandwidth by repeatedly requesting and immediately aborting downloads.<br/>
+				When the user aborts a request, Squid will compare the below values to the amount of data transferred so far.<br/><br/>
+				If you do not want any retrieval to continue after the client has aborted, set both values below to 0.<br/>
+				If you want retrievals to always continue if they are being cached, set 'Finish transfer if less than x KB remaining' to -1.
+				]]>
+			</description>
+		</field>
 			<fielddescr>Finish transfer if less than x KB remaining</fielddescr>
 			<fieldname>quick_abort_min</fieldname>
-			<description>If the transfer has less than x KB remaining, it will finish the retrieval. Set to 0 to abort the transfer immediately.</description>
+			<description>If the transfer has less than x KB remaining, it will finish the retrieval.</description>
 			<type>input</type>
 			<size>10</size>
 			<default_value>0</default_value>
@@ -186,7 +215,7 @@
 		<field>
 			<fielddescr>Abort transfer if more than x KB remaining</fielddescr>
 			<fieldname>quick_abort_max</fieldname>
-			<description>If the transfer has more than x KB remaining, it will abort the retrieval. Set to 0 to abort the transfer immediately.</description>
+			<description>If the transfer has more than x KB remaining, it will abort the retrieval.</description>
 			<type>input</type>
 			<default_value>0</default_value>
 		</field>
@@ -197,7 +226,7 @@
 			<type>input</type>
 			<size>10</size>
 			<default_value>0</default_value>
-		</field>        		
+		</field>
 	</fields>
 	<custom_php_validation_command>
 		squid_validate_traffic($_POST, $input_errors);