1

"""

     2

    CLI argument handling; common stuff: logging

     3

"""

     4

     5

import optparse

     6

import logging

     7

     8

import pwd, grp, os, sys

     9

    10

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

    11

    12

def parser (parser) :

    13

    """

    14

        Return an optparse.OptionGroup.

    15

    """

    16

    17

    general = optparse.OptionGroup(parser, "General options")

    18

    19

    general.add_option('-q', '--quiet',     dest='loglevel', action='store_const', const=logging.ERROR, help="Less output")

    20

    general.add_option('-v', '--verbose',   dest='loglevel', action='store_const', const=logging.INFO,  help="More output")

    21

    general.add_option('-D', '--debug',     dest='loglevel', action='store_const', const=logging.DEBUG, help="Even more output")

    22

    general.add_option('--log-file',                                                                    help="Log to file")

    23

    general.add_option('--debug-module',    action='append', metavar='MODULE', 

    24

            help="Enable logging for the given logger/module name")

    25

    26

    general.add_option('--uid',             help="Change uid")

    27

    general.add_option('--gid',             help="Change gid")

    28

    29

    # defaults

    30

    parser.set_defaults(

    31

        logname             = parser.prog,

    32

        loglevel            = logging.WARN,

    33

        debug_module        = [],

    34

    )

    35

    36

    return general

    37

    38

def apply_setid (options, rootok=None) :

    39

    """

    40

        Drop privileges if running as root.

    41

    42

        XXX: this feature isn't very useful (import-time issues etc), but in certain cases (syslog-ng -> python),

    43

        it's difficult to avoid this without some extra wrapper tool..?

    44

    """

    45

    46

    # --uid -> pw

    47

    if not options.uid :

    48

        pw = None

    49

    elif options.uid.isdigit() :

    50

        pw = pwd.getpwuid(int(options.uid))

    51

    else :

    52

        pw = pwd.getpwnam(options.uid)

    53

    54

    # --gid -> gr

    55

    if not options.gid and not pw :

    56

        gr = None

    57

    elif not options.gid :

    58

        gr = grp.getgrgid(pw.pw_gid)

    59

    elif options.gid.isdigit() :

    60

        gr = grp.getgrgid(str(options.gid))

    61

    else :

    62

        gr = grp.getgrnam(options.gid)

    63

    64

    if gr :

    65

        # XXX: secondary groups? seem to get cleared

    66

        log.info("setgid: %s: %s", gr.gr_name, gr.gr_gid)

    67

        os.setgid(gr.gr_gid)

    68

    69

    if pw :

    70

        log.info("setuid: %s: %s", pw.pw_name, pw.pw_uid)

    71

        os.setuid(pw.pw_uid)

    72

    73

    elif os.getuid() == 0 :

    74

        if rootok :

    75

            log.info("running as root")

    76

        else :

    77

            log.error("refusing to run as root, use --uid 0 to override")

    78

            sys.exit(2)

    79

    80

def apply (options, logname=None, rootok=True) :

    81

    """

    82

        Apply the optparse options.

    83

    """

    84

    85

    if logname :

    86

        prefix = options.logname + ': '

    87

    else :

    88

        prefix = ''

    89

    90

    # configure

    91

    logging.basicConfig(

    92

        # XXX: log Class.__init__ as Class, not __init__?

    93

        format      = prefix + '%(name)-20s: %(levelname)5s %(funcName)s: %(message)s',

    94

        level       = options.loglevel,

    95

        filename    = options.log_file,

    96

    )

   100

   101

    if options.uid or options.gid or not rootok :

   102

        # set uid/gid

   103

        apply_setid(options, rootok=rootok)

   104

   105

    # enable debugging for specific targets

   106

    for logger in options.debug_module :

   107

        logging.getLogger(logger).setLevel(logging.DEBUG)

   108