X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=devel%2Fnmbug%2Fnmbug-status;h=a289798e3cc18559584de5cccda81d0f95c4e392;hp=6aa258325fa285c3854cb10c95a7540efa196b08;hb=8b35b8f71aec56232a3d305aff6cf315bf31331e;hpb=98cb4779c02a07c0405073ca4a1e8a9006844904 diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status index 6aa25832..a289798e 100755 --- a/devel/nmbug/nmbug-status +++ b/devel/nmbug/nmbug-status @@ -1,11 +1,30 @@ #!/usr/bin/python # # Copyright (c) 2011-2012 David Bremner -# License: Same as notmuch +# # dependencies # - python 2.6 for json # - argparse; either python 2.7, or install separately -# - collections.OrderedDict; python 2.7 +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see http://www.gnu.org/licenses/ . + +"""Generate HTML for one or more notmuch searches. + +Messages matching each search are grouped by thread. Each message +that contains both a subject and message-id will have the displayed +subject link to the Gmane view of the message. +""" from __future__ import print_function from __future__ import unicode_literals @@ -14,7 +33,6 @@ import codecs import collections import datetime import email.utils -import locale try: # Python 3 from urllib.parse import quote except ImportError: # Python 2 @@ -22,36 +40,89 @@ except ImportError: # Python 2 import json import argparse import os +import re import sys import subprocess +import xml.sax.saxutils -_ENCODING = locale.getpreferredencoding() or sys.getdefaultencoding() +_ENCODING = 'UTF-8' _PAGES = {} +if not hasattr(collections, 'OrderedDict'): # Python 2.6 or earlier + class _OrderedDict (dict): + "Just enough of a stub to get through Page._get_threads" + def __init__(self, *args, **kwargs): + super(_OrderedDict, self).__init__(*args, **kwargs) + self._keys = [] # record key order + + def __setitem__(self, key, value): + super(_OrderedDict, self).__setitem__(key, value) + self._keys.append(key) + + def values(self): + for key in self._keys: + yield self[key] + + + collections.OrderedDict = _OrderedDict + + +class ConfigError (Exception): + """Errors with config file usage + """ + pass + + def read_config(path=None, encoding=None): "Read config from json file" if not encoding: encoding = _ENCODING if path: - fp = open(path) + try: + with open(path, 'rb') as f: + config_bytes = f.read() + except IOError as e: + raise ConfigError('Could not read config from {}'.format(path)) else: nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug')) + branch = 'config' + filename = 'status-config.json' # read only the first line from the pipe sha1_bytes = subprocess.Popen( - ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'], + ['git', '--git-dir', nmbhome, 'show-ref', '-s', '--heads', branch], stdout=subprocess.PIPE).stdout.readline() sha1 = sha1_bytes.decode(encoding).rstrip() + if not sha1: + raise ConfigError( + ("No local branch '{branch}' in {nmbgit}. " + 'Checkout a local {branch} branch or explicitly set --config.' + ).format(branch=branch, nmbgit=nmbhome)) - fp_byte_stream = subprocess.Popen( + p = subprocess.Popen( ['git', '--git-dir', nmbhome, 'cat-file', 'blob', - sha1+':status-config.json'], - stdout=subprocess.PIPE).stdout - fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream) - - return json.load(fp) + '{}:{}'.format(sha1, filename)], + stdout=subprocess.PIPE) + config_bytes, err = p.communicate() + status = p.wait() + if status != 0: + raise ConfigError( + ("Missing status-config.json in branch '{branch}' of" + '{nmbgit}. Add the file or explicitly set --config.' + ).format(branch=branch, nmbgit=nmbhome)) + + config_json = config_bytes.decode(encoding) + try: + return json.loads(config_json) + except ValueError as e: + if not path: + path = "{} in branch '{}' of {}".format( + filename, branch, nmbhome) + raise ConfigError( + 'Could not parse JSON from the config file {}:\n{}'.format( + path, e)) class Thread (list): @@ -70,7 +141,7 @@ class Page (object): byte_stream = sys.stdout.buffer except AttributeError: # Python 2 byte_stream = sys.stdout - stream = codecs.getwriter(encoding='UTF-8')(stream=byte_stream) + stream = codecs.getwriter(encoding=_ENCODING)(stream=byte_stream) self._write_header(views=views, stream=stream) for view in views: self._write_view(database=database, view=view, stream=stream) @@ -85,11 +156,20 @@ class Page (object): stream.write(self.footer) def _write_view(self, database, view, stream): + # sort order, default to oldest-first + sort_key = view.get('sort', 'oldest-first') + # dynamically accept all values in Query.SORT + sort_attribute = sort_key.upper().replace('-', '_') + try: + sort = getattr(notmuch.Query.SORT, sort_attribute) + except AttributeError: + raise ConfigError('Invalid sort setting for {}: {!r}'.format( + view['title'], sort_key)) if 'query-string' not in view: query = view['query'] view['query-string'] = ' and '.join(query) q = notmuch.Query(database, view['query-string']) - q.set_sort(notmuch.Query.SORT.OLDEST_FIRST) + q.set_sort(sort) threads = self._get_threads(messages=q.search_messages()) self._write_view_header(view=view, stream=stream) self._write_threads(threads=threads, stream=stream) @@ -150,24 +230,32 @@ class Page (object): class HtmlPage (Page): + _slug_regexp = re.compile('\W+') + def _write_header(self, views, stream): super(HtmlPage, self)._write_header(views=views, stream=stream) stream.write('\n') def _write_view_header(self, view, stream): - stream.write('

