pvl/syslog/filter.py
author Tero Marttila <terom@fixme.fi>
Fri, 04 Jan 2013 23:47:31 +0200
changeset 68 bea41de5cc98
parent 65 be2b407c06ff
child 74 952ee07efd7a
permissions -rw-r--r--
pvl.syslog.filter: reject empty progs
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
import logging; log = logging.getLogger('pvl.syslog.filter')
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
     3
import re # XXX
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
     4
import os.path, fnmatch
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
     5
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
class SyslogFilter (object) :
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
    """
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
     8
        Match syslog messages fields against given patterns.
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
    """
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    11
    def __init__ (self, **filters) :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
        """
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    13
            Match using given { field: regex }.
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
        """
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    15
        
61
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
    16
        # drop None's
65
be2b407c06ff pvl.syslog: fixfix
Tero Marttila <terom@fixme.fi>
parents: 61
diff changeset
    17
        self.filters = dict((attr, regex) for attr, regex in filters.iteritems() if regex is not None)
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    19
    def match_prog (self, attr, glob, prog=None) :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    20
        """
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    21
            XXX: Match given prog as glob?
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    22
        """
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    23
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    24
        if not glob :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    25
            # ignore
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    26
            return None
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    27
68
bea41de5cc98 pvl.syslog.filter: reject empty progs
Tero Marttila <terom@fixme.fi>
parents: 65
diff changeset
    28
        if not prog :
bea41de5cc98 pvl.syslog.filter: reject empty progs
Tero Marttila <terom@fixme.fi>
parents: 65
diff changeset
    29
            # require
bea41de5cc98 pvl.syslog.filter: reject empty progs
Tero Marttila <terom@fixme.fi>
parents: 65
diff changeset
    30
            return False
bea41de5cc98 pvl.syslog.filter: reject empty progs
Tero Marttila <terom@fixme.fi>
parents: 65
diff changeset
    31
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
        # normalize
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    33
        prog = prog.strip().lower()
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    34
        _, prog = os.path.split(prog)
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
        # match
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    37
        if fnmatch.fnmatch(prog, glob) :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    38
            return { attr: prog }
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    39
        else :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
            return False
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    42
    def match (self, attr, regex, value=None) :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    43
        """
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    44
            Match given value against given pattern.
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    45
        """
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    47
        if not regex :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    48
            # ignore
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    49
            return None
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    50
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    51
        if not value :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    52
            # XXX: optional = match empty string?
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    53
            value = ''
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    54
        else :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    55
            # normalize; XXX: unicode?
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    56
            value = str(value).strip()
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    57
        
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    58
        # match
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    59
        match = regex.match(value)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    60
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    61
        if not match :
56
ff184e09ceb9 pvl.syslog.filter: fix true/false/filenotfound snafu
Tero Marttila <terom@fixme.fi>
parents: 54
diff changeset
    62
            return False
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    63
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    64
        # as match-values
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    65
        matches = match.groupdict()
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    66
        matches[attr] = match.group(0) # whole match
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    67
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    68
        # TODO match.expand?
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    69
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    70
        return matches
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    71
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
    def filter (self, item) :
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    73
        """
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    74
            Match given item. Returns any matched values (including regexp capture groups) across all fields.
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    75
        """
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    76
57
c88861dda326 pvl.syslog.filter: fix empty filters
Tero Marttila <terom@fixme.fi>
parents: 56
diff changeset
    77
        match = None
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    78
        matches = {}
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    79
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    80
        for attr in self.filters :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    81
            # lookup match-func
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    82
            match = getattr(self, 'match_{attr}'.format(attr=attr), self.match)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    83
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    84
            # filter
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    85
            filter = self.filters[attr]
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    86
            
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    87
            # apply match
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    88
            if attr in item :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    89
                match = match(attr, filter, item[attr])
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    90
            else :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    91
                match = match(attr, filter)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    92
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    93
            log.debug("%s: %s", attr, match)
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    94
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    95
            if match :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    96
                # match
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    97
                matches.update(match)
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    98
            
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    99
            elif match is None :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   100
                # ignore
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   101
                continue
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   102
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   103
            else :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   104
                # reject
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   105
                return
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   106
        
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   107
        # XXX: test last match, in case they were all None
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   108
        if match is None :
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   109
            # XXX: empty filter!?
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   110
            return True
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   111
        else :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   112
            return matches
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   113
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   114
    def process (self, items) :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   115
        for item in items:
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   116
            match = self.filter(item)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   117
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   118
            if match :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   119
                yield item
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   120
    
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   121
    __call__ = process
61
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   122
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   123
    def __nonzero__ (self) :
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   124
        return bool(self.filters)
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   125
65
be2b407c06ff pvl.syslog: fixfix
Tero Marttila <terom@fixme.fi>
parents: 61
diff changeset
   126
    def __repr__ (self) :
be2b407c06ff pvl.syslog: fixfix
Tero Marttila <terom@fixme.fi>
parents: 61
diff changeset
   127
        return repr(self.filters)