Project

General

Profile

Download (37.7 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php 
2
/*
3
	util.inc
4
	part of the pfSense project (http://www.pfsense.com)
5

    
6
	originally part of m0n0wall (http://m0n0.ch/wall)
7
	Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>.
8
	All rights reserved.
9

    
10
	Redistribution and use in source and binary forms, with or without
11
	modification, are permitted provided that the following conditions are met:
12

    
13
	1. Redistributions of source code must retain the above copyright notice,
14
	   this list of conditions and the following disclaimer.
15

    
16
	2. Redistributions in binary form must reproduce the above copyright
17
	   notice, this list of conditions and the following disclaimer in the
18
	   documentation and/or other materials provided with the distribution.
19

    
20
	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
21
	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
22
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23
	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
24
	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25
	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26
	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27
	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28
	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29
	POSSIBILITY OF SUCH DAMAGE.
30
*/
31

    
32
/*
33
	pfSense_BUILDER_BINARIES:	/bin/ps	/bin/kill	/usr/bin/killall	/sbin/ifconfig	/usr/bin/netstat
34
	pfSense_BUILDER_BINARIES:	/usr/bin/awk	/sbin/dmesg		/sbin/ping /usr/local/sbin/gzsig	/usr/sbin/arp
35
	pfSense_BUILDER_BINARIES:	/sbin/conscontrol	/sbin/devd	/bin/ps
36
	pfSense_MODULE:	utils
37
*/
38

    
39
/* kill a process by pid file */
40
function killbypid($pidfile) {
41
	return sigkillbypid($pidfile, "TERM");
42
}
43

    
44
function isvalidpid($pid) {
45
	$output = "";
46
	exec("/bin/pgrep -F {$pid}", $output, $retval);
47

    
48
	return (intval($retval) == 0);
49
}
50

    
51
function is_process_running($process) {
52
	$output = "";
53
	exec("/bin/pgrep -ax {$process}", $output, $retval);
54

    
55
	return (intval($retval) == 0);
56
}
57

    
58
function isvalidproc($proc) {
59
	return is_process_running($proc);
60
}
61

    
62
/* sigkill a process by pid file */
63
/* return 1 for success and 0 for a failure */
64
function sigkillbypid($pidfile, $sig) {
65
	if (is_file($pidfile))
66
		return mwexec("/bin/pkill -{$sig} -F {$pidfile}", true);
67

    
68
	return 0;
69
}
70

    
71
/* kill a process by name */
72
function sigkillbyname($procname, $sig) {
73
	if(isvalidproc($procname))
74
		return mwexec("/usr/bin/killall -{$sig} " . escapeshellarg($procname), true);
75
}
76

    
77
/* kill a process by name */
78
function killbyname($procname) {
79
	if(isvalidproc($procname)) 
80
		mwexec("/usr/bin/killall " . escapeshellarg($procname));
81
}
82

    
83
function is_subsystem_dirty($subsystem = "") {
84
	global $g;
85

    
86
	if ($subsystem == "")
87
		return false;
88

    
89
	if (file_exists("{$g['varrun_path']}/{$subsystem}.dirty"))
90
		return true;
91

    
92
	return false;
93
}
94

    
95
function mark_subsystem_dirty($subsystem = "") {
96
	global $g;
97

    
98
	if (!file_put_contents("{$g['varrun_path']}/{$subsystem}.dirty", "DIRTY"))
99
		log_error("WARNING: Could not mark subsystem: {$subsytem} dirty");
100
}
101

    
102
function clear_subsystem_dirty($subsystem = "") {
103
	global $g;
104

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

    
108
function config_lock() {
109
	return;
110
}
111
function config_unlock() {
112
	return;
113
}
114

    
115
/* lock configuration file */
116
function lock($lock, $op = LOCK_SH) {
117
	global $g, $cfglckkeyconsumers;
118
	if (!$lock)
119
		die("WARNING: You must give a name as parameter to lock() function.");
120
	if (!file_exists("{$g['tmp_path']}/{$lock}.lock"))
121
		@touch("{$g['tmp_path']}/{$lock}.lock");
122
	$cfglckkeyconsumers++;
123
	if ($fp = fopen("{$g['tmp_path']}/{$lock}.lock", "w")) {
124
		if (flock($fp, $op))
125
			return $fp;
126
		else
127
			fclose($fp);
128
	}
129
}
130

    
131
/* unlock configuration file */
132
function unlock($cfglckkey = 0) {
133
	global $g, $cfglckkeyconsumers;
134
	flock($cfglckkey, LOCK_UN);
135
	fclose($cfglckkey);
136
	return;
137
}
138

    
139
function send_event($cmd) {
140
	global $g;
141

    
142
	if(!isset($g['event_address']))
143
		$g['event_address'] = "unix:///var/run/check_reload_status";
144
		
145
	$try = 0;
146
	while ($try < 3) {
147
		$fd = @fsockopen($g['event_address']);
148
		if ($fd) {
149
			fwrite($fd, $cmd);
150
			$resp = fread($fd, 4096);
151
			if ($resp != "OK\n")
152
				log_error("send_event: sent {$cmd} got {$resp}");
153
			fclose($fd);
154
			$try = 3;
155
		} else
156
			mwexec_bg("/usr/bin/nice -n20 /usr/local/sbin/check_reload_status");
157
		$try++;
158
	}
159
}
160

    
161
function send_multiple_events($cmds) {
162
	global $g;
163

    
164
	if(!isset($g['event_address']))
165
		$g['event_address'] = "unix:///var/run/check_reload_status";
166
			
167
	if (!is_array($cmds))
168
		return;
169
	$fd = fsockopen($g['event_address']);
170
	if ($fd) {
171
		foreach ($cmds as $cmd) {
172
			fwrite($fd, $cmd);
173
			$resp = fread($fd, 4096);
174
			if ($resp != "OK\n")
175
				log_error("send_event: sent {$cmd} got {$resp}");
176
		}
177
		fclose($fd);
178
	}
179
}
180

    
181
function refcount_init($reference) {
182
	$shmid = shmop_open($reference, "c", 0644, 10);
183
	shmop_write($shmid, 0, 0);
184
	shmop_close($shmid);
185
}
186

    
187
function refcount_reference($reference) {
188
	$shmid = @shmop_open($reference, "w", 0644, 10);
189
	if (!$shmid) {
190
		refcount_init($reference);
191
		$shmid = shmop_open($reference, "w", 0644, 10);
192
	}
193
	$shm_data = shmop_read($shmid, 0, 10);
194
	$shm_data = intval($shm_data) + 1;
195
	shmop_write($shmid, $shm_data, 0);
196
	shmop_close($shmid);
197
	
198
	return $shm_data;
199
}
200

    
201
function refcount_unreference($reference) {
202
	/* We assume that the shared memory exists. */
203
	$shmid = shmop_open($reference, "w", 0644, 10);
204
	$shm_data = shmop_read($shmid, 0, 10);
205
	$shm_data = intval($shm_data) - 1;
206
	if ($shm_data < 0) {
207
		//debug_backtrace();
208
		log_error("Reference {$reference} is going negative, not doing unreference.");
209
	} else
210
		shmop_write($shmid, $shm_data, 0);
211
	shmop_close($shmid);
212
	
213
	return $shm_data;
214
}
215

    
216
function is_module_loaded($module_name) {
217
	$running = `/sbin/kldstat | grep {$module_name} | /usr/bin/grep -v grep | /usr/bin/wc -l`;
218
	if (intval($running) >= 1)
219
		return true;
220
	else
221
		return false;
222
}
223

    
224
/* return the subnet address given a host address and a subnet bit count */
225
function gen_subnet($ipaddr, $bits) {
226
	if (!is_ipaddr($ipaddr) || !is_numeric($bits))
227
		return "";
228

    
229
	return long2ip(ip2long($ipaddr) & gen_subnet_mask_long($bits));
230
}
231

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

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

    
240
/* returns a subnet mask (long given a bit count) */
241
function gen_subnet_mask_long($bits) {
242
	$sm = 0;
243
	for ($i = 0; $i < $bits; $i++) {
244
		$sm >>= 1;
245
		$sm |= 0x80000000;
246
	}
247
	return $sm;
248
}
249

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
356
		// Check if the subnet is between $startip and $endip
357
		if (ip_greater_than($targetsub_min, $startip) && ip_less_than($targetsub_max, $endip)) {
358
			break;
359
		}
360
	}
361

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

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

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

    
378
function is_iprange($range) {
379
	if (substr_count($range, '-') != 1) {
380
		return false;
381
	}
382
	list($ip1, $ip2) = explode ('-', $range);
383
	return (is_ipaddr($ip1) && is_ipaddr($ip2));
384
}
385

    
386
function is_numericint($arg) {
387
	return (preg_match("/[^0-9]/", $arg) ? false : true);
388
}
389

    
390
/* returns true if $ipaddr is a valid dotted IPv4 address */
391
function is_ipaddr($ipaddr) {
392
	if (!is_string($ipaddr))
393
		return false;
394

    
395
	$ip_long = ip2long($ipaddr);
396
	$ip_reverse = long2ip32($ip_long);
397

    
398
	if ($ipaddr == $ip_reverse)
399
		return true;
400
	else
401
		return false;
402
}
403

    
404
/* returns true if $ipaddr is a valid dotted IPv4 address or an alias thereof */
405
function is_ipaddroralias($ipaddr) {
406
	global $config;
407

    
408
	if (is_alias($ipaddr)) {
409
		if (is_array($config['aliases']['alias'])) {
410
			foreach ($config['aliases']['alias'] as $alias) {
411
				if ($alias['name'] == $ipaddr && $alias['type'] != "port")
412
					return true;
413
			}
414
		}
415
		return false;
416
	} else
417
		return is_ipaddr($ipaddr);
418

    
419
}
420

    
421
/* returns true if $subnet is a valid subnet in CIDR format */
422
function is_subnet($subnet) {
423
	if (!is_string($subnet))
424
		return false;
425

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

    
428
	if (!is_ipaddr($hp))
429
		return false;
430

    
431
	if (!is_numeric($np) || ($np < 1) || ($np > 32))
432
		return false;
433

    
434
	return true;
435
}
436

    
437
/* returns true if $subnet is a valid subnet in CIDR format or an alias thereof */
438
function is_subnetoralias($subnet) {
439
	global $aliastable;
440

    
441
	if (isset($aliastable[$subnet]) && is_subnet($aliastable[$subnet]))
442
		return true;
443
	else
444
		return is_subnet($subnet);
445
}
446

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

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

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

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

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

    
474
/* returns true if $name is a valid name for an alias */
475
/* returns NULL if a reserved word is used */
476
function is_validaliasname($name) {
477
	/* Array of reserved words */
478
	$reserved = array("port", "pass");
479
	if (in_array($name, $reserved, true))
480
		return; /* return NULL */
481
	if (!preg_match("/[^a-zA-Z0-9_]/", $name) && (strlen($name) < 32))
482
		return true;
483
	else
484
		return false;
485
}
486

    
487
/* returns true if $port is a valid TCP/UDP port */
488
function is_port($port) {
489
	$tmpports = explode(":", $port);
490
	foreach($tmpports as $tmpport) {
491
		if (getservbyname($tmpport, "tcp") || getservbyname($tmpport, "udp"))
492
			continue;
493
		if (!ctype_digit($tmpport))
494
			return false;
495
		else if ((intval($tmpport) < 1) || (intval($tmpport) > 65535))
496
			return false;
497
	}
498
	return true;
499
}
500

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

    
505
	if(count($ports) == 2 && is_port($ports[0]) && is_port($ports[1]))
506
		return true;
507
	else
508
		return false;
509
}
510

    
511
/* returns true if $port is a valid port number or an alias thereof */
512
function is_portoralias($port) {
513
	global $config;
514

    
515
	if (is_alias($port)) {
516
		if (is_array($config['aliases']['alias'])) {
517
			foreach ($config['aliases']['alias'] as $alias) {
518
				if ($alias['name'] == $port && $alias['type'] == "port")
519
					return true;
520
				}
521
			}
522
			return false;
523
	} else
524
		return is_port($port);
525
}
526

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

    
532
/* return the configured carp interface list */
533
function get_configured_carp_interface_list() {
534
	global $config;
535

    
536
	$iflist = array();
537

    
538
	if(is_array($config['virtualip']['vip'])) {
539
		$viparr = &$config['virtualip']['vip'];
540
		foreach ($viparr as $vip) {
541
			switch ($vip['mode']) {
542
				case "carp":
543
				case "carpdev-dhcp":
544
					$vipif = "vip" . $vip['vhid'];
545
					$iflist[$vipif] = $vip['subnet'];
546
					break;
547
			}
548
		}
549
	}
550

    
551
	return $iflist;
552
}
553

    
554
/* return the configured IP aliases list */
555
function get_configured_ip_aliases_list() {
556
	global $config;
557

    
558
	$alias_list=array();
559

    
560
	if(is_array($config['virtualip']['vip'])) {
561
		$viparr = &$config['virtualip']['vip'];
562
		foreach ($viparr as $vip) {
563
			if ($vip['mode']=="ipalias") {
564
				$alias_list[$vip['subnet']] = $vip['interface'];
565
			}
566
		}
567
	}
568

    
569
	return $alias_list;
570
}
571

    
572

    
573
/* comparison function for sorting by the order in which interfaces are normally created */
574
function compare_interface_friendly_names($a, $b) {
575
	if ($a == $b)
576
		return 0;
577
	else if ($a == 'wan')
578
		return -1;
579
	else if ($b == 'wan')
580
		return 1;
581
	else if ($a == 'lan')
582
		return -1;
583
	else if ($b == 'lan')
584
		return 1;
585

    
586
	return strnatcmp($a, $b);
587
}
588

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

    
593
	$iflist = array();
