terom@0: """
terom@0:     CLI argument handling; common stuff: logging
terom@0: """
terom@0: 
terom@0: import optparse
terom@0: import logging
terom@0: 
terom@96: import pwd, grp, os, sys
terom@96: 
terom@96: import logging; log = logging.getLogger('pvl.args')
terom@96: 
terom@0: def parser (parser) :
terom@0:     """
terom@0:         Return an optparse.OptionGroup.
terom@0:     """
terom@0: 
terom@0:     general = optparse.OptionGroup(parser, "General options")
terom@0: 
terom@0:     general.add_option('-q', '--quiet',     dest='loglevel', action='store_const', const=logging.ERROR, help="Less output")
terom@0:     general.add_option('-v', '--verbose',   dest='loglevel', action='store_const', const=logging.INFO,  help="More output")
terom@0:     general.add_option('-D', '--debug',     dest='loglevel', action='store_const', const=logging.DEBUG, help="Even more output")
terom@86:     general.add_option('--log-file',                                                                    help="Log to file")
terom@0:     general.add_option('--debug-module',    action='append', metavar='MODULE', 
terom@0:             help="Enable logging for the given logger/module name")
terom@96:     
terom@96:     general.add_option('--uid',             help="Change uid")
terom@96:     general.add_option('--gid',             help="Change gid")
terom@0: 
terom@0:     # defaults
terom@0:     parser.set_defaults(
terom@0:         logname             = parser.prog,
terom@0:         loglevel            = logging.WARN,
terom@0:         debug_module        = [],
terom@0:     )
terom@0:  
terom@0:     return general
terom@0: 
terom@96: def apply_setid (options, rootok=None) :
terom@96:     """
terom@96:         Drop privileges if running as root.
terom@96: 
terom@96:         XXX: this feature isn't very useful (import-time issues etc), but in certain cases (syslog-ng -> python),
terom@96:         it's difficult to avoid this without some extra wrapper tool..?
terom@96:     """
terom@96: 
terom@96:     # --uid -> pw
terom@96:     if not options.uid :
terom@96:         pw = None
terom@96:     elif options.uid.isdigit() :
terom@96:         pw = pwd.getpwuid(int(options.uid))
terom@96:     else :
terom@96:         pw = pwd.getpwnam(options.uid)
terom@96: 
terom@96:     # --gid -> gr
terom@96:     if not options.gid and not pw :
terom@96:         gr = None
terom@96:     elif not options.gid :
terom@96:         gr = grp.getgrgid(pw.pw_gid)
terom@96:     elif options.gid.isdigit() :
terom@96:         gr = grp.getgrgid(str(options.gid))
terom@96:     else :
terom@96:         gr = grp.getgrnam(options.gid)
terom@96:     
terom@96:     if gr :
terom@96:         # XXX: secondary groups? seem to get cleared
terom@96:         log.info("setgid: %s: %s", gr.gr_name, gr.gr_gid)
terom@96:         os.setgid(gr.gr_gid)
terom@96: 
terom@96:     if pw :
terom@96:         log.info("setuid: %s: %s", pw.pw_name, pw.pw_uid)
terom@96:         os.setuid(pw.pw_uid)
terom@96:     
terom@96:     elif os.getuid() == 0 :
terom@96:         if rootok :
terom@96:             log.info("running as root")
terom@96:         else :
terom@96:             log.error("refusing to run as root, use --uid 0 to override")
terom@96:             sys.exit(2)
terom@96: 
terom@96: def apply (options, logname=None, rootok=True) :
terom@0:     """
terom@0:         Apply the optparse options.
terom@0:     """
terom@0: 
terom@0:     if logname :
terom@0:         prefix = options.logname + ': '
terom@0:     else :
terom@0:         prefix = ''
terom@0: 
terom@0:     # configure
terom@0:     logging.basicConfig(
terom@0:         # XXX: log Class.__init__ as Class, not __init__?
terom@86:         format      = prefix + '%(name)-20s: %(levelname)5s %(funcName)s: %(message)s',
terom@86:         level       = options.loglevel,
terom@86:         filename    = options.log_file,
terom@0:     )
terom@187: 
terom@187:     # TODO: use --quiet for stdout output?
terom@187:     options.quiet = options.loglevel > logging.WARN
terom@96:     
terom@96:     if options.uid or options.gid or not rootok :
terom@96:         # set uid/gid
terom@96:         apply_setid(options, rootok=rootok)
terom@0: 
terom@0:     # enable debugging for specific targets
terom@0:     for logger in options.debug_module :
terom@0:         logging.getLogger(logger).setLevel(logging.DEBUG)
terom@96: