Add rate package, courtesy of Scott Dale

7 files changed, 507 insertions, 0 deletions

diff --git a/config/rate/bandwidth_by_ip.php b/config/rate/bandwidth_by_ip.php
new file mode 100644
index 00000000..3fd01a61
--- /dev/null
+++ b/config/rate/bandwidth_by_ip.php
@@ -0,0 +1,77 @@
+<?php
+/* 
+ * To change this template, choose Tools | Templates
+ * and open the template in the editor.
+ *
+ *
+ *
+ *
+ *
+ */
+
+require_once('guiconfig.inc');
+require_once('interfaces.inc');
+require_once('pfsense-utils.inc');
+require_once('util.inc');
+
+$listedIPs = "";
+
+//get interface IP and break up into an array
+$interface = $_GET['if'];
+$real_interface = convert_friendly_interface_to_real_interface_name($interface);
+$intip = find_interface_ip($real_interface);
+$intip = explode (".", $intip);
+
+//use class A subnet to make sure we capture all traffic on specified interface
+$intsubnet = $intip[0] . ".0.0.0/8";
+
+exec("rate -i {$real_interface} -nlq 1 -A -c {$intsubnet}", $listedIPs);
+
+unset($bandwidthinfo);
+unset($receivebytesarray);
+unset($transmitbytesarray);
+
+$someinfo = false;
+for ($x=2; $x<12; $x++){
+
+    $bandwidthinfo = $listedIPs[$x];
+
+   // echo $bandwidthinfo;
+    $emptyinfocounter = 1;
+    if ($bandwidthinfo != "") {
+        $splitinfo = explode ("|",$bandwidthinfo);
+        $receivebytesarray = explode(" ",$splitinfo[0]);
+        //print IP of host;
+        echo $receivebytesarray[0] . ";";
+
+        //skip empty array elements until first element found with data
+        while ($receivebytesarray[$emptyinfocounter] == "")
+        {
+            $emptyinfocounter++;
+        }
+        //print received bytes for host
+        echo $receivebytesarray[$emptyinfocounter] . ";";
+
+        $transmitbytesarray = explode(" ",$splitinfo[1]);
+
+        $emptyinfocounter = 1;
+
+        //skip empty array elements until first element found with data
+        while ($transmitbytesarray[$emptyinfocounter] == "")
+        {
+            $emptyinfocounter++;
+        }
+        //print transmitted bytes for host
+        echo $transmitbytesarray[$emptyinfocounter] . "|";
+
+        //mark that we collected information
+        $someinfo = true;
+    }
+}
+
+
+//no bandwidth usage found
+if ($someinfo == false)
+    echo "no info";
+
+?>
diff --git a/config/rate/rate.inc b/config/rate/rate.inc
new file mode 100644
index 00000000..3a2f13a9
--- /dev/null
+++ b/config/rate/rate.inc
@@ -0,0 +1,29 @@
+<?php
+
+function rate_install() {
+	global $g, $config;
+
+	/* Copy files for backup. */
+	mwexec("cp /usr/local/www/status_graph.php /usr/local/www/status_graph.php.orig");
+	unlink("/usr/local/www/status_graph.php");
+	mwexec("cp /usr/local/pkg/bandwidth_by_ip.php /usr/local/www/bandwidth_by_ip.php");
+	mwexec("cp /usr/local/pkg/status_graph.php /usr/local/www/status_graph.php");
+
+	assign_privs();
+	/* Clear the APC cache so that the updates to installed files will work. */
+	apc_clear_cache();
+}
+
+function rate_deinstall() {
+	unlink("/usr/local/www/status_graph.php");
+	unlink("/usr/local/www/bandwidth_by_ip.php");
+	mwexec("cp /usr/local/www/status_graph.php.orig /usr/local/www/status_graph.php");
+}
+
+function assign_privs() {
+	/* Fix permissions on replaced files */
+	mwexec("chown root:wheel /usr/local/www/bandwidth_by_ip.php");
+	mwexec("chown root:wheel /usr/local/www/status_graph.php");
+}
+
+?>
\ No newline at end of file
diff --git a/config/rate/rate.xml b/config/rate/rate.xml
new file mode 100644
index 00000000..f60fc92f
--- /dev/null
+++ b/config/rate/rate.xml
@@ -0,0 +1,74 @@
+<?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[
+/* $Id$ */
+/* ========================================================================== */
+/*
+    rate.xml
+    part of pfSense (http://www.pfSense.com)
+    Copyright (C) 2007 to whom it may belong
+    All rights reserved.
+
+    Based on m0n0wall (http://m0n0.ch/wall)
+    Copyright (C) 2003-2006 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.
+                                                                              */
+/* ========================================================================== */
+        ]]>
+        </copyright>
+    <description>Per-IP Realtime Bandwidth Rate Monitor</description>
+    <requirements>FreeBSD rate-0.9 package</requirements>
+    <faq>Currently there are no FAQ items provided.</faq>
+	<name>rate</name>
+	<version>0.9</version>
+	<title>Rate</title>
+	<include_file>/usr/local/pkg/dashboard.inc</include_file>
+	<additional_files_needed>
+		<prefix>/usr/local/pkg/</prefix>
+		<chmod>077</chmod>
+		<item>http://www.pfsense.com/packages/config/rate/rate.inc</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/pkg/</prefix>
+		<chmod>077</chmod>
+		<item>http://www.pfsense.com/packages/config/rate/bandwidth_by_ip.php</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/pkg/</prefix>
+		<chmod>077</chmod>
+		<item>http://www.pfsense.com/packages/config/rate/status_graph.php</item>
+	</additional_files_needed>
+
+	<custom_php_install_command>
+		rate_install();
+	</custom_php_install_command>
+	<custom_php_deinstall_command>
+		rate_deinstall();
+	</custom_php_deinstall_command>
+</packagegui>
diff --git a/config/rate/status_graph.php b/config/rate/status_graph.php
new file mode 100644
index 00000000..12a9fd39
--- /dev/null
+++ b/config/rate/status_graph.php
@@ -0,0 +1,291 @@
+<?php
+/* $Id$ */
+/*
+	status_graph.php
+	Part of pfSense
+	Copyright (C) 2004 Scott Ullrich
+	All rights reserved.
+
+	Originally 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.
+*/
+
+##|+PRIV
+##|*IDENT=page-status-trafficgraph
+##|*NAME=Status: Traffic Graph page
+##|*DESCR=Allow access to the 'Status: Traffic Graph' page.
+##|*MATCH=status_graph.php*
+##|-PRIV
+
+
+
+require("guiconfig.inc");
+
+if ($_POST['width'])
+	$width = $_POST['width'];
+else
+	$width = "100%";
+
+if ($_POST['height'])
+	$height = $_POST['height'];
+else
+	$height = "200";
+
+
+if ($_GET['if'])
+	$curif = $_GET['if'];
+else
+	$curif = "wan";
+
+$pgtitle = array("Status","Traffic Graph");
+
+include("head.inc");
+
+?>
+
+<body link="#0000CC" vlink="#0000CC" alink="#0000CC">
+
+<script src="/javascript/scriptaculous/prototype.js" type="text/javascript"></script>
+<script src="/javascript/scriptaculous/scriptaculous.js" type="text/javascript"></script>
+<script language="javascript" type="text/javascript">
+
+function updateBandwidth(){
+    var hostinterface = "<?php echo $curif; ?>";
+    bandwidthAjax(hostinterface);
+}
+
+function bandwidthAjax(hostinterface) {
+	uri = "bandwidth_by_ip.php?if=" + hostinterface;
+	var opt = {
+	    // Use GET
+	    method: 'get',
+	    asynchronous: true,
+	    // Handle 404
+	    on404: function(t) {
+	        alert('Error 404: location "' + t.statusText + '" was not found.');
+	    },
+	    // Handle other errors
+	    onFailure: function(t) {
+	        alert('Error ' + t.status + ' -- ' + t.statusText);
+	    },
+		onSuccess: function(t) {
+			updateBandwidthHosts(t.responseText);
+	    }
+	}
+	new Ajax.Request(uri, opt);
+}
+
+function updateBandwidthHosts(data){
+    var hosts_split = data.split("|");
+    d = document;
+    //parse top ten bandwidth abuser hosts
+    for (var y=0; y<10; y++){
+        if (hosts_split[y] != "" && hosts_split[y] != "no info"){
+            if (hosts_split[y]) {
+                hostinfo = hosts_split[y].split(";");
+
+                //update host ip info
+                var HostIpID = "hostip" + y;
+                var hostip = d.getElementById(HostIpID);
+                hostip.innerHTML = hostinfo[0];
+
+                //update bandwidth inbound to host
+                var hostbandwidthInID = "bandwidthin" + y;
+                var hostbandwidthin = d.getElementById(hostbandwidthInID);
+                hostbandwidthin.innerHTML = hostinfo[1] + " Bytes/sec";
+
+                //update bandwidth outbound from host
+                var hostbandwidthOutID = "bandwidthout" + y;
+                var hostbandwidthOut = d.getElementById(hostbandwidthOutID);
+                hostbandwidthOut.innerHTML = hostinfo[2] + " Bytes/sec";
+
+                //make the row appear if hidden
+                var rowid = "host" + y;
+                textlink = d.getElementById(rowid);
+                if (textlink.style.display == "none"){
+                     //hide rows that contain no data
+                     Effect.Appear(rowid, {duration:1});
+                }
+            }
+        }
+        else
+        {
+            var rowid = "host" + y;
+            textlink = d.getElementById(rowid);
+            if (textlink.style.display != "none"){
+                //hide rows that contain no data
+                Effect.Fade(rowid, {duration:2});
+            }
+        }
+    }
+    
+    setTimeout('updateBandwidth()', 3000);
+}
+
+
+</script>
+
+<?php include("fbegin.inc"); ?>
+<?php
+$ifdescrs = array('wan' => 'WAN', 'lan' => 'LAN');
+
+for($j = 1; isset($config['interfaces']['opt' . $j]); $j++) {
+	if(isset($config['interfaces']['opt' . $j]['enable']))
+		$ifdescrs['opt' . $j] = $config['interfaces']['opt' . $j]['descr'];
+}
+if((isset($config['ipsec']['enable'])) || (isset($config['ipsec']['mobileclients']['enable']))) {
+	$ifdescrs['ipsec'] = "IPSEC";
+}
+
+/* link the ipsec interface magically */
+if (isset($config['ipsec']['enable']) || isset($config['ipsec']['mobileclients']['enable'])) 
+	$ifdescrs['enc0'] = "IPsec";
+
+?>
+<form name="form1" action="status_graph.php" method="get" style="padding-bottom: 10px; margin-bottom: 14px; border-bottom: 1px solid #999999">
+Interface:
+<select name="if" class="formselect" style="z-index: -10;" onchange="document.form1.submit()">
+<?php
+foreach ($ifdescrs as $ifn => $ifd) {
+	echo "<option value=\"$ifn\"";
+	if ($ifn == $curif) echo " selected";
+	echo ">" . htmlspecialchars($ifd) . "</option>\n";
+}
+?>
+</select>
+</form>
+<p><span class="red"><strong>Note:</strong></span> the <a href="http://www.adobe.com/svg/viewer/install/" target="_blank">Adobe SVG Viewer</a>, Firefox 1.5 or later or other browser supporting SVG is required to view the graph.
+<p><form method="post" action="status_graph.php">
+</form>
+<p>
+<div>
+    <div class="widgetdiv" style="padding: 5px; float:left; width:46%">
+        <object data="graph.php?ifnum=<?=$curif;?>&amp;ifname=<?=rawurlencode($ifdescrs[$curif]);?>" type="image/svg+xml" width="<?=$width;?>" height="<?=$height;?>">
+            <param name="src" value="graph.php?ifnum=<?=$curif;?>&amp;ifname=<?=rawurlencode($ifdescrs[$curif]);?>" />
+            Your browser does not support the type SVG! You need to either use Firefox or download the Adobe SVG plugin.
+        </object>
+    </div>
+    <div class="widgetdiv" style="padding: 5px; float:right; width:48%">
+        <table width="100%" border="0" cellspacing="0" cellpadding="0">
+            <tr>
+                <td class="listtopic" valign="top">Host IP</td>
+                <td class="listtopic" valign="top">Bandwidth In</td>
+                <td class="listtopic" valign="top">Bandwidth Out</td>
+           </tr>
+           <tr id="host0" style="display:none">
+                <td id="hostip0" class="vncell">
+                </td>
+                <td id="bandwidthin0" class="listr">
+                </td>
+                <td id="bandwidthout0" class="listr">
+                </td>
+           </tr>
+           <tr id="host1" style="display:none">
+                <td id="hostip1" class="vncell">
+                </td>
+                <td id="bandwidthin1" class="listr">
+                </td>
+                <td id="bandwidthout1" class="listr">
+                </td>
+           </tr>
+           <tr id="host2" style="display:none">
+                <td id="hostip2" class="vncell">
+                </td>
+                <td id="bandwidthin2" class="listr">
+                </td>
+                <td id="bandwidthout2" class="listr">
+                </td>
+           </tr>
+           <tr id="host3" style="display:none">
+                <td id="hostip3" class="vncell">
+                </td>
+                <td id="bandwidthin3" class="listr">
+                </td>
+                <td id="bandwidthout3" class="listr">
+                </td>
+           </tr>
+           <tr id="host4" style="display:none">
+                <td id="hostip4" class="vncell">
+                </td>
+                <td id="bandwidthin4" class="listr">
+                </td>
+                <td id="bandwidthout4" class="listr">
+                </td>
+           </tr>
+           <tr id="host5" style="display:none">
+                <td id="hostip5" class="vncell">
+                </td>
+                <td id="bandwidthin5" class="listr">
+                </td>
+                <td id="bandwidthout5" class="listr">
+                </td>
+           </tr>
+           <tr id="host6" style="display:none">
+                <td id="hostip6" class="vncell">
+                </td>
+                <td id="bandwidthin6" class="listr">
+                </td>
+                <td id="bandwidthout6" class="listr">
+                </td>
+           </tr>
+           <tr id="host7" style="display:none">
+                <td id="hostip7" class="vncell">
+                </td>
+                <td id="bandwidthin7" class="listr">
+                </td>
+                <td id="bandwidthout7" class="listr">
+                </td>
+           </tr>
+           <tr id="host8" style="display:none">
+                <td id="hostip8" class="vncell">
+                </td>
+                <td id="bandwidthin8" class="listr">
+                </td>
+                <td id="bandwidthout8" class="listr">
+                </td>
+           </tr>
+           <tr id="host9" style="display:none">
+                <td id="hostip9" class="vncell">
+                </td>
+                <td id="bandwidthin9" class="listr">
+                </td>
+                <td id="bandwidthout9" class="listr">
+                </td>
+           </tr>
+        </table>
+	 </div>
+</div>
+
+<?php include("fend.inc"); ?>
+
+<script type="text/javascript">
+window.onload = function(in_event)
+	{
+        updateBandwidth();
+    }
+
+</script>
+</body>
+</html>
diff --git a/pkg_config.7.xml b/pkg_config.7.xml
index 2efd5a8c..aaad5fa2 100755
--- a/pkg_config.7.xml
+++ b/pkg_config.7.xml
@@ -739,5 +739,17 @@
       <config_file>http://www.pfsense.com/packages/config/ovpnenhance/ovpnenhance.xml</config_file>
       <configurationfile>ovpnenhance.xml</configurationfile>
     </package>
+    <package>
+      <name>rate</name>
+      <descr>This package adds a table of realtime bandwidth usage by IP address to Status -&gt; Traffic Graphs</descr>
+      <category>Network Management</category>
+      <version>0.9</version>
+      <status>BETA</status>
+      <maintainer></maintainer>
+      <depends_on_package_base_url>http://files.pfsense.com/packages/7/All/</depends_on_package_base_url>
+      <depends_on_package>rate-0.9.tbz</depends_on_package>
+      <config_file>http://www.pfsense.org/packages/config/rate/rate.xml</config_file>
+      <configurationfile>rate.xml</configurationfile>
+    </package>
   </packages>
 </pfsensepkgs>
diff --git a/pkg_config.8.xml b/pkg_config.8.xml
index 42dccece..e620a878 100755
--- a/pkg_config.8.xml
+++ b/pkg_config.8.xml
@@ -671,5 +671,17 @@
    <configurationfile>jail_template.xml</configurationfile>
    <maintainer>ltning-jailctl@anduin.net</maintainer>
   </package>
+    <package>
+      <name>rate</name>
+      <descr>This package adds a table of realtime bandwidth usage by IP address to Status -&gt; Traffic Graphs</descr>
+      <category>Network Management</category>
+      <version>0.9</version>
+      <status>BETA</status>
+      <maintainer></maintainer>
+      <depends_on_package_base_url>http://files.pfsense.com/packages/7/All/</depends_on_package_base_url>
+      <depends_on_package>rate-0.9.tbz</depends_on_package>
+      <config_file>http://www.pfsense.org/packages/config/rate/rate.xml</config_file>
+      <configurationfile>rate.xml</configurationfile>
+    </package>
   </packages>
 </pfsensepkgs>
diff --git a/pkg_config.xml b/pkg_config.xml
index ff5c1827..8360ecbf 100644
--- a/pkg_config.xml
+++ b/pkg_config.xml
@@ -825,4 +825,16 @@
       <config_file>http://www.pfsense.com/packages/config/ovpnenhance/ovpnenhance.xml</config_file>
       <configurationfile>ovpnenhance.xml</configurationfile>
     </package>
+    <package>
+      <name>rate</name>
+      <descr>This package adds a table of realtime bandwidth usage by IP address to Status -&gt; Traffic Graphs</descr>
+      <category>Network Management</category>
+      <version>0.9</version>
+      <status>BETA</status>
+      <maintainer></maintainer>
+      <depends_on_package_base_url>http://files.pfsense.com/packages/7/All/</depends_on_package_base_url>
+      <depends_on_package>rate-0.9.tbz</depends_on_package>
+      <config_file>http://www.pfsense.org/packages/config/rate/rate.xml</config_file>
+      <configurationfile>rate.xml</configurationfile>
+    </package>
 </pfsensepkgs>