(legacy) refactor interfaces_vlan_edit.php

src/www/interfaces_vlan_edit.php

 <?php
 
 /*
-	Copyright (C) 2014-2015 Deciso B.V.
-	Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>.
-	All rights reserved.
-
-	Redistribution and use in source and binary forms, with or without
-	modification, are permitted provided that the following conditions are met:
-
-	1. Redistributions of source code must retain the above copyright notice,
-	   this list of conditions and the following disclaimer.
-
-	2. Redistributions in binary form must reproduce the above copyright
-	   notice, this list of conditions and the following disclaimer in the
-	   documentation and/or other materials provided with the distribution.
-
-	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
-	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-	POSSIBILITY OF SUCH DAMAGE.
+    Copyright (C) 2014-2016 Deciso B.V.
+    Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
 */
 
 require_once("guiconfig.inc");
@@ -35,201 +35,200 @@ require_once("pfsense-utils.inc");
 require_once("unbound.inc");
 require_once("services.inc");
 
-$referer = (isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '/interfaces_vlan.php');
-
-if (!is_array($config['vlans'])) {
-	$config['vlans'] = array();
+if (!isset($config['vlans']) || !is_array($config['vlans'])) {
+    $config['vlans'] = array();
 }
-
-if (!is_array($config['vlans']['vlan'])) {
-	$config['vlans']['vlan'] = array();
+if (!isset($config['vlans']['vlan']) || !is_array($config['vlans']['vlan'])) {
+    $config['vlans']['vlan'] = array();
 }
-
 $a_vlans = &$config['vlans']['vlan'];
 
-$portlist = get_interface_list();
-
-/* add LAGG interfaces */
-if (isset($config['laggs']['lagg'])) {
-        foreach ($config['laggs']['lagg'] as $lagg) {
-                $portlist[$lagg['laggif']] = $lagg;
-	}
-}
-
-if (is_numericint($_GET['id']))
-	$id = $_GET['id'];
-if (isset($_POST['id']) && is_numericint($_POST['id']))
-	$id = $_POST['id'];
-
-if (isset($id) && $a_vlans[$id]) {
-	$pconfig['if'] = $a_vlans[$id]['if'];
-	$pconfig['vlanif'] = $a_vlans[$id]['vlanif'];
-	$pconfig['tag'] = $a_vlans[$id]['tag'];
-	$pconfig['descr'] = $a_vlans[$id]['descr'];
-}
-
-if ($_POST) {
-
-	unset($input_errors);
-	$pconfig = $_POST;
-
-	/* input validation */
-	$reqdfields = explode(" ", "if tag");
-	$reqdfieldsn = array(gettext("Parent interface"),gettext("VLAN tag"));
-
-	do_input_validation($_POST, $reqdfields, $reqdfieldsn, $input_errors);
-
-	if ($_POST['tag'] && (!is_numericint($_POST['tag']) || ($_POST['tag'] < '1') || ($_POST['tag'] > '4094'))) {
-		$input_errors[] = gettext("The VLAN tag must be an integer between 1 and 4094.");
-	}
-
-	if (!does_interface_exist($_POST['if']))
-		$input_errors[] = gettext("Interface supplied as parent is invalid");
-
-	if (isset($id)) {
-		if ($_POST['tag'] && $_POST['tag'] != $a_vlans[$id]['tag']) {
-			if (!empty($a_vlans[$id]['vlanif']) && convert_real_interface_to_friendly_interface_name($a_vlans[$id]['vlanif']) != NULL)
-				$input_errors[] = gettext("Interface is assigned and you cannot change the VLAN tag while assigned.");
-		}
-	}
-	foreach ($a_vlans as $vlan) {
-		if (isset($id) && ($a_vlans[$id]) && ($a_vlans[$id] === $vlan))
-			continue;
-
-		if (($vlan['if'] == $_POST['if']) && ($vlan['tag'] == $_POST['tag'])) {
-			$input_errors[] = sprintf(gettext("A VLAN with the tag %s is already defined on this interface."),$vlan['tag']);
-			break;
-		}
-	}
-	if (isset($config['qinqs']['qinqentry'])) {
-		foreach ($config['qinqs']['qinqentry'] as $qinq) {
-			if ($qinq['tag'] == $_POST['tag'] && $qinq['if'] == $_POST['if']) {
-				$input_errors[] = gettext("A QinQ VLAN exists with this tag please remove it to use this tag with.");
-			}
-		}
-	}
-
-	if (!$input_errors) {
-		if (isset($id) && $a_vlans[$id]) {
-			if (($a_vlans[$id]['if'] != $_POST['if']) || ($a_vlans[$id]['tag'] != $_POST['tag'])) {
-				if (!empty($a_vlans[$id]['vlanif'])) {
-					$confif = convert_real_interface_to_friendly_interface_name($vlan['vlanif']);
-					legacy_interface_destroy($a_vlans[$id]['vlanif']);
-				} else {
-					legacy_interface_destroy("{$a_vlans[$id]['if']}_vlan{$a_vlans[$id]['tag']}");
-					$confif = convert_real_interface_to_friendly_interface_name("{$a_vlans[$id]['if']}_vlan{$a_vlans[$id]['tag']}");
-				}
-				if ($confif <> "")
-					$config['interfaces'][$confif]['if'] = "{$_POST['if']}_vlan{$_POST['tag']}";
-			}
-		}
-		$vlan = array();
-		$vlan['if'] = $_POST['if'];
-		$vlan['tag'] = $_POST['tag'];
-		$vlan['descr'] = $_POST['descr'];
-		$vlan['vlanif'] = "{$_POST['if']}_vlan{$_POST['tag']}";
-
-		$vlan['vlanif'] = interface_vlan_configure($vlan);
-                if ($vlan['vlanif'] == "" || !stristr($vlan['vlanif'], "vlan"))
-                        $input_errors[] = gettext("Error occurred creating interface, please retry.");
-                else {
-                        if (isset($id) && $a_vlans[$id])
-                                $a_vlans[$id] = $vlan;
-                        else
-                                $a_vlans[] = $vlan;
-
-                        write_config();
-
-			if ($confif <> "")
-				interface_configure($confif);
-
-			header("Location: interfaces_vlan.php");
-			exit;
-		}
-	}
+if ($_SERVER['REQUEST_METHOD'] === 'GET') {
+    // read form data
+    if (!empty($a_vlans[$_GET['id']])) {
+        $id = $_GET['id'];
+    }
+    $pconfig['if'] = isset($a_vlans[$id]['if']) ? $a_vlans[$id]['if'] : null;
+    $pconfig['vlanif'] = isset($a_vlans[$id]['vlanif']) ? $a_vlans[$id]['vlanif'] : null;
+    $pconfig['tag'] = isset($a_vlans[$id]['tag']) ? $a_vlans[$id]['tag'] : null;
+    $pconfig['descr'] = isset($a_vlans[$id]['descr']) ? $a_vlans[$id]['descr'] : null;
+} elseif ($_SERVER['REQUEST_METHOD'] === 'POST') {
+    // validate / save form data
+    if (!empty($a_vlans[$_POST['id']])) {
+        $id = $_POST['id'];
+    }
+
+    $input_errors = array();
+    $pconfig = $_POST;
+
+    /* input validation */
+    $reqdfields = explode(" ", "if tag");
+    $reqdfieldsn = array(gettext("Parent interface"),gettext("VLAN tag"));
+
+    do_input_validation($_POST, $reqdfields, $reqdfieldsn, $input_errors);
+
+    if ($pconfig['tag'] && (!is_numericint($pconfig['tag']) || ($pconfig['tag'] < '1') || ($pconfig['tag'] > '4094'))) {
+        $input_errors[] = gettext("The VLAN tag must be an integer between 1 and 4094.");
+    }
+
+    if (!does_interface_exist($pconfig['if'])) {
+        $input_errors[] = gettext("Interface supplied as parent is invalid");
+    }
+
+    if (isset($id) && $pconfig['tag'] && $pconfig['tag'] != $a_vlans[$id]['tag']) {
+        if (!empty($a_vlans[$id]['vlanif']) && convert_real_interface_to_friendly_interface_name($a_vlans[$id]['vlanif']) != NULL) {
+            $input_errors[] = gettext("Interface is assigned and you cannot change the VLAN tag while assigned.");
+        }
+    }
+
+    foreach ($a_vlans as $vlan) {
+        if (isset($id)  && $a_vlans[$id] === $vlan) {
+            continue;
+        }
+        if (($vlan['if'] == $pconfig['if']) && ($vlan['tag'] == $_POST['tag'])) {
+            $input_errors[] = sprintf(gettext("A VLAN with the tag %s is already defined on this interface."), $vlan['tag']);
+            break;
+        }
+    }
+    if (isset($config['qinqs']['qinqentry'])) {
+        foreach ($config['qinqs']['qinqentry'] as $qinq) {
+            if ($qinq['tag'] == $pconfig['tag'] && $qinq['if'] == $pconfig['if']) {
+                $input_errors[] = gettext("A QinQ VLAN exists with this tag please remove it to use this tag with.");
+            }
+        }
+    }
+
+    if (count($input_errors) == 0) {
+        $confif = "";
+        if (isset($id)) {
+            if (($a_vlans[$id]['if'] != $pconfig['if']) || ($a_vlans[$id]['tag'] != $pconfig['tag'])) {
+                if (!empty($a_vlans[$id]['vlanif'])) {
+                    $confif = convert_real_interface_to_friendly_interface_name($a_vlans[$id]['vlanif']);
+                    legacy_interface_destroy($a_vlans[$id]['vlanif']);
+                } else {
+                    legacy_interface_destroy("{$a_vlans[$id]['if']}_vlan{$a_vlans[$id]['tag']}");
+                    $confif = convert_real_interface_to_friendly_interface_name("{$a_vlans[$id]['if']}_vlan{$a_vlans[$id]['tag']}");
+                }
+                if ($confif <> "") {
+                    $config['interfaces'][$confif]['if'] = "{$_POST['if']}_vlan{$_POST['tag']}";
+                }
+            }
+        }
+        $vlan = array();
+        $vlan['if'] = $_POST['if'];
+        $vlan['tag'] = $_POST['tag'];
+        $vlan['descr'] = $_POST['descr'];
+        $vlan['vlanif'] = "{$_POST['if']}_vlan{$_POST['tag']}";
+        $vlan['vlanif'] = interface_vlan_configure($vlan);
+        if ($vlan['vlanif'] == "" || !stristr($vlan['vlanif'], "vlan")) {
+            $input_errors[] = gettext("Error occurred creating interface, please retry.");
+        } else {
+            if (isset($id)) {
+                $a_vlans[$id] = $vlan;
+            } else {
+                $a_vlans[] = $vlan;
+            }
+            write_config();
+
+            if ($confif <> "") {
+                interface_configure($confif);
+            }
+            header("Location: interfaces_vlan.php");
+            exit;
+        }
+    }
 }
 
 include("head.inc");
-
 ?>
 
 <body>
 <?php include("fbegin.inc"); ?>
 
-	<section class="page-content-main">
-		<div class="container-fluid">
-			<div class="row">
-
-				<?php if (isset($input_errors) && count($input_errors) > 0) print_input_errors($input_errors); ?>
-				<div id="inputerrors"></div>
-
-
-			    <section class="col-xs-12">
-
-				<div class="content-box">
-
-					 <header class="content-box-head container-fluid">
-				        <h3><?=gettext("VLAN configuration");?></h3>
-				    </header>
-
-				    <div class="content-box-main">
-
-						<form action="interfaces_vlan_edit.php" method="post" name="iform" id="iform">
-
-		                        <div class="table-responsive">
-			                        <table class="table table-striped table-sort">
-
-										<tr>
-						                  <td width="22%" valign="top" class="vncellreq"><?=gettext("Parent interface");?></td>
-						                  <td width="78%" class="vtable">
-						                    <select name="if" class="selectpicker">
-						                      <?php
-											  foreach ($portlist as $ifn => $ifinfo)
-												if (is_jumbo_capable($ifn)) {
-													echo "<option value=\"{$ifn}\"";
-													if ($ifn == $pconfig['if'])
-														echo " selected=\"selected\"";
-													echo ">";
-												        echo htmlspecialchars($ifn . " (" . $ifinfo['mac'] . ")");
-													echo "</option>";
-												}
-								      ?>
-						                    </select>
-									<br />
-									<span class="vexpl"><?=gettext("Only VLAN capable interfaces will be shown.");?></span></td>
-						                </tr>
-										<tr>
-						                  <td valign="top" class="vncellreq"><?=gettext("VLAN tag ");?></td>
-						                  <td class="vtable">
-						                    <input name="tag" type="text" class="form-control unknown" id="tag" size="6" value="<?=htmlspecialchars($pconfig['tag']);?>" />
-						                    <br />
-						                    <span class="vexpl"><?=gettext("802.1Q VLAN tag (between 1 and 4094) ");?></span></td>
-									    </tr>
-										<tr>
-						                  <td width="22%" valign="top" class="vncell"><?=gettext("Description");?></td>
-						                  <td width="78%" class="vtable">
-						                    <input name="descr" type="text" class="form-control unknown" id="descr" size="40" value="<?=htmlspecialchars($pconfig['descr']);?>" />
-						                    <br /> <span class="vexpl"><?=gettext("You may enter a description here ".
-						                    "for your reference (not parsed).");?></span></td>
-						                </tr>
-						                <tr>
-						                  <td width="22%" valign="top">&nbsp;</td>
-						                  <td width="78%">
-								    <input type="hidden" name="vlanif" value="<?=htmlspecialchars($pconfig['vlanif']); ?>" />
-						                    <input name="Submit" type="submit" class="btn btn-primary" value="<?=gettext("Save");?>" />
-						                    <input type="button" class="btn btn-default" value="<?=gettext("Cancel");?>" onclick="window.location.href='<?=$referer;?>'" />
-						                    <?php if (isset($id) && $a_vlans[$id]): ?>
-						                    <input name="id" type="hidden" value="<?=htmlspecialchars($id);?>" />
-						                    <?php endif; ?>
-						                  </td>
-						                </tr>
-						              </table>
-		                        </div>
-						</form>
-				    </div>
-				</div>
-			    </section>
-			</div>
-		</div>
-	</section>
+<section class="page-content-main">
+  <div class="container-fluid">
+    <div class="row">
+      <?php if (isset($input_errors) && count($input_errors) > 0) print_input_errors($input_errors); ?>
+      <section class="col-xs-12">
+        <div class="content-box">
+          <div class="table-responsive">
+            <form method="post" name="iform" id="iform">
+              <table class="table table-striped">
+                <thead>
+                  <tr>
+                    <td width="22%"><strong><?=gettext("Interface QinQ Edit");?></strong></td>
+                    <td width="78%" align="right">
+                      <small><?=gettext("full help"); ?> </small>
+                      <i class="fa fa-toggle-off text-danger"  style="cursor: pointer;" id="show_all_help_page" type="button"></i></a>
+                      &nbsp;
+                    </td>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td><a id="help_for_if" href="#" class="showhelp"><i class="fa fa-info-circle"></i></a> <?=gettext("Parent interface");?></td>
+                    <td>
+                      <select name="if" class="selectpicker">
+<?php
+                      $portlist = get_interface_list();
+                      /* add LAGG interfaces */
+                      if (isset($config['laggs']['lagg'])) {
+                          foreach ($config['laggs']['lagg'] as $lagg) {
+                              $portlist[$lagg['laggif']] = $lagg;
+                          }
+                      }
+                      foreach ($portlist as $ifn => $ifinfo):
+                        if (!is_jumbo_capable($ifn)) {
+                            continue;
+                        }?>
+                        <option value="<?=$ifn;?>" <?=$ifn == $pconfig['if'] ? " selected=\"selected\"" : "";?>>
+                          <?=htmlspecialchars($ifn);?>  ( <?= !empty($ifinfo['mac']) ? $ifinfo['mac'] :"" ;?> )
+                        </option>
+<?php
+                      endforeach;?>
+
+                      </select>
+                      <div class="hidden" for="help_for_if">
+                        <?=gettext("Only VLAN capable interfaces will be shown.");?>
+                      </div>
+                    </td>
+                  </tr>
+                  <tr>
+                    <td><a id="help_for_tag" href="#" class="showhelp"><i class="fa fa-info-circle"></i></a> <?=gettext("VLAN tag ");?></td>
+                    <td>
+                      <input name="tag" type="text" value="<?=$pconfig['tag'];?>" />
+                      <div class="hidden" for="help_for_tag">
+                        <?=gettext("802.1Q VLAN tag (between 1 and 4094) ");?>
+                      </div>
+                    </td>
+                  </tr>
+                  <tr>
+                    <td><a id="help_for_descr" href="#" class="showhelp"><i class="fa fa-info-circle"></i></a> <?=gettext("Description"); ?></td>
+                    <td>
+                      <input name="descr" type="text" value="<?=$pconfig['descr'];?>" />
+                      <div class="hidden" for="help_for_descr">
+                        <?=gettext("You may enter a description here for your reference (not parsed).");?>
+                      </div>
+                    </td>
+                  </tr>
+                  <tr>
+                    <td width="22%" valign="top">&nbsp;</td>
+                    <td width="78%">
+                      <input type="hidden" name="vlanif" value="<?=$pconfig['vlanif']; ?>" />
+                      <input name="Submit" type="submit" class="btn btn-primary" value="<?=gettext("Save");?>" />
+                      <input type="button" class="btn btn-default" value="<?=gettext("Cancel");?>" onclick="window.location.href='<?=(isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '/interfaces_vlan.php');?>'" />
+                      <?php if (isset($id)): ?>
+                      <input name="id" type="hidden" value="<?=$id;?>" />
+                      <?php endif; ?>
+                    </td>
+                  </tr>
+                </tbody>
+              </table>
+            </form>
+          </div>
+        </div>
+      </section>
+    </div>
+  </div>
+</section>
 <?php include("foot.inc"); ?>