changed old filter be a hash with a name
[spider.git] / perl / Filter.pm
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..d45f5096ac8e0ab7ef2226ac7052c1dd133a6252 100644 (file)
@@ -0,0 +1,167 @@
+#
+# The User/Sysop Filter module
+#
+# The way this works is that the filter routine is actually
+# a predefined function that returns 0 if it is OK and 1 if it
+# is not when presented with a list of things.
+#
+# This set of routines provide a means of maintaining the filter
+# scripts which are compiled in when an entity connects.
+#
+# Copyright (c) 1999 Dirk Koopman G1TLH
+#
+# $Id$
+#
+# The NEW INSTRUCTIONS
+#
+# use the commands accept/spot|ann|wwv|wcy and reject/spot|ann|wwv|wcy
+# also show/filter spot|ann|wwv|wcy
+#
+# The filters live in a directory tree of their own in $main::root/filter
+#
+# Each type of filter (e.g. spot, wwv) live in a tree of their own so you
+# can have different filters for different things for the same callsign.
+#
+
+
+package Filter;
+
+use DXVars;
+use DXUtil;
+use DXDebug;
+use Data::Dumper;
+
+use strict;
+
+use vars qw ($filterbasefn $in);
+
+$filterbasefn = "$main::root/filter";
+$in = undef;
+
+# initial filter system
+sub init
+{
+
+}
+
+
+# this reads in a filter statement and returns it as a list
+# 
+# The filter is stored in straight perl so that it can be parsed and read
+# in with a 'do' statement. The 'do' statement reads the filter into
+# @in which is a list of references
+#
+sub read_in
+{
+       my ($sort, $call, $flag) = @_;
+
+    # first uppercase
+       $flag = ($flag) ? "in_" : "";
+       $call = uc $call;
+       my $fn = "$filterbasefn/$sort/$flag$call.pl";
+
+       # otherwise lowercase
+       unless (-e $fn) {
+               $call = lc $call;
+               $fn = "$filterbasefn/$sort/$flag$call.pl";
+       }
+       
+       # load it
+       if (-e $fn) {
+               $in = undef; 
+               my $s = readfilestr($fn);
+               my $newin = eval $s;
+               dbg('conn', "$@") if $@;
+               if ($in) {
+                       $newin = bless {filter => $in, name => "$flag$call.pl" }, 'Filter::Old'
+               }
+               return $newin;
+       }
+       return undef;
+}
+
+# this writes out the filter in a form suitable to be read in by 'read_in'
+# It expects a list of references to filter lines
+sub write
+{
+       my $self = shift;
+}
+
+sub print
+{
+       my $self = shift;
+       return $self->{name};
+}
+
+package Filter::Old;
+
+use strict;
+use vars qw(@ISA);
+@ISA = qw(Filter);
+
+# the OLD instructions!
+#
+# Each filter file has the same structure:-
+#
+# <some comment>
+# @in = (
+#      [ action, fieldno, fieldsort, comparison, action data ],
+#      ...
+# );
+#
+# The action is usually 1 or 0 but could be any numeric value
+#
+# The fieldno is the field no in the list of fields that is presented
+# to 'Filter::it' 
+#
+# The fieldsort is the type of field that we are dealing with which 
+# currently can be 'a', 'n', 'r' or 'd'. 'a' is alphanumeric, 'n' is 
+# numeric, 'r' is ranges of pairs of numeric values and 'd' is default.
+#
+# Filter::it basically goes thru the list of comparisons from top to
+# bottom and when one matches it will return the action and the action data as a list. 
+# The fields
+# are the element nos of the list that is presented to Filter::it. Element
+# 0 is the first field of the list.
+#
+
+#
+# takes the reference to the filter (the first argument) and applies
+# it to the subsequent arguments and returns the action specified.
+#
+sub it
+{
+       my $self = shift;
+       my $filter = $self->{filter};            # this is now a bless ref of course but so what
+       
+       my ($action, $field, $fieldsort, $comp, $actiondata);
+       my $ref;
+
+       # default action is 1
+       $action = 1;
+       $actiondata = "";
+       return ($action, $actiondata) if !$filter;
+
+       for $ref (@{$filter}) {
+               ($action, $field, $fieldsort, $comp, $actiondata) = @{$ref};
+               if ($fieldsort eq 'n') {
+                       my $val = $_[$field];
+                       return ($action, $actiondata)  if grep $_ == $val, @{$comp};
+               } elsif ($fieldsort eq 'r') {
+                       my $val = $_[$field];
+                       my $i;
+                       my @range = @{$comp};
+                       for ($i = 0; $i < @range; $i += 2) {
+                               return ($action, $actiondata)  if $val >= $range[$i] && $val <= $range[$i+1];
+                       }
+               } elsif ($fieldsort eq 'a') {
+                       return ($action, $actiondata)  if $_[$field] =~ m{$comp};
+               } else {
+                       return ($action, $actiondata);      # the default action
+               }
+       }
+}
+
+
+1;
+__END__