From 817a7c757fc641e02a6fc13e04a61d3307b0ce8b Mon Sep 17 00:00:00 2001 From: "martin f. krafft" Date: Sun, 30 Sep 2007 17:30:43 +0100 Subject: [PATCH] add verbose mode and cleanup warnings/errors --- mailplate | 128 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 81 insertions(+), 47 deletions(-) diff --git a/mailplate b/mailplate index 6410670..439fc73 100755 --- a/mailplate +++ b/mailplate @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # -# mailplate — apply templates to mail drafts. +# mailplate — reformat mail drafts according to templates # # This script reformats mail drafts according to a given template. The # template may be specified on the command line, but mailplate can also use @@ -42,10 +42,17 @@ # TODO: if headers like From are absent from the mail, they should not be kept # but replaced with a default. # -# Copyright © martin f. krafft +# Copyright © martin f. krafft # Released under the terms of the Artistic Licence 2.0 # +__name__ = 'mailplate' +__description__ = 'reformat mail drafts according to templates' +__version__ = '0.1' +__author__ = 'martin f. krafft ' +__copyright__ = 'Copyright © ' + __author__ +__licence__ = 'Artistic Licence 2.0' + import email import os import posix @@ -88,7 +95,14 @@ SIG_DELIM='\n-- \n' ### def err(s): - sys.stderr.write(s + '\n') + sys.stderr.write('E: ' + s + '\n') + +def warn(s): + sys.stderr.write('W: ' + s + '\n') + +def info(s): + if not options.verbose: return + sys.stderr.write('I: ' + s + '\n') # obtain a regexp from a line, run it, return score/dict if matched def exec_regexp(line, rawmsg, name): @@ -110,7 +124,7 @@ def exec_command(line, rawmsg, name): else: return 0 except OSError: - err("W: command '%s' (template '%s') failed to run." % (r, name)) + warn("command '%s' (template '%s') failed to run." % (r, name)) return 0 def interpolate_helpers(s): @@ -125,7 +139,7 @@ def interpolate_helpers(s): out = proc.communicate()[0] s = s[:helper_begin] + out.strip() + s[helper_end+1:] except KeyError: - err('E: unknown helper: ' + helper) + err('unknown helper: ' + helper) sys.exit(posix.EX_DATAERR) return s @@ -162,6 +176,50 @@ vars = {} headers = {} payload = None +### +### COMMAND LINE PARSING +### + +parser = OptionParser() +parser.prog = __name__ +parser.version = __version__ +parser.description = __description__ +parser.usage = '%prog [options] ' +parser.add_option('-a', '--auto', dest='auto', + default=False, action='store_true', + help='turn on template auto-discovery') +parser.add_option('-m', '--menu', dest='menu', + default=False, action='store_true', + help='choose from a list of templates (not yet implemented)') +parser.add_option('-n', '--new', dest='new', + default=False, action='store_true', + help='create a new message') +parser.add_option('-e', '--editor', dest='edit', + default=False, action='store_true', + help='spawn editor once template is applied') +parser.add_option('-k', '--keep-unknown', dest='keep_unknown', + default=False, action='store_true', + help='preserve mail headers not specified in template') +parser.add_option('-v', '--verbose', dest='verbose', + default=False, action='store_true', + help='write informational messages to stderr') +parser.add_option('-d', '--debug', dest='debug', + default=False, action='store_true', + help='start a debugger after initialisation') +parser.add_option('-V', '--version', dest='version', + default=False, action='store_true', + help='display version information') + +options, args = parser.parse_args() + +if options.version: + print __name__, __version__ + ' — ' + __description__ + print + print 'Written by ' + __author__ + print __copyright__ + print 'Released under the ' + __licence__ + sys.exit(posix.EX_OK) + ### ### CONFIGURATION FILE PARSING ### @@ -179,13 +237,15 @@ if not os.path.exists(CONFFILE): # conffile does not exist, let's create it with defaults. if not os.path.isdir(MAILPLATEDIR): + info('configuration directory not found, creating: ' + MAILPLATEDIR) os.mkdir(MAILPLATEDIR, 0700) if not os.path.isfile(CONFFILE): + info('creating a default configuration file: ' + CONFFILE) f = file(CONFFILE, 'w') f.write('# mailplate configuration\n[%s]\n' % SECTION_GENERAL) for kvpair in config.iteritems(): - if kvpair[1] and len(kvpair[1]) > 0: + if len(kvpair[1]) > 0: f.write('%s = %s\n' % kvpair) if len(helpers) > 0: @@ -196,7 +256,7 @@ if not os.path.exists(CONFFILE): f.close() if not os.access(CONFFILE, os.R_OK): - err('E: cannot read configuration file: %s' % CONFFILE) + err('cannot read configuration file: %s' % CONFFILE) sys.exit(posix.EX_OSFILE) # now parse @@ -208,12 +268,12 @@ for key in config.keys(): try: config[key] = parser.get(SECTION_GENERAL, key) except ConfigParser.NoSectionError, ConfigParser.MissingSectionHeaderError: - err("E: no section '%s' in %s" % (SECTION_GENERAL, CONFFILE)) + err("no section '%s' in %s" % (SECTION_GENERAL, CONFFILE)) sys.exit(posix.EX_CONFIG) except ConfigParser.NoOptionError: continue except ConfigParser.DuplicateSectionError, ConfigParser.ParseError: - err('E: parse error on %s' % CONFFILE) + err('parse error on %s' % CONFFILE) sys.exit(posix.EX_CONFIG) # all HELPERS into the helpers dict @@ -221,43 +281,18 @@ helpers.update(parser.items(SECTION_HELPERS)) TPATH = os.path.expanduser(config['template_path']) if not os.path.isdir(TPATH): + info('creating template directory: ' + TPATH) os.mkdir(TPATH, 0700) default_templname = config['default_template'] if default_templname is not None: default_templpath = os.path.join(TPATH, default_templname) if not os.path.isfile(default_templpath): + info('creating the default template: ' + default_templpath) f = file(default_templpath, 'w') f.write('@KEEP_STD_HEADERS\n\n@KEEP_BODY\n') f.close() -### -### COMMAND LINE PARSING -### - -parser = OptionParser() -parser.usage = '%prog [options] ' -parser.add_option('-a', '--auto', dest='auto', - default=False, action='store_true', - help='turn on template auto-discovery') -parser.add_option('-m', '--menu', dest='menu', - default=False, action='store_true', - help='choose from a list of template') -parser.add_option('-n', '--new', dest='new', - default=False, action='store_true', - help='create a new message') -parser.add_option('-e', '--editor', dest='edit', - default=False, action='store_true', - help='spawn editor once template is applied') -parser.add_option('-k', '--keep-unknown', dest='keep_unknown', - default=False, action='store_true', - help='preserve mail headers not specified in template') -parser.add_option('-d', '--debug', dest='debug', - default=False, action='store_true', - help='start a debugger after initialisation') - -options, args = parser.parse_args() - if options.debug: import pdb pdb.set_trace() @@ -277,24 +312,24 @@ for arg in args: # argument referenced an existing template templname = arg else: - err('E: unknown argument: %s' % arg) + err('unknown argument, and cannot find a template by this name: %s' % arg) sys.exit(posix.EX_USAGE) # sanity checks if options.auto and options.menu: - err('E: cannot combine --auto and --menu') + err('cannot combine --auto and --menu') sys.exit(posix.EX_USAGE) elif (options.auto or options.menu) and templname: - err('E: cannot specify a template with --auto or --menu') + err('cannot specify a template with --auto or --menu') sys.exit(posix.EX_USAGE) elif not templname and not (options.auto or options.menu): - err('E: no template specified') + err('no template specified') sys.exit(posix.EX_USAGE) elif options.menu: - err('E: --menu mode not yet implemented') + err('--menu mode not yet implemented') sys.exit(posix.EX_USAGE) ### @@ -339,22 +374,21 @@ if options.auto: templname = best_score[1] if templname is None: - err('E: could not determine a template to use and no default is set') + err('could not determine a template to use and no default is set') sys.exit(posix.EX_CONFIG) - print >>sys.stderr, \ - 'I: Chose profile %s with score %d.' % (templname, best_score[0]) + info('chose profile %s with score %d.' % (templname, best_score[0])) vars = best_score[2] # now read in the template templpath = os.path.join(TPATH, templname) if not os.path.isfile(templpath): - err('E: not a template: ' + templpath) + err('not a template: ' + templpath) sys.exit(posix.EX_OSFILE) elif not os.access(templpath, os.R_OK): - err('E: template ' + templpath + ' could not be read.') + err('template ' + templpath + ' could not be read.') sys.exit(posix.EX_OSFILE) templ = file(templpath, 'r', 1) @@ -453,7 +487,7 @@ outf.close() if options.edit: # finally, spawn the editor, if we wrote into a file if outfname is None: - err('E: cannot use --edit without an output file.') + err('cannot use --edit without an output file.') sys.exit(posix.EX_USAGE) os.execlp('sensible-editor', 'sensible-editor', outfname) -- 2.39.2