Skip to content

O
OpnSense
Commit 3301e1a2 authored by Ad Schellevis's avatar Ad Schellevis
Browse files
Options

(legacy) refactor system_gateway_groups_edit.php

parent 49dc45d9
Show whitespace changes
Inline Side-by-side
Showing with 221 additions and 293 deletions
src/www/system_gateway_groups_edit.php
View file @ 3301e1a2
...@@ -31,8 +31,6 @@ require_once("guiconfig.inc"); ...@@ -31,8 +31,6 @@ require_once("guiconfig.inc");
require_once("vpn.inc"); require_once("vpn.inc");
require_once("interfaces.inc"); require_once("interfaces.inc");
$referer = (isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '/system_gateway_groups.php');
if (!is_array($config['gateways'])) { if (!is_array($config['gateways'])) {
$config['gateways'] = array(); $config['gateways'] = array();
} }
...@@ -40,68 +38,61 @@ if (!is_array($config['gateways'])) { ...@@ -40,68 +38,61 @@ if (!is_array($config['gateways'])) {
if (!is_array($config['gateways']['gateway_group'])) { if (!is_array($config['gateways']['gateway_group'])) {
$config['gateways']['gateway_group'] = array(); $config['gateways']['gateway_group'] = array();
} }
$a_gateway_groups = &$config['gateways']['gateway_group']; $a_gateway_groups = &$config['gateways']['gateway_group'];
$a_gateways = return_gateways_array(); $a_gateways = return_gateways_array();
$carplist = get_configured_carp_interface_list();
$categories = array('down' => gettext("Member Down"),
'downloss' => gettext("Packet Loss"),
'downlatency' => gettext("High Latency"),
'downlosslatency' => gettext("Packet Loss or High Latency"));
if (is_numericint($_GET['id'])) { if ($_SERVER['REQUEST_METHOD'] === 'GET') {
if (isset($_GET['id']) && isset($a_gateway_groups[$_GET['id']])) {
$id = $_GET['id']; $id = $_GET['id'];
} $configId = $id;
if (isset($_POST['id']) && is_numericint($_POST['id'])) { } elseif (isset($_GET['dup']) && isset($a_gateway_groups[$_GET['dup']])) {
$id = $_POST['id']; $configId = $_GET['dup'];
} }
$pconfig=array();
if (isset($_GET['dup']) && is_numericint($_GET['dup'])) { if (isset($configId)) {
$id = $_GET['dup']; $pconfig['name'] = $a_gateway_groups[$configId]['name'];
} $pconfig['item'] = &$a_gateway_groups[$configId]['item'];
$pconfig['descr'] = $a_gateway_groups[$configId]['descr'];
if (isset($id) && $a_gateway_groups[$id]) { $pconfig['trigger'] = $a_gateway_groups[$configId]['trigger'];
$pconfig['name'] = $a_gateway_groups[$id]['name']; } else {
$pconfig['item'] = &$a_gateway_groups[$id]['item']; $pconfig['name'] = null;
$pconfig['descr'] = $a_gateway_groups[$id]['descr']; $pconfig['descr'] = null;
$pconfig['trigger'] = $a_gateway_groups[$id]['trigger']; $pconfig['trigger'] = null;
} $pconfig['item'] = array();
}
if (isset($_GET['dup']) && is_numericint($_GET['dup'])) { } elseif ($_SERVER['REQUEST_METHOD'] === 'POST') {
unset($id);
}
if ($_POST) {
unset($input_errors);
$pconfig = $_POST; $pconfig = $_POST;
if (isset($_POST['id']) && isset($a_gateway_groups[$_POST['id']])) {
$id = $_POST['id'];
}
$input_errors = array();
/* input validation */ /* input validation */
$reqdfields = explode(" ", "name"); $reqdfields = explode(" ", "name");
$reqdfieldsn = explode(",", "Name"); $reqdfieldsn = explode(",", "Name");
do_input_validation($_POST, $reqdfields, $reqdfieldsn, $input_errors); do_input_validation($_POST, $reqdfields, $reqdfieldsn, $input_errors);
if (! isset($_POST['name'])) { if (empty($pconfig['name'])) {
$input_errors[] = gettext("A valid gateway group name must be specified."); $input_errors[] = gettext("A valid gateway group name must be specified.");
} }
if (! is_validaliasname($_POST['name'])) { if (!is_validaliasname($pconfig['name'])) {
$input_errors[] = gettext("The gateway name must not contain invalid characters."); $input_errors[] = gettext("The gateway name must not contain invalid characters.");
} }
if (isset($_POST['name'])) { if (!empty($pconfig['name'])) {
/* check for overlaps */ /* check for overlaps */
if (is_array($a_gateway_groups)) { if (is_array($a_gateway_groups)) {
foreach ($a_gateway_groups as $gateway_group) { foreach ($a_gateway_groups as $gateway_group) {
if (isset($id) && ($a_gateway_groups[$id]) && ($a_gateway_groups[$id] === $gateway_group)) { if (isset($id) && ($a_gateway_groups[$id]) && ($a_gateway_groups[$id] === $gateway_group)) {
if ($gateway_group['name'] != $_POST['name']) { if ($gateway_group['name'] != $pconfig['name']) {
$input_errors[] = gettext("Changing name on a gateway group is not allowed."); $input_errors[] = gettext("Changing name on a gateway group is not allowed.");
} }
continue; continue;
} }
if ($gateway_group['name'] == $_POST['name']) { if ($gateway_group['name'] == $pconfig['name']) {
$input_errors[] = sprintf(gettext('A gateway group with this name "%s" already exists.'), $_POST['name']); $input_errors[] = sprintf(gettext('A gateway group with this name "%s" already exists.'), $pconfig['name']);
break; break;
} }
} }
...@@ -111,14 +102,14 @@ if ($_POST) { ...@@ -111,14 +102,14 @@ if ($_POST) {
/* Build list of items in group with priority */ /* Build list of items in group with priority */
$pconfig['item'] = array(); $pconfig['item'] = array();
foreach ($a_gateways as $gwname => $gateway) { foreach ($a_gateways as $gwname => $gateway) {
if ($_POST[$gwname] > 0) { if (isset($pconfig[$gwname]) && $pconfig[$gwname] > 0) {
$vipname = "{$gwname}_vip"; $vipname = "{$gwname}_vip";
/* we have a priority above 0 (disabled), add item to list */ /* we have a priority above 0 (disabled), add item to list */
$pconfig['item'][] = "{$gwname}|{$_POST[$gwname]}|{$_POST[$vipname]}"; $pconfig['item'][] = "{$gwname}|{$pconfig[$gwname]}|{$pconfig[$vipname]}";
} }
/* check for overlaps */ /* check for overlaps */
if ($_POST['name'] == $gwname) { if ($pconfig['name'] == $gwname) {
$input_errors[] = sprintf(gettext('A gateway group cannot have the same name with a gateway "%s" please choose another name.'), $_POST['name']); $input_errors[] = sprintf(gettext('A gateway group cannot have the same name with a gateway "%s" please choose another name.'), $pconfig['name']);
} }
} }
...@@ -126,14 +117,14 @@ if ($_POST) { ...@@ -126,14 +117,14 @@ if ($_POST) {
$input_errors[] = gettext("No gateway(s) have been selected to be used in this group"); $input_errors[] = gettext("No gateway(s) have been selected to be used in this group");
} }
if (!$input_errors) { if (count($input_errors) == 0) {
$gateway_group = array(); $gateway_group = array();
$gateway_group['name'] = $_POST['name']; $gateway_group['name'] = $pconfig['name'];
$gateway_group['item'] = $pconfig['item']; $gateway_group['item'] = $pconfig['item'];
$gateway_group['trigger'] = $_POST['trigger']; $gateway_group['trigger'] = $pconfig['trigger'];
$gateway_group['descr'] = $_POST['descr']; $gateway_group['descr'] = $pconfig['descr'];
if (isset($id) && $a_gateway_groups[$id]) { if (isset($id)) {
$a_gateway_groups[$id] = $gateway_group; $a_gateway_groups[$id] = $gateway_group;
} else { } else {
$a_gateway_groups[] = $gateway_group; $a_gateway_groups[] = $gateway_group;
...@@ -152,112 +143,49 @@ if ($_POST) { ...@@ -152,112 +143,49 @@ if ($_POST) {
$pgtitle = array(gettext('System'),gettext('Gateways'), gettext('Edit Group')); $pgtitle = array(gettext('System'),gettext('Gateways'), gettext('Edit Group'));
$shortcut_section = "gateway-groups"; $shortcut_section = "gateway-groups";
function build_gateway_protocol_map (&$a_gateways) legacy_html_escape_form_data($a_gateways);
{ legacy_html_escape_form_data($pconfig);
$result = array();
foreach ($a_gateways as $gwname => $gateway) {
$result[$gwname] = $gateway['ipprotocol'];
}
return $result;
}
include("head.inc"); include("head.inc");
?> ?>
<body> <body>
<?php include("fbegin.inc"); ?> <?php include("fbegin.inc"); ?>
<?php
$gateway_protocol = build_gateway_protocol_map($a_gateways);
$gateway_array = array_keys($a_gateways);
$protocol_array = array_values($gateway_protocol);
$protocol_array = array_values(array_unique($gateway_protocol));
?>
<script type="text/javascript">
//<![CDATA[
jQuery(function ($) {
var gateway_protocol = <?= json_encode($gateway_protocol) ?>;
var gateways = <?= json_encode($gateway_array) ?>;
var protocols = <?= json_encode($protocol_array) ?>;
if (protocols.length <= 1) { return; }
var update_gateway_visibilities = function () {
var which_protocol_to_show = undefined;
$.each(gateways, function (i, gateway) {
var $select = $("#" + gateway);
var value = $select.val();
var protocol = gateway_protocol[gateway];
if (value !== '0' /* i.e., an option is selected */) {
if (which_protocol_to_show === undefined) {
which_protocol_to_show = protocol;
}
else if (which_protocol_to_show !== protocol) {
which_protocol_to_show = 'ALL OF THEM'; // this shouldn't happen
}
}
});
if (which_protocol_to_show !== undefined && which_protocol_to_show !== 'ALL OF THEM') {
$.each(gateways, function (i, gateway) {
var protocol = gateway_protocol[gateway];
var $row = $("tr.gateway_row#" + gateway + "_row");
if (protocol === which_protocol_to_show) {
if ($row.is(":hidden")) {
$row.fadeIn('slow');
}
} else {
if (!$row.is(":hidden")) {
$row.fadeOut('slow');
}
}
});
} else {
$("tr.gateway_row").each(function () {
if ($(this).is(":hidden")) {
$(this).fadeIn('slow');
}
});
}
};
$("select.gateway_tier_selector").change(update_gateway_visibilities);
update_gateway_visibilities();
});
//]]>
</script>
<section class="page-content-main"> <section class="page-content-main">
<div class="container-fluid"> <div class="container-fluid">
<div class="row"> <div class="row">
<?php if (isset($input_errors) && count($input_errors) > 0) { <?php if (isset($input_errors) && count($input_errors) > 0) {
print_input_errors($input_errors); print_input_errors($input_errors);
} ?> } ?>
<div id="inputerrors"></div>
<section class="col-xs-12"> <section class="col-xs-12">
<div class="tab-content content-box col-xs-12">
<div class="content-box"> <div class="table-responsive">
<header class="content-box-head container-fluid">
<h3><?=gettext("Edit gateway group entry");?></h3>
</header>
<div class="content-box-main col-xs-12">
<form action="system_gateway_groups_edit.php" method="post" name="iform" id="iform"> <form action="system_gateway_groups_edit.php" method="post" name="iform" id="iform">
<table class="table table-striped" summary="system groups edit"> <table class="table table-striped" summary="system groups edit">
<tr> <tr>
<td width="22%" valign="top" class="vncellreq"><?=gettext("Group Name"); ?></td> <td width="22%"></td>
<td width="78%" class="vtable"> <td width="78%" align="right">
<input name="name" type="text" class="formfld unknown" id="name" size="20" value="<?=htmlspecialchars($pconfig['name']);?>" /> <small><?=gettext("full help"); ?> </small>
<br /> <span class="vexpl"><?=gettext("Group Name"); ?></span></td> <i class="fa fa-toggle-off text-danger" style="cursor: pointer;" id="show_all_help_page" type="button"></i></a>
</td>
</tr> </tr>
<tr> <tr>
<td width="22%" valign="top" class="vncellreq"><?=gettext("Gateway Priority"); ?></td> <td><i class="fa fa-info-circle text-muted"></i> <?=gettext("Group Name"); ?></td>
<td width="78%" class="vtable"> <td>
<table border="0" cellpadding="6" cellspacing="0" summary="gateway priority"> <input name="name" type="text" size="20" value="<?=$pconfig['name'];?>" />
</td>
</tr>
<tr>
<td><a id="help_for_gatewayprio" href="#" class="showhelp"><i class="fa fa-info-circle"></i></a> <?=gettext("Gateway Priority"); ?></td>
<td>
<table class="table table-condensed">
<tr> <tr>
<td class="listhdrr"><?= gettext('Gateway') ?></td> <td><?= gettext('Gateway') ?></td>
<td class="listhdrr"><?= gettext('Tier') ?></td> <td><?= gettext('Tier') ?></td>
<td class="listhdrr"><?= gettext('Virtual IP') ?></td> <td><?= gettext('Virtual IP') ?></td>
<td class="listhdrr"><?= gettext('Description') ?></td> <td><?= gettext('Description') ?></td>
</tr> </tr>
<?php <?php
foreach ($a_gateways as $gwname => $gateway) { foreach ($a_gateways as $gwname => $gateway):
if (!empty($pconfig['item'])) { if (!empty($pconfig['item'])) {
$af = explode("|", $pconfig['item'][0]); $af = explode("|", $pconfig['item'][0]);
$family = $a_gateways[$af[0]]['ipprotocol']; $family = $a_gateways[$af[0]]['ipprotocol'];
...@@ -265,48 +193,45 @@ jQuery(function ($) { ...@@ -265,48 +193,45 @@ jQuery(function ($) {
continue; continue;
} }
} }
$interface = $gateway['friendlyiface']; ?>
$selected = array(); <tr>
<td><strong><?=$gateway['name'];?></strong></td>
<td>
<select name="<?=$gwname;?>" class="selectpicker" data-width='auto'>
<?php
for ($tierId = 0 ; $tierId < 6 ; ++$tierId):
$is_selected = false;
foreach ((array)$pconfig['item'] as $item) { foreach ((array)$pconfig['item'] as $item) {
$itemsplit = explode("|", $item); $itemsplit = explode("|", $item);
if ($itemsplit[0] == $gwname) { if ($itemsplit[0] == $gwname && $itemsplit[1] == $tierId) {
$selected[$itemsplit[1]] = "selected=\"selected\""; $is_selected = true;
break;
} else {
$selected[0] = "selected=\"selected\"";
} }
} }
$tr_id = $gwname . "_row"; ?>
echo "<tr class='gateway_row' id='{$tr_id}'>\n"; <option value="<?=$tierId;?>" <?=$is_selected ? "selected=\"selected\"" : "";?>>
echo "<td class='listlr'>"; <?=$tierId == 0 ? gettext("Never") : sprintf(gettext("Tier %d"), $tierId) ;?>
echo "<strong>{$gateway['name']} </strong>"; </option>
echo "</td><td class='listr'>"; <?php
echo "<select name='{$gwname}' class='gateway_tier_selector formfldselect selectpicker' data-style='btn-default' data-width='auto' id='{$gwname}'>\n"; endfor;?>
echo "<option value='0' $selected[0] >" . gettext("Never") . "</option>\n"; </select>
echo "<option value='1' $selected[1] >" . gettext("Tier 1") . "</option>\n"; </td>
echo "<option value='2' $selected[2] >" . gettext("Tier 2") . "</option>\n"; <td>
echo "<option value='3' $selected[3] >" . gettext("Tier 3") . "</option>\n"; <select name="<?=$gwname;?>_vip" class="selectpicker" data-width="auto">
echo "<option value='4' $selected[4] >" . gettext("Tier 4") . "</option>\n"; <?php
echo "<option value='5' $selected[5] >" . gettext("Tier 5") . "</option>\n"; $selected_key = 'address';
echo "</select>\n";
echo "</td>";
$selected = array();
foreach ((array)$pconfig['item'] as $item) { foreach ((array)$pconfig['item'] as $item) {
$itemsplit = explode("|", $item); $itemsplit = explode("|", $item);
if ($itemsplit[0] == $gwname) { if ($itemsplit[0] == $gwname) {
$selected[$itemsplit[2]] = "selected=\"selected\""; $selected_key = $itemsplit[2];
break; break;
} else {
$selected['address'] = "selected=\"selected\"";
}
} }
echo "<td class='listr'>"; }?>
echo "<select name='{$gwname}_vip' class='gateway_vip_selector formfldselect selectpicker' data-style='btn-default' data-width='auto' id='{$gwname}_vip'>\n"; <option value="address" <?=$selected_key == "address" ? "selected=\"selected\"" :"";?> >
echo "<option value='address' {$selected['address']} >" . gettext("Interface Address") . "</option>\n"; <?=gettext("Interface Address");?>
foreach ($carplist as $vip => $address) { </option>
echo "<!-- $vip - $address - $interface -->\n"; <?php
if (!preg_match("/^{$interface}_/i", $vip)) { foreach (get_configured_carp_interface_list() as $vip => $address):
if (!preg_match("/^{$gateway['friendlyiface']}_/i", $vip)) {
continue; continue;
} }
if (($gateway['ipprotocol'] == "inet") && (!is_ipaddrv4($address))) { if (($gateway['ipprotocol'] == "inet") && (!is_ipaddrv4($address))) {
...@@ -314,61 +239,66 @@ jQuery(function ($) { ...@@ -314,61 +239,66 @@ jQuery(function ($) {
} }
if (($gateway['ipprotocol'] == "inet6") && (!is_ipaddrv6($address))) { if (($gateway['ipprotocol'] == "inet6") && (!is_ipaddrv6($address))) {
continue; continue;
} }?>
echo "<option value='{$vip}' $selected[$vip] >$vip - $address</option>\n"; <option value="<?=$vip;?>" <?=$selected_key == $vip ? "selected=\"selected\"" :"";?> >
} <?=$vip;?> - <?=$address;?>
echo "</select></td>"; </option>
echo "<td class='listr'><strong>{$gateway['descr']}&nbsp;</strong>"; <?php
echo "</td></tr>"; endforeach;?>
}
?> </select>
</td>
<td><strong><?=$gateway['descr'];?></strong></td>
</tr>
<?php
endforeach;?>
</table> </table>
<br /><span class="vexpl"> <div for="help_for_gatewayprio" class="hidden">
<br>
<strong><?=gettext("Link Priority"); ?></strong> <br /> <strong><?=gettext("Link Priority"); ?></strong> <br />
<?=gettext("The priority selected here defines in what order failover and balancing of links will be done. " . <?=gettext("The priority selected here defines in what order failover and balancing of links will be done. " .
"Multiple links of the same priority will balance connections until all links in the priority will be exhausted. " . "Multiple links of the same priority will balance connections until all links in the priority will be exhausted. " .
"If all links in a priority level are exhausted we will use the next available link(s) in the next priority level.") ?> "If all links in a priority level are exhausted we will use the next available link(s) in the next priority level.") ?>
<br /> <br />
<strong><?=gettext("Virtual IP"); ?></strong> <br /> <strong><?=gettext("Virtual IP"); ?></strong> <br />
<?=gettext("The virtual IP field selects what (virtual) IP should be used when this group applies to a local Dynamic DNS, IPsec or OpenVPN endpoint") ?> <?=gettext("The virtual IP field selects what (virtual) IP should be used when this group applies to a local Dynamic DNS, IPsec or OpenVPN endpoint") ?>
</span><br /> </div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td width="22%" valign="top" class="vncellreq"><?=gettext("Trigger Level"); ?></td> <td><a id="help_for_triggerlvl" href="#" class="showhelp"><i class="fa fa-info-circle"></i></a> <?=gettext("Trigger Level"); ?></td>
<td width="78%" class="vtable"> <td>
<select name='trigger' class='formfldselect trigger_level_selector selectpicker' id='trigger' data-style='btn-default'> <select name='trigger' class='selectpicker'>
<?php <option value="down" <?=$pconfig['trigger'] == "down" ? "selected=\"selected\"" :"";?> ><?=gettext("Member Down");?></option>
foreach ($categories as $category => $categoryd) { <option value="downloss" <?=$pconfig['trigger'] == "downloss" ? "selected=\"selected\"" :"";?> ><?=gettext("Packet Loss");?></option>
echo "<option value=\"$category\""; <option value="downlatency" <?=$pconfig['trigger'] == "downlatency" ? "selected=\"selected\"" :"";?> ><?=gettext("High Latency");?></option>
if ($category == $pconfig['trigger']) { <option value="downlosslatency" <?=$pconfig['trigger'] == "downlosslatency" ? "selected=\"selected\"" :"";?> ><?=gettext("Packet Loss or High Latency");?></option>
echo " selected=\"selected\"";
}
echo ">" . htmlspecialchars($categoryd) . "</option>\n";
}
?>
</select> </select>
<br /> <span class="vexpl"><?=gettext("When to trigger exclusion of a member"); ?></span> <div for="help_for_triggerlvl" class="hidden">
<?=gettext("When to trigger exclusion of a member"); ?>
</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td width="22%" valign="top" class="vncell"><?=gettext("Description"); ?></td> <td><a id="help_for_descr" href="#" class="showhelp"><i class="fa fa-info-circle"></i></a> <?=gettext("Description"); ?></td>
<td width="78%" class="vtable"> <td>
<input name="descr" type="text" class="formfld unknown" id="descr" size="40" value="<?=htmlspecialchars($pconfig['descr']);?>" /> <input name="descr" type="text" value="<?=$pconfig['descr'];?>" />
<br /> <span class="vexpl"><?=gettext("You may enter a description here for your reference (not parsed)."); ?></span> <div for="help_for_descr" class="hidden">
<?=gettext("You may enter a description here for your reference (not parsed)."); ?>
</div>
</td> </td>
</tr> </tr>
<tr> <tr>
<td width="22%" valign="top">&nbsp;</td> <td></td>
<td width="78%"> <td>
<input name="Submit" type="submit" class="btn btn-primary formbtn" value="<?=gettext("Save");?>" /> <input name="Submit" type="submit" class="btn btn-primary" value="<?=gettext("Save");?>" />
<input type="button" class="btn btn-default formbtn" value="<?=gettext("Cancel"); <input type="button" class="btn btn-default" value="<?=gettext("Cancel");?>" onclick="window.location.href='<?=(isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '/system_gateway_groups.php');?>'" />
?>" onclick="window.location.href='<?=$referer;?>'" /> <?php
<?php if (isset($id) && $a_gateway_groups[$id]) : if (isset($id)) :?>
?> <input name="id" type="hidden" value="<?=$id;?>" />
<input name="id" type="hidden" value="<?=htmlspecialchars($id);?>" /> <?php
<?php endif; ?>
endif; ?>
</td> </td>
</tr> </tr>
</table> </table>
...@@ -380,5 +310,3 @@ endif; ?> ...@@ -380,5 +310,3 @@ endif; ?>
</div> </div>
</section> </section>
<?php include("foot.inc"); ?> <?php include("foot.inc"); ?>
</body>
</html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023