git.notmuchmail.org Git - notmuch/blob - devel/nmbug/nmbug-status

   1 #!/usr/bin/python
   2 #
   3 # Copyright (c) 2011-2012 David Bremner <david@tethera.net>
   4 # License: Same as notmuch
   5 # dependencies
   6 #       - python 2.6 for json
   7 #       - argparse; either python 2.7, or install separately
   8
   9 from __future__ import print_function
  10 from __future__ import unicode_literals
  11
  12 import codecs
  13 import collections
  14 import datetime
  15 import email.utils
  16 import locale
  17 try:  # Python 3
  18     from urllib.parse import quote
  19 except ImportError:  # Python 2
  20     from urllib import quote
  21 import json
  22 import argparse
  23 import os
  24 import sys
  25 import subprocess
  26
  27
  28 _ENCODING = locale.getpreferredencoding() or sys.getdefaultencoding()
  29 _PAGES = {}
  30
  31
  32 if not hasattr(collections, 'OrderedDict'):  # Python 2.6 or earlier
  33     class _OrderedDict (dict):
  34         "Just enough of a stub to get through Page._get_threads"
  35         def __init__(self, *args, **kwargs):
  36             super(_OrderedDict, self).__init__(*args, **kwargs)
  37             self._keys = []  # record key order
  38
  39         def __setitem__(self, key, value):
  40             super(_OrderedDict, self).__setitem__(key, value)
  41             self._keys.append(key)
  42
  43         def __values__(self):
  44             for key in self._keys:
  45                 yield self[key]
  46
  47
  48     collections.OrderedDict = _OrderedDict
  49
  50
  51 def read_config(path=None, encoding=None):
  52     "Read config from json file"
  53     if not encoding:
  54         encoding = _ENCODING
  55     if path:
  56         fp = open(path)
  57     else:
  58         nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
  59
  60         # read only the first line from the pipe
  61         sha1_bytes = subprocess.Popen(
  62             ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'],
  63             stdout=subprocess.PIPE).stdout.readline()
  64         sha1 = sha1_bytes.decode(encoding).rstrip()
  65
  66         fp_byte_stream = subprocess.Popen(
  67             ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
  68              sha1+':status-config.json'],
  69             stdout=subprocess.PIPE).stdout
  70         fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream)
  71
  72     return json.load(fp)
  73
  74
  75 class Thread (list):
  76     def __init__(self):
  77         self.running_data = {}
  78
  79
  80 class Page (object):
  81     def __init__(self, header=None, footer=None):
  82         self.header = header
  83         self.footer = footer
  84
  85     def write(self, database, views, stream=None):
  86         if not stream:
  87             try:  # Python 3
  88                 byte_stream = sys.stdout.buffer
  89             except AttributeError:  # Python 2
  90                 byte_stream = sys.stdout
  91             stream = codecs.getwriter(encoding='UTF-8')(stream=byte_stream)
  92         self._write_header(views=views, stream=stream)
  93         for view in views:
  94             self._write_view(database=database, view=view, stream=stream)
  95         self._write_footer(views=views, stream=stream)
  96
  97     def _write_header(self, views, stream):
  98         if self.header:
  99             stream.write(self.header)
 100
 101     def _write_footer(self, views, stream):
 102         if self.footer:
 103             stream.write(self.footer)
 104
 105     def _write_view(self, database, view, stream):
 106         if 'query-string' not in view:
 107             query = view['query']
 108             view['query-string'] = ' and '.join(query)
 109         q = notmuch.Query(database, view['query-string'])
 110         q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
 111         threads = self._get_threads(messages=q.search_messages())
 112         self._write_view_header(view=view, stream=stream)
 113         self._write_threads(threads=threads, stream=stream)
 114
 115     def _get_threads(self, messages):
 116         threads = collections.OrderedDict()
 117         for message in messages:
 118             thread_id = message.get_thread_id()
 119             if thread_id in threads:
 120                 thread = threads[thread_id]
 121             else:
 122                 thread = Thread()
 123                 threads[thread_id] = thread
 124             thread.running_data, display_data = self._message_display_data(
 125                 running_data=thread.running_data, message=message)
 126             thread.append(display_data)
 127         return list(threads.values())
 128
 129     def _write_view_header(self, view, stream):
 130         pass
 131
 132     def _write_threads(self, threads, stream):
 133         for thread in threads:
 134             for message_display_data in thread:
 135                 stream.write(
 136                     ('{date:10.10s} {from:20.20s} {subject:40.40s}\n'
 137                      '{message-id-term:>72}\n'
 138                      ).format(**message_display_data))
 139             if thread != threads[-1]:
 140                 stream.write('\n')
 141
 142     def _message_display_data(self, running_data, message):
 143         headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
 144         data = {}
 145         for header in headers:
 146             if header == 'thread-id':
 147                 value = message.get_thread_id()
 148             elif header == 'message-id':
 149                 value = message.get_message_id()
 150                 data['message-id-term'] = 'id:"{0}"'.format(value)
 151             elif header == 'date':
 152                 value = str(datetime.datetime.utcfromtimestamp(
 153                     message.get_date()).date())
 154             else:
 155                 value = message.get_header(header)
 156             if header == 'from':
 157                 (value, addr) = email.utils.parseaddr(value)
 158                 if not value:
 159                     value = addr.split('@')[0]
 160             data[header] = value
 161         next_running_data = data.copy()
 162         for header, value in data.items():
 163             if header in ['message-id', 'subject']:
 164                 continue
 165             if value == running_data.get(header, None):
 166                 data[header] = ''
 167         return (next_running_data, data)
 168
 169
 170 class HtmlPage (Page):
 171     def _write_header(self, views, stream):
 172         super(HtmlPage, self)._write_header(views=views, stream=stream)
 173         stream.write('<ul>\n')
 174         for view in views:
 175             stream.write(
 176                 '<li><a href="#{title}">{title}</a></li>\n'.format(**view))
 177         stream.write('</ul>\n')
 178
 179     def _write_view_header(self, view, stream):
 180         stream.write('<h3><a name="{title}" />{title}</h3>\n'.format(**view))
 181         if 'comment' in view:
 182             stream.write(view['comment'])
 183             stream.write('\n')
 184         for line in [
 185                 'The view is generated from the following query:',
 186                 '<blockquote>',
 187                 view['query-string'],
 188                 '</blockquote>',
 189                 ]:
 190             stream.write(line)
 191             stream.write('\n')
 192
 193     def _write_threads(self, threads, stream):
 194         if not threads:
 195             return
 196         stream.write('<table>\n')
 197         for thread in threads:
 198             for message_display_data in thread:
 199                 stream.write((
 200                     '<tr>\n'
 201                     '  <td>{date}</td>\n'
 202                     '  <td>{message-id-term}</td>\n'
 203                     '</tr>\n'
 204                     '<tr>\n'
 205                     '  <td>{from}</td>\n'
 206                     '  <td>{subject}</td>\n'
 207                     '</tr>\n'
 208                     ).format(**message_display_data))
 209             if thread != threads[-1]:
 210                 stream.write('<tr><td colspan="2"><br /></td></tr>\n')
 211         stream.write('</table>\n')
 212
 213     def _message_display_data(self, *args, **kwargs):
 214         running_data, display_data = super(
 215             HtmlPage, self)._message_display_data(
 216                 *args, **kwargs)
 217         if 'subject' in display_data and 'message-id' in display_data:
 218             d = {
 219                 'message-id': quote(display_data['message-id']),
 220                 'subject': display_data['subject'],
 221                 }
 222             display_data['subject'] = (
 223                 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
 224                 ).format(**d)
 225         return (running_data, display_data)
 226
 227
 228 _PAGES['text'] = Page()
 229 _PAGES['html'] = HtmlPage(
 230     header='''<!DOCTYPE html>
 231 <html lang="en">
 232 <head>
 233 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 234 <title>Notmuch Patches</title>
 235 </head>
 236 <body>
 237 <h2>Notmuch Patches</h2>
 238 Generated: {date}<br />
 239 For more infomation see <a href="http://notmuchmail.org/nmbug">nmbug</a>
 240 <h3>Views</h3>
 241 '''.format(date=datetime.datetime.utcnow().date()),
 242     footer='</body>\n</html>\n',
 243     )
 244
 245
 246 parser = argparse.ArgumentParser()
 247 parser.add_argument('--text', help='output plain text format',
 248                     action='store_true')
 249 parser.add_argument('--config', help='load config from given file',
 250                     metavar='PATH')
 251 parser.add_argument('--list-views', help='list views',
 252                     action='store_true')
 253 parser.add_argument('--get-query', help='get query for view',
 254                     metavar='VIEW')
 255
 256 args = parser.parse_args()
 257
 258 config = read_config(path=args.config)
 259
 260 if args.list_views:
 261     for view in config['views']:
 262         print(view['title'])
 263     sys.exit(0)
 264 elif args.get_query != None:
 265     for view in config['views']:
 266         if args.get_query == view['title']:
 267             print(' and '.join(view['query']))
 268     sys.exit(0)
 269 else:
 270     # only import notmuch if needed
 271     import notmuch
 272
 273 if args.text:
 274     page = _PAGES['text']
 275 else:
 276     page = _PAGES['html']
 277
 278 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
 279 page.write(database=db, views=config['views'])