util.inc 34.9 KB
Newer Older
Ad Schellevis's avatar
Ad Schellevis committed
1 2
<?php

3
/*
Ad Schellevis's avatar
Ad Schellevis committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
	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.
*/
28
require_once("IPv6.inc");
Ad Schellevis's avatar
Ad Schellevis committed
29

30
function killbyname($procname, $sig = 'TERM')
31
{
32 33 34
	if (!is_process_running($procname)) {
		return;
	}
35

36 37 38 39 40
	mwexecf('/bin/pkill -%s %s', array($sig, $procname));
}

function killbypid($pidfile, $sig = 'TERM')
{
41
	if (!isvalidpid($pidfile)) {
42
		return;
43 44
	}

45
	mwexecf('/bin/pkill -%s -F %s', array($sig, $pidfile));
Ad Schellevis's avatar
Ad Schellevis committed
46 47
}

48 49
function isvalidpid($pidfile)
{
50 51
	if (!file_exists($pidfile)) {
		return false;
Ad Schellevis's avatar
Ad Schellevis committed
52
	}
53

54
	return mwexecf('/bin/pgrep -nF %s', $pidfile, true) == 0;
Ad Schellevis's avatar
Ad Schellevis committed
55 56
}

57 58 59
function is_process_running($process)
{
	exec('/bin/pgrep -anx ' . escapeshellarg($process), $output, $retval);
Ad Schellevis's avatar
Ad Schellevis committed
60 61 62 63

	return (intval($retval) == 0);
}

64 65 66
function is_subsystem_dirty($subsystem = '')
{
	if ($subsystem == '') {
Ad Schellevis's avatar
Ad Schellevis committed
67
		return false;
68
	}
Ad Schellevis's avatar
Ad Schellevis committed
69

70
	if (file_exists("/tmp/{$subsystem}.dirty")) {
Ad Schellevis's avatar
Ad Schellevis committed
71
		return true;
72
	}
Ad Schellevis's avatar
Ad Schellevis committed
73 74 75 76

	return false;
}

77 78
function mark_subsystem_dirty($subsystem = '')
{
79
	touch("/tmp/{$subsystem}.dirty");
Ad Schellevis's avatar
Ad Schellevis committed
80 81
}

82 83
function clear_subsystem_dirty($subsystem = '')
{
84
	@unlink("/tmp/{$subsystem}.dirty");
Ad Schellevis's avatar
Ad Schellevis committed
85 86 87
}

/* lock configuration file */
88 89 90
function lock($lock, $op = LOCK_SH)
{
	if (!$lock) {
Ad Schellevis's avatar
Ad Schellevis committed
91
		die(gettext("WARNING: You must give a name as parameter to lock() function."));
92 93
	}

94 95 96
	if (!file_exists("{/tmp/{$lock}.lock")) {
		@touch("/tmp/{$lock}.lock");
		@chmod("/tmp/{$lock}.lock", 0666);
Ad Schellevis's avatar
Ad Schellevis committed
97
	}
98

99
	if ($fp = fopen("/tmp/{$lock}.lock", "w")) {
100
		if (flock($fp, $op)) {
Ad Schellevis's avatar
Ad Schellevis committed
101
			return $fp;
102
		} else {
Ad Schellevis's avatar
Ad Schellevis committed
103
			fclose($fp);
104
		}
Ad Schellevis's avatar
Ad Schellevis committed
105 106 107 108 109
	}
}


/* unlock configuration file */
110 111
function unlock($cfglckkey = 0)
{
Ad Schellevis's avatar
Ad Schellevis committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
	flock($cfglckkey, LOCK_UN);
	fclose($cfglckkey);
}

function is_module_loaded($module_name) {
	$module_name = str_replace(".ko", "", $module_name);
	$running = 0;
	$_gb = exec("/sbin/kldstat -qn {$module_name} 2>&1", $_gb, $running);
	if (intval($running) == 0)
		return true;
	else
		return false;
}

/* validate non-negative numeric string, or equivalent numeric variable */
function is_numericint($arg) {
128
	return (((is_int($arg) && $arg >= 0) || (is_string($arg) && strlen($arg) > 0 && ctype_digit($arg))) ? true : false);
Ad Schellevis's avatar
Ad Schellevis committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
}

/* return the subnet address given a host address and a subnet bit count */
function gen_subnet($ipaddr, $bits) {
	if (!is_ipaddr($ipaddr) || !is_numeric($bits))
		return "";
	return long2ip(ip2long($ipaddr) & gen_subnet_mask_long($bits));
}

/* return the subnet address given a host address and a subnet bit count */
function gen_subnetv6($ipaddr, $bits) {
	if (!is_ipaddrv6($ipaddr) || !is_numeric($bits))
		return "";

	$address = Net_IPv6::getNetmask($ipaddr, $bits);
	$address = Net_IPv6::compress($address);
	return $address;
}

/* return the highest (broadcast) address in the subnet given a host address and a subnet bit count */
function gen_subnet_max($ipaddr, $bits) {
	if (!is_ipaddr($ipaddr) || !is_numeric($bits))
		return "";

	return long2ip32(ip2long($ipaddr) | ~gen_subnet_mask_long($bits));
}

/* Generate end number for a given ipv6 subnet mask */
function gen_subnetv6_max($ipaddr, $bits) {
	if(!is_ipaddrv6($ipaddr))
		return false;

	$mask = Net_IPv6::getNetmask('FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF',$bits);

	$inet_ip = (binary)inet_pton($ipaddr);
	$inet_mask = (binary)inet_pton($mask);

	$inet_end = $inet_ip | ~$inet_mask;

	return (inet_ntop($inet_end));
}

/* returns a subnet mask (long given a bit count) */
function gen_subnet_mask_long($bits) {
	$sm = 0;
	for ($i = 0; $i < $bits; $i++) {
		$sm >>= 1;
		$sm |= 0x80000000;
	}
	return $sm;
}

