Merge pull request #35 from gentoo/dol-sen-PR

Dol sen pr, new glepcheck action and other fixes

1 files changed, 253 insertions, 0 deletions

diff --git a/gkeys/base.py b/gkeys/base.py
new file mode 100644
index 0000000..95142f9
--- /dev/null
+++ b/gkeys/base.py
@@ -0,0 +1,253 @@
+#
+#-*- coding:utf-8 -*-
+
+"""
+    Gentoo-keys - base.py
+
+    Command line interface argsparse options module
+    and common functions
+
+    @copyright: 2012 by Brian Dolbec <dol-sen@gentoo.org>
+    @license: GNU GPL2, see COPYING for details.
+"""
+
+from __future__ import print_function
+
+
+import argparse
+
+from gkeys import config, fileops, seed, lib
+from gkeys.log import log_levels, set_logger
+
+
+class CliBase(object):
+    '''Common cli and argsparse options class'''
+
+
+    def __init__(self):
+        self.cli_config = {
+            'Actions': [],
+            'Available_Actions': [],
+            'Action_Options': [],
+            'prog': 'gkeys',
+            'description': 'Gentoo-keys manager program',
+            'epilog': '''Caution: adding untrusted keys to these keyrings can
+                be hazardous to your system!'''
+        }
+        self.config = None
+        self.args = None
+        self.seeds = None
+        self.actions = None
+
+
+    @staticmethod
+    def _option_dest(parser=None):
+        parser.add_argument('-d', '--dest', dest='destination', default=None,
+            help='The destination seed file or keydir for move, copy operations')
+
+    @staticmethod
+    def _option_fingerprint(parser=None):
+        parser.add_argument('-f', '--fingerprint', dest='fingerprint',
+            default=None, nargs='+',
+            help='The fingerprint of the the key')
+
+    @staticmethod
+    def _option_gpgsearch(parser=None):
+        parser.add_argument('-g', '--gpgsearch', dest='gpgsearch', default=None,
+            help='Do a gpg search operations, rather than a gkey search')
+
+    @staticmethod
+    def _option_keyid(parser=None):
+        parser.add_argument('-i', '--keyid', dest='keyid', default=None,
+            nargs='+',
+            help='The long keyid of the gpg key to search for')
+
+    @staticmethod
+    def _option_keyring(parser=None):
+        parser.add_argument('-k', '--keyring', dest='keyring', default='trusted_keyring',
+            help='The name of the keyring to use')
+
+    @staticmethod
+    def _option_nick(parser=None):
+        parser.add_argument('-n', '--nick', dest='nick', default=None,
+            help='The nick associated with the the key')
+
+    @staticmethod
+    def _option_name(parser=None):
+        parser.add_argument('-N', '--name', dest='name', nargs='*',
+            default=None, help='The name of the the key')
+
+    @staticmethod
+    def _option_category(parser=None):
+        parser.add_argument('-C', '--category',
+            choices=['rel', 'dev', 'overlays', 'sign'], dest='category', default=None,
+            help='The key or seed directory category to use or update')
+
+    @staticmethod
+    def _option_cleankey(parser=None):
+        parser.add_argument('--clean-key',
+            dest='cleankey', default=False,
+            help='Clean the key from the keyring due to failures')
+
+    @staticmethod
+    def _option_cleanseed(parser=None):
+        parser.add_argument('--clean-seed',
+            dest='cleanseed', default=False,
+            help='Clean the seed from the seedfile due to failures.  '
+                'Used during binary keyring release creation.')
+
+    @staticmethod
+    def _option_keydir(parser=None):
+        parser.add_argument('-r', '--keydir', dest='keydir', default=None,
+            help='The keydir to use, update or search for/in')
+
+    @staticmethod
+    def _option_seedfile(parser=None):
+        parser.add_argument('-S', '--seedfile', dest='seedfile', default=None,
+            help='The seedfile to use from the gkeys.conf file')
+
+    @staticmethod
+    def _option_file(parser=None):
+        parser.add_argument('-F', '--file', dest='filename', default=None,
+            nargs='+',
+            help='The path/URL to use for the (signed) file')
+
+    @staticmethod
+    def _option_1file(parser=None):
+        parser.add_argument('-F', '--file', dest='filename', default=None,
+            help='The path/URL to use for the (signed) file')
+
+    @staticmethod
+    def _option_signature(parser=None):
+        parser.add_argument('-s','--signature', dest='signature', default=None,
+           help='The path/URL to use for the signature')
+
+    @staticmethod
+    def _option_timestamp(parser=None):
+        parser.add_argument('-t', '--timestamp', dest='timestamp', type=bool,
+            default=False,
+            help='Turn on timestamp use')
+
+    @staticmethod
+    def _option_mail(parser=None):
+        parser.add_argument('-m', '--mail', dest='mail', default=None,
+            help='The email address to search for')
+
+    @staticmethod
+    def _option_status(parser=None):
+        parser.add_argument('-A', '--status', default=False,
+            help='The active status of the member')
+
+
+    def parse_args(self, args):
+        '''Parse a list of aruments
+
+        @param args: list
+        @returns argparse.Namespace object
+        '''
+        #logger.debug('CliBase: parse_args; args: %s' % args)
+        parser = argparse.ArgumentParser(
+            prog=self.cli_config['prog'],
+            description=self.cli_config['description'],
+            epilog=self.cli_config['epilog'])
+
+        # options
+        parser.add_argument('-c', '--config', dest='config', default=None,
+            help='The path to an alternate config file')
+        parser.add_argument('-D', '--debug', default='DEBUG',
+            choices=list(log_levels),
+            help='The logging level to set for the logfile')
+
+
+        subparsers = parser.add_subparsers(help='actions')
+        for name in self.cli_config['Available_Actions']:
+            action_method = getattr(self.cli_config['Actions'], name)
+            actiondoc = action_method.__doc__
+            try:
+                text = actiondoc.splitlines()[0]
+            except AttributeError:
+                text = ""
+            action_parser = subparsers.add_parser(
+                name,
+                help=text,
+                description=actiondoc,
+                formatter_class=argparse.RawDescriptionHelpFormatter)
+            action_parser.set_defaults(action=name)
+            self._add_options(action_parser, self.cli_config['Action_Options'][name])
+
+        return parser.parse_args(args)
+
+
+    def _add_options(self, parser, options):
+        for opt in options:
+            getattr(self, '_option_%s' % opt)(parser)
+
+
+    def run(self, args):
+        '''Run the args passed in
+
+        @param args: list or argparse.Namespace object
+        '''
+        global logger
+        message = None
+        if not args:
+            message = "Main: run; invalid args argument passed in"
+        if isinstance(args, list):
+            args = self.parse_args(args)
+        if args.config:
+            self.config.defaults['config'] = args.config
+        # now make it load the config file
+        self.config.read_config()
+
+        # establish our logger and update it in the imported files
+        logger = set_logger('gkeys', self.config['logdir'], args.debug,
+            dirmode=int(self.config.get_key('permissions', 'directories'),0),
+            filemask=int(self.config.get_key('permissions', 'files'),0))
+        config.logger = logger
+        fileops.logger = logger
+        seed.logger = logger
+        lib.logger = logger
+
+        if message:
+            logger.error(message)
+
+        # now that we have a logger, record the alternate config setting
+        if args.config:
+            logger.debug("Main: run; Found alternate config request: %s"
+                % args.config)
+
+        # establish our actions instance
+        self.actions = self.cli_config['Actions'](self.config, self.output_results, logger)
+
+        # run the action
+        func = getattr(self.actions, '%s' % args.action)
+        logger.debug('Main: run; Found action: %s' % args.action)
+        success, results = func(args)
+        if not results:
+            print("No results found.  Check your configuration and that the",
+                "seed file exists.")
+            return success
+        if self.config.options['print_results'] and 'done' not in list(results):
+            self.output_results(results, '\n Gkey task results:')
+        return success
+
+
+    @staticmethod
+    def output_results(results, header):
+        # super simple output for the time being
+        if header:
+            print(header)
+        for msg in results:
+            if isinstance(msg, str) or isinstance(msg, unicode):
+                print('    ', msg)
+            else:
+                try:
+                    print("\n".join([x.pretty_print for x in msg]))
+                except AttributeError:
+                    for x in msg:
+                        print('    ', x)
+        print()
+
+
+    def output_failed(self, failed):
+        pass