Project

General

Profile

Download (85.8 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/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_natpfruleint_access
44
 * NAME
45
 *   have_natpfruleint_access
46
 * INPUTS
47
 *	none
48
 * RESULT
49
 *   returns true if user has access to edit a specific firewall nat port forward interface
50
 ******/
51
function have_natpfruleint_access($if) {
52
	$security_url = "firewall_nat_edit.php?if=". strtolower($if);
53
	if(isAllowedPage($security_url, $allowed))
54
		return true;
55
	return false;
56
}
57

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

    
73
/****f* pfsense-utils/does_url_exist
74
 * NAME
75
 *   does_url_exist
76
 * INPUTS
77
 *	none
78
 * RESULT
79
 *   returns true if a url is available
80
 ******/
81
function does_url_exist($url) {
82
	$fd = fopen("$url","r");
83
	if($fd) {
84
		fclose($fd);
85
		return true;
86
	} else {
87
		return false;
88
	}
89
}
90

    
91
/****f* pfsense-utils/is_private_ip
92
 * NAME
93
 *   is_private_ip
94
 * INPUTS
95
 *	none
96
 * RESULT
97
 *   returns true if an ip address is in a private range
98
 ******/
99
function is_private_ip($iptocheck) {
100
	$isprivate = false;
101
	$ip_private_list=array(
102
		"10.0.0.0/8",
103
		"100.64.0.0/10",
104
		"172.16.0.0/12",
105
		"192.168.0.0/16",
106
	);
107
	foreach($ip_private_list as $private) {
108
		if(ip_in_subnet($iptocheck,$private)==true)
109
			$isprivate = true;
110
	}
111
	return $isprivate;
112
}
113

    
114
/****f* pfsense-utils/get_tmp_file
115
 * NAME
116
 *   get_tmp_file
117
 * INPUTS
118
 *	none
119
 * RESULT
120
 *   returns a temporary filename
121
 ******/
122
function get_tmp_file() {
123
	global $g;
124
	return "{$g['tmp_path']}/tmp-" . time();
125
}
126

    
127
/****f* pfsense-utils/get_dns_servers
128
 * NAME
129
 *   get_dns_servres - get system dns servers
130
 * INPUTS
131
 *   $dns_servers - an array of the dns servers
132
 * RESULT
133
 *   null
134
 ******/
135
function get_dns_servers() {
136
	$dns_servers = array();
137
	$dns_s = file("/etc/resolv.conf", FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
138
	foreach($dns_s as $dns) {
139
		$matches = "";
140
		if (preg_match("/nameserver (.*)/", $dns, $matches))
141
			$dns_servers[] = $matches[1];
142
	}
143
	return array_unique($dns_servers);
144
}
145

    
146
function hardware_offloading_applyflags($iface) {
147
	global $config;
148

    
149
	$flags_on = 0;
150
	$flags_off = 0;
151
	$options = pfSense_get_interface_addresses($iface);
152

    
153
	if(isset($config['system']['disablechecksumoffloading'])) {
154
		if (isset($options['encaps']['txcsum']))
155
			$flags_off |= IFCAP_TXCSUM;
156
		if (isset($options['encaps']['rxcsum']))
157
			$flags_off |= IFCAP_RXCSUM;
158
	} else {
159
		if (isset($options['caps']['txcsum']))
160
			$flags_on |= IFCAP_TXCSUM;
161
		if (isset($options['caps']['rxcsum']))
162
			$flags_on |= IFCAP_RXCSUM;
163
	}
164

    
165
	if(isset($config['system']['disablesegmentationoffloading']))
166
		$flags_off |= IFCAP_TSO;
167
	else if (isset($options['caps']['tso']) || isset($options['caps']['tso4']) || isset($options['caps']['tso6']))
168
		$flags_on |= IFCAP_TSO;
169

    
170
	if(isset($config['system']['disablelargereceiveoffloading']))
171
		$flags_off |= IFCAP_LRO;
172
	else if (isset($options['caps']['lro']))
173
		$flags_on |= IFCAP_LRO;
174

    
175
	/* if the NIC supports polling *AND* it is enabled in the GUI */
176
	if (!isset($config['system']['polling']))
177
		$flags_off |= IFCAP_POLLING;
178
	else if (isset($options['caps']['polling']))
179
		$flags_on |= IFCAP_POLLING;
180

    
181
	pfSense_interface_capabilities($iface, -$flags_off);
182
	pfSense_interface_capabilities($iface, $flags_on);
183
}
184

    
185
/****f* pfsense-utils/enable_hardware_offloading
186
 * NAME
187
 *   enable_hardware_offloading - Enable a NIC's supported hardware features.
188
 * INPUTS
189
 *   $interface	- string containing the physical interface to work on.
190
 * RESULT
191
 *   null
192
 * NOTES
193
 *   This function only supports the fxp driver's loadable microcode.
194
 ******/
195
function enable_hardware_offloading($interface) {
196
	global $g, $config;
197

    
198
	$int = get_real_interface($interface);
199
	if(empty($int))
200
		return;
201

    
202
	if (!isset($config['system']['do_not_use_nic_microcode'])) {
203
		/* translate wan, lan, opt -> real interface if needed */
204
		$int_family = preg_split("/[0-9]+/", $int);
205
		$supported_ints = array('fxp');
206
		if (in_array($int_family, $supported_ints)) {
207
			if(does_interface_exist($int))
208
				pfSense_interface_flags($int, IFF_LINK0);
209
		}
210
	}
211

    
212
	/* This is mostly for vlans and ppp types */
213
	$realhwif = get_parent_interface($interface);
214
	if ($realhwif[0] == $int)
215
		hardware_offloading_applyflags($int);
216
	else {
217
		hardware_offloading_applyflags($realhwif[0]);
218
		hardware_offloading_applyflags($int);
219
	}
220
}
221

    
222
/****f* pfsense-utils/interface_supports_polling
223
 * NAME
224
 *   checks to see if an interface supports polling according to man polling
225
 * INPUTS
226
 *
227
 * RESULT
228
 *   true or false
229
 * NOTES
230
 *
231
 ******/
232
function interface_supports_polling($iface) {
233
	$opts = pfSense_get_interface_addresses($iface);
234
	if (is_array($opts) && isset($opts['caps']['polling']))
235
		return true;
236

    
237
	return false;
238
}
239

    
240
/****f* pfsense-utils/is_alias_inuse
241
 * NAME
242
 *   checks to see if an alias is currently in use by a rule
243
 * INPUTS
244
 *
245
 * RESULT
246
 *   true or false
247
 * NOTES
248
 *
249
 ******/
250
function is_alias_inuse($alias) {
251
	global $g, $config;
252

    
253
	if($alias == "") return false;
254
	/* loop through firewall rules looking for alias in use */
255
	if(is_array($config['filter']['rule']))
256
		foreach($config['filter']['rule'] as $rule) {
257
			if($rule['source']['address'])
258
				if($rule['source']['address'] == $alias)
259
					return true;
260
			if($rule['destination']['address'])
261
				if($rule['destination']['address'] == $alias)
262
					return true;
263
		}
264
	/* loop through nat rules looking for alias in use */
265
	if(is_array($config['nat']['rule']))
266
		foreach($config['nat']['rule'] as $rule) {
267
			if($rule['target'] && $rule['target'] == $alias)
268
				return true;
269
			if($rule['source']['address'] && $rule['source']['address'] == $alias)
270
				return true;
271
			if($rule['destination']['address'] && $rule['destination']['address'] == $alias)
272
				return true;
273
		}
274
	return false;
275
}
276

    
277
/****f* pfsense-utils/is_schedule_inuse
278
 * NAME
279
 *   checks to see if a schedule is currently in use by a rule
280
 * INPUTS
281
 *
282
 * RESULT
283
 *   true or false
284
 * NOTES
285
 *
286
 ******/
287
function is_schedule_inuse($schedule) {
288
	global $g, $config;
289

    
290
	if($schedule == "") return false;
291
	/* loop through firewall rules looking for schedule in use */
292
	if(is_array($config['filter']['rule']))
293
		foreach($config['filter']['rule'] as $rule) {
294
			if($rule['sched'] == $schedule)
295
				return true;
296
		}
297
	return false;
298
}
299

    
300
/****f* pfsense-utils/setup_polling
301
 * NAME
302
 *   sets up polling
303
 * INPUTS
304
 *
305
 * RESULT
306
 *   null
307
 * NOTES
308
 *
309
 ******/
310
function setup_polling() {
311
	global $g, $config;
312

    
313
	if (isset($config['system']['polling']))
314
		set_single_sysctl("kern.polling.idle_poll", "1");
315
	else
316
		set_single_sysctl("kern.polling.idle_poll", "0");
317

    
318
	if($config['system']['polling_each_burst'])
319
		set_single_sysctl("kern.polling.each_burst", $config['system']['polling_each_burst']);
320
	if($config['system']['polling_burst_max'])
321
		set_single_sysctl("kern.polling.burst_max", $config['system']['polling_burst_max']);
322
	if($config['system']['polling_user_frac'])
323
		set_single_sysctl("kern.polling.user_frac", $config['system']['polling_user_frac']);
324
}
325

    
326
/****f* pfsense-utils/setup_microcode
327
 * NAME
328
 *   enumerates all interfaces and calls enable_hardware_offloading which
329
 *   enables a NIC's supported hardware features.
330
 * INPUTS
331
 *
332
 * RESULT
333
 *   null
334
 * NOTES
335
 *   This function only supports the fxp driver's loadable microcode.
336
 ******/
337
function setup_microcode() {
338

    
339
	/* if list */
340
	$iflist = get_configured_interface_list(false, true);
341
	foreach($iflist as $if => $ifdescr)
342
		enable_hardware_offloading($if);
343
	unset($iflist);
344
}
345

    
346
/****f* pfsense-utils/get_carp_status
347
 * NAME
348
 *   get_carp_status - Return whether CARP is enabled or disabled.
349
 * RESULT
350
 *   boolean	- true if CARP is enabled, false if otherwise.
351
 ******/
352
function get_carp_status() {
353
	/* grab the current status of carp */
354
	$status = get_single_sysctl('net.inet.carp.allow');
355
	return (intval($status) > 0);
356
}
357

    
358
/*
359
 * convert_ip_to_network_format($ip, $subnet): converts an ip address to network form
360

    
361
 */
362
function convert_ip_to_network_format($ip, $subnet) {
363
	$ipsplit = explode('.', $ip);
364
	$string = $ipsplit[0] . "." . $ipsplit[1] . "." . $ipsplit[2] . ".0/" . $subnet;
365
	return $string;
366
}
367

    
368
/*
369
 * get_carp_interface_status($carpinterface): returns the status of a carp ip
370
 */
371
function get_carp_interface_status($carpinterface) {
372
	$carp_query = "";
373

    
374
	/* XXX: Need to find a better way for this! */
375
	list ($interface, $vhid) = explode("_vip", $carpinterface);
376
	$interface = get_real_interface($interface);
377
	exec("/sbin/ifconfig $interface | /usr/bin/grep -v grep | /usr/bin/grep carp: | /usr/bin/grep 'vhid {$vhid}'", $carp_query);
378
	foreach($carp_query as $int) {
379
		if(stristr($int, "MASTER"))
380
			return "MASTER";
381
		if(stristr($int, "BACKUP"))
382
			return "BACKUP";
383
		if(stristr($int, "INIT"))
384
			return "INIT";
385
	}
386
	return;
387
}
388

    
389
/*
390
 * get_pfsync_interface_status($pfsyncinterface): returns the status of a pfsync
391
 */
392
function get_pfsync_interface_status($pfsyncinterface) {
393
	if (!does_interface_exist($pfsyncinterface))
394
		return;
395

    
396
	return exec_command("/sbin/ifconfig {$pfsyncinterface} | /usr/bin/awk '/pfsync:/ {print \$5}'");
397
}
398

    
399
/*
400
 * add_rule_to_anchor($anchor, $rule): adds the specified rule to an anchor
401
 */
402
function add_rule_to_anchor($anchor, $rule, $label) {
403
	mwexec("echo " . escapeshellarg($rule) . " | /sbin/pfctl -a " . escapeshellarg($anchor) . ":" . escapeshellarg($label) . " -f -");
404
}
405

    
406
/*
407
 * remove_text_from_file
408
 * remove $text from file $file
409
 */
410
function remove_text_from_file($file, $text) {
411
	if(!file_exists($file) && !is_writable($file))
412
		return;
413
	$filecontents = file_get_contents($file);
414
	$text = str_replace($text, "", $filecontents);
415
	@file_put_contents($file, $text);
416
}
417

    
418
/*
419
 * add_text_to_file($file, $text): adds $text to $file.
420
 * replaces the text if it already exists.
421
 */
422
function add_text_to_file($file, $text, $replace = false) {
423
	if(file_exists($file) and is_writable($file)) {
424
		$filecontents = file($file);
425
		$filecontents = array_map('rtrim', $filecontents);
426
		array_push($filecontents, $text);
427
		if ($replace)
428
			$filecontents = array_unique($filecontents);
429

    
430
		$file_text = implode("\n", $filecontents);
431

    
432
		@file_put_contents($file, $file_text);
433
		return true;
434
	}
435
	return false;
436
}
437

    
438
/*
439
 *   after_sync_bump_adv_skew(): create skew values by 1S
440
 */
441
function after_sync_bump_adv_skew() {
442
	global $config, $g;
443
	$processed_skew = 1;
444
	$a_vip = &$config['virtualip']['vip'];
445
	foreach ($a_vip as $vipent) {
446
		if($vipent['advskew'] <> "") {
447
			$processed_skew = 1;
448
			$vipent['advskew'] = $vipent['advskew']+1;
449
		}
450
	}
451
	if($processed_skew == 1)
452
		write_config(gettext("After synch increase advertising skew"));
453
}
454

    
455
/*
456
 * get_filename_from_url($url): converts a url to its filename.
457
 */
458
function get_filename_from_url($url) {
459
	return basename($url);
460
}
461

    
462
/*
463
 *   get_dir: return an array of $dir
464
 */
465
function get_dir($dir) {
466
	$dir_array = array();
467
	$d = dir($dir);
468
	while (false !== ($entry = $d->read())) {
469
		array_push($dir_array, $entry);
470
	}
471
	$d->close();
472
	return $dir_array;
473
}
474

    
475
/****f* pfsense-utils/WakeOnLan
476
 * NAME
477
 *   WakeOnLan - Wake a machine up using the wake on lan format/protocol
478
 * RESULT
479
 *   true/false - true if the operation was successful
480
 ******/
481
function WakeOnLan($addr, $mac)
482
{
483
	$addr_byte = explode(':', $mac);
484
	$hw_addr = '';
485

    
486
	for ($a=0; $a < 6; $a++)
487
		$hw_addr .= chr(hexdec($addr_byte[$a]));
488

    
489
	$msg = chr(255).chr(255).chr(255).chr(255).chr(255).chr(255);
490

    
491
	for ($a = 1; $a <= 16; $a++)
492
		$msg .= $hw_addr;
493

    
494
	// send it to the broadcast address using UDP
495
	$s = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
496
	if ($s == false) {
497
		log_error(gettext("Error creating socket!"));
498
		log_error(sprintf(gettext("Error code is '%1\$s' - %2\$s"), socket_last_error($s), socket_strerror(socket_last_error($s))));
499
	} else {
500
		// setting a broadcast option to socket:
501
		$opt_ret =  socket_set_option($s, 1, 6, TRUE);
502
		if($opt_ret < 0)
503
			log_error(sprintf(gettext("setsockopt() failed, error: %s"), strerror($opt_ret)));
504
		$e = socket_sendto($s, $msg, strlen($msg), 0, $addr, 2050);
505
		socket_close($s);
506
		log_error(sprintf(gettext('Magic Packet sent (%1$s) to {%2$s} MAC=%3$s'), $e, $addr, $mac));
507
		return true;
508
	}
509

    
510
	return false;
511
}
512

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

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

    
536
/*
537
 *  restore_config_section($section_name, new_contents): restore a configuration section,
538
 *                                                  and write the configuration out
539
 *                                                  to disk/cf.
540
 */
541
function restore_config_section($section_name, $new_contents) {
542
	global $config, $g;
543
	conf_mount_rw();
544
	$fout = fopen("{$g['tmp_path']}/tmpxml","w");
545
	fwrite($fout, $new_contents);
546
	fclose($fout);
547

    
548
	$xml = parse_xml_config($g['tmp_path'] . "/tmpxml", null);
549
	if ($xml['pfsense']) {
550
		$xml = $xml['pfsense'];
551
	}
552
	else if ($xml['m0n0wall']) {
553
		$xml = $xml['m0n0wall'];
554
	}
555
	if ($xml[$section_name]) {
556
		$section_xml = $xml[$section_name];
557
	} else {
558
		$section_xml = -1;
559
	}
560

    
561
	@unlink($g['tmp_path'] . "/tmpxml");
562
	if ($section_xml === -1) {
563
		return false;
564
	}
565
	$config[$section_name] = &$section_xml;
566
	if(file_exists("{$g['tmp_path']}/config.cache"))
567
		unlink("{$g['tmp_path']}/config.cache");
568
	write_config(sprintf(gettext("Restored %s of config file (maybe from CARP partner)"), $section_name));
569
	disable_security_checks();
570
	conf_mount_ro();
571
	return true;
572
}
573

    
574
/*
575
 *  merge_config_section($section_name, new_contents):   restore a configuration section,
576
 *                                                  and write the configuration out
577
 *                                                  to disk/cf.  But preserve the prior
578
 * 													structure if needed
579
 */
580
function merge_config_section($section_name, $new_contents) {
581
	global $config;
582
	conf_mount_rw();
583
	$fname = get_tmp_filename();
584
	$fout = fopen($fname, "w");
585
	fwrite($fout, $new_contents);
586
	fclose($fout);
587
	$section_xml = parse_xml_config($fname, $section_name);
588
	$config[$section_name] = $section_xml;
589
	unlink($fname);
590
	write_config(sprintf(gettext("Restored %s of config file (maybe from CARP partner)"), $section_name));
591
	disable_security_checks();
592
	conf_mount_ro();
593
	return;
594
}
595

    
596
/*
597
 * http_post($server, $port, $url, $vars): does an http post to a web server
598
 *                                         posting the vars array.
599
 * written by nf@bigpond.net.au
600
 */
601
function http_post($server, $port, $url, $vars) {
602
	$user_agent = "Mozilla/4.0 (compatible; MSIE 5.5; Windows 98)";
603
	$urlencoded = "";
604
	while (list($key,$value) = each($vars))
605
		$urlencoded.= urlencode($key) . "=" . urlencode($value) . "&";
606
	$urlencoded = substr($urlencoded,0,-1);
607
	$content_length = strlen($urlencoded);
608
	$headers = "POST $url HTTP/1.1
609
Accept: */*
610
Accept-Language: en-au
611
Content-Type: application/x-www-form-urlencoded
612
User-Agent: $user_agent
613
Host: $server
614
Connection: Keep-Alive
615
Cache-Control: no-cache
616
Content-Length: $content_length
617

    
618
";
619

    
620
	$errno = "";
621
	$errstr = "";
622
	$fp = fsockopen($server, $port, $errno, $errstr);
623
	if (!$fp) {
624
		return false;
625
	}
626

    
627
	fputs($fp, $headers);
628
	fputs($fp, $urlencoded);
629

    
630
	$ret = "";
631
	while (!feof($fp))
632
		$ret.= fgets($fp, 1024);
633
	fclose($fp);
634

    
635
	return $ret;
636
}
637

    
638
/*
639
 *  php_check_syntax($code_tocheck, $errormessage): checks $code_to_check for errors
640
 */
641
if (!function_exists('php_check_syntax')){
642
	global $g;
643
	function php_check_syntax($code_to_check, &$errormessage){
644
		return false;
645
		$fout = fopen("{$g['tmp_path']}/codetocheck.php","w");
646
		$code = $_POST['content'];
647
		$code = str_replace("<?php", "", $code);
648
		$code = str_replace("?>", "", $code);
649
		fwrite($fout, "<?php\n\n");
650
		fwrite($fout, $code_to_check);
651
		fwrite($fout, "\n\n?>\n");
652
		fclose($fout);
653
		$command = "/usr/local/bin/php -l {$g['tmp_path']}/codetocheck.php";
654
		$output = exec_command($command);
655
		if (stristr($output, "Errors parsing") == false) {
656
			echo "false\n";
657
			$errormessage = '';
658
			return(false);
659
		} else {
660
			$errormessage = $output;
661
			return(true);
662
		}
663
	}
664
}
665

    
666
/*
667
 *  php_check_filename_syntax($filename, $errormessage): checks the file $filename for errors
668
 */
669
if (!function_exists('php_check_syntax')){
670
	function php_check_syntax($code_to_check, &$errormessage){
671
		return false;
672
		$command = "/usr/local/bin/php -l " . escapeshellarg($code_to_check);
673
		$output = exec_command($command);
674
		if (stristr($output, "Errors parsing") == false) {
675
			echo "false\n";
676
			$errormessage = '';
677
			return(false);
678
		} else {
679
			$errormessage = $output;
680
			return(true);
681
		}
682
	}
683
}
684

    
685
/*
686
 * rmdir_recursive($path,$follow_links=false)
687
 * Recursively remove a directory tree (rm -rf path)
688
 * This is for directories _only_
689
 */
690
function rmdir_recursive($path,$follow_links=false) {
691
	$to_do = glob($path);
692
	if(!is_array($to_do)) $to_do = array($to_do);
693
	foreach($to_do as $workingdir) { // Handle wildcards by foreaching.
694
		if(file_exists($workingdir)) {
695
			if(is_dir($workingdir)) {
696
				$dir = opendir($workingdir);
697
				while ($entry = readdir($dir)) {
698
					if (is_file("$workingdir/$entry") || ((!$follow_links) && is_link("$workingdir/$entry")))
699
						unlink("$workingdir/$entry");
700
					elseif (is_dir("$workingdir/$entry") && $entry!='.' && $entry!='..')
701
						rmdir_recursive("$workingdir/$entry");
702
				}
703
				closedir($dir);
704
				rmdir($workingdir);
705
			} elseif (is_file($workingdir)) {
706
				unlink($workingdir);
707
			}
708
		}
709
	}
710
	return;
711
}
712

    
713
/*
714
 * call_pfsense_method(): Call a method exposed by the pfsense.org XMLRPC server.
715
 */
716
function call_pfsense_method($method, $params, $timeout = 0) {
717
	global $g, $config;
718

    
719
	$xmlrpc_base_url = get_active_xml_rpc_base_url();
720
	$xmlrpc_path = $g['xmlrpcpath'];
721
	
722
	$xmlrpcfqdn = preg_replace("(https?://)", "", $xmlrpc_base_url);
723
	$ip = gethostbyname($xmlrpcfqdn);
724
	if($ip == $xmlrpcfqdn)
725
		return false;
726

    
727
	$msg = new XML_RPC_Message($method, array(XML_RPC_Encode($params)));
728
	$port = 0;
729
	$proxyurl = "";
730
	$proxyport = 0;
731
	$proxyuser = "";
732
	$proxypass = "";
733
	if (!empty($config['system']['proxyurl']))
734
		$proxyurl = $config['system']['proxyurl'];
735
	if (!empty($config['system']['proxyport']) && is_numeric($config['system']['proxyport']))
736
		$proxyport = $config['system']['proxyport'];
737
	if (!empty($config['system']['proxyuser']))
738
		$proxyuser = $config['system']['proxyuser'];
739
	if (!empty($config['system']['proxypass']))
740
		$proxypass = $config['system']['proxypass'];
741
	$cli = new XML_RPC_Client($xmlrpc_path, $xmlrpc_base_url, $port, $proxyurl, $proxyport, $proxyuser, $proxypass);
742
	// If the ALT PKG Repo has a username/password set, use it.
743
	if($config['system']['altpkgrepo']['username'] &&
744
	   $config['system']['altpkgrepo']['password']) {
745
		$username = $config['system']['altpkgrepo']['username'];
746
		$password = $config['system']['altpkgrepo']['password'];
747
		$cli->setCredentials($username, $password);
748
	}
749
	$resp = $cli->send($msg, $timeout);
750
	if(!is_object($resp)) {
751
		log_error(sprintf(gettext("XMLRPC communication error: %s"), $cli->errstr));
752
		return false;
753
	} elseif($resp->faultCode()) {
754
		log_error(sprintf(gettext('XMLRPC request failed with error %1$s: %2$s'), $resp->faultCode(), $resp->faultString()));
755
		return false;
756
	} else {
757
		return XML_RPC_Decode($resp->value());
758
	}
759
}
760

    
761
/*
762
 * check_firmware_version(): Check whether the current firmware installed is the most recently released.
763
 */
764
function check_firmware_version($tocheck = "all", $return_php = true) {
765
	global $g, $config;
766
	
767
	$xmlrpc_base_url = get_active_xml_rpc_base_url();
768
	$xmlrpcfqdn = preg_replace("(https?://)", "", $xmlrpc_base_url);
769
	$ip = gethostbyname($xmlrpcfqdn);
770
	if($ip == $xmlrpcfqdn)
771
		return false;
772
	$version = php_uname('r');
773
	$version = explode('-', $version);
774
	$rawparams = array("firmware" => array("version" => trim(file_get_contents('/etc/version'))),
775
		"kernel"   => array("version" => $version[0]),
776
		"base"     => array("version" => $version[0]),
777
		"platform" => trim(file_get_contents('/etc/platform')),
778
		"config_version" => $config['version']
779
		);
780
	unset($version);
781

    
782
	if($tocheck == "all") {
783
		$params = $rawparams;
784
	} else {
785
		foreach($tocheck as $check) {
786
			$params['check'] = $rawparams['check'];
787
			$params['platform'] = $rawparams['platform'];
788
		}
789
	}
790
	if($config['system']['firmware']['branch'])
791
		$params['branch'] = $config['system']['firmware']['branch'];
792

    
793
	/* XXX: What is this method? */
794
	if(!($versions = call_pfsense_method('pfsense.get_firmware_version', $params))) {
795
		return false;
796
	} else {
797
		$versions["current"] = $params;
798
	}
799

    
800
	return $versions;
801
}
802

    
803
/*
804
 * host_firmware_version(): Return the versions used in this install
805
 */
806
function host_firmware_version($tocheck = "") {
807
	global $g, $config;
808

    
809
	$os_version = trim(substr(php_uname("r"), 0, strpos(php_uname("r"), '-')));
810

    
811
	return array(
812
		"firmware" => array("version" => trim(file_get_contents('/etc/version', " \n"))),
813
		"kernel"   => array("version" => $os_version),
814
		"base"     => array("version" => $os_version),
815
		"platform" => trim(file_get_contents('/etc/platform', " \n")),
816
		"config_version" => $config['version']
817
	);
818
}
819

    
820
function get_disk_info() {
821
	$diskout = "";
822
	exec("/bin/df -h | /usr/bin/grep -w '/' | /usr/bin/awk '{ print $2, $3, $4, $5 }'", $diskout);
823
	return explode(' ', $diskout[0]);
824
}
825

    
826
/****f* pfsense-utils/strncpy
827
 * NAME
828
 *   strncpy - copy strings
829
 * INPUTS
830
 *   &$dst, $src, $length
831
 * RESULT
832
 *   none
833
 ******/
834
function strncpy(&$dst, $src, $length) {
835
	if (strlen($src) > $length) {
836
		$dst = substr($src, 0, $length);
837
	} else {
838
		$dst = $src;
839
	}
840
}
841

    
842
/****f* pfsense-utils/reload_interfaces_sync
843
 * NAME
844
 *   reload_interfaces - reload all interfaces
845
 * INPUTS
846
 *   none
847
 * RESULT
848
 *   none
849
 ******/
850
function reload_interfaces_sync() {
851
	global $config, $g;
852

    
853
	if($g['debug'])
854
		log_error(gettext("reload_interfaces_sync() is starting."));
855

    
856
	/* parse config.xml again */
857
	$config = parse_config(true);
858

    
859
	/* enable routing */
860
	system_routing_enable();
861
	if($g['debug'])
862
		log_error(gettext("Enabling system routing"));
863

    
864
	if($g['debug'])
865
		log_error(gettext("Cleaning up Interfaces"));
866

    
867
	/* set up interfaces */
868
	interfaces_configure();
869
}
870

    
871
/****f* pfsense-utils/reload_all
872
 * NAME
873
 *   reload_all - triggers a reload of all settings
874
 *   * INPUTS
875
 *   none
876
 * RESULT
877
 *   none
878
 ******/
879
function reload_all() {
880
	send_event("service reload all");
881
}
882

    
883
/****f* pfsense-utils/reload_interfaces
884
 * NAME
885
 *   reload_interfaces - triggers a reload of all interfaces
886
 * INPUTS
887
 *   none
888
 * RESULT
889
 *   none
890
 ******/
891
function reload_interfaces() {
892
	send_event("interface all reload");
893
}
894

    
895
/****f* pfsense-utils/reload_all_sync
896
 * NAME
897
 *   reload_all - reload all settings
898
 *   * INPUTS
899
 *   none
900
 * RESULT
901
 *   none
902
 ******/
903
function reload_all_sync() {
904
	global $config, $g;
905

    
906
	/* parse config.xml again */
907
	$config = parse_config(true);
908

    
909
	/* set up our timezone */
910
	system_timezone_configure();
911

    
912
	/* set up our hostname */
913
	system_hostname_configure();
914

    
915
	/* make hosts file */
916
	system_hosts_generate();
917

    
918
	/* generate resolv.conf */
919
	system_resolvconf_generate();
920

    
921
	/* enable routing */
922
	system_routing_enable();
923

    
924
	/* set up interfaces */
925
	interfaces_configure();
926

    
927
	/* start dyndns service */
928
	services_dyndns_configure();
929

    
930
	/* configure cron service */
931
	configure_cron();
932

    
933
	/* start the NTP client */
934
	system_ntp_configure();
935

    
936
	/* sync pw database */
937
	conf_mount_rw();
938
	unlink_if_exists("/etc/spwd.db.tmp");
939
	mwexec("/usr/sbin/pwd_mkdb -d /etc/ /etc/master.passwd");
940
	conf_mount_ro();
941

    
942
	/* restart sshd */
943
	send_event("service restart sshd");
944

    
945
	/* restart webConfigurator if needed */
946
	send_event("service restart webgui");
947
}
948

    
949
function setup_serial_port($when="save", $path="") {
950
	global $g, $config;
951
	conf_mount_rw();
952
	$ttys_file = "{$path}/etc/ttys";
953
	$boot_config_file = "{$path}/boot.config";
954
	$loader_conf_file = "{$path}/boot/loader.conf";
955
	/* serial console - write out /boot.config */
956
	if(file_exists($boot_config_file))
957
		$boot_config = file_get_contents($boot_config_file);
958
	else
959
		$boot_config = "";
960

    
961
	$serialspeed = (is_numeric($config['system']['serialspeed'])) ? $config['system']['serialspeed'] : "115200";
962
	if ($g['platform'] != "cdrom") {
963
		$boot_config_split = explode("\n", $boot_config);
964
		$fd = fopen($boot_config_file,"w");
965
		if($fd) {
966
			foreach($boot_config_split as $bcs) {
967
				if(stristr($bcs, "-D") || stristr($bcs, "-h")) {
968
					/* DONT WRITE OUT, WE'LL DO IT LATER */
969
				} else {
970
					if($bcs <> "")
971
						fwrite($fd, "{$bcs}\n");
972
				}
973
			}
974
			if (($g['platform'] == "nanobsd") && !file_exists("/etc/nano_use_vga.txt"))
975
				fwrite($fd, "-S{$serialspeed} -h");
976
			else if (is_serial_enabled())
977
				fwrite($fd, "-S{$serialspeed} -D");
978
			fclose($fd);
979
		}
980

    
981
		/* serial console - write out /boot/loader.conf */
982
		if ($when == "upgrade")
983
			system("echo \"Reading {$loader_conf_file}...\" >> /conf/upgrade_log.txt");
984
		$boot_config = file_get_contents($loader_conf_file);
985
		$boot_config_split = explode("\n", $boot_config);
986
		if(count($boot_config_split) > 0) {
987
			$new_boot_config = array();
988
			// Loop through and only add lines that are not empty, and which
989
			//  do not contain a console directive.
990
			foreach($boot_config_split as $bcs)
991
				if(!empty($bcs)
992
					&& (stripos($bcs, "console") === false)
993
					&& (stripos($bcs, "boot_multicons") === false)
994
					&& (stripos($bcs, "boot_serial") === false)
995
					&& (stripos($bcs, "hw.usb.no_pf") === false))
996
					$new_boot_config[] = $bcs;
997

    
998
			if (($g['platform'] == "nanobsd") && !file_exists("/etc/nano_use_vga.txt")) {
999
				$new_boot_config[] = 'boot_serial="YES"';
1000
				$new_boot_config[] = 'console="comconsole"';
1001
			} else if (is_serial_enabled()) {
1002
				$new_boot_config[] = 'boot_multicons="YES"';
1003
				$new_boot_config[] = 'boot_serial="YES"';
1004
				$primaryconsole = isset($g['primaryconsole_force']) ? $g['primaryconsole_force'] : $config['system']['primaryconsole'];
1005
				switch ($primaryconsole) {
1006
					case "video":
1007
						$new_boot_config[] = 'console="vidconsole,comconsole"';
1008
						break;
1009
					case "serial":
1010
					default:
1011
						$new_boot_config[] = 'console="comconsole,vidconsole"';
1012
				}
1013
			}
1014
			$new_boot_config[] = 'comconsole_speed="' . $serialspeed . '"';
1015
			$new_boot_config[] = 'hw.usb.no_pf="1"';
1016

    
1017
			file_put_contents($loader_conf_file, implode("\n", $new_boot_config) . "\n");
1018
		}
1019
	}
1020
	$ttys = file_get_contents($ttys_file);
1021
	$ttys_split = explode("\n", $ttys);
1022
	$fd = fopen($ttys_file, "w");
1023

    
1024
	$on_off = (is_serial_enabled() ? 'onifconsole' : 'off');
1025

    
1026
	if (isset($config['system']['disableconsolemenu'])) {
1027
		$console_type = 'Pc';
1028
		$serial_type = 'std.' . $serialspeed;
1029
	} else {
1030
		$console_type = 'al.Pc';
1031
		$serial_type = 'al.' . $serialspeed;
1032
	}
1033
	foreach($ttys_split as $tty) {
1034
		if (stristr($tty, "ttyv0"))
1035
			fwrite($fd, "ttyv0	\"/usr/libexec/getty {$console_type}\"	cons25	on	secure\n");
1036
		else if (stristr($tty, "ttyu")) {
1037
			$ttyn = substr($tty, 0, 5);
1038
			fwrite($fd, "{$ttyn}	\"/usr/libexec/getty {$serial_type}\"	cons25	{$on_off}	secure\n");
1039
		} else
1040
			fwrite($fd, $tty . "\n");
1041
	}
1042
	unset($on_off, $console_type, $serial_type);
1043
	fclose($fd);
1044
	if ($when != "upgrade")
1045
		reload_ttys();
1046

    
1047
	conf_mount_ro();
1048
	return;
1049
}
1050

    
1051
function is_serial_enabled() {
1052
	global $g, $config;
1053

    
1054
	if (!isset($g['enableserial_force']) &&
1055
	    !isset($config['system']['enableserial']) &&
1056
	    ($g['platform'] == "pfSense" || $g['platform'] == "cdrom" || file_exists("/etc/nano_use_vga.txt")))
1057
		return false;
1058

    
1059
	return true;
1060
}
1061

    
1062
function reload_ttys() {
1063
	// Send a HUP signal to init will make it reload /etc/ttys
1064
	posix_kill(1, SIGHUP);
1065
}
1066

    
1067
function print_value_list($list, $count = 10, $separator = ",") {
1068
	$list = implode($separator, array_slice($list, 0, $count));
1069
	if(count($list) < $count) {
1070
		$list .= ".";
1071
	} else {
1072
		$list .= "...";
1073
	}
1074
	return $list;
1075
}
1076

    
1077
/* DHCP enabled on any interfaces? */
1078
function is_dhcp_server_enabled() {
1079
	global $config;
1080

    
1081
	if (!is_array($config['dhcpd']))
1082
		return false;
1083

    
1084
	foreach ($config['dhcpd'] as $dhcpif => $dhcpifconf) {
1085
		if (isset($dhcpifconf['enable']) && !empty($config['interfaces'][$dhcpif]))
1086
			return true;
1087
	}
1088

    
1089
	return false;
1090
}
1091

    
1092
/* DHCP enabled on any interfaces? */
1093
function is_dhcpv6_server_enabled() {
1094
	global $config;
1095

    
1096
	if (is_array($config['interfaces'])) {
1097
		foreach ($config['interfaces'] as $ifcfg) {
1098
			if (isset($ifcfg['enable']) && !empty($ifcfg['track6-interface']))
1099
				return true;
1100
		}
1101
	}
1102

    
1103
	if (!is_array($config['dhcpdv6']))
1104
		return false;
1105

    
1106
	foreach ($config['dhcpdv6'] as $dhcpv6if => $dhcpv6ifconf) {
1107
		if (isset($dhcpv6ifconf['enable']) && !empty($config['interfaces'][$dhcpv6if]))
1108
			return true;
1109
	}
1110

    
1111
	return false;
1112
}
1113

    
1114
/* radvd enabled on any interfaces? */
1115
function is_radvd_enabled() {
1116
	global $config;
1117

    
1118
	if (!is_array($config['dhcpdv6']))
1119
		$config['dhcpdv6'] = array();
1120

    
1121
	$dhcpdv6cfg = $config['dhcpdv6'];
1122
	$Iflist = get_configured_interface_list();
1123

    
1124
	/* handle manually configured DHCP6 server settings first */
1125
	foreach ($dhcpdv6cfg as $dhcpv6if => $dhcpv6ifconf) {
1126
		if(!isset($config['interfaces'][$dhcpv6if]['enable']))
1127
			continue;
1128

    
1129
		if(!isset($dhcpv6ifconf['ramode']))
1130
			$dhcpv6ifconf['ramode'] = $dhcpv6ifconf['mode'];
1131

    
1132
		if($dhcpv6ifconf['ramode'] == "disabled")
1133
			continue;
1134

    
1135
		$ifcfgipv6 = get_interface_ipv6($dhcpv6if);
1136
		if(!is_ipaddrv6($ifcfgipv6))
1137
			continue;
1138

    
1139
		return true;
1140
	}
1141

    
1142
	/* handle DHCP-PD prefixes and 6RD dynamic interfaces */
1143
	foreach ($Iflist as $if => $ifdescr) {
1144
		if(!isset($config['interfaces'][$if]['track6-interface']))
1145
			continue;
1146
		if(!isset($config['interfaces'][$if]['enable']))
1147
			continue;
1148

    
1149
		$ifcfgipv6 = get_interface_ipv6($if);
1150
		if(!is_ipaddrv6($ifcfgipv6))
1151
			continue;
1152

    
1153
		$ifcfgsnv6 = get_interface_subnetv6($if);
1154
		$subnetv6 = gen_subnetv6($ifcfgipv6, $ifcfgsnv6);
1155

    
1156
		if(!is_ipaddrv6($subnetv6))
1157
			continue;
1158

    
1159
		return true;
1160
	}
1161

    
1162
	return false;
1163
}
1164

    
1165
/* Any PPPoE servers enabled? */
1166
function is_pppoe_server_enabled() {
1167
	global $config;
1168

    
1169
	$pppoeenable = false;
1170

    
1171
	if (!is_array($config['pppoes']) || !is_array($config['pppoes']['pppoe']))
1172
		return false;
1173

    
1174
	foreach ($config['pppoes']['pppoe'] as $pppoes)
1175
		if ($pppoes['mode'] == 'server')
1176
			$pppoeenable = true;
1177

    
1178
	return $pppoeenable;
1179
}
1180

    
1181
function convert_seconds_to_hms($sec){
1182
	$min=$hrs=0;
1183
	if ($sec != 0){
1184
		$min = floor($sec/60);
1185
		$sec %= 60;
1186
	}
1187
	if ($min != 0){
1188
		$hrs = floor($min/60);
1189
		$min %= 60;
1190
	}
1191
	if ($sec < 10)
1192
		$sec = "0".$sec;
1193
	if ($min < 10)
1194
		$min = "0".$min;
1195
	if ($hrs < 10)
1196
		$hrs = "0".$hrs;
1197
	$result = $hrs.":".$min.":".$sec;
1198
	return $result;
1199
}
1200

    
1201
/* Compute the total uptime from the ppp uptime log file in the conf directory */
1202

    
1203
function get_ppp_uptime($port){
1204
	if (file_exists("/conf/{$port}.log")){
1205
		$saved_time = file_get_contents("/conf/{$port}.log");
1206
		$uptime_data = explode("\n",$saved_time);
1207
		$sec=0;
1208
		foreach($uptime_data as $upt) {
1209
			$sec += substr($upt, 1 + strpos($upt, " "));
1210
		}
1211
		return convert_seconds_to_hms($sec);
1212
	} else {
1213
		$total_time = gettext("No history data found!");
1214
		return $total_time;
1215
	}
1216
}
1217

    
1218
//returns interface information
1219
function get_interface_info($ifdescr) {
1220
	global $config, $g;
1221

    
1222
	$ifinfo = array();
1223
	if (empty($config['interfaces'][$ifdescr]))
1224
		return;
1225
	$ifinfo['hwif'] = $config['interfaces'][$ifdescr]['if'];
1226
	$ifinfo['if'] = get_real_interface($ifdescr);
1227

    
1228
	$chkif = $ifinfo['if'];
1229
	$ifinfotmp = pfSense_get_interface_addresses($chkif);
1230
	$ifinfo['status'] = $ifinfotmp['status'];
1231
	if (empty($ifinfo['status']))
1232
		$ifinfo['status'] = "down";
1233
	$ifinfo['macaddr'] = $ifinfotmp['macaddr'];
1234
	$ifinfo['mtu'] = $ifinfotmp['mtu'];
1235
	$ifinfo['ipaddr'] = $ifinfotmp['ipaddr'];
1236
	$ifinfo['subnet'] = $ifinfotmp['subnet'];
1237
	$ifinfo['linklocal'] = get_interface_linklocal($ifdescr);
1238
	$ifinfo['ipaddrv6'] = get_interface_ipv6($ifdescr);
1239
	$ifinfo['subnetv6'] = get_interface_subnetv6($ifdescr);
1240
	if (isset($ifinfotmp['link0']))
1241
		$link0 = "down";
1242
	$ifinfotmp = pfSense_get_interface_stats($chkif);
1243
	// $ifinfo['inpkts'] = $ifinfotmp['inpkts'];
1244
	// $ifinfo['outpkts'] = $ifinfotmp['outpkts'];
1245
	$ifinfo['inerrs'] = $ifinfotmp['inerrs'];
1246
	$ifinfo['outerrs'] = $ifinfotmp['outerrs'];
1247
	$ifinfo['collisions'] = $ifinfotmp['collisions'];
1248

    
1249
	/* Use pfctl for non wrapping 64 bit counters */
1250
	/* Pass */
1251
	exec("/sbin/pfctl -vvsI -i {$chkif}", $pfctlstats);
1252
	$pf_in4_pass = preg_split("/ +/ ", $pfctlstats[3]);
1253
	$pf_out4_pass = preg_split("/ +/", $pfctlstats[5]);
1254
	$pf_in6_pass = preg_split("/ +/ ", $pfctlstats[7]);
1255
	$pf_out6_pass = preg_split("/ +/", $pfctlstats[9]);
1256
	$in4_pass = $pf_in4_pass[5];
1257
	$out4_pass = $pf_out4_pass[5];
1258
	$in4_pass_packets = $pf_in4_pass[3];
1259
	$out4_pass_packets = $pf_out4_pass[3];
1260
	$in6_pass = $pf_in6_pass[5];
1261
	$out6_pass = $pf_out6_pass[5];
1262
	$in6_pass_packets = $pf_in6_pass[3];
1263
	$out6_pass_packets = $pf_out6_pass[3];
1264
	$ifinfo['inbytespass'] = $in4_pass + $in6_pass;
1265
	$ifinfo['outbytespass'] = $out4_pass + $out6_pass;
1266
	$ifinfo['inpktspass'] = $in4_pass_packets + $in6_pass_packets;
1267
	$ifinfo['outpktspass'] = $out4_pass_packets + $out6_pass_packets;
1268

    
1269
	/* Block */
1270
	$pf_in4_block = preg_split("/ +/", $pfctlstats[4]);
1271
	$pf_out4_block = preg_split("/ +/", $pfctlstats[6]);
1272
	$pf_in6_block = preg_split("/ +/", $pfctlstats[8]);
1273
	$pf_out6_block = preg_split("/ +/", $pfctlstats[10]);
1274
	$in4_block = $pf_in4_block[5];
1275
	$out4_block = $pf_out4_block[5];
1276
	$in4_block_packets = $pf_in4_block[3];
1277
	$out4_block_packets = $pf_out4_block[3];
1278
	$in6_block = $pf_in6_block[5];
1279
	$out6_block = $pf_out6_block[5];
1280
	$in6_block_packets = $pf_in6_block[3];
1281
	$out6_block_packets = $pf_out6_block[3];
1282
	$ifinfo['inbytesblock'] = $in4_block + $in6_block;
1283
	$ifinfo['outbytesblock'] = $out4_block + $out6_block;
1284
	$ifinfo['inpktsblock'] = $in4_block_packets + $in6_block_packets;
1285
	$ifinfo['outpktsblock'] = $out4_block_packets + $out6_block_packets;
1286

    
1287
	$ifinfo['inbytes'] = $in4_pass + $in6_pass;
1288
	$ifinfo['outbytes'] = $out4_pass + $out6_pass;
1289
	$ifinfo['inpkts'] = $in4_pass_packets + $in6_pass_packets;
1290
	$ifinfo['outpkts'] = $out4_pass_packets + $out6_pass_packets;
1291

    
1292
	$ifconfiginfo = "";
1293
	$link_type = $config['interfaces'][$ifdescr]['ipaddr'];
1294
	switch ($link_type) {
1295
	/* DHCP? -> see if dhclient is up */
1296
	case "dhcp":
1297
		/* see if dhclient is up */
1298
		if (find_dhclient_process($ifinfo['if']) != 0)
1299
			$ifinfo['dhcplink'] = "up";
1300
		else
1301
			$ifinfo['dhcplink'] = "down";
1302

    
1303
		break;
1304
	/* PPPoE/PPTP/L2TP interface? -> get status from virtual interface */
1305
	case "pppoe":
1306
	case "pptp":
1307
	case "l2tp":
1308
		if ($ifinfo['status'] == "up" && !isset($link0))
1309
			/* get PPPoE link status for dial on demand */
1310
			$ifinfo["{$link_type}link"] = "up";
1311
		else
1312
			$ifinfo["{$link_type}link"] = "down";
1313

    
1314
		break;
1315
	/* PPP interface? -> get uptime for this session and cumulative uptime from the persistant log file in conf */
1316
	case "ppp":
1317
		if ($ifinfo['status'] == "up")
1318
			$ifinfo['ppplink'] = "up";
1319
		else
1320
			$ifinfo['ppplink'] = "down" ;
1321

    
1322
		if (empty($ifinfo['status']))
1323
			$ifinfo['status'] = "down";
1324

    
1325
		if (is_array($config['ppps']['ppp']) && count($config['ppps']['ppp'])) {
1326
			foreach ($config['ppps']['ppp'] as $pppid => $ppp) {
1327
				if ($config['interfaces'][$ifdescr]['if'] == $ppp['if'])
1328
					break;
1329
			}
1330
		}
1331
		$dev = $ppp['ports'];
1332
		if ($config['interfaces'][$ifdescr]['if'] != $ppp['if'] || empty($dev))
1333
			break;
1334
		if (!file_exists($dev)) {
1335
			$ifinfo['nodevice'] = 1;
1336
			$ifinfo['pppinfo'] = $dev . " " . gettext("device not present! Is the modem attached to the system?");
1337
		}
1338

    
1339
		$usbmodemoutput = array();
1340
		exec("usbconfig", $usbmodemoutput);
1341
		$mondev = "{$g['tmp_path']}/3gstats.{$ifdescr}";
1342
		if(file_exists($mondev)) {
1343
			$cellstats = file($mondev);
1344
			/* skip header */
1345
			$a_cellstats = explode(",", $cellstats[1]);
1346
			if(preg_match("/huawei/i", implode("\n", $usbmodemoutput))) {
1347
				$ifinfo['cell_rssi'] = huawei_rssi_to_string($a_cellstats[1]);
1348
				$ifinfo['cell_mode'] = huawei_mode_to_string($a_cellstats[2], $a_cellstats[3]);
1349
				$ifinfo['cell_simstate'] = huawei_simstate_to_string($a_cellstats[10]);
1350
				$ifinfo['cell_service'] = huawei_service_to_string(trim($a_cellstats[11]));
1351
			}
1352
			if(preg_match("/zte/i", implode("\n", $usbmodemoutput))) {
1353
				$ifinfo['cell_rssi'] = zte_rssi_to_string($a_cellstats[1]);
1354
				$ifinfo['cell_mode'] = zte_mode_to_string($a_cellstats[2], $a_cellstats[3]);
1355
				$ifinfo['cell_simstate'] = zte_simstate_to_string($a_cellstats[10]);
1356
				$ifinfo['cell_service'] = zte_service_to_string(trim($a_cellstats[11]));
1357
			}
1358
			$ifinfo['cell_upstream'] = $a_cellstats[4];
1359
			$ifinfo['cell_downstream'] = trim($a_cellstats[5]);
1360
			$ifinfo['cell_sent'] = $a_cellstats[6];
1361
			$ifinfo['cell_received'] = trim($a_cellstats[7]);
1362
			$ifinfo['cell_bwupstream'] = $a_cellstats[8];
1363
			$ifinfo['cell_bwdownstream'] = trim($a_cellstats[9]);
1364
		}
1365
		// Calculate cumulative uptime for PPP link. Useful for connections that have per minute/hour contracts so you don't go over!
1366
		if (isset($ppp['uptime']))
1367
			$ifinfo['ppp_uptime_accumulated'] = "(".get_ppp_uptime($ifinfo['if']).")";
1368
		break;
1369
	default:
1370
		break;
1371
	}
1372

    
1373
	if (file_exists("{$g['varrun_path']}/{$link_type}_{$ifdescr}.pid")) {
1374
		$sec = trim(`/usr/local/sbin/ppp-uptime.sh {$ifinfo['if']}`);
1375
		$ifinfo['ppp_uptime'] = convert_seconds_to_hms($sec);
1376
	}
1377

    
1378
	if ($ifinfo['status'] == "up") {
1379
		/* try to determine media with ifconfig */
1380
		unset($ifconfiginfo);
1381
		exec("/sbin/ifconfig " . $ifinfo['if'], $ifconfiginfo);
1382
		$wifconfiginfo = array();
1383
		if(is_interface_wireless($ifdescr)) {
1384
			exec("/sbin/ifconfig {$ifinfo['if']} list sta", $wifconfiginfo);
1385
			array_shift($wifconfiginfo);
1386
		}
1387
		$matches = "";
1388
		foreach ($ifconfiginfo as $ici) {
1389

    
1390
			/* don't list media/speed for wireless cards, as it always
1391
			   displays 2 Mbps even though clients can connect at 11 Mbps */
1392
			if (preg_match("/media: .*? \((.*?)\)/", $ici, $matches)) {
1393
				$ifinfo['media'] = $matches[1];
1394
			} else if (preg_match("/media: Ethernet (.*)/", $ici, $matches)) {
1395
				$ifinfo['media'] = $matches[1];
1396
			} else if (preg_match("/media: IEEE 802.11 Wireless Ethernet (.*)/", $ici, $matches)) {
1397
				$ifinfo['media'] = $matches[1];
1398
			}
1399

    
1400
			if (preg_match("/status: (.*)$/", $ici, $matches)) {
1401
				if ($matches[1] != "active")
1402
					$ifinfo['status'] = $matches[1];
1403
				if($ifinfo['status'] == gettext("running"))
1404
					$ifinfo['status'] = gettext("up");
1405
			}
1406
			if (preg_match("/channel (\S*)/", $ici, $matches)) {
1407
				$ifinfo['channel'] = $matches[1];
1408
			}
1409
			if (preg_match("/ssid (\".*?\"|\S*)/", $ici, $matches)) {
1410
				if ($matches[1][0] == '"')
1411
					$ifinfo['ssid'] = substr($matches[1], 1, -1);
1412
				else
1413
					$ifinfo['ssid'] = $matches[1];
1414
			}
1415
			if (preg_match("/laggproto (.*)$/", $ici, $matches)) {
1416
				$ifinfo['laggproto'] = $matches[1];
1417
			}
1418
			if (preg_match("/laggport: (.*)$/", $ici, $matches)) {
1419
				$ifinfo['laggport'][] = $matches[1];
1420
			}
1421
		}
1422
		foreach($wifconfiginfo as $ici) {
1423
			$elements = preg_split("/[ ]+/i", $ici);
1424
			if ($elements[0] != "") {
1425
				$ifinfo['bssid'] = $elements[0];
1426
			}
1427
			if ($elements[3] != "") {
1428
				$ifinfo['rate'] = $elements[3];
1429
			}
1430
			if ($elements[4] != "") {
1431
				$ifinfo['rssi'] = $elements[4];
1432
			}
1433

    
1434
		}
1435
		/* lookup the gateway */
1436
		if (interface_has_gateway($ifdescr)) {
1437
			$ifinfo['gateway'] = get_interface_gateway($ifdescr);
1438
			$ifinfo['gatewayv6'] = get_interface_gateway_v6($ifdescr);
1439
		}
1440
	}
1441

    
1442
	$bridge = "";
1443
	$bridge = link_interface_to_bridge($ifdescr);
1444
	if($bridge) {
1445
		$bridge_text = `/sbin/ifconfig {$bridge}`;
1446
		if(stristr($bridge_text, "blocking") <> false) {
1447
			$ifinfo['bridge'] = "<b><font color='red'>" . gettext("blocking") . "</font></b> - " . gettext("check for ethernet loops");
1448
			$ifinfo['bridgeint'] = $bridge;
1449
		} else if(stristr($bridge_text, "learning") <> false) {
1450
			$ifinfo['bridge'] = gettext("learning");
1451
			$ifinfo['bridgeint'] = $bridge;
1452
		} else if(stristr($bridge_text, "forwarding") <> false) {
1453
			$ifinfo['bridge'] = gettext("forwarding");
1454
			$ifinfo['bridgeint'] = $bridge;
1455
		}
1456
	}
1457

    
1458
	return $ifinfo;
1459
}
1460

    
1461
//returns cpu speed of processor. Good for determining capabilities of machine
1462
function get_cpu_speed() {
1463
	return get_single_sysctl("hw.clockrate");
1464
}
1465

    
1466
function get_uptime_sec() {
1467
	$boottime = "";
1468
	$matches = "";
1469
	$boottime = get_single_sysctl("kern.boottime");
1470
	preg_match("/sec = (\d+)/", $boottime, $matches);
1471
	$boottime = $matches[1];
1472
	if(intval($boottime) == 0)
1473
		return 0;
1474

    
1475
	$uptime = time() - $boottime;
1476
	return $uptime;
1477
}
1478

    
1479
function add_hostname_to_watch($hostname) {
1480
	if(!is_dir("/var/db/dnscache")) {
1481
		mkdir("/var/db/dnscache");
1482
	}
1483
	$result = array();
1484
	if((is_fqdn($hostname)) && (!is_ipaddr($hostname))) {
1485
		$domrecords = array();
1486
		$domips = array();
1487
		exec("host -t A " . escapeshellarg($hostname), $domrecords, $rethost);
1488
		if($rethost == 0) {
1489
			foreach($domrecords as $domr) {
1490
				$doml = explode(" ", $domr);
1491
				$domip = $doml[3];
1492
				/* fill array with domain ip addresses */
1493
				if(is_ipaddr($domip)) {
1494
					$domips[] = $domip;
1495
				}
1496
			}
1497
		}
1498
		sort($domips);
1499
		$contents = "";
1500
		if(! empty($domips)) {
1501
			foreach($domips as $ip) {
1502
				$contents .= "$ip\n";
1503
			}
1504
		}
1505
		file_put_contents("/var/db/dnscache/$hostname", $contents);
1506
		/* Remove empty elements */
1507
		$result = array_filter(explode("\n", $contents), 'strlen');
1508
	}
1509
	return $result;
1510
}
1511

    
1512
function is_fqdn($fqdn) {
1513
	$hostname = false;
1514
	if(preg_match("/[-A-Z0-9\.]+\.[-A-Z0-9\.]+/i", $fqdn)) {
1515
		$hostname = true;
1516
	}
1517
	if(preg_match("/\.\./", $fqdn)) {
1518
		$hostname = false;
1519
	}
1520
	if(preg_match("/^\./i", $fqdn)) {
1521
		$hostname = false;
1522
	}
1523
	if(preg_match("/\//i", $fqdn)) {
1524
		$hostname = false;
1525
	}
1526
	return($hostname);
1527
}
1528

    
1529
function pfsense_default_state_size() {
1530
	/* get system memory amount */
1531
	$memory = get_memory();
1532
	$physmem = $memory[0];
1533
	/* Be cautious and only allocate 10% of system memory to the state table */
1534
	$max_states = (int) ($physmem/10)*1000;
1535
	return $max_states;
1536
}
1537

    
1538
function pfsense_default_tables_size() {
1539
	$current = `pfctl -sm | grep ^tables | awk '{print $4};'`;
1540
	return $current;
1541
}
1542

    
1543
function pfsense_default_table_entries_size() {
1544
	$current = `pfctl -sm | grep table-entries | awk '{print $4};'`;
1545
	return $current;
1546
}
1547

    
1548
/* Compare the current hostname DNS to the DNS cache we made
1549
 * if it has changed we return the old records
1550
 * if no change we return false */
1551
function compare_hostname_to_dnscache($hostname) {
1552
	if(!is_dir("/var/db/dnscache")) {
1553
		mkdir("/var/db/dnscache");
1554
	}
1555
	$hostname = trim($hostname);
1556
	if(is_readable("/var/db/dnscache/{$hostname}")) {
1557
		$oldcontents = file_get_contents("/var/db/dnscache/{$hostname}");
1558
	} else {
1559
		$oldcontents = "";
1560
	}
1561
	if((is_fqdn($hostname)) && (!is_ipaddr($hostname))) {
1562
		$domrecords = array();
1563
		$domips = array();
1564
		exec("host -t A " . escapeshellarg($hostname), $domrecords, $rethost);
1565
		if($rethost == 0) {
1566
			foreach($domrecords as $domr) {
1567
				$doml = explode(" ", $domr);
1568
				$domip = $doml[3];
1569
				/* fill array with domain ip addresses */
1570
				if(is_ipaddr($domip)) {
1571
					$domips[] = $domip;
1572
				}
1573
			}
1574
		}
1575
		sort($domips);
1576
		$contents = "";
1577
		if(! empty($domips)) {
1578
			foreach($domips as $ip) {
1579
				$contents .= "$ip\n";
1580
			}
1581
		}
1582
	}
1583

    
1584
	if(trim($oldcontents) != trim($contents)) {
1585
		if($g['debug']) {
1586
			log_error(sprintf(gettext('DNSCACHE: Found old IP %1$s and new IP %2$s'), $oldcontents, $contents));
1587
		}
1588
		return ($oldcontents);
1589
	} else {
1590
		return false;
1591
	}
1592
}
1593

    
1594
/*
1595
 * load_crypto() - Load crypto modules if enabled in config.
1596
 */
1597
function load_crypto() {
1598
	global $config, $g;
1599
	$crypto_modules = array('glxsb', 'aesni');
1600

    
1601
	if (!in_array($config['system']['crypto_hardware'], $crypto_modules))
1602
		return false;
1603

    
1604
	if (!empty($config['system']['crypto_hardware']) && !is_module_loaded($config['system']['crypto_hardware'])) {
1605
		log_error("Loading {$config['system']['crypto_hardware']} cryptographic accelerator module.");
1606
		mwexec("/sbin/kldload {$config['system']['crypto_hardware']}");
1607
	}
1608
}
1609

    
1610
/*
1611
 * load_thermal_hardware() - Load temperature monitor kernel module
1612
 */
1613
function load_thermal_hardware() {
1614
	global $config, $g;
1615
	$thermal_hardware_modules = array('coretemp', 'amdtemp');
1616

    
1617
	if (!in_array($config['system']['thermal_hardware'], $thermal_hardware_modules))
1618
		return false;
1619

    
1620
	if (!empty($config['system']['thermal_hardware']) && !is_module_loaded($config['system']['thermal_hardware'])) {
1621
		log_error("Loading {$config['system']['thermal_hardware']} thermal monitor module.");
1622
		mwexec("/sbin/kldload {$config['system']['thermal_hardware']}");
1623
	}
1624
}
1625

    
1626
/****f* pfsense-utils/isvm
1627
 * NAME
1628
 *   isvm
1629
 * INPUTS
1630
 *	none
1631
 * RESULT
1632
 *   returns true if machine is running under a virtual environment
1633
 ******/
1634
function isvm() {
1635
	$virtualenvs = array("vmware", "parallels", "qemu", "bochs", "plex86", "VirtualBox");
1636
	$_gb = exec('/bin/kenv smbios.system.product 2>/dev/null', $output, $rc);
1637

    
1638
	if ($rc != 0 || !isset($output[0]))
1639
		return false;
1640

    
1641
	foreach ($virtualenvs as $virtualenv)
1642
		if (stripos($output[0], $virtualenv) !== false)
1643
			return true;
1644

    
1645
	return false;
1646
}
1647

    
1648
function get_freebsd_version() {
1649
	$version = explode(".", php_uname("r"));
1650
	return $version[0];
1651
}
1652

    
1653
function download_file($url, $destination, $verify_ssl = false, $connect_timeout = 60, $timeout = 0) {
1654
	global $config, $g;
1655

    
1656
	$fp = fopen($destination, "wb");
1657

    
1658
	if (!$fp)
1659
		return false;
1660

    
1661
	$ch = curl_init();
1662
	curl_setopt($ch, CURLOPT_URL, $url);
1663
	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $verify_ssl);
1664
	curl_setopt($ch, CURLOPT_FILE, $fp);
1665
	curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connect_timeout);
1666
	curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1667
	curl_setopt($ch, CURLOPT_HEADER, false);
1668
	curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1669
	curl_setopt($ch, CURLOPT_USERAGENT, $g['product_name'] . '/' . rtrim(file_get_contents("/etc/version")));
1670

    
1671
	if (!empty($config['system']['proxyurl'])) {
1672
		curl_setopt($ch, CURLOPT_PROXY, $config['system']['proxyurl']);
1673
		if (!empty($config['system']['proxyport']))
1674
			curl_setopt($ch, CURLOPT_PROXYPORT, $config['system']['proxyport']);
1675
		if (!empty($config['system']['proxyuser']) && !empty($config['system']['proxypass'])) {
1676
			@curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_ANY | CURLAUTH_ANYSAFE);
1677
			curl_setopt($ch, CURLOPT_PROXYUSERPWD, "{$config['system']['proxyuser']}:{$config['system']['proxypass']}");
1678
		}
1679
	}
1680

    
1681
	@curl_exec($ch);
1682
	$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
1683
	fclose($fp);
1684
	curl_close($ch);
1685
	return ($http_code == 200) ? true : $http_code;
1686
}
1687

    
1688
function download_file_with_progress_bar($url_file, $destination_file, $readbody = 'read_body', $connect_timeout=60, $timeout=0) {
1689
	global $ch, $fout, $file_size, $downloaded, $config, $first_progress_update, $g;
1690
	$file_size  = 1;
1691
	$downloaded = 1;
1692
	$first_progress_update = TRUE;
1693
	/* open destination file */
1694
	$fout = fopen($destination_file, "wb");
1695

    
1696
	/*
1697
	 *      Originally by Author: Keyvan Minoukadeh
1698
	 *      Modified by Scott Ullrich to return Content-Length size
1699
	 */
1700

    
1701
	$ch = curl_init();
1702
	curl_setopt($ch, CURLOPT_URL, $url_file);
1703
	curl_setopt($ch, CURLOPT_HEADERFUNCTION, 'read_header');
1704
	curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1705
	/* Don't verify SSL peers since we don't have the certificates to do so. */
1706
	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
1707
	curl_setopt($ch, CURLOPT_WRITEFUNCTION, $readbody);
1708
	curl_setopt($ch, CURLOPT_NOPROGRESS, '1');
1709
	curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connect_timeout);
