2 # The User/Sysop Filter module
4 # The way this works is that the filter routine is actually
5 # a predefined function that returns 0 if it is OK and 1 if it
6 # is not when presented with a list of things.
8 # This set of routines provide a means of maintaining the filter
9 # scripts which are compiled in when an entity connects.
11 # Copyright (c) 1999 Dirk Koopman G1TLH
15 # The NEW INSTRUCTIONS
17 # use the commands accept/spot|ann|wwv|wcy and reject/spot|ann|wwv|wcy
18 # also show/filter spot|ann|wwv|wcy
20 # The filters live in a directory tree of their own in $main::root/filter
22 # Each type of filter (e.g. spot, wwv) live in a tree of their own so you
23 # can have different filters for different things for the same callsign.
37 use vars qw($VERSION $BRANCH);
38 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
39 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
40 $main::build += $VERSION;
41 $main::branch += $BRANCH;
43 use vars qw ($filterbasefn $in);
45 $filterbasefn = "$main::root/filter";
48 # initial filter system
56 my ($class, $sort, $call, $flag) = @_;
57 $flag = ($flag) ? "in_" : "";
58 return bless {sort => $sort, name => "$flag$call.pl" }, $class;
61 # standard filename generator
64 my ($sort, $call, $flag) = @_;
67 $flag = ($flag) ? "in_" : "";
69 my $fn = "$filterbasefn/$sort/$flag$call.pl";
74 $fn = "$filterbasefn/$sort/$flag$call.pl";
76 $fn = undef unless -e $fn;
80 # this reads in a filter statement and returns it as a list
82 # The filter is stored in straight perl so that it can be parsed and read
83 # in with a 'do' statement. The 'do' statement reads the filter into
84 # @in which is a list of references
91 my $ref = $self->{$fname};
94 if ($ref->{$ar} && exists $ref->{$ar}->{asc}) {
95 $ref->{$ar}->{code} = eval "sub { my \$r=shift; return $ref->{$ar}->{asc}; }" ;
97 my $sort = $ref->{sort};
98 my $name = $ref->{name};
99 dbg("Error compiling $ar $sort $name: $@");
100 Log('err', "Error compiling $ar $sort $name: $@");
109 my ($sort, $call, $flag) = @_;
113 if ($fn = getfn($sort, $call, $flag)) {
115 my $s = readfilestr($fn);
119 $newin = new('Filter::Old', $sort, $call, $flag);
120 $newin->{filter} = $in;
124 foreach $key ($newin->getfilkeys) {
125 $newin->compile($key, 'reject');
126 $newin->compile($key, 'accept');
139 foreach $key (grep {/^filter/ } keys %$self) {
140 push @out, $self->{$key};
148 return grep {/^filter/ } keys %$self;
152 # This routine accepts a composite filter with a reject rule and then an accept rule.
154 # The filter returns 0 if an entry is matched by any reject rule and also if any
155 # accept rule fails otherwise it returns 1
157 # Either set of rules may be missing meaning an implicit 'opposite' ie if it
158 # a reject then ok else if an accept then not ok.
160 # you can set a default with either an accept/xxxx all or reject/xxxx all
162 # Unlike the old system, this is kept as a hash of hashes so that you can
163 # easily change them by program.
165 # You can have 10 filter lines (0->9), they are tried in order until
168 # There is a parser that takes a Filter::Cmd object which describes all the possible
169 # things you can filter on and then converts that to a bit of perl which is compiled
170 # and stored as a function.
172 # The result of this is that in theory you can put together an arbritrarily complex
173 # expression involving the things you can filter on including 'and' 'or' 'not' and
178 # accept/spots hf and by_zone 14,15,16 and not by pa,on
180 # accept/spots freq 0/30000 and by_zone 4,5
182 # accept/spots 2 vhf and (by_zone 14,15,16 or call_dxcc 61)
184 # no filter no implies filter 1
186 # The field nos are the same as for the 'Old' filters
195 my @keys = sort $self->getfilkeys;
200 my $r = @keys > 0 ? 0 : 1;
201 foreach $key (@keys) {
202 $filter = $self->{$key};
203 if ($filter->{reject} && exists $filter->{reject}->{code}) {
205 $asc = $filter->{reject}->{user};
206 if (&{$filter->{reject}->{code}}(\@_)) {
213 if ($filter->{accept} && exists $filter->{accept}->{code}) {
215 $asc = $filter->{accept}->{user};
216 if (&{$filter->{accept}->{code}}(\@_)) {
225 # hops are done differently (simply)
226 my $hops = $self->{hops} if exists $self->{hops};
228 if (isdbg('filter')) {
229 my $args = join '\',\'', @_;
230 my $true = $r ? "OK " : "REJ";
231 my $sort = $self->{sort};
232 my $dir = $self->{name} =~ /^in_/i ? "IN " : "OUT";
235 dbg("$true $dir: $type/$sort with $asc on '$args' $h") if isdbg('filter');
240 # this writes out the filter in a form suitable to be read in by 'read_in'
241 # It expects a list of references to filter lines
245 my $sort = $self->{sort};
246 my $name = $self->{name};
247 my $dir = "$filterbasefn/$sort";
248 my $fn = "$dir/$name";
250 mkdir $dir, 0775 unless -e $dir;
251 rename $fn, "$fn.o" if -e $fn;
252 my $fh = new IO::File ">$fn";
254 my $dd = new Data::Dumper([ $self ]);
257 $dd->Quotekeys($] < 5.005 ? 1 : 0);
258 $fh->print($dd->Dumpxs);
261 rename "$fn.o", $fn if -e "$fn.o";
270 my $name = shift || $self->{name};
271 my $sort = shift || $self->{sort};
272 my $flag = shift || "";
276 push @out, join(' ', $name , ':', $sort, $flag);
279 foreach $key (sort $self->getfilkeys) {
280 my $filter = $self->{$key};
281 if (exists $filter->{reject} && exists $filter->{reject}->{user}) {
282 push @out, ' ' . join(' ', $key, 'reject', $filter->{reject}->{user});
284 if (exists $filter->{accept} && exists $filter->{accept}->{user}) {
285 push @out, ' ' . join(' ', $key, 'accept', $filter->{accept}->{user});
295 my $name = uc $self->{name};
296 my $sort = $self->{sort};
298 $in = "in" if $name =~ s/^IN_//;
303 if ($name eq 'NODE_DEFAULT') {
304 @dxchan = DXChannel::get_all_nodes();
305 } elsif ($name eq 'USER_DEFAULT') {
306 @dxchan = DXChannel::get_all_users();
308 $dxchan = DXChannel->get($name);
309 push @dxchan, $dxchan if $dxchan;
311 foreach $dxchan (@dxchan) {
312 my $n = "$in$sort" . "filter";
313 my $ref = $dxchan->$n;
314 if (!$ref || ($ref && uc $ref->{name} eq "$name.PL")) {
315 $dxchan->$n($remove ? undef : $self);
322 my ($sort, $call, $flag, $fno) = @_;
325 my $fn = getfn($sort, $call, $flag);
326 my $filter = read_in($sort, $call, $flag);
330 foreach $key ($filter->getfilkeys) {
331 delete $filter->{$key};
333 } elsif (exists $filter->{"filter$fno"}) {
334 delete $filter->{"filter$fno"};
338 if ($filter->{hops} || $filter->getfilkeys) {
357 # the general purpose command processor
358 # this is called as a subroutine not as a method
361 my ($self, $dxchan, $sort, $line) = @_;
369 # check the line for non legal characters
370 return ('ill', $dxchan->msg('e19')) if $line =~ /[^\s\w,_\-\*\/\(\)]/;
372 # add some spaces for ease of parsing
373 $line =~ s/([\(\)])/ $1 /g;
376 my @f = split /\s+/, $line;
382 if (@f && $dxchan->priv >= 8 && ((is_callsign(uc $f[0]) && DXUser->get(uc $f[0])) || $f[0] =~ /(?:node|user)_default/)) {
384 if ($f[0] eq 'input') {
389 $call = $dxchan->call;
392 if (@f && $f[0] =~ /^\d$/) {
396 $filter = Filter::read_in($sort, $call, $flag);
397 $filter = Filter->new($sort, $call, $flag) if !$filter || $filter->isa('Filter::Old');
403 # do the rest of the filter tokens
420 } elsif ($tok eq ')') {
426 } elsif ($tok eq 'all') {
430 } elsif ($tok eq 'or') {
431 $conj = ' || ' if $conj ne ' || ';
433 } elsif ($tok eq 'and') {
434 $conj = ' && ' if $conj ne ' && ';
436 } elsif ($tok eq 'not' || $tok eq '!') {
442 my @val = split /,/, $val;
452 $user .= "$tok $val";
456 foreach $fref (@$self) {
458 if ($fref->[0] eq $tok) {
462 push @nval, split(',', &{$fref->[4]}($dxchan, $_));
466 if ($fref->[1] eq 'a') {
470 push @t, "\$r->[$fref->[2]]=~/$_/i";
472 $s .= "(" . join(' || ', @t) . ")";
473 } elsif ($fref->[1] eq 'c') {
477 push @t, "\$r->[$fref->[2]]=~/^\U$_/";
479 $s .= "(" . join(' || ', @t) . ")";
480 } elsif ($fref->[1] eq 'n') {
483 return ('num', $dxchan->msg('e21', $_)) unless /^\d+$/;
484 push @t, "\$r->[$fref->[2]]==$_";
486 $s .= "(" . join(' || ', @t) . ")";
487 } elsif ($fref->[1] =~ /^n[ciz]$/ ) { # for DXCC, ITU, CQ Zone
489 my $cmd = $fref->[1];
490 foreach my $v (@val) {
492 push @n, $v unless grep $_ eq $v, @n;
494 my @pre = Prefix::extract($v);
495 return ('numpre', $dxchan->msg('e27', $_)) unless @pre;
497 foreach my $p (@pre) {
498 my $n = $p->dxcc if $cmd eq 'nc' ;
499 $n = $p->itu if $cmd eq 'ni' ;
500 $n = $p->cq if $cmd eq 'nz' ;
501 push @n, $n unless grep $_ eq $n, @n;
505 $s .= "(" . join(' || ', map {"\$r->[$fref->[2]]==$_"} @n) . ")";
506 } elsif ($fref->[1] eq 'r') {
509 return ('range', $dxchan->msg('e23', $_)) unless /^(\d+)\/(\d+)$/;
510 push @t, "(\$r->[$fref->[2]]>=$1 && \$r->[$fref->[2]]<=$2)";
512 $s .= "(" . join(' || ', @t) . ")";
513 } elsif ($fref->[1] eq 't') {
517 push @t, "\$r->[$fref->[2]]=~/$_/i";
519 $s .= "(" . join(' || ', @t) . ")";
521 confess("invalid letter $fref->[1]");
527 return ('unknown', $dxchan->msg('e20', $tok)) unless $found;
529 return ('no', $dxchan->msg('filter2', $tok));
535 # tidy up the user string
536 $user =~ s/\&\&/ and /g;
537 $user =~ s/\|\|/ or /g;
538 $user =~ s/\!/ not /g;
541 return (0, $filter, $fno, $user, "$s");
544 # a filter accept/reject command
547 my ($self, $dxchan, $sort, $type, $line) = @_;
549 return $dxchan->msg('filter5') unless $line;
551 my ($r, $filter, $fno, $user, $s) = $self->parse($dxchan, $sort, $line);
552 my $u = DXUser->get_current($user);
553 return (1, $dxchan->msg('isow', $user)) if $u && $u->isolate;
554 return (1, $filter) if $r;
556 my $fn = "filter$fno";
558 $filter->{$fn} = {} unless exists $filter->{$fn};
559 $filter->{$fn}->{$type} = {} unless exists $filter->{$fn}->{$type};
561 $filter->{$fn}->{$type}->{user} = $user;
562 $filter->{$fn}->{$type}->{asc} = $s;
563 $r = $filter->compile($fn, $type);
571 return (0, $filter, $fno);
583 # the OLD instructions!
585 # Each filter file has the same structure:-
589 # [ action, fieldno, fieldsort, comparison, action data ],
593 # The action is usually 1 or 0 but could be any numeric value
595 # The fieldno is the field no in the list of fields that is presented
598 # The fieldsort is the type of field that we are dealing with which
599 # currently can be 'a', 'n', 'r' or 'd'. 'a' is alphanumeric, 'n' is
600 # numeric, 'r' is ranges of pairs of numeric values and 'd' is default.
602 # Filter::it basically goes thru the list of comparisons from top to
603 # bottom and when one matches it will return the action and the action data as a list.
605 # are the element nos of the list that is presented to Filter::it. Element
606 # 0 is the first field of the list.
610 # takes the reference to the filter (the first argument) and applies
611 # it to the subsequent arguments and returns the action specified.
616 my $filter = $self->{filter}; # this is now a bless ref of course but so what
618 my ($action, $field, $fieldsort, $comp, $actiondata);
621 # default action is 1
624 return ($action, $actiondata) if !$filter;
626 for $ref (@{$filter}) {
627 ($action, $field, $fieldsort, $comp, $actiondata) = @{$ref};
628 if ($fieldsort eq 'n') {
629 my $val = $_[$field];
630 return ($action, $actiondata) if grep $_ == $val, @{$comp};
631 } elsif ($fieldsort eq 'r') {
632 my $val = $_[$field];
634 my @range = @{$comp};
635 for ($i = 0; $i < @range; $i += 2) {
636 return ($action, $actiondata) if $val >= $range[$i] && $val <= $range[$i+1];
638 } elsif ($fieldsort eq 'a') {
639 return ($action, $actiondata) if $_[$field] =~ m{$comp};
641 return ($action, $actiondata); # the default action
651 my $flag = shift || "";
652 return "$call: Old Style Filter $flag $sort";