1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
|
<?php
/*
pfSense-utils.inc
Utilities specific to pfSense
part of pfSense (www.pfSense.com)
Copyright (C) 2005 Scott Ullrich (sullrich@gmail.com)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
/*
* log_error: send string to syslog
*/
function log_error($error) {
syslog(LOG_WARNING, $error);
return;
}
/*
* return_dir_as_array($dir): returns $dir contents as an array
*/
function return_dir_as_array($dir) {
$dir_array = array();
if (is_dir($dir)) {
if ($dh = opendir($dir)) {
while (($file = readdir($dh)) !== false) {
$canadd = 0;
if($file == ".") $canadd = 1;
if($file == "..") $canadd = 1;
if($canadd == 0)
array_push($dir_array, $file);
}
closedir($dh);
}
}
return $dir_array;
}
/*
* enable_hardware_offloading() enables hardware features of nics if they are supported
*/
function enable_hardware_offloading($interface) {
$supported_ints = array('fxp');
foreach($supported_ints as $int) {
if(stristr($interface,$int) != false) {
mwexec("/sbin/ifconfig $interface link0");
}
}
}
/*
* return_filename_as_array($filename): returns $filename contents as a string
*/
function return_filename_as_array($filename) {
$file = array();
if(file_exists($filename)) {
$text = return_filename_as_string($filename);
$text_split = split("\n", $text);
/* Strip out comments */
while (($line = array_shift($text_split)) != NULL) {
if(strpos($line, "#") !== 0)
array_push($file, $line);
}
}
return $file;
}
/*
* return_dir_as_array($filename): returns $filename contents as a string
*/
function return_filename_as_string($filename) {
$tmp = "";
$fd = fopen($filename, "r");
if(!$fd) {
log_error("Could not open {$filename}");
return;
}
while(!feof($fd)) {
$tmp .= fread($fd,49);
}
fclose($fd);
return $tmp;
}
/*
* is_carp_defined: returns true if carp is detected in kernel
*/
function is_carp_defined() {
/* is carp compiled into the kernel and userland? */
$command = "/sbin/sysctl -a | grep carp";
$fd = popen($command . " 2>&1 ", "r");
if(!$fd) {
log_error("Warning, could not execute command {$command}");
return 0;
}
while(!feof($fd)) {
$tmp .= fread($fd,49);
}
fclose($fd);
if($tmp == "")
return false;
else
return true;
}
/*
* find_number_of_created_carp_interfaces() returns the number of currently created carp interfaces
*/
function find_number_of_created_carp_interfaces() {
$command = "/sbin/ifconfig | /usr/bin/grep \"carp*:\" | /usr/bin/wc -l";
$fd = popen($command . " 2>&1 ", "r");
if(!$fd) {
log_error("Warning, could not execute command {$command}");
return 0;
}
while(!feof($fd)) {
$tmp .= fread($fd,49);
}
fclose($fd);
$tmp = intval($tmp);
return $tmp;
}
/*
* link_ip_to_carp_interface($ip): finds where a carp interface links to.
*/
function link_ip_to_carp_interface($ip) {
global $config;
if($ip == "") return;
$i = 0;
$ifdescrs = array('wan', 'lan');
for ($j = 1; isset($config['interfaces']['opt' . $j]); $j++) {
$ifdescrs['opt' . $j] = "opt" . $j;
}
$ft = split("\.", $ip);
$ft_ip = $ft[0] . "." . $ft[1] . "." . $ft[2] . ".";
$carp_ints = "";
$num_carp_ints = find_number_of_created_carp_interfaces();
foreach ($ifdescrs as $ifdescr => $ifname) {
for($x=0; $x<$num_carp_ints; $x++) {
$carp_int = "carp{$x}";
$carp_ip = find_interface_ip($carp_int);
$carp_ft = split("\.", $carp_ip);
$carp_ft_ip = $carp_ft[0] . "." . $carp_ft[1] . "." . $carp_ft[2] . ".";
$result = does_interface_exist($carp_int);
if($result <> true) break;
$interface = filter_opt_interface_to_real($ifname);
if($ft_ip == $carp_ft_ip)
if(stristr($carp_ints,$carp_int) == false)
$carp_ints .= " " . $carp_int;
}
}
return $carp_ints;
}
/*
* exec_command($command): execute command return string of result
*/
function exec_command($command) {
$counter = 0;
$tmp = "";
$fd = popen($command . " 2>&1 ", "r");
while(!feof($fd)) {
$tmp .= fread($fd,49);
}
fclose($fd);
return $tmp;
}
/*
* does_interface_exist($interface): return true or false if a interface is detected.
*/
function does_interface_exist($interface) {
$ints = exec_command("/sbin/ifconfig -l");
if(stristr($ints, $interface) !== false)
return true;
else
return false;
}
/*
* convert_ip_to_network_format($ip, $subnet): converts an ip address to network form
*/
function convert_ip_to_network_format($ip, $subnet) {
$ipsplit = split('[.]', $ip);
$string = $ipsplit[0] . "." . $ipsplit[1] . "." . $ipsplit[2] . ".0/" . $subnet;
return $string;
}
/*
* find_interface_ip($interface): return the interface ip (first found)
*/
function find_interface_ip($interface) {
if(does_interface_exist($interface) == false) return;
$ip = exec_command("/sbin/ifconfig {$interface} | /usr/bin/grep -w \"inet\" | /usr/bin/cut -d\" \" -f 2");
$ip = str_replace("\n","",$ip);
return $ip;
}
function filter_opt_interface_to_real($opt) {
global $config;
return $config['interfaces'][$opt]['if'];
}
function filter_get_opt_interface_descr($opt) {
global $config;
return $config['interfaces'][$opt]['descr'];
}
function get_friendly_interface_list_as_array() {
global $config;
$ints = array();
$i = 0;
$ifdescrs = array('wan', 'lan');
for ($j = 1; isset($config['interfaces']['opt' . $j]); $j++) {
$ifdescrs['opt' . $j] = "opt" . $j;
}
$ifdescrs = get_interface_list();
foreach ($ifdescrs as $ifdescr => $ifname) {
array_push($ints,$ifdescr);
}
return $ints;
}
/*
* find_ip_interface($ip): return the interface where an ip is defined
*/
function find_ip_interface($ip) {
global $config;
$i = 0;
$ifdescrs = array('wan', 'lan');
for ($j = 1; isset($config['interfaces']['opt' . $j]); $j++) {
$ifdescrs['opt' . $j] = "opt" . $j;
}
foreach ($ifdescrs as $ifdescr => $ifname) {
$int = filter_translate_type_to_real_interface($ifname);
$ifconfig = exec_command("/sbin/ifconfig {$int}");
if(stristr($ifconfig,$ip) <> false)
return $int;
}
return false;
}
/*
* get_carp_interface_status($carpinterface): returns the status of a carp ip
*/
function get_carp_interface_status($carpinterface) {
$result = does_interface_exist($carpinterface);
if($result <> true) return false;
$status = exec_command("/sbin/ifconfig {$carpinterface} | /usr/bin/grep \"carp:\" | /usr/bin/cut -d\" \" -f2");
return $status;
}
/*
* get_pfsync_interface_status($pfsyncinterface): returns the status of a pfsync
*/
function get_pfsync_interface_status($pfsyncinterface) {
$result = does_interface_exist($pfsyncinterface);
if($result <> true) return;
$status = exec_command("/sbin/ifconfig {$pfsyncinterface} | /usr/bin/grep \"pfsync:\" | /usr/bin/cut -d\" \" -f5");
return $status;
}
/*
* find_carp_interface($ip): return the carp interface where an ip is defined
*/
function find_carp_interface($ip) {
$num_carp_ints = find_number_of_created_carp_interfaces();
for($x=0; $x<$num_carp_ints; $x++) {
$result = does_interface_exist("carp{$x}");
if($result <> true) return;
$ifconfig = exec_command("/sbin/ifconfig carp{$x}");
if(stristr($ifconfig,$ip))
return "carp" . $x;
}
}
/*
* add_rule_to_anchor($anchor, $rule): adds the specified rule to an anchor
*/
function add_rule_to_anchor($anchor, $rule, $label) {
mwexec("echo " . $rule . " | /sbin/pfctl -a " . $anchor . ":" . $label . " -f -");
}
/*
* remove_text_from_file
* remove $text from file $file
*/
function remove_text_from_file($file, $text) {
global $fd_log;
fwrite($fd_log, "Adding needed text items:\n");
$filecontents = exec_command_and_return_text("cat " . $file);
$textTMP = str_replace($text, "", $filecontents);
$text .= $textTMP;
fwrite($fd_log, $text . "\n");
$fd = fopen($file, "w");
fwrite($fd, $text);
fclose($fd);
}
/*
* lookup pkg array id#
*/
function get_pkg_id($pkg_name) {
global $config;
global $pkg_config;
$i=0;
foreach ($config['installedpackages']['package'] as $pkg) {
if($pkg['name'] == $pkg_name) return $i;
$i++;
}
return -1;
}
/*
* get_latest_package_version($pkgname): get current version of a package.
* returns latest package version
*/
function get_latest_package_version($pkg_name) {
global $g;
fetch_latest_pkg_config();
$pkg_config = parse_xml_config_pkg("{$g['tmp_path']}/pkg_config.xml", "pfsensepkgs");
foreach($pkg_config['packages']['package'] as $pkg) {
if($pkg['name'] == $pkg_name) {
return $pkg['version'];
}
}
return;
}
/*
* Lookup pkg_id in pkg_config.xml
*/
function get_available_pkg_id($pkg_name) {
fetch_latest_pkg_config();
$pkg_config = parse_xml_config_pkg("{$g['tmp_path']}/pkg_config.xml", "pfsensepkgs");
$id = 0;
foreach($pkg_config as $pkg) {
if($pkg_config['name'] == $pkg_name) {
return $id;
}
$id++;
}
return;
}
/*
* fetch_latest_pkg_config: download the latest pkg_config.xml to /tmp/ directory
*/
function fetch_latest_pkg_config() {
global $g;
if(!file_exists("{$g['tmp_path']}/pkg_config.xml")) {
mwexec("/usr/bin/fetch -o {$g['tmp_path']}/pkg_config.xml {$g['pkg_config_location']}");
if(!file_exists("{$g['tmp_path']}/pkg_config.xml")) {
print_info_box_np("Could not download pkg_config.xml from pfSense.com. Check your DNS settings.");
die;
}
}
return;
}
/*
* add_text_to_file($file, $text): adds $text to $file.
* replaces the text if it already exists.
*/
function add_text_to_file($file, $text) {
global $fd_log;
fwrite($fd_log, "Adding needed text items:\n");
$filecontents = exec_command_and_return_text("cat " . $file);
$filecontents = str_replace($text, "", $filecontents);
$text = $filecontents . $text;
fwrite($fd_log, $text . "\n");
$fd = fopen($file, "w");
fwrite($fd, $text . "\n");
fclose($fd);
}
/*
* get_filename_from_url($url): converts a url to its filename.
*/
function get_filename_from_url($url) {
$filenamesplit = split("/", $url);
foreach($filenamesplit as $fn) $filename = $fn;
return $filename;
}
/*
* update_output_window: update bottom textarea dynamically.
*/
function update_output_window($text) {
$log = ereg_replace("\n", "\\n", $text);
echo "\n<script language=\"JavaScript\">this.document.forms[0].output.value = \"" . $log . "\";</script>";
}
/*
* get_dir: return an array of $dir
*/
function get_dir($dir) {
$dir_array = array();
$d = dir($dir);
while (false !== ($entry = $d->read())) {
array_push($dir_array, $entry);
}
$d->close();
return $dir_array;
}
/*
* update_output_window: update top textarea dynamically.
*/
function update_status($status) {
echo "\n<script language=\"JavaScript\">document.forms[0].status.value=\"" . $status . "\";</script>";
}
/*
* exec_command_and_return_text_array: execute command and return output
*/
function exec_command_and_return_text_array($command) {
$counter = 0;
$fd = popen($command . " 2>&1 ", "r");
while(!feof($fd)) {
$tmp .= fread($fd,49);
}
fclose($fd);
$temp_array = split("\n", $tmp);
return $tmp_array;
}
/*
* exec_command_and_return_text: execute command and return output
*/
function exec_command_and_return_text($command) {
return exec_command($command);
}
/*
* exec_command_and_return_text: execute command and update output window dynamically
*/
function execute_command_return_output($command) {
global $fd_log;
$fd = popen($command . " 2>&1 ", "r");
echo "\n<script language=\"JavaScript\">this.document.forms[0].output.value = \"\";</script>";
$counter = 0;
$counter2 = 0;
while(!feof($fd)) {
$tmp = fread($fd, 50);
$tmp1 = ereg_replace("\n","\\n", $tmp);
$text = ereg_replace("\"","'", $tmp1);
if($lasttext == "..") {
$text = "";
$lasttext = "";
$counter=$counter-2;
} else {
$lasttext .= $text;
}
if($counter > 51) {
$counter = 0;
$extrabreak = "\\n";
} else {
$extrabreak = "";
$counter++;
}
if($counter2 > 600) {
echo "\n<script language=\"JavaScript\">this.document.forms[0].output.value = \"\";</script>";
$counter2 = 0;
} else
$counter2++;
echo "\n<script language=\"JavaScript\">this.document.forms[0].output.value = this.document.forms[0].output.value + \"" . $text . $extrabreak . "\"; f('output'); </script>";
}
fclose($fd);
}
/*
* convert_friendly_interface_to_real_interface_name($interface): convert WAN to FXP0
*/
function convert_friendly_interface_to_real_interface_name($interface) {
return $config['interfaces'][$interface]['if'];
}
/*
* convert_real_interface_to_friendly_interface_name($interface): convert fxp0 -> wan, etc.
*/
function convert_real_interface_to_friendly_interface_name($interface) {
global $config;
$i = 0;
$ifdescrs = array('wan', 'lan');
for ($j = 1; isset($config['interfaces']['opt' . $j]); $j++) {
$ifdescrs['opt' . $j] = "opt" . $j;
}
foreach ($ifdescrs as $ifdescr => $ifname) {
$int = filter_translate_type_to_real_interface($ifname);
if($int == $interface) return $ifname;
}
return $interface;
}
/*
* update_progress_bar($percent): updates the javascript driven progress bar.
*/
function update_progress_bar($percent) {
if($percent > 100) $percent = 1;
echo "\n<script type=\"text/javascript\" language=\"javascript\">";
echo "\ndocument.progressbar.style.width='" . $percent . "%';";
echo "\n</script>";
}
/*
* resync_all_package_configs_bootup() Force packages to setup their configuration and rc.d files at bootup.
* This function also prints output to the terminal indicating progress.
*/
function resync_all_package_configs_bootup($show_message) {
global $config;
log_error("Resyncing configuration for all packages.");
if(!$config['installedpackages']['package']) return;
foreach($config['installedpackages']['package'] as $package) {
if($show_message == true) print "Syncing " . $package['name'] . ".\n";
if(!file_exists("/usr/local/pkg/" . $package['configurationfile'])) {
if($show_message == true) print "Fetching " . $package['configurationfile'] . ".\n";
log_error("Fetching missing configuration XML for " . $package['name']);
system("/usr/bin/fetch -o /usr/local/pkg/" . $package['configurationfile'] . " http://www.pfsense.com/packages/config/" . $package['configurationfile']);
}
$pkg_config = parse_xml_config_pkg("/usr/local/pkg/" . $package['configurationfile'], "packagegui");
if($pkg_config['custom_php_command_before_form'] <> "") eval($pkg_config['custom_php_command_before_form']);
if($pkg_config['custom_php_resync_config_command'] <> "") eval($pkg_config['custom_php_resync_config_command']);
if($show_message == true) print "Synced " . $package['name'] . ".\n";
}
}
/*
* sweep_package_processes() Periodically kill a package's unnecessary processes that may still be running (a server that does not automatically timeout, for example)
*/
function sweep_package_processes() {
global $config;
if(!$config['installedpackages']['package']) return;
foreach($config['installedpackages']['package'] as $package) {
$pkg_config = parse_xml_config_pkg("/usr/local/pkg/" . $package['configurationfile'], "packagegui");
if($pkg_config['swept_processes'] <> "") {
mwexec("killall" . $pkg_config['swept_processes']);
log_error("Killed " . $package['name'] . "'s unnecessary processes.");
}
}
}
/*
* gather_altq_queue_stats(): gather alq queue stats and return an array that
* is queuename|qlength|measured_packets
* NOTE: this commandt takes 5 seconds to run
*/
function gather_altq_queue_stats($dont_return_root_queues) {
mwexec("/usr/bin/killall -9 pfctl");
$stats = `/sbin/pfctl -vvsq & sleep 5;killall pfctl 2>/dev/null`;
$stats_array = split("\n", $stats);
$queue_stats = array();
foreach ($stats_array as $stats_line) {
if (preg_match_all("/queue\s+(\w+)\s+/",$stats_line,$match_array))
$queue_name = $match_array[1][0];
if (preg_match_all("/measured:\s+.*packets\/s\,\s(.*)\s+\]/",$stats_line,$match_array))
$speed = $match_array[1][0];
if (preg_match_all("/borrows:\s+(.*)/",$stats_line,$match_array))
$borrows = $match_array[1][0];
if (preg_match_all("/measured:\s+(.*)packets/",$stats_line,$match_array)) {
$measured = $match_array[1][0];
if($dont_return_root_queues == true)
if(stristr($queue_name,"root_") == false)
array_push($queue_stats, "{$queue_name}|{$speed}|{$measured}|{$borrows}");
}
}
return $queue_stats;
}
?>
|