pfSense

<?php

/*

 * interfaces_fast.inc

 *

 * part of pfSense (https://www.pfsense.org)

 * Copyright (c) 2004-2016 Rubicon Communications, LLC (Netgate) (pfSense)

 * Copyright (c) 2017 Peter Schofield (parts of this file)

 * All rights reserved.

 *

 * originally based on m0n0wall (http://m0n0.ch/wall)

 * Copyright (c) 2004 Manuel Kasper <mk@neon1.net>.

 * All rights reserved.

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 *

 * This file contains rewrites of several functions, from both interfaces.inc

 * and interfaces_assign.php. The general purpose of these rewrites is not

 * necessarily to be faster in and of themselves, though they may be, but to

 * replace functions called multiple times with a function that's called only

 * once. This results in a significant speedup because there are far fewer

 * function calls, fewer loops and suchlike. It does, however, increase memory

 * usage somewhat, but it shouldn't be significant in the grand scheme of things.

 *

 *

 * Functions in this file may not require/use parameters when called, however 

 * in most cases they will accept parameters as per their original forms, for 

 * consistency.

 */

require_once('interfaces.inc');

/*

* does_interface_exist_fast

Returns an array of interfaces which exist on the system.

The $interface parameter is not used, but is accepted for

consistency with the function it replaces.

*/

function does_interface_exist_fast($interface='', $flush = true) {

	global $config;

	$ints = get_interface_arr($flush);

	return array_flip($ints);

}

/*

 * convert_real_interface_to_friendly_interface_name_fast($interface): convert fxp0 -> wan, etc.

 Returns an array of interfaces and friendly names.

 */

function convert_real_interface_to_friendly_interface_name_fast() {

	global $config;

	$out = array();

	/* XXX: For speed reasons reference directly the interface array */

	$ifdescrs = &$config['interfaces'];

	$iffriendlynames = array_keys($ifdescrs);

	$out = array_flip(get_real_interface_fast($iffriendlynames));

	return $out;

}

/* 

 * get_real_interface_fast($interfaces, ...)

 * Exactly the same as it's namesake, except it takes an array of interfaces and returns an array

 *

 */

function get_real_interface_fast($interfaces = array(), $family = "all", $realv6iface = false, $flush = true) {

	global $config, $g;

	$existing_ifs = does_interface_exist_fast();

	$out = array();

	foreach ($interfaces as $interface) {

		$wanif = NULL;

		switch ($interface) {

			case "l2tp":

				$wanif = "l2tp";

				break;

			case "pptp":

				$wanif = "pptp";

				break;

			case "pppoe":

				$wanif = "pppoe";

				break;

			case "openvpn":

				$wanif = "openvpn";

				break;

			case "IPsec":

			case "ipsec":

			case "enc0":

				$wanif = "enc0";

				break;

			case "ppp":

				$wanif = "ppp";

				break;

			default:

				if (substr($interface, 0, 4) == '_vip') {

					$wanif = get_configured_vip_interface($interface);

					if (!empty($wanif)) {

						$wanif = get_real_interface($wanif);

					}

					break;

				} else if (substr($interface, 0, 5) == '_lloc') {

					$interface = substr($interface, 5);

				} else if (strstr($interface, "_vlan") || isset($existing_ifs[$interface])) {

					/*

					 * If a real interface was already passed simply

					 * pass the real interface back.  This encourages

					 * the usage of this function in more cases so that

					 * we can combine logic for more flexibility.

					 */

					$wanif = $interface;

					break;

				}

				if (empty($config['interfaces'][$interface])) {

					break;

				}

				$cfg = &$config['interfaces'][$interface];

				if ($family == "inet6") {

					switch ($cfg['ipaddrv6']) {

						case "6rd":

						case "6to4":

							$wanif = "{$interface}_stf";

							break;

						case 'pppoe':

						case 'ppp':

						case 'l2tp':

						case 'pptp':

							if (is_array($cfg['wireless']) || preg_match($g['wireless_regex'], $cfg['if'])) {

								$wanif = interface_get_wireless_clone($cfg['if']);

							} else {

								$wanif = $cfg['if'];

							}

							break;

						default:

							switch ($cfg['ipaddr']) {

								case 'pppoe':

								case 'ppp':

								case 'l2tp':

								case 'pptp':

									if (isset($cfg['dhcp6usev4iface']) && $realv6iface === false) {

										$wanif = $cfg['if'];

									} else {

										$parents = get_parent_interface($interface);

										if (!empty($parents[0])) {

											$wanif = $parents[0];

										} else {

											$wanif = $cfg['if'];

										}

									}

									break;

								default:

									if (is_array($cfg['wireless']) || preg_match($g['wireless_regex'], $cfg['if'])) {

										$wanif = interface_get_wireless_clone($cfg['if']);

									} else {

										$wanif = $cfg['if'];

									}

									break;

							}

							break;

					}

				} else {

					// Wireless cloned NIC support (FreeBSD 8+)

					// interface name format: $parentnic_wlanparentnic#

					// example: ath0_wlan0

					if (is_array($cfg['wireless']) || preg_match($g['wireless_regex'], $cfg['if'])) {

						$wanif = interface_get_wireless_clone($cfg['if']);

					} else {

						$wanif = $cfg['if'];

					}

				}

				break;

		}

		$out[$interface] = $wanif;

	}

	return $out;

}

/*

 * interface_assign_description_fast($portlist, $friendlyifnames)

 *

 * This function replaces the function defined in interfaces_assign.php

 *

 * I created this version of the function because in interfaces_assign.php

 * the interface_assign_description() function is used twice, in both cases

 * being called for every iteration through the array of interfaces, and 

 * was seemingly dragging the performance of the HTML generation code down 

 * when faced with a large number of VLAN interfaces.

 *

 * Although this function internally recreates the loop that its namesake was

 * called in; the fact it's only called once rather than once per interface * 2

 * has resulted in a significant speed gain with a large number of optional 

 * interfaces configured.

 *

 * $portlist is the same $portlist as defined in interfaces_assign.php, call this

 * function after all the optional interfaces are added to $portlist.

 *

 * $friendlyifnames is a global variable of my own making, created by calling

 * convert_real_interface_to_friendly_interface_name_fast() on the keys of $portlist.

 *

 * Return value of this function is an associative array of interface descriptions

 * indexed by the unique name of the interface.

 *

 */

function interface_assign_description_fast($portlist, $friendlyifnames) {

	global $ovpn_descrs;

	$out = array();

	$gettext = gettext('on');

	foreach($portlist as $portname => $portinfo) {

		if ($portinfo['isvlan']) {

			$descr = sprintf('VLAN %1$s '.$gettext.' %2$s', $portinfo['tag'], $portinfo['if']);

			$iface = $friendlyifnames[$portinfo['if']];

			if (isset($iface) && strlen($iface) > 0) {

				$descr .= " - $iface";

			}

			if ($portinfo['descr']) {

				$descr .= " (" . $portinfo['descr'] . ")";

			}

		} elseif ($portinfo['iswlclone']) {

			$descr = $portinfo['cloneif'];

			if ($portinfo['descr']) {

				$descr .= " (" . $portinfo['descr'] . ")";

			}

		} elseif ($portinfo['isppp']) {

			$descr = $portinfo['descr'];

		} elseif ($portinfo['isbridge']) {

			$descr = strtoupper($portinfo['bridgeif']);

			if ($portinfo['descr']) {

				$descr .= " (" . $portinfo['descr'] . ")";

			}

		} elseif ($portinfo['isgre']) {

			$descr = "GRE {$portinfo['remote-addr']}";

			if ($portinfo['descr']) {

				$descr .= " (" . $portinfo['descr'] . ")";

			}

		} elseif ($portinfo['isgif']) {

			$descr = "GIF {$portinfo['remote-addr']}";

			if ($portinfo['descr']) {

				$descr .= " (" . $portinfo['descr'] . ")";

			}

		} elseif ($portinfo['islagg']) {

			$descr = strtoupper($portinfo['laggif']);

			if ($portinfo['descr']) {

				$descr .= " (" . $portinfo['descr'] . ")";

			}

		} elseif ($portinfo['isqinq']) {

			$descr = $portinfo['descr'];

		} elseif (substr($portname, 0, 4) == 'ovpn') {

			$descr = $portname . " (" . $ovpn_descrs[substr($portname, 5)] . ")";

		} else {

			$descr = $portname . " (" . $portinfo['mac'] . ")";

		}

		$out[$portname] = htmlspecialchars($descr);

	}

	return $out;

}

?>

//$timealla = microtime(true);

require_once("interfaces_fast.inc");

global $friendlyifnames;

/*moved most gettext calls to here, we really don't want to be repeatedly calling gettext() within loops if it can be avoided.*/

$gettextArray = array('add'=>gettext('Add'),'addif'=>gettext('Add interface'),'delete'=>gettext('Delete'),'deleteif'=>gettext('Delete interface'),'edit'=>gettext('Edit'),'on'=>gettext('on'));

/*another *_fast function from interfaces_fast.inc. These functions are basically the same as the 

ones they're named after, except they (usually) take an array and (always) return an array. This means that they only

need to be called once per script run, the returned array contains all the data necessary for repeated use */

$friendlyifnames = convert_real_interface_to_friendly_interface_name_fast();

	//$timea = microtime(true);

