pvl/syslog/filter.py
author Tero Marttila <terom@fixme.fi>
Fri, 04 Jan 2013 22:25:20 +0200
changeset 65 be2b407c06ff
parent 61 cd33c2b53d69
child 68 bea41de5cc98
permissions -rw-r--r--
pvl.syslog: fixfix
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
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
        # normalize
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    29
        prog = prog.strip().lower()
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    30
        _, prog = os.path.split(prog)
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
        # match
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    33
        if fnmatch.fnmatch(prog, glob) :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    34
            return { attr: prog }
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    35
        else :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
            return False
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    38
    def match (self, attr, regex, value=None) :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    39
        """
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    40
            Match given value against given pattern.
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    41
        """
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    43
        if not regex :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    44
            # ignore
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    45
            return None
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    46
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    47
        if not value :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    48
            # XXX: optional = match empty string?
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    49
            value = ''
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
        else :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    51
            # normalize; XXX: unicode?
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    52
            value = str(value).strip()
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    53
        
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    54
        # match
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    55
        match = regex.match(value)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    56
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    57
        if not match :
56
ff184e09ceb9 pvl.syslog.filter: fix true/false/filenotfound snafu
Tero Marttila <terom@fixme.fi>
parents: 54
diff changeset
    58
            return False
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    59
54
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    60
        # as match-values
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    61
        matches = match.groupdict()
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    62
        matches[attr] = match.group(0) # whole match
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    63
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    64
        # TODO match.expand?
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    65
9c82a068f8f9 pvl.syslog.filter: fixfix
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    66
        return matches
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    67
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    68
    def filter (self, item) :
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    69
        """
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    70
            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
    71
        """
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
57
c88861dda326 pvl.syslog.filter: fix empty filters
Tero Marttila <terom@fixme.fi>
parents: 56
diff changeset
    73
        match = None
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    74
        matches = {}
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    75
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    76
        for attr in self.filters :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    77
            # lookup match-func
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    78
            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
    79
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    80
            # filter
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    81
            filter = self.filters[attr]
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    82
            
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    83
            # apply match
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    84
            if attr in item :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    85
                match = match(attr, filter, item[attr])
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    86
            else :
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    87
                match = match(attr, filter)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    88
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    89
            log.debug("%s: %s", attr, match)
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    90
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    91
            if match :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    92
                # match
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    93
                matches.update(match)
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    94
            
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
    95
            elif match is None :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    96
                # ignore
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
    97
                continue
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
            else :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   100
                # reject
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   101
                return
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   102
        
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   103
        # XXX: test last match, in case they were all None
45
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   104
        if match is None :
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   105
            # XXX: empty filter!?
10dfa434da77 pvl.syslog: SyslogRule
Tero Marttila <terom@fixme.fi>
parents: 44
diff changeset
   106
            return True
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   107
        else :
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   108
            return matches
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   109
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   110
    def process (self, items) :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   111
        for item in items:
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   112
            match = self.filter(item)
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   113
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   114
            if match :
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   115
                yield item
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   116
    
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 45
diff changeset
   117
    __call__ = process
61
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   118
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   119
    def __nonzero__ (self) :
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   120
        return bool(self.filters)
cd33c2b53d69 pvl.syslog.filter: ignore None-filters
Tero Marttila <terom@fixme.fi>
parents: 57
diff changeset
   121
65
be2b407c06ff pvl.syslog: fixfix
Tero Marttila <terom@fixme.fi>
parents: 61
diff changeset
   122
    def __repr__ (self) :
be2b407c06ff pvl.syslog: fixfix
Tero Marttila <terom@fixme.fi>
parents: 61
diff changeset
   123
        return repr(self.filters)