Project

General

Profile

Download (65 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/****h* pfSense/pfsense-utils
3
 * NAME
4
 *   pfsense-utils.inc - Utilities specific to pfSense
5
 * DESCRIPTION
6
 *   This include contains various pfSense specific functions.
7
 * HISTORY
8
 *   $Id$
9
 ******
10
 *
11
 * Copyright (C) 2004-2007 Scott Ullrich (sullrich@gmail.com)
12
 * All rights reserved.
13
 * Redistribution and use in source and binary forms, with or without
14
 * modification, are permitted provided that the following conditions are met:
15
 *
16
 * 1. Redistributions of source code must retain the above copyright notice,
17
 * this list of conditions and the following disclaimer.
18
 *
19
 * 2. Redistributions in binary form must reproduce the above copyright
20
 * notice, this list of conditions and the following disclaimer in the
21
 * documentation and/or other materials provided with the distribution.
22
 *
23
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
24
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
25
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26
 * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
27
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31
 * RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32
 * POSSIBILITY OF SUCH DAMAGE.
33
 *
34
 */
35

    
36
/*
37
	pfSense_BUILDER_BINARIES:	/sbin/sysctl	/sbin/ifconfig	/sbin/pfctl	/usr/local/bin/php /usr/bin/netstat
38
	pfSense_BUILDER_BINARIES:	/bin/df	/usr/bin/grep	/usr/bin/awk	/bin/rm	/usr/sbin/pwd_mkdb	/usr/bin/host
39
	pfSense_BUILDER_BINARIES:	/sbin/kldload
40
	pfSense_MODULE:	utils
41
*/
42

    
43
/****f* pfsense-utils/have_natonetooneruleint_access
44
 * NAME
45
 *   have_natonetooneruleint_access
46
 * INPUTS
47
 *	 none
48
 * RESULT
49
 *   returns true if user has access to edit a specific firewall nat one to one interface
50
 ******/
51
function have_natonetooneruleint_access($if) {
52
	$security_url = "firewall_nat_1to1_edit.php?if=". strtolower($if);
53
	if(isAllowedPage($security_url, $_SESSION['Username'])) 
54
		return true;
55
	return false;
56
}
57

    
58
/****f* pfsense-utils/have_natpfruleint_access
59
 * NAME
60
 *   have_natpfruleint_access
61
 * INPUTS
62
 *	 none
63
 * RESULT
64
 *   returns true if user has access to edit a specific firewall nat port forward interface
65
 ******/
66
function have_natpfruleint_access($if) {
67
	$security_url = "firewall_nat_edit.php?if=". strtolower($if);
68
	if(isAllowedPage($security_url, $allowed)) 
69
		return true;
70
	return false;
71
}
72

    
73
/****f* pfsense-utils/have_ruleint_access
74
 * NAME
75
 *   have_ruleint_access
76
 * INPUTS
77
 *	 none
78
 * RESULT
79
 *   returns true if user has access to edit a specific firewall interface
80
 ******/
81
function have_ruleint_access($if) {
82
	$security_url = "firewall_rules.php?if=". strtolower($if);
83
	if(isAllowedPage($security_url)) 
84
		return true;
85
	return false;
86
}
87

    
88
/****f* pfsense-utils/does_url_exist
89
 * NAME
90
 *   does_url_exist
91
 * INPUTS
92
 *	 none
93
 * RESULT
94
 *   returns true if a url is available
95
 ******/
96
function does_url_exist($url) {
97
	$fd = fopen("$url","r");
98
	if($fd) {
99
		fclose($fd);
100
   		return true;    
101
	} else {
102
        return false;
103
	}
104
}
105

    
106
/****f* pfsense-utils/is_private_ip
107
 * NAME
108
 *   is_private_ip
109
 * INPUTS
110
 *	 none
111
 * RESULT
112
 *   returns true if an ip address is in a private range
113
 ******/
114
function is_private_ip($iptocheck) {
115
        $isprivate = false;
116
        $ip_private_list=array(
117
               "10.0.0.0/8",
118
               "172.16.0.0/12",
119
               "192.168.0.0/16",
120
               "99.0.0.0/8"
121
        );
122
        foreach($ip_private_list as $private) {
123
                if(ip_in_subnet($iptocheck,$private)==true)
124
                        $isprivate = true;
125
        }
126
        return $isprivate;
127
}
128

    
129
/****f* pfsense-utils/get_tmp_file
130
 * NAME
131
 *   get_tmp_file
132
 * INPUTS
133
 *	 none
134
 * RESULT
135
 *   returns a temporary filename
136
 ******/
137
function get_tmp_file() {
138
	global $g;
139
	return "{$g['tmp_path']}/tmp-" . time();
140
}
141

    
142
/****f* pfsense-utils/get_dns_servers
143
 * NAME
144
 *   get_dns_servres - get system dns servers
145
 * INPUTS
146
 *   $dns_servers - an array of the dns servers
147
 * RESULT
148
 *   null
149
 ******/
150
function get_dns_servers() {
151
	$dns_servers = array();
152
	$dns_s = file("/etc/resolv.conf", FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
153
	foreach($dns_s as $dns) {
154
		$matches = "";
155
		if (preg_match("/nameserver (.*)/", $dns, $matches))
156
			$dns_servers[] = $matches[1];
157
	}
158
	return array_unique($dns_servers);
159
}
160

    
161
/****f* pfsense-utils/enable_hardware_offloading
162
 * NAME
163
 *   enable_hardware_offloading - Enable a NIC's supported hardware features.
164
 * INPUTS
165
 *   $interface	- string containing the physical interface to work on.
166
 * RESULT
167
 *   null
168
 * NOTES
169
 *   This function only supports the fxp driver's loadable microcode.
170
 ******/
171
function enable_hardware_offloading($interface) {
172
	global $g, $config;
173

    
174
	if(isset($config['system']['do_not_use_nic_microcode']))
175
		return;
176

    
177
	/* translate wan, lan, opt -> real interface if needed */
178
	$int = get_real_interface($interface);
179
	if(empty($int)) 
180
		return;
181
	$int_family = preg_split("/[0-9]+/", $int);
182
	$supported_ints = array('fxp');
183
	if (in_array($int_family, $supported_ints)) {
184
		if(does_interface_exist($int)) 
185
			pfSense_interface_flags($int, IFF_LINK0);
186
	}
187

    
188
	return;
189
}
190

    
191
/****f* pfsense-utils/interface_supports_polling
192
 * NAME
193
 *   checks to see if an interface supports polling according to man polling
194
 * INPUTS
195
 *
196
 * RESULT
197
 *   true or false
198
 * NOTES
199
 *
200
 ******/
201
function interface_supports_polling($iface) {
202
	$opts = pfSense_get_interface_addresses($iface);
203
	if (is_array($opts) && isset($opts['caps']['polling']))
204
		return true;
205

    
206
	return false;
207
}
208

    
209
/****f* pfsense-utils/is_alias_inuse
210
 * NAME
211
 *   checks to see if an alias is currently in use by a rule
212
 * INPUTS
213
 *
214
 * RESULT
215
 *   true or false
216
 * NOTES
217
 *
218
 ******/
219
function is_alias_inuse($alias) {
220
	global $g, $config;
221

    
222
	if($alias == "") return false;
223
	/* loop through firewall rules looking for alias in use */
224
	if(is_array($config['filter']['rule']))
225
		foreach($config['filter']['rule'] as $rule) {
226
			if($rule['source']['address'])
227
				if($rule['source']['address'] == $alias)
228
					return true;
229
			if($rule['destination']['address'])
230
				if($rule['destination']['address'] == $alias)
231
					return true;
232
		}
233
	/* loop through nat rules looking for alias in use */
234
	if(is_array($config['nat']['rule']))
235
		foreach($config['nat']['rule'] as $rule) {
236
			if($rule['target'] && $rule['target'] == $alias)
237
				return true;
238
			if($rule['source']['address'] && $rule['source']['address'] == $alias)
239
				return true;
240
			if($rule['destination']['address'] && $rule['destination']['address'] == $alias)
241
				return true;
242
		}
243
	return false;
244
}
245

    
246
/****f* pfsense-utils/is_schedule_inuse
247
 * NAME
248
 *   checks to see if a schedule is currently in use by a rule
249
 * INPUTS
250
 *
251
 * RESULT
252
 *   true or false
253
 * NOTES
254
 *
255
 ******/
256
function is_schedule_inuse($schedule) {
257
	global $g, $config;
258

    
259
	if($schedule == "") return false;
260
	/* loop through firewall rules looking for schedule in use */
261
	if(is_array($config['filter']['rule']))
262
		foreach($config['filter']['rule'] as $rule) {
263
			if($rule['sched'] == $schedule)
264
				return true;
265
		}
266
	return false;
267
}
268

    
269
/****f* pfsense-utils/setup_polling
270
 * NAME
271
 *   sets up polling
272
 * INPUTS
273
 *
274
 * RESULT
275
 *   null
276
 * NOTES
277
 *
278
 ******/
279
function setup_polling() {
280
	global $g, $config;
281

    
282
	if (isset($config['system']['polling']))
283
		mwexec("/sbin/sysctl kern.polling.idle_poll=1");
284
	else
285
		mwexec("/sbin/sysctl kern.polling.idle_poll=0");
286

    
287
	if($config['system']['polling_each_burst'])
288
		mwexec("/sbin/sysctl kern.polling.each_burst={$config['system']['polling_each_burst']}");
289
	if($config['system']['polling_burst_max'])
290
		mwexec("/sbin/sysctl kern.polling.burst_max={$config['system']['polling_burst_max']}");
291
	if($config['system']['polling_user_frac'])
292
		mwexec("/sbin/sysctl kern.polling.user_frac={$config['system']['polling_user_frac']}");
293
}
294

    
295
/****f* pfsense-utils/setup_microcode
296
 * NAME
297
 *   enumerates all interfaces and calls enable_hardware_offloading which
298
 *   enables a NIC's supported hardware features.
299
 * INPUTS
300
 *
301
 * RESULT
302
 *   null
303
 * NOTES
304
 *   This function only supports the fxp driver's loadable microcode.
305
 ******/
306
function setup_microcode() {
307

    
308
	/* if list */
309
	$ifs = get_interface_arr();
310

    
311
	foreach($ifs as $if)
312
		enable_hardware_offloading($if);
313
}
314

    
315
/****f* pfsense-utils/get_carp_status
316
 * NAME
317
 *   get_carp_status - Return whether CARP is enabled or disabled.
318
 * RESULT
319
 *   boolean	- true if CARP is enabled, false if otherwise.
320
 ******/
321
function get_carp_status() {
322
    /* grab the current status of carp */
323
    $status = `/sbin/sysctl -n net.inet.carp.allow`;
324
    return (intval($status) > 0);
325
}
326

    
327
/*
328
 * convert_ip_to_network_format($ip, $subnet): converts an ip address to network form
329

    
330
 */
331
function convert_ip_to_network_format($ip, $subnet) {
332
	$ipsplit = split('[.]', $ip);
333
	$string = $ipsplit[0] . "." . $ipsplit[1] . "." . $ipsplit[2] . ".0/" . $subnet;
334
	return $string;
335
}
336

    
337
/*
338
 * get_carp_interface_status($carpinterface): returns the status of a carp ip
339
 */
340
function get_carp_interface_status($carpinterface) {
341
	$carp_query = "";
342
	exec("/sbin/ifconfig $carpinterface | /usr/bin/grep -v grep | /usr/bin/grep carp:", $carp_query);
343
	foreach($carp_query as $int) {
344
		if(stristr($int, "MASTER")) 
345
			return "MASTER";
346
		if(stristr($int, "BACKUP")) 
347
			return "BACKUP";
348
		if(stristr($int, "INIT")) 
349
			return "INIT";
350
	}
351
	return;
352
}
353

    
354
/*
355
 * get_pfsync_interface_status($pfsyncinterface): returns the status of a pfsync
356
 */
357
function get_pfsync_interface_status($pfsyncinterface) {
358
    $result = does_interface_exist($pfsyncinterface);
359
    if($result <> true) return;
360
    $status = exec_command("/sbin/ifconfig {$pfsyncinterface} | /usr/bin/awk '/pfsync:/ {print \$5}'");
361
    return $status;
362
}
363

    
364
/*
365
 * add_rule_to_anchor($anchor, $rule): adds the specified rule to an anchor
366
 */
367
function add_rule_to_anchor($anchor, $rule, $label) {
368
	mwexec("echo " . $rule . " | /sbin/pfctl -a " . $anchor . ":" . $label . " -f -");
369
}
370

    
371
/*
372
 * remove_text_from_file
373
 * remove $text from file $file
374
 */
375
function remove_text_from_file($file, $text) {
376
	if(!file_exists($file) && !is_writable($file))
377
		return;
378
	$filecontents = file_get_contents($file);
379
	$text = str_replace($text, "", $filecontents);
380
	@file_put_contents($file, $text); 
381
}
382

    
383
/*
384
 * add_text_to_file($file, $text): adds $text to $file.
385
 * replaces the text if it already exists.
386
 */
387
function add_text_to_file($file, $text, $replace = false) {
388
	if(file_exists($file) and is_writable($file)) {
389
		$filecontents = file($file);
390
		$filecontents = array_map('rtrim', $filecontents);
391
		array_push($filecontents, $text);
392
		if ($replace)
393
			$filecontents = array_unique($filecontents);
394

    
395
		$file_text = implode("\n", $filecontents);
396

    
397
		@file_put_contents($file, $file_text); 
398
		return true;
399
	}
400
	return false;
401
}
402

    
403
/*
404
 *   after_sync_bump_adv_skew(): create skew values by 1S
405
 */
406
function after_sync_bump_adv_skew() {
407
	global $config, $g;
408
	$processed_skew = 1;
409
	$a_vip = &$config['virtualip']['vip'];
410
	foreach ($a_vip as $vipent) {
411
		if($vipent['advskew'] <> "") {
412
			$processed_skew = 1;
413
			$vipent['advskew'] = $vipent['advskew']+1;
414
		}
415
	}
416
	if($processed_skew == 1)
417
		write_config("After synch increase advertising skew");
418
}
419

    
420
/*
421
 * get_filename_from_url($url): converts a url to its filename.
422
 */
423
function get_filename_from_url($url) {
424
	return basename($url);
425
}
426

    
427
/*
428
 *   get_dir: return an array of $dir
429
 */
430
function get_dir($dir) {
431
	$dir_array = array();
432
	$d = dir($dir);
433
	while (false !== ($entry = $d->read())) {
434
		array_push($dir_array, $entry);
435
	}
436
	$d->close();
437
	return $dir_array;
438
}
439

    
440
/****f* pfsense-utils/WakeOnLan
441
 * NAME
442
 *   WakeOnLan - Wake a machine up using the wake on lan format/protocol
443
 * RESULT
444
 *   true/false - true if the operation was successful
445
 ******/
446
function WakeOnLan($addr, $mac)
447
{
448
	$addr_byte = explode(':', $mac);
449
	$hw_addr = '';
450

    
451
	for ($a=0; $a < 6; $a++)
452
		$hw_addr .= chr(hexdec($addr_byte[$a]));
453

    
454
	$msg = chr(255).chr(255).chr(255).chr(255).chr(255).chr(255);
455

    
456
	for ($a = 1; $a <= 16; $a++)
457
		$msg .= $hw_addr;
458

    
459
	// send it to the broadcast address using UDP
460
	$s = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
461
	if ($s == false) {
462
		log_error("Error creating socket!");
463
		log_error("Error code is '".socket_last_error($s)."' - " . socket_strerror(socket_last_error($s)));
464
	} else {
465
		// setting a broadcast option to socket:
466
		$opt_ret =  socket_set_option($s, 1, 6, TRUE);
467
		if($opt_ret < 0)
468
			log_error("setsockopt() failed, error: " . strerror($opt_ret));
469
		$e = socket_sendto($s, $msg, strlen($msg), 0, $addr, 2050);
470
		socket_close($s);
471
		log_error("Magic Packet sent ({$e}) to {$addr} MAC={$mac}");
472
		return true;
473
	}
474

    
475
	return false;
476
}
477

    
478
/*
479
 * gather_altq_queue_stats():  gather altq queue stats and return an array that
480
 *                             is queuename|qlength|measured_packets
481
 *                             NOTE: this command takes 5 seconds to run
482
 */
483
function gather_altq_queue_stats($dont_return_root_queues) {
484
	exec("/sbin/pfctl -vvsq", $stats_array);
485
	$queue_stats = array();
486
	foreach ($stats_array as $stats_line) {
487
		$match_array = "";
488
		if (preg_match_all("/queue\s+(\w+)\s+/",$stats_line,$match_array))
489
			$queue_name = $match_array[1][0];
490
		if (preg_match_all("/measured:\s+.*packets\/s\,\s(.*)\s+\]/",$stats_line,$match_array))
491
			$speed = $match_array[1][0];
492
		if (preg_match_all("/borrows:\s+(.*)/",$stats_line,$match_array))
493
			$borrows = $match_array[1][0];
494
		if (preg_match_all("/suspends:\s+(.*)/",$stats_line,$match_array))
495
			$suspends = $match_array[1][0];
496
		if (preg_match_all("/dropped pkts:\s+(.*)/",$stats_line,$match_array))
497
			$drops = $match_array[1][0];
498
		if (preg_match_all("/measured:\s+(.*)packets/",$stats_line,$match_array)) {
499
			$measured = $match_array[1][0];
500
			if($dont_return_root_queues == true)
501
				if(stristr($queue_name,"root_") == false)
502
					array_push($queue_stats, "{$queue_name}|{$speed}|{$measured}|{$borrows}|{$suspends}|{$drops}");
503
		}
504
	}
505
	return $queue_stats;
506
}
507

    
508
/*
509
 * reverse_strrchr($haystack, $needle):  Return everything in $haystack up to the *last* instance of $needle.
510
 *					 Useful for finding paths and stripping file extensions.
511
 */
512
function reverse_strrchr($haystack, $needle) {
513
	if (!is_string($haystack))
514
		return;
515
	return strrpos($haystack, $needle) ? substr($haystack, 0, strrpos($haystack, $needle) +1 ) : false;
516
}
517

    
518
/*
519
 *  backup_config_section($section): returns as an xml file string of
520
 *                                   the configuration section
521
 */
522
function backup_config_section($section) {
523
	global $config;
524
	$new_section = &$config[$section];
525
	/* generate configuration XML */
526
	$xmlconfig = dump_xml_config($new_section, $section);
527
	$xmlconfig = str_replace("<?xml version=\"1.0\"?>", "", $xmlconfig);
528
	return $xmlconfig;
529
}
530

    
531
/*
532
 *  restore_config_section($section, new_contents): restore a configuration section,
533
 *                                                  and write the configuration out
534
 *                                                  to disk/cf.
535
 */
536
function restore_config_section($section, $new_contents) {
537
	global $config, $g;
538
	conf_mount_rw();
539
	$fout = fopen("{$g['tmp_path']}/tmpxml","w");
540
	fwrite($fout, $new_contents);
541
	fclose($fout);
542
	$section_xml = parse_xml_config($g['tmp_path'] . "/tmpxml", $section);
543
	if ($section_xml != -1)
544
		$config[$section] = &$section_xml;
545
	@unlink($g['tmp_path'] . "/tmpxml");
546
	if(file_exists("{$g['tmp_path']}/config.cache"))
547
		unlink("{$g['tmp_path']}/config.cache");
548
	write_config("Restored {$section} of config file (maybe from CARP partner)");
549
	disable_security_checks();
550
	conf_mount_ro();
551
	return;
552
}
553

    
554
/*
555
 *  merge_config_section($section, new_contents):   restore a configuration section,
556
 *                                                  and write the configuration out
557
 *                                                  to disk/cf.  But preserve the prior
558
 * 													structure if needed
559
 */
560
function merge_config_section($section, $new_contents) {
561
	global $config;
562
	conf_mount_rw();
563
	$fname = get_tmp_filename();
564
	$fout = fopen($fname, "w");
565
	fwrite($fout, $new_contents);
566
	fclose($fout);
567
	$section_xml = parse_xml_config($fname, $section);
568
	$config[$section] = $section_xml;
569
	unlink($fname);
570
	write_config("Restored {$section} of config file (maybe from CARP partner)");
571
	disable_security_checks();
572
	conf_mount_ro();
573
	return;
574
}
575

    
576
/*
577
 * http_post($server, $port, $url, $vars): does an http post to a web server
578
 *                                         posting the vars array.
579
 * written by nf@bigpond.net.au
580
 */
581
function http_post($server, $port, $url, $vars) {
582
	$user_agent = "Mozilla/4.0 (compatible; MSIE 5.5; Windows 98)";
583
	$urlencoded = "";
584
	while (list($key,$value) = each($vars))
585
		$urlencoded.= urlencode($key) . "=" . urlencode($value) . "&";
586
	$urlencoded = substr($urlencoded,0,-1);
587
	$content_length = strlen($urlencoded);
588
	$headers = "POST $url HTTP/1.1
589
Accept: */*
590
Accept-Language: en-au
591
Content-Type: application/x-www-form-urlencoded
592
User-Agent: $user_agent
593
Host: $server
594
Connection: Keep-Alive
595
Cache-Control: no-cache
596
Content-Length: $content_length
597

    
598
";
599

    
600
	$errno = "";
601
	$errstr = "";
602
	$fp = fsockopen($server, $port, $errno, $errstr);
603
	if (!$fp) {
604
		return false;
605
	}
606

    
607
	fputs($fp, $headers);
608
	fputs($fp, $urlencoded);
609

    
610
	$ret = "";
611
	while (!feof($fp))
612
		$ret.= fgets($fp, 1024);
613
	fclose($fp);
614

    
615
	return $ret;
616
}
617

    
618
/*
619
 *  php_check_syntax($code_tocheck, $errormessage): checks $code_to_check for errors
620
 */
621
if (!function_exists('php_check_syntax')){
622
	global $g;
623
	function php_check_syntax($code_to_check, &$errormessage){
624
		return false;
625
		$fout = fopen("{$g['tmp_path']}/codetocheck.php","w");
626
		$code = $_POST['content'];
627
		$code = str_replace("<?php", "", $code);
628
		$code = str_replace("?>", "", $code);
629
		fwrite($fout, "<?php\n\n");
630
		fwrite($fout, $code_to_check);
631
		fwrite($fout, "\n\n?>\n");
632
		fclose($fout);
633
		$command = "/usr/local/bin/php -l {$g['tmp_path']}/codetocheck.php";
634
		$output = exec_command($command);
635
		if (stristr($output, "Errors parsing") == false) {
636
			echo "false\n";
637
			$errormessage = '';
638
			return(false);
639
		} else {
640
			$errormessage = $output;
641
			return(true);
642
		}
643
	}
644
}
645

    
646
/*
647
 *  php_check_filename_syntax($filename, $errormessage): checks the file $filename for errors
648
 */
649
if (!function_exists('php_check_syntax')){
650
	function php_check_syntax($code_to_check, &$errormessage){
651
		return false;
652
		$command = "/usr/local/bin/php -l " . $code_to_check;
653
		$output = exec_command($command);
654
		if (stristr($output, "Errors parsing") == false) {
655
			echo "false\n";
656
			$errormessage = '';
657
			return(false);
658
		} else {
659
			$errormessage = $output;
660
			return(true);
661
		}
662
	}
663
}
664

    
665
/*
666
 * rmdir_recursive($path,$follow_links=false)
667
 * Recursively remove a directory tree (rm -rf path)
668
 * This is for directories _only_
669
 */
670
function rmdir_recursive($path,$follow_links=false) {
671
	$to_do = glob($path);
672
	if(!is_array($to_do)) $to_do = array($to_do);
673
	foreach($to_do as $workingdir) { // Handle wildcards by foreaching.
674
		if(file_exists($workingdir)) {
675
			if(is_dir($workingdir)) {
676
				$dir = opendir($workingdir);
677
				while ($entry = readdir($dir)) {
678
					if (is_file("$workingdir/$entry") || ((!$follow_links) && is_link("$workingdir/$entry")))
679
						unlink("$workingdir/$entry");
680
					elseif (is_dir("$workingdir/$entry") && $entry!='.' && $entry!='..')
681
						rmdir_recursive("$workingdir/$entry");
682
				}
683
				closedir($dir);
684
				rmdir($workingdir);
685
			} elseif (is_file($workingdir)) {
686
				unlink($workingdir);
687
			}
688
               	}
689
	}
690
	return;
691
}
692

    
693
/*
694
 * call_pfsense_method(): Call a method exposed by the pfsense.com XMLRPC server.
695
 */
696
function call_pfsense_method($method, $params, $timeout = 0) {
697
	global $g, $config;
698

    
699
	$ip = gethostbyname($g['product_website']);
700
	if($ip == $g['product_website'])
701
		return false;
702

    
703
	$xmlrpc_base_url = isset($config['system']['altpkgrepo']['enable']) ? $config['system']['altpkgrepo']['xmlrpcbaseurl'] : $g['xmlrpcbaseurl'];
704
	$xmlrpc_path = $g['xmlrpcpath'];
705
	$msg = new XML_RPC_Message($method, array(XML_RPC_Encode($params)));
706
	$port = 0;
707
	$proxyurl = "";
708
	$proxyport = 0;
709
	$proxyuser = "";
710
	$proxypass = "";
711
	if (!empty($config['system']['proxyurl']))
712
		$proxyurl = $config['system']['proxyurl'];
713
	if (!empty($config['system']['proxyport']) && is_numeric($config['system']['proxyport']))
714
		$proxyport = $config['system']['proxyport'];
715
	if (!empty($config['system']['proxyuser']))
716
		$proxyuser = $config['system']['proxyuser'];
717
	if (!empty($config['system']['proxypass']))
718
		$proxypass = $config['system']['proxypass'];
719
	$cli = new XML_RPC_Client($xmlrpc_path, $xmlrpc_base_url, $port, $proxyurl, $proxyport, $proxyuser, $proxypass);
720
	// If the ALT PKG Repo has a username/password set, use it.
721
	if($config['system']['altpkgrepo']['username'] && 
722
	   $config['system']['altpkgrepo']['password']) {
723
		$username = $config['system']['altpkgrepo']['username'];
724
		$password = $config['system']['altpkgrepo']['password'];
725
		$cli->setCredentials($username, $password);
726
	}
727
	$resp = $cli->send($msg, $timeout);
728
	if(!is_object($resp)) {
729
		log_error("XMLRPC communication error: " . $cli->errstr);
730
		return false;
731
	} elseif($resp->faultCode()) {
732
		log_error("XMLRPC request failed with error " . $resp->faultCode() . ": " . $resp->faultString());
733
		return false;
734
	} else {
735
		return XML_RPC_Decode($resp->value());
736
	}
737
}
738

    
739
/*
740
 * check_firmware_version(): Check whether the current firmware installed is the most recently released.
741
 */
742
function check_firmware_version($tocheck = "all", $return_php = true) {
743
	global $g, $config;
744

    
745
	$ip = gethostbyname($g['product_website']);
746
	if($ip == $g['product_website'])
747
		return false;
748

    
749
	$rawparams = array("firmware" => array("version" => trim(file_get_contents('/etc/version'))),
750
		"kernel"   => array("version" => trim(file_get_contents('/etc/version_kernel'))),
751
		"base"     => array("version" => trim(file_get_contents('/etc/version_base'))),
752
		"platform" => trim(file_get_contents('/etc/platform')),
753
		"config_version" => $config['version']
754
		);
755
	if($tocheck == "all") {
756
		$params = $rawparams;
757
	} else {
758
		foreach($tocheck as $check) {
759
			$params['check'] = $rawparams['check'];
760
			$params['platform'] = $rawparams['platform'];
761
		}
762
	}
763
	if($config['system']['firmware']['branch'])
764
		$params['branch'] = $config['system']['firmware']['branch'];
765

    
766
	/* XXX: What is this method? */
767
	if(!($versions = call_pfsense_method('pfsense.get_firmware_version', $params))) {
768
		return false;
769
	} else {
770
		$versions["current"] = $params;
771
	}
772

    
773
	return $versions;
774
}
775

    
776
/*
777
 * host_firmware_version(): Return the versions used in this install
778
 */
779
function host_firmware_version($tocheck = "") {
780
        global $g, $config;
781

    
782
        return array(
783
		"firmware" => array("version" => trim(file_get_contents('/etc/version', " \n"))),
784
                "kernel"   => array("version" => trim(file_get_contents('/etc/version_kernel', " \n"))),
785
                "base"     => array("version" => trim(file_get_contents('/etc/version_base', " \n"))),
786
                "platform" => trim(file_get_contents('/etc/platform', " \n")),
787
                "config_version" => $config['version']
788
                );
789
}
790

    
791
function get_disk_info() {
792
	$diskout = "";
793
	exec("/bin/df -h | /usr/bin/grep -w '/' | /usr/bin/awk '{ print $2, $3, $4, $5 }'", $diskout);
794
	return explode(' ', $diskout[0]);
795
}
796

    
797
/****f* pfsense-utils/strncpy
798
 * NAME
799
 *   strncpy - copy strings
800
 * INPUTS
801
 *   &$dst, $src, $length
802
 * RESULT
803
 *   none
804
 ******/
805
function strncpy(&$dst, $src, $length) {
806
	if (strlen($src) > $length) {
807
		$dst = substr($src, 0, $length);
808
	} else {
809
		$dst = $src;
810
	}
811
}
812

    
813
/****f* pfsense-utils/reload_interfaces_sync
814
 * NAME
815
 *   reload_interfaces - reload all interfaces
816
 * INPUTS
817
 *   none
818
 * RESULT
819
 *   none
820
 ******/
821
function reload_interfaces_sync() {
822
	global $config, $g;
823

    
824
	if($g['debug'])
825
		log_error("reload_interfaces_sync() is starting.");
826

    
827
	/* parse config.xml again */
828
	$config = parse_config(true);
829

    
830
	/* enable routing */
831
	system_routing_enable();
832
	if($g['debug'])
833
		log_error("Enabling system routing");
834

    
835
	if($g['debug'])
836
		log_error("Cleaning up Interfaces");
837

    
838
	/* set up interfaces */
839
	interfaces_configure();
840
}
841

    
842
/****f* pfsense-utils/reload_all
843
 * NAME
844
 *   reload_all - triggers a reload of all settings
845
 *   * INPUTS
846
 *   none
847
 * RESULT
848
 *   none
849
 ******/
850
function reload_all() {
851
	send_event("service reload all");
852
}
853

    
854
/****f* pfsense-utils/reload_interfaces
855
 * NAME
856
 *   reload_interfaces - triggers a reload of all interfaces
857
 * INPUTS
858
 *   none
859
 * RESULT
860
 *   none
861
 ******/
862
function reload_interfaces() {
863
	send_event("interface all reload");
864
}
865

    
866
/****f* pfsense-utils/reload_all_sync
867
 * NAME
868
 *   reload_all - reload all settings
869
 *   * INPUTS
870
 *   none
871
 * RESULT
872
 *   none
873
 ******/
874
function reload_all_sync() {
875
	global $config, $g;
876

    
877
	$g['booting'] = false;
878

    
879
	/* parse config.xml again */
880
	$config = parse_config(true);
881

    
882
	/* set up our timezone */
883
	system_timezone_configure();
884

    
885
	/* set up our hostname */
886
	system_hostname_configure();
887

    
888
	/* make hosts file */
889
	system_hosts_generate();
890

    
891
	/* generate resolv.conf */
892
	system_resolvconf_generate();
893

    
894
	/* enable routing */
895
	system_routing_enable();
896

    
897
	/* set up interfaces */
898
	interfaces_configure();
899

    
900
	/* start dyndns service */
901
	services_dyndns_configure();
902

    
903
	/* configure cron service */
904
	configure_cron();
905

    
906
	/* start the NTP client */
907
	system_ntp_configure();
908

    
909
	/* sync pw database */
910
	conf_mount_rw();
911
	unlink_if_exists("/etc/spwd.db.tmp");
912
	mwexec("/usr/sbin/pwd_mkdb -d /etc/ /etc/master.passwd");
913
	conf_mount_ro();
914

    
915
	/* restart sshd */
916
	send_event("service restart sshd");
917

    
918
	/* restart webConfigurator if needed */
919
	send_event("service restart webgui");
920
}
921

    
922
function auto_login() {
923
	global $config;
924

    
925
	if(isset($config['system']['disableconsolemenu']))
926
		$status = false;
927
	else
928
		$status = true;
929

    
930
	$gettytab = file_get_contents("/etc/gettytab");
931
	$getty_split = split("\n", $gettytab);
932
	conf_mount_rw();
933
	$fd = false;
934
	$tries = 0;
935
	while (!$fd && $tries < 100) {
936
		$fd = fopen("/etc/gettytab", "w");
937
		$tries++;
938
		
939
	}
940
	if (!$fd) {
941
		conf_mount_ro();
942
		log_error("Enabling auto login was not possible.");
943
		return;
944
	}
945
	foreach($getty_split as $gs) {
946
		if(stristr($gs, ":ht:np:sp#115200") ) {
947
			if($status == true) {
948
				fwrite($fd, "	:ht:np:sp#115200:al=root:\n");
949
			} else {
950
				fwrite($fd, "	:ht:np:sp#115200:\n");
951
			}
952
		} else {
953
			fwrite($fd, "{$gs}\n");
954
		}
955
	}
956
	fclose($fd);
957
	conf_mount_ro();
958
}
959

    
960
function setup_serial_port() {
961
	global $g, $config;
962
	conf_mount_rw();
963
	/* serial console - write out /boot.config */
964
	if(file_exists("/boot.config"))
965
		$boot_config = file_get_contents("/boot.config");
966
	else
967
		$boot_config = "";
968

    
969
	if($g['platform'] <> "cdrom") {
970
		$boot_config_split = split("\n", $boot_config);
971
		$fd = fopen("/boot.config","w");
972
		if($fd) {
973
			foreach($boot_config_split as $bcs) {
974
				if(stristr($bcs, "-D")) {
975
					/* DONT WRITE OUT, WE'LL DO IT LATER */
976
				} else {
977
					if($bcs <> "")
978
						fwrite($fd, "{$bcs}\n");
979
				}
980
			}
981
			if(isset($config['system']['enableserial'])) {
982
				fwrite($fd, "-D");
983
			}
984
			fclose($fd);
985
		}
986
		/* serial console - write out /boot/loader.conf */
987
		$boot_config = file_get_contents("/boot/loader.conf");
988
		$boot_config_split = explode("\n", $boot_config);
989
		if(count($boot_config_split) > 0) {
990
			$new_boot_config = array();
991
			// Loop through and only add lines that are not empty, and which
992
			//  do not contain a console directive.
993
			foreach($boot_config_split as $bcs)
994
				if(!empty($bcs) && (stripos($bcs, "console") === false))
995
					$new_boot_config[] = $bcs;
996

    
997
			if(isset($config['system']['enableserial']))
998
				$new_boot_config[] = 'console="comconsole"';
999
			file_put_contents("/boot/loader.conf", implode("\n", $new_boot_config));
1000
		}
1001
	}
1002
	$ttys = file_get_contents("/etc/ttys");
1003
	$ttys_split = split("\n", $ttys);
1004
	$fd = fopen("/etc/ttys", "w");
1005
	foreach($ttys_split as $tty) {
1006
		if(stristr($tty, "ttyd0") or stristr($tty, "ttyu0")) {
1007
			if(isset($config['system']['enableserial'])) {
1008
				fwrite($fd, "ttyu0	\"/usr/libexec/getty bootupcli\"	cons25	on	secure\n");
1009
			} else {
1010
				fwrite($fd, "ttyu0	\"/usr/libexec/getty bootupcli\"	cons25	off	secure\n");
1011
			}
1012
		} else {
1013
			fwrite($fd, $tty . "\n");
1014
		}
1015
	}
1016
	fclose($fd);
1017
	auto_login();
1018

    
1019
	conf_mount_ro();
1020
	return;
1021
}
1022

    
1023
function print_value_list($list, $count = 10, $separator = ",") {
1024
	$list = implode($separator, array_slice($list, 0, $count));
1025
	if(count($list) < $count) {
1026
		$list .= ".";
1027
	} else {
1028
		$list .= "...";
1029
	}
1030
	return $list;
1031
}
1032

    
1033
/* DHCP enabled on any interfaces? */
1034
function is_dhcp_server_enabled() 
1035
{
1036
	global $config;
1037

    
1038
	$dhcpdenable = false;
1039
	
1040
	if (!is_array($config['dhcpd']))
1041
		return false;
1042

    
1043
	$Iflist = get_configured_interface_list();
1044

    
1045
	foreach ($config['dhcpd'] as $dhcpif => $dhcpifconf) {
1046
		if (isset($dhcpifconf['enable']) && isset($Iflist[$dhcpif])) {
1047
			$dhcpdenable = true;
1048
			break;
1049
		}
1050
	}
1051

    
1052
	return $dhcpdenable;
1053
}
1054

    
1055
/* Any PPPoE servers enabled? */
1056
function is_pppoe_server_enabled() {
1057
	global $config;
1058

    
1059
	$pppoeenable = false;
1060

    
1061
	if (!is_array($config['pppoes']) || !is_array($config['pppoes']['pppoe']))
1062
		return false;
1063

    
1064
	foreach ($config['pppoes']['pppoe'] as $pppoes)
1065
		if ($pppoes['mode'] == 'server')
1066
			$pppoeenable = true;
1067

    
1068
	return $pppoeenable;
1069
}
1070

    
1071
function convert_seconds_to_hms($sec){
1072
	$min=$hrs=0;
1073
	if ($sec != 0){
1074
		$min = floor($sec/60);
1075
		$sec %= 60;
1076
	}
1077
	if ($min != 0){
1078
		$hrs = floor($min/60);
1079
		$min %= 60;
1080
	}
1081
	if ($sec < 10)
1082
		$sec = "0".$sec;
1083
	if ($min < 10)
1084
		$min = "0".$min;
1085
	if ($hrs < 10)
1086
		$hrs = "0".$hrs;
1087
	$result = $hrs.":".$min.":".$sec;
1088
	return $result;
1089
}
1090

    
1091
/* Compute the total uptime from the ppp uptime log file in the conf directory */
1092

    
1093
function get_ppp_uptime($port){
1094
	if (file_exists("/conf/{$port}.log")){
1095
    	$saved_time = file_get_contents("/conf/{$port}.log");
1096
    	$uptime_data = explode("\n",$saved_time);
1097
		$sec=0;
1098
		foreach($uptime_data as $upt) {
1099
			$sec += substr($upt, 1 + strpos($upt, " "));
1100
 		}
1101
		return convert_seconds_to_hms($sec);
1102
	} else {
1103
		$total_time = "No history data found!";
1104
		return $total_time;
1105
	}
1106
}
1107

    
1108
//returns interface information
1109
function get_interface_info($ifdescr) {
1110
	global $config, $g;
1111

    
1112
	$ifinfo = array();
1113
	if (empty($config['interfaces'][$ifdescr]))
1114
		return;
1115
	$ifinfo['hwif'] = $config['interfaces'][$ifdescr]['if'];
1116
	$ifinfo['if'] = get_real_interface($ifdescr);
1117

    
1118
	$chkif = $ifinfo['if'];
1119
	$ifinfotmp = pfSense_get_interface_addresses($chkif);
1120
	$ifinfo['status'] = $ifinfotmp['status'];
1121
	if (empty($ifinfo['status']))
1122
                $ifinfo['status'] = "down";
1123
	$ifinfo['macaddr'] = $ifinfotmp['macaddr'];
1124
	$ifinfo['ipaddr'] = $ifinfotmp['ipaddr'];
1125
	$ifinfo['subnet'] = $ifinfotmp['subnet'];
1126
	if (isset($ifinfotmp['link0']))
1127
		$link0 = "down";
1128
	$ifinfotmp = pfSense_get_interface_stats($chkif);
1129
        $ifinfo['inpkts'] = $ifinfotmp['inpkts'];
1130
        $ifinfo['outpkts'] = $ifinfotmp['outpkts'];
1131
        $ifinfo['inerrs'] = $ifinfotmp['inerrs'];
1132
        $ifinfo['outerrs'] = $ifinfotmp['outerrs'];
1133
        $ifinfo['collisions'] = $ifinfotmp['collisions'];
1134

    
1135
	/* Use pfctl for non wrapping 64 bit counters */
1136
	/* Pass */
1137
	exec("/sbin/pfctl -vvsI -i {$chkif}", $pfctlstats);
1138
	$pf_in4_pass = preg_split("/ +/ ", $pfctlstats[3]);
1139
	$pf_out4_pass = preg_split("/ +/", $pfctlstats[5]);
1140
	$in4_pass = $pf_in4_pass[5];
1141
	$out4_pass = $pf_out4_pass[5];
1142
	$in4_pass_packets = $pf_in4_pass[3];
1143
	$out4_pass_packets = $pf_out4_pass[3];
1144
	$ifinfo['inbytespass'] = $in4_pass;
1145
	$ifinfo['outbytespass'] = $out4_pass;
1146
	$ifinfo['inpktspass'] = $in4_pass_packets;
1147
	$ifinfo['outpktspass'] = $out4_pass_packets;
1148

    
1149
	/* Block */
1150
	$pf_in4_block = preg_split("/ +/", $pfctlstats[4]);
1151
	$pf_out4_block = preg_split("/ +/", $pfctlstats[6]);
1152
	$in4_block = $pf_in4_block[5];
1153
	$out4_block = $pf_out4_block[5];
1154
	$in4_block_packets = $pf_in4_block[3];
1155
	$out4_block_packets = $pf_out4_block[3];
1156
	$ifinfo['inbytesblock'] = $in4_block;
1157
	$ifinfo['outbytesblock'] = $out4_block;
1158
	$ifinfo['inpktsblock'] = $in4_block_packets;
1159
	$ifinfo['outpktsblock'] = $out4_block_packets;
1160

    
1161
	$ifinfo['inbytes'] = $in4_pass + $in4_block;
1162
	$ifinfo['outbytes'] = $out4_pass + $out4_block;
1163
	$ifinfo['inpkts'] = $in4_pass_packets + $in4_block_packets;
1164
	$ifinfo['outpkts'] = $in4_pass_packets + $out4_block_packets;
1165
		
1166
	$ifconfiginfo = "";
1167
	$link_type = $config['interfaces'][$ifdescr]['ipaddr'];
1168
	switch ($link_type) {
1169
	 /* DHCP? -> see if dhclient is up */
1170
	case "dhcp":
1171
	case "carpdev-dhcp":
1172
		/* see if dhclient is up */
1173
		if (find_dhclient_process($ifinfo['if']) <> "")
1174
			$ifinfo['dhcplink'] = "up";
1175
		else
1176
			$ifinfo['dhcplink'] = "down";
1177

    
1178
		break;
1179
	/* PPPoE/PPTP/L2TP interface? -> get status from virtual interface */
1180
	case "pppoe":
1181
	case "pptp":
1182
	case "l2tp":
1183
		if ($ifinfo['status'] == "up" && !isset($link0))
1184
			/* get PPPoE link status for dial on demand */
1185
			$ifinfo["{$link_type}link"] = "up";
1186
		else
1187
			$ifinfo["{$link_type}link"] = "down";
1188

    
1189
		break;
1190
	/* PPP interface? -> get uptime for this session and cumulative uptime from the persistant log file in conf */
1191
	case "ppp":
1192
		if ($ifinfo['status'] == "up")
1193
			$ifinfo['ppplink'] = "up";
1194
		else
1195
			$ifinfo['ppplink'] = "down" ;
1196

    
1197
		if (empty($ifinfo['status']))
1198
			$ifinfo['status'] = "down";
1199
			
1200
		if (is_array($config['ppps']['ppp']) && count($config['ppps']['ppp'])) {
1201
			foreach ($config['ppps']['ppp'] as $pppid => $ppp) {
1202
				if ($config['interfaces'][$ifdescr]['if'] == $ppp['if'])
1203
					break;
1204
			}
1205
		}
1206
		$dev = $ppp['ports'];
1207
		if ($config['interfaces'][$ifdescr]['if'] != $ppp['if'] || empty($dev))
1208
			break;
1209
		if (!file_exists($dev)) {
1210
			$ifinfo['nodevice'] = 1;
1211
			$ifinfo['pppinfo'] = $dev . " device not present! Is the modem attached to the system?";	
1212
		}
1213
		// Calculate cumulative uptime for PPP link. Useful for connections that have per minute/hour contracts so you don't go over!
1214
		if (isset($ppp['uptime']))
1215
			$ifinfo['ppp_uptime_accumulated'] = "(".get_ppp_uptime($ifinfo['if']).")";
1216
		break;
1217
	default:
1218
		break;
1219
	}
1220
	
1221
	if (file_exists("{$g['varrun_path']}/{$link_type}_{$ifdescr}.pid")) {
1222
		$sec = trim(`/usr/local/sbin/ppp-uptime.sh {$ifinfo['if']}`);
1223
		$ifinfo['ppp_uptime'] = convert_seconds_to_hms($sec);
1224
	}
1225
	
1226
	if ($ifinfo['status'] == "up") {
1227
		/* try to determine media with ifconfig */
1228
		unset($ifconfiginfo);
1229
		exec("/sbin/ifconfig " . $ifinfo['if'], $ifconfiginfo);
1230
		$wifconfiginfo = array();
1231
		if(is_interface_wireless($ifdescr)) {
1232
			exec("/sbin/ifconfig {$ifinfo['if']} list sta", $wifconfiginfo);
1233
			array_shift($wifconfiginfo);
1234
		}
1235
		$matches = "";
1236
		foreach ($ifconfiginfo as $ici) {
1237

    
1238
			/* don't list media/speed for wireless cards, as it always
1239
			   displays 2 Mbps even though clients can connect at 11 Mbps */
1240
			if (preg_match("/media: .*? \((.*?)\)/", $ici, $matches)) {
1241
				$ifinfo['media'] = $matches[1];
1242
			} else if (preg_match("/media: Ethernet (.*)/", $ici, $matches)) {
1243
				$ifinfo['media'] = $matches[1];
1244
			} else if (preg_match("/media: IEEE 802.11 Wireless Ethernet (.*)/", $ici, $matches)) {
1245
				$ifinfo['media'] = $matches[1];
1246
			}
1247

    
1248
			if (preg_match("/status: (.*)$/", $ici, $matches)) {
1249
				if ($matches[1] != "active")
1250
					$ifinfo['status'] = $matches[1];
1251
				if($ifinfo['status'] == "running")
1252
					$ifinfo['status'] = "up";
1253
			}
1254
			if (preg_match("/channel (\S*)/", $ici, $matches)) {
1255
				$ifinfo['channel'] = $matches[1];
1256
			}
1257
			if (preg_match("/ssid (\".*?\"|\S*)/", $ici, $matches)) {
1258
				if ($matches[1][0] == '"')
1259
					$ifinfo['ssid'] = substr($matches[1], 1, -1);
1260
				else
1261
					$ifinfo['ssid'] = $matches[1];
1262
			}
1263
		}
1264
		foreach($wifconfiginfo as $ici) {
1265
			$elements = preg_split("/[ ]+/i", $ici);
1266
			if ($elements[0] != "") {
1267
				$ifinfo['bssid'] = $elements[0];
1268
			}
1269
			if ($elements[3] != "") {
1270
				$ifinfo['rate'] = $elements[3];
1271
			}
1272
			if ($elements[4] != "") {
1273
				$ifinfo['rssi'] = $elements[4];
1274
			}
1275

    
1276
		}
1277
		/* lookup the gateway */
1278
		if (interface_has_gateway($ifdescr)) 
1279
			$ifinfo['gateway'] = get_interface_gateway($ifdescr);
1280
	}
1281

    
1282
	$bridge = "";
1283
	$bridge = link_interface_to_bridge($ifdescr);
1284
	if($bridge) {
1285
		$bridge_text = `/sbin/ifconfig {$bridge}`;
1286
		if(stristr($bridge_text, "blocking") <> false) {
1287
			$ifinfo['bridge'] = "<b><font color='red'>blocking</font></b> - check for ethernet loops";
1288
			$ifinfo['bridgeint'] = $bridge;
1289
		} else if(stristr($bridge_text, "learning") <> false) {
1290
			$ifinfo['bridge'] = "learning";
1291
			$ifinfo['bridgeint'] = $bridge;
1292
		} else if(stristr($bridge_text, "forwarding") <> false) {
1293
			$ifinfo['bridge'] = "forwarding";
1294
			$ifinfo['bridgeint'] = $bridge;
1295
		}
1296
	}
1297

    
1298
	return $ifinfo;
1299
}
1300

    
1301
//returns cpu speed of processor. Good for determining capabilities of machine
1302
function get_cpu_speed() {
1303
	 return exec("sysctl hw.clockrate | awk '{ print $2 }'");
1304
}
1305

    
1306
function add_hostname_to_watch($hostname) {
1307
	if(!is_dir("/var/db/dnscache")) {
1308
		mkdir("/var/db/dnscache");
1309
	}
1310
	if((is_fqdn($hostname)) && (!is_ipaddr($hostname))) {
1311
		$domrecords = array();
1312
		$domips = array();
1313
		exec("host -t A $hostname", $domrecords, $rethost);
1314
		if($rethost == 0) {
1315
			foreach($domrecords as $domr) {
1316
				$doml = explode(" ", $domr);
1317
				$domip = $doml[3];
1318
				/* fill array with domain ip addresses */
1319
				if(is_ipaddr($domip)) {
1320
					$domips[] = $domip;
1321
				}
1322
			}
1323
		}
1324
		sort($domips);
1325
		$contents = "";
1326
		if(! empty($domips)) {
1327
			foreach($domips as $ip) {
1328
				$contents .= "$ip\n";
1329
			}
1330
		}
1331
		file_put_contents("/var/db/dnscache/$hostname", $contents);
1332
	}
1333
}
1334

    
1335
function is_fqdn($fqdn) {
1336
	$hostname = false;
1337
	if(preg_match("/[-A-Z0-9\.]+\.[-A-Z0-9\.]+/i", $fqdn)) {
1338
		$hostname = true;
1339
	}
1340
	if(preg_match("/\.\./", $fqdn)) {
1341
		$hostname = false;
1342
	}
1343
	if(preg_match("/^\./i", $fqdn)) { 
1344
		$hostname = false;
1345
	}
1346
	if(preg_match("/\//i", $fqdn)) {
1347
		$hostname = false;
1348
	}
1349
	return($hostname);
1350
}
1351

    
1352
function pfsense_default_state_size() {
1353
  /* get system memory amount */
1354
  $memory = get_memory();
1355
  $avail = $memory[0];
1356
  /* Be cautious and only allocate 10% of system memory to the state table */
1357
  $max_states = (int) ($avail/10)*1000;
1358
  return $max_states;
1359
}
1360

    
1361
function pfsense_default_table_entries_size() {
1362
	$current = `pfctl -sm | grep table-entries | awk '{print $4};'`;
1363
	return $current;
1364
}
1365

    
1366
/* Compare the current hostname DNS to the DNS cache we made
1367
 * if it has changed we return the old records
1368
 * if no change we return true */
1369
function compare_hostname_to_dnscache($hostname) {
1370
	if(!is_dir("/var/db/dnscache")) {
1371
		mkdir("/var/db/dnscache");
1372
	}
1373
	$hostname = trim($hostname);
1374
	if(is_readable("/var/db/dnscache/{$hostname}")) {
1375
		$oldcontents = file_get_contents("/var/db/dnscache/{$hostname}");
1376
	} else {
1377
		$oldcontents = "";
1378
	}
1379
	if((is_fqdn($hostname)) && (!is_ipaddr($hostname))) {
1380
		$domrecords = array();
1381
		$domips = array();
1382
		exec("host -t A $hostname", $domrecords, $rethost);
1383
		if($rethost == 0) {
1384
			foreach($domrecords as $domr) {
1385
				$doml = explode(" ", $domr);
1386
				$domip = $doml[3];
1387
				/* fill array with domain ip addresses */
1388
				if(is_ipaddr($domip)) {
1389
					$domips[] = $domip;
1390
				}
1391
			}
1392
		}
1393
		sort($domips);
1394
		$contents = "";
1395
		if(! empty($domips)) {
1396
			foreach($domips as $ip) {
1397
				$contents .= "$ip\n";
1398
			}
1399
		}
1400
	}
1401

    
1402
	if(trim($oldcontents) != trim($contents)) {
1403
		if($g['debug']) {
1404
			log_error("DNSCACHE: Found old IP {$oldcontents} and new IP {$contents}");
1405
		}
1406
		return ($oldcontents);
1407
	} else {
1408
		return false;
1409
	}
1410
}
1411

    
1412
/*
1413
 * load_glxsb() - Load the glxsb crypto module if enabled in config.
1414
 */
1415
function load_glxsb() {
1416
	global $config, $g;
1417
	$is_loaded = `/sbin/kldstat | /usr/bin/grep -c glxsb`;
1418
	if (isset($config['system']['glxsb_enable']) && ($is_loaded == 0)) {
1419
		mwexec("/sbin/kldload glxsb");
1420
	}
1421
}
1422

    
1423
/****f* pfsense-utils/isvm
1424
 * NAME
1425
 *   isvm
1426
 * INPUTS
1427
 *	 none
1428
 * RESULT
1429
 *   returns true if machine is running under a virtual environment
1430
 ******/
1431
function isvm() {
1432
	$virtualenvs = array("vmware", "parallels", "qemu", "bochs", "plex86");
1433
	$bios_vendor = strtolower(`/bin/kenv | /usr/bin/awk -F= '/smbios.bios.vendor/ {print $2}'`);
1434
	if(in_array($bios_vendor, $virtualenvs)) 
1435
		return true;
1436
	else
1437
		return false;
1438
}
1439

    
1440
function get_freebsd_version() {
1441
	$version = php_uname("r");
1442
	return $version[0];
1443
}
1444

    
1445
function download_file_with_progress_bar($url_file, $destination_file, $readbody = 'read_body', $connect_timeout=60, $timeout=0) {
1446
        global $ch, $fout, $file_size, $downloaded, $config;
1447
        $file_size  = 1;
1448
        $downloaded = 1;
1449
        /* open destination file */
1450
        $fout = fopen($destination_file, "wb");
1451

    
1452
        /*
1453
         *      Originally by Author: Keyvan Minoukadeh
1454
         *      Modified by Scott Ullrich to return Content-Length size
1455
         */
1456

    
1457
        $ch = curl_init();
1458
        curl_setopt($ch, CURLOPT_URL, $url_file);
1459
        curl_setopt($ch, CURLOPT_HEADERFUNCTION, 'read_header');
1460
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1461
        /* Don't verify SSL peers since we don't have the certificates to do so. */
1462
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
1463
        curl_setopt($ch, CURLOPT_WRITEFUNCTION, $readbody);
1464
        curl_setopt($ch, CURLOPT_NOPROGRESS, '1');
1465
        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connect_timeout);
1466
        curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1467

    
1468
	if (!empty($config['system']['proxyurl'])) {
1469
		curl_setopt($ch, CURLOPT_PROXY, $config['system']['proxyurl']);
1470
		if (!empty($config['system']['proxyport']))
1471
			curl_setopt($ch, CURLOPT_PROXYPORT, $config['system']['proxyport']);
1472
		if (!empty($config['system']['proxyuser']) && !empty($config['system']['proxypass'])) {
1473
			@curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_ANY | CURLAUTH_ANYSAFE);
1474
			curl_setopt($ch, CURLOPT_PROXYUSERPWD, "{$config['system']['proxyuser']}:{$config['system']['proxypass']}");
1475
		}
1476
	}
1477

    
1478
        @curl_exec($ch);
1479
        $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
1480
        if($fout)
1481
                fclose($fout);
1482
        curl_close($ch);
1483
        return ($http_code == 200) ? true : $http_code;
1484
}
1485

    
1486
function read_header($ch, $string) {
1487
        global $file_size, $fout;
1488
        $length = strlen($string);
1489
        $regs = "";
1490
        ereg("(Content-Length:) (.*)", $string, $regs);
1491
        if($regs[2] <> "") {
1492
                $file_size = intval($regs[2]);
1493
        }
1494
        ob_flush();
1495
        return $length;
1496
}
1497

    
1498
function read_body($ch, $string) {
1499
        global $fout, $file_size, $downloaded, $sendto, $static_status, $static_output, $lastseen;
1500
		global $pkg_interface;
1501
        $length = strlen($string);
1502
        $downloaded += intval($length);
1503
        if($file_size > 0) {
1504
                $downloadProgress = round(100 * (1 - $downloaded / $file_size), 0);
1505
                $downloadProgress = 100 - $downloadProgress;
1506
        } else
1507
                $downloadProgress = 0;
1508
        if($lastseen <> $downloadProgress and $downloadProgress < 101) {
1509
                if($sendto == "status") {
1510
					if($pkg_interface == "console") {
1511
						if(substr($downloadProgress,2,1) == "0" || count($downloadProgress) < 2) {
1512
                        	$tostatus = $static_status . $downloadProgress . "%";
1513
                        	update_status($tostatus);
1514
						}
1515
					} else {
1516
                        $tostatus = $static_status . $downloadProgress . "%";
1517
                        update_status($tostatus);						
1518
					}
1519
                } else {
1520
					if($pkg_interface == "console") {
1521
						if(substr($downloadProgress,2,1) == "0" || count($downloadProgress) < 2) {
1522
                        	$tooutput = $static_output . $downloadProgress . "%";
1523
                        	update_output_window($tooutput);
1524
						}
1525
					} else {
1526
                        $tooutput = $static_output . $downloadProgress . "%";
1527
                        update_output_window($tooutput);
1528
					}
1529
                }
1530
                update_progress_bar($downloadProgress);
1531
                $lastseen = $downloadProgress;
1532
        }
1533
        if($fout)
1534
                fwrite($fout, $string);
1535
        ob_flush();
1536
        return $length;
1537
}
1538

    
1539
/*
1540
 *   update_output_window: update bottom textarea dynamically.
1541
 */
1542
function update_output_window($text) {
1543
        global $pkg_interface;
1544
        $log = ereg_replace("\n", "\\n", $text);
1545
        if($pkg_interface != "console") {
1546
                echo "\n<script language=\"JavaScript\">\nthis.document.forms[0].output.value = \"" . $log . "\";\n";
1547
				echo "this.document.forms[0].output.scrollTop = this.document.forms[0].output.scrollHeight;\n";	
1548
				echo "</script>";
1549
        }
1550
        /* ensure that contents are written out */
1551
        ob_flush();
1552
}
1553

    
1554
/*
1555
 *   update_output_window: update top textarea dynamically.
1556
 */
1557
function update_status($status) {
1558
        global $pkg_interface;
1559
        if($pkg_interface == "console") {
1560
                echo $status . "\n";
1561
        } else {
1562
                echo "\n<script type=\"text/javascript\">this.document.forms[0].status.value=\"" . $status . "\";</script>";
1563
        }
1564
        /* ensure that contents are written out */
1565
        ob_flush();
1566
}
1567

    
1568
/*
1569
 * update_progress_bar($percent): updates the javascript driven progress bar.
1570
 */
1571
function update_progress_bar($percent) {
1572
        global $pkg_interface;
1573
        if($percent > 100) $percent = 1;
1574
        if($pkg_interface <> "console") {
1575
                echo "\n<script type=\"text/javascript\" language=\"javascript\">";
1576
                echo "\ndocument.progressbar.style.width='" . $percent . "%';";
1577
                echo "\n</script>";
1578
        } else {
1579
                echo " {$percent}%";
1580
        }
1581
}
1582

    
1583
/* Split() is being DEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 6.0.0. Relying on this feature is highly discouraged. */
1584
if(!function_exists("split")) {
1585
	function split($seperator, $haystack, $limit = null) {
1586
		return preg_split($seperator, $haystack, $limit);
1587
	}
1588
}
1589

    
1590
function update_alias_names_upon_change($section, $field, $new_alias_name, $origname) {
1591
	global $g, $config, $pconfig, $debug;
1592
	if(!$origname) 
1593
		return;
1594

    
1595
	$sectionref = &$config;
1596
	foreach($section as $sectionname) {
1597
		if(is_array($sectionref) && isset($sectionref[$sectionname]))
1598
			$sectionref = &$sectionref[$sectionname];
1599
		else
1600
			return;
1601
	}
1602

    
1603
	if($debug) $fd = fopen("{$g['tmp_path']}/print_r", "a");
1604
	if($debug) fwrite($fd, print_r($pconfig, true));
1605

    
1606
	if(is_array($sectionref)) {
1607
		foreach($sectionref as $itemkey => $item) {
1608
			if($debug) fwrite($fd, "$itemkey\n");
1609

    
1610
			$fieldfound = true;
1611
			$fieldref = &$sectionref[$itemkey];
1612
			foreach($field as $fieldname) {
1613
				if(is_array($fieldref) && isset($fieldref[$fieldname]))
1614
					$fieldref = &$fieldref[$fieldname];
1615
				else {
1616
					$fieldfound = false;
1617
					break;
1618
				}
1619
			}
1620
			if($fieldfound && $fieldref == $origname) {
1621
				if($debug) fwrite($fd, "Setting old alias value $origname to $new_alias_name\n");
1622
				$fieldref = $new_alias_name;
1623
			}
1624
		}
1625
	}
1626

    
1627
	if($debug) fclose($fd);
1628

    
1629
}
1630

    
1631
function update_alias_url_data() {
1632
	global $config, $g;
1633

    
1634
	/* item is a url type */
1635
	$lockkey = lock('config');
1636
	if (is_array($config['aliases']['alias'])) {
1637
		foreach ($config['aliases']['alias'] as $x => $alias) {
1638
			if (empty($alias['aliasurl']))
1639
				continue;
1640

    
1641
			/* fetch down and add in */
1642
			$isfirst = 0;
1643
			$temp_filename = tempnam("{$g['tmp_path']}/", "alias_import");
1644
			unlink($temp_filename);
1645
			$fda = fopen("{$g['tmp_path']}/tmpfetch","w");
1646
			fwrite($fda, "/usr/bin/fetch -q -o \"{$temp_filename}/aliases\" \"" . $config['aliases']['alias'][$x]['aliasurl'] . "\"");
1647
			fclose($fda);
1648
			mwexec("/bin/mkdir -p {$temp_filename}");
1649
			mwexec("/usr/bin/fetch -q -o \"{$temp_filename}/aliases\" \"" . $config['aliases']['alias'][$x]['aliasurl'] . "\"");
1650
			/* if the item is tar gzipped then extract */
1651
			if(stristr($alias['aliasurl'], ".tgz"))
1652
				process_alias_tgz($temp_filename);
1653
			else if(stristr($alias['aliasurl'], ".zip"))
1654
				process_alias_unzip($temp_filename);
1655
			if(file_exists("{$temp_filename}/aliases")) {
1656
				$file_contents = file_get_contents("{$temp_filename}/aliases");
1657
				$file_contents = str_replace("#", "\n#", $file_contents);
1658
				$file_contents_split = split("\n", $file_contents);
1659
				foreach($file_contents_split as $fc) {
1660
					$tmp = trim($fc);
1661
					if(stristr($fc, "#")) {
1662
						$tmp_split = split("#", $tmp);
1663
						$tmp = trim($tmp_split[0]);
1664
					}
1665
					if(trim($tmp) <> "") {
1666
						if($isfirst == 1)
1667
							$address .= " ";
1668
						$address .= $tmp;
1669
						$isfirst = 1;
1670
					}
1671
				}
1672
				if($isfirst > 0) {
1673
					$config['aliases']['alias'][$x]['address'] = $address;
1674
					$updated = true;
1675
				}
1676
				mwexec("/bin/rm -rf {$temp_filename}");
1677
			}
1678
		}
1679
	}
1680
	if($updated)
1681
		write_config();
1682
	unlock($lockkey);
1683
}
1684

    
1685
function process_alias_unzip($temp_filename) {
1686
	if(!file_exists("/usr/local/bin/unzip"))
1687
		return;
1688
	mwexec("/bin/mv {$temp_filename}/aliases {$temp_filename}/aliases.zip");
1689
	mwexec("/usr/local/bin/unzip {$temp_filename}/aliases.tgz -d {$temp_filename}/aliases/");
1690
	unlink("{$temp_filename}/aliases.zip");
1691
	$files_to_process = return_dir_as_array("{$temp_filename}/");
1692
	/* foreach through all extracted files and build up aliases file */
1693
	$fd = fopen("{$temp_filename}/aliases", "w");
1694
	foreach($files_to_process as $f2p) {
1695
		$file_contents = file_get_contents($f2p);
1696
		fwrite($fd, $file_contents);
1697
		unlink($f2p);
1698
	}
1699
	fclose($fd);
1700
}
1701

    
1702
function process_alias_tgz($temp_filename) {
1703
	if(!file_exists("/usr/bin/tar"))
1704
		return;
1705
	mwexec("/bin/mv {$temp_filename}/aliases {$temp_filename}/aliases.tgz");
1706
	mwexec("/usr/bin/tar xzf {$temp_filename}/aliases.tgz -C {$temp_filename}/aliases/");
1707
	unlink("{$temp_filename}/aliases.tgz");
1708
	$files_to_process = return_dir_as_array("{$temp_filename}/");
1709
	/* foreach through all extracted files and build up aliases file */
1710
	$fd = fopen("{$temp_filename}/aliases", "w");
1711
	foreach($files_to_process as $f2p) {
1712
		$file_contents = file_get_contents($f2p);
1713
		fwrite($fd, $file_contents);
1714
		unlink($f2p);
1715
	}
1716
	fclose($fd);
1717
}
1718

    
1719
function version_compare_dates($a, $b) {
1720
	$a_time = strtotime($a);
1721
	$b_time = strtotime($b);
1722

    
1723
	if ((!$a_time) || (!$b_time)) {
1724
		return FALSE;
1725
	} else {
1726
		if ($a_time < $b_time)
1727
			return -1;
1728
		elseif ($$a_time == $b_time)
1729
			return 0;
1730
		else
1731
			return 1;
1732
	}
1733
}
1734
function version_get_string_value($a) {
1735
	$strs = array(
1736
		0 => "ALPHA-ALPHA",
1737
		2 => "ALPHA",
1738
		3 => "BETA",
1739
		4 => "B",
1740
		5 => "C",
1741
		6 => "D",
1742
		7 => "RC",
1743
		8 => "RELEASE"
1744
	);
1745
	$major = 0;
1746
	$minor = 0;
1747
	foreach ($strs as $num => $str) {
1748
		if (substr($a, 0, strlen($str)) == $str) {
1749
			$major = $num;
1750
			$n = substr($a, strlen($str));
1751
			if (is_numeric($n))
1752
				$minor = $n;
1753
			break;
1754
		}
1755
	}
1756
	return "{$major}.{$minor}";
1757
}
1758
function version_compare_string($a, $b) {
1759
	return version_compare_numeric(version_get_string_value($a), version_get_string_value($b));
1760
}
1761
function version_compare_numeric($a, $b) {
1762
	$a_arr = explode('.', rtrim($a, '.0'));
1763
	$b_arr = explode('.', rtrim($b, '.0'));
1764

    
1765
	foreach ($a_arr as $n => $val) {
1766
		if (array_key_exists($n, $b_arr)) {
1767
			// So far so good, both have values at this minor version level. Compare.
1768
			if ($val > $b_arr[$n])
1769
				return 1;
1770
			elseif ($val < $b_arr[$n])
1771
				return -1;
1772
		} else {
1773
			// a is greater, since b doesn't have any minor version here.
1774
			return 1;
1775
		}
1776
	}
1777
	if (count($b_arr) > count($a_arr)) {
1778
		// b is longer than a, so it must be greater.
1779
		return -1;
1780
	} else {
1781
		// Both a and b are of equal length and value.
1782
		return 0;
1783
	}
1784
}
1785
function pfs_version_compare($cur_time, $cur_text, $remote) {
1786
	// First try date compare
1787
	$v = version_compare_dates($cur_time, $remote);
1788
	if ($v === FALSE) {
1789
		// If that fails, try to compare by string
1790
		// Before anything else, simply test if the strings are equal
1791
		if (($cur_text == $remote) || ($cur_time == $remote))
1792
			return 0;
1793
		list($cur_num, $cur_str) = explode('-', $cur_text);
1794
		list($rem_num, $rem_str) = explode('-', $remote);
1795

    
1796
		// First try to compare the numeric parts of the version string.
1797
		$v = version_compare_numeric($cur_num, $rem_num);
1798

    
1799
		// If the numeric parts are the same, compare the string parts.
1800
		if ($v == 0)
1801
			return version_compare_string($cur_str, $rem_str);
1802
	}
1803
	return $v;
1804
}
1805
function process_alias_urltable($name, $url, $freq, $forceupdate=false) {
1806
	$urltable_prefix = "/var/db/aliastables/";
1807
	$urltable_filename = $urltable_prefix . $name . ".txt";
1808

    
1809
	// Make the aliases directory if it doesn't exist
1810
	if (!file_exists($urltable_prefix)) {
1811
		mkdir($urltable_prefix);
1812
	} elseif (!is_dir($urltable_prefix)) {
1813
		unlink($urltable_prefix);
1814
		mkdir($urltable_prefix);
1815
	}
1816

    
1817
	// If the file doesn't exist or is older than update_freq days, fetch a new copy.
1818
	if (!file_exists($urltable_filename)
1819
		|| ((time() - filemtime($urltable_filename)) > ($freq * 86400))
1820
		|| $forceupdate) {
1821

    
1822
		// Try to fetch the URL supplied
1823
		conf_mount_rw();
1824
		unlink_if_exists($urltable_filename . ".tmp");
1825
		// Use fetch to grab data since these may be large files, we don't want to process them through PHP if we can help it.
1826
		mwexec("/usr/bin/fetch -q -o " . escapeshellarg($urltable_filename . ".tmp") . " " . escapeshellarg($url));
1827
		// Remove comments. Might need some grep-fu to only allow lines that look like IPs/subnets
1828
		mwexec("/usr/bin/grep -v '^#' " . escapeshellarg($urltable_filename . ".tmp") . " > " . escapeshellarg($urltable_filename));
1829
		unlink_if_exists($urltable_filename . ".tmp");
1830
		conf_mount_ro();
1831
		if (filesize($urltable_filename)) {
1832
			return true;
1833
		} else {
1834
			// If it's unfetchable or an empty file, bail
1835
			return false;
1836
		}
1837
	} else {
1838
		// File exists, and it doesn't need updated.
1839
		return -1;
1840
	}
1841
}
1842
function get_real_slice_from_glabel($label) {
1843
	$label = escapeshellarg($label);
1844
	return trim(`/sbin/glabel list | /usr/bin/grep -B2 ufs/{$label} | /usr/bin/head -n 1 | /usr/bin/cut -f3 -d' '`);
1845
}
1846
function nanobsd_get_boot_slice() {
1847
	return trim(`/sbin/mount | /usr/bin/grep pfsense | /usr/bin/cut -d'/' -f4 | /usr/bin/cut -d' ' -f1`);
1848
}
1849
function nanobsd_get_boot_drive() {
1850
	return trim(`/sbin/glabel list | /usr/bin/grep -B2 ufs/pfsense | /usr/bin/head -n 1 | /usr/bin/cut -f3 -d' ' | /usr/bin/cut -d's' -f1`);
1851
}
1852
function nanobsd_get_active_slice() {
1853
	$boot_drive = nanobsd_get_boot_drive();
1854
	$active = trim(`gpart show $boot_drive | grep '\[active\]' | awk '{print $3;}'`);
1855

    
1856
	return "{$boot_drive}s{$active}";
1857
}
1858
function nanobsd_get_size() {
1859
	return strtoupper(file_get_contents("/etc/nanosize.txt"));
1860
}
1861
function nanobsd_switch_boot_slice() {
1862
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
1863
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
1864
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
1865
	nanobsd_detect_slice_info();
1866

    
1867
	if ($BOOTFLASH == $ACTIVE_SLICE) {
1868
		$slice = $TOFLASH;
1869
	} else {
1870
		$slice = $BOOTFLASH;
1871
	}
1872

    
1873
	for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
1874
	ob_implicit_flush(1);
1875
	if(strstr($slice, "s2")) {
1876
		$ASLICE="2";
1877
		$AOLDSLICE="1";
1878
		$AGLABEL_SLICE="pfsense1";
1879
		$AUFS_ID="1";
1880
		$AOLD_UFS_ID="0";
1881
	} else {
1882
		$ASLICE="1";
1883
		$AOLDSLICE="2";
1884
		$AGLABEL_SLICE="pfsense0";
1885
		$AUFS_ID="0";
1886
		$AOLD_UFS_ID="1";
1887
	}
1888
	$ATOFLASH="{$BOOT_DRIVE}s{$ASLICE}";
1889
	$ACOMPLETE_PATH="{$BOOT_DRIVE}s{$ASLICE}a";
1890
	$ABOOTFLASH="{$BOOT_DRIVE}s{$AOLDSLICE}";
1891
	conf_mount_rw();
1892
	exec("sysctl kern.geom.debugflags=16");
1893
	exec("gpart set -a active -i {$ASLICE} {$BOOT_DRIVE}");
1894
	exec("/usr/sbin/boot0cfg -s {$ASLICE} -v /dev/{$BOOT_DRIVE}");
1895
	// We can't update these if they are mounted now.
1896
	if ($BOOTFLASH != $slice) {
1897
		exec("/sbin/tunefs -L ${AGLABEL_SLICE} /dev/$ACOMPLETE_PATH");
1898
		nanobsd_update_fstab($AGLABEL_SLICE, $ACOMPLETE_PATH, $AOLD_UFS_ID, $AUFS_ID);
1899
	}
1900
	exec("/sbin/sysctl kern.geom.debugflags=0");
1901
	conf_mount_ro();
1902
}
1903
function nanobsd_clone_slice() {
1904
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
1905
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
1906
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
1907
	nanobsd_detect_slice_info();
1908

    
1909
	for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
1910
	ob_implicit_flush(1);
1911
	exec("/sbin/sysctl kern.geom.debugflags=16");
1912
	exec("/bin/dd if=/dev/zero of=/dev/{$TOFLASH} bs=1m count=1");
1913
	exec("/bin/dd if=/dev/{$BOOTFLASH} of=/dev/{$TOFLASH} bs=64k");
1914
	exec("/sbin/tunefs -L {$GLABEL_SLICE} /dev/{$COMPLETE_PATH}");
1915
	$status = nanobsd_update_fstab($GLABEL_SLICE, $COMPLETE_PATH, $OLD_UFS_ID, $UFS_ID);
1916
	exec("/sbin/sysctl kern.geom.debugflags=0");
1917
	if($status) {
1918
		return false;
1919
	} else {
1920
		return true;
1921
	}
1922
}
1923
function nanobsd_update_fstab($gslice, $complete_path, $oldufs, $newufs) {
1924
	$tmppath = "/tmp/{$gslice}";
1925
	$fstabpath = "/tmp/{$gslice}/etc/fstab";
1926

    
1927
	exec("/bin/mkdir {$tmppath}");
1928
	exec("/sbin/fsck_ufs -y /dev/{$complete_path}");
1929
	exec("/sbin/mount /dev/ufs/{$gslice} {$tmppath}");
1930
	exec("/bin/cp /etc/fstab {$fstabpath}");
1931

    
1932
	if (!file_exists($fstabpath)) {
1933
		$fstab = <<<EOF
1934
/dev/ufs/{$gslice} / ufs ro,noatime 1 1
1935
/dev/ufs/cf /cf ufs ro,noatime 1 1
1936
EOF;
1937
		if (file_put_contents($fstabpath, $fstab))
1938
			$status = true;
1939
		else
1940
			$status = false;
1941
	} else {
1942
		$status = exec("sed -i \"\" \"s/pfsense{$oldufs}/pfsense{$newufs}/g\" {$fstabpath}");
1943
	}
1944
	exec("/sbin/umount {$tmppath}");
1945
	exec("/bin/rmdir {$tmppath}");
1946

    
1947
	return $status;
1948
}
1949
function nanobsd_detect_slice_info() {
1950
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
1951
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
1952
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
1953

    
1954
	$BOOT_DEVICE=nanobsd_get_boot_slice();
1955
	$REAL_BOOT_DEVICE=get_real_slice_from_glabel($BOOT_DEVICE);
1956
	$BOOT_DRIVE=nanobsd_get_boot_drive();
1957
	$ACTIVE_SLICE=nanobsd_get_active_slice();
1958

    
1959
	// Detect which slice is active and set information.
1960
	if(strstr($REAL_BOOT_DEVICE, "s1")) {
1961
		$SLICE="2";
1962
		$OLDSLICE="1";
1963
		$GLABEL_SLICE="pfsense1";
1964
		$UFS_ID="1";
1965
		$OLD_UFS_ID="0";
1966

    
1967
	} else {
1968
		$SLICE="1";
1969
		$OLDSLICE="2";
1970
		$GLABEL_SLICE="pfsense0";
1971
		$UFS_ID="0";
1972
		$OLD_UFS_ID="1";
1973
	}
1974
	$TOFLASH="{$BOOT_DRIVE}s{$SLICE}";
1975
	$COMPLETE_PATH="{$BOOT_DRIVE}s{$SLICE}a";
1976
	$COMPLETE_BOOT_PATH="{$BOOT_DRIVE}s{$OLDSLICE}";
1977
	$BOOTFLASH="{$BOOT_DRIVE}s{$OLDSLICE}";
1978
}
1979

    
1980
function nanobsd_friendly_slice_name($slicename) {
1981
	global $g;
1982
	return strtolower(str_ireplace('pfsense', $g['product_name'], $slicename));
1983
}
1984

    
1985
function get_include_contents($filename) {
1986
    if (is_file($filename)) {
1987
        ob_start();
1988
        include $filename;
1989
        $contents = ob_get_contents();
1990
        ob_end_clean();
1991
        return $contents;
1992
    }
1993
    return false;
1994
}
1995

    
1996
/* This xml 2 array function is courtesy of the php.net comment section on xml_parse.
1997
 * it is roughly 4 times faster then our existing pfSense parser but due to the large
1998
 * size of the RRD xml dumps this is required.
1999
 * The reason we do not use it for pfSense is that it does not know about array fields
2000
 * which causes it to fail on array fields with single items. Possible Todo?
2001
 */
2002
function xml2array($contents, $get_attributes = 1, $priority = 'tag')
2003
{
2004
    if (!function_exists('xml_parser_create'))
2005
    {
2006
        return array ();
2007
    }
2008
    $parser = xml_parser_create('');
2009
    xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8");
2010
    xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2011
    xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
2012
    xml_parse_into_struct($parser, trim($contents), $xml_values);
2013
    xml_parser_free($parser);
2014
    if (!$xml_values)
2015
        return; //Hmm...
2016
    $xml_array = array ();
2017
    $parents = array ();
2018
    $opened_tags = array ();
2019
    $arr = array ();
2020
    $current = & $xml_array;
2021
    $repeated_tag_index = array ();
2022
    foreach ($xml_values as $data)
2023
    {
2024
        unset ($attributes, $value);
2025
        extract($data);
2026
        $result = array ();
2027
        $attributes_data = array ();
2028
        if (isset ($value))
2029
        {
2030
            if ($priority == 'tag')
2031
                $result = $value;
2032
            else
2033
                $result['value'] = $value;
2034
        }
2035
        if (isset ($attributes) and $get_attributes)
2036
        {
2037
            foreach ($attributes as $attr => $val)
2038
            {
2039
                if ($priority == 'tag')
2040
                    $attributes_data[$attr] = $val;
2041
                else
2042
                    $result['attr'][$attr] = $val; //Set all the attributes in a array called 'attr'
2043
            }
2044
        }
2045
        if ($type == "open")
2046
        {
2047
            $parent[$level -1] = & $current;
2048
            if (!is_array($current) or (!in_array($tag, array_keys($current))))
2049
            {
2050
                $current[$tag] = $result;
2051
                if ($attributes_data)
2052
                    $current[$tag . '_attr'] = $attributes_data;
2053
                $repeated_tag_index[$tag . '_' . $level] = 1;
2054
                $current = & $current[$tag];
2055
            }
2056
            else
2057
            {
2058
                if (isset ($current[$tag][0]))
2059
                {
2060
                    $current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
2061
                    $repeated_tag_index[$tag . '_' . $level]++;
2062
                }
2063
                else
2064
                {
2065
                    $current[$tag] = array (
2066
                        $current[$tag],
2067
                        $result
2068
                    );
2069
                    $repeated_tag_index[$tag . '_' . $level] = 2;
2070
                    if (isset ($current[$tag . '_attr']))
2071
                    {
2072
                        $current[$tag]['0_attr'] = $current[$tag . '_attr'];
2073
                        unset ($current[$tag . '_attr']);
2074
                    }
2075
                }
2076
                $last_item_index = $repeated_tag_index[$tag . '_' . $level] - 1;
2077
                $current = & $current[$tag][$last_item_index];
2078
            }
2079
        }
2080
        elseif ($type == "complete")
2081
        {
2082
            if (!isset ($current[$tag]))
2083
            {
2084
                $current[$tag] = $result;
2085
                $repeated_tag_index[$tag . '_' . $level] = 1;
2086
                if ($priority == 'tag' and $attributes_data)
2087
                    $current[$tag . '_attr'] = $attributes_data;
2088
            }
2089
            else
2090
            {
2091
                if (isset ($current[$tag][0]) and is_array($current[$tag]))
2092
                {
2093
                    $current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
2094
                    if ($priority == 'tag' and $get_attributes and $attributes_data)
2095
                    {
2096
                        $current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
2097
                    }
2098
                    $repeated_tag_index[$tag . '_' . $level]++;
2099
                }
2100
                else
2101
                {
2102
                    $current[$tag] = array (
2103
                        $current[$tag],
2104
                        $result
2105
                    );
2106
                    $repeated_tag_index[$tag . '_' . $level] = 1;
2107
                    if ($priority == 'tag' and $get_attributes)
2108
                    {
2109
                        if (isset ($current[$tag . '_attr']))
2110
                        {
2111
                            $current[$tag]['0_attr'] = $current[$tag . '_attr'];
2112
                            unset ($current[$tag . '_attr']);
2113
                        }
2114
                        if ($attributes_data)
2115
                        {
2116
                            $current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
2117
                        }
2118
                    }
2119
                    $repeated_tag_index[$tag . '_' . $level]++; //0 and 1 index is already taken
2120
                }
2121
            }
2122
        }
2123
        elseif ($type == 'close')
2124
        {
2125
            $current = & $parent[$level -1];
2126
        }
2127
    }
2128
    return ($xml_array);
2129
}
2130

    
2131
function get_country_name($country_code) {
2132
	if ($country_code != "ALL" && strlen($country_code) != 2)
2133
		return "";
2134

    
2135
	$country_names_xml = "/usr/local/share/mobile-broadband-provider-info/iso_3166-1_list_en.xml";
2136
	$country_names_contents = file_get_contents($country_names_xml);
2137
	$country_names = xml2array($country_names_contents);
2138

    
2139
	if($country_code == "ALL") {
2140
		$country_list = array();
2141
		foreach($country_names['ISO_3166-1_List_en']['ISO_3166-1_Entry'] as $country) {
2142
			$country_list[] = array( "code" => $country['ISO_3166-1_Alpha-2_Code_element'],
2143
						 "name" => ucwords(strtolower($country['ISO_3166-1_Country_name'])) );
2144
		}
2145
		return $country_list;
2146
	}
2147

    
2148
	foreach ($country_names['ISO_3166-1_List_en']['ISO_3166-1_Entry'] as $country) {
2149
		if ($country['ISO_3166-1_Alpha-2_Code_element'] == strtoupper($country_code)) {
2150
			return ucwords(strtolower($country['ISO_3166-1_Country_name']));
2151
		}
2152
	}
2153
	return "";
2154
}
2155

    
2156
/* sort by interface only, retain the original order of rules that apply to
2157
   the same interface */
2158
function filter_rules_sort() {
2159
	global $config;
2160

    
2161
	/* mark each rule with the sequence number (to retain the order while sorting) */
2162
	for ($i = 0; isset($config['filter']['rule'][$i]); $i++)
2163
		$config['filter']['rule'][$i]['seq'] = $i;
2164

    
2165
	usort($config['filter']['rule'], "filter_rules_compare");
2166

    
2167
	/* strip the sequence numbers again */
2168
	for ($i = 0; isset($config['filter']['rule'][$i]); $i++)
2169
		unset($config['filter']['rule'][$i]['seq']);
2170
}
2171
function filter_rules_compare($a, $b) {
2172
	if (isset($a['floating']) && isset($b['floating']))
2173
		return $a['seq'] - $b['seq'];
2174
	else if (isset($a['floating']))
2175
		return -1;
2176
	else if (isset($b['floating']))
2177
		return 1;
2178
	else if ($a['interface'] == $b['interface'])
2179
		return $a['seq'] - $b['seq'];
2180
	else
2181
		return compare_interface_friendly_names($a['interface'], $b['interface']);
2182
}
2183

    
2184
/****f* pfsense-utils/load_mac_manufacturer_table
2185
 * NAME
2186
 *   load_mac_manufacturer_table
2187
 * INPUTS
2188
 *   none
2189
 * RESULT
2190
 *   returns associative array with MAC-Manufacturer pairs
2191
 ******/
2192
function load_mac_manufacturer_table() {
2193
	/* load MAC-Manufacture data from the file */
2194
	$macs = false;
2195
	if (file_exists("/usr/local/share/nmap/nmap-mac-prefixes"))
2196
		$macs=file("/usr/local/share/nmap/nmap-mac-prefixes");
2197
	if ($macs){
2198
		foreach ($macs as $line){
2199
			if (preg_match('/([0-9A-Fa-f]{6}) (.*)$/', $line, $matches)){
2200
				/* store values like this $mac_man['000C29']='VMware' */
2201
				$mac_man["$matches[1]"]=$matches[2];
2202
			}
2203
		}
2204
 		return $mac_man;
2205
	} else
2206
		return -1;
2207

    
2208
}
2209

    
2210
/****f* pfsense-utils/is_ipaddr_configured
2211
 * NAME
2212
 *   is_ipaddr_configured
2213
 * INPUTS
2214
 *   IP Address to check.
2215
 * RESULT
2216
 *   returns true if the IP Address is
2217
 *   configured and present on this device.
2218
*/
2219
function is_ipaddr_configured($ipaddr) {
2220
	$interface_list_ips = get_configured_ip_addresses();
2221
	foreach($interface_list_ips as $ilips) {
2222
		if(strcasecmp($ipaddr, $ilips) == 0) 
2223
				return true;
2224
	}	
2225
}
2226

    
2227
/****f* pfsense-utils/pfSense_handle_custom_code
2228
 * NAME
2229
 *   pfSense_handle_custom_code
2230
 * INPUTS
2231
 *   directory name to process
2232
 * RESULT
2233
 *   globs the directory and includes the files
2234
 */
2235
function pfSense_handle_custom_code($src_dir) {
2236
	// Allow extending of the nat edit page and include custom input validation 
2237
	if(is_dir("$src_dir")) {
2238
		$cf = glob($src_dir);
2239
		foreach($cf as $nf) {
2240
			if($nf == "." || $nf == "..") 
2241
				continue;
2242
			// Include the extra handler
2243
			include("$src_dir/$nf");
2244
		}
2245
	}
2246
}
2247

    
2248
?>
(35-35/61)