1710
	curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1711
	curl_setopt($ch, CURLOPT_USERAGENT, $g['product_name'] . '/' . rtrim(file_get_contents("/etc/version")));
1712

    
1713
	if (!empty($config['system']['proxyurl'])) {
1714
		curl_setopt($ch, CURLOPT_PROXY, $config['system']['proxyurl']);
1715
		if (!empty($config['system']['proxyport']))
1716
			curl_setopt($ch, CURLOPT_PROXYPORT, $config['system']['proxyport']);
1717
		if (!empty($config['system']['proxyuser']) && !empty($config['system']['proxypass'])) {
1718
			@curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_ANY | CURLAUTH_ANYSAFE);
1719
			curl_setopt($ch, CURLOPT_PROXYUSERPWD, "{$config['system']['proxyuser']}:{$config['system']['proxypass']}");
1720
		}
1721
	}
1722

    
1723
	@curl_exec($ch);
1724
	$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
1725
	if($fout)
1726
		fclose($fout);
1727
	curl_close($ch);
1728
	return ($http_code == 200) ? true : $http_code;
1729
}
1730

    
1731
function read_header($ch, $string) {
1732
	global $file_size, $fout;
1733
	$length = strlen($string);
1734
	$regs = "";
1735
	preg_match("/(Content-Length:) (.*)/", $string, $regs);
1736
	if($regs[2] <> "") {
1737
		$file_size = intval($regs[2]);
1738
	}
1739
	ob_flush();
1740
	return $length;
1741
}
1742

    
1743
function read_body($ch, $string) {
1744
	global $fout, $file_size, $downloaded, $sendto, $static_status, $static_output, $lastseen, $first_progress_update;
1745
	global $pkg_interface;
1746
	$length = strlen($string);
1747
	$downloaded += intval($length);
1748
	if($file_size > 0) {
1749
		$downloadProgress = round(100 * (1 - $downloaded / $file_size), 0);
1750
		$downloadProgress = 100 - $downloadProgress;
1751
	} else
1752
		$downloadProgress = 0;
1753
	if($lastseen <> $downloadProgress and $downloadProgress < 101) {
1754
		if($sendto == "status") {
1755
			if($pkg_interface == "console") {
1756
				if(($downloadProgress % 10) == 0 || $downloadProgress < 10) {
1757
					$tostatus = $static_status . $downloadProgress . "%";
1758
					if ($downloadProgress == 100) {
1759
						$tostatus = $tostatus . "\r";
1760
					}
1761
					update_status($tostatus);
1762
				}
1763
			} else {
1764
				$tostatus = $static_status . $downloadProgress . "%";
1765
				update_status($tostatus);
1766
			}
1767
		} else {
1768
			if($pkg_interface == "console") {
1769
				if(($downloadProgress % 10) == 0 || $downloadProgress < 10) {
1770
					$tooutput = $static_output . $downloadProgress . "%";
1771
					if ($downloadProgress == 100) {
1772
						$tooutput = $tooutput . "\r";
1773
					}
1774
					update_output_window($tooutput);
1775
				}
1776
			} else {
1777
				$tooutput = $static_output . $downloadProgress . "%";
1778
				update_output_window($tooutput);
1779
			}
1780
		}
1781
				if(($pkg_interface != "console") || (($downloadProgress % 10) == 0) || ($downloadProgress < 10)) {
1782
					update_progress_bar($downloadProgress, $first_progress_update);
1783
					$first_progress_update = FALSE;
1784
				}
1785
		$lastseen = $downloadProgress;
1786
	}
1787
	if($fout)
1788
		fwrite($fout, $string);
1789
	ob_flush();
1790
	return $length;
1791
}
1792

    
1793
/*
1794
 *   update_output_window: update bottom textarea dynamically.
1795
 */
1796
function update_output_window($text) {
1797
	global $pkg_interface;
1798
	$log = preg_replace("/\n/", "\\n", $text);
1799
	if($pkg_interface != "console") {
1800
		echo "\n<script type=\"text/javascript\">";
1801
		echo "\n//<![CDATA[";
1802
		echo "\nthis.document.forms[0].output.value = \"" . $log . "\";";
1803
		echo "\nthis.document.forms[0].output.scrollTop = this.document.forms[0].output.scrollHeight;";
1804
		echo "\n//]]>";
1805
		echo "\n</script>";
1806
	}
1807
	/* ensure that contents are written out */
1808
	ob_flush();
1809
}
1810

    
1811
/*
1812
 *   update_status: update top textarea dynamically.
1813
 */
1814
function update_status($status) {
1815
	global $pkg_interface;
1816
	if($pkg_interface == "console") {
1817
		echo "\r{$status}";
1818
	} else {
1819
		echo "\n<script type=\"text/javascript\">";
1820
		echo "\n//<![CDATA[";
1821
		echo "\nthis.document.forms[0].status.value=\"" . $status . "\";";
1822
		echo "\n//]]>";
1823
		echo "\n</script>";
1824
	}
1825
	/* ensure that contents are written out */
1826
	ob_flush();
1827
}
1828

    
1829
/*
1830
 * update_progress_bar($percent, $first_time): updates the javascript driven progress bar.
1831
 */
