pfSense

<?php 

/*

	util.inc

	part of the pfSense project (http://www.pfsense.com)

	originally part of m0n0wall (http://m0n0.ch/wall)

	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.

*/

/*

	pfSense_BUILDER_BINARIES:	/bin/ps	/bin/kill	/usr/bin/killall	/sbin/ifconfig	/usr/bin/netstat

	pfSense_BUILDER_BINARIES:	/usr/bin/awk	/sbin/dmesg		/sbin/ping /usr/local/sbin/gzsig	/usr/sbin/arp

	pfSense_BUILDER_BINARIES:	/sbin/conscontrol	/sbin/devd	/bin/ps

	pfSense_MODULE:	utils

*/

/* kill a process by pid file */

function killbypid($pidfile) {

	sigkillbypid($pidfile, "TERM");

}

function isvalidpid($pid) {

	$running = `ps -p $pid | wc -l`;

	if(intval($running) > 1)

		return true;

	else 

		return false;

}

function is_process_running($process) {

        $running = (trim(shell_exec("ps axwu | grep '\b{$process}\b' | grep -v 'grep'")) != '');

        return $running;

}

function isvalidproc($proc) {

	$running = is_process_running($proc);

	if (intval($running) >= 1)

		return true;

	else 

		return false;

}

/* sigkill a process by pid file */

/* return 1 for success and 0 for a failure */

function sigkillbypid($pidfile, $sig) {

	if (is_file($pidfile)) {

		$pid = trim(file_get_contents($pidfile));

		if(isvalidpid($pid))

			return mwexec("/bin/kill -s $sig {$pid}", true);

	}

	return 0;

}

/* kill a process by name */

function sigkillbyname($procname, $sig) {

	if(isvalidproc($procname))

		return mwexec("/usr/bin/killall -{$sig} " . escapeshellarg($procname), true);

}

/* kill a process by name */

function killbyname($procname) {

	if(isvalidproc($procname)) 

		mwexec("/usr/bin/killall " . escapeshellarg($procname));

}

function is_subsystem_dirty($subsystem = "") {

	global $g;

	if ($subsystem == "")

		return false;

	if (file_exists("{$g['varrun_path']}/{$subsystem}.dirty"))

		return true;

	return false;

}

function mark_subsystem_dirty($subsystem = "") {

	global $g;

	if (!file_put_contents("{$g['varrun_path']}/{$subsystem}.dirty", "DIRTY"))

		log_error("WARNING: Could not mark subsystem: {$subsytem} dirty");

}

function clear_subsystem_dirty($subsystem = "") {

	global $g;

	@unlink("{$g['varrun_path']}/{$subsystem}.dirty");

}

function config_lock() {

	return;

}

function config_unlock() {

	return;

}

/* lock configuration file */

function lock($lock) {

	global $g, $cfglckkeyconsumers;

	if (!$lock)

		die("WARNING: You must give a name as parameter to lock() function.");

	if (!file_exists("{$g['tmp_path']}/{$lock}.lock"))

		@touch("{$g['tmp_path']}/{$lock}.lock");

	$cfglckkeyconsumers++;

	if ($fp = fopen("{$g['tmp_path']}/{$lock}.lock", "w+")) {

		if (flock($fp, LOCK_EX))

			return $fp;

		else

			fclose($fp);

	}

}

/* unlock configuration file */

function unlock($cfglckkey = 0) {

	global $g, $cfglckkeyconsumers;

	flock($cfglckkey, LOCK_UN);

	fclose($cfglckkey);

	return;

}

function is_module_loaded($module_name) {

	$running = `/sbin/kldstat | grep {$module_name} | /usr/bin/grep -v grep | /usr/bin/wc -l`;

	if (intval($running) >= 1)

		return true;

	else

		return false;

}

/* 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 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 long2ip(ip2long($ipaddr) | ~gen_subnet_mask_long($bits));

}

/* 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));

}

function is_numericint($arg) {

	return (preg_match("/[^0-9]/", $arg) ? false : true);

}

/* returns true if $ipaddr is a valid dotted IPv4 address */

