1

import optparse, sys

     2

     3

from pvl.syslog.parser import SyslogParser

     4

from pvl.syslog.filter import SyslogFilter

     5

from pvl.syslog.syslog import SyslogSource

     6

from pvl.syslog import fifo, tail, file

     7

     8

# XXX: use optparse parser.error()?

     9

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

    10

    11

def parser (parser, prog=None) :

    12

    """

    13

        Optparse option group

    14

    15

            prog        - filter to only process lines from given process

    16

    """

    17

    18

    syslog = optparse.OptionGroup(parser, 'Syslog collector')

    19

    20

    syslog.add_option('--syslog-fifo',          metavar='PATH',

    21

            help="Read syslog messages from given fifo")

    22

    23

    syslog.add_option('--syslog-file',          metavar='FILE',

    24

            help="Read syslog messages from given file")

    25

    26

    syslog.add_option('--syslog-tail',          metavar='FILE',

    27

            help="Continuously poll syslog messages given file")

    28

    29

    syslog.add_option('--syslog-stdin',         action='store_true',

    30

            help="Read syslog messages from stdin")

    31

    32

    syslog.add_option('--syslog-raw',           action='store_true',

    33

            help="Parse raw syslog lines without timestamp/etc")

    34

    35

    syslog.add_option('--syslog-facility',      metavar='FACILITY',

    36

            help="Set/filter by given facility")

    37

    38

    syslog.add_option('--syslog-severity',      metavar='SEVERITY',

    39

            help="Set given facility")

    40

    41

    syslog.add_option('--syslog-prog',          metavar='PROG',     default=prog,

    42

            help="Filter by given prog: %default")

    43

    44

    return syslog

    45

    46

def apply (options, optional=False) :

    47

    """

    48

        Handle options, returning a SyslogSource, if any.

    49

    50

        May log.error/sys.exit

    51

    """

    52

    53

    # XXX: this belongs in pvl.syslog.source

    54

    if options.syslog_fifo :

    55

        # fifo pipe

    56

        source = fifo.Fifo(options.syslog_fifo)

    57

        poll = True # select(source)

    58

    59

    elif options.syslog_tail :

    60

        # tail file

    61

        source = tail.Tail(options.syslog_tail, skip=True)

    62

        poll = tail.Tail.POLL # select(float)

    63

    64

    elif options.syslog_file :

    65

        # read file

    66

        source = file.File(open(options.syslog_file))

    67

        poll = False # do not loop, just read up to EOF

    68

    69

    elif options.syslog_stdin :

    70

        # read pipe

    71

        source = fifo.Pipe.file(sys.stdin) # puts stdin into non-blocking mode

    72

        poll = True # select(source)

    73

    74

    elif optional :

    75

        return None

    76

    77

    else :

    78

        # from stdin

    79

        if sys.stdin.isatty() :

    80

            log.warning("Reading syslog messages from TTY?")

    81

    82

        source = file.File(sys.stdin)

    83

        poll = False # XXX: tty vs pipe vs file? False -> just block

    84

    85

    # options

    86

    parser = SyslogParser(

    87

        raw         = options.syslog_raw,

    88

        facility    = options.syslog_facility,

    89

        severity    = options.syslog_severity,

    90

    )

    91

    92

    # TODO: filter optional

    93

    filter = SyslogFilter.build(

    94

        # glob pattern

    95

        prog        = options.syslog_prog,

    96

        facility    = options.syslog_facility,

    97

        #severity   = options.sylog_severity,   # XXX: match as greater-than?

    98

    )

    99

   100

    # polling

   101

    return SyslogSource(source, parser, filter, poll)