1832
function update_progress_bar($percent, $first_time) {
1833
	global $pkg_interface;
1834
	if($percent > 100) $percent = 1;
1835
	if($pkg_interface <> "console") {
1836
		echo "\n<script type=\"text/javascript\">";
1837
		echo "\n//<![CDATA[";
1838
		echo "\ndocument.progressbar.style.width='" . $percent . "%';";
1839
		echo "\n//]]>";
1840
		echo "\n</script>";
1841
	} else {
1842
		if(!($first_time))
1843
			echo "\x08\x08\x08\x08\x08";
1844
		echo sprintf("%4d%%", $percent);
1845
	}
1846
}
1847

    
1848
/* 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. */
1849
if(!function_exists("split")) {
1850
	function split($separator, $haystack, $limit = null) {
1851
		log_error("deprecated split() call with separator '{$separator}'");
1852
		return preg_split($separator, $haystack, $limit);
1853
	}
1854
}
1855

    
1856
function update_alias_names_upon_change($section, $field, $new_alias_name, $origname) {
1857
	global $g, $config, $pconfig, $debug;
1858
	if(!$origname)
1859
		return;
1860

    
1861
	$sectionref = &$config;
1862
	foreach($section as $sectionname) {
1863
		if(is_array($sectionref) && isset($sectionref[$sectionname]))
1864
			$sectionref = &$sectionref[$sectionname];
1865
		else
1866
			return;
1867
	}
1868

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

    
1872
	if(is_array($sectionref)) {
1873
		foreach($sectionref as $itemkey => $item) {
1874
			if($debug) fwrite($fd, "$itemkey\n");
1875

    
1876
			$fieldfound = true;
1877
			$fieldref = &$sectionref[$itemkey];
1878
			foreach($field as $fieldname) {
1879
				if(is_array($fieldref) && isset($fieldref[$fieldname]))
1880
					$fieldref = &$fieldref[$fieldname];
1881
				else {
1882
					$fieldfound = false;
1883
					break;
1884
				}
1885
			}
1886
			if($fieldfound && $fieldref == $origname) {
1887
				if($debug) fwrite($fd, "Setting old alias value $origname to $new_alias_name\n");
1888
				$fieldref = $new_alias_name;
1889
			}
1890
		}
1891
	}
1892

    
1893
	if($debug) fclose($fd);
1894

    
1895
}
1896

    
1897
function parse_aliases_file($filename, $type = "url", $max_items = -1) {
1898
	/*
1899
	 * $filename = file to process for example blocklist like DROP:  http://www.spamhaus.org/drop/drop.txt
1900
	 * $type = if set to 'url' then subnets and ips will be returned,
1901
	 *         if set to 'url_ports' port-ranges and ports will be returned
1902
	 * $max_items = sets the maximum amount of valid items to load, -1 the default defines there is no limit.
1903
	 *
1904
	 * RETURNS an array of ip subnets and ip's or ports and port-ranges, returns NULL upon a error conditions (file not found)
1905
	 */
1906

    
1907
	$fd = @fopen($filename, 'r');
1908
	if (!$fd) {
1909
		log_error(gettext("Could not process aliases from alias: {$alias_url}"));
1910
		return null;
1911
	}
1912
	$items = array();
1913
	/* NOTE: fgetss() is not a typo RTFM before being smart */
1914
	while (($fc = fgetss($fd)) !== FALSE) {
1915
		$tmp = trim($fc, " \t\n\r");
1916
		if (empty($tmp))
1917
			continue;
1918
		$tmp_str = strstr($tmp, '#', true);
1919
		if (!empty($tmp_str))
1920
			$tmp = $tmp_str;
1921
		$tmp_str = strstr($tmp, ' ', true);
1922
		if (!empty($tmp_str))
1923
			$tmp = $tmp_str;
1924
		$valid = ($type == "url" && (is_ipaddr($tmp) || is_subnet($tmp))) ||
1925
		         ($type == "url_ports" && (is_port($tmp) || is_portrange($tmp)));
1926
		if ($valid) {
1927
			$items[] = $tmp;
1928
			if (count($items) == $max_items)
1929
				break;
1930
		}
1931
	}
1932
	fclose($fd);
1933
	return $items;
1934
}
1935

    
1936
function update_alias_url_data() {
1937
	global $config, $g;
1938

    
1939
	$updated = false;
1940

    
1941
	/* item is a url type */
1942
	$lockkey = lock('aliasurl');
1943
	if (is_array($config['aliases']['alias'])) {
1944
		foreach ($config['aliases']['alias'] as $x => $alias) {
1945
			if (empty($alias['aliasurl']))
1946
				continue;
1947

    
1948
			$address = null;
1949
			foreach ($alias['aliasurl'] as $alias_url) {
1950
				/* fetch down and add in */
1951
				$temp_filename = tempnam("{$g['tmp_path']}/", "alias_import");
1952
				unlink($temp_filename);
1953
				$verify_ssl = isset($config['system']['checkaliasesurlcert']);
1954
				mkdir($temp_filename);
1955
				download_file($alias_url, $temp_filename . "/aliases", $verify_ssl);
1956

    
1957
				/* if the item is tar gzipped then extract */
1958
				if (stripos($alias_url, '.tgz')) {
1959
					if (!process_alias_tgz($temp_filename))
1960
						continue;
1961
				} else if (stripos($alias_url, '.zip')) {
1962
					if (!process_alias_unzip($temp_filename))
1963
						continue;
1964
				}
1965
				if (file_exists("{$temp_filename}/aliases")) {
1966
					$address = parse_aliases_file("{$temp_filename}/aliases", $alias['type'], 3000);
1967
					mwexec("/bin/rm -rf {$temp_filename}");
1968
				}
1969
			}
1970
			if ($address != null) {
1971
				$config['aliases']['alias'][$x]['address'] = implode(" ", $address);
1972
				$updated = true;
1973
			}
1974
		}
1975
	}
1976
	unlock($lockkey);
1977

    
1978
	/* Report status to callers as well */
1979
	return $updated;
1980
}
1981

    
1982
function process_alias_unzip($temp_filename) {
1983
	if(!file_exists("/usr/local/bin/unzip")) {
1984
		log_error(gettext("Alias archive is a .zip file which cannot be decompressed because utility is missing!"));
1985
		return false;
1986
	}
1987
	rename("{$temp_filename}/aliases", "{$temp_filename}/aliases.zip");
1988
	mwexec("/usr/local/bin/unzip {$temp_filename}/aliases.tgz -d {$temp_filename}/aliases/");
1989
	unlink("{$temp_filename}/aliases.zip");
1990
	$files_to_process = return_dir_as_array("{$temp_filename}/");
1991
	/* foreach through all extracted files and build up aliases file */
1992
	$fd = @fopen("{$temp_filename}/aliases", "w");
1993
	if (!$fd) {
1994
		log_error(gettext("Could not open {$temp_filename}/aliases for writing!"));
1995
		return false;
1996
	}
1997
	foreach($files_to_process as $f2p) {
1998
		$tmpfd = @fopen($f2p, 'r');
1999
		if (!$tmpfd) {
2000
			log_error(gettext("The following file could not be read {$f2p} from {$temp_filename}"));
2001
			continue;
2002
		}
2003
		while (($tmpbuf = fread($tmpfd, 65536)) !== FALSE)
2004
			fwrite($fd, $tmpbuf);
2005
		fclose($tmpfd);
2006
		unlink($f2p);
2007
	}
2008
	fclose($fd);
2009
	unset($tmpbuf);
2010

    
2011
	return true;
2012
}
2013

    
2014
function process_alias_tgz($temp_filename) {
2015
	if(!file_exists('/usr/bin/tar')) {
2016
		log_error(gettext("Alias archive is a .tar/tgz file which cannot be decompressed because utility is missing!"));
2017
		return false;
2018
	}
2019
	rename("{$temp_filename}/aliases", "{$temp_filename}/aliases.tgz");
2020
	mwexec("/usr/bin/tar xzf {$temp_filename}/aliases.tgz -C {$temp_filename}/aliases/");
2021
	unlink("{$temp_filename}/aliases.tgz");
2022
	$files_to_process = return_dir_as_array("{$temp_filename}/");
2023
	/* foreach through all extracted files and build up aliases file */
2024
	$fd = @fopen("{$temp_filename}/aliases", "w");
2025
	if (!$fd) {
2026
		log_error(gettext("Could not open {$temp_filename}/aliases for writing!"));
2027
		return false;
2028
	}
2029
	foreach($files_to_process as $f2p) {
2030
		$tmpfd = @fopen($f2p, 'r');
2031
		if (!$tmpfd) {
2032
			log_error(gettext("The following file could not be read {$f2p} from {$temp_filename}"));
2033
			continue;
2034
		}
2035
		while (($tmpbuf = fread($tmpfd, 65536)) !== FALSE)
2036
			fwrite($fd, $tmpbuf);
2037
		fclose($tmpfd);
2038
		unlink($f2p);
2039
	}
2040
	fclose($fd);
2041
	unset($tmpbuf);
2042

    
2043
	return true;
2044
}
2045

    
2046
function version_compare_dates($a, $b) {
2047
	$a_time = strtotime($a);
2048
	$b_time = strtotime($b);
2049

    
2050
	if ((!$a_time) || (!$b_time)) {
2051
		return FALSE;
2052
	} else {
2053
		if ($a_time < $b_time)
2054
			return -1;
2055
		elseif ($a_time == $b_time)
2056
			return 0;
2057
		else
2058
			return 1;
2059
	}
2060
}
2061
function version_get_string_value($a) {
2062
	$strs = array(
2063
		0 => "ALPHA-ALPHA",
2064
		2 => "ALPHA",
2065
		3 => "BETA",
2066
		4 => "B",
2067
		5 => "C",
2068
		6 => "D",
2069
		7 => "RC",
2070
		8 => "RELEASE",
2071
		9 => "*"			// Matches all release levels
2072
	);
2073
	$major = 0;
2074
	$minor = 0;
2075
	foreach ($strs as $num => $str) {
2076
		if (substr($a, 0, strlen($str)) == $str) {
2077
			$major = $num;
2078
			$n = substr($a, strlen($str));
2079
			if (is_numeric($n))
2080
				$minor = $n;
2081
			break;
2082
		}
2083
	}
2084
	return "{$major}.{$minor}";
2085
}
2086
function version_compare_string($a, $b) {
2087
	// Only compare string parts if both versions give a specific release
2088
	// (If either version lacks a string part, assume intended to match all release levels)
2089
	if (isset($a) && isset($b))
2090
		return version_compare_numeric(version_get_string_value($a), version_get_string_value($b));
2091
	else
2092
		return 0;
2093
}
2094
function version_compare_numeric($a, $b) {
2095
	$a_arr = explode('.', rtrim($a, '.0'));
2096
	$b_arr = explode('.', rtrim($b, '.0'));
2097

    
2098
	foreach ($a_arr as $n => $val) {
2099
		if (array_key_exists($n, $b_arr)) {
2100
			// So far so good, both have values at this minor version level. Compare.
2101
			if ($val > $b_arr[$n])
2102
				return 1;
2103
			elseif ($val < $b_arr[$n])
2104
				return -1;
2105
		} else {
2106
			// a is greater, since b doesn't have any minor version here.
2107
			return 1;
2108
		}
2109
	}
2110
	if (count($b_arr) > count($a_arr)) {
2111
		// b is longer than a, so it must be greater.
2112
		return -1;
2113
	} else {
2114
		// Both a and b are of equal length and value.
2115
		return 0;
2116
	}
2117
}
2118
function pfs_version_compare($cur_time, $cur_text, $remote) {
2119
	// First try date compare
2120
	$v = version_compare_dates($cur_time, $remote);
2121
	if ($v === FALSE) {
2122
		// If that fails, try to compare by string
2123
		// Before anything else, simply test if the strings are equal
2124
		if (($cur_text == $remote) || ($cur_time == $remote))
2125
			return 0;
2126
		list($cur_num, $cur_str) = explode('-', $cur_text);
2127
		list($rem_num, $rem_str) = explode('-', $remote);
2128

    
2129
		// First try to compare the numeric parts of the version string.
2130
		$v = version_compare_numeric($cur_num, $rem_num);
2131

    
2132
		// If the numeric parts are the same, compare the string parts.
2133
		if ($v == 0)
2134
			return version_compare_string($cur_str, $rem_str);
2135
	}
2136
	return $v;
2137
}
2138
function process_alias_urltable($name, $url, $freq, $forceupdate=false) {
2139
	global $config;
2140

    
2141
	$urltable_prefix = "/var/db/aliastables/";
2142
	$urltable_filename = $urltable_prefix . $name . ".txt";
2143

    
2144
	// Make the aliases directory if it doesn't exist
2145
	if (!file_exists($urltable_prefix)) {
2146
		mkdir($urltable_prefix);
2147
	} elseif (!is_dir($urltable_prefix)) {
2148
		unlink($urltable_prefix);
2149
		mkdir($urltable_prefix);
2150
	}
2151

    
2152
	// If the file doesn't exist or is older than update_freq days, fetch a new copy.
2153
	if (!file_exists($urltable_filename)
2154
		|| ((time() - filemtime($urltable_filename)) > ($freq * 86400 - 90))
2155
		|| $forceupdate) {
2156

    
2157
		// Try to fetch the URL supplied
2158
		conf_mount_rw();
2159
		unlink_if_exists($urltable_filename . ".tmp");
2160
		$verify_ssl = isset($config['system']['checkaliasesurlcert']);
2161
		if (download_file($url, $urltable_filename . ".tmp", $verify_ssl)) {
2162
			mwexec("/usr/bin/sed -E 's/\;.*//g; /^[[:space:]]*($|#)/d' ". escapeshellarg($urltable_filename . ".tmp") . " > " . escapeshellarg($urltable_filename));
2163
			if (alias_get_type($name) == "urltable_ports") {
2164
				$ports = explode("\n", file_get_contents($urltable_filename));
2165
				$ports = group_ports($ports);
2166
				file_put_contents($urltable_filename, implode("\n", $ports));
2167
			}
2168
			unlink_if_exists($urltable_filename . ".tmp");
2169
		} else
2170
			touch($urltable_filename);
2171
		conf_mount_ro();
2172
		return true;
2173
	} else {
2174
		// File exists, and it doesn't need updated.
2175
		return -1;
2176
	}
2177
}
2178
function get_real_slice_from_glabel($label) {
2179
	$label = escapeshellarg($label);
2180
	return trim(`/sbin/glabel list | /usr/bin/grep -B2 ufs/{$label} | /usr/bin/head -n 1 | /usr/bin/cut -f3 -d' '`);
2181
}
2182
function nanobsd_get_boot_slice() {
2183
	return trim(`/sbin/mount | /usr/bin/grep pfsense | /usr/bin/cut -d'/' -f4 | /usr/bin/cut -d' ' -f1`);
2184
}
2185
function nanobsd_get_boot_drive() {
2186
	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`);
2187
}
2188
function nanobsd_get_active_slice() {
2189
	$boot_drive = nanobsd_get_boot_drive();
2190
	$active = trim(`gpart show $boot_drive | grep '\[active\]' | awk '{print $3;}'`);
2191

    
2192
	return "{$boot_drive}s{$active}";
2193
}
2194
function nanobsd_get_size() {
2195
	return strtoupper(file_get_contents("/etc/nanosize.txt"));
2196
}
2197
function nanobsd_switch_boot_slice() {
2198
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
2199
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
2200
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
2201
	nanobsd_detect_slice_info();
2202

    
2203
	if ($BOOTFLASH == $ACTIVE_SLICE) {
2204
		$slice = $TOFLASH;
2205
	} else {
2206
		$slice = $BOOTFLASH;
2207
	}
2208

    
2209
	for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
2210
	ob_implicit_flush(1);
2211
	if(strstr($slice, "s2")) {
2212
		$ASLICE="2";
2213
		$AOLDSLICE="1";
2214
		$AGLABEL_SLICE="pfsense1";
2215
		$AUFS_ID="1";
2216
		$AOLD_UFS_ID="0";
2217
	} else {
2218
		$ASLICE="1";
2219
		$AOLDSLICE="2";
2220
		$AGLABEL_SLICE="pfsense0";
2221
		$AUFS_ID="0";
2222
		$AOLD_UFS_ID="1";
2223
	}
2224
	$ATOFLASH="{$BOOT_DRIVE}s{$ASLICE}";
2225
	$ACOMPLETE_PATH="{$BOOT_DRIVE}s{$ASLICE}a";
2226
	$ABOOTFLASH="{$BOOT_DRIVE}s{$AOLDSLICE}";
2227
	conf_mount_rw();
2228
	set_single_sysctl("kern.geom.debugflags", "16");
2229
	exec("gpart set -a active -i {$ASLICE} {$BOOT_DRIVE}");
2230
	exec("/usr/sbin/boot0cfg -s {$ASLICE} -v /dev/{$BOOT_DRIVE}");
2231
	// We can't update these if they are mounted now.
2232
	if ($BOOTFLASH != $slice) {
2233
		exec("/sbin/tunefs -L ${AGLABEL_SLICE} /dev/$ACOMPLETE_PATH");
2234
		nanobsd_update_fstab($AGLABEL_SLICE, $ACOMPLETE_PATH, $AOLD_UFS_ID, $AUFS_ID);
2235
	}
2236
	set_single_sysctl("kern.geom.debugflags", "0");
2237
	conf_mount_ro();
2238
}
2239
function nanobsd_clone_slice() {
2240
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
2241
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
2242
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
2243
	nanobsd_detect_slice_info();
2244

    
2245
	for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
2246
	ob_implicit_flush(1);
2247
	set_single_sysctl("kern.geom.debugflags", "16");
2248
	exec("/bin/dd if=/dev/zero of=/dev/{$TOFLASH} bs=1m count=1");
2249
	exec("/bin/dd if=/dev/{$BOOTFLASH} of=/dev/{$TOFLASH} bs=64k");
2250
	exec("/sbin/tunefs -L {$GLABEL_SLICE} /dev/{$COMPLETE_PATH}");
2251
	$status = nanobsd_update_fstab($GLABEL_SLICE, $COMPLETE_PATH, $OLD_UFS_ID, $UFS_ID);
2252
	set_single_sysctl("kern.geom.debugflags", "0");
2253
	if($status) {
2254
		return false;
2255
	} else {
2256
		return true;
2257
	}
2258
}
2259
function nanobsd_update_fstab($gslice, $complete_path, $oldufs, $newufs) {
2260
	$tmppath = "/tmp/{$gslice}";
2261
	$fstabpath = "/tmp/{$gslice}/etc/fstab";
2262

    
2263
	mkdir($tmppath);
2264
	exec("/sbin/fsck_ufs -y /dev/{$complete_path}");
2265
	exec("/sbin/mount /dev/ufs/{$gslice} {$tmppath}");
2266
	copy("/etc/fstab", $fstabpath);
2267

    
2268
	if (!file_exists($fstabpath)) {
2269
		$fstab = <<<EOF
2270
/dev/ufs/{$gslice} / ufs ro,noatime 1 1
2271
/dev/ufs/cf /cf ufs ro,noatime 1 1
2272
EOF;
2273
		if (file_put_contents($fstabpath, $fstab))
2274
			$status = true;
2275
		else
2276
			$status = false;
2277
	} else {
2278
		$status = exec("sed -i \"\" \"s/pfsense{$oldufs}/pfsense{$newufs}/g\" {$fstabpath}");
2279
	}
2280
	exec("/sbin/umount {$tmppath}");
2281
	rmdir($tmppath);
2282

    
2283
	return $status;
2284
}
2285
function nanobsd_detect_slice_info() {
2286
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
2287
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
2288
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
2289

    
2290
	$BOOT_DEVICE=nanobsd_get_boot_slice();
2291
	$REAL_BOOT_DEVICE=get_real_slice_from_glabel($BOOT_DEVICE);
2292
	$BOOT_DRIVE=nanobsd_get_boot_drive();
2293
	$ACTIVE_SLICE=nanobsd_get_active_slice();
2294

    
2295
	// Detect which slice is active and set information.
2296
	if(strstr($REAL_BOOT_DEVICE, "s1")) {
2297
		$SLICE="2";
2298
		$OLDSLICE="1";
2299
		$GLABEL_SLICE="pfsense1";
2300
		$UFS_ID="1";
2301
		$OLD_UFS_ID="0";
2302

    
2303
	} else {
2304
		$SLICE="1";
2305
		$OLDSLICE="2";
2306
		$GLABEL_SLICE="pfsense0";
2307
		$UFS_ID="0";
2308
		$OLD_UFS_ID="1";
2309
	}
2310
	$TOFLASH="{$BOOT_DRIVE}s{$SLICE}";
2311
	$COMPLETE_PATH="{$BOOT_DRIVE}s{$SLICE}a";
2312
	$COMPLETE_BOOT_PATH="{$BOOT_DRIVE}s{$OLDSLICE}";
2313
	$BOOTFLASH="{$BOOT_DRIVE}s{$OLDSLICE}";
2314
}
2315

    
2316
function nanobsd_friendly_slice_name($slicename) {
2317
	global $g;
2318
	return strtolower(str_ireplace('pfsense', $g['product_name'], $slicename));
2319
}
2320

    
2321
function get_include_contents($filename) {
2322
	if (is_file($filename)) {
2323
		ob_start();
2324
		include $filename;
2325
		$contents = ob_get_contents();
2326
		ob_end_clean();
2327
		return $contents;
2328
	}
2329
	return false;
2330
}
2331

    
2332
/* This xml 2 array function is courtesy of the php.net comment section on xml_parse.
2333
 * it is roughly 4 times faster then our existing pfSense parser but due to the large
2334
 * size of the RRD xml dumps this is required.
2335
 * The reason we do not use it for pfSense is that it does not know about array fields
2336
 * which causes it to fail on array fields with single items. Possible Todo?
2337
 */
2338
function xml2array($contents, $get_attributes = 1, $priority = 'tag')
2339
{
2340
	if (!function_exists('xml_parser_create'))
2341
	{
2342
		return array ();
2343
	}
2344
	$parser = xml_parser_create('');
2345
	xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8");
2346
	xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2347
	xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
2348
	xml_parse_into_struct($parser, trim($contents), $xml_values);
2349
	xml_parser_free($parser);
2350
	if (!$xml_values)
2351
		return; //Hmm...
2352
	$xml_array = array ();
2353
	$parents = array ();
2354
	$opened_tags = array ();
2355
	$arr = array ();
2356
	$current = & $xml_array;
2357
	$repeated_tag_index = array ();
2358
	foreach ($xml_values as $data)
2359
	{
2360
		unset ($attributes, $value);
2361
		extract($data);
2362
		$result = array ();
2363
		$attributes_data = array ();
2364
		if (isset ($value))
2365
		{
2366
			if ($priority == 'tag')
2367
				$result = $value;
2368
			else
2369
				$result['value'] = $value;
2370
		}
2371
		if (isset ($attributes) and $get_attributes)
2372
		{
2373
			foreach ($attributes as $attr => $val)
2374
			{
2375
				if ($priority == 'tag')
2376
					$attributes_data[$attr] = $val;
2377
				else
2378
					$result['attr'][$attr] = $val; //Set all the attributes in a array called 'attr'
2379
			}
2380
		}
2381
		if ($type == "open")
2382
		{
2383
			$parent[$level -1] = & $current;
2384
			if (!is_array($current) or (!in_array($tag, array_keys($current))))
2385
			{
2386
				$current[$tag] = $result;
2387
				if ($attributes_data)
2388
					$current[$tag . '_attr'] = $attributes_data;
2389
				$repeated_tag_index[$tag . '_' . $level] = 1;
2390
				$current = & $current[$tag];
2391
			}
2392
			else
2393
			{
2394
				if (isset ($current[$tag][0]))
2395
				{
2396
					$current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
2397
					$repeated_tag_index[$tag . '_' . $level]++;
2398
				}
2399
				else
2400
				{
2401
					$current[$tag] = array (
2402
						$current[$tag],
2403
						$result
2404
						);
2405
					$repeated_tag_index[$tag . '_' . $level] = 2;
2406
					if (isset ($current[$tag . '_attr']))
2407
					{
2408
						$current[$tag]['0_attr'] = $current[$tag . '_attr'];
2409
						unset ($current[$tag . '_attr']);
2410
					}
2411
				}
2412
				$last_item_index = $repeated_tag_index[$tag . '_' . $level] - 1;
2413
				$current = & $current[$tag][$last_item_index];
2414
			}
2415
		}
2416
		elseif ($type == "complete")
2417
		{
2418
			if (!isset ($current[$tag]))
2419
			{
2420
				$current[$tag] = $result;
2421
				$repeated_tag_index[$tag . '_' . $level] = 1;
2422
				if ($priority == 'tag' and $attributes_data)
2423
					$current[$tag . '_attr'] = $attributes_data;
2424
			}
2425
			else
2426
			{
2427
				if (isset ($current[$tag][0]) and is_array($current[$tag]))
2428
				{
2429
					$current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
2430
					if ($priority == 'tag' and $get_attributes and $attributes_data)
2431
					{
2432
						$current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
2433
					}
2434
					$repeated_tag_index[$tag . '_' . $level]++;
2435
				}
2436
				else
2437
				{
2438
					$current[$tag] = array (
2439
						$current[$tag],
2440
						$result
2441
						);
2442
					$repeated_tag_index[$tag . '_' . $level] = 1;
2443
					if ($priority == 'tag' and $get_attributes)
2444
					{
2445
						if (isset ($current[$tag . '_attr']))
2446
						{
2447
							$current[$tag]['0_attr'] = $current[$tag . '_attr'];
2448
							unset ($current[$tag . '_attr']);
2449
						}
2450
						if ($attributes_data)
2451
						{
2452
							$current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
2453
						}
2454
					}
2455
					$repeated_tag_index[$tag . '_' . $level]++; //0 and 1 index is already taken
2456
				}
2457
			}
2458
		}
2459
		elseif ($type == 'close')
2460
		{
2461
			$current = & $parent[$level -1];
2462
		}
2463
	}
2464
	return ($xml_array);
2465
}
2466

    
2467
function get_country_name($country_code) {
2468
	if ($country_code != "ALL" && strlen($country_code) != 2)
2469
		return "";
2470

    
2471
	$country_names_xml = "/usr/local/share/mobile-broadband-provider-info/iso_3166-1_list_en.xml";
2472
	$country_names_contents = file_get_contents($country_names_xml);
2473
	$country_names = xml2array($country_names_contents);
2474

    
2475
	if($country_code == "ALL") {
2476
		$country_list = array();
2477
		foreach($country_names['ISO_3166-1_List_en']['ISO_3166-1_Entry'] as $country) {
2478
			$country_list[] = array("code" => $country['ISO_3166-1_Alpha-2_Code_element'],
2479
						"name" => ucwords(strtolower($country['ISO_3166-1_Country_name'])) );
2480
		}
2481
		return $country_list;
2482
	}
2483

    
2484
	foreach ($country_names['ISO_3166-1_List_en']['ISO_3166-1_Entry'] as $country) {
2485
		if ($country['ISO_3166-1_Alpha-2_Code_element'] == strtoupper($country_code)) {
2486
			return ucwords(strtolower($country['ISO_3166-1_Country_name']));
2487
		}
2488
	}
2489
	return "";
2490
}
2491

    
2492
/* sort by interface only, retain the original order of rules that apply to
2493
   the same interface */
2494
function filter_rules_sort() {
2495
	global $config;
2496

    
2497
	/* mark each rule with the sequence number (to retain the order while sorting) */
2498
	for ($i = 0; isset($config['filter']['rule'][$i]); $i++)
2499
		$config['filter']['rule'][$i]['seq'] = $i;
2500

    
2501
	usort($config['filter']['rule'], "filter_rules_compare");
2502

    
2503
	/* strip the sequence numbers again */
2504
	for ($i = 0; isset($config['filter']['rule'][$i]); $i++)
2505
		unset($config['filter']['rule'][$i]['seq']);
2506
}
2507
function filter_rules_compare($a, $b) {
2508
	if (isset($a['floating']) && isset($b['floating']))
2509
		return $a['seq'] - $b['seq'];
2510
	else if (isset($a['floating']))
2511
		return -1;
2512
	else if (isset($b['floating']))
2513
		return 1;
2514
	else if ($a['interface'] == $b['interface'])
2515
		return $a['seq'] - $b['seq'];
2516
	else
2517
		return compare_interface_friendly_names($a['interface'], $b['interface']);
2518
}
2519

    
2520
function generate_ipv6_from_mac($mac) {
2521
	$elements = explode(":", $mac);
2522
	if(count($elements) <> 6)
2523
		return false;
2524

    
2525
	$i = 0;
2526
	$ipv6 = "fe80::";
2527
	foreach($elements as $byte) {
2528
		if($i == 0) {
2529
			$hexadecimal =  substr($byte, 1, 2);
2530
			$bitmap = base_convert($hexadecimal, 16, 2);
2531
			$bitmap = str_pad($bitmap, 4, "0", STR_PAD_LEFT);
2532
			$bitmap = substr($bitmap, 0, 2) ."1". substr($bitmap, 3,4);
2533
			$byte = substr($byte, 0, 1) . base_convert($bitmap, 2, 16);
2534
		}
2535
		$ipv6 .= $byte;
2536
		if($i == 1) {
2537
			$ipv6 .= ":";
2538
		}
2539
		if($i == 3) {
2540
			$ipv6 .= ":";
2541
		}
2542
		if($i == 2) {
2543
			$ipv6 .= "ff:fe";
2544
		}
2545

    
2546
		$i++;
2547
	}
2548
	return $ipv6;
2549
}
2550

    
2551
/****f* pfsense-utils/load_mac_manufacturer_table
2552
 * NAME
2553
 *   load_mac_manufacturer_table
2554
 * INPUTS
2555
 *   none
2556
 * RESULT
2557
 *   returns associative array with MAC-Manufacturer pairs
2558
 ******/
2559
function load_mac_manufacturer_table() {
2560
	/* load MAC-Manufacture data from the file */
2561
	$macs = false;
2562
	if (file_exists("/usr/local/share/nmap/nmap-mac-prefixes"))
2563
		$macs=file("/usr/local/share/nmap/nmap-mac-prefixes");
2564
	if ($macs){
2565
		foreach ($macs as $line){
2566
			if (preg_match('/([0-9A-Fa-f]{6}) (.*)$/', $line, $matches)){
2567
				/* store values like this $mac_man['000C29']='VMware' */
2568
				$mac_man["$matches[1]"]=$matches[2];
2569
			}
2570
		}
2571
		return $mac_man;
2572
	} else
2573
		return -1;
2574

    
2575
}
2576

    
2577
/****f* pfsense-utils/is_ipaddr_configured
2578
 * NAME
2579
 *   is_ipaddr_configured
2580
 * INPUTS
2581
 *   IP Address to check.
2582
 *   If ignore_if is a VIP (not carp), vip array index is passed after string _virtualip
2583
 * RESULT
2584
 *   returns true if the IP Address is
2585
 *   configured and present on this device.
2586
*/
2587
function is_ipaddr_configured($ipaddr, $ignore_if = "", $check_localip = false, $check_subnets = false) {
2588
	global $config;
2589

    
2590
	$pos = strpos($ignore_if, '_virtualip');
2591
	if ($pos !== false) {
2592
		$ignore_vip_id = substr($ignore_if, $pos+10);
2593
		$ignore_vip_if = substr($ignore_if, 0, $pos);
2594
	} else {
2595
		$ignore_vip_id = -1;
2596
		$ignore_vip_if = $ignore_if;
2597
	}
2598

    
2599
	$isipv6 = is_ipaddrv6($ipaddr);
2600

    
2601
	if ($check_subnets) {
2602
		$iflist = get_configured_interface_list();
2603
		foreach ($iflist as $if => $ifname) {
2604
			if ($ignore_if == $if)
2605
				continue;
2606

    
2607
			if ($isipv6 === true) {
2608
				$bitmask = get_interface_subnetv6($if);
2609
				$subnet = gen_subnetv6(get_interface_ipv6($if), $bitmask);
2610
			} else {
2611
				$bitmask = get_interface_subnet($if);
2612
				$subnet = gen_subnet(get_interface_ip($if), $bitmask);
2613
			}
2614

    
2615
			if (ip_in_subnet($ipaddr, $subnet . '/' . $bitmask))
2616
				return true;
2617
		}
2618
	} else {
2619
		if ($isipv6 === true)
2620
			$interface_list_ips = get_configured_ipv6_addresses();
2621
		else
2622
			$interface_list_ips = get_configured_ip_addresses();
2623

    
2624
		foreach($interface_list_ips as $if => $ilips) {
2625
			if ($ignore_if == $if)
2626
				continue;
2627
			if (strcasecmp($ipaddr, $ilips) == 0)
2628
				return true;
2629
		}
2630
	}
2631

    
2632
	$interface_list_vips = get_configured_vips_list(true);
2633
	foreach ($interface_list_vips as $id => $vip) {
2634
		/* Skip CARP interfaces here since they were already checked above */
2635
		if ($id == $ignore_vip_id || (strstr($ignore_if, '_vip') && $ignore_vip_if == $vip['if']))
2636
			continue;
2637
		if (strcasecmp($ipaddr, $vip['ipaddr']) == 0)
2638
			return true;
2639
	}
2640

    
2641
	if ($check_localip) {
2642
		if (is_array($config['pptpd']) && !empty($config['pptpd']['localip']) && (strcasecmp($ipaddr, $config['pptpd']['localip']) == 0))
2643
			return true;
2644

    
2645
		if (!is_array($config['l2tp']) && !empty($config['l2tp']['localip']) && (strcasecmp($ipaddr, $config['l2tp']['localip']) == 0))
2646
			return true;
2647
	}
2648

    
2649
	return false;
2650
}
2651

    
2652
/****f* pfsense-utils/pfSense_handle_custom_code
2653
 * NAME
2654
 *   pfSense_handle_custom_code
2655
 * INPUTS
2656
 *   directory name to process
2657
 * RESULT
2658
 *   globs the directory and includes the files
2659
 */
2660
function pfSense_handle_custom_code($src_dir) {
2661
	// Allow extending of the nat edit page and include custom input validation
2662
	if(is_dir("$src_dir")) {
2663
		$cf = glob($src_dir . "/*.inc");
2664
		foreach($cf as $nf) {
2665
			if($nf == "." || $nf == "..")
2666
				continue;
2667
			// Include the extra handler
2668
			include("$nf");
2669
		}
2670
	}
2671
}
2672

    
2673
function set_language($lang = 'en_US', $encoding = "UTF-8") {
2674
	putenv("LANG={$lang}.{$encoding}");
2675
	setlocale(LC_ALL, "{$lang}.{$encoding}");
2676
	textdomain("pfSense");
2677
	bindtextdomain("pfSense","/usr/local/share/locale");
2678
	bind_textdomain_codeset("pfSense","{$lang}.{$encoding}");
2679
}
2680

    
2681
function get_locale_list() {
2682
	$locales = array(
2683
		"en_US" => gettext("English"),
2684
		"pt_BR" => gettext("Portuguese (Brazil)"),
2685
		"tr" => gettext("Turkish"),
2686
	);
2687
	asort($locales);
2688
	return $locales;
2689
}
2690

    
2691
function system_get_language_code() {
2692
	global $config, $g_languages;
2693

    
2694
	// a language code, as per [RFC3066]
2695
	$language = $config['system']['language'];
2696
	//$code = $g_languages[$language]['code'];
2697
	$code = str_replace("_", "-", $language);
2698

    
2699
	if (empty($code))
2700
		$code = "en-US"; // Set default code.
2701

    
2702
	return $code;
2703
}
2704

    
2705
function system_get_language_codeset() {
2706
	global $config, $g_languages;
2707

    
2708
	$language = $config['system']['language'];
2709
	$codeset = $g_languages[$language]['codeset'];
2710

    
2711
	if (empty($codeset))
2712
		$codeset = "UTF-8"; // Set default codeset.
2713

    
2714
	return $codeset;
2715
}
2716

    
2717
/* Available languages/locales */
2718
$g_languages = array (
2719
	"sq"    => array("codeset" => "UTF-8", "desc" => gettext("Albanian")),
2720
	"bg"    => array("codeset" => "UTF-8", "desc" => gettext("Bulgarian")),
2721
	"zh_CN" => array("codeset" => "UTF-8", "desc" => gettext("Chinese (Simplified)")),
2722
	"zh_TW" => array("codeset" => "UTF-8", "desc" => gettext("Chinese (Traditional)")),
2723
	"nl"    => array("codeset" => "UTF-8", "desc" => gettext("Dutch")),
2724
	"da"    => array("codeset" => "UTF-8", "desc" => gettext("Danish")),
2725
	"en_US" => array("codeset" => "UTF-8", "desc" => gettext("English")),
2726
	"fi"    => array("codeset" => "UTF-8", "desc" => gettext("Finnish")),
2727
	"fr"    => array("codeset" => "UTF-8", "desc" => gettext("French")),
2728
	"de"    => array("codeset" => "UTF-8", "desc" => gettext("German")),
2729
	"el"    => array("codeset" => "UTF-8", "desc" => gettext("Greek")),
2730
	"hu"    => array("codeset" => "UTF-8", "desc" => gettext("Hungarian")),
2731
	"it"    => array("codeset" => "UTF-8", "desc" => gettext("Italian")),
2732
	"ja"    => array("codeset" => "UTF-8", "desc" => gettext("Japanese")),
2733
	"ko"    => array("codeset" => "UTF-8", "desc" => gettext("Korean")),
2734
	"lv"    => array("codeset" => "UTF-8", "desc" => gettext("Latvian")),
2735
	"nb"    => array("codeset" => "UTF-8", "desc" => gettext("Norwegian (Bokmal)")),
2736
	"pl"    => array("codeset" => "UTF-8", "desc" => gettext("Polish")),
2737
	"pt_BR" => array("codeset" => "ISO-8859-1", "desc" => gettext("Portuguese (Brazil)")),
2738
	"pt"    => array("codeset" => "UTF-8", "desc" => gettext("Portuguese (Portugal)")),
2739
	"ro"    => array("codeset" => "UTF-8", "desc" => gettext("Romanian")),
2740
	"ru"    => array("codeset" => "UTF-8", "desc" => gettext("Russian")),
2741
	"sl"    => array("codeset" => "UTF-8", "desc" => gettext("Slovenian")),
2742
	"tr"    => array("codeset" => "UTF-8", "desc" => gettext("Turkish")),
2743
	"es"    => array("codeset" => "UTF-8", "desc" => gettext("Spanish")),
2744
	"sv"    => array("codeset" => "UTF-8", "desc" => gettext("Swedish")),
2745
	"sk"    => array("codeset" => "UTF-8", "desc" => gettext("Slovak")),
2746
	"cs"    => array("codeset" => "UTF-8", "desc" => gettext("Czech"))
2747
);
2748

    
2749
function return_hex_ipv4($ipv4) {
2750
	if(!is_ipaddrv4($ipv4))
2751
		return(false);
2752

    
2753
	/* we need the hex form of the interface IPv4 address */
2754
	$ip4arr = explode(".", $ipv4);
2755
	return (sprintf("%02x%02x%02x%02x", $ip4arr[0], $ip4arr[1], $ip4arr[2], $ip4arr[3]));
2756
}
2757

    
2758
function convert_ipv6_to_128bit($ipv6) {
2759
	if(!is_ipaddrv6($ipv6))
2760
		return(false);
2761

    
2762
	$ip6arr = array();
2763
	$ip6prefix = Net_IPv6::uncompress($ipv6);
2764
	$ip6arr = explode(":", $ip6prefix);
2765
	/* binary presentation of the prefix for all 128 bits. */
2766
	$ip6prefixbin = "";
2767
	foreach($ip6arr as $element) {
2768
		$ip6prefixbin .= sprintf("%016b", hexdec($element));
2769
	}
2770
	return($ip6prefixbin);
2771
}
2772

    
2773
function convert_128bit_to_ipv6($ip6bin) {
2774
	if(strlen($ip6bin) <> 128)
2775
		return(false);
2776

    
2777
	$ip6arr = array();
2778
	$ip6binarr = array();
2779
	$ip6binarr = str_split($ip6bin, 16);
2780
	foreach($ip6binarr as $binpart)
2781
		$ip6arr[] = dechex(bindec($binpart));
2782
	$ip6addr = Net_IPv6::compress(implode(":", $ip6arr));
2783

    
2784
	return($ip6addr);
2785
}
2786

    
2787

    
2788
/* Returns the calculated bit length of the prefix delegation from the WAN interface */
2789
/* DHCP-PD is variable, calculate from the prefix-len on the WAN interface */
2790
/* 6rd is variable, calculate from 64 - (v6 prefixlen - (32 - v4 prefixlen)) */
2791
/* 6to4 is 16 bits, e.g. 65535 */
2792
function calculate_ipv6_delegation_length($if) {
2793
	global $config;
2794

    
2795
	if(!is_array($config['interfaces'][$if]))
2796
		return false;
2797

    
2798
	switch($config['interfaces'][$if]['ipaddrv6']) {
2799
		case "6to4":
2800
			$pdlen = 16;
2801
			break;
2802
		case "6rd":
2803
			$rd6cfg = $config['interfaces'][$if];
2804
			$rd6plen = explode("/", $rd6cfg['prefix-6rd']);
2805
			$pdlen = (64 - ($rd6plen[1] + (32 - $rd6cfg['prefix-6rd-v4plen'])));
2806
			break;
2807
		case "dhcp6":
2808
			$dhcp6cfg = $config['interfaces'][$if];
2809
			$pdlen = $dhcp6cfg['dhcp6-ia-pd-len'];
2810
			break;
2811
		default:
2812
			$pdlen = 0;
2813
			break;
2814
	}
2815
	return($pdlen);
2816
}
2817

    
2818
function huawei_rssi_to_string($rssi) {
2819
	$dbm = array();
2820
	$i = 0;
2821
	$dbstart = -113;
2822
	while($i < 32) {
2823
		$dbm[$i] = $dbstart + ($i * 2);
2824
		$i++;
2825
	}
2826
	$percent = round(($rssi / 31) * 100);
2827
	$string = "rssi:{$rssi} level:{$dbm[$rssi]}dBm percent:{$percent}%";
2828
	return $string;
2829
}
2830

    
2831
function huawei_mode_to_string($mode, $submode) {
2832
	$modes[0] = "None";
2833
	$modes[1] = "AMPS";
2834
	$modes[2] = "CDMA";
2835
	$modes[3] = "GSM/GPRS";
2836
	$modes[4] = "HDR";
2837
	$modes[5] = "WCDMA";
2838
	$modes[6] = "GPS";
2839

    
2840
	$submodes[0] = "No Service";
2841
	$submodes[1] = "GSM";
2842
	$submodes[2] = "GPRS";
2843
	$submodes[3] = "EDGE";
2844
	$submodes[4] = "WCDMA";
2845
	$submodes[5] = "HSDPA";
2846
	$submodes[6] = "HSUPA";
2847
	$submodes[7] = "HSDPA+HSUPA";
2848
	$submodes[8] = "TD-SCDMA";
2849
	$submodes[9] = "HSPA+";
2850
	$string = "{$modes[$mode]}, {$submodes[$submode]} Mode";
2851
	return $string;
2852
}
2853

    
2854
function huawei_service_to_string($state) {
2855
	$modes[0] = "No";
2856
	$modes[1] = "Restricted";
2857
	$modes[2] = "Valid";
2858
	$modes[3] = "Restricted Regional";
2859
	$modes[4] = "Powersaving";
2860
	$string = "{$modes[$state]} Service";
2861
	return $string;
2862
}
2863

    
2864
function huawei_simstate_to_string($state) {
2865
	$modes[0] = "Invalid SIM/locked";
2866
	$modes[1] = "Valid SIM";
2867
	$modes[2] = "Invalid SIM CS";
2868
	$modes[3] = "Invalid SIM PS";
2869
	$modes[4] = "Invalid SIM CS/PS";
2870
	$modes[255] = "Missing SIM";
2871
	$string = "{$modes[$state]} State";
2872
	return $string;
2873
}
2874

    
2875
function zte_rssi_to_string($rssi) {
2876
	return huawei_rssi_to_string($rssi);
2877
}
2878

    
2879
function zte_mode_to_string($mode, $submode) {
2880
	$modes[0] = "No Service";
2881
	$modes[1] = "Limited Service";
2882
	$modes[2] = "GPRS";
2883
	$modes[3] = "GSM";
2884
	$modes[4] = "UMTS";
2885
	$modes[5] = "EDGE";
2886
	$modes[6] = "HSDPA";
2887

    
2888
	$submodes[0] = "CS_ONLY";
2889
	$submodes[1] = "PS_ONLY";
2890
	$submodes[2] = "CS_PS";
2891
	$submodes[3] = "CAMPED";
2892
	$string = "{$modes[$mode]}, {$submodes[$submode]} Mode";
2893
	return $string;
2894
}
2895

    
2896
function zte_service_to_string($state) {
2897
	$modes[0] = "Initializing";
2898
	$modes[1] = "Network Lock error";
2899
	$modes[2] = "Network Locked";
2900
	$modes[3] = "Unlocked or correct MCC/MNC";
2901
	$string = "{$modes[$state]} Service";
2902
	return $string;
2903
}
2904

    
2905
function zte_simstate_to_string($state) {
2906
	$modes[0] = "No action";
2907
	$modes[1] = "Network lock";
2908
	$modes[2] = "(U)SIM card lock";
2909
	$modes[3] = "Network Lock and (U)SIM card Lock";
2910
	$string = "{$modes[$state]} State";
2911
	return $string;
2912
}
2913

    
2914
function get_configured_pppoe_server_interfaces() {
2915
	global $config;
2916
	$iflist = array();
2917
	if (is_array($config['pppoes']['pppoe'])) {
2918
		foreach($config['pppoes']['pppoe'] as $pppoe) {
2919
			if ($pppoe['mode'] == "server") {
2920
				$int = "poes". $pppoe['pppoeid'];
2921
				$iflist[$int] = strtoupper($int);
2922
			}
2923
		}
2924
	}
2925
	return $iflist;
2926
}
2927

    
2928
function get_pppoes_child_interfaces($ifpattern) {
2929
	$if_arr = array();
2930
	if($ifpattern == "")
2931
		return;
2932

    
2933
	exec("ifconfig", $out, $ret);
2934
	foreach($out as $line) {
2935
		if(preg_match("/^({$ifpattern}[0-9]+):/i", $line, $match)) {
2936
			$if_arr[] = $match[1];
2937
		}
2938
	}
2939
	return $if_arr;
2940

    
2941
}
2942

    
2943
/****f* pfsense-utils/pkg_call_plugins
2944
 * NAME
2945
 *   pkg_call_plugins
2946
 * INPUTS
2947
 *   $plugin_type value used to search in package configuration if the plugin is used, also used to create the function name
2948
 *   $plugin_params parameters to pass to the plugin function for passing multiple parameters a array can be used.
2949
 * RESULT
2950
 *   returns associative array results from the plugin calls for each package
2951
 * NOTES
2952
 *   This generic function can be used to notify or retrieve results from functions that are defined in packages.
2953
 ******/
2954
function pkg_call_plugins($plugin_type, $plugin_params) {
2955
	global $g, $config;
2956
	$results = array();
2957
	if (!is_array($config['installedpackages']['package']))
2958
		return $results;
2959
	foreach ($config['installedpackages']['package'] as $package) {
2960
		if(!file_exists("/usr/local/pkg/" . $package['configurationfile']))
2961
			continue;
2962
		$pkg_config = parse_xml_config_pkg("/usr/local/pkg/" . $package['configurationfile'], 'packagegui');
2963
		$pkgname = substr(reverse_strrchr($package['configurationfile'], "."),0,-1);
2964
		if (is_array($pkg_config['plugins']['item']))
2965
			foreach ($pkg_config['plugins']['item'] as $plugin) {
2966
				if ($plugin['type'] == $plugin_type) {
2967
					if (file_exists($pkg_config['include_file']))
2968
						require_once($pkg_config['include_file']);
2969
					else
2970
						continue;
2971
					$plugin_function = $pkgname . '_'. $plugin_type;
2972
					$results[$pkgname] = @eval($plugin_function($plugin_params));
2973
				}
2974
			}
2975
	}
2976
	return $results;
2977
}
2978

    
2979
/* Function to find and return the active XML RPC base URL to avoid code duplication */
2980
function get_active_xml_rpc_base_url() {
2981
	global $config, $g;
2982
	/* If the user has activated the option to enable an alternate xmlrpcbaseurl, and it's not empty, then use it */
2983
	if (isset($config['system']['altpkgrepo']['enable']) && !empty($config['system']['altpkgrepo']['xmlrpcbaseurl'])) {
2984
		return $config['system']['altpkgrepo']['xmlrpcbaseurl'];
2985
	} else {
2986
		return $g['xmlrpcbaseurl'];
2987
	}
2988
}
2989

    
2990
?>
(40-40/68)