function is_ipaddr($ipaddr) {

	if (!is_string($ipaddr))

		return false;

	$ip_long = ip2long($ipaddr);

	$ip_reverse = long2ip($ip_long);

	if ($ipaddr == $ip_reverse)

		return true;

	else

		return false;

}

/* returns true if $ipaddr is a valid dotted IPv4 address or an alias thereof */

function is_ipaddroralias($ipaddr) {

	global $config;

	if (is_alias($ipaddr)) {

		if (is_array($config['aliases']['alias'])) {

			foreach ($config['aliases']['alias'] as $alias) {

                        	if ($alias['name'] == $ipaddr && $alias['type'] != "port")

					return true;

			}

                }

		return false;

	} else

		return is_ipaddr($ipaddr);

}

/* returns true if $subnet is a valid subnet in CIDR format */

function is_subnet($subnet) {

	if (!is_string($subnet))

		return false;

	list($hp,$np) = explode('/', $subnet);

	if (!is_ipaddr($hp))

		return false;

	if (!is_numeric($np) || ($np < 1) || ($np > 32))

		return false;

	return true;

}

/* returns true if $subnet is a valid subnet in CIDR format or an alias thereof */

function is_subnetoralias($subnet) {

	global $aliastable;

	if (isset($aliastable[$subnet]) && is_subnet($aliastable[$subnet]))

		return true;

	else

		return is_subnet($subnet);

}

/* returns true if $hostname is a valid hostname */

function is_hostname($hostname) {

	if (!is_string($hostname))

		return false;

	if (preg_match("/^([_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\-]+\.?)+$/i", $domain))

		return true;

	else

		return false;

}

/* returns true if $macaddr is a valid MAC address */

function is_macaddr($macaddr) {

	if (!is_string($macaddr))

		return false;

	$maca = explode(":", $macaddr);

	if (count($maca) != 6)

		return false;

	foreach ($maca as $macel) {

		if (($macel === "") || (strlen($macel) > 2))

			return false;

		if (preg_match("/[^0-9a-f]/i", $macel))

			return false;

	}

	return true;

}

/* returns true if $name is a valid name for an alias */

/* returns NULL if a reserved word is used */

function is_validaliasname($name) {

	/* Array of reserved words */

	$reserved = array("port", "pass");

	if (in_array($name, $reserved, true))

		return; /* return NULL */

	if (!preg_match("/[^a-zA-Z0-9_]/", $name))

		return true;

	else

		return false;

}

/* returns true if $port is a valid TCP/UDP port */

function is_port($port) {

	if ((intval($port) < 1) || (intval($port) > 65535))

		return false;

	else

		return true;

}

/* returns true if $portrange is a valid TCP/UDP portrange ("<port>:<port>") */

function is_portrange($portrange) {

        $ports = explode(":", $portrange);

        if(count($ports) == 2 && is_port($ports[0]) && is_port($ports[1]))

                return true;

        else

                return false;

}

/* returns true if $port is a valid port number or an alias thereof */

function is_portoralias($port) {

	global $config;

        if (is_alias($port)) {

                if (is_array($config['aliases']['alias'])) {

                        foreach ($config['aliases']['alias'] as $alias) {

                                if ($alias['name'] == $port && $alias['type'] == "port")

                                        return true;

                        }

                }

                return false;

        } else

                return is_port($port);

}

/* returns true if $val is a valid shaper bandwidth value */

function is_valid_shaperbw($val) {

	return (preg_match("/^(\d+(?:\.\d+)?)([MKG]?b|%)$/", $val));

}

/* return the configured carp interface list */

function get_configured_carp_interface_list() {

	global $config;

	$iflist = array();

	if(is_array($config['virtualip']['vip'])) {

                $viparr = &$config['virtualip']['vip'];

                foreach ($viparr as $vip) {

                        switch ($vip['mode']) {

                        case "carp":

                        case "carpdev-dhcp":

				$vipif = "vip" . $vip['vhid'];

                        	$iflist[$vipif] = $vip['subnet'];

                                break;

                        }

                }

        }

	return $iflist;

}

/* return the configured interfaces list. */

function get_configured_interface_list($only_opt = false, $withdisabled = false) {

	global $config;

	$iflist = array();

	if (!$only_opt) {

		if (isset($config['interfaces']['wan']))

			$iflist['wan'] = "wan";

		if (isset($config['interfaces']['lan']))

			$iflist['lan'] = "lan";

	}

	/* if list */

        foreach($config['interfaces'] as $if => $ifdetail) {

		if ($if == "wan" || $if == "lan")

			continue;

		if (isset($ifdetail['enable']) || $withdisabled == true)

			$iflist[$if] = $if;

	}

	return $iflist;

}

/* return the configured interfaces list. */

function get_configured_interface_list_by_realif($only_opt = false, $withdisabled = false) {

        global $config;

        $iflist = array();

        if (!$only_opt) {

                if (isset($config['interfaces']['wan'])) {

			$tmpif = get_real_interface("wan");

			if (!empty($tmpif))

				$iflist[$tmpif] = "wan";

		}

                if (isset($config['interfaces']['lan'])) {

			$tmpif = get_real_interface("lan");

			if (!empty($tmpif))

				$iflist[$tmpif] = "lan";

		}

        }

        /* if list */

        foreach($config['interfaces'] as $if => $ifdetail) {

                if ($if == "wan" || $if == "lan")

                        continue;

                if (isset($ifdetail['enable']) || $withdisabled == true) {

			$tmpif = get_real_interface($if);

			if (!empty($tmpif))

				$iflist[$tmpif] = $if;

		}

        }

        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 (!$only_opt) {

		if (isset($config['interfaces']['wan'])) {

			if (empty($config['interfaces']['wan']['descr']))

				$iflist['wan'] = "WAN";

			else

				$iflist['wan'] = strtoupper($config['interfaces']['wan']['descr']);

		}

		if (isset($config['interfaces']['lan'])) {

			if (empty($config['interfaces']['lan']['descr']))

				$iflist['lan'] = "LAN";

			else

				$iflist['lan'] = strtoupper($config['interfaces']['lan']['descr']);

		}

	}

	/* if list */

	foreach($config['interfaces'] as $if => $ifdetail) {

		if (isset($ifdetail['enable']) || $withdisabled == true) {

			if($ifdetail['descr'] == "")

				$iflist[$if] = strtoupper($if);

			else

				$iflist[$if] = strtoupper($ifdetail['descr']);

		}

	}

	return $iflist;

}

/*

 *   get_interface_list() - Return a list of all physical interfaces

 *   along with MAC and status.

 *

 *   $mode = "active" - use ifconfig -lu

 *           "media"  - use ifconfig to check physical connection

 *			status (much slower)

 */

function get_interface_list($mode = "active", $keyby = "physical", $vfaces = "") {

        global $config;

	$upints = array();

        /* get a list of virtual interface types */

        if(!$vfaces) {

		$vfaces = array (

				'bridge',

				'ppp',

				'sl',

				'gif',

				'gre',

				'faith',

				'lo',

				'ng',

				'vlan',

				'pflog',

				'plip',

				'pfsync',

				'enc',

				'tun',

				'carp',

				'lagg',

				'vip'

		);

	}

	switch($mode) {

	case "active":

                $upints = explode(" ", trim(shell_exec("/sbin/ifconfig -lu")));

        	break;

	case "media":

                $intlist = explode(" ", trim(shell_exec("/sbin/ifconfig -l")));

                $ifconfig = "";

                exec("/sbin/ifconfig -a", $ifconfig);

                $regexp = '/(' . implode('|', $intlist) . '):\s/';

                $ifstatus = preg_grep('/status:/', $ifconfig);

		foreach($ifstatus as $status) {

			$int = array_shift($intlist);

                	if(stristr($status, "active")) $upints[] = $int;

		}

		break;

	}

        /* build interface list with netstat */

        $linkinfo = "";

        exec("/usr/bin/netstat -inW -f link | awk '{ print $1, $4 }'", $linkinfo);

        array_shift($linkinfo);

	/* build ip address list with netstat */

	$ipinfo = "";

	exec("/usr/bin/netstat -inW -f inet | awk '{ print $1, $4 }'", $ipinfo);

	array_shift($ipinfo);

	foreach($linkinfo as $link) {

		$friendly = "";

                $alink = explode(" ", $link);

                $ifname = rtrim(trim($alink[0]), '*');

                /* trim out all numbers before checking for vfaces */

		if (!in_array(array_shift(preg_split('/\d/', $ifname)), $vfaces) &&

			!stristr($ifname, "_vl")) {

			$toput = array(

					"mac" => trim($alink[1]),

					"up" => in_array($ifname, $upints)

				);

			foreach($ipinfo as $ip) {

				$aip = explode(" ", $ip);

				if($aip[0] == $ifname) {

					$toput['ipaddr'] = $aip[1];

				}

			}

			foreach($config['interfaces'] as $name => $int) {

				if($int['if'] == $ifname) $friendly = $name;

			}

			switch($keyby) {

			case "physical":

				if($friendly != "") {

					$toput['friendly'] = $friendly;

				}

				$dmesg_arr = array();

				exec("/sbin/dmesg |grep $ifname | head -n1", $dmesg_arr);

				preg_match_all("/<(.*?)>/i", $dmesg_arr[0], $dmesg);

				$toput['dmesg'] = $dmesg[1][0];

				$iflist[$ifname] = $toput;

				break;

			case "ppp":

			case "friendly":

				if($friendly != "") {

					$toput['if'] = $ifname;

					$iflist[$friendly] = $toput;

				}

				break;

			}

                }

        }

        return $iflist;

}

/****f* util/log_error

* NAME

*   log_error  - Sends a string to syslog.

* INPUTS

*   $error     - string containing the syslog message.

* RESULT

*   null

******/

function log_error($error) {

        global $g;

        $page = $_SERVER['SCRIPT_NAME'];

        syslog(LOG_WARNING, "$page: $error");

        if ($g['debug'])

                syslog(LOG_WARNING, var_dump(debug_backtrace()));

        return;

}

/****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));

}

/* wrapper for exec() */

function mwexec($command, $mute = false) {

	global $g;

	$oarr = array();

	$retval = 0;

	if ($g['debug']) {

		if (!$_SERVER['REMOTE_ADDR'])

			echo "mwexec(): $command\n";

		exec("$command 2>&1", $oarr, $retval);

	} else {

		exec("$command 2>&1", $oarr, $retval);

	}

	if(isset($config['system']['developerspew']))

                $mute = false;

	if(($retval <> 0) && ($mute === false)) {

		$output = implode(" ", $oarr);

		log_error("The command '$command' returned exit code '$retval', the output was '$output' ");

	}

	return $retval;

}

/* wrapper for exec() in background */

function mwexec_bg($command) {

	global $g;

	if ($g['debug']) {

		if (!$_SERVER['REMOTE_ADDR'])

			echo "mwexec(): $command\n";

	}

	exec("nohup $command > /dev/null 2>&1 &");

}

/* unlink a file, if it exists */

function unlink_if_exists($fn) {

	$to_do = glob($fn);

	if(is_array($to_do)) {

		foreach($to_do as $filename)

			@unlink($filename);

	} else {

		@unlink($fn);

	}

}

/* make a global alias table (for faster lookups) */

function alias_make_table($config) {

	global $aliastable;

	$aliastable = array();

	if (is_array($config['aliases']['alias'])) {

		foreach ($config['aliases']['alias'] as $alias) {

			if ($alias['name'])

				$aliastable[$alias['name']] = $alias['address'];

		}

	}

}