594

    
595
	if(!is_array($config['interfaces']))
596
		$config = parse_config(true);
597

    
598
	/* if list */
599
	foreach($config['interfaces'] as $if => $ifdetail) {
600
		if ($only_opt && ($if == "wan" || $if == "lan"))
601
			continue;
602
		if (isset($ifdetail['enable']) || $withdisabled == true)
603
			$iflist[$if] = $if;
604
	}
605

    
606
	return $iflist;
607
}
608

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

    
613
	$iflist = array();
614

    
615
	/* if list */
616
	foreach($config['interfaces'] as $if => $ifdetail) {
617
		if ($only_opt && ($if == "wan" || $if == "lan"))
618
			continue;
619
		if (isset($ifdetail['enable']) || $withdisabled == true) {
620
			$tmpif = get_real_interface($if);
621
			if (!empty($tmpif))
622
				$iflist[$tmpif] = $if;
623
		}
624
	}
625

    
626
	return $iflist;
627
}
628

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

    
633
	$iflist = array();
634

    
635
	/* if list */
636
	foreach($config['interfaces'] as $if => $ifdetail) {
637
		if ($only_opt && ($if == "wan" || $if == "lan"))
638
			continue;
639
		if (isset($ifdetail['enable']) || $withdisabled == true) {
640
			if(empty($ifdetail['descr']))
641
				$iflist[$if] = strtoupper($if);
642
			else
643
				$iflist[$if] = strtoupper($ifdetail['descr']);
644
		}
645
	}
646

    
647
	return $iflist;
648
}
649

    
650
/*
651
 *   get_configured_ip_addresses() - Return a list of all configured
652
 *   interfaces IP Addresses
653
 *
654
 */
655
function get_configured_ip_addresses() {
656
	require_once("interfaces.inc");
657
	$ip_array = array();
658
	$interfaces = get_configured_interface_list();
659
	if(is_array($interfaces)) {
660
		foreach($interfaces as $int) {
661
			$ipaddr = get_interface_ip($int);
662
			$ip_array[$int] = $ipaddr;
663
		}
664
	}
665
	$interfaces = get_configured_carp_interface_list();
666
	if(is_array($interfaces)) 
667
		foreach($interfaces as $int => $ipaddr) 
668
			$ip_array[$int] = $ipaddr;
669
	return $ip_array;
670
}
671

    
672
/*
673
 *   get_interface_list() - Return a list of all physical interfaces
674
 *   along with MAC and status.
675
 *
676
 *   $mode = "active" - use ifconfig -lu
677
 *           "media"  - use ifconfig to check physical connection
678
 *			status (much slower)
679
 */
680
function get_interface_list($mode = "active", $keyby = "physical", $vfaces = "") {
681
        global $config;
682
	$upints = array();
683
        /* get a list of virtual interface types */
684
        if(!$vfaces) {
685
		$vfaces = array (
686
				'bridge',
687
				'ppp',
688
				'pppoe',
689
				'pptp',
690
				'l2tp',
691
				'sl',
692
				'gif',
693
				'gre',
694
				'faith',
695
				'lo',
696
				'ng',
697
				'_vlan',
698
				'_wlan',
699
				'pflog',
700
				'plip',
701
				'pfsync',
702
				'enc',
703
				'tun',
704
				'carp',
705
				'lagg',
706
				'vip',
707
				'ipfw'
708
		);
709
	}
710
	switch($mode) {
711
	case "active":
712
                $upints = explode(" ", trim(shell_exec("/sbin/ifconfig -lu")));
713
        	break;
714
	case "media":
715
                $intlist = explode(" ", trim(shell_exec("/sbin/ifconfig -l")));
716
                $ifconfig = "";
717
                exec("/sbin/ifconfig -a", $ifconfig);
718
                $regexp = '/(' . implode('|', $intlist) . '):\s/';
719
                $ifstatus = preg_grep('/status:/', $ifconfig);
720
		foreach($ifstatus as $status) {
721
			$int = array_shift($intlist);
722
			if(stristr($status, "active")) $upints[] = $int;
723
		}
724
		break;
725
	default:
726
		$upints = explode(" ", trim(shell_exec("/sbin/ifconfig -l")));
727
		break;
728
	}
729
        /* build interface list with netstat */
730
        $linkinfo = "";
731
        exec("/usr/bin/netstat -inW -f link | awk '{ print $1, $4 }'", $linkinfo);
732
        array_shift($linkinfo);
733
	/* build ip address list with netstat */
734
	$ipinfo = "";
735
	exec("/usr/bin/netstat -inW -f inet | awk '{ print $1, $4 }'", $ipinfo);
736
	array_shift($ipinfo);
737
	foreach($linkinfo as $link) {
738
		$friendly = "";
739
		$alink = explode(" ", $link);
740
		$ifname = rtrim(trim($alink[0]), '*');
741
		/* trim out all numbers before checking for vfaces */
742
		if (!in_array(array_shift(preg_split('/\d/', $ifname)), $vfaces) &&
743
			!stristr($ifname, "_vlan") && !stristr($ifname, "_wlan")) {
744
			$toput = array(
745
					"mac" => trim($alink[1]),
746
					"up" => in_array($ifname, $upints)
747
				);
748
			foreach($ipinfo as $ip) {
749
				$aip = explode(" ", $ip);
750
				if($aip[0] == $ifname) {
751
					$toput['ipaddr'] = $aip[1];
752
				}
753
			}
754
			if (is_array($config['interfaces'])) {
755
				foreach($config['interfaces'] as $name => $int)
756
					if($int['if'] == $ifname) $friendly = $name;
757
			}
758
			switch($keyby) {
759
			case "physical":
760
				if($friendly != "") {
761
					$toput['friendly'] = $friendly;
762
				}
763
				$dmesg_arr = array();
764
				exec("/sbin/dmesg |grep $ifname | head -n1", $dmesg_arr);
765
				preg_match_all("/<(.*?)>/i", $dmesg_arr[0], $dmesg);
766
				$toput['dmesg'] = $dmesg[1][0];
767
				$iflist[$ifname] = $toput;
768
				break;
769
			case "ppp":
770
				
771
			case "friendly":
772
				if($friendly != "") {
773
					$toput['if'] = $ifname;
774
					$iflist[$friendly] = $toput;
775
				}
776
				break;
777
			}
778
		}
779
	}
780
	return $iflist;
781
}
782

    
783
/****f* util/log_error
784
* NAME
785
*   log_error  - Sends a string to syslog.
786
* INPUTS
787
*   $error     - string containing the syslog message.
788
* RESULT
789
*   null
790
******/
791
function log_error($error) {
792
	global $g;
793
	$page = $_SERVER['SCRIPT_NAME'];
794
	syslog(LOG_WARNING, "$page: $error");
795
	if ($g['debug'])
796
		syslog(LOG_WARNING, var_dump(debug_backtrace()));
797
	return;
798
}
799

    
800
/****f* util/log_auth
801
* NAME
802
*   log_error  - Sends a string to syslog as LOG_AUTH facility
803
* INPUTS
804
*   $error     - string containing the syslog message.
805
* RESULT
806
*   null
807
******/
808
function log_auth($error) {
809
	global $g;
810
	$page = $_SERVER['SCRIPT_NAME'];
811
	syslog(LOG_AUTH, "$page: $error");
812
	if ($g['debug'])
813
		syslog(LOG_WARNING, var_dump(debug_backtrace()));
814
	return;
815
}
816

    
817
/****f* util/exec_command
818
 * NAME
819
 *   exec_command - Execute a command and return a string of the result.
820
 * INPUTS
821
 *   $command   - String of the command to be executed.
822
 * RESULT
823
 *   String containing the command's result.
824
 * NOTES
825
 *   This function returns the command's stdout and stderr.
826
 ******/
827
function exec_command($command) {
828
	$output = array();
829
	exec($command . ' 2>&1 ', $output);
830
	return(implode("\n", $output));
831
}
832

    
833
/* wrapper for exec() */
834
function mwexec($command, $mute = false) {
835
	global $g;
836

    
837
	if ($g['debug']) {
838
		if (!$_SERVER['REMOTE_ADDR'])
839
			echo "mwexec(): $command\n";
840
	}
841
	$oarr = array();
842
	$retval = 0;
843
	$garbage = exec("$command 2>&1", $oarr, $retval);
844

    
845
	if(isset($config['system']['developerspew']))
846
		$mute = false;
847
	if(($retval <> 0) && ($mute === false)) {
848
		$output = implode(" ", $oarr);
849
		log_error("The command '$command' returned exit code '$retval', the output was '$output' ");
850
	}
851
	return $retval;
852
}
853

    
854
/* wrapper for exec() in background */
855
function mwexec_bg($command) {
856
	global $g;
857

    
858
	if ($g['debug']) {
859
		if (!$_SERVER['REMOTE_ADDR'])
860
			echo "mwexec(): $command\n";
861
	}
862

    
863
	exec("nohup $command > /dev/null 2>&1 &");
864
}
865

    
866
/* unlink a file, if it exists */
867
function unlink_if_exists($fn) {
868
	$to_do = glob($fn);
869
	if(is_array($to_do)) {
870
		foreach($to_do as $filename)
871
			@unlink($filename);
872
	} else {
873
		@unlink($fn);
874
	}
875
}
876
/* make a global alias table (for faster lookups) */
877
function alias_make_table($config) {
878
	global $aliastable;
879

    
880
	$aliastable = array();
881

    
882
	if (is_array($config['aliases']['alias'])) {
883
		foreach ($config['aliases']['alias'] as $alias) {
884
			if ($alias['name'])
885
				$aliastable[$alias['name']] = $alias['address'];
886
		}
887
	}
888
}
889
/* check if an alias exists */
890
function is_alias($name) {
891
	global $aliastable;
892

    
893
	return isset($aliastable[$name]);
894
}
895

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

    
900
	if (isset($aliastable[$name]))
901
		return "\${$name}";
902
	else if (is_ipaddr($name) || is_subnet($name) || is_port($name))
903
		return "{$name}";
904
	else
905
		return null;
906
}
907

    
908
function alias_expand_urltable($name) {
909
	global $config;
910
	$urltable_prefix = "/var/db/aliastables/";
911
	$urltable_filename = $urltable_prefix . $name . ".txt";
912

    
913
	foreach ($config['aliases']['alias'] as $alias) {
914
		if (($alias['type'] == 'urltable') && ($alias['name'] == $name)) {
915
			if (is_URL($alias["url"]) && file_exists($urltable_filename) && filesize($urltable_filename))
916
				return $urltable_filename;
917
			else if (process_alias_urltable($name, $alias["url"], 0, true))
918
				return $urltable_filename;
919
		}
920
	}
921
	return null;
922
}
923

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

    
927
	if (!is_numeric($bits1))
928
		$bits1 = 32;
929
	if (!is_numeric($bits2))
930
		$bits2 = 32;
931

    
932
	if ($bits1 < $bits2)
933
		$relbits = $bits1;
934
	else
935
		$relbits = $bits2;
936

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

    
940
	if ($sn1 == $sn2)
941
		return true;
942
	else
943
		return false;
944
}
945

    
946
/* compare two IP addresses */
947
function ipcmp($a, $b) {
948
	if (ip_less_than($a, $b))
949
		return -1;
950
	else if (ip_greater_than($a, $b))
951
		return 1;
952
	else
953
		return 0;
954
}
955

    
956
/* return true if $addr is in $subnet, false if not */
957
function ip_in_subnet($addr,$subnet) {
958
	list($ip, $mask) = explode('/', $subnet);
959
	$mask = (0xffffffff << (32 - $mask)) & 0xffffffff;
960
	return ((ip2long($addr) & $mask) == (ip2long($ip) & $mask));
961
}
962

    
963
/* verify (and remove) the digital signature on a file - returns 0 if OK */
964
function verify_digital_signature($fname) {
965
	global $g;
966

    
967
	if(!file_exists("/usr/local/sbin/gzsig"))
968
		return 4;
969

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

    
973
/* obtain MAC address given an IP address by looking at the ARP table */
974
function arp_get_mac_by_ip($ip) {
975
	mwexec("/sbin/ping -c 1 -t 1 {$ip}", true);
976
	$arpoutput = "";
977
	exec("/usr/sbin/arp -n {$ip}", $arpoutput);
978

    
979
	if ($arpoutput[0]) {
980
		$arpi = explode(" ", $arpoutput[0]);
981
		$macaddr = $arpi[3];
982
		if (is_macaddr($macaddr))
983
			return $macaddr;
984
		else
985
			return false;
986
	}
987

    
988
	return false;
989
}
990

    
991
/* return a fieldname that is safe for xml usage */
992
function xml_safe_fieldname($fieldname) {
993
	$replace = array('/', '-', ' ', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
994
			 '_', '+', '=', '{', '}', '[', ']', '|', '/', '<', '>', '?',
995
			 ':', ',', '.', '\'', '\\'
996
		);
997
	return strtolower(str_replace($replace, "", $fieldname));
998
}
999

    
1000
function mac_format($clientmac) {
1001
    $mac =explode(":", $clientmac);
1002

    
1003
    global $config;
1004

    
1005
    $mac_format = $config['captiveportal']['radmac_format'] ? $config['captiveportal']['radmac_format'] : false;
1006

    
1007
    switch($mac_format) {
1008

    
1009
        case 'singledash':
1010
        return "$mac[0]$mac[1]$mac[2]-$mac[3]$mac[4]$mac[5]";
1011

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

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

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

    
1021
        default:
1022
        return $clientmac;
1023
    }
1024
}
1025

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

    
1028
	if (is_ipaddr($hostname))
1029
		return $hostname;
1030

    
1031
	for ($i = 0; $i < $retries; $i++) {
1032
		$ip = gethostbyname($hostname);
1033

    
1034
		if ($ip && $ip != $hostname) {
1035
			/* success */
1036
			return $ip;
1037
		}
1038

    
1039
		sleep(1);
1040
	}
1041

    
1042
	return false;
1043
}
1044

    
1045
function format_bytes($bytes) {
1046
	if ($bytes >= 1073741824) {
1047
		return sprintf("%.2f GB", $bytes/1073741824);
1048
	} else if ($bytes >= 1048576) {
1049
		return sprintf("%.2f MB", $bytes/1048576);
1050
	} else if ($bytes >= 1024) {
1051
		return sprintf("%.0f KB", $bytes/1024);
1052
	} else {
1053
		return sprintf("%d bytes", $bytes);
1054
	}
1055
}
1056

    
1057
function update_filter_reload_status($text) {
1058
	global $g;
1059

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

    
1063
/****f* util/return_dir_as_array
1064
 * NAME
1065
 *   return_dir_as_array - Return a directory's contents as an array.
1066
 * INPUTS
1067
 *   $dir       - string containing the path to the desired directory.
1068
 * RESULT
1069
 *   $dir_array - array containing the directory's contents. This array will be empty if the path specified is invalid.
1070
 ******/
1071
function return_dir_as_array($dir) {
1072
	$dir_array = array();
1073
	if (is_dir($dir)) {
1074
		if ($dh = opendir($dir)) {
1075
			while (($file = readdir($dh)) !== false) {
1076
				$canadd = 0;
1077
				if($file == ".") $canadd = 1;
1078
				if($file == "..") $canadd = 1;
1079
				if($canadd == 0)
1080
					array_push($dir_array, $file);
1081
			}
1082
			closedir($dh);
1083
		}
1084
	}
1085
	return $dir_array;
1086
}
1087

    
1088
function run_plugins($directory) {
1089
	global $config, $g;
1090

    
1091
	/* process packager manager custom rules */
1092
	$files = return_dir_as_array($directory);
1093
	if (is_array($files)) {
1094
		foreach ($files as $file) {
1095
			if (stristr($file, ".sh") == true)
1096
				mwexec($directory . $file . " start");
1097
			else if (!is_dir($directory . "/" . $file) && stristr($file,".inc")) 
1098
				require_once($directory . "/" . $file);
1099
		}
1100
	}
1101
}
1102

    
1103
/*
1104
 *    safe_mkdir($path, $mode = 0755)
1105
 *    create directory if it doesn't already exist and isn't a file!
1106
 */
1107
function safe_mkdir($path, $mode=0755) {
1108
	global $g;
1109

    
1110
	if (!is_file($path) && !is_dir($path)) {
1111
		return @mkdir($path, $mode, true);
1112
	} else {
1113
		return false;
1114
	}
1115
}
1116

    
1117
/*
1118
 * make_dirs($path, $mode = 0755)
1119
 * create directory tree recursively (mkdir -p)
1120
 */
1121
function make_dirs($path, $mode = 0755) {
1122
	$base = '';
1123
	foreach (explode('/', $path) as $dir) {
1124
		$base .= "/$dir";
1125
		if (!is_dir($base)) {
1126
			if (!@mkdir($base, $mode))
1127
				return false;
1128
		}
1129
	}
1130
	return true;
1131
}
1132

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

    
1142
	if (is_array($names)) {
1143
		$name_list = array();
1144
		foreach ($names as $name) {
1145
			$name_list[] = escapeshellarg($name);
1146
		}
1147
	} else
1148
		$name_list = array(escapeshellarg($names));
1149

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

    
1158
	return $values;
1159
}
1160

    
1161
/*
1162
 * set_sysctl($value_list)
1163
 * Set sysctl OID's listed as key/value pairs and return
1164
 * an array with keys set for those that succeeded
1165
 */
1166
function set_sysctl($values) {
1167
	if (empty($values))
1168
		return array();
1169

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

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

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

    
1184
	$ret = array();
1185
	foreach ($output as $line) {
1186
		$line = explode(": ", $line, 2);
1187
		if (count($line) == 2)
1188
			$ret[$line[0]] = true;
1189
	}
1190

    
1191
	return $ret;
1192
}
1193

    
1194
/*
1195
 *     get_memory()
1196
 *     returns an array listing the amount of
1197
 *     memory installed in the hardware
1198
 *     [0]real and [1]available
1199
 */
1200
function get_memory() {
1201
	$matches = "";
1202
	if(file_exists("/var/log/dmesg.boot"))
1203
		$mem = `cat /var/log/dmesg.boot | grep memory`;
1204
	else
1205
		$mem = `dmesg -a | grep memory`;			
1206
	if (preg_match_all("/avail memory.* \((.*)MB\)/", $mem, $matches)) 
1207
		return array($matches[1][0], $matches[1][0]);
1208
	if(!$real && !$avail) {
1209
		$real = trim(`sysctl hw.physmem | cut -d' ' -f2`);
1210
		$avail = trim(`sysctl hw.realmem | cut -d' ' -f2`);
1211
		/* convert from bytes to megabytes */
1212
		return array(($real/1048576),($avail/1048576));
1213
	}
1214
}
1215

    
1216
function mute_kernel_msgs() {
1217
	global $config;
1218
	// Do not mute serial console.  The kernel gets very very cranky
1219
	// and will start dishing you cannot control tty errors.
1220
	if(trim(file_get_contents("/etc/platform")) == "nanobsd") 
1221
		return;
1222
	if($config['system']['enableserial']) 
1223
		return;			
1224
	exec("/sbin/conscontrol mute on");
1225
}
1226

    
1227
function unmute_kernel_msgs() {
1228
	global $config;
1229
	// Do not mute serial console.  The kernel gets very very cranky
1230
	// and will start dishing you cannot control tty errors.
1231
	if(trim(file_get_contents("/etc/platform")) == "nanobsd") 
1232
		return;
1233
	exec("/sbin/conscontrol mute off");
1234
}
1235

    
1236
function start_devd() {
1237
	global $g;
1238

    
1239
	exec("/sbin/devd");
1240
	sleep(1);
1241
}
1242

    
1243
function is_interface_vlan_mismatch() {
1244
	global $config, $g;
1245

    
1246
	if (is_array($config['vlans']['vlan'])) {
1247
		foreach ($config['vlans']['vlan'] as $vlan) {
1248
			if (does_interface_exist($vlan['if']) == false)
1249
				return true;
1250
		}
1251
	}
1252

    
1253
	return false;
1254
}
1255

    
1256
function is_interface_mismatch() {
1257
	global $config, $g;
1258

    
1259
	$do_assign = false;
1260
	$i = 0;
1261
	if (is_array($config['interfaces'])) {
1262
		foreach ($config['interfaces'] as $ifname => $ifcfg) {
1263
			if (preg_match("/^enc|^cua|^tun|^l2tp|^pptp|^ppp|^ovpn|^gif|^gre|^lagg|^bridge|vlan|_wlan/i", $ifcfg['if'])) {
1264
				// Do not check these interfaces.
1265
				$i++;
1266
				continue;
1267
			}
1268
			else if (does_interface_exist($ifcfg['if']) == false) {
1269
				$do_assign = true;
1270
			} else
1271
				$i++;
1272
		}
1273
	}
1274

    
1275
	if ($g['minimum_nic_count'] > $i) {
1276
		$do_assign = true;
1277
	} else if (file_exists("{$g['tmp_path']}/assign_complete"))
1278
	$do_assign = false;
1279

    
1280
	return $do_assign;
1281
}
1282

    
1283
/* sync carp entries to other firewalls */
1284
function carp_sync_client() {
1285
	global $g;
1286
	send_event("filter sync");
1287
}
1288

    
1289
/****f* util/isAjax
1290
 * NAME
1291
 *   isAjax - reports if the request is driven from prototype
1292
 * INPUTS
1293
 *   none
1294
 * RESULT
1295
 *   true/false
1296
 ******/
1297
function isAjax() {
1298
	return isset ($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest';
1299
}
1300

    
1301
/****f* util/timeout
1302
 * NAME
1303
 *   timeout - console input with timeout countdown. Note: erases 2 char of screen for timer. Leave space.
1304
 * INPUTS
1305
 *   optional, seconds to wait before timeout. Default 9 seconds.
1306
 * RESULT
1307
 *   returns 1 char of user input or null if no input.
1308
 ******/
1309
function timeout($timer = 9) {
1310
	while(!isset($key)) {
1311
		if ($timer >= 9) { echo chr(8) . chr(8) . ($timer==9 ? chr(32) : null)  . "{$timer}";  }
1312
		else { echo chr(8). "{$timer}"; }
1313
		`/bin/stty -icanon min 0 time 25`;
1314
		$key = trim(`KEY=\`dd count=1 2>/dev/null\`; echo \$KEY`);
1315
		`/bin/stty icanon`;
1316
		if ($key == '')
1317
			unset($key);
1318
		$timer--;
1319
		if ($timer == 0)
1320
			break;
1321
	}
1322
	return $key;	
1323
}
1324

    
1325
/****f* util/msort
1326
 * NAME
1327
 *   msort - sort array
1328
 * INPUTS
1329
 *   $array to be sorted, field to sort by, direction of sort
1330
 * RESULT
1331
 *   returns newly sorted array
1332
 ******/
1333
function msort($array, $id="id", $sort_ascending=true) {
1334
	$temp_array = array();
1335
	while(count($array)>0) {
1336
		$lowest_id = 0;
1337
		$index=0;
1338
		foreach ($array as $item) {
1339
			if (isset($item[$id])) {
1340
				if ($array[$lowest_id][$id]) {
1341
					if (strtolower($item[$id]) < strtolower($array[$lowest_id][$id])) {
1342
						$lowest_id = $index;
1343
					}
1344
				}
1345
			}
1346
			$index++;
1347
		}
1348
		$temp_array[] = $array[$lowest_id];
1349
		$array = array_merge(array_slice($array, 0,$lowest_id), array_slice($array, $lowest_id+1));
1350
	}
1351
	if ($sort_ascending) {
1352
		return $temp_array;
1353
	} else {
1354
    	return array_reverse($temp_array);
1355
	}
1356
}
1357

    
1358
/****f* util/color
1359
 * NAME
1360
 *   color - outputs a color code to the ansi terminal if supported
1361
 * INPUTS
1362
 *   color code or color name
1363
 * RESULT
1364
 *   Outputs the ansi color sequence for the color specified.  Default resets terminal.
1365
 ******/
1366
function color($color = "0m") {
1367
	/*
1368
		Color codes available:
1369
		 0m reset; clears all colors and styles (to white on black)
1370
		 1m bold on (see below)
1371
		 3m italics on
1372
		 4m underline on
1373
		 7m inverse on; reverses foreground & background colors
1374
		 9m strikethrough on
1375
		 22m bold off (see below)
1376
		 23m italics off
1377
		 24m underline off
1378
		 27m inverse off
1379
		 29m strikethrough off
1380
		 30m set foreground color to black
1381
		 31m set foreground color to red
1382
		 32m set foreground color to green
1383
		 33m set foreground color to yellow
1384
		 34m set foreground color to blue
1385
		 35m set foreground color to magenta (purple)
1386
		 36m set foreground color to cyan
1387
		 37m set foreground color to white
1388
		 40m  set background color to black
1389
		 41m set background color to red
1390
		 42m set background color to green
1391
		 43m set background color to yellow
1392
		 44m set background color to blue
1393
		 45m set background color to magenta (purple)
1394
		 46m set background color to cyan
1395
		 47m set background color to white
1396
		 49m set background color to default (black)
1397
	*/	
1398
	// Allow caching of TERM to 
1399
	// speedup subequence requests.
1400
	global $TERM;
1401
	if(!$TERM) 
1402
		$TERM=`/usr/bin/env | grep color`;
1403
	if(!$TERM)
1404
		$TERM=`/usr/bin/env | grep cons25`;
1405
	if($TERM) {
1406
		$ESCAPE=chr(27);
1407
		switch ($color) {
1408
			case "black":
1409
				return "{$ESCAPE}[30m"; 
1410
			case "red":
1411
				return "{$ESCAPE}[31m"; 
1412
			case "green":
1413
				return "{$ESCAPE}[32m"; 
1414
			case "yellow":
1415
				return "{$ESCAPE}[33m"; 
1416
			case "blue":
1417
				return "{$ESCAPE}[34m"; 
1418
			case "magenta":
1419
				return "{$ESCAPE}[35m"; 
1420
			case "cyan":
1421
				return "{$ESCAPE}[36m"; 
1422
			case "white":
1423
				return "{$ESCAPE}[37m"; 
1424
			case "default":
1425
				return "{$ESCAPE}[39m"; 
1426
		}
1427
		return "{$ESCAPE}[{$color}";
1428
	}
1429
}
1430

    
1431
/****f* util/is_URL
1432
 * NAME
1433
 *   is_URL
1434
 * INPUTS
1435
 *   string to check
1436
 * RESULT
1437
 *   Returns true if item is a URL
1438
 ******/
1439
function is_URL($url) {
1440
	$match = preg_match("'\b(([\w-]+://?|www[.])[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|/)))'", $url);
1441
	if($match)
1442
		return true;	
1443
	return false;
1444
}
1445

    
1446
function is_file_included($file = "") {
1447
	$files = get_included_files();
1448
	if (in_array($file, $files))
1449
		return true;
1450
	
1451
	return false;
1452
}
1453

    
1454
/*
1455
	This function was borrowed from a comment on PHP.net at the following URL:
1456
	http://www.php.net/manual/en/function.array-merge-recursive.php#73843
1457
 */
1458
function array_merge_recursive_unique($array0, $array1) {
1459

    
1460
	$arrays = func_get_args();
1461
	$remains = $arrays;
1462

    
1463
	// We walk through each arrays and put value in the results (without
1464
	// considering previous value).
1465
	$result = array();
1466

    
1467
	// loop available array
1468
	foreach($arrays as $array) {
1469

    
1470
		// The first remaining array is $array. We are processing it. So
1471
		// we remove it from remaing arrays.
1472
        array_shift($remains);
1473

    
1474
		// We don't care non array param, like array_merge since PHP 5.0.
1475
		if(is_array($array)) {
1476
			// Loop values
1477
			foreach($array as $key => $value) {
1478
				if(is_array($value)) {
1479
					// we gather all remaining arrays that have such key available
1480
					$args = array();
1481
					foreach($remains as $remain) {
1482
						if(array_key_exists($key, $remain)) {
1483
							array_push($args, $remain[$key]);
1484
						}
1485
					}
1486

    
1487
					if(count($args) > 2) {
1488
						// put the recursion
1489
						$result[$key] = call_user_func_array(__FUNCTION__, $args);
1490
					} else {
1491
						foreach($value as $vkey => $vval) {
1492
							$result[$key][$vkey] = $vval;
1493
						}
1494
					}
1495
				} else {
1496
					// simply put the value
1497
					$result[$key] = $value;
1498
				}
1499
			}
1500
		}
1501
	}
1502
	return $result;
1503
}
1504

    
1505
?>
(49-49/61)