1

"""

     2

    Syslog handling.

     3

"""

     4

     5

import select

     6

     7

import logging; log = logging.getLogger('pvl.syslog.source')

     8

     9

class SyslogSource (object) :

    10

    """

    11

        Process syslog input from a given source.

    12

    13

        Implements an iterable mainloop doing continuous polling on the source, using either a timeout or

    14

        select():able source.

    15

    """

    16

    17

    def __init__ (self, source, parser, filter, poll=None) :

    18

        """

    19

            Using given underlying line source.

    20

    21

                source      - source to select() if poll=True

    22

                poll        - polling behaviour

    23

        """

    24

    25

        self.source = source

    26

        self.parser = parser

    27

        self.filter = filter

    28

    29

        self._poll = poll

    30

    32

        """

    33

            Yield available input.

    34

        """

    35

    36

        return self.filter(self.parser(self.source))

    37

    38

    def poll (self, poll=None) :

    39

        """

    40

            Poll our source for input, with given polling behaviour:

    41

                True    - select() on source

    42

                False   - peek on source

    43

                float   - timeout in seconds

    44

    45

            Returns True if we have input waiting, False on timeout with no input. None on indeterminate.

    46

        """

    47

    48

        reading = writing = ()

    49

    50

        if poll is True :

    51

            timeout = None # block

    52

            reading += (self.source, ) # file-like object with fileno()

    53

    54

        elif not poll :

    55

            timeout = 0.0 # do not block

    56

    57

        else :

    58

            timeout = float(poll)

    59

    60

        log.debug("%s", timeout)

    61

    62

        # select

    63

        readable, writeable, ex = select.select(reading, writing, [], timeout)

    64

    65

        if readable :

    66

            return True

    67

    68

        elif reading :

    69

            # timeout

    70

            return False

    71

    72

        else :

    73

            # unknown

    74

            return None

    75

    76

    def main (self, poll=None) :

    77

        """

    78

            yield items from syslog source, polling as given.

    79

    80

            Returns once no more lines are available.

    81

    82

            XXX: reconnect? or source takes care of that..

    83

            TODO: SIGINT -> finish iteration and return?

    84

        """

    85

    86

        if poll is None :

    87

            poll = self._poll

    88

    89

        # mainloop

    90

        while True :

    91

            # pull in messages

    93

                log.debug("%s", item)

    94

                yield item

    95

    96

            # poll

    97

            if poll :

    98

                # wait

    99

                self.poll(poll)

   100

            else :

   101

                # done

   102

                break

   103

   104

        log.debug("exit")

   105