/* check if an alias exists */

function is_alias($name) {

	global $aliastable;

	return isset($aliastable[$name]);

}

/* 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))

		return "{$name}";

	else

		return null;

}

/* 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);

	if ($sn1 == $sn2)

		return true;

	else

		return false;

}

/* compare two IP addresses */

function ipcmp($a, $b) {

	if (ip2long($a) < ip2long($b))

		return -1;

	else if (ip2long($a) > ip2long($b))

		return 1;

	else

		return 0;

}

/* return true if $addr is in $subnet, false if not */

function ip_in_subnet($addr,$subnet) {

	list($ip, $mask) = explode('/', $subnet);

	$mask = 0xffffffff << (32 - $mask);

	return ((ip2long($addr) & $mask) == (ip2long($ip) & $mask));

}

/* verify (and remove) the digital signature on a file - returns 0 if OK */

function verify_digital_signature($fname) {

	global $g;

	if(!file_exists("/usr/local/sbin/gzsig"))

		return 1;

	return mwexec("/usr/local/sbin/gzsig verify {$g['etc_path']}/pubkey.pem < " . escapeshellarg($fname));

}

/* obtain MAC address given an IP address by looking at the ARP table */

function arp_get_mac_by_ip($ip) {

	mwexec("/sbin/ping -c 1 -t 1 {$ip}", true);

	$arpoutput = "";

	exec("/usr/sbin/arp -n {$ip}", $arpoutput);

	if ($arpoutput[0]) {

		$arpi = explode(" ", $arpoutput[0]);

		$macaddr = $arpi[3];

		if (is_macaddr($macaddr))

			return $macaddr;

		else

			return false;

	}

	return false;

}

/* return a fieldname that is safe for xml usage */

function xml_safe_fieldname($fieldname) {

	$replace = array('/', '-', ' ', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',

			 '_', '+', '=', '{', '}', '[', ']', '|', '/', '<', '>', '?',

			 ':', ',', '.', '\'', '\\'

		);

	return strtolower(str_replace($replace, "", $fieldname));

}

function mac_format($clientmac) {

    $mac =explode(":", $clientmac);

    global $config;

    $mac_format = $config['captiveportal']['radmac_format'] ? $config['captiveportal']['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++) {

               $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);

	}

}

function update_filter_reload_status($text) {

        global $g;

        file_put_contents("{$g['varrun_path']}/filter_reload_status", $text);

}

/****f* 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.

 * 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) {

        $dir_array = array();

        if (is_dir($dir)) {

                if ($dh = opendir($dir)) {

                        while (($file = readdir($dh)) !== false) {

                                $canadd = 0;

                                if($file == ".") $canadd = 1;

                                if($file == "..") $canadd = 1;

                                if($canadd == 0)

                                        array_push($dir_array, $file);

                        }

                        closedir($dh);

                }

        }

        return $dir_array;

}

function run_plugins($directory) {

        global $config, $g;

		/* process packager manager custom rules */

		$files = return_dir_as_array($directory);

		if (is_array($files)) {

			foreach ($files as $file) {

				if (stristr($file, ".sh") == true)

					mwexec($directory . $file . " start");

				else if (!is_dir($directory . "/" . $file) && stristr($file,".inc")) 

					require_once($directory . "/" . $file);

			}

		}

}

/*

 *    safe_mkdir($path, $mode = 0755)

 *    create directory if it doesn't already exist and isn't a file!

 */

function safe_mkdir($path, $mode=0755) {

        global $g;

        if (!is_file($path) && !is_dir($path)) {

                return @mkdir($path, $mode);

        } else {

                return false;

        }

}

/*

 * make_dirs($path, $mode = 0755)

 * create directory tree recursively (mkdir -p)

 */

function make_dirs($path, $mode = 0755) {

        $base = '';

        foreach (explode('/', $path) as $dir) {