{title}

\n'.format(**view)) + stream.write('

{title}

\n'.format(**view)) + stream.write('

\n') if 'comment' in view: stream.write(view['comment']) stream.write('\n') for line in [ 'The view is generated from the following query:', - '

', + '

', + '

', + ' ', view['query-string'], - '

', + ' ', + '

', ]: stream.write(line) stream.write('\n') @@ -177,17 +265,22 @@ class HtmlPage (Page): return stream.write('\n') for thread in threads: + stream.write(' \n') for message_display_data in thread: stream.write(( - '\n' - '\n' + ' \n' + ' \n' + ' \n' + ' \n' + ' \n' + ' \n' + ' \n' + ' \n' ).format(**message_display_data)) + stream.write(' \n') if thread != threads[-1]: - stream.write('\n') + stream.write( + ' \n') stream.write('
{date}\n' - '{message-id-term}\n' - '
{from}\n' - '{subject}\n' - '
{date}{message-id-term}
{from}{subject}


\n') def _message_display_data(self, *args, **kwargs): @@ -197,34 +290,20 @@ class HtmlPage (Page): if 'subject' in display_data and 'message-id' in display_data: d = { 'message-id': quote(display_data['message-id']), - 'subject': display_data['subject'], + 'subject': xml.sax.saxutils.escape(display_data['subject']), } display_data['subject'] = ( '{subject}' ).format(**d) + for key in ['message-id', 'from']: + if key in display_data: + display_data[key] = xml.sax.saxutils.escape(display_data[key]) return (running_data, display_data) + def _slug(self, string): + return self._slug_regexp.sub('-', string) -_PAGES['text'] = Page() -_PAGES['html'] = HtmlPage( - header=''' - - - - -Notmuch Patches - - -

Notmuch Patches

-Generated: {date}
-For more infomation see nmbug -

Views

-'''.format(date=datetime.datetime.utcnow().date()), - footer='\n\n', - ) - - -parser = argparse.ArgumentParser() +parser = argparse.ArgumentParser(description=__doc__) parser.add_argument('--text', help='output plain text format', action='store_true') parser.add_argument('--config', help='load config from given file', @@ -236,7 +315,87 @@ parser.add_argument('--get-query', help='get query for view', args = parser.parse_args() -config = read_config(path=args.config) +try: + config = read_config(path=args.config) +except ConfigError as e: + print(e) + sys.exit(1) + +header_template = config['meta'].get('header', ''' + + + + {title} + + + +

{title}

+{blurb} +

+

Views

+''') + +footer_template = config['meta'].get('footer', ''' +
+

Generated: {datetime} + + +''') + +now = datetime.datetime.utcnow() +context = { + 'date': now, + 'datetime': now.strftime('%Y-%m-%d %H:%M:%SZ'), + 'title': config['meta']['title'], + 'blurb': config['meta']['blurb'], + 'encoding': _ENCODING, + 'inter_message_padding': '0.25em', + 'border_radius': '0.5em', + } + +_PAGES['text'] = Page() +_PAGES['html'] = HtmlPage( + header=header_template.format(**context), + footer=footer_template.format(**context), + ) if args.list_views: for view in config['views']: