]>
git.ipfire.org Git - people/pmueller/ipfire-2.x.git/blob - config/cfgroot/general-functions.pl
3 # This code is distributed under the terms of the GPL
5 # (c) The SmoothWall Team
6 # Copyright (C) 2002 Alex Hudson - getcgihash() rewrite
7 # Copyright (C) 2002 Bob Grant <bob@cache.ucr.edu> - validmac()
8 # Copyright (c) 2002/04/13 Steve Bootes - add alias section, helper functions
9 # Copyright (c) 2002/08/23 Mark Wormgoor <mark@wormgoor.com> validfqdn()
10 # Copyright (c) 2003/09/11 Darren Critchley <darrenc@telus.net> srtarray()
12 # $Id: general-functions.pl,v 1.1.2.26 2006/01/04 16:33:55 franck78 Exp $
22 $|=1; # line buffering
24 $General::version
= 'VERSION';
25 $General::swroot
= 'CONFIG_ROOT';
26 $General::noipprefix
= 'noipg-';
27 $General::adminmanualurl
= 'http://wiki.ipfire.org';
30 # log ("message") use default 'ipcop' tag
31 # log ("tag","message") use your tag
36 $tag = shift if (@_>1);
37 my $logmessage = $_[0];
38 $logmessage =~ /([\w\W]*)/;
40 system('logger', '-t', $tag, $logmessage);
50 # Some ipcop code expects that readhash 'complete' the hash if new entries
51 # are presents. Not clear it !!!
54 open(FILE
, $filename) or die "Unable to read file $filename";
59 ($var, $val) = split /=/, $_, 2;
65 # Untaint variables read from hash
66 # trim space from begin and end
69 $var =~ /([A-Za-z0-9_-]*)/;
86 # write cgi vars to the file.
87 open(FILE
, ">${filename}") or die "Unable to write file $filename";
89 foreach $var (keys %$hash)
91 if ( $var eq "__CGI__"){next;}
93 # Darren Critchley Jan 17, 2003 added the following because when submitting with a graphic, the x and y
94 # location of the mouse are submitted as well, this was being written to the settings file causing
95 # some serious grief! This skips the variable.x and variable.y
96 if (!($var =~ /(.x|.y)$/)) {
99 if (!($var =~ /^ACTION/)) {
100 print FILE
"${var}=${val}\n"; }
108 # This function replaces the given hash in the original hash by keeping the old
109 # content and just replacing the new content
111 my $filename = $_[0];
116 readhash
("${filename}", \
%oldhash);
118 foreach $var (keys %$newhash){
119 $oldhash{$var}=$newhash->{$var};
122 # write cgi vars to the file.
123 open(FILE
, ">${filename}") or die "Unable to write file $filename";
125 foreach $var (keys %oldhash)
127 if ( $var eq "__CGI__"){next;}
128 $val = $oldhash{$var};
129 # Darren Critchley Jan 17, 2003 added the following because when submitting with a graphic, the x and y
130 # location of the mouse are submitted as well, this was being written to the settings file causing
131 # some serious grief! This skips the variable.x and variable.y
132 if (!($var =~ /(.x|.y)$/)) {
135 if (!($var =~ /^ACTION/)) {
136 print FILE
"${var}=${val}\n"; }
144 my ($dev, $ino, $mode, $nlink, $uid, $gid, $rdev, $size,
145 $atime, $mtime, $ctime, $blksize, $blocks) = stat $_[0];
148 my $totalsecs = $now - $mtime;
149 my $days = int($totalsecs / 86400);
150 my $totalhours = int($totalsecs / 3600);
151 my $hours = $totalhours % 24;
152 my $totalmins = int($totalsecs / 60);
153 my $mins = $totalmins % 60;
154 my $secs = $totalsecs % 60;
156 return "${days}d ${hours}h ${mins}m ${secs}s";
163 if (!($ip =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/)) {
167 my @octets = ($1, $2, $3, $4);
172 if ($_ < 0 || $_ > 255) {
184 if (&validip
($mask)) {
186 # second part a number?
189 if (!($mask =~ /^\d+$/)) {
191 if ($mask >= 0 && $mask <= 32) {
198 my $ipormask = $_[0];
200 # see if it is a IP only.
201 if (&validip
($ipormask)) {
203 # split it into number and mask.
204 if (!($ipormask =~ /^(.*?)\/(.*?
)$/)) {
208 # first part not a ip?
209 if (!(&validip
($ip))) {
211 return &validmask
($mask);
216 my $ipandmask = $_[0];
218 # split it into number and mask.
219 if (!($ipandmask =~ /^(.*?)\/(.*?
)$/)) {
223 # first part not a ip?
224 if (!(&validip
($ip))) {
226 return &validmask
($mask);
237 if ($_ >= 1 && $_ <= 65535) {
250 if ($_ == 53 || $_ == 222 || $_ == 444 || $_ == 81 ) {
252 elsif ($_ >= 1 && $_ <= 65535) {
259 my $checkmac = $_[0];
260 my $ot = '[0-9a-f]{2}'; # 2 Hex digits (one octet)
261 if ($checkmac !~ /^$ot:$ot:$ot:$ot:$ot:$ot$/i)
270 # Checks a hostname against RFC1035
271 my $hostname = $_[0];
273 # Each part should be at least two characters in length
274 # but no more than 63 characters
275 if (length ($hostname) < 1 || length ($hostname) > 63) {
277 # Only valid characters are a-z, A-Z, 0-9 and -
278 if ($hostname !~ /^[a-zA-Z0-9-]*$/) {
280 # First character can only be a letter or a digit
281 if (substr ($hostname, 0, 1) !~ /^[a-zA-Z0-9]*$/) {
283 # Last character can only be a letter or a digit
284 if (substr ($hostname, -1, 1) !~ /^[a-zA-Z0-9]*$/) {
293 # Checks a domain name against RFC1035
294 my $domainname = $_[0];
295 my @parts = split (/\./, $domainname); # Split hostname at the '.'
297 foreach $part (@parts) {
298 # Each part should be at least two characters in length
299 # but no more than 63 characters
300 if (length ($part) < 2 || length ($part) > 63) {
302 # Only valid characters are a-z, A-Z, 0-9 and -
303 if ($part !~ /^[a-zA-Z0-9-]*$/) {
305 # First character can only be a letter or a digit
306 if (substr ($part, 0, 1) !~ /^[a-zA-Z0-9]*$/) {
308 # Last character can only be a letter or a digit
309 if (substr ($part, -1, 1) !~ /^[a-zA-Z0-9]*$/) {
319 # Checks a fully qualified domain name against RFC1035
321 my @parts = split (/\./, $fqdn); # Split hostname at the '.'
322 if (scalar(@parts) < 2) { # At least two parts should
323 return 0;} # exist in a FQDN
324 # (i.e. hostname.domain)
325 foreach $part (@parts) {
326 # Each part should be at least one character in length
327 # but no more than 63 characters
328 if (length ($part) < 1 || length ($part) > 63) {
330 # Only valid characters are a-z, A-Z, 0-9 and -
331 if ($part !~ /^[a-zA-Z0-9-]*$/) {
333 # First character can only be a letter or a digit
334 if (substr ($part, 0, 1) !~ /^[a-zA-Z0-9]*$/) {
336 # Last character can only be a letter or a digit
337 if (substr ($part, -1, 1) !~ /^[a-zA-Z0-9]*$/) {
343 sub validportrange
# used to check a port range
345 my $port = $_[0]; # port values
346 $port =~ tr/-/:/; # replace all - with colons just in case someone used -
347 my $srcdst = $_[1]; # is it a source or destination port
349 if (!($port =~ /^(\d+)\:(\d+)$/)) {
351 if (!(&validport
($port))) {
352 if ($srcdst eq 'src'){
353 return $Lang::tr
{'source port numbers'};
355 return $Lang::tr
{'destination port numbers'};
361 my @ports = ($1, $2);
363 if ($srcdst eq 'src'){
364 return $Lang::tr
{'bad source range'};
366 return $Lang::tr
{'bad destination range'};
371 if (!(&validport
($_))) {
372 if ($srcdst eq 'src'){
373 return $Lang::tr
{'source port numbers'};
375 return $Lang::tr
{'destination port numbers'};
383 # Test if IP is within a subnet
384 # Call: IpInSubnet (Addr, Subnet, Subnet Mask)
385 # Subnet can be an IP of the subnet: 10.0.0.0 or 10.0.0.1
386 # Everything in dottted notation
390 my $ip = unpack('N', &Socket
::inet_aton
(shift));
391 my $start = unpack('N', &Socket
::inet_aton
(shift));
392 my $mask = unpack('N', &Socket
::inet_aton
(shift));
393 $start &= $mask; # base of subnet...
394 my $end = $start + ~$mask;
395 return (($ip >= $start) && ($ip <= $end));
399 # Return the following IP (IP+1) in dotted notation.
400 # Call: NextIP ('1.1.1.1');
405 return &Socket
::inet_ntoa
( pack("N", 1 + unpack('N', &Socket
::inet_aton
(shift))
412 return 0 if ( $mail !~ /^[0-9a-zA-Z\.\-\_]+\@[0-9a-zA-Z\.\-]+$/ );
413 return 0 if ( $mail =~ /^[^0-9a-zA-Z]|[^0-9a-zA-Z]$/);
414 return 0 if ( $mail !~ /([0-9a-zA-Z]{1})\@./ );
415 return 0 if ( $mail !~ /.\@([0-9a-zA-Z]{1})/ );
416 return 0 if ( $mail =~ /.\.\-.|.\-\..|.\.\..|.\-\-./g );
417 return 0 if ( $mail =~ /.\.\_.|.\-\_.|.\_\..|.\_\-.|.\_\_./g );
418 return 0 if ( $mail !~ /\.([a-zA-Z]{2,4})$/ );
423 # Currently only vpnmain use this three procs (readhasharray, writehasharray, findhasharray)
424 # The 'key' used is numeric but is perfectly unneeded! This will to be removed so don't use
425 # this code. Vpnmain will be splitted in parts: x509/pki, connection ipsec, connection other,... .
428 my ($filename, $hash) = @_;
431 open(FILE
, $filename) or die "Unable to read file $filename";
434 my ($key, $rest, @temp);
436 ($key, $rest) = split (/,/, $_, 2);
437 if ($key =~ /^[0-9]+$/) {
438 @temp = split (/,/, $rest);
439 $hash->{$key} = \
@temp;
447 my ($filename, $hash) = @_;
448 my ($key, @temp, $i);
450 open(FILE
, ">$filename") or die "Unable to write to file $filename";
452 foreach $key (keys %$hash) {
453 if ($key =~ /^[0-9]+$/) {
455 foreach $i (0 .. $#{$hash->{$key}}) {
456 print FILE
",$hash->{$key}[$i]";
465 sub findhasharraykey
{
466 foreach my $i (1 .. 1000000) {
467 if ( ! exists $_[0]{$i}) {
474 # Darren Critchley - darrenc@telus.net - (c) 2003
475 # &srtarray(SortOrder, AlphaNumeric, SortDirection, ArrayToBeSorted)
476 # This subroutine will take the following parameters:
477 # ColumnNumber = the column which you want to sort on, starts at 1
478 # AlphaNumberic = a or n (lowercase) defines whether the sort should be alpha or numberic
479 # SortDirection = asc or dsc (lowercase) Ascending or Descending sort
480 # ArrayToBeSorted = the array that wants sorting
482 # Returns an array that is sorted to your specs
484 # If SortOrder is greater than the elements in array, then it defaults to the first element
487 my ($colno, $alpnum, $srtdir, @tobesorted) = @_;
493 my $ttlitems = scalar @tobesorted; # want to know the number of rows in the passed array
494 if ($ttlitems < 1){ # if no items, don't waste our time lets leave
495 return (@tobesorted);
497 my @tmp = split(/\,/,$tobesorted[0]);
498 $ttlitems = scalar @tmp; # this should be the number of elements in each row of the passed in array
500 # Darren Critchley - validate parameters
501 if ($colno > $ttlitems){$colno = '1';}
502 $colno--; # remove one from colno to deal with arrays starting at 0
503 if($colno < 0){$colno = '0';}
504 if ($alpnum ne '') { $alpnum = lc($alpnum); } else { $alpnum = 'a'; }
505 if ($srtdir ne '') { $srtdir = lc($srtdir); } else { $srtdir = 'src'; }
507 foreach $line (@tobesorted)
511 my @temp = split(/\,/,$line);
512 # Darren Critchley - juggle the fields so that the one we want to sort on is first
513 my $tmpholder = $temp[0];
514 $temp[0] = $temp[$colno];
515 $temp[$colno] = $tmpholder;
517 for ($ctr=0; $ctr < $ttlitems ; $ctr++) {
518 $newline=$newline . $temp[$ctr] . ",";
521 push(@tmparray,$newline);
524 if ($alpnum eq 'n') {
525 @tmparray = sort {$a <=> $b} @tmparray;
527 @tmparray = (sort @tmparray);
529 foreach $line (@tmparray)
533 my @temp = split(/\,/,$line);
534 my $tmpholder = $temp[0];
535 $temp[0] = $temp[$colno];
536 $temp[$colno] = $tmpholder;
538 for ($ctr=0; $ctr < $ttlitems ; $ctr++){
539 $newline=$newline . $temp[$ctr] . ",";
542 push(@srtedarray,$newline);
546 if ($srtdir eq 'dsc') {
547 @tmparray = reverse(@srtedarray);
550 return (@srtedarray);
556 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
557 if ($_=$proxysettings{'UPSTREAM_PROXY'}) {
558 my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\
/)?(?:[A-Za-z0-9\_\.\-]*?(?:\:[A-Za-z0-9\_\.\-]*?)?\@)?([a-zA-Z0-9\.\_\-]*?)(?:\:([0-9]{1,5}))?(?:\/.*?
)?
$/);
559 Net
::SSLeay
::set_proxy
($peer,$peerport,$proxysettings{'UPSTREAM_USER'},$proxysettings{'UPSTREAM_PASSWORD'} );
561 my ($out, $response) = Net
::SSLeay
::get_http
( 'checkip.dyndns.org',
564 Net
::SSLeay
::make_headers
('User-Agent' => 'IPFire' )
566 if ($response =~ m
%HTTP/1\
.. 200 OK
%) {
567 $out =~ /Current IP Address: (\d+.\d+.\d+.\d+)/;
574 # Check if hostname.domain provided have IP provided
575 # use gethostbyname to verify that
581 # 1 IP matches host.domain
584 sub DyndnsServiceSync
($;$;$) {
586 my ($ip,$hostName,$domain) = @_;
589 #fix me no ip GROUP, what is the name ?
590 $hostName =~ s/$General::noipprefix//;
591 if ($hostName) { #may be empty
592 $hostName = "$hostName.$domain";
593 @addresses = gethostbyname($hostName);
596 if ($addresses[0] eq '') { # nothing returned ?
597 $hostName = $domain; # try resolving with domain only
598 @addresses = gethostbyname($hostName);
601 if ($addresses[0] ne '') { # got something ?
602 #&General::log("name:$addresses[0], alias:$addresses[1]");
603 # Build clear text list of IP
604 @addresses = map ( &Socket
::inet_ntoa
($_), @addresses[4..$#addresses]);
605 if (grep (/$ip/, @addresses)) {
612 # This sub returns the red IP used to compare in DyndnsServiceSync
616 &General
::readhash
("${General::swroot}/ddns/settings", \
%settings);
618 open(IP
, "${General::swroot}/red/local-ipaddress") or return 'unavailable';
623 if (&General
::IpInSubnet
($ip,'10.0.0.0','255.0.0.0') ||
624 &General
::IpInSubnet
($ip,'172.16.0.0.','255.240.0.0') ||
625 &General
::IpInSubnet
($ip,'192.168.0.0','255.255.0.0'))
627 if ($settings{'BEHINDROUTER'} eq 'FETCH_IP') {
628 my $RealIP = &General
::FetchPublicIp
;
629 $ip = (&General
::validip
($RealIP) ?
$RealIP : 'unavailable');
635 # Translate ICMP code to text
636 # ref: http://www.iana.org/assignments/icmp-parameters
637 sub GetIcmpDescription
($) {
639 my @icmp_description = (
643 'Destination Unreachable',
646 'Alternate Host Address',
649 'Router Advertisement',
650 'Router Solicitation', #10
655 'Information Request',
657 'Address Mask Request',
658 'Address Mask Reply',
659 'Reserved (for Security)',
660 'Reserved (for Robustness Experiment)', #20
671 'Datagram Conversion Error',
672 'Mobile Host Redirect',
673 'IPv6 Where-Are-You',
675 'Mobile Registration Request',
676 'Mobile Registration Reply',
677 'Domain Name Request',
682 if ($index>41) {return 'unknown'} else {return @icmp_description[$index]};