From e5fee5ba38431f87213433b66e92acf27061c55b Mon Sep 17 00:00:00 2001
From: Nigel Kukard <nkukard@lbsd.net>
Date: Sun, 5 Jan 2014 17:45:20 +0000
Subject: [PATCH] Reworked limits page against new API
---
.../plugins/webserver/pages/limits.pm | 2353 ++++++++++++++---
1 file changed, 1979 insertions(+), 374 deletions(-)
diff --git a/opentrafficshaper/plugins/webserver/pages/limits.pm b/opentrafficshaper/plugins/webserver/pages/limits.pm
index 8e686d4..4f3afc0 100644
--- a/opentrafficshaper/plugins/webserver/pages/limits.pm
+++ b/opentrafficshaper/plugins/webserver/pages/limits.pm
@@ -1,5 +1,5 @@
# OpenTrafficShaper webserver module: limits page
-# Copyright (C) 2007-2013, AllWorldIT
+# Copyright (C) 2007-2014, AllWorldIT
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -33,24 +33,46 @@ our (@ISA,@EXPORT,@EXPORT_OK);
use DateTime;
use HTML::Entities;
use HTTP::Status qw( :constants );
-use URI::Escape;
+use URI::Escape qw( uri_escape );
use URI::QueryParam;
+use Storable qw( dclone );
+use opentrafficshaper::constants;
use opentrafficshaper::logger;
use opentrafficshaper::plugins;
-use opentrafficshaper::utils qw( parseURIQuery parseFormContent isUsername isIP isNumber prettyUndef );
+use opentrafficshaper::utils qw(
+ parseURIQuery
+ parseFormContent
+ isUsername
+ isIP
+ isNumber
+ prettyUndef
+);
use opentrafficshaper::plugins::configmanager qw(
- getLimits getLimit
+ getPools
+ getPool
+ getPoolByIdentifer
+ getPoolShaperState
+ isPoolReady
+
+ getPoolMembers
+ getPoolMember
+ getPoolMembersByIP
+ getPoolMemberShaperState
+ isPoolMemberReady
- getInterfaceGroups
- isInterfaceGroupValid
+ getOverrides
+ getOverride
- getMatchPriorities
- isMatchPriorityValid
+ getInterfaceGroups
+ isInterfaceGroupIDValid
- getTrafficClasses getTrafficClassName
- isTrafficClassValid
+ getMatchPriorities
+ isMatchPriorityIDValid
+
+ getTrafficClasses getTrafficClassName
+ isTrafficClassIDValid
);
@@ -58,15 +80,32 @@ use opentrafficshaper::plugins::configmanager qw(
# Sidebar menu options for this module
my $menu = [
{
- 'name' => 'View Limits',
+ 'name' => 'Pools',
+ 'items' => [
+ {
+ 'name' => 'List Pools',
+ 'link' => 'pool-list'
+ },
+ {
+ 'name' => 'List Manual Pools',
+ 'link' => 'pool-list?source=plugin.webserver.limits'
+ },
+ {
+ 'name' => 'Add Pool',
+ 'link' => 'pool-add'
+ }
+ ]
+ },
+ {
+ 'name' => 'Pool Overrides',
'items' => [
{
- 'name' => 'All Limits',
- 'link' => ''
+ 'name' => 'List Overrides',
+ 'link' => 'override-list'
},
{
- 'name' => 'Manual Limits',
- 'link' => './?source=plugin.webserver.limits'
+ 'name' => 'Add Override',
+ 'link' => 'override-add'
}
]
},
@@ -83,13 +122,13 @@ my $menu = [
-# Default page/action
-sub default
+# Pool list page/action
+sub pool_list
{
my ($kernel,$globals,$client_session_id,$request) = @_;
- my @limits = getLimits();
+ my @pools = getPools();
# Pull in URL params
my $queryParams = parseURIQuery($request);
@@ -99,189 +138,122 @@ sub default
# Header
$content .=<<EOF;
-<table class="table">
- <legend>Limit List</legend>
- <thead>
- <tr>
- <th></th>
- <th>User</th>
- <th>IP</th>
- <th>Class</th>
- <th>Group</th>
- <th>CIR (Kbps)</th>
- <th>Limits (Kbps)</th>
- <th></th>
- </tr>
- </thead>
- <tbody>
+ <legend>Pool List</legend>
+ <table class="table">
+ <thead>
+ <tr>
+ <th></th>
+ <th>Friendly Name</th>
+ <th>Identifier</th>
+ <th>Expires</th>
+ <th></th>
+ <th>Class</th>
+ <th>CIR (Kbps)</th>
+ <th>Limit (Kbps)</th>
+ <th></th>
+ </tr>
+ </thead>
+ <tbody>
EOF
# Body
- foreach my $lid (@limits) {
- my $limit;
- # If we can't get the limit just move onto the next
- if (!defined($limit = getLimit($lid))) {
+ foreach my $pid (@pools) {
+ my $pool;
+ # If we can't get the pool just move onto the next
+ if (!defined($pool = getPool($pid))) {
next;
}
# Conditionals
if (defined($queryParams->{'source'})) {
- if ($limit->{'Source'} ne $queryParams->{'source'}->{'value'}) {
+ if ($pool->{'Source'} ne $queryParams->{'source'}->{'value'}) {
next;
}
}
- # Make style a bit pretty
- my $style = "";
- my $icon = "";
- if ($limit->{'Status'} eq "offline") {
- $icon = '<span class="glyphicon glyphicon-trash"></span>';
- $style = "warning";
- } elsif ($limit->{'Status'} eq "new") {
-# $icon = '<i class="glyphicon-plus"></i>';
- $style = "info";
- } elsif ($limit->{'Status'} eq "conflict") {
- $icon = '<span class="glyphicon glyphicon-random"></span>';
- $style = "error";
- }
-
# Get a nice last update string
- my $lastUpdate = DateTime->from_epoch( epoch => $limit->{'LastUpdate'} )->iso8601();
-
- my $cirStr = sprintf('%s/%s',prettyUndef($limit->{'TrafficLimitTx'}),prettyUndef($limit->{'TrafficLimitRx'}));
- my $limitStr = sprintf('%s/%s',prettyUndef($limit->{'TrafficLimitTxBurst'}),prettyUndef($limit->{'TrafficLimitRxBurst'}));
-
-
- # If the statistics plugin is loaded pull in some stats
- my $statsPPSTx = my $statsRateTx = my $statsPrioTx = "-";
- my $statsPPSRx = my $statsRateRx = my $statsPrioRx = "-";
- if (isPluginLoaded('statistics')) {
- my $stats = opentrafficshaper::plugins::statistics::getLastStats($limit->{'Username'});
- # Pull off tx stats
- if (my $statsTx = $stats->{'tx'}) {
- $statsPPSTx = $statsTx->{'current_pps'};
- $statsRateTx = $statsTx->{'current_rate'};
- $statsPrioTx = $statsTx->{'priority'};
- }
- # Pull off rx stats
- if (my $statsRx = $stats->{'rx'}) {
- $statsPPSRx = $statsRx->{'current_pps'};
- $statsRateRx = $statsRx->{'current_rate'};
- $statsPrioRx = $statsRx->{'priority'};
- }
- }
+ my $lastUpdate = DateTime->from_epoch( epoch => $pool->{'LastUpdate'} )->iso8601();
+
+ my $cirStr = sprintf('%s/%s',prettyUndef($pool->{'TrafficLimitTx'}),prettyUndef($pool->{'TrafficLimitRx'}));
+ my $limitStr = sprintf('%s/%s',prettyUndef($pool->{'TrafficLimitTxBurst'}),prettyUndef($pool->{'TrafficLimitRxBurst'}));
+
+ my $pidEscaped = uri_escape($pool->{'ID'});
- my $lidEncoded = encode_entities($limit->{'ID'});
- my $name = (defined($limit->{'FriendlyName'}) && $limit->{'FriendlyName'} ne "") ? $limit->{'FriendlyName'} : $limit->{'Username'};
- my $usernameEncoded = encode_entities($name);
+ my $friendlyName = (defined($pool->{'FriendlyName'}) && $pool->{'FriendlyName'} ne "") ? $pool->{'FriendlyName'} :
+ $pool->{'Identifier'};
+ my $friendlyNameEncoded = encode_entities($friendlyName);
- my $classStr = getTrafficClassName($limit->{'ClassID'});
+ my $identifierEncoded = encode_entities($pool->{'Identifier'});
- # We only support removing certain sources of limits
- my $removeLink = "";
- if ($limit->{'Source'} eq "plugin.webserver.limits") {
- $removeLink = "<a href=\"/limits/limit-remove?lid=$lidEncoded\"><span class=\"glyphicon glyphicon-remove\"></span></a>";
+ my $expiresStr = ($pool->{'Expires'} > 0) ? DateTime->from_epoch( epoch => $pool->{'Expires'} )->iso8601() : '-never-';
+
+ my $classStr = getTrafficClassName($pool->{'ClassID'});
+
+ # Display relevant icons depending on pool status
+ my $icons = "";
+ if (getPoolShaperState($pool->{'ID'}) == SHAPER_NOTLIVE || $pool->{'Status'} == CFGM_CHANGED) {
+ $icons .= '<span class="glyphicon glyphicon-time" />';
+ }
+ if ($pool->{'Status'} == CFGM_NEW) {
+ $icons .= '<span class="glyphicon glyphicon-import" />';
+ }
+ if ($pool->{'Status'} == CFGM_OFFLINE) {
+ $icons .= '<span class="glyphicon glyphicon-trash" />';
}
+# if ($pool->{'Status'} eq 'conflict') {
+# $icons .= '<span class="glyphicon glyphicon-random" />';
+# }
+# if ($pool->{'Status'} eq 'conflict') {
+# $icons .= '<span class="glyphicon glyphicon-edit" />';
+# }
+
$content .= <<EOF;
- <tr class="$style">
- <td>$icon</td>
- <td class="limit">
- $usernameEncoded
- <span class="limit-data" style="display:none">
- <table width="100%" border="0">
- <tr>
- <td>Source</td>
- <td>$limit->{'Source'}</td>
- <td> </td>
- <td>Last Update</td>
- <td>$lastUpdate</td>
- </tr>
- <tr>
- <td>Tx Priority</td>
- <td>$statsPrioTx</td>
- <td> </td>
- <td>Tx Priority</td>
- <td>$statsPrioRx</td>
- </tr>
- <tr>
- <td>Tx PPS</td>
- <td>$statsPPSTx</td>
- <td> </td>
- <td>Rx PPS</td>
- <td>$statsPPSRx</td>
- </tr>
- <tr>
- <td>Tx Rate</td>
- <td>$statsRateTx</td>
- <td> </td>
- <td>Rx Rate</td>
- <td>$statsRateRx</td>
- </tr>
- </table>
- </span>
- </td>
- <td>$limit->{'IP'}</td>
- <td>$classStr</td>
- <td>$limit->{'GroupID'}</td>
- <td>$cirStr</td>
- <td>$limitStr</td>
- <td>
- <a href="/statistics/by-limit?lid=$lidEncoded"><span class="glyphicon glyphicon-stats"></span></a>
- <a href="/limits/limit-edit?lid=$lidEncoded"><span class="glyphicon glyphicon-wrench"></span></a>
- $removeLink
- </td>
- </tr>
+ <tr>
+ <td>$icons</td>
+ <td>$friendlyNameEncoded</td>
+ <td>$identifierEncoded</td>
+ <td>$expiresStr</td>
+ <td><span class="glyphicon glyphicon-arrow-right" /></td>
+ <td>$classStr</td>
+ <td>$cirStr</td>
+ <td>$limitStr</td>
+ <td>
+ <a href="/statistics/by-pool?pid=$pidEscaped"><span class="glyphicon glyphicon-stats"></span></a>
+ <a href="/limits/pool-edit?pid=$pidEscaped"><span class="glyphicon glyphicon-wrench"></span></a>
+ <a href="/limits/poolmember-list?pid=$pidEscaped"><span class="glyphicon glyphicon-link"></span></a>
+ <a href="/limits/pool-remove?pid=$pidEscaped"><span class="glyphicon glyphicon-remove"></span></a>
+ </td>
+ </tr>
EOF
}
# No results
- if (!@limits) {
+ if (!@pools) {
$content .=<<EOF;
- <tr class="info">
- <td colspan="8"><p class="text-center">No Results</p></td>
- </tr>
+ <tr class="info">
+ <td colspan="8"><p class="text-center">No Results</p></td>
+ </tr>
EOF
}
# Footer
$content .=<<EOF;
- </tbody>
-</table>
-EOF
-
- my $style = <<EOF;
- .popover {
- max-width:none;
- }
-
- .popover td:nth-child(4), .popover td:first-child {
- font-weight:bold;
- text-transform:capitalize;
- }
-EOF
-
- my $javascript = <<EOF;
- \$(document).ready(function(){
- \$('.limit').each(function(){
- \$(this).popover({
- html: true,
- content: \$(this).find('.limit-data').html(),
- placement: 'bottom',
- trigger: 'hover',
- container: \$(this),
- title: 'Statistics',
- });
- })
- });
+ </tbody>
+ </table>
+ <span class="glyphicon glyphicon-time" /> - Processing,
+ <span class="glyphicon glyphicon-edit" /> - Override,
+ <span class="glyphicon glyphicon-import" /> - Being Added,
+ <span class="glyphicon glyphicon-trash" /> - Being Removed,
+ <span class="glyphicon glyphicon-random" /> - Conflicts
EOF
- return (HTTP_OK,$content,{ 'style' => $style, 'menu' => $menu, 'javascript' => $javascript });
+ return (HTTP_OK,$content,{ 'menu' => $menu });
}
-# Add/edit action
-sub limit_addedit
+# Pool add/edit action
+sub pool_addedit
{
my ($kernel,$globals,$client_session_id,$request) = @_;
@@ -295,9 +267,8 @@ sub limit_addedit
# Items for our form...
my @formElements = qw(
FriendlyName
- Username IP
+ Identifier
InterfaceGroupID
- MatchPriorityID
ClassID
TrafficLimitTx TrafficLimitTxBurst
TrafficLimitRx TrafficLimitRxBurst
@@ -319,78 +290,85 @@ sub limit_addedit
my $formNoEdit = "";
# Form data
my $formData;
+ # If we have a pool, this is where its kept
+ my $pool;
+
+ # Get query params
+ my $queryParams = parseURIQuery($request);
+
+ # If we have a pool ID, pull in the pool
+ if (defined($queryParams->{'pid'})) {
+ # Check if we can grab the pool
+ if (!defined($pool = getPool($queryParams->{'pid'}->{'value'}))) {
+ return (HTTP_TEMPORARY_REDIRECT,"limits");
+ }
+ }
# If this is a form try parse it
if ($request->method eq "POST") {
# Parse form data
- $formData = parseFormContent($request->content);
+ my $form = parseFormContent($request->content);
# If user pressed cancel, redirect
- if (defined($formData->{'cancel'})) {
+ if (defined($form->{'cancel'})) {
# Redirects to default page
return (HTTP_TEMPORARY_REDIRECT,'limits');
}
- # Maybe we were given an override key as a parameter? this would be an edit form
- } elsif ($request->method eq "GET") {
- # Parse GET data
- my $queryParams = parseURIQuery($request);
- # We need a key first of all...
- if (defined($queryParams->{'lid'})) {
- # Check if we get some data back when pulling the limit from the backend
- if (defined($formData = getLimit($queryParams->{'lid'}->{'value'}))) {
- # We need to make sure we're only editing our own limits
- if ($formData->{'Source'} ne "plugin.webserver.limits") {
- return (HTTP_TEMPORARY_REDIRECT,'limits');
- }
+ # Transform form into form data
+ foreach my $key (keys %{$form}) {
+ $formData->{$key} = $form->{$key}->{'value'};
+ }
- # Work out expires modifier
-# XXX - TODO
- # If we didn't get any data, then something went wrong
- } else {
- my $encodedID = encode_entities($queryParams->{'lid'}->{'value'});
- push(@errors,"Limit data could not be loaded using limit ID '$encodedID'");
+ # Set form type if its edit
+ if (defined($form->{'submit'}) && $form->{'submit'}->{'value'} eq "Edit") {
+ # Check pool exists
+ if (!defined($pool)) {
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
}
- # Lastly if we were given a key, this is actually an edit
+
+ $formData->{'ID'} = $pool->{'ID'};
+
$formType = "Edit";
$formNoEdit = "readonly";
+ }
+
+ # Maybe we were given a pool key as a parameter? this would be an edit form
+ } elsif ($request->method eq "GET") {
+ if (defined($pool)) {
+ # Setup form data from pool
+ foreach my $key (@formElements) {
+ $formData->{$key} = $pool->{$key};
+ }
- # Woops ... no query string?
- } elsif (%{$queryParams} > 0) {
- push(@errors,"No limit ID in query string!");
$formType = "Edit";
$formNoEdit = "readonly";
+
+ # Woops ... no query string?
+ } elsif (keys %{$queryParams} > 0) {
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
}
}
- #
- # If we already have data, lets check how valid it is...
- #
-
# We only do this if we have hash elements
if (ref($formData) eq "HASH") {
# Grab friendly name
my $friendlyName = $formData->{'FriendlyName'};
# Check POST data
- my $username;
- if (!defined($username = isUsername($formData->{'Username'}))) {
- push(@errors,"Username is not valid");
- }
- my $ipAddress;
- if (!defined($ipAddress = isIP($formData->{'IP'}))) {
- push(@errors,"IP address is not valid");
+ my $identifier;
+ if (!defined($identifier = isUsername($formData->{'Identifier'}))) {
+ push(@errors,"Identifier is not valid");
}
my $interfaceGroupID;
- if (!defined($interfaceGroupID = isInterfaceGroupValid($formData->{'InterfaceGroupID'}))) {
+ if (!defined($interfaceGroupID = isInterfaceGroupIDValid($formData->{'InterfaceGroupID'}))) {
push(@errors,"Interface group is not valid");
}
- my $matchPriorityID;
- if (!defined($matchPriorityID = isMatchPriorityValid($formData->{'MatchPriorityID'}))) {
- push(@errors,"Match priority is not valid");
+ if ($formType ne "Edit" && getPoolByIdentifer($interfaceGroupID,$identifier)) {
+ push(@errors,"A pool with the same identifier already exists");
}
my $classID;
- if (!defined($classID = isTrafficClassValid($formData->{'ClassID'}))) {
+ if (!defined($classID = isTrafficClassIDValid($formData->{'ClassID'}))) {
push(@errors,"Traffic class is not valid");
}
my $trafficLimitTx = isNumber($formData->{'TrafficLimitTx'});
@@ -404,6 +382,13 @@ sub limit_addedit
push(@errors,"A valid upload CIR and/or limit is required");
}
+ # Make sure pool is not transitioning states
+ if ($formType eq "Edit") {
+ if (!isPoolReady($pool->{'ID'})) {
+ push(@errors,"Pool is not currently in a READY state, please try again");
+ }
+ }
+
my $expires = 0;
if (defined($formData->{'Expires'}) && $formData->{'Expires'} ne "") {
if (!defined($expires = isNumber($formData->{'Expires'}))) {
@@ -433,19 +418,17 @@ sub limit_addedit
}
}
}
+
# Grab notes
my $notes = $formData->{'Notes'};
# If there are no errors we need to push this update
if (!@errors && $request->method eq "POST") {
- # Build limit
- my $limit = {
+ # Build pool details
+ my $poolData = {
'FriendlyName' => $friendlyName,
- 'Username' => $username,
- 'IP' => $ipAddress,
- 'GroupID' => 1,
+ 'Identifier' => $identifier,
'InterfaceGroupID' => $interfaceGroupID,
- 'MatchPriorityID' => $matchPriorityID,
'ClassID' => $classID,
'TrafficLimitTx' => $trafficLimitTx,
'TrafficLimitTxBurst' => $trafficLimitTxBurst,
@@ -455,21 +438,23 @@ sub limit_addedit
'Notes' => $notes,
};
- # Throw the change at the config manager after we add extra data we need
+ my $cEvent;
if ($formType eq "Add") {
- $limit->{'Status'} = 'online';
- $limit->{'Source'} = 'plugin.webserver.limits';
+ $poolData->{'Status'} = CFGM_ONLINE;
+ $poolData->{'Source'} = 'plugin.webserver.limits';
+ $cEvent = "pool_add";
+ } else {
+ $poolData->{'ID'} = $formData->{'ID'};
+ $cEvent = "pool_change";
}
- $kernel->post("configmanager" => "process_limit_change" => $limit);
+ $kernel->post("configmanager" => $cEvent => $poolData);
- $logger->log(LOG_INFO,'[WEBSERVER/LIMITS] Acount: %s, User: %s, IP: %s, Group: %s, InterfaceGroup: %s, MatchPriority: %s, Class: %s, Limits: %s/%s, Burst: %s/%s',
+ $logger->log(LOG_INFO,"[WEBSERVER/LIMITS] Pool: %s, Identifier: %s, InterfaceGroup: %s, Class: %s, Limits: %s/%s, ".
+ "Burst: %s/%s",
$formType,
- prettyUndef($username),
- prettyUndef($ipAddress),
- prettyUndef(undef),
+ prettyUndef($identifier),
prettyUndef($interfaceGroupID),
- prettyUndef($matchPriorityID),
prettyUndef($classID),
prettyUndef($trafficLimitTx),
prettyUndef($trafficLimitRx),
@@ -491,8 +476,8 @@ sub limit_addedit
# Form header
$content .=<<EOF;
-<form role="form" method="post">
- <legend>$formType Manual Limit</legend>
+ <legend>$formType Pool</legend>
+ <form role="form" method="post">
EOF
# Spit out errors if we have any
@@ -506,30 +491,14 @@ EOF
my $interfaceGroups = getInterfaceGroups();
my $interfaceGroupStr = "";
foreach my $interfaceGroupID (sort keys %{$interfaceGroups}) {
- # Process selections nicely
+ # Check if this item is selected
my $selected = "";
if ($formData->{'InterfaceGroupID'} ne "" && $formData->{'InterfaceGroupID'} eq $interfaceGroupID) {
$selected = "selected";
}
# And build the options
- $interfaceGroupStr .= '<option value="'.$interfaceGroupID.'" '.$selected.'>'.$interfaceGroups->{$interfaceGroupID}->{'name'}.'</option>';
- }
-
- # Generate match priority list
- my $matchPriorities = getMatchPriorities();
- my $matchPriorityStr = "";
- foreach my $matchPriorityID (sort keys %{$matchPriorities}) {
- # Process selections nicely
- my $selected = "";
- if ($formData->{'MatchPriorityID'} ne "" && $formData->{'MatchPriorityID'} eq $matchPriorityID) {
- $selected = "selected";
- }
- # Default to 2 if nothing specified
- if ($formData->{'MatchPriorityID'} eq "" && $matchPriorityID eq "2") {
- $selected = "selected";
- }
- # And build the options
- $matchPriorityStr .= '<option value="'.$matchPriorityID.'" '.$selected.'>'.$matchPriorities->{$matchPriorityID}.'</option>';
+ $interfaceGroupStr .= '<option value="'.$interfaceGroupID.'" '.$selected.'>'.
+ $interfaceGroups->{$interfaceGroupID}->{'name'}.'</option>';
}
# Generate traffic class list
@@ -558,7 +527,8 @@ EOF
$selected = "selected";
}
# And build the options
- $expiresModifierStr .= '<option value="'.$expireModifier.'" '.$selected.'>'.$expiresModifiers->{$expireModifier}.'</option>';
+ $expiresModifierStr .= '<option value="'.$expireModifier.'" '.$selected.'>'.$expiresModifiers->{$expireModifier}.
+ '</option>';
}
# Blank expires if its 0
@@ -566,136 +536,131 @@ EOF
$formData->{'Expires'} = "";
}
- #
# Page content
- #
$content .=<<EOF;
- <div class="form-group">
- <label for="FriendlyName" class="col-lg-2 control-label">Friendly Name</label>
- <div class="row">
- <div class="col-lg-4 input-group">
- <input name="FriendlyName" type="text" placeholder="Opt. Friendly Name" class="form-control" value="$formData->{'FriendlyName'}" />
+ <div class="form-group">
+ <label for="FriendlyName" class="col-md-2 control-label">Friendly Name</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="FriendlyName" type="text" placeholder="Opt. Friendly Name" class="form-control"
+ value="$formData->{'FriendlyName'}" />
+ </div>
+ </div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="Username" class="col-lg-2 control-label">Username</label>
- <div class="row">
- <div class="col-lg-4 input-group">
- <input name="Username" type="text" placeholder="Username" class="form-control" value="$formData->{'Username'}" $formNoEdit/>
- <span class="input-group-addon">*</span>
+ <div class="form-group">
+ <label for="Identifier" class="col-md-2 control-label">Identifier</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="Identifier" type="text" placeholder="Identifier" class="form-control"
+ value="$formData->{'Identifier'}" $formNoEdit />
+ <span class="input-group-addon">*</span>
+ </div>
+ </div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="IP" class="col-lg-2 control-label">IP Address</label>
- <div class="row">
- <div class="col-lg-4 input-group">
- <input name="IP" type="text" placeholder="IP Address" class="form-control" value="$formData->{'IP'}" $formNoEdit/>
- <span class="input-group-addon">*</span>
+ <div class="form-group">
+ <label for="InterfaceGroupID" class="col-md-2 control-label">Interface Group</label>
+ <div class="row">
+ <div class="col-md-2">
+ <select name="InterfaceGroupID" class="form-control" $formNoEdit>
+ $interfaceGroupStr
+ </select>
+ </div>
+ </div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="InterfaceGroupID" class="col-lg-2 control-label">Interface Group</label>
- <div class="row">
- <div class="col-lg-2">
- <select name="InterfaceGroupID" class="form-control" $formNoEdit>
- $interfaceGroupStr
- </select>
- </div>
-
- <label for="MatchPriorityID" class="col-lg-2 control-label">Match Priority</label>
- <div class="col-lg-2">
- <select name="MatchPriorityID" class="form-control" $formNoEdit>
- $matchPriorityStr
- </select>
+ <div class="form-group">
+ <label for="ClassID" class="col-md-2 control-label">Traffic Class</label>
+ <div class="row">
+ <div class="col-md-2">
+ <select name="ClassID" class="form-control">
+ $trafficClassStr
+ </select>
+ </div>
+ </div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="ClassID" class="col-lg-2 control-label">Traffic Class</label>
- <div class="row">
- <div class="col-lg-2">
- <select name="ClassID" class="form-control">
- $trafficClassStr
- </select>
+ <div class="form-group">
+ <label for="TrafficLimitTx" class="col-md-2 control-label">Download CIR</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitTx" type="text" placeholder="Download CIR" class="form-control"
+ value="$formData->{'TrafficLimitTx'}" />
+ <span class="input-group-addon">Kbps *<span>
+ </div>
+ </div>
+ </div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="Expires" class="col-lg-2 control-label">Expires</label>
- <div class="row">
- <div class="col-lg-2">
- <input name="Expires" type="text" placeholder="Optional" class="form-control" value="$formData->{'Expires'}" />
- </div>
- <div class="col-lg-2">
- <select name="inputExpires.modifier" class="form-control" value="$formData->{'inputExpires.modifier'}">
- $expiresModifierStr
- </select>
+ <div class="form-group">
+ <label for="TrafficLimitTxBurst" class="col-md-2 control-label">Download Limit</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitTxBurst" type="text" placeholder="Download Limit" class="form-control"
+ value="$formData->{'TrafficLimitTxBurst'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="TrafficLimitTx" class="col-lg-2 control-label">Download CIR</label>
- <div class="row">
- <div class="col-lg-3">
- <div class="input-group">
- <input name="TrafficLimitTx" type="text" placeholder="Download CIR" class="form-control" value="$formData->{'TrafficLimitTx'}" />
- <span class="input-group-addon">Kbps *<span>
+ <div class="form-group">
+ <label for="TrafficLimitRx" class="col-md-2 control-label">Upload CIR</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitRx" type="text" placeholder="Upload CIR" class="form-control"
+ value="$formData->{'TrafficLimitRx'}" />
+ <span class="input-group-addon">Kbps *<span>
+ </div>
+ </div>
</div>
</div>
-
- <label for="TrafficLimitTxBurst" class="col-lg-1 control-label">Limit</label>
- <div class="col-lg-3">
- <div class="input-group">
- <input name="TrafficLimitTxBurst" type="text" placeholder="Download Limit" class="form-control" value="$formData->{'TrafficLimitTxBurst'}" />
- <span class="input-group-addon">Kbps<span>
+ <div class="form-group">
+ <label for="TrafficLimitRxBurst" class="col-md-2 control-label">Upload Limit</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitRxBurst" type="text" placeholder="Upload Limit" class="form-control"
+ value="$formData->{'TrafficLimitRxBurst'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
</div>
</div>
- </div>
- </div>
-
- <div class="form-group">
- <label for="TrafficLimitRx" class="col-lg-2 control-label">Upload CIR</label>
- <div class="row">
- <div class="col-lg-3">
- <div class="input-group">
- <input name="TrafficLimitRx" type="text" placeholder="Upload CIR" class="form-control" value="$formData->{'TrafficLimitRx'}" />
- <span class="input-group-addon">Kbps *<span>
+ <div class="form-group">
+ <label for="Expires" class="col-md-2 control-label">Expires</label>
+ <div class="row">
+ <div class="col-md-2">
+ <input name="Expires" type="text" placeholder="Optional" class="form-control"
+ value="$formData->{'Expires'}" />
+ </div>
+ <div class="col-md-2">
+ <select name="inputExpires.modifier" class="form-control" value="$formData->{'inputExpires.modifier'}">
+ $expiresModifierStr
+ </select>
+ </div>
</div>
</div>
-
- <label for="TrafficLimitRxBurst" class="col-lg-1 control-label">Limit</label>
- <div class="col-lg-3">
- <div class="input-group">
- <input name="TrafficLimitRxBurst" type="text" placeholder="Upload Limit" class="form-control" value="$formData->{'TrafficLimitRxBurst'}" />
- <span class="input-group-addon">Kbps<span>
+ <div class="form-group">
+ <label for="Notes" class="col-md-2 control-label">Notes</label>
+ <div class="row">
+ <div class="col-md-4">
+ <textarea name="Notes" placeholder="Opt. Notes" rows="3"
+ class="form-control">$formData->{'Notes'}</textarea>
+ </div>
</div>
</div>
- </div>
- </div>
- <div class="form-group">
- <label for="Notes" class="col-lg-2 control-label">Notes</label>
- <div class="row">
- <div class="col-lg-4">
- <textarea name="Notes" placeholder="Opt. Notes" rows="3" class="form-control"></textarea>
+ <div class="form-group">
+ <button name="submit" type="submit" value="$formType" class="btn btn-primary">$formType</button>
+ <button name="cancel" type="submit" class="btn">Cancel</button>
</div>
- </div>
- </div>
- <div class="form-group">
- <button type="submit" class="btn btn-primary">$formType</button>
- <button name="cancel" type="submit" class="btn">Cancel</button>
- </div>
-</form>
+ </form>
EOF
return (HTTP_OK,$content,{ 'menu' => $menu });
}
-# Remove action
-sub limit_remove
+# Pool remove action
+sub pool_remove
{
my ($kernel,$globals,$client_session_id,$request) = @_;
@@ -704,64 +669,63 @@ sub limit_remove
my $content = "";
- # Pull in GET
+ # Pull in query data
my $queryParams = parseURIQuery($request);
# We need a key first of all...
- if (!defined($queryParams->{'lid'})) {
+ if (!defined($queryParams->{'pid'})) {
$content = <<EOF;
<div class="alert alert-danger text-center">
- No limit ID in query string!
+ No pool ID in query string!
</div>
EOF
goto END;
}
- # Grab the limit
- my $limit = getLimit($queryParams->{'lid'}->{'value'});
-
- # Make the key safe for HTML
- my $encodedLID = encode_entities($queryParams->{'lid'}->{'value'});
+ # Grab the pool
+ my $pool = getPool($queryParams->{'pid'}->{'value'});
- # Make sure the limit ID is valid... we would have a limit now if it was
- if (!defined($limit)) {
+ # Make sure the pool ID is valid... we would have a pool now if it was
+ if (!defined($pool)) {
$content = <<EOF;
<div class="alert alert-danger text-center">
- Invalid limit ID "$encodedLID"!
+ Invalid pool ID!
</div>
EOF
goto END;
}
- # Make sure its a manual limit we're removing
- if ($limit->{'Source'} ne "plugin.webserver.limits") {
+ # Make sure its a manual pool we're removing
+ if ($pool->{'Source'} ne "plugin.webserver.limits") {
$content = <<EOF;
<div class="alert alert-danger text-center">
- Only manual limits can be removed!
+ Only manual pools can be removed!
</div>
EOF
goto END;
}
# Pull in POST
- my $postParams = parseFormContent($request->content);
+ my $form = parseFormContent($request->content);
+
# If this is a post, then its probably a confirmation
- if (defined($postParams->{'confirm'})) {
+ if (defined($form->{'confirm'})) {
# Check if its a success
- if ($postParams->{'confirm'} eq "Yes") {
+ if ($form->{'confirm'}->{'value'} eq "Yes") {
# Post the removal
- $kernel->post("configmanager" => "process_limit_remove" => $limit);
+ $kernel->post("configmanager" => "pool_remove" => $pool->{'ID'});
}
return (HTTP_TEMPORARY_REDIRECT,'limits');
}
-
+ # Make the pool ID safe for HTML
+ my $encodedPID = encode_entities($queryParams->{'pid'}->{'value'});
# Make the friendly name HTML safe
- my $encodedUsername = encode_entities($limit->{'Username'});
+ my $encodedIdentifier = encode_entities($pool->{'Identifier'});
# Build our confirmation dialog
$content .= <<EOF;
<div class="alert alert-danger">
- Are you very sure you wish to remove limit for "$encodedUsername"?
+ Are you very sure you wish to remove pool for "$encodedIdentifier"?
</div>
<form role="form" method="post">
<input type="submit" class="btn btn-primary" name="confirm" value="Yes" />
@@ -773,5 +737,1646 @@ END:
return (HTTP_OK,$content,{ 'menu' => $menu });
}
+
+# Pool member list page/action
+sub poolmember_list
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ # Build content
+ my $content = "";
+ # Build custom menu
+ my $customMenu = $menu;
+
+
+ # Pull in query params
+ my $queryParams = parseURIQuery($request);
+ # We need a key first of all...
+ if (!defined($queryParams->{'pid'})) {
+ $content = <<EOF;
+ <div class="alert alert-danger text-center">
+ No pool ID in query string!
+ </div>
+EOF
+ goto END;
+ }
+
+ # Grab the pool
+ my $pool = getPool($queryParams->{'pid'}->{'value'});
+
+ # If pool is not defined, it means we got an invalid pool ID
+ if (!defined($pool)) {
+ $content = <<EOF;
+ <div class="alert alert-danger text-center">
+ Invalid pool ID!
+ </div>
+EOF
+ goto END;
+ }
+
+ # Grab pools members
+ my @poolMembers = getPoolMembers($pool->{'ID'});
+
+ # Make the pool ID safe for HTML
+ my $pidEscaped = encode_entities($pool->{'ID'});
+
+ my $poolFriendlyName = (defined($pool->{'FriendlyName'}) && $pool->{'FriendlyName'} ne "") ? $pool->{'FriendlyName'} :
+ $pool->{'Identifier'};
+ my $poolFriendlyNameEncoded = encode_entities($poolFriendlyName);
+ my $poolIdentifierEncoded = encode_entities($pool->{'Identifier'});
+
+ # Menu
+ $customMenu = [
+ {
+ 'name' => 'Pool Members',
+ 'items' => [
+ {
+ 'name' => 'Add Pool Member',
+ 'link' => "poolmember-add?pid=$pidEscaped",
+ },
+ ],
+ },
+ @{$menu}
+ ];
+ # Header
+ $content .=<<EOF;
+ <legend>
+ <a href="pool-list"><span class="glyphicon glyphicon-circle-arrow-left"></span></a>
+ Pool Member List: '$poolFriendlyNameEncoded' [$poolIdentifierEncoded]
+ </legend>
+ <table class="table">
+ <thead>
+ <tr>
+ <th></th>
+ <th>Friendly Name</th>
+ <th>Username</th>
+ <th>IP</th>
+ <th>Created</th>
+ <th>Updated</th>
+ <th>Expires</th>
+ <th></th>
+ </tr>
+ </thead>
+ <tbody>
+EOF
+ # Body
+ foreach my $pmid (@poolMembers) {
+ my $poolMember;
+ # If we can't get the pool member just move onto the next
+ if (!defined($poolMember = getPoolMember($pmid))) {
+ next;
+ }
+
+ # Get a nice last update string
+ my $pmidEscaped = uri_escape($poolMember->{'ID'});
+
+ my $friendlyName = (defined($poolMember->{'FriendlyName'}) && $poolMember->{'FriendlyName'} ne "") ?
+ $poolMember->{'FriendlyName'} : $poolMember->{'Username'};
+ my $friendlyNameEncoded = encode_entities($friendlyName);
+
+ my $usernameEncoded = encode_entities($poolMember->{'Username'});
+
+ my $ipEncoded = encode_entities($poolMember->{'IPAddress'});
+
+ my $createdStr = ($poolMember->{'Created'} > 0) ?
+ DateTime->from_epoch( epoch => $poolMember->{'Created'} )->iso8601() : '-never-';
+ my $updatedStr = ($poolMember->{'LastUpdate'} > 0) ?
+ DateTime->from_epoch( epoch => $poolMember->{'LastUpdate'} )->iso8601() : '-never-';
+ my $expiresStr = ($poolMember->{'Expires'} > 0) ?
+ DateTime->from_epoch( epoch => $poolMember->{'Expires'} )->iso8601() : '-never-';
+
+ # Display relevant icons depending on pool status
+ my $icons = "";
+ if (getPoolMemberShaperState($poolMember->{'ID'}) ne SHAPER_LIVE) {
+ $icons .= '<span class="glyphicon glyphicon-time" />';
+ }
+ if ($poolMember->{'Status'} == CFGM_NEW) {
+ $icons .= '<span class="glyphicon glyphicon-import" />';
+ }
+ if ($poolMember->{'Status'} == CFGM_OFFLINE) {
+ $icons .= '<span class="glyphicon glyphicon-trash" />';
+ }
+# if ($poolMember->{'Status'} eq 'conflict') {
+# $icons .= '<span class="glyphicon glyphicon-random" />';
+# }
+# if ($pool->{'Status'} eq 'conflict') {
+# $icons .= '<span class="glyphicon glyphicon-edit" />';
+# }
+
+ $content .= <<EOF;
+ <tr>
+ <td>$icons</td>
+ <td>$friendlyNameEncoded</td>
+ <td>$usernameEncoded</td>
+ <td>$ipEncoded</td>
+ <td>$createdStr</td>
+ <td>$updatedStr</td>
+ <td>$expiresStr</td>
+ <td>
+ <a href="/limits/poolmember-edit?pmid=$pmidEscaped"><span class="glyphicon glyphicon-wrench"></span></a>
+ <a href="/limits/poolmember-remove?pmid=$pmidEscaped"><span class="glyphicon glyphicon-remove"></span></a>
+ </td>
+ </tr>
+EOF
+ }
+
+ # No results
+ if (!@poolMembers) {
+ $content .=<<EOF;
+ <tr class="info">
+ <td colspan="8"><p class="text-center">No Results</p></td>
+ </tr>
+EOF
+ }
+
+ # Footer
+ $content .=<<EOF;
+ </tbody>
+ </table>
+ <span class="glyphicon glyphicon-time" /> - Processing,
+ <span class="glyphicon glyphicon-edit" /> - Override,
+ <span class="glyphicon glyphicon-import" /> - Being Added,
+ <span class="glyphicon glyphicon-trash" /> - Being Removed,
+ <span class="glyphicon glyphicon-random" /> - Conflicts
+EOF
+
+END:
+ return (HTTP_OK,$content,{ 'menu' => $customMenu });
+}
+
+
+# Pool member add/edit action
+sub poolmember_addedit
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ # Setup our environment
+ my $logger = $globals->{'logger'};
+
+ # Errors to display above the form
+ my @errors;
+
+ # Items for our form...
+ my @formElements = qw(
+ FriendlyName
+ Username IPAddress
+ MatchPriorityID
+ Expires inputExpires.modifier
+ Notes
+ );
+
+ # Expires modifier options
+ my $expiresModifiers = {
+ 'm' => "Minutes",
+ 'h' => "Hours",
+ 'd' => "Days",
+ 'n' => "Never",
+ };
+
+
+ # Title of the form, by default its an add form
+ my $formType = "Add";
+ my $formNoEdit = "";
+ # Form data
+ my $formData;
+ # Pool
+ my $pool;
+ my $poolMember;
+
+
+ # Parse query params
+ my $queryParams = parseURIQuery($request);
+
+ # If we have a pool member ID, pull in the pool member
+ if (defined($queryParams->{'pmid'})) {
+ # Check if we can grab the pool member
+ if (!defined($poolMember = getPoolMember($queryParams->{'pmid'}->{'value'}))) {
+ return (HTTP_TEMPORARY_REDIRECT,"limits");
+ }
+
+ $pool = getPool($poolMember->{'PoolID'});
+
+ # If we have a pool ID, pull in the pool
+ } elsif (defined($queryParams->{'pid'})) {
+ # Check if we can grab the pool
+ if (!defined($pool = getPool($queryParams->{'pid'}->{'value'}))) {
+ return (HTTP_TEMPORARY_REDIRECT,"limits");
+ }
+ }
+
+ # If this is a form try parse it
+ if ($request->method eq "POST") {
+ # Parse form data
+ my $form = parseFormContent($request->content);
+
+ # If user pressed cancel, redirect
+ if (defined($form->{'cancel'})) {
+ # If the pool member is defined, rededirect to pool member list
+ if (defined($poolMember)) {
+ my $pidEscaped = uri_escape($poolMember->{'PoolID'});
+ return (HTTP_TEMPORARY_REDIRECT,"limits/poolmember-list?pid=$pidEscaped");
+ # Do same for pool
+ } elsif (defined($pool)) {
+ my $pidEscaped = uri_escape($pool->{'ID'});
+ return (HTTP_TEMPORARY_REDIRECT,"limits/poolmember-list?pid=$pidEscaped");
+ }
+
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
+ }
+
+ # Transform form into form data
+ foreach my $key (keys %{$form}) {
+ $formData->{$key} = $form->{$key}->{'value'};
+ }
+
+ # Set form type if its edit
+ if (defined($form->{'submit'}) && $form->{'submit'}->{'value'} eq "Edit") {
+ # If there is no pool member on submit, redirect<F7>
+ if (!defined($poolMember)) {
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
+ }
+
+ $formData->{'ID'} = $poolMember->{'ID'};
+
+ $formType = "Edit";
+ $formNoEdit = "readonly";
+ }
+
+ # Maybe we were given an override key as a parameter? this would be an edit form
+ } elsif ($request->method eq "GET") {
+ # If we got a pool member, this is an edit
+ if (defined($poolMember)) {
+ # Setup form data from pool member
+ foreach my $key (@formElements) {
+ $formData->{$key} = $poolMember->{$key};
+ }
+
+ # Lastly if we were given a key, this is actually an edit
+ $formType = "Edit";
+ $formNoEdit = "readonly";
+
+ # Woops ... no query string?
+ } elsif (!defined($pool)) {
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
+ }
+ }
+
+ if (ref($formData) eq "HASH") {
+ # Grab friendly name
+ my $friendlyName = $formData->{'FriendlyName'};
+
+ # Check POST data
+ my $username;
+ if (!defined($username = isUsername($formData->{'Username'}))) {
+ push(@errors,"Username is not valid");
+ }
+ my $ipAddress;
+ if (!defined($ipAddress = isIP($formData->{'IPAddress'}))) {
+ push(@errors,"IP address is not valid");
+ }
+ my $matchPriorityID;
+ if (!defined($matchPriorityID = isMatchPriorityIDValid($formData->{'MatchPriorityID'}))) {
+ push(@errors,"Match priority is not valid");
+ }
+
+ if ($formType eq "Add") {
+ if (getPoolMembersByIP($pool->{'InterfaceGroupID'},$ipAddress)) {
+ push(@errors,"A pool member with the same IP address already exists");
+ }
+ } elsif ($formType eq "Edit") {
+ if (!isPoolMemberReady($poolMember->{'ID'})) {
+ push(@errors,"Pool member is not currently in a READY state, please try again");
+ }
+ }
+
+ my $expires = 0;
+ if (defined($formData->{'Expires'}) && $formData->{'Expires'} ne "") {
+ if (!defined($expires = isNumber($formData->{'Expires'}))) {
+ push(@errors,"Expires value is not valid");
+ # Check the modifier
+ } else {
+ # Check if its defined
+ if (defined($formData->{'inputExpires.modifier'}) && $formData->{'inputExpires.modifier'} ne "") {
+ # Never
+ if ($formData->{'inputExpires.modifier'} eq "n") {
+ $expires = 0;
+ } elsif ($formData->{'inputExpires.modifier'} eq "m") {
+ $expires *= 60;
+ # Hours
+ } elsif ($formData->{'inputExpires.modifier'} eq "h") {
+ $expires *= 3600;
+ # Days
+ } elsif ($formData->{'inputExpires.modifier'} eq "d") {
+ $expires *= 86400;
+ } else {
+ push(@errors,"Expires modifier is not valid");
+ }
+ }
+ # Base the expiry off now, plus the expiry time
+ if ($expires > 0) {
+ $expires += time();
+ }
+ }
+ }
+ # Grab notes
+ my $notes = $formData->{'Notes'};
+
+ # If there are no errors we need to push this update
+ if (!@errors && $request->method eq "POST") {
+ # Build limit
+ my $poolMemberData = {
+ 'FriendlyName' => $friendlyName,
+ 'Username' => $username,
+ 'IPAddress' => $ipAddress,
+ 'GroupID' => 1,
+ 'MatchPriorityID' => $matchPriorityID,
+ 'Expires' => $expires,
+ 'Notes' => $notes,
+ };
+
+ my $cEvent;
+ if ($formType eq "Add") {
+ $poolMemberData->{'PoolID'} = $pool->{'ID'};
+ $poolMemberData->{'Source'} = 'plugin.webserver.limits';
+ $cEvent = "poolmember_add";
+ } else {
+ $poolMemberData->{'ID'} = $poolMember->{'ID'};
+ $cEvent = "poolmember_change";
+ }
+
+ $kernel->post("configmanager" => $cEvent => $poolMemberData);
+
+ $logger->log(LOG_INFO,'[WEBSERVER/POOLMEMBER] Account: %s, User: %s, IP: %s, Group: %s, MatchPriority: %s, Pool: %s',
+ $formType,
+ prettyUndef($username),
+ prettyUndef($ipAddress),
+ prettyUndef(undef),
+ prettyUndef($matchPriorityID),
+ prettyUndef($pool->{'ID'}),
+ );
+
+ my $pidEscaped = uri_escape($pool->{'ID'});
+ return (HTTP_TEMPORARY_REDIRECT,"limits/poolmember-list?pid=$pidEscaped");
+ }
+ }
+
+ # Sanitize params if we need to
+ foreach my $item (@formElements) {
+ $formData->{$item} = defined($formData->{$item}) ? encode_entities($formData->{$item}) : "";
+ }
+
+ my $pidEscaped = uri_escape($pool->{'ID'});
+
+ # Build content
+ my $content = "";
+ # Menu
+ my $customMenu = [
+ {
+ 'name' => 'Pool Members',
+ 'items' => [
+ {
+ 'name' => 'Add Pool Member',
+ 'link' => "poolmember-add?pid=$pidEscaped",
+ },
+ ],
+ },
+ @{$menu}
+ ];
+
+
+ # Form header
+ $content .=<<EOF;
+ <legend>$formType Pool Member</legend>
+ <form role="form" method="post">
+EOF
+
+ # Spit out errors if we have any
+ if (@errors > 0) {
+ foreach my $error (@errors) {
+ $content .= '<div class="alert alert-danger">'.$error.'</div>';
+ }
+ }
+
+ # Generate match priority list
+ my $matchPriorities = getMatchPriorities();
+ my $matchPriorityStr = "";
+ foreach my $matchPriorityID (sort keys %{$matchPriorities}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'MatchPriorityID'} ne "" && $formData->{'MatchPriorityID'} eq $matchPriorityID) {
+ $selected = "selected";
+ }
+ # Default to 2 if nothing specified
+ if ($formData->{'MatchPriorityID'} eq "" && $matchPriorityID eq "2") {
+ $selected = "selected";
+ }
+ # And build the options
+ $matchPriorityStr .= '<option value="'.$matchPriorityID.'" '.$selected.'>'.$matchPriorities->{$matchPriorityID}.
+ '</option>';
+ }
+
+ # Generate expires modifiers list
+ my $expiresModifierStr = "";
+ foreach my $expireModifier (sort keys %{$expiresModifiers}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'inputExpires.modifier'} ne "" && $formData->{'inputExpires.modifier'} eq $expireModifier) {
+ $selected = "selected";
+ }
+ # Default to n if nothing is specified
+ if ($formData->{'inputExpires.modifier'} eq "" && $expireModifier eq "n") {
+ $selected = "selected";
+ }
+ # And build the options
+ $expiresModifierStr .= '<option value="'.$expireModifier.'" '.$selected.'>'.$expiresModifiers->{$expireModifier}.
+ '</option>';
+ }
+
+ # Blank expires if its 0
+ if (defined($formData->{'Expires'}) && $formData->{'Expires'} eq "0") {
+ $formData->{'Expires'} = "";
+ }
+
+ # Page content
+ $content .=<<EOF;
+ <div class="form-group">
+ <label for="FriendlyName" class="col-md-2 control-label">Friendly Name</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="FriendlyName" type="text" placeholder="Opt. Friendly Name" class="form-control"
+ value="$formData->{'FriendlyName'}" />
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Username" class="col-md-2 control-label">Username</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="Username" type="text" placeholder="Username" class="form-control"
+ value="$formData->{'Username'}" $formNoEdit />
+ <span class="input-group-addon">*</span>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="IPAddress" class="col-md-2 control-label">IP Address</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="IPAddress" type="text" placeholder="IP Address" class="form-control"
+ value="$formData->{'IPAddress'}" $formNoEdit />
+ <span class="input-group-addon">*</span>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="MatchPriorityID" class="col-md-2 control-label">Match Priority</label>
+ <div class="row">
+ <div class="col-md-2">
+ <select name="MatchPriorityID" class="form-control" $formNoEdit>
+ $matchPriorityStr
+ </select>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Expires" class="col-md-2 control-label">Expires</label>
+ <div class="row">
+ <div class="col-md-2">
+ <input name="Expires" type="text" placeholder="Optional" class="form-control"
+ value="$formData->{'Expires'}" />
+ </div>
+ <div class="col-md-2">
+ <select name="inputExpires.modifier" class="form-control" value="$formData->{'inputExpires.modifier'}">
+ $expiresModifierStr
+ </select>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Notes" class="col-md-2 control-label">Notes</label>
+ <div class="row">
+ <div class="col-md-4">
+ <textarea name="Notes" placeholder="Opt. Notes" rows="3"
+ class="form-control">$formData->{'Notes'}</textarea>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <button name="submit" type="submit" value="$formType" class="btn btn-primary">$formType</button>
+ <button name="cancel" type="submit" class="btn">Cancel</button>
+ </div>
+ </form>
+EOF
+
+ return (HTTP_OK,$content,{ 'menu' => $customMenu });
+}
+
+
+# Pool member remove action
+sub poolmember_remove
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ # Content to return
+ my $content = "";
+ # Build custom menu
+ my $customMenu = $menu;
+
+ # Pull in query params
+ my $queryParams = parseURIQuery($request);
+ # We need a key first of all...
+ if (!defined($queryParams->{'pmid'})) {
+ $content = <<EOF;
+ <div class="alert alert-danger text-center">
+ No pool member ID in query string!
+ </div>
+EOF
+ goto END;
+ }
+
+ # Grab the pool
+ my $poolMember = getPoolMember($queryParams->{'pmid'}->{'value'});
+
+ # If we don't have a pool member it means the ID we got is invalid
+ if (!defined($poolMember)) {
+ $content = <<EOF;
+ <div class="alert alert-danger text-center">
+ Invalid pool member ID!
+ </div>
+EOF
+ goto END;
+ }
+
+ # Make the pool ID safe for HTML
+ my $pidEscaped = encode_entities($poolMember->{'PoolID'});
+
+ # Menu
+ $customMenu = [
+ {
+ 'name' => 'Pool Members',
+ 'items' => [
+ {
+ 'name' => 'Add Pool Member',
+ 'link' => "poolmember-add?pid=$pidEscaped",
+ },
+ ],
+ },
+ @{$menu}
+ ];
+
+ # Pull in POST
+ my $form = parseFormContent($request->content);
+
+ # If this is a post, then its probably a confirmation
+ if (defined($form->{'confirm'})) {
+ # Check if its a success
+ if ($form->{'confirm'}->{'value'} eq "Yes") {
+ # Post the removal
+ $kernel->post("configmanager" => "poolmember_remove" => $poolMember->{'ID'});
+ }
+ return (HTTP_TEMPORARY_REDIRECT,"limits/poolmember-list?pid=$pidEscaped");
+ }
+
+ # Make the friendly name HTML safe
+ my $friendlyName = (defined($poolMember->{'FriendlyName'}) && $poolMember->{'FriendlyName'} ne "") ?
+ $poolMember->{'FriendlyName'} : $poolMember->{'Username'};
+ my $friendlyNameEncoded = encode_entities($friendlyName);
+ my $usernameEncoded = encode_entities($poolMember->{'Username'});
+
+ # Build our confirmation dialog
+ $content .= <<EOF;
+ <div class="alert alert-danger">
+ Are you very sure you wish to remove pool member "$friendlyNameEncoded" [$usernameEncoded]?
+ </div>
+ <form role="form" method="post">
+ <input type="submit" class="btn btn-primary" name="confirm" value="Yes" />
+ <input type="submit" class="btn btn-default" name="confirm" value="No" />
+ </form>
+EOF
+ # And here is where we return
+END:
+ return (HTTP_OK,$content,{ 'menu' => $customMenu });
+}
+
+
+# Add action
+sub limit_add
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ # Setup our environment
+ my $logger = $globals->{'logger'};
+
+ # Errors to display above the form
+ my @errors;
+
+ # Items for our form...
+ my @formElements = qw(
+ FriendlyName
+ Username IPAddress
+ InterfaceGroupID
+ MatchPriorityID
+ ClassID
+ TrafficLimitTx TrafficLimitTxBurst
+ TrafficLimitRx TrafficLimitRxBurst
+ Expires inputExpires.modifier
+ Notes
+ );
+
+ # Expires modifier options
+ my $expiresModifiers = {
+ 'm' => "Minutes",
+ 'h' => "Hours",
+ 'd' => "Days",
+ 'n' => "Never",
+ };
+
+
+ # Form data
+ my $formData;
+
+ # If this is a form try parse it
+ if ($request->method eq "POST") {
+ # Parse form data
+ my $form = parseFormContent($request->content);
+
+ # If user pressed cancel, redirect
+ if (defined($form->{'cancel'})) {
+ # Redirects to default page
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
+ }
+
+ # Transform form into form data
+ foreach my $key (keys %{$form}) {
+ $formData->{$key} = $form->{$key}->{'value'};
+ }
+ }
+
+ # We only do this if we have hash elements
+ if (ref($formData) eq "HASH") {
+ # Grab friendly name
+ my $friendlyName = $formData->{'FriendlyName'};
+
+ # Check POST data
+ my $username;
+ if (!defined($username = isUsername($formData->{'Username'}))) {
+ push(@errors,"Username is not valid");
+ }
+ my $ipAddress;
+ if (!defined($ipAddress = isIP($formData->{'IPAddress'}))) {
+ push(@errors,"IP address is not valid");
+ }
+ my $interfaceGroupID;
+ if (!defined($interfaceGroupID = isInterfaceGroupIDValid($formData->{'InterfaceGroupID'}))) {
+ push(@errors,"Interface group is not valid");
+ }
+ my $matchPriorityID;
+ if (!defined($matchPriorityID = isMatchPriorityIDValid($formData->{'MatchPriorityID'}))) {
+ push(@errors,"Match priority is not valid");
+ }
+ my $classID;
+ if (!defined($classID = isTrafficClassIDValid($formData->{'ClassID'}))) {
+ push(@errors,"Traffic class is not valid");
+ }
+ my $trafficLimitTx = isNumber($formData->{'TrafficLimitTx'});
+ my $trafficLimitTxBurst = isNumber($formData->{'TrafficLimitTxBurst'});
+ if (!defined($trafficLimitTx) && !defined($trafficLimitTxBurst)) {
+ push(@errors,"A valid download CIR and/or limit is required");
+ }
+ my $trafficLimitRx = isNumber($formData->{'TrafficLimitRx'});
+ my $trafficLimitRxBurst = isNumber($formData->{'TrafficLimitRxBurst'});
+ if (!defined($trafficLimitRx) && !defined($trafficLimitRxBurst)) {
+ push(@errors,"A valid upload CIR and/or limit is required");
+ }
+
+ my $expires = 0;
+ if (defined($formData->{'Expires'}) && $formData->{'Expires'} ne "") {
+ if (!defined($expires = isNumber($formData->{'Expires'}))) {
+ push(@errors,"Expires value is not valid");
+ # Check the modifier
+ } else {
+ # Check if its defined
+ if (defined($formData->{'inputExpires.modifier'}) && $formData->{'inputExpires.modifier'} ne "") {
+ # Never
+ if ($formData->{'inputExpires.modifier'} eq "n") {
+ $expires = 0;
+ } elsif ($formData->{'inputExpires.modifier'} eq "m") {
+ $expires *= 60;
+ # Hours
+ } elsif ($formData->{'inputExpires.modifier'} eq "h") {
+ $expires *= 3600;
+ # Days
+ } elsif ($formData->{'inputExpires.modifier'} eq "d") {
+ $expires *= 86400;
+ } else {
+ push(@errors,"Expires modifier is not valid");
+ }
+ }
+ # Base the expiry off now, plus the expiry time
+ if ($expires > 0) {
+ $expires += time();
+ }
+ }
+ }
+ # Grab notes
+ my $notes = $formData->{'Notes'};
+
+ # If there are no errors we need to push this update
+ if (!@errors && $request->method eq "POST") {
+ # Build limit
+ my $limit = {
+ 'FriendlyName' => $friendlyName,
+ 'Username' => $username,
+ 'IPAddress' => $ipAddress,
+ 'GroupID' => 1,
+ 'InterfaceGroupID' => $interfaceGroupID,
+ 'MatchPriorityID' => $matchPriorityID,
+ 'ClassID' => $classID,
+ 'TrafficLimitTx' => $trafficLimitTx,
+ 'TrafficLimitTxBurst' => $trafficLimitTxBurst,
+ 'TrafficLimitRx' => $trafficLimitRx,
+ 'TrafficLimitRxBurst' => $trafficLimitRxBurst,
+ 'Expires' => $expires,
+ 'Notes' => $notes,
+ };
+
+ # Throw the change at the config manager after we add extra data we need
+ $limit->{'Status'} = CFGM_ONLINE;
+ $limit->{'Source'} = 'plugin.webserver.limits';
+
+ $kernel->post("configmanager" => "limit_add" => $limit);
+
+ $logger->log(LOG_INFO,"[WEBSERVER/LIMITS] New User: %s, IP: %s, Group: %s, InterfaceGroup: %s, MatchPriority: %s, ".
+ "Class: %s, Limits: %s/%s, Burst: %s/%s",
+ prettyUndef($username),
+ prettyUndef($ipAddress),
+ prettyUndef(undef),
+ prettyUndef($interfaceGroupID),
+ prettyUndef($matchPriorityID),
+ prettyUndef($classID),
+ prettyUndef($trafficLimitTx),
+ prettyUndef($trafficLimitRx),
+ prettyUndef($trafficLimitTxBurst),
+ prettyUndef($trafficLimitRxBurst)
+ );
+
+ return (HTTP_TEMPORARY_REDIRECT,'limits');
+ }
+ }
+
+ # Sanitize params if we need to
+ foreach my $item (@formElements) {
+ $formData->{$item} = defined($formData->{$item}) ? encode_entities($formData->{$item}) : "";
+ }
+
+ # Build content
+ my $content = "";
+
+ # Form header
+ $content .=<<EOF;
+ <legend>Add Limit</legend>
+ <form role="form" method="post">
+EOF
+
+ # Spit out errors if we have any
+ if (@errors > 0) {
+ foreach my $error (@errors) {
+ $content .= '<div class="alert alert-danger">'.$error.'</div>';
+ }
+ }
+
+ # Generate interface group list
+ my $interfaceGroups = getInterfaceGroups();
+ my $interfaceGroupStr = "";
+ foreach my $interfaceGroupID (sort keys %{$interfaceGroups}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'InterfaceGroupID'} ne "" && $formData->{'InterfaceGroupID'} eq $interfaceGroupID) {
+ $selected = "selected";
+ }
+ # And build the options
+ $interfaceGroupStr .= '<option value="'.$interfaceGroupID.'" '.$selected.'>'.
+ $interfaceGroups->{$interfaceGroupID}->{'name'}.'</option>';
+ }
+
+ # Generate match priority list
+ my $matchPriorities = getMatchPriorities();
+ my $matchPriorityStr = "";
+ foreach my $matchPriorityID (sort keys %{$matchPriorities}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'MatchPriorityID'} ne "" && $formData->{'MatchPriorityID'} eq $matchPriorityID) {
+ $selected = "selected";
+ }
+ # Default to 2 if nothing specified
+ if ($formData->{'MatchPriorityID'} eq "" && $matchPriorityID eq "2") {
+ $selected = "selected";
+ }
+ # And build the options
+ $matchPriorityStr .= '<option value="'.$matchPriorityID.'" '.$selected.'>'.$matchPriorities->{$matchPriorityID}.
+ '</option>';
+ }
+
+ # Generate traffic class list
+ my $trafficClasses = getTrafficClasses();
+ my $trafficClassStr = "";
+ foreach my $classID (sort keys %{$trafficClasses}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'ClassID'} ne "" && $formData->{'ClassID'} eq $classID) {
+ $selected = "selected";
+ }
+ # And build the options
+ $trafficClassStr .= '<option value="'.$classID.'" '.$selected.'>'.$trafficClasses->{$classID}.'</option>';
+ }
+
+ # Generate expires modifiers list
+ my $expiresModifierStr = "";
+ foreach my $expireModifier (sort keys %{$expiresModifiers}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'inputExpires.modifier'} ne "" && $formData->{'inputExpires.modifier'} eq $expireModifier) {
+ $selected = "selected";
+ }
+ # Default to n if nothing is specified
+ if ($formData->{'inputExpires.modifier'} eq "" && $expireModifier eq "n") {
+ $selected = "selected";
+ }
+ # And build the options
+ $expiresModifierStr .= '<option value="'.$expireModifier.'" '.$selected.'>'.$expiresModifiers->{$expireModifier}.
+ '</option>';
+ }
+
+ # Blank expires if its 0
+ if (defined($formData->{'Expires'}) && $formData->{'Expires'} eq "0") {
+ $formData->{'Expires'} = "";
+ }
+
+ # Page content
+ $content .=<<EOF;
+ <div class="form-group">
+ <label for="FriendlyName" class="col-md-2 control-label">Friendly Name</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="FriendlyName" type="text" placeholder="Opt. Friendly Name" class="form-control"
+ value="$formData->{'FriendlyName'}" />
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Username" class="col-md-2 control-label">Username</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="Username" type="text" placeholder="Username" class="form-control"
+ value="$formData->{'Username'}" />
+ <span class="input-group-addon">*</span>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="IPAddress" class="col-md-2 control-label">IP Address</label>
+ <div class="row">
+ <div class="col-md-4 input-group">
+ <input name="IPAddress" type="text" placeholder="IP Address" class="form-control"
+ value="$formData->{'IPAddress'}" />
+ <span class="input-group-addon">*</span>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="InterfaceGroupID" class="col-md-2 control-label">Interface Group</label>
+ <div class="row">
+ <div class="col-md-2">
+ <select name="InterfaceGroupID" class="form-control">
+ $interfaceGroupStr
+ </select>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="MatchPriorityID" class="col-md-2 control-label">Match Priority</label>
+ <div class="row">
+ <div class="col-md-2">
+ <select name="MatchPriorityID" class="form-control">
+ $matchPriorityStr
+ </select>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="ClassID" class="col-md-2 control-label">Traffic Class</label>
+ <div class="row">
+ <div class="col-md-2">
+ <select name="ClassID" class="form-control">
+ $trafficClassStr
+ </select>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Expires" class="col-md-2 control-label">Expires</label>
+ <div class="row">
+ <div class="col-md-2">
+ <input name="Expires" type="text" placeholder="Optional" class="form-control"
+ value="$formData->{'Expires'}" />
+ </div>
+ <div class="col-md-2">
+ <select name="inputExpires.modifier" class="form-control" value="$formData->{'inputExpires.modifier'}">
+ $expiresModifierStr
+ </select>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="TrafficLimitTx" class="col-md-2 control-label">Download CIR</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitTx" type="text" placeholder="Download CIR" class="form-control"
+ value="$formData->{'TrafficLimitTx'}" />
+ <span class="input-group-addon">Kbps *<span>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="TrafficLimitTxBurst" class="col-md-2 control-label">Download Limit</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitTxBurst" type="text" placeholder="Download Limit" class="form-control"
+ value="$formData->{'TrafficLimitTxBurst'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="TrafficLimitRx" class="col-md-2 control-label">Upload CIR</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitRx" type="text" placeholder="Upload CIR" class="form-control"
+ value="$formData->{'TrafficLimitRx'}" />
+ <span class="input-group-addon">Kbps *<span>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="TrafficLimitRxBurst" class="col-md-2 control-label">Upload Limit</label>
+ <div class="row">
+ <div class="col-md-3">
+ <div class="input-group">
+ <input name="TrafficLimitRxBurst" type="text" placeholder="Upload Limit" class="form-control"
+ value="$formData->{'TrafficLimitRxBurst'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Notes" class="col-md-2 control-label">Notes</label>
+ <div class="row">
+ <div class="col-md-4">
+ <textarea name="Notes" placeholder="Opt. Notes" rows="3"
+ class="form-control">$formData->{'Notes'}</textarea>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <button type="submit" class="btn btn-primary">Add</button>
+ <button name="cancel" type="submit" class="btn">Cancel</button>
+ </div>
+ </form>
+EOF
+
+ return (HTTP_OK,$content,{ 'menu' => $menu });
+}
+
+
+# Override list
+sub override_list
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ my @overrides = getOverrides();
+
+ # Build content
+ my $content = "";
+
+ # Header
+ $content .=<<EOF;
+ <legend>Override List</legend>
+ <table class="table">
+ <thead>
+ <tr>
+ <th></th>
+ <th>Friendly Name</th>
+ <th>Pool</th>
+ <th>User</th>
+ <th>IP</th>
+ <th>Expires</th>
+ <th></th>
+ <th>Class</th>
+ <th>CIR (Kbps)</th>
+ <th>Limit (Kbps)</th>
+ <th></th>
+ </tr>
+ </thead>
+ <tbody>
+EOF
+ # Body
+ foreach my $oid (@overrides) {
+ my $override;
+ # If we can't get the override, just skip it
+ if (!defined($override = getOverride($oid))) {
+ next;
+ }
+
+ my $oidEscaped = uri_escape($override->{'ID'});
+
+ my $friendlyNameEncoded = prettyUndef(encode_entities($override->{'FriendlyName'}));
+ my $usernameEncoded = prettyUndef(encode_entities($override->{'Username'}));
+ my $poolIdentifierEncoded = prettyUndef(encode_entities($override->{'PoolIdentifier'}));
+ my $ipAddress = prettyUndef($override->{'IPAddress'});
+ my $expiresStr = ($override->{'Expires'} > 0) ?
+ DateTime->from_epoch( epoch => $override->{'Expires'} )->iso8601() : '-never-';
+
+ my $classStr = prettyUndef(getTrafficClassName($override->{'ClassID'}));
+ my $cirStr = sprintf('%s/%s',prettyUndef($override->{'TrafficLimitTx'}),prettyUndef($override->{'TrafficLimitRx'}));
+ my $limitStr = sprintf('%s/%s',prettyUndef($override->{'TrafficLimitTxBurst'}),
+ prettyUndef($override->{'TrafficLimitRxBurst'}));
+
+
+ $content .= <<EOF;
+ <tr>
+ <td></td>
+ <td>$friendlyNameEncoded</td>
+ <td>$poolIdentifierEncoded</td>
+ <td>$usernameEncoded</td>
+ <td>$ipAddress</td>
+ <td>$expiresStr</td>
+ <td><span class="glyphicon glyphicon-arrow-right" /></td>
+ <td>$classStr</td>
+ <td>$cirStr</td>
+ <td>$limitStr</td>
+ <td>
+ <a href="/limits/override-edit?oid=$oidEscaped"><span class="glyphicon glyphicon-wrench" /></a>
+ <a href="/limits/override-remove?oid=$oidEscaped"><span class="glyphicon glyphicon-remove" /></a>
+ </td>
+ </tr>
+EOF
+ }
+
+ # No results
+ if (!@overrides) {
+ $content .=<<EOF;
+ <tr class="info">
+ <td colspan="11"><p class="text-center">No Results</p></td>
+ </tr>
+EOF
+ }
+
+ # Footer
+ $content .=<<EOF;
+ </tbody>
+ </table>
+EOF
+
+
+ return (HTTP_OK,$content,{ 'menu' => $menu });
+}
+
+
+# Add/edit action
+sub override_addedit
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ # Setup our environment
+ my $logger = $globals->{'logger'};
+
+ # Errors to display above the form
+ my @errors;
+
+ # Items for our form...
+ my @formElements = qw(
+ FriendlyName
+ PoolIdentifier Username IPAddress
+ ClassID
+ TrafficLimitTx TrafficLimitTxBurst
+ TrafficLimitRx TrafficLimitRxBurst
+ Expires inputExpires.modifier
+ Notes
+ );
+ my @formElementCheckboxes = qw(
+ ClassID
+ TrafficLimitTx TrafficLimitTxBurst
+ TrafficLimitRx TrafficLimitRxBurst
+ );
+
+ # Expires modifier options
+ my $expiresModifiers = {
+ 'm' => "Minutes",
+ 'h' => "Hours",
+ 'd' => "Days",
+ 'n' => "Never",
+ };
+
+ # Title of the form, by default its an add form
+ my $formType = "Add";
+ my $formNoEdit = "";
+ # Form data
+ my $formData;
+ # If we have a override, this is where its kept
+ my $override;
+
+ # Grab query params
+ my $queryParams = parseURIQuery($request);
+
+ # If we have a override ID, pull in the override
+ if (defined($queryParams->{'oid'})) {
+ # Check if we can grab the override
+ if (!defined($override = getOverride($queryParams->{'oid'}->{'value'}))) {
+ return (HTTP_TEMPORARY_REDIRECT,"limits/override-list");
+ }
+ }
+
+ # If this is a form try parse it
+ if ($request->method eq "POST") {
+ # Parse form data
+ my $form = parseFormContent($request->content);
+
+ # If user pressed cancel, redirect
+ if (defined($form->{'cancel'})) {
+ # Redirects to default page
+ return (HTTP_TEMPORARY_REDIRECT,'limits/override-list');
+ }
+
+ # Transform form into form data
+ foreach my $key (keys %{$form}) {
+ $formData->{$key} = $form->{$key}->{'value'};
+ }
+
+ # Set form type if its edit
+ if (defined($form->{'submit'}) && $form->{'submit'}->{'value'} eq "Edit") {
+ # Check override exists
+ if (!defined($override)) {
+ return (HTTP_TEMPORARY_REDIRECT,'limits/override-list');
+ }
+
+ $formData->{'ID'} = $override->{'ID'};
+
+ $formType = "Edit";
+ $formNoEdit = "readonly";
+ }
+
+ # A GET would indicate that a override ID was passed normally
+ } elsif ($request->method eq "GET") {
+ # We need a override
+ if (defined($override)) {
+ # Setup form data from override
+ foreach my $key (@formElements) {
+ $formData->{$key} = $override->{$key};
+ }
+ # Setup our checkboxes
+ foreach my $checkbox (@formElementCheckboxes) {
+ if (defined($formData->{$checkbox})) {
+ $formData->{"input$checkbox.enabled"} = "on";
+ }
+ }
+
+ $formType = "Edit";
+ $formNoEdit = "readonly";
+
+ # Woops ... no query string?
+ } elsif (keys %{$queryParams} > 0) {
+ return (HTTP_TEMPORARY_REDIRECT,'limits/override-list');
+ }
+ }
+
+
+ # We only do this if we have hash elements
+ if (ref($formData) eq "HASH") {
+ my $friendlyName = $formData->{'FriendlyName'};
+ if (!defined($friendlyName)) {
+ push(@errors,"Friendly name must be specified");
+ }
+
+ # Make sure we have at least a pool identifier, username or IP address
+ my $poolIdentifier = isUsername($formData->{'PoolIdentifier'});
+ my $username = isUsername($formData->{'Username'});
+ my $ipAddress = isIP($formData->{'IPAddress'});
+ if (!defined($poolIdentifier) && !defined($username) && !defined($ipAddress)) {
+ push(@errors,"A pool identifier and/or IP address and/or Username must be specified");
+ }
+
+ # If the traffic class is ticked, process it
+ my $classID;
+ if (defined($formData->{'inputClassID.enabled'})) {
+ if (!defined($classID = isTrafficClassIDValid($formData->{'ClassID'}))) {
+ push(@errors,"Traffic class is not valid");
+ }
+ }
+ # Check traffic limits
+ my $trafficLimitTx;
+ if (defined($formData->{'inputTrafficLimitTx.enabled'})) {
+ if (!defined($trafficLimitTx = isNumber($formData->{'TrafficLimitTx'}))) {
+ push(@errors,"Download CIR is not valid");
+ }
+ }
+ my $trafficLimitTxBurst;
+ if (defined($formData->{'inputTrafficLimitTxBurst.enabled'})) {
+ if (!defined($trafficLimitTxBurst = isNumber($formData->{'TrafficLimitTxBurst'}))) {
+ push(@errors,"Download limit is not valid");
+ }
+ }
+ # Check TrafficLimitRx
+ my $trafficLimitRx;
+ if (defined($formData->{'inputTrafficLimitRx.enabled'})) {
+ if (!defined($trafficLimitRx = isNumber($formData->{'TrafficLimitRx'}))) {
+ push(@errors,"Upload CIR is not valid");
+ }
+ }
+ my $trafficLimitRxBurst;
+ if (defined($formData->{'inputTrafficLimitRxBurst.enabled'})) {
+ if (!defined($trafficLimitRxBurst = isNumber($formData->{'TrafficLimitRxBurst'}))) {
+ push(@errors,"Upload limit is not valid");
+ }
+ }
+ # Check that we actually have something to override
+ if (
+ !defined($classID) &&
+ !defined($trafficLimitTx) && !defined($trafficLimitTxBurst) &&
+ !defined($trafficLimitRx) && !defined($trafficLimitRxBurst)
+ ) {
+ push(@errors,"Something must be specified to override");
+ }
+
+ my $expires = 0;
+ if (defined($formData->{'Expires'}) && $formData->{'Expires'} ne "") {
+ if (!defined($expires = isNumber($formData->{'Expires'}))) {
+ push(@errors,"Expires value is not valid");
+ # Check the modifier
+ } else {
+ # Check if its defined
+ if (defined($formData->{'inputExpires.modifier'}) && $formData->{'inputExpires.modifier'} ne "") {
+ # Never
+ if ($formData->{'inputExpires.modifier'} eq "n") {
+ $expires = 0;
+ # Minutes
+ } elsif ($formData->{'inputExpires.modifier'} eq "m") {
+ $expires *= 60;
+ # Hours
+ } elsif ($formData->{'inputExpires.modifier'} eq "h") {
+ $expires *= 3600;
+ # Days
+ } elsif ($formData->{'inputExpires.modifier'} eq "d") {
+ $expires *= 86400;
+ } else {
+ push(@errors,"Expires modifier is not valid");
+ }
+ }
+ # Base the expiry off now, plus the expiry time
+ if ($expires > 0) {
+ $expires += time();
+ }
+ }
+ }
+ # Grab notes
+ my $notes = $formData->{'Notes'};
+
+ # If there are no errors we need to push this override
+ if (!@errors && $request->method eq "POST") {
+ # Build override
+ my $overrideData = {
+ 'FriendlyName' => $friendlyName,
+ 'PoolIdentifier' => $poolIdentifier,
+ 'Username' => $username,
+ 'IPAddress' => $ipAddress,
+# 'GroupID' => 1,
+ 'ClassID' => $classID,
+ 'TrafficLimitTx' => $trafficLimitTx,
+ 'TrafficLimitTxBurst' => $trafficLimitTxBurst,
+ 'TrafficLimitRx' => $trafficLimitRx,
+ 'TrafficLimitRxBurst' => $trafficLimitRxBurst,
+ 'Expires' => $expires,
+ 'Notes' => $notes,
+ };
+
+ # Check if this is an add or edit
+ my $cEvent;
+ if ($formType eq "Add") {
+ $cEvent = "override_add";
+ } else {
+ $overrideData->{'ID'} = $formData->{'ID'};
+ $cEvent = "override_change";
+ }
+
+ $kernel->post("configmanager" => $cEvent => $overrideData);
+
+ $logger->log(LOG_INFO,"[WEBSERVER/OVERRIDE/ADD] Pool: %s, User: %s, IP: %s, Group: %s, Class: %s, Limits: %s/%s, ".
+ "Burst: %s/%s",
+ prettyUndef($poolIdentifier),
+ prettyUndef($username),
+ prettyUndef($ipAddress),
+ "",
+ prettyUndef($classID),
+ prettyUndef($trafficLimitTx),
+ prettyUndef($trafficLimitRx),
+ prettyUndef($trafficLimitTxBurst),
+ prettyUndef($trafficLimitRxBurst)
+ );
+
+ return (HTTP_TEMPORARY_REDIRECT,'limits/override-list');
+ }
+ }
+
+ # Handle checkboxes first and a little differently
+ foreach my $item (@formElementCheckboxes) {
+ $formData->{"input$item.enabled"} = defined($formData->{"input$item.enabled"}) ? "checked" : "";
+ }
+ # Sanitize params if we need to
+ foreach my $item (@formElements) {
+ $formData->{$item} = defined($formData->{$item}) ? encode_entities($formData->{$item}) : "";
+ }
+
+ # Build content
+ my $content = "";
+
+ # Form header
+ $content .=<<EOF;
+ <legend>$formType Override</legend>
+ <form role="form" method="post">
+EOF
+
+ # Spit out errors if we have any
+ if (@errors > 0) {
+ foreach my $error (@errors) {
+ $content .= '<div class="alert alert-danger">'.$error.'</div>';
+ }
+ }
+
+ # Generate traffic class list
+ my $trafficClasses = getTrafficClasses();
+ my $trafficClassStr = "";
+ foreach my $classID (sort keys %{$trafficClasses}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'ClassID'} ne "" && $formData->{'ClassID'} eq $classID) {
+ $selected = "selected";
+ }
+ # And build the options
+ $trafficClassStr .= '<option value="'.$classID.'" '.$selected.'>'.$trafficClasses->{$classID}.'</option>';
+ }
+
+ # Generate expires modifiers list
+ my $expiresModifierStr = "";
+ foreach my $expireModifier (sort keys %{$expiresModifiers}) {
+ # Process selections nicely
+ my $selected = "";
+ if ($formData->{'inputExpires.modifier'} ne "" && $formData->{'inputExpires.modifier'} eq $expireModifier) {
+ $selected = "selected";
+ }
+ # Default to n if nothing is specified
+ if ($formData->{'inputExpires.modifier'} eq "" && $expireModifier eq "n") {
+ $selected = "selected";
+ }
+ # And build the options
+ $expiresModifierStr .= '<option value="'.$expireModifier.'" '.$selected.'>'.$expiresModifiers->{$expireModifier}.
+ '</option>';
+ }
+
+ # Blank expires if its 0
+ if (defined($formData->{'Expires'}) && $formData->{'Expires'} eq "0") {
+ $formData->{'Expires'} = "";
+ }
+
+ #
+ # Page content
+ #
+ $content .=<<EOF;
+ <div class="form-group">
+ <label for="FriendlyName" class="col-md-2 control-label">FriendlyName</label>
+ <div class="row">
+ <div class="col-md-4">
+ <div class="input-group">
+ <input name="FriendlyName" type="text" placeholder="Friendly Name" class="form-control"
+ value="$formData->{'FriendlyName'}" />
+ <span class="input-group-addon">*</span>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="PoolIdentifier" class="col-md-2 control-label">Pool Identifier</label>
+ <div class="row">
+ <div class="col-md-4">
+ <input name="PoolIdentifier" type="text" placeholder="Pool Identifier To Override" class="form-control"
+ value="$formData->{'PoolIdentifier'}" $formNoEdit/>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="Username" class="col-md-2 control-label">Username</label>
+ <div class="row">
+ <div class="col-md-4">
+ <input name="Username" type="text" placeholder="Username To Override" class="form-control"
+ value="$formData->{'Username'}" $formNoEdit/>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="IPAddress" class="col-md-2 control-label">IP Address</label>
+ <div class="row">
+ <div class="col-md-4">
+ <input name="IPAddress" type="text" placeholder="And/Or IP Address To Override" class="form-control"
+ value="$formData->{'IPAddress'}" $formNoEdit/>
+ </div>
+ </div>
+ </div>
+
+ <div class="form-group">
+ <label for="ClassID" class="col-md-2 control-label">Traffic Class</label>
+ <div class="row">
+ <div class="col-md-3">
+ <input name="inputClassID.enabled" type="checkbox" $formData->{'inputClassID.enabled'}/> Override
+ <select name="ClassID" class="form-control">
+ $trafficClassStr
+ </select>
+ </div>
+ </div>
+ </div>
+
+ <div class="form-group">
+ <label for="TrafficLimitTx" class="col-md-2 control-label">Download CIR</label>
+ <div class="row">
+ <div class="col-md-3">
+ <input name="inputTrafficLimitTx.enabled" type="checkbox" $formData->{'inputTrafficLimitTx.enabled'} />
+ Override
+ <div class="input-group">
+ <input name="TrafficLimitTx" type="text" placeholder="Download CIR" class="form-control"
+ value="$formData->{'TrafficLimitTx'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div class="form-group">
+ <label for="TrafficLimitTxBurst" class="col-md-2 control-label">Download Limit</label>
+ <div class="row">
+ <div class="col-md-3">
+ <input name="inputTrafficLimitTxBurst.enabled" type="checkbox"
+ $formData->{'inputTrafficLimitTxBurst.enabled'}/> Override
+ <div class="input-group">
+ <input name="TrafficLimitTxBurst" type="text" placeholder="Download Limit" class="form-control"
+ value="$formData->{'TrafficLimitTxBurst'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div class="form-group">
+ <label for="inputTrafficLimitRx" class="col-md-2 control-label">Upload CIR</label>
+ <div class="row">
+ <div class="col-md-3">
+ <input name="inputTrafficLimitRx.enabled" type="checkbox"
+ $formData->{'inputTrafficLimitRx.enabled'}/> Override
+ <div class="input-group">
+ <input name="TrafficLimitRx" type="text" placeholder="Upload CIR" class="form-control"
+ value="$formData->{'TrafficLimitRx'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <label for="TrafficLimitRxBurst" class="col-md-2 control-label">Upload Limit</label>
+ <div class="row">
+ <div class="col-md-3">
+ <input name="inputTrafficLimitRxBurst.enabled" type="checkbox"
+ $formData->{'inputTrafficLimitRxBurst.enabled'}/> Override
+ <div class="input-group">
+ <input name="TrafficLimitRxBurst" type="text" placeholder="Upload Limit" class="form-control"
+ value="$formData->{'TrafficLimitRxBurst'}" />
+ <span class="input-group-addon">Kbps<span>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div class="form-group">
+ <label for="Expires" class="col-md-2 control-label">Expires</label>
+ <div class="row">
+ <div class="col-md-2">
+ <input name="Expires" type="text" placeholder="Expires" class="form-control"
+ value="$formData->{'Expires'}" />
+ </div>
+ <div class="col-md-2">
+ <select name="inputExpires.modifier" class="form-control" value="$formData->{'inputExpires.modifier'}">
+ $expiresModifierStr
+ </select>
+ </div>
+ </div>
+ </div>
+
+ <div class="form-group">
+ <label for="Notes" class="col-md-2 control-label">Notes</label>
+ <div class="row">
+ <div class="col-md-4">
+ <textarea name="Notes" placeholder="Notes" rows="3" class="form-control">$formData->{'Notes'}</textarea>
+ </div>
+ </div>
+ </div>
+ <div class="form-group">
+ <button name="submit" type="submit" value="$formType" class="btn btn-primary">$formType</button>
+ <button name="cancel" type="submit" class="btn">Cancel</button>
+ </div>
+ </form>
+EOF
+
+ return (HTTP_OK,$content,{ 'menu' => $menu });
+}
+
+
+# Remove action
+sub override_remove
+{
+ my ($kernel,$globals,$client_session_id,$request) = @_;
+
+
+ # Content to return
+ my $content = "";
+
+ # Pull in GET
+ my $queryParams = parseURIQuery($request);
+ # We need a key first of all...
+ if (!defined($queryParams->{'oid'})) {
+ $content = <<EOF;
+ <div class="alert alert-danger text-center">
+ No override oid in query string!
+ </div>
+EOF
+ goto END;
+ }
+
+ # Grab the override
+ my $override = getOverride($queryParams->{'oid'}->{'value'});
+
+ # Make the oid safe for HTML
+ my $encodedID = encode_entities($queryParams->{'oid'}->{'value'});
+
+ # Make sure the oid was valid... we would have an override now if it was
+ if (!defined($override)) {
+ $content = <<EOF;
+ <div class="alert alert-danger text-center">
+ Invalid override oid "$encodedID"!
+ </div>
+EOF
+ goto END;
+ }
+
+ # Pull in POST
+ my $form = parseFormContent($request->content);
+ # If this is a post, then its probably a confirmation
+ if (defined($form->{'confirm'})) {
+ # Check if its a success
+ if ($form->{'confirm'}->{'value'} eq "Yes") {
+ # Post the removal
+ $kernel->post("configmanager" => "override_remove" => $override->{'ID'});
+ }
+ return (HTTP_TEMPORARY_REDIRECT,'limits/override-list');
+ }
+
+
+ # Make the friendly name HTML safe
+ my $encodedFriendlyName = encode_entities($override->{'FriendlyName'});
+
+ # Build our confirmation dialog
+ $content .= <<EOF;
+ <div class="alert alert-danger">
+ Are you very sure you wish to remove override "$encodedFriendlyName"?
+ </div>
+ <form role="form" method="post">
+ <input type="submit" class="btn btn-primary" name="confirm" value="Yes" />
+ <input type="submit" class="btn btn-default" name="confirm" value="No" />
+ </form>
+EOF
+ # And here is where we return
+END:
+ return (HTTP_OK,$content,{ 'menu' => $menu });
+}
+
+
+
1;
# vim: ts=4
--
GitLab