Project

General

Profile

Download (84.9 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 fidn 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 gettext("MASTER");
381
		if(stristr($int, "BACKUP"))
382
			return gettext("BACKUP");
383
		if(stristr($int, "INIT"))
384
			return gettext("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() ? 'on' : '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, "ttyu0"))
1037
			fwrite($fd, "ttyu0	\"/usr/libexec/getty {$serial_type}\"	cons25	{$on_off}	secure\n");
1038
		else
1039
			fwrite($fd, $tty . "\n");
1040
	}
1041
	unset($on_off, $console_type, $serial_type);
1042
	fclose($fd);
1043
	if ($when != "upgrade")
1044
		reload_ttys();
1045

    
1046
	conf_mount_ro();
1047
	return;
1048
}
1049

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

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

    
1058
	return true;
1059
}
1060

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

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

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

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

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

    
1088
	return false;
1089
}
1090

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

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

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

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

    
1110
	return false;
1111
}
1112

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

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

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

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

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

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

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

    
1138
		return true;
1139
	}
1140

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

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

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

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

    
1158
		return true;
1159
	}
1160

    
1161
	return false;
1162
}
1163

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

    
1168
	$pppoeenable = false;
1169

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

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

    
1177
	return $pppoeenable;
1178
}
1179

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1457
	return $ifinfo;
1458
}
1459

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1625
/****f* pfsense-utils/isvm
1626
 * NAME
1627
 *   isvm
1628
 * INPUTS
1629
 *	none
1630
 * RESULT
1631
 *   returns true if machine is running under a virtual environment
1632
 ******/
1633
function isvm() {
1634
	$virtualenvs = array("vmware", "parallels", "qemu", "bochs", "plex86");
1635
	$bios_product = trim(`/bin/kenv smbios.system.product`);
1636
	foreach ($virtualenvs as $virtualenv)
1637
		if (stripos($bios_product, $virtualenv) !== false)
1638
			return true;
1639

    
1640
	return false;
1641
}
1642

    
1643
function get_freebsd_version() {
1644
	$version = explode(".", php_uname("r"));
1645
	return $version[0];
1646
}
1647

    
1648
function download_file($url, $destination, $verify_ssl = false, $connect_timeout = 60, $timeout = 0) {
1649
	global $config, $g;
1650

    
1651
	$fp = fopen($destination, "wb");
1652

    
1653
	if (!$fp)
1654
		return false;
1655

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

    
1666
	if (!empty($config['system']['proxyurl'])) {
1667
		curl_setopt($ch, CURLOPT_PROXY, $config['system']['proxyurl']);
1668
		if (!empty($config['system']['proxyport']))
1669
			curl_setopt($ch, CURLOPT_PROXYPORT, $config['system']['proxyport']);
1670
		if (!empty($config['system']['proxyuser']) && !empty($config['system']['proxypass'])) {
1671
			@curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_ANY | CURLAUTH_ANYSAFE);
1672
			curl_setopt($ch, CURLOPT_PROXYUSERPWD, "{$config['system']['proxyuser']}:{$config['system']['proxypass']}");
1673
		}
1674
	}
1675

    
1676
	@curl_exec($ch);
1677
	$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
1678
	fclose($fp);
1679
	curl_close($ch);
1680
	return ($http_code == 200) ? true : $http_code;
1681
}
1682

    
1683
function download_file_with_progress_bar($url_file, $destination_file, $readbody = 'read_body', $connect_timeout=60, $timeout=0) {
1684
	global $ch, $fout, $file_size, $downloaded, $config, $first_progress_update;
1685
	$file_size  = 1;
1686
	$downloaded = 1;
1687
	$first_progress_update = TRUE;
1688
	/* open destination file */
1689
	$fout = fopen($destination_file, "wb");
1690

    
1691
	/*
1692
	 *      Originally by Author: Keyvan Minoukadeh
1693
	 *      Modified by Scott Ullrich to return Content-Length size
1694
	 */
1695

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

    
1708
	if (!empty($config['system']['proxyurl'])) {
1709
		curl_setopt($ch, CURLOPT_PROXY, $config['system']['proxyurl']);
1710
		if (!empty($config['system']['proxyport']))
1711
			curl_setopt($ch, CURLOPT_PROXYPORT, $config['system']['proxyport']);
1712
		if (!empty($config['system']['proxyuser']) && !empty($config['system']['proxypass'])) {
1713
			@curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_ANY | CURLAUTH_ANYSAFE);
1714
			curl_setopt($ch, CURLOPT_PROXYUSERPWD, "{$config['system']['proxyuser']}:{$config['system']['proxypass']}");
1715
		}
1716
	}
1717

    
1718
	@curl_exec($ch);
1719
	$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
1720
	if($fout)
1721
		fclose($fout);
1722
	curl_close($ch);
1723
	return ($http_code == 200) ? true : $http_code;