if (is_array($config['laggs']['lagg']) && count($config['laggs']['lagg'])) {

	foreach ($config['laggs']['lagg'] as $lagg) {

		$portlist[$lagg['laggif']] = $lagg;

		$portlist[$lagg['laggif']]['islagg'] = true;

		/* LAGG members cannot be assigned */

		$lagifs = explode(',', $lagg['members']);

		foreach ($lagifs as $lagif) {

			if (isset($portlist[$lagif])) {

				unset($portlist[$lagif]);

			}

			$portlist["{$qinq['vlanif']}_{$qinqif}"]['descr'] = "QinQ {$qinqif} on VLAN {$qinq['tag']} on {$qinq['if']}";

			$portlist["{$qinq['vlanif']}_{$qinqif}"]['isqinq'] = true;

$ifdescrs = interface_assign_description_fast($portlist,$friendlyifnames);

			/*get first available OPT interface number. This code scales better than the foreach it replaces. 

			* might not work if theres ifs other than 'wan','lan' and 'optx';

			* The performance increase isn't substantial over the foreach; however as the number of OPT interfaces

			* increases, so does the performance gain; from ~0.0003s improvement with 100 VLANs to ~0.0009s with 400.

			* It is, however, marginally slower (~0.000036s at 50 VLANS) than the foreach with less than 100 VLANs, and 

			* therefore may not be worth the loss of code readability or performance for the majority of use cases. */

			$step1 = array_keys($config['interfaces']);

			unset($step1['lan'],$step1['wan']);

			$step2 = str_replace("opt","",$step1);

			$step3 = array_fill(0,end($step2),'x');

			$step4 = array_flip($step2);

			$step5 = array_replace($step3,$step2);

			$step6 = array_unique($step5);

			$step7 = array_flip($step6);

			if (isset($step7['x']))

				$i = $step7['x'];

			else

				$i = count($config['interfaces'])-1;

$portArray = array_keys($portlist);

$ifaceArray = array_column($config['interfaces'],'if');

$unused = array_diff($portArray,$ifaceArray);

$unused = array_flip($unused);

$unused_portlist = array_intersect_key($portlist,$unused);//*/

unset($unused,$portArray,$ifaceArray);

/*generate the port select box only once. 

Not indenting the HTML to produce smaller code

and faster load times */

$portselect='';

foreach ($portlist as $portname => $portinfo) {

	$portselect.='<option value="'.$portname.'"'; 

	$portselect.=">".$ifdescrs[$portname]."</option>\n";

}

	$i=0;

<?php 

/*port select menu generation loop replaced with pre-prepared select menu to reduce page generation time */

echo str_replace('value="'.$iface['if'].'">','value="'.$iface['if'].'" selected>',$portselect);

?>

				<button type="submit" name="del[<?=$ifname?>]" class="btn btn-danger btn-sm" title="<?=$gettextArray['deleteif']?>">

					<?=$gettextArray["delete"]?>

<?php $i++; 

endforeach;

<?php

/* HTML not indented to save on transmission/render time */

foreach ($unused_portlist as $portname => $portinfo):?>

<option value="<?=$portname?>" <?=($portname == $iface['if']) ? ' selected': ''?>><?=$ifdescrs[$portname]?></option>

<?php endforeach;

?>

					<?=$gettextArray["add"]?>

##|*MATCH=interfaces_vlan_new_prof.php*

require_once("interfaces_fast.inc");

global $profile;

//$timealla = microtime(true);

$a_vlans = &$config['vlans']['vlan'] ;

<form action="interfaces_vlan_new_prof.php" method="post">

	//$timea = microtime(true);

	$gettext_array = array('edit'=>gettext('Edit VLAN'),'del'=>gettext('Delete VLAN'));

	$ifaces = convert_real_interface_to_friendly_interface_name_fast(array());

	//$iface = convert_real_interface_to_friendly_interface_name($vlan['if']);

	//if (isset($iface) && strlen($iface) > 0)

	//	printf(" (%s)", htmlspecialchars($iface));

	if (isset($ifaces[$vlan['if']]) && strlen($ifaces[$vlan['if']]) > 0)

		printf(" (%s)", htmlspecialchars($ifaces[$vlan['if']]));

								<a class="fa fa-pencil"	title="<?=$gettext_array['edit']?>"	role="button" href="interfaces_vlan_edit.php?id=<?=$i?>" ></a>

								<a class="fa fa-trash no-confirm"	title="<?=$gettext_array['del']?>"	role="button" id="del-<?=$i?>"></a>

	/*$timeb = microtime(true);

	$profile['vlan_list'] = $timeb - $tima;*/

/*$timeallb = microtime(true);

$profile['total'] = $timeallb - $timealla;

print_r($profile);*/