/* same as above but returns a string */
function gen_subnet_mask($bits) {
	return long2ip(gen_subnet_mask_long($bits));
}

/* Convert long int to IP address, truncating to 32-bits. */
function long2ip32($ip) {
	return long2ip($ip & 0xFFFFFFFF);
}

/* Convert IP address to long int, truncated to 32-bits to avoid sign extension on 64-bit platforms. */
function ip2long32($ip) {
	return ( ip2long($ip) & 0xFFFFFFFF );
}

/* Convert IP address to unsigned long int. */
function ip2ulong($ip) {
	return sprintf("%u", ip2long32($ip));
}

/* Find out how many IPs are contained within a given IP range
 *  e.g. 192.168.0.0 to 192.168.0.255 returns 256
 */
function ip_range_size($startip, $endip) {
	if (is_ipaddr($startip) && is_ipaddr($endip)) {
		// Operate as unsigned long because otherwise it wouldn't work
		//   when crossing over from 127.255.255.255 / 128.0.0.0 barrier
		return abs(ip2ulong($startip) - ip2ulong($endip)) + 1;
	}
	return -1;
}

/* Find the smallest possible subnet mask which can contain a given number of IPs
 *  e.g. 512 IPs can fit in a /23, but 513 IPs need a /22
 */
function find_smallest_cidr($number) {
	$smallest = 1;
	for ($b=32; $b > 0; $b--) {
		$smallest = ($number <= pow(2,$b)) ? $b : $smallest;
	}
	return (32-$smallest);
}

/* Return the previous IP address before the given address */
function ip_before($ip) {
	return long2ip32(ip2long($ip)-1);
}

/* Return the next IP address after the given address */
function ip_after($ip) {
	return long2ip32(ip2long($ip)+1);
}

/* Return true if the first IP is 'before' the second */
function ip_less_than($ip1, $ip2) {
	// Compare as unsigned long because otherwise it wouldn't work when
	//   crossing over from 127.255.255.255 / 128.0.0.0 barrier
	return ip2ulong($ip1) < ip2ulong($ip2);
}

/* Return true if the first IP is 'after' the second */
function ip_greater_than($ip1, $ip2) {
	// Compare as unsigned long because otherwise it wouldn't work
	//   when crossing over from 127.255.255.255 / 128.0.0.0 barrier
	return ip2ulong($ip1) > ip2ulong($ip2);
}

/* Convert a range of IPs to an array of subnets which can contain the range. */
function ip_range_to_subnet_array($startip, $endip) {
	if (!is_ipaddr($startip) || !is_ipaddr($endip)) {
		return array();
	}

	// Container for subnets within this range.
	$rangesubnets = array();

	// Figure out what the smallest subnet is that holds the number of IPs in the given range.
	$cidr = find_smallest_cidr(ip_range_size($startip, $endip));

	// Loop here to reduce subnet size and retest as needed. We need to make sure
	//   that the target subnet is wholly contained between $startip and $endip.
	for ($cidr; $cidr <= 32; $cidr++) {
		// Find the network and broadcast addresses for the subnet being tested.
		$targetsub_min = gen_subnet($startip, $cidr);
		$targetsub_max = gen_subnet_max($startip, $cidr);

		// Check best case where the range is exactly one subnet.
		if (($targetsub_min == $startip) && ($targetsub_max == $endip)) {
			// Hooray, the range is exactly this subnet!
			return array("{$startip}/{$cidr}");
		}

		// These remaining scenarios will find a subnet that uses the largest
		//  chunk possible of the range being tested, and leave the rest to be
		//  tested recursively after the loop.

		// Check if the subnet begins with $startip and ends before $endip
		if (($targetsub_min == $startip) && ip_less_than($targetsub_max, $endip)) {
			break;
		}

		// Check if the subnet ends at $endip and starts after $startip
		if (ip_greater_than($targetsub_min, $startip) && ($targetsub_max == $endip)) {
			break;
		}

		// Check if the subnet is between $startip and $endip
		if (ip_greater_than($targetsub_min, $startip) && ip_less_than($targetsub_max, $endip)) {
			break;
		}
	}

	// Some logic that will recursivly search from $startip to the first IP before the start of the subnet we just found.
	// NOTE: This may never be hit, the way the above algo turned out, but is left for completeness.
	if ($startip != $targetsub_min) {
		$rangesubnets = array_merge($rangesubnets, ip_range_to_subnet_array($startip, ip_before($targetsub_min)));
	}

	// Add in the subnet we found before, to preserve ordering
	$rangesubnets[] = "{$targetsub_min}/{$cidr}";

	// And some more logic that will search after the subnet we found to fill in to the end of the range.
	if ($endip != $targetsub_max) {
		$rangesubnets = array_merge($rangesubnets, ip_range_to_subnet_array(ip_after($targetsub_max), $endip));
	}
	return $rangesubnets;
}

/* returns true if $ipaddr is a valid dotted IPv4 address or a IPv6 */
function is_ipaddr($ipaddr) {
	if(is_ipaddrv4($ipaddr)) {
		return true;
	}
	if(is_ipaddrv6($ipaddr)) {
		return true;
	}
	return false;
}

/* returns true if $ipaddr is a valid IPv6 address */
function is_ipaddrv6($ipaddr) {
	if (!is_string($ipaddr) || empty($ipaddr))
		return false;
	if (strstr($ipaddr, "%") && is_linklocal($ipaddr)) {
		$tmpip = explode("%", $ipaddr);
		$ipaddr = $tmpip[0];
	}
328 329 330 331 332
	if (strpos($ipaddr, ":") === false) {
		return false;
	} else {
		return Net_IPv6::checkIPv6($ipaddr);
	}
Ad Schellevis's avatar
Ad Schellevis committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
}

/* returns true if $ipaddr is a valid dotted IPv4 address */
function is_ipaddrv4($ipaddr) {
	if (!is_string($ipaddr) || empty($ipaddr))
		return false;

	$ip_long = ip2long($ipaddr);
	$ip_reverse = long2ip32($ip_long);

	if ($ipaddr == $ip_reverse)
		return true;
	else
		return false;
}

/* returns true if $ipaddr is a valid linklocal address */
function is_linklocal($ipaddr) {
	return (strtolower(substr($ipaddr, 0, 5)) == "fe80:");
}

/* returns scope of a linklocal address */
function get_ll_scope($addr) {
	if (!is_linklocal($addr) || !strstr($addr, "%"))
		return "";
	list ($ll, $scope) = explode("%", $addr);
	return $scope;
}

/* returns true if $ipaddr is a valid literal IPv6 address */
function is_literalipaddrv6($ipaddr) {
	if(preg_match("/\[([0-9a-f:]+)\]/i", $ipaddr, $match))
		$ipaddr = $match[1];
	else
		return false;

	return is_ipaddrv6($ipaddr);
}

function is_ipaddrwithport($ipport) {
	$parts = explode(":", $ipport);
	$port = array_pop($parts);
	if (count($parts) == 1) {
		return is_ipaddrv4($parts[0]) && is_port($port);
	} elseif (count($parts) > 1) {
		return is_literalipaddrv6(implode(":", $parts)) && is_port($port);
	} else {
		return false;
	}
}

function is_hostnamewithport($hostport) {
	$parts = explode(":", $hostport);
	$port = array_pop($parts);
	if (count($parts) == 1) {
		return is_hostname($parts[0]) && is_port($port);
	} else {
		return false;
	}
}

/* returns true if $ipaddr is a valid dotted IPv4 address or an alias thereof */
395 396
function is_ipaddroralias($ipaddr)
{
Ad Schellevis's avatar
Ad Schellevis committed
397 398 399
	global $config;

	if (is_alias($ipaddr)) {
400
		if (isset($config['aliases']['alias'])) {
Ad Schellevis's avatar
Ad Schellevis committed
401 402 403 404 405 406
			foreach ($config['aliases']['alias'] as $alias) {
				if ($alias['name'] == $ipaddr && !preg_match("/port/i", $alias['type']))
					return true;
			}
		}
		return false;
407
	}
Ad Schellevis's avatar
Ad Schellevis committed
408

409
	return is_ipaddr($ipaddr);
Ad Schellevis's avatar
Ad Schellevis committed
410 411 412
}

/* returns true if $subnet is a valid IPv4 or IPv6 subnet in CIDR format
413 414
	false - if not a valid subnet
	true (numeric 4 or 6) - if valid, gives type of subnet */
Ad Schellevis's avatar
Ad Schellevis committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
function is_subnet($subnet) {
	if (is_string($subnet) && preg_match('/^(?:([0-9.]{7,15})|([0-9a-f:]{2,39}))\/(\d{1,3})$/i', $subnet, $parts)) {
		if (is_ipaddrv4($parts[1]) && $parts[3] <= 32)
			return 4;
		if (is_ipaddrv6($parts[2]) && $parts[3] <= 128)
			return 6;
	}
	return false;
}

/* same as is_subnet() but accepts IPv4 only */
function is_subnetv4($subnet) {
	return (is_subnet($subnet) == 4);
}

/* same as is_subnet() but accepts IPv6 only */
function is_subnetv6($subnet) {
	return (is_subnet($subnet) == 6);
}

/* returns true if $hostname is a valid hostname */
function is_hostname($hostname) {
	if (!is_string($hostname))
		return false;

	if (preg_match('/^(?:(?:[a-z0-9_]|[a-z0-9_][a-z0-9_\-]*[a-z0-9_])\.)*(?:[a-z0-9_]|[a-z0-9_][a-z0-9_\-]*[a-z0-9_])$/i', $hostname))
		return true;
	else
		return false;
}

/* returns true if $domain is a valid domain name */
function is_domain($domain) {
	if (!is_string($domain))
		return false;

	if (preg_match('/^(?:(?:[a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*(?:[a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$/i', $domain))
		return true;
	else
		return false;
}

/* returns true if $macaddr is a valid MAC address */
function is_macaddr($macaddr, $partial=false) {
	$repeat = ($partial) ? '1,5' : '5';
	return preg_match('/^[0-9A-F]{2}(?:[:][0-9A-F]{2}){'.$repeat.'}$/i', $macaddr) == 1 ? true : false;
}

/* returns true if $name is a valid name for an alias
   returns NULL if a reserved word is used
   returns FALSE for bad chars in the name - this allows calling code to determine what the problem was.
   aliases cannot be:
467 468 469
	bad chars: anything except a-z 0-9 and underscore
	bad names: empty string, pure numeric, pure underscore
	reserved words: pre-defined service/protocol/port names which should not be ambiguous, and the words "port" and  "pass" */
Ad Schellevis's avatar
Ad Schellevis committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

function is_validaliasname($name) {
	/* Array of reserved words */
	$reserved = array("port", "pass");

	if (!is_string($name) || strlen($name) >= 32 || preg_match('/(^_*$|^\d*$|[^a-z0-9_])/i', $name))
		return false;
	if (in_array($name, $reserved, true) || getservbyname($name, "tcp") || getservbyname($name, "udp") || getprotobyname($name))
		return; /* return NULL */
	return true;
}

/* returns true if $port is a valid TCP/UDP port */
function is_port($port) {
	if (getservbyname($port, "tcp") || getservbyname($port, "udp"))
		return true;
	if (!ctype_digit($port))
		return false;
	else if ((intval($port) < 1) || (intval($port) > 65535))
		return false;
	return true;
}

/* returns true if $portrange is a valid TCP/UDP portrange ("<port>:<port>") */
function is_portrange($portrange) {
	$ports = explode(":", $portrange);

	return (count($ports) == 2 && is_port($ports[0]) && is_port($ports[1]));
}

/* returns true if $port is a valid port number or an alias thereof */
501 502
function is_portoralias($port)
{
Ad Schellevis's avatar
Ad Schellevis committed
503 504 505
	global $config;

	if (is_alias($port)) {
506
		if (isset($config['aliases']['alias'])) {
Ad Schellevis's avatar
Ad Schellevis committed
507 508 509 510 511 512
			foreach ($config['aliases']['alias'] as $alias) {
				if ($alias['name'] == $port && preg_match("/port/i", $alias['type']))
					return true;
				}
			}
			return false;
513 514 515
	}

	return is_port($port);
Ad Schellevis's avatar
Ad Schellevis committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
}

/* create ranges of sequential port numbers (200:215) and remove duplicates */
function group_ports($ports) {
	if (!is_array($ports) || empty($ports))
		return;

	$uniq = array();
	foreach ($ports as $port) {
		if (is_portrange($port)) {
			list($begin, $end) = explode(":", $port);
			if ($begin > $end) {
				$aux = $begin;
				$begin = $end;
				$end = $aux;
			}
			for ($i = $begin; $i <= $end; $i++)
				if (!in_array($i, $uniq))
					$uniq[] = $i;
		} else if (is_port($port)) {
			if (!in_array($port, $uniq))
				$uniq[] = $port;
		}
	}
	sort($uniq, SORT_NUMERIC);

	$result = array();
	foreach ($uniq as $idx => $port) {
		if ($idx == 0) {
			$result[] = $port;
			continue;
		}

		$last = end($result);
		if (is_portrange($last))
			list($begin, $end) = explode(":", $last);
		else
			$begin = $end = $last;

		if ($port == ($end+1)) {
			$end++;
			$result[count($result)-1] = "{$begin}:{$end}";
		} else {
			$result[] = $port;
		}
	}

	return $result;
}

/* returns true if $val is a valid shaper bandwidth value */
function is_valid_shaperbw($val) {
	return (preg_match("/^(\d+(?:\.\d+)?)([MKG]?b|%)$/", $val));
}

/* returns true if $test is in the range between $start and $end */
function is_inrange_v4($test, $start, $end) {
	if ( (ip2ulong($test) <= ip2ulong($end)) && (ip2ulong($test) >= ip2ulong($start)) )
		return true;
	else
		return false;
}

/* returns true if $test is in the range between $start and $end */
function is_inrange_v6($test, $start, $end) {
	if ( (inet_pton($test) <= inet_pton($end)) && (inet_pton($test) >= inet_pton($start)) )
		return true;
	else
		return false;
}

/* returns true if $test is in the range between $start and $end */
function is_inrange($test, $start, $end) {
	return is_ipaddrv6($test) ? is_inrange_v6($test, $start, $end) : is_inrange_v4($test, $start, $end);
}

/* XXX: return the configured carp interface list */
593 594
function get_configured_carp_interface_list($carpinterface = '', $family = 'inet')
{
Ad Schellevis's avatar
Ad Schellevis committed
595 596 597 598
	global $config;

	$iflist = array();

599
	if (isset($config['virtualip']['vip'])) {
Ad Schellevis's avatar
Ad Schellevis committed
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
		$viparr = &$config['virtualip']['vip'];
		foreach ($viparr as $vip) {
			switch ($vip['mode']) {
			case "carp":
				if (!empty($carpinterface)) {
					if ($carpinterface == "{$vip['interface']}_vip{$vip['vhid']}") {
						if ($family == "inet" && is_ipaddrv4($vip['subnet']))
							return $vip['subnet'];
						else if ($family == "inet6" && is_ipaddrv6($vip['subnet']))
							return $vip['subnet'];
					}
				} else {
					$iflist["{$vip['interface']}_vip{$vip['vhid']}"] = $vip['subnet'];
				}
				break;
			}
		}
	}

	return $iflist;
}

/* return the configured IP aliases list */
623 624
function get_configured_ip_aliases_list($returnfullentry = false)
{
Ad Schellevis's avatar
Ad Schellevis committed
625 626
	global $config;

627
	$alias_list = array();
Ad Schellevis's avatar
Ad Schellevis committed
628

629
	if (isset($config['virtualip']['vip'])) {
Ad Schellevis's avatar
Ad Schellevis committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
		$viparr = &$config['virtualip']['vip'];
		foreach ($viparr as $vip) {
			if ($vip['mode']=="ipalias") {
				if ($returnfullentry)
					$alias_list[$vip['subnet']] = $vip;
				else
					$alias_list[$vip['subnet']] = $vip['interface'];
			}
		}
	}

	return $alias_list;
}

/* return all configured aliases list (IP, carp, proxyarp and other) */
645 646
function get_configured_vips_list()
{
Ad Schellevis's avatar
Ad Schellevis committed
647 648 649 650
	global $config;

	$alias_list=array();

651
	if (isset($config['virtualip']['vip'])) {
Ad Schellevis's avatar
Ad Schellevis committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
		$viparr = &$config['virtualip']['vip'];
		foreach ($viparr as $vip) {
			if ($vip['mode'] == "carp")
				$alias_list[] = array("ipaddr" => $vip['subnet'], "if" => "{$vip['interface']}_vip{$vip['vhid']}");
			else
				$alias_list[] = array("ipaddr" => $vip['subnet'], "if" => $vip['interface']);
		}
	}

	return $alias_list;
}

/* comparison function for sorting by the order in which interfaces are normally created */
function compare_interface_friendly_names($a, $b) {
	if ($a == $b)
		return 0;
	else if ($a == 'wan')
		return -1;
	else if ($b == 'wan')
		return 1;
	else if ($a == 'lan')
		return -1;
	else if ($b == 'lan')
		return 1;

	return strnatcmp($a, $b);
}

/* return the configured interfaces list. */
function get_configured_interface_list($only_opt = false, $withdisabled = false) {
	global $config;

	$iflist = array();

	/* if list */
687 688 689 690 691 692 693 694 695
	if (isset($config['interfaces'])) {
		foreach($config['interfaces'] as $if => $ifdetail) {
			if ($only_opt && ($if == "wan" || $if == "lan")) {
				continue;
			}
			if (isset($ifdetail['enable']) || $withdisabled == true) {
				$iflist[$if] = $if;
			}
		}
Ad Schellevis's avatar
Ad Schellevis committed
696 697 698 699 700 701 702 703 704 705 706 707
	}

	return $iflist;
}

/* return the configured interfaces list. */
function get_configured_interface_list_by_realif($only_opt = false, $withdisabled = false) {
	global $config;

	$iflist = array();

	/* if list */
708 709 710 711 712 713 714 715 716
	if (isset($config['interfaces'])) {
		foreach($config['interfaces'] as $if => $ifdetail) {
			if ($only_opt && ($if == "wan" || $if == "lan"))
				continue;
			if (isset($ifdetail['enable']) || $withdisabled == true) {
				$tmpif = get_real_interface($if);
				if (!empty($tmpif))
					$iflist[$tmpif] = $if;
			}
Ad Schellevis's avatar
Ad Schellevis committed
717 718 719 720 721 722 723 724 725 726 727 728 729
		}
	}

	return $iflist;
}

/* return the configured interfaces list with their description. */
function get_configured_interface_with_descr($only_opt = false, $withdisabled = false) {
	global $config;

	$iflist = array();

	/* if list */
730 731 732 733 734 735 736 737 738 739
	if (isset($config['interfaces'])) {
		foreach($config['interfaces'] as $if => $ifdetail) {
			if ($only_opt && ($if == "wan" || $if == "lan"))
				continue;
			if (isset($ifdetail['enable']) || $withdisabled == true) {
				if(empty($ifdetail['descr']))
					$iflist[$if] = strtoupper($if);
				else
					$iflist[$if] = strtoupper($ifdetail['descr']);
			}
Ad Schellevis's avatar
Ad Schellevis committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
		}
	}

	return $iflist;
}

/*
 *   get_configured_ip_addresses() - Return a list of all configured
 *   interfaces IP Addresses
 *
 */
function get_configured_ip_addresses() {
	global $config;

	$ip_array = array();
	$interfaces = get_configured_interface_list();
	if (is_array($interfaces)) {
		foreach($interfaces as $int) {
			$ipaddr = get_interface_ip($int);
			$ip_array[$int] = $ipaddr;
		}
	}
	$interfaces = get_configured_carp_interface_list();
763 764
	if (is_array($interfaces)) {
		foreach($interfaces as $int => $ipaddr) {
Ad Schellevis's avatar
Ad Schellevis committed
765
			$ip_array[$int] = $ipaddr;
766 767
		}
	}
Ad Schellevis's avatar
Ad Schellevis committed
768 769

	/* pppoe server */
770
	if (isset($config['pppoes']['pppoe'])) {
Ad Schellevis's avatar
Ad Schellevis committed
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
		foreach($config['pppoes']['pppoe'] as $pppoe) {
			if ($pppoe['mode'] == "server") {
				if(is_ipaddr($pppoe['localip'])) {
					$int = "pppoes". $pppoe['pppoeid'];
					$ip_array[$int] = $pppoe['localip'];
				}
			}
		}
	}

	return $ip_array;
}

/*
 *   get_configured_ipv6_addresses() - Return a list of all configured
 *   interfaces IPv6 Addresses
 *
 */
789 790
function get_configured_ipv6_addresses()
{
Ad Schellevis's avatar
Ad Schellevis committed
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
	$ipv6_array = array();
	$interfaces = get_configured_interface_list();
	if(is_array($interfaces)) {
		foreach($interfaces as $int) {
			$ipaddrv6 = get_interface_ipv6($int);
			$ipv6_array[$int] = $ipaddrv6;
		}
	}
	$interfaces = get_configured_carp_interface_list();
	if(is_array($interfaces))
		foreach($interfaces as $int => $ipaddrv6)
			$ipv6_array[$int] = $ipaddrv6;
	return $ipv6_array;
}

/*
 *   get_interface_list() - Return a list of all physical interfaces
808
 *   along with MAC, IPv4 and status.
Ad Schellevis's avatar
Ad Schellevis committed
809
 *
810 811
 *   $only_active = false -- interfaces that are available in the system
 *                  true  -- interfaces that are physically connected
Ad Schellevis's avatar
Ad Schellevis committed
812
 */
813
function get_interface_list($only_active = false)
814
{
Ad Schellevis's avatar
Ad Schellevis committed
815
	global $config;
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842

	/* list of virtual interface types */
	$vfaces = array(
		'_vlan',
		'_wlan',
		'bridge',
		'carp',
		'enc',
		'faith',
		'gif',
		'gre',
		'ipfw',
		'l2tp',
		'lagg',
		'lo',
		'ng',
		'pflog',
		'plip',
		'ppp',
		'pppoe',
		'pptp',
		'pfsync',
		'sl',
		'tun',
		'vip'
	);

843
	$ifnames_up = legacy_interface_listget('up');
844
	$ifnames = legacy_interface_listget();
845

846 847 848 849 850 851 852 853 854
	if ($only_active) {
		$_ifnames = array();

		foreach ($ifnames as $ifname) {
			$ifinfo = legacy_interface_stats($ifname);
			if (isset($ifinfo['link state'])) {
				if ($ifinfo['link state'] == '2') {
					$_ifnames[] = $ifname;
				}
855
			}
Ad Schellevis's avatar
Ad Schellevis committed
856
		}
857 858

		$ifnames = $_ifnames;
Ad Schellevis's avatar
Ad Schellevis committed
859
	}
860 861

	foreach ($ifnames as $ifname) {
862
		if (in_array(array_shift(preg_split('/\d/', $ifname)), $vfaces)) {
863 864 865 866 867 868
			continue;
		}

		$ifdata = pfSense_get_interface_addresses($ifname);

		$toput = array(
869
			'up' => in_array($ifname, $ifnames_up),
870 871 872 873 874 875 876
			'ipaddr' => $ifdata['ipaddr'],
			'mac' => $ifdata['macaddr']
		);

		if (isset($config['interfaces'])) {
			foreach($config['interfaces'] as $name => $int) {
				if ($int['if'] == $ifname) {
877 878
					$toput['friendly'] = $name;
					break;
879
				}
Ad Schellevis's avatar
Ad Schellevis committed
880
			}
881
		}
Ad Schellevis's avatar
Ad Schellevis committed
882

883 884 885 886 887 888 889
		$dmesg_arr = array();
		exec("/sbin/dmesg |grep $ifname | head -n1", $dmesg_arr);
		preg_match_all("/<(.*?)>/i", $dmesg_arr[0], $dmesg);
		if (isset($dmesg[1][0])) {
			$toput['dmesg'] = $dmesg[1][0];
		} else {
			$toput['dmesg'] = null;
Ad Schellevis's avatar
Ad Schellevis committed
890
		}
891 892

		$iflist[$ifname] = $toput;
Ad Schellevis's avatar
Ad Schellevis committed
893
	}
894

Ad Schellevis's avatar
Ad Schellevis committed
895 896 897 898 899 900 901 902 903 904 905
	return $iflist;
}

/****f* util/log_error
* NAME
*   log_error  - Sends a string to syslog.
* INPUTS
*   $error     - string containing the syslog message.
* RESULT
*   null
******/
906 907
function log_error($error)
{
Ad Schellevis's avatar
Ad Schellevis committed
908 909 910 911 912
	$page = $_SERVER['SCRIPT_NAME'];
	if (empty($page)) {
		$files = get_included_files();
		$page = basename($files[0]);
	}
913

Ad Schellevis's avatar
Ad Schellevis committed
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
	syslog(LOG_ERR, "$page: $error");
}

/****f* util/exec_command
 * NAME
 *   exec_command - Execute a command and return a string of the result.
 * INPUTS
 *   $command   - String of the command to be executed.
 * RESULT
 *   String containing the command's result.
 * NOTES
 *   This function returns the command's stdout and stderr.
 ******/
function exec_command($command) {
	$output = array();
	exec($command . ' 2>&1', $output);
	return(implode("\n", $output));
}

933
/* wrapper for mwexec() ;) */
Franco Fichtner's avatar
Franco Fichtner committed
934
function mwexecf($format, $args = array(), $mute = false)
935 936 937 938 939 940 941 942 943 944
{
	if (!is_array($args)) {
		/* just in case there's only one argument */
		$args = array($args);
	}

	foreach ($args as $id => $arg) {
		$args[$id] = escapeshellarg($arg);
	}

Franco Fichtner's avatar
Franco Fichtner committed
945
	return mwexec(vsprintf($format, $args), $mute);
946 947
}

Ad Schellevis's avatar
Ad Schellevis committed
948
/* wrapper for exec() */
Franco Fichtner's avatar
Franco Fichtner committed
949
function mwexec($command, $mute = false)
950
{
Ad Schellevis's avatar
Ad Schellevis committed
951 952 953
	$oarr = array();
	$retval = 0;

954 955 956 957 958 959
	$garbage = exec("{$command} 2>&1", $oarr, $retval);
	unset($garbage);

	if ($retval != 0 && $mute == false) {
		$output = implode(' ', $oarr);
		log_error(sprintf(gettext("The command '%s' returned exit code '%d', the output was '%s'"), $command, $retval, $output));
Ad Schellevis's avatar
Ad Schellevis committed
960 961
		unset($output);
	}
962

Ad Schellevis's avatar
Ad Schellevis committed
963
	unset($oarr);
964

Ad Schellevis's avatar
Ad Schellevis committed
965 966 967 968
	return $retval;
}

/* wrapper for exec() in background */
Franco Fichtner's avatar
Franco Fichtner committed
969
function mwexec_bg($command, $mute = false)
970
{
Franco Fichtner's avatar
Franco Fichtner committed
971
	mwexec("/usr/sbin/daemon -f {$command}", $mute);
Ad Schellevis's avatar
Ad Schellevis committed
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
}


/* check if an alias exists */
function is_alias($name) {
	global $aliastable;

	return isset($aliastable[$name]);
}

function alias_get_type($name) {
	global $config;

	if (is_array($config['aliases']['alias'])) {
		foreach ($config['aliases']['alias'] as $alias) {
			if ($name == $alias['name'])
				return $alias['type'];
		}
	}

	return "";
}

/* expand a host or network alias, if necessary */
function alias_expand($name) {
	global $aliastable;

	if (isset($aliastable[$name]))
		return "\${$name}";
	else if (is_ipaddr($name) || is_subnet($name) || is_port($name) || is_portrange($name))
		return "{$name}";
	else
		return null;
}

function subnet_size($subnet) {
	if (is_subnetv4($subnet)) {
		list ($ip, $bits) = explode("/", $subnet);
		return round(exp(log(2) * (32 - $bits)));
	}
	else if (is_subnetv6($subnet)) {
		list ($ip, $bits) = explode("/", $subnet);
		return round(exp(log(2) * (128 - $bits)));
	}
	else {
		return 0;
	}
}

/* find out whether two subnets overlap */
function check_subnets_overlap($subnet1, $bits1, $subnet2, $bits2) {

	if (!is_numeric($bits1))
		$bits1 = 32;
	if (!is_numeric($bits2))
		$bits2 = 32;

	if ($bits1 < $bits2)
		$relbits = $bits1;
	else
		$relbits = $bits2;

	$sn1 = gen_subnet_mask_long($relbits) & ip2long($subnet1);
	$sn2 = gen_subnet_mask_long($relbits) & ip2long($subnet2);

	return ($sn1 == $sn2);
}

/* compare two IP addresses */
function ipcmp($a, $b) {
	if (ip_less_than($a, $b))
		return -1;
	else if (ip_greater_than($a, $b))
		return 1;
	else
		return 0;
}

/* return true if $addr is in $subnet, false if not */
function ip_in_subnet($addr,$subnet) {
	if(is_ipaddrv6($addr)) {
		return (Net_IPv6::isInNetmask($addr, $subnet));
	} else { /* XXX: Maybe check for IPv4 */
		list($ip, $mask) = explode('/', $subnet);
		$mask = (0xffffffff << (32 - $mask)) & 0xffffffff;
		return ((ip2long($addr) & $mask) == (ip2long($ip) & $mask));
	}
}



function mac_format($clientmac) {
	global $config, $cpzone;

	$mac = explode(":", $clientmac);
	$mac_format = $cpzone ? $config['captiveportal'][$cpzone]['radmac_format'] : false;

	switch($mac_format) {
	case 'singledash':
		return "$mac[0]$mac[1]$mac[2]-$mac[3]$mac[4]$mac[5]";

	case 'ietf':
		return "$mac[0]-$mac[1]-$mac[2]-$mac[3]-$mac[4]-$mac[5]";

	case 'cisco':
		return "$mac[0]$mac[1].$mac[2]$mac[3].$mac[4]$mac[5]";

	case 'unformatted':
		return "$mac[0]$mac[1]$mac[2]$mac[3]$mac[4]$mac[5]";

	default:
		return $clientmac;
	}
}

function resolve_retry($hostname, $retries = 5) {

	if (is_ipaddr($hostname))
		return $hostname;

	for ($i = 0; $i < $retries; $i++) {
		// FIXME: gethostbyname does not work for AAAA hostnames, boo, hiss
		$ip = gethostbyname($hostname);

		if ($ip && $ip != $hostname) {
			/* success */
			return $ip;
		}

		sleep(1);
	}

	return false;
}

function format_bytes($bytes) {
	if ($bytes >= 1073741824) {
		return sprintf("%.2f GB", $bytes/1073741824);
	} else if ($bytes >= 1048576) {
		return sprintf("%.2f MB", $bytes/1048576);
	} else if ($bytes >= 1024) {
		return sprintf("%.0f KB", $bytes/1024);
	} else {
		return sprintf("%d bytes", $bytes);
	}
}

1119 1120 1121
function update_filter_reload_status($text)
{
	file_put_contents('/var/run/filter_reload_status', $text);
Ad Schellevis's avatar
Ad Schellevis committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
}

/****** util/return_dir_as_array
 * NAME
 *   return_dir_as_array - Return a directory's contents as an array.
 * INPUTS
 *   $dir          - string containing the path to the desired directory.
 *   $filter_regex - string containing a regular expression to filter file names. Default empty.
 * RESULT
 *   $dir_array - array containing the directory's contents. This array will be empty if the path specified is invalid.
 ******/
function return_dir_as_array($dir, $filter_regex = '') {
	$dir_array = array();
	if (is_dir($dir)) {
		if ($dh = opendir($dir)) {
			while (($file = readdir($dh)) !== false) {
				if (($file == ".") || ($file == ".."))
					continue;

				if (empty($filter_regex) || preg_match($filter_regex, $file))
					array_push($dir_array, $file);
			}
			closedir($dh);
		}
	}
	return $dir_array;
}

/*
 * get_sysctl($names)
 * Get values of sysctl OID's listed in $names (accepts an array or a single
 * name) and return an array of key/value pairs set for those that exist
 */
function get_sysctl($names) {
	if (empty($names))
		return array();

	if (is_array($names)) {
		$name_list = array();
		foreach ($names as $name) {
			$name_list[] = escapeshellarg($name);
		}
	} else
		$name_list = array(escapeshellarg($names));

	exec("/sbin/sysctl -i " . implode(" ", $name_list), $output);
	$values = array();
	foreach ($output as $line) {
		$line = explode(": ", $line, 2);
		if (count($line) == 2)
			$values[$line[0]] = $line[1];
	}

	return $values;
}

/*
 * get_single_sysctl($name)
 * Wrapper for get_sysctl() to simplify read of a single sysctl value
 * return the value for sysctl $name or empty string if it doesn't exist
 */
function get_single_sysctl($name) {
	if (empty($name))
		return "";

	$value = get_sysctl($name);
	if (empty($value) || !isset($value[$name]))
		return "";

	return $value[$name];
}

/*
 * set_sysctl($value_list)
 * Set sysctl OID's listed as key/value pairs and return
 * an array with keys set for those that succeeded
 */
function set_sysctl($values) {
	if (empty($values))
		return array();

	$value_list = array();
	foreach ($values as $key => $value) {
		$value_list[] = escapeshellarg($key) . "=" . escapeshellarg($value);
	}

	exec("/sbin/sysctl -i " . implode(" ", $value_list), $output, $success);

	/* Retry individually if failed (one or more read-only) */
	if ($success <> 0 && count($value_list) > 1) {
		foreach ($value_list as $value) {
			exec("/sbin/sysctl -i " . $value, $output);
		}
	}

	$ret = array();
	foreach ($output as $line) {
		$line = explode(": ", $line, 2);
		if (count($line) == 2)
			$ret[$line[0]] = true;
	}

	return $ret;
}

/*
 * set_single_sysctl($name, $value)
 * Wrapper to set_sysctl() to make it simple to set only one sysctl
 * returns boolean meaning if it suceed
 */
function set_single_sysctl($name, $value) {
	if (empty($name))
		return false;

	$result = set_sysctl(array($name => $value));

	if (!isset($result[$name]) || $result[$name] != $value)
		return false;

	return true;
}

1244 1245
function mute_kernel_msgs()
{
Ad Schellevis's avatar
Ad Schellevis committed
1246
	global $config;
1247

1248
	if (isset($config['system']['enableserial'])) {
Ad Schellevis's avatar
Ad Schellevis committed
1249
		return;
1250 1251 1252
	}

	exec('/sbin/conscontrol mute on');
Ad Schellevis's avatar
Ad Schellevis committed
1253 1254
}

1255 1256 1257
function unmute_kernel_msgs()
{
	exec('/sbin/conscontrol mute off');
Ad Schellevis's avatar
Ad Schellevis committed
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
}

/****f* util/isAjax
 * NAME
 *   isAjax - reports if the request is driven from prototype
 * INPUTS
 *   none
 * RESULT
 *   true/false
 ******/
function isAjax() {
	return isset ($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest';
}

/****f* util/msort
 * NAME
 *   msort - sort array
 * INPUTS
 *   $array to be sorted, field to sort by, direction of sort
 * RESULT
 *   returns newly sorted array
 ******/
function msort($array, $id="id", $sort_ascending=true) {
	$temp_array = array();
	while(count($array)>0) {
		$lowest_id = 0;
		$index=0;
		foreach ($array as $item) {
			if (isset($item[$id])) {
				if ($array[$lowest_id][$id]) {
					if (strtolower($item[$id]) < strtolower($array[$lowest_id][$id])) {
						$lowest_id = $index;
					}
				}
			}
			$index++;
		}
		$temp_array[] = $array[$lowest_id];
		$array = array_merge(array_slice($array, 0,$lowest_id), array_slice($array, $lowest_id+1));
	}
	if ($sort_ascending) {
		return $temp_array;
	} else {
		return array_reverse($temp_array);
	}
}

/****f* util/is_URL
 * NAME
 *   is_URL
 * INPUTS
 *   string to check
 * RESULT
 *   Returns true if item is a URL
 ******/
function is_URL($url) {
	$match = preg_match("'\b(([\w-]+://?|www[.])[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|/)))'", $url);
	if($match)
		return true;
	return false;
}

1320 1321
function get_staticroutes($returnsubnetsonly = false, $returnhostnames = false)
{
Ad Schellevis's avatar
Ad Schellevis committed
1322 1323 1324
	global $config, $aliastable;

	/* Bail if there are no routes, but return an array always so callers don't have to check. */
1325
	if (!isset($config['staticroutes']['route'])) {
Ad Schellevis's avatar
Ad Schellevis committed
1326
		return array();
1327
	}
Ad Schellevis's avatar
Ad Schellevis committed
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373

	$allstaticroutes = array();
	$allsubnets = array();
	/* Loop through routes and expand aliases as we find them. */
	foreach ($config['staticroutes']['route'] as $route) {
		if (is_alias($route['network'])) {
			if (!isset($aliastable[$route['network']]))
				continue;

			$subnets = preg_split('/\s+/', $aliastable[$route['network']]);
			foreach ($subnets as $net) {
				if (!is_subnet($net)) {
					if (is_ipaddrv4($net))
						$net .= "/32";
					else if (is_ipaddrv6($net))
						$net .= "/128";
					else if ($returnhostnames === false || !is_fqdn($net))
						continue;
				}
				$temproute = $route;
				$temproute['network'] = $net;
				$allstaticroutes[] = $temproute;
				$allsubnets[] = $net;
			}
		} elseif (is_subnet($route['network'])) {
			$allstaticroutes[] = $route;
			$allsubnets[] = $route['network'];
		}
	}
	if ($returnsubnetsonly)
		return $allsubnets;
	else
		return $allstaticroutes;
}

/****f* util/get_alias_list
 * NAME
 *   get_alias_list - Provide a list of aliases.
 * INPUTS
 *   $type          - Optional, can be a string or array specifying what type(s) of aliases you need.
 * RESULT
 *   Array containing list of aliases.
 *   If $type is unspecified, all aliases are returned.
 *   If $type is a string, all aliases of the type specified in $type are returned.
 *   If $type is an array, all aliases of any type specified in any element of $type are returned.
 */
1374 1375
function get_alias_list($type = null)
{
Ad Schellevis's avatar
Ad Schellevis committed
1376
	global $config;
1377

Ad Schellevis's avatar
Ad Schellevis committed
1378
	$result = array();
1379 1380

	if (isset($config['aliases']['alias'])) {
Ad Schellevis's avatar
Ad Schellevis committed
1381 1382 1383
		foreach ($config['aliases']['alias'] as $alias) {
			if ($type === null) {
				$result[] = $alias['name'];
1384
			} elseif (is_array($type)) {
Ad Schellevis's avatar
Ad Schellevis committed
1385 1386 1387
				if (in_array($alias['type'], $type)) {
					$result[] = $alias['name'];
				}
1388
			} elseif ($type === $alias['type']) {
Ad Schellevis's avatar
Ad Schellevis committed
1389 1390 1391 1392
				$result[] = $alias['name'];
			}
		}
	}
1393

Ad Schellevis's avatar
Ad Schellevis committed
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
	return $result;
}

/* Define what is preferred, IPv4 or IPv6 */
function prefer_ipv4_or_ipv6() {
	global $config;

	if (isset($config['system']['prefer_ipv4']))
		mwexec("/etc/rc.d/ip6addrctl prefer_ipv4");
	else
		mwexec("/etc/rc.d/ip6addrctl prefer_ipv6");
}

/* Redirect to page passing parameters via POST */
function post_redirect($page, $params) {
	if (!is_array($params))
		return;

	print "<html><body><form action=\"{$page}\" name=\"formredir\" method=\"post\">\n";
	foreach ($params as $key => $value) {
		print "<input type=\"hidden\" name=\"{$key}\" value=\"{$value}\" />\n";
	}
	print "</form><script type=\"text/javascript\">document.formredir.submit();</script>\n";
	print "</body></html>\n";
}