1724
}
1725

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

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

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

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

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

    
1843
/* 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. */
1844
if(!function_exists("split")) {
1845
	function split($separator, $haystack, $limit = null) {
1846
		log_error("deprecated split() call with separator '{$separator}'");
1847
		return preg_split($separator, $haystack, $limit);
1848
	}
1849
}
1850

    
1851
function update_alias_names_upon_change($section, $field, $new_alias_name, $origname) {
1852
	global $g, $config, $pconfig, $debug;
1853
	if(!$origname)
1854
		return;
1855

    
1856
	$sectionref = &$config;
1857
	foreach($section as $sectionname) {
1858
		if(is_array($sectionref) && isset($sectionref[$sectionname]))
1859
			$sectionref = &$sectionref[$sectionname];
1860
		else
1861
			return;
1862
	}
1863

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

    
1867
	if(is_array($sectionref)) {
1868
		foreach($sectionref as $itemkey => $item) {
1869
			if($debug) fwrite($fd, "$itemkey\n");
1870

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

    
1888
	if($debug) fclose($fd);
1889

    
1890
}
1891

    
1892
function update_alias_url_data() {
1893
	global $config, $g;
1894

    
1895
	$updated = false;
1896

    
1897
	/* item is a url type */
1898
	$lockkey = lock('aliasurl');
1899
	if (is_array($config['aliases']['alias'])) {
1900
		foreach ($config['aliases']['alias'] as $x => $alias) {
1901
			if (empty($alias['aliasurl']))
1902
				continue;
1903

    
1904
			$address = "";
1905
			$isfirst = 0;
1906
			foreach ($alias['aliasurl'] as $alias_url) {
1907
				/* fetch down and add in */
1908
				$temp_filename = tempnam("{$g['tmp_path']}/", "alias_import");
1909
				unlink($temp_filename);
1910
				$verify_ssl = isset($config['system']['checkaliasesurlcert']);
1911
				mkdir($temp_filename);
1912
				download_file($alias_url, $temp_filename . "/aliases", $verify_ssl);
1913

    
1914
				/* if the item is tar gzipped then extract */
1915
				if (stripos($alias_url, '.tgz')) {
1916
					if (!process_alias_tgz($temp_filename))
1917
						continue;
1918
				} else if (stripos($alias_url, '.zip')) {
1919
					if (!process_alias_unzip($temp_filename))
1920
						continue;
1921
				}
1922
				if (file_exists("{$temp_filename}/aliases")) {
1923
					$fd = @fopen("{$temp_filename}/aliases", 'r');
1924
					if (!$fd) {
1925
						log_error(gettext("Could not process aliases from alias: {$alias_url}"));
1926
						continue;
1927
					}
1928
					/* NOTE: fgetss() is not a typo RTFM before being smart */
1929
					while (($fc = fgetss($fd)) !== FALSE) {
1930
						$tmp = trim($fc, " \t\n\r");
1931
						if (empty($tmp))
1932
							continue;
1933
						$tmp_str = strstr($tmp, '#', true);
1934
						if (!empty($tmp_str))
1935
							$tmp = $tmp_str;
1936
						if ($isfirst == 1)
1937
							$address .= ' ';
1938
						$address .= $tmp;
1939
						$isfirst = 1;
1940
					}
1941
					fclose($fd);
1942
					mwexec("/bin/rm -rf {$temp_filename}");
1943
				}
1944
			}
1945
			if (!empty($address)) {
1946
				$config['aliases']['alias'][$x]['address'] = $address;
1947
				$updated = true;
1948
			}
1949
		}
1950
	}
1951
	unlock($lockkey);
1952

    
1953
	/* Report status to callers as well */
1954
	return $updated;
1955
}
1956

    
1957
function process_alias_unzip($temp_filename) {
1958
	if(!file_exists("/usr/local/bin/unzip")) {
1959
		log_error(gettext("Alias archive is a .zip file which cannot be decompressed because utility is missing!"));
1960
		return false;
1961
	}
1962
	rename("{$temp_filename}/aliases", "{$temp_filename}/aliases.zip");
1963
	mwexec("/usr/local/bin/unzip {$temp_filename}/aliases.tgz -d {$temp_filename}/aliases/");
1964
	unlink("{$temp_filename}/aliases.zip");
1965
	$files_to_process = return_dir_as_array("{$temp_filename}/");
1966
	/* foreach through all extracted files and build up aliases file */
1967
	$fd = @fopen("{$temp_filename}/aliases", "w");
1968
	if (!$fd) {
1969
		log_error(gettext("Could not open {$temp_filename}/aliases for writing!"));
1970
		return false;
1971
	}
1972
	foreach($files_to_process as $f2p) {
1973
		$tmpfd = @fopen($f2p, 'r');
1974
		if (!$tmpfd) {
1975
			log_error(gettext("The following file could not be read {$f2p} from {$temp_filename}"));
1976
			continue;
1977
		}
1978
		while (($tmpbuf = fread($tmpfd, 65536)) !== FALSE)
1979
			fwrite($fd, $tmpbuf);
1980
		fclose($tmpfd);
1981
		unlink($f2p);
1982
	}
1983
	fclose($fd);
1984
	unset($tmpbuf);
1985

    
1986
	return true;
1987
}
1988

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

    
2018
	return true;
2019
}
2020

    
2021
function version_compare_dates($a, $b) {
2022
	$a_time = strtotime($a);
2023
	$b_time = strtotime($b);
2024

    
2025
	if ((!$a_time) || (!$b_time)) {
2026
		return FALSE;
2027
	} else {
2028
		if ($a_time < $b_time)
2029
			return -1;
2030
		elseif ($a_time == $b_time)
2031
			return 0;
2032
		else
2033
			return 1;
2034
	}
2035
}
2036
function version_get_string_value($a) {
2037
	$strs = array(
2038
		0 => "ALPHA-ALPHA",
2039
		2 => "ALPHA",
2040
		3 => "BETA",
2041
		4 => "B",
2042
		5 => "C",
2043
		6 => "D",
2044
		7 => "RC",
2045
		8 => "RELEASE",
2046
		9 => "*"			// Matches all release levels
2047
	);
2048
	$major = 0;
2049
	$minor = 0;
2050
	foreach ($strs as $num => $str) {
2051
		if (substr($a, 0, strlen($str)) == $str) {
2052
			$major = $num;
2053
			$n = substr($a, strlen($str));
2054
			if (is_numeric($n))
2055
				$minor = $n;
2056
			break;
2057
		}
2058
	}
2059
	return "{$major}.{$minor}";
2060
}
2061
function version_compare_string($a, $b) {
2062
	// Only compare string parts if both versions give a specific release
2063
	// (If either version lacks a string part, assume intended to match all release levels)
2064
	if (isset($a) && isset($b))
2065
		return version_compare_numeric(version_get_string_value($a), version_get_string_value($b));
2066
	else
2067
		return 0;
2068
}
2069
function version_compare_numeric($a, $b) {
2070
	$a_arr = explode('.', rtrim($a, '.0'));
2071
	$b_arr = explode('.', rtrim($b, '.0'));
2072

    
2073
	foreach ($a_arr as $n => $val) {
2074
		if (array_key_exists($n, $b_arr)) {
2075
			// So far so good, both have values at this minor version level. Compare.
2076
			if ($val > $b_arr[$n])
2077
				return 1;
2078
			elseif ($val < $b_arr[$n])
2079
				return -1;
2080
		} else {
2081
			// a is greater, since b doesn't have any minor version here.
2082
			return 1;
2083
		}
2084
	}
2085
	if (count($b_arr) > count($a_arr)) {
2086
		// b is longer than a, so it must be greater.
2087
		return -1;
2088
	} else {
2089
		// Both a and b are of equal length and value.
2090
		return 0;
2091
	}
2092
}
2093
function pfs_version_compare($cur_time, $cur_text, $remote) {
2094
	// First try date compare
2095
	$v = version_compare_dates($cur_time, $remote);
2096
	if ($v === FALSE) {
2097
		// If that fails, try to compare by string
2098
		// Before anything else, simply test if the strings are equal
2099
		if (($cur_text == $remote) || ($cur_time == $remote))
2100
			return 0;
2101
		list($cur_num, $cur_str) = explode('-', $cur_text);
2102
		list($rem_num, $rem_str) = explode('-', $remote);
2103

    
2104
		// First try to compare the numeric parts of the version string.
2105
		$v = version_compare_numeric($cur_num, $rem_num);
2106

    
2107
		// If the numeric parts are the same, compare the string parts.
2108
		if ($v == 0)
2109
			return version_compare_string($cur_str, $rem_str);
2110
	}
2111
	return $v;
2112
}
2113
function process_alias_urltable($name, $url, $freq, $forceupdate=false) {
2114
	global $config;
2115

    
2116
	$urltable_prefix = "/var/db/aliastables/";
2117
	$urltable_filename = $urltable_prefix . $name . ".txt";
2118

    
2119
	// Make the aliases directory if it doesn't exist
2120
	if (!file_exists($urltable_prefix)) {
2121
		mkdir($urltable_prefix);
2122
	} elseif (!is_dir($urltable_prefix)) {
2123
		unlink($urltable_prefix);
2124
		mkdir($urltable_prefix);
2125
	}
2126

    
2127
	// If the file doesn't exist or is older than update_freq days, fetch a new copy.
2128
	if (!file_exists($urltable_filename)
2129
		|| ((time() - filemtime($urltable_filename)) > ($freq * 86400 - 90))
2130
		|| $forceupdate) {
2131

    
2132
		// Try to fetch the URL supplied
2133
		conf_mount_rw();
2134
		unlink_if_exists($urltable_filename . ".tmp");
2135
		$verify_ssl = isset($config['system']['checkaliasesurlcert']);
2136
		if (download_file($url, $urltable_filename . ".tmp", $verify_ssl)) {
2137
			mwexec("/usr/bin/sed -E 's/\;.*//g; /^[[:space:]]*($|#)/d' ". escapeshellarg($urltable_filename . ".tmp") . " > " . escapeshellarg($urltable_filename));
2138
			if (alias_get_type($name) == "urltable_ports") {
2139
				$ports = explode("\n", file_get_contents($urltable_filename));
2140
				$ports = group_ports($ports);
2141
				file_put_contents($urltable_filename, implode("\n", $ports));
2142
			}
2143
			unlink_if_exists($urltable_filename . ".tmp");
2144
		} else
2145
			touch($urltable_filename);
2146
		conf_mount_ro();
2147
		return true;
2148
	} else {
2149
		// File exists, and it doesn't need updated.
2150
		return -1;
2151
	}
2152
}
2153
function get_real_slice_from_glabel($label) {
2154
	$label = escapeshellarg($label);
2155
	return trim(`/sbin/glabel list | /usr/bin/grep -B2 ufs/{$label} | /usr/bin/head -n 1 | /usr/bin/cut -f3 -d' '`);
2156
}
2157
function nanobsd_get_boot_slice() {
2158
	return trim(`/sbin/mount | /usr/bin/grep pfsense | /usr/bin/cut -d'/' -f4 | /usr/bin/cut -d' ' -f1`);
2159
}
2160
function nanobsd_get_boot_drive() {
2161
	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`);
2162
}
2163
function nanobsd_get_active_slice() {
2164
	$boot_drive = nanobsd_get_boot_drive();
2165
	$active = trim(`gpart show $boot_drive | grep '\[active\]' | awk '{print $3;}'`);
2166

    
2167
	return "{$boot_drive}s{$active}";
2168
}
2169
function nanobsd_get_size() {
2170
	return strtoupper(file_get_contents("/etc/nanosize.txt"));
2171
}
2172
function nanobsd_switch_boot_slice() {
2173
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
2174
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
2175
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
2176
	nanobsd_detect_slice_info();
2177

    
2178
	if ($BOOTFLASH == $ACTIVE_SLICE) {
2179
		$slice = $TOFLASH;
2180
	} else {
2181
		$slice = $BOOTFLASH;
2182
	}
2183

    
2184
	for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
2185
	ob_implicit_flush(1);
2186
	if(strstr($slice, "s2")) {
2187
		$ASLICE="2";
2188
		$AOLDSLICE="1";
2189
		$AGLABEL_SLICE="pfsense1";
2190
		$AUFS_ID="1";
2191
		$AOLD_UFS_ID="0";
2192
	} else {
2193
		$ASLICE="1";
2194
		$AOLDSLICE="2";
2195
		$AGLABEL_SLICE="pfsense0";
2196
		$AUFS_ID="0";
2197
		$AOLD_UFS_ID="1";
2198
	}
2199
	$ATOFLASH="{$BOOT_DRIVE}s{$ASLICE}";
2200
	$ACOMPLETE_PATH="{$BOOT_DRIVE}s{$ASLICE}a";
2201
	$ABOOTFLASH="{$BOOT_DRIVE}s{$AOLDSLICE}";
2202
	conf_mount_rw();
2203
	set_single_sysctl("kern.geom.debugflags", "16");
2204
	exec("gpart set -a active -i {$ASLICE} {$BOOT_DRIVE}");
2205
	exec("/usr/sbin/boot0cfg -s {$ASLICE} -v /dev/{$BOOT_DRIVE}");
2206
	// We can't update these if they are mounted now.
2207
	if ($BOOTFLASH != $slice) {
2208
		exec("/sbin/tunefs -L ${AGLABEL_SLICE} /dev/$ACOMPLETE_PATH");
2209
		nanobsd_update_fstab($AGLABEL_SLICE, $ACOMPLETE_PATH, $AOLD_UFS_ID, $AUFS_ID);
2210
	}
2211
	set_single_sysctl("kern.geom.debugflags", "0");
2212
	conf_mount_ro();
2213
}
2214
function nanobsd_clone_slice() {
2215
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
2216
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
2217
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
2218
	nanobsd_detect_slice_info();
2219

    
2220
	for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
2221
	ob_implicit_flush(1);
2222
	set_single_sysctl("kern.geom.debugflags", "16");
2223
	exec("/bin/dd if=/dev/zero of=/dev/{$TOFLASH} bs=1m count=1");
2224
	exec("/bin/dd if=/dev/{$BOOTFLASH} of=/dev/{$TOFLASH} bs=64k");
2225
	exec("/sbin/tunefs -L {$GLABEL_SLICE} /dev/{$COMPLETE_PATH}");
2226
	$status = nanobsd_update_fstab($GLABEL_SLICE, $COMPLETE_PATH, $OLD_UFS_ID, $UFS_ID);
2227
	set_single_sysctl("kern.geom.debugflags", "0");
2228
	if($status) {
2229
		return false;
2230
	} else {
2231
		return true;
2232
	}
2233
}
2234
function nanobsd_update_fstab($gslice, $complete_path, $oldufs, $newufs) {
2235
	$tmppath = "/tmp/{$gslice}";
2236
	$fstabpath = "/tmp/{$gslice}/etc/fstab";
2237

    
2238
	mkdir($tmppath);
2239
	exec("/sbin/fsck_ufs -y /dev/{$complete_path}");
2240
	exec("/sbin/mount /dev/ufs/{$gslice} {$tmppath}");
2241
	copy("/etc/fstab", $fstabpath);
2242

    
2243
	if (!file_exists($fstabpath)) {
2244
		$fstab = <<<EOF
2245
/dev/ufs/{$gslice} / ufs ro,noatime 1 1
2246
/dev/ufs/cf /cf ufs ro,noatime 1 1
2247
EOF;
2248
		if (file_put_contents($fstabpath, $fstab))
2249
			$status = true;
2250
		else
2251
			$status = false;
2252
	} else {
2253
		$status = exec("sed -i \"\" \"s/pfsense{$oldufs}/pfsense{$newufs}/g\" {$fstabpath}");
2254
	}
2255
	exec("/sbin/umount {$tmppath}");
2256
	rmdir($tmppath);
2257

    
2258
	return $status;
2259
}
2260
function nanobsd_detect_slice_info() {
2261
	global $SLICE, $OLDSLICE, $TOFLASH, $COMPLETE_PATH, $COMPLETE_BOOT_PATH;
2262
	global $GLABEL_SLICE, $UFS_ID, $OLD_UFS_ID, $BOOTFLASH;
2263
	global $BOOT_DEVICE, $REAL_BOOT_DEVICE, $BOOT_DRIVE, $ACTIVE_SLICE;
2264

    
2265
	$BOOT_DEVICE=nanobsd_get_boot_slice();
2266
	$REAL_BOOT_DEVICE=get_real_slice_from_glabel($BOOT_DEVICE);
2267
	$BOOT_DRIVE=nanobsd_get_boot_drive();
2268
	$ACTIVE_SLICE=nanobsd_get_active_slice();
2269

    
2270
	// Detect which slice is active and set information.
2271
	if(strstr($REAL_BOOT_DEVICE, "s1")) {
2272
		$SLICE="2";
2273
		$OLDSLICE="1";
2274
		$GLABEL_SLICE="pfsense1";
2275
		$UFS_ID="1";
2276
		$OLD_UFS_ID="0";
2277

    
2278
	} else {
2279
		$SLICE="1";
2280
		$OLDSLICE="2";
2281
		$GLABEL_SLICE="pfsense0";
2282
		$UFS_ID="0";
2283
		$OLD_UFS_ID="1";
2284
	}
2285
	$TOFLASH="{$BOOT_DRIVE}s{$SLICE}";
2286
	$COMPLETE_PATH="{$BOOT_DRIVE}s{$SLICE}a";
2287
	$COMPLETE_BOOT_PATH="{$BOOT_DRIVE}s{$OLDSLICE}";
2288
	$BOOTFLASH="{$BOOT_DRIVE}s{$OLDSLICE}";
2289
}
2290

    
2291
function nanobsd_friendly_slice_name($slicename) {
2292
	global $g;
2293
	return strtolower(str_ireplace('pfsense', $g['product_name'], $slicename));
2294
}
2295

    
2296
function get_include_contents($filename) {
2297
	if (is_file($filename)) {
2298
		ob_start();
2299
		include $filename;
2300
		$contents = ob_get_contents();
2301
		ob_end_clean();
2302
		return $contents;
2303
	}
2304
	return false;
2305
}
2306

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

    
2442
function get_country_name($country_code) {
2443
	if ($country_code != "ALL" && strlen($country_code) != 2)
2444
		return "";
2445

    
2446
	$country_names_xml = "/usr/local/share/mobile-broadband-provider-info/iso_3166-1_list_en.xml";
2447
	$country_names_contents = file_get_contents($country_names_xml);
2448
	$country_names = xml2array($country_names_contents);
2449

    
2450
	if($country_code == "ALL") {
2451
		$country_list = array();
2452
		foreach($country_names['ISO_3166-1_List_en']['ISO_3166-1_Entry'] as $country) {
2453
			$country_list[] = array("code" => $country['ISO_3166-1_Alpha-2_Code_element'],
2454
						"name" => ucwords(strtolower($country['ISO_3166-1_Country_name'])) );
2455
		}
2456
		return $country_list;
2457
	}
2458

    
2459
	foreach ($country_names['ISO_3166-1_List_en']['ISO_3166-1_Entry'] as $country) {
2460
		if ($country['ISO_3166-1_Alpha-2_Code_element'] == strtoupper($country_code)) {
2461
			return ucwords(strtolower($country['ISO_3166-1_Country_name']));
2462
		}
2463
	}
2464
	return "";
2465
}
2466

    
2467
/* sort by interface only, retain the original order of rules that apply to
2468
   the same interface */
2469
function filter_rules_sort() {
2470
	global $config;
2471

    
2472
	/* mark each rule with the sequence number (to retain the order while sorting) */
2473
	for ($i = 0; isset($config['filter']['rule'][$i]); $i++)
2474
		$config['filter']['rule'][$i]['seq'] = $i;
2475

    
2476
	usort($config['filter']['rule'], "filter_rules_compare");
2477

    
2478
	/* strip the sequence numbers again */
2479
	for ($i = 0; isset($config['filter']['rule'][$i]); $i++)
2480
		unset($config['filter']['rule'][$i]['seq']);
2481
}
2482
function filter_rules_compare($a, $b) {
2483
	if (isset($a['floating']) && isset($b['floating']))
2484
		return $a['seq'] - $b['seq'];
2485
	else if (isset($a['floating']))
2486
		return -1;
2487
	else if (isset($b['floating']))
2488
		return 1;
2489
	else if ($a['interface'] == $b['interface'])
2490
		return $a['seq'] - $b['seq'];
2491
	else
2492
		return compare_interface_friendly_names($a['interface'], $b['interface']);
2493
}
2494

    
2495
function generate_ipv6_from_mac($mac) {
2496
	$elements = explode(":", $mac);
2497
	if(count($elements) <> 6)
2498
		return false;
2499

    
2500
	$i = 0;
2501
	$ipv6 = "fe80::";
2502
	foreach($elements as $byte) {
2503
		if($i == 0) {
2504
			$hexadecimal =  substr($byte, 1, 2);
2505
			$bitmap = base_convert($hexadecimal, 16, 2);
2506
			$bitmap = str_pad($bitmap, 4, "0", STR_PAD_LEFT);
2507
			$bitmap = substr($bitmap, 0, 2) ."1". substr($bitmap, 3,4);
2508
			$byte = substr($byte, 0, 1) . base_convert($bitmap, 2, 16);
2509
		}
2510
		$ipv6 .= $byte;
2511
		if($i == 1) {
2512
			$ipv6 .= ":";
2513
		}
2514
		if($i == 3) {
2515
			$ipv6 .= ":";
2516
		}
2517
		if($i == 2) {
2518
			$ipv6 .= "ff:fe";
2519
		}
2520

    
2521
		$i++;
2522
	}
2523
	return $ipv6;
2524
}
2525

    
2526
/****f* pfsense-utils/load_mac_manufacturer_table
2527
 * NAME
2528
 *   load_mac_manufacturer_table
2529
 * INPUTS
2530
 *   none
2531
 * RESULT
2532
 *   returns associative array with MAC-Manufacturer pairs
2533
 ******/
2534
function load_mac_manufacturer_table() {
2535
	/* load MAC-Manufacture data from the file */
2536
	$macs = false;
2537
	if (file_exists("/usr/local/share/nmap/nmap-mac-prefixes"))
2538
		$macs=file("/usr/local/share/nmap/nmap-mac-prefixes");
2539
	if ($macs){
2540
		foreach ($macs as $line){
2541
			if (preg_match('/([0-9A-Fa-f]{6}) (.*)$/', $line, $matches)){
2542
				/* store values like this $mac_man['000C29']='VMware' */
2543
				$mac_man["$matches[1]"]=$matches[2];
2544
			}
2545
		}
2546
		return $mac_man;
2547
	} else
2548
		return -1;
2549

    
2550
}
2551

    
2552
/****f* pfsense-utils/is_ipaddr_configured
2553
 * NAME
2554
 *   is_ipaddr_configured
2555
 * INPUTS
2556
 *   IP Address to check.
2557
 *   If ignore_if is a VIP (not carp), vip array index is passed after string _virtualip
2558
 * RESULT
2559
 *   returns true if the IP Address is
2560
 *   configured and present on this device.
2561
*/
2562
function is_ipaddr_configured($ipaddr, $ignore_if = "", $check_localip = false, $check_subnets = false) {
2563
	global $config;
2564

    
2565
	$pos = strpos($ignore_if, '_virtualip');
2566
	if ($pos !== false) {
2567
		$ignore_vip_id = substr($ignore_if, $pos+10);
2568
		$ignore_vip_if = substr($ignore_if, 0, $pos);
2569
	} else {
2570
		$ignore_vip_id = -1;
2571
		$ignore_vip_if = $ignore_if;
2572
	}
2573

    
2574
	$isipv6 = is_ipaddrv6($ipaddr);
2575

    
2576
	if ($check_subnets) {
2577
		$iflist = get_configured_interface_list();
2578
		foreach ($iflist as $if => $ifname) {
2579
			if ($ignore_if == $if)
2580
				continue;
2581

    
2582
			if ($isipv6 === true) {
2583
				$bitmask = get_interface_subnetv6($if);
2584
				$subnet = gen_subnetv6(get_interface_ipv6($if), $bitmask);
2585
			} else {
2586
				$bitmask = get_interface_subnet($if);
2587
				$subnet = gen_subnet(get_interface_ip($if), $bitmask);
2588
			}
2589

    
2590
			if (ip_in_subnet($ipaddr, $subnet . '/' . $bitmask))
2591
				return true;
2592
		}
2593
	} else {
2594
		if ($isipv6 === true)
2595
			$interface_list_ips = get_configured_ipv6_addresses();
2596
		else
2597
			$interface_list_ips = get_configured_ip_addresses();
2598

    
2599
		foreach($interface_list_ips as $if => $ilips) {
2600
			if ($ignore_if == $if)
2601
				continue;
2602
			if (strcasecmp($ipaddr, $ilips) == 0)
2603
				return true;
2604
		}
2605
	}
2606

    
2607
	$interface_list_vips = get_configured_vips_list(true);
2608
	foreach ($interface_list_vips as $id => $vip) {
2609
		/* Skip CARP interfaces here since they were already checked above */
2610
		if ($id == $ignore_vip_id || (strstr($ignore_if, '_vip') && $ignore_vip_if == $vip['if']))
2611
			continue;
2612
		if (strcasecmp($ipaddr, $vip['ipaddr']) == 0)
2613
			return true;
2614
	}
2615

    
2616
	if ($check_localip) {
2617
		if (is_array($config['pptpd']) && !empty($config['pptpd']['localip']) && (strcasecmp($ipaddr, $config['pptpd']['localip']) == 0))
2618
			return true;
2619

    
2620
		if (!is_array($config['l2tp']) && !empty($config['l2tp']['localip']) && (strcasecmp($ipaddr, $config['l2tp']['localip']) == 0))
2621
			return true;
2622
	}
2623

    
2624
	return false;
2625
}
2626

    
2627
/****f* pfsense-utils/pfSense_handle_custom_code
2628
 * NAME
2629
 *   pfSense_handle_custom_code
2630
 * INPUTS
2631
 *   directory name to process
2632
 * RESULT
2633
 *   globs the directory and includes the files
2634
 */
2635
function pfSense_handle_custom_code($src_dir) {
2636
	// Allow extending of the nat edit page and include custom input validation
2637
	if(is_dir("$src_dir")) {
2638
		$cf = glob($src_dir . "/*.inc");
2639
		foreach($cf as $nf) {
2640
			if($nf == "." || $nf == "..")
2641
				continue;
2642
			// Include the extra handler
2643
			include("$nf");
2644
		}
2645
	}
2646
}
2647

    
2648
function set_language($lang = 'en_US', $encoding = "UTF-8") {
2649
	putenv("LANG={$lang}.{$encoding}");
2650
	setlocale(LC_ALL, "{$lang}.{$encoding}");
2651
	textdomain("pfSense");
2652
	bindtextdomain("pfSense","/usr/local/share/locale");
2653
	bind_textdomain_codeset("pfSense","{$lang}.{$encoding}");
2654
}
2655

    
2656
function get_locale_list() {
2657
	$locales = array(
2658
		"en_US" => gettext("English"),
2659
		"pt_BR" => gettext("Portuguese (Brazil)"),
2660
		"tr" => gettext("Turkish"),
2661
	);
2662
	asort($locales);
2663
	return $locales;
2664
}
2665

    
2666
function system_get_language_code() {
2667
	global $config, $g_languages;
2668

    
2669
	// a language code, as per [RFC3066]
2670
	$language = $config['system']['language'];
2671
	//$code = $g_languages[$language]['code'];
2672
	$code = str_replace("_", "-", $language);
2673

    
2674
	if (empty($code))
2675
		$code = "en-US"; // Set default code.
2676

    
2677
	return $code;
2678
}
2679

    
2680
function system_get_language_codeset() {
2681
	global $config, $g_languages;
2682

    
2683
	$language = $config['system']['language'];
2684
	$codeset = $g_languages[$language]['codeset'];
2685

    
2686
	if (empty($codeset))
2687
		$codeset = "UTF-8"; // Set default codeset.
2688

    
2689
	return $codeset;
2690
}
2691

    
2692
/* Available languages/locales */
2693
$g_languages = array (
2694
	"sq"    => array("codeset" => "UTF-8", "desc" => gettext("Albanian")),
2695
	"bg"    => array("codeset" => "UTF-8", "desc" => gettext("Bulgarian")),
2696
	"zh_CN" => array("codeset" => "UTF-8", "desc" => gettext("Chinese (Simplified)")),
2697
	"zh_TW" => array("codeset" => "UTF-8", "desc" => gettext("Chinese (Traditional)")),
2698
	"nl"    => array("codeset" => "UTF-8", "desc" => gettext("Dutch")),
2699
	"da"    => array("codeset" => "UTF-8", "desc" => gettext("Danish")),
2700
	"en_US" => array("codeset" => "UTF-8", "desc" => gettext("English")),
2701
	"fi"    => array("codeset" => "UTF-8", "desc" => gettext("Finnish")),
2702
	"fr"    => array("codeset" => "UTF-8", "desc" => gettext("French")),
2703
	"de"    => array("codeset" => "UTF-8", "desc" => gettext("German")),
2704
	"el"    => array("codeset" => "UTF-8", "desc" => gettext("Greek")),
2705
	"hu"    => array("codeset" => "UTF-8", "desc" => gettext("Hungarian")),
2706
	"it"    => array("codeset" => "UTF-8", "desc" => gettext("Italian")),
2707
	"ja"    => array("codeset" => "UTF-8", "desc" => gettext("Japanese")),
2708
	"ko"    => array("codeset" => "UTF-8", "desc" => gettext("Korean")),
2709
	"lv"    => array("codeset" => "UTF-8", "desc" => gettext("Latvian")),
2710
	"nb"    => array("codeset" => "UTF-8", "desc" => gettext("Norwegian (Bokmal)")),
2711
	"pl"    => array("codeset" => "UTF-8", "desc" => gettext("Polish")),
2712
	"pt_BR" => array("codeset" => "ISO-8859-1", "desc" => gettext("Portuguese (Brazil)")),
2713
	"pt"    => array("codeset" => "UTF-8", "desc" => gettext("Portuguese (Portugal)")),
2714
	"ro"    => array("codeset" => "UTF-8", "desc" => gettext("Romanian")),
2715
	"ru"    => array("codeset" => "UTF-8", "desc" => gettext("Russian")),
2716
	"sl"    => array("codeset" => "UTF-8", "desc" => gettext("Slovenian")),
2717
	"tr"    => array("codeset" => "UTF-8", "desc" => gettext("Turkish")),
2718
	"es"    => array("codeset" => "UTF-8", "desc" => gettext("Spanish")),
2719
	"sv"    => array("codeset" => "UTF-8", "desc" => gettext("Swedish")),
2720
	"sk"    => array("codeset" => "UTF-8", "desc" => gettext("Slovak")),
2721
	"cs"    => array("codeset" => "UTF-8", "desc" => gettext("Czech"))
2722
);
2723

    
2724
function return_hex_ipv4($ipv4) {
2725
	if(!is_ipaddrv4($ipv4))
2726
		return(false);
2727

    
2728
	/* we need the hex form of the interface IPv4 address */
2729
	$ip4arr = explode(".", $ipv4);
2730
	return (sprintf("%02x%02x%02x%02x", $ip4arr[0], $ip4arr[1], $ip4arr[2], $ip4arr[3]));
2731
}
2732

    
2733
function convert_ipv6_to_128bit($ipv6) {
2734
	if(!is_ipaddrv6($ipv6))
2735
		return(false);
2736

    
2737
	$ip6arr = array();
2738
	$ip6prefix = Net_IPv6::uncompress($ipv6);
2739
	$ip6arr = explode(":", $ip6prefix);
2740
	/* binary presentation of the prefix for all 128 bits. */
2741
	$ip6prefixbin = "";
2742
	foreach($ip6arr as $element) {
2743
		$ip6prefixbin .= sprintf("%016b", hexdec($element));
2744
	}
2745
	return($ip6prefixbin);
2746
}
2747

    
2748
function convert_128bit_to_ipv6($ip6bin) {
2749
	if(strlen($ip6bin) <> 128)
2750
		return(false);
2751

    
2752
	$ip6arr = array();
2753
	$ip6binarr = array();
2754
	$ip6binarr = str_split($ip6bin, 16);
2755
	foreach($ip6binarr as $binpart)
2756
		$ip6arr[] = dechex(bindec($binpart));
2757
	$ip6addr = Net_IPv6::compress(implode(":", $ip6arr));
2758

    
2759
	return($ip6addr);
2760
}
2761

    
2762

    
2763
/* Returns the calculated bit length of the prefix delegation from the WAN interface */
2764
/* DHCP-PD is variable, calculate from the prefix-len on the WAN interface */
2765
/* 6rd is variable, calculate from 64 - (v6 prefixlen - (32 - v4 prefixlen)) */
2766
/* 6to4 is 16 bits, e.g. 65535 */
2767
function calculate_ipv6_delegation_length($if) {
2768
	global $config;
2769

    
2770
	if(!is_array($config['interfaces'][$if]))
2771
		return false;
2772

    
2773
	switch($config['interfaces'][$if]['ipaddrv6']) {
2774
		case "6to4":
2775
			$pdlen = 16;
2776
			break;
2777
		case "6rd":
2778
			$rd6cfg = $config['interfaces'][$if];
2779
			$rd6plen = explode("/", $rd6cfg['prefix-6rd']);
2780
			$pdlen = (64 - ($rd6plen[1] + (32 - $rd6cfg['prefix-6rd-v4plen'])));
2781
			break;
2782
		case "dhcp6":
2783
			$dhcp6cfg = $config['interfaces'][$if];
2784
			$pdlen = $dhcp6cfg['dhcp6-ia-pd-len'];
2785
			break;
2786
		default:
2787
			$pdlen = 0;
2788
			break;
2789
	}
2790
	return($pdlen);
2791
}
2792

    
2793
function huawei_rssi_to_string($rssi) {
2794
	$dbm = array();
2795
	$i = 0;
2796
	$dbstart = -113;
2797
	while($i < 32) {
2798
		$dbm[$i] = $dbstart + ($i * 2);
2799
		$i++;
2800
	}
2801
	$percent = round(($rssi / 31) * 100);
2802
	$string = "rssi:{$rssi} level:{$dbm[$rssi]}dBm percent:{$percent}%";
2803
	return $string;
2804
}
2805

    
2806
function huawei_mode_to_string($mode, $submode) {
2807
	$modes[0] = "None";
2808
	$modes[1] = "AMPS";
2809
	$modes[2] = "CDMA";
2810
	$modes[3] = "GSM/GPRS";
2811
	$modes[4] = "HDR";
2812
	$modes[5] = "WCDMA";
2813
	$modes[6] = "GPS";
2814

    
2815
	$submodes[0] = "No Service";
2816
	$submodes[1] = "GSM";
2817
	$submodes[2] = "GPRS";
2818
	$submodes[3] = "EDGE";
2819
	$submodes[4] = "WCDMA";
2820
	$submodes[5] = "HSDPA";
2821
	$submodes[6] = "HSUPA";
2822
	$submodes[7] = "HSDPA+HSUPA";
2823
	$submodes[8] = "TD-SCDMA";
2824
	$submodes[9] = "HSPA+";
2825
	$string = "{$modes[$mode]}, {$submodes[$submode]} Mode";
2826
	return $string;
2827
}
2828

    
2829
function huawei_service_to_string($state) {
2830
	$modes[0] = "No";
2831
	$modes[1] = "Restricted";
2832
	$modes[2] = "Valid";
2833
	$modes[3] = "Restricted Regional";
2834
	$modes[4] = "Powersaving";
2835
	$string = "{$modes[$state]} Service";
2836
	return $string;
2837
}
2838

    
2839
function huawei_simstate_to_string($state) {
2840
	$modes[0] = "Invalid SIM/locked";
2841
	$modes[1] = "Valid SIM";
2842
	$modes[2] = "Invalid SIM CS";
2843
	$modes[3] = "Invalid SIM PS";
2844
	$modes[4] = "Invalid SIM CS/PS";
2845
	$modes[255] = "Missing SIM";
2846
	$string = "{$modes[$state]} State";
2847
	return $string;
2848
}
2849

    
2850
function zte_rssi_to_string($rssi) {
2851
	return huawei_rssi_to_string($rssi);
2852
}
2853

    
2854
function zte_mode_to_string($mode, $submode) {
2855
	$modes[0] = "No Service";
2856
	$modes[1] = "Limited Service";
2857
	$modes[2] = "GPRS";
2858
	$modes[3] = "GSM";
2859
	$modes[4] = "UMTS";
2860
	$modes[5] = "EDGE";
2861
	$modes[6] = "HSDPA";
2862

    
2863
	$submodes[0] = "CS_ONLY";
2864
	$submodes[1] = "PS_ONLY";
2865
	$submodes[2] = "CS_PS";
2866
	$submodes[3] = "CAMPED";
2867
	$string = "{$modes[$mode]}, {$submodes[$submode]} Mode";
2868
	return $string;
2869
}
2870

    
2871
function zte_service_to_string($state) {
2872
	$modes[0] = "Initializing";
2873
	$modes[1] = "Network Lock error";
2874
	$modes[2] = "Network Locked";
2875
	$modes[3] = "Unlocked or correct MCC/MNC";
2876
	$string = "{$modes[$state]} Service";
2877
	return $string;
2878
}
2879

    
2880
function zte_simstate_to_string($state) {
2881
	$modes[0] = "No action";
2882
	$modes[1] = "Network lock";
2883
	$modes[2] = "(U)SIM card lock";
2884
	$modes[3] = "Network Lock and (U)SIM card Lock";
2885
	$string = "{$modes[$state]} State";
2886
	return $string;
2887
}
2888

    
2889
function get_configured_pppoe_server_interfaces() {
2890
	global $config;
2891
	$iflist = array();
2892
	if (is_array($config['pppoes']['pppoe'])) {
2893
		foreach($config['pppoes']['pppoe'] as $pppoe) {
2894
			if ($pppoe['mode'] == "server") {
2895
				$int = "poes". $pppoe['pppoeid'];
2896
				$iflist[$int] = strtoupper($int);
2897
			}
2898
		}
2899
	}
2900
	return $iflist;
2901
}
2902

    
2903
function get_pppoes_child_interfaces($ifpattern) {
2904
	$if_arr = array();
2905
	if($ifpattern == "")
2906
		return;
2907

    
2908
	exec("ifconfig", $out, $ret);
2909
	foreach($out as $line) {
2910
		if(preg_match("/^({$ifpattern}[0-9]+):/i", $line, $match)) {
2911
			$if_arr[] = $match[1];
2912
		}
2913
	}
2914
	return $if_arr;
2915

    
2916
}
2917

    
2918
/****f* pfsense-utils/pkg_call_plugins
2919
 * NAME
2920
 *   pkg_call_plugins
2921
 * INPUTS
2922
 *   $plugin_type value used to search in package configuration if the plugin is used, also used to create the function name
2923
 *   $plugin_params parameters to pass to the plugin function for passing multiple parameters a array can be used.
2924
 * RESULT
2925
 *   returns associative array results from the plugin calls for each package
2926
 * NOTES
2927
 *   This generic function can be used to notify or retrieve results from functions that are defined in packages.
2928
 ******/
2929
function pkg_call_plugins($plugin_type, $plugin_params) {
2930
	global $g, $config;
2931
	$results = array();
2932
	if (!is_array($config['installedpackages']['package']))
2933
		return $results;
2934
	foreach ($config['installedpackages']['package'] as $package) {
2935
		if(!file_exists("/usr/local/pkg/" . $package['configurationfile']))
2936
			continue;
2937
		$pkg_config = parse_xml_config_pkg("/usr/local/pkg/" . $package['configurationfile'], 'packagegui');
2938
		$pkgname = substr(reverse_strrchr($package['configurationfile'], "."),0,-1);
2939
		if (is_array($pkg_config['plugins']['item']))
2940
			foreach ($pkg_config['plugins']['item'] as $plugin) {
2941
				if ($plugin['type'] == $plugin_type) {
2942
					if (file_exists($pkg_config['include_file']))
2943
						require_once($pkg_config['include_file']);
2944
					else
2945
						continue;
2946
					$plugin_function = $pkgname . '_'. $plugin_type;
2947
					$results[$pkgname] = @eval($plugin_function($plugin_params));
2948
				}
2949
			}
2950
	}
2951
	return $results;
2952
}
2953

    
2954
/* Function to find and return the active XML RPC base URL to avoid code duplication */
2955
function get_active_xml_rpc_base_url() {
2956
	global $config, $g;
2957
	/* If the user has activated the option to enable an alternate xmlrpcbaseurl, and it's not empty, then use it */
2958
	if (isset($config['system']['altpkgrepo']['enable']) && !empty($config['system']['altpkgrepo']['xmlrpcbaseurl'])) {
2959
		return $config['system']['altpkgrepo']['xmlrpcbaseurl'];
2960
	} else {
2961
		return $g['xmlrpcbaseurl'];
2962
	}
2963
}
2964

    
2965
?>
(40-40/68)