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 try:  # Python 3
  17     from urllib.parse import quote
  18 except ImportError:  # Python 2
  19     from urllib import quote
  20 import json
  21 import argparse
  22 import os
  23 import re
  24 import sys
  25 import subprocess
  26 import xml.sax.saxutils
  27
  28
  29 _ENCODING = 'UTF-8'
  30 _PAGES = {}
  31
  32
  33 if not hasattr(collections, 'OrderedDict'):  # Python 2.6 or earlier
  34     class _OrderedDict (dict):
  35         "Just enough of a stub to get through Page._get_threads"
  36         def __init__(self, *args, **kwargs):
  37             super(_OrderedDict, self).__init__(*args, **kwargs)
  38             self._keys = []  # record key order
  39
  40         def __setitem__(self, key, value):
  41             super(_OrderedDict, self).__setitem__(key, value)
  42             self._keys.append(key)
  43
  44         def values(self):
  45             for key in self._keys:
  46                 yield self[key]
  47
  48
  49     collections.OrderedDict = _OrderedDict
  50
  51
  52 def read_config(path=None, encoding=None):
  53     "Read config from json file"
  54     if not encoding:
  55         encoding = _ENCODING
  56     if path:
  57         fp = open(path)
  58     else:
  59         nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
  60
  61         # read only the first line from the pipe
  62         sha1_bytes = subprocess.Popen(
  63             ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'],
  64             stdout=subprocess.PIPE).stdout.readline()
  65         sha1 = sha1_bytes.decode(encoding).rstrip()
  66
  67         fp_byte_stream = subprocess.Popen(
  68             ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
  69              sha1+':status-config.json'],
  70             stdout=subprocess.PIPE).stdout
  71         fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream)
  72
  73     return json.load(fp)
  74
  75
  76 class Thread (list):
  77     def __init__(self):
  78         self.running_data = {}
  79
  80
  81 class Page (object):
  82     def __init__(self, header=None, footer=None):
  83         self.header = header
  84         self.footer = footer
  85
  86     def write(self, database, views, stream=None):
  87         if not stream:
  88             try:  # Python 3
  89                 byte_stream = sys.stdout.buffer
  90             except AttributeError:  # Python 2
  91                 byte_stream = sys.stdout
  92             stream = codecs.getwriter(encoding=_ENCODING)(stream=byte_stream)
  93         self._write_header(views=views, stream=stream)
  94         for view in views:
  95             self._write_view(database=database, view=view, stream=stream)
  96         self._write_footer(views=views, stream=stream)
  97
  98     def _write_header(self, views, stream):
  99         if self.header:
 100             stream.write(self.header)
 101
 102     def _write_footer(self, views, stream):
 103         if self.footer:
 104             stream.write(self.footer)
 105
 106     def _write_view(self, database, view, stream):
 107         if 'query-string' not in view:
 108             query = view['query']
 109             view['query-string'] = ' and '.join(query)
 110         q = notmuch.Query(database, view['query-string'])
 111         q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
 112         threads = self._get_threads(messages=q.search_messages())
 113         self._write_view_header(view=view, stream=stream)
 114         self._write_threads(threads=threads, stream=stream)
 115
 116     def _get_threads(self, messages):
 117         threads = collections.OrderedDict()
 118         for message in messages:
 119             thread_id = message.get_thread_id()
 120             if thread_id in threads:
 121                 thread = threads[thread_id]
 122             else:
 123                 thread = Thread()
 124                 threads[thread_id] = thread
 125             thread.running_data, display_data = self._message_display_data(
 126                 running_data=thread.running_data, message=message)
 127             thread.append(display_data)
 128         return list(threads.values())
 129
 130     def _write_view_header(self, view, stream):
 131         pass
 132
 133     def _write_threads(self, threads, stream):
 134         for thread in threads:
 135             for message_display_data in thread:
 136                 stream.write(
 137                     ('{date:10.10s} {from:20.20s} {subject:40.40s}\n'
 138                      '{message-id-term:>72}\n'
 139                      ).format(**message_display_data))
 140             if thread != threads[-1]:
 141                 stream.write('\n')
 142
 143     def _message_display_data(self, running_data, message):
 144         headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
 145         data = {}
 146         for header in headers:
 147             if header == 'thread-id':
 148                 value = message.get_thread_id()
 149             elif header == 'message-id':
 150                 value = message.get_message_id()
 151                 data['message-id-term'] = 'id:"{0}"'.format(value)
 152             elif header == 'date':
 153                 value = str(datetime.datetime.utcfromtimestamp(
 154                     message.get_date()).date())
 155             else:
 156                 value = message.get_header(header)
 157             if header == 'from':
 158                 (value, addr) = email.utils.parseaddr(value)
 159                 if not value:
 160                     value = addr.split('@')[0]
 161             data[header] = value
 162         next_running_data = data.copy()
 163         for header, value in data.items():
 164             if header in ['message-id', 'subject']:
 165                 continue
 166             if value == running_data.get(header, None):
 167                 data[header] = ''
 168         return (next_running_data, data)
 169
 170
 171 class HtmlPage (Page):
 172     _slug_regexp = re.compile('\W+')
 173
 174     def _write_header(self, views, stream):
 175         super(HtmlPage, self)._write_header(views=views, stream=stream)
 176         stream.write('<ul>\n')
 177         for view in views:
 178             if 'id' not in view:
 179                 view['id'] = self._slug(view['title'])
 180             stream.write(
 181                 '<li><a href="#{id}">{title}</a></li>\n'.format(**view))
 182         stream.write('</ul>\n')
 183
 184     def _write_view_header(self, view, stream):
 185         stream.write('<h3 id="{id}">{title}</h3>\n'.format(**view))
 186         stream.write('<p>\n')
 187         if 'comment' in view:
 188             stream.write(view['comment'])
 189             stream.write('\n')
 190         for line in [
 191                 'The view is generated from the following query:',
 192                 '</p>',
 193                 '<p>',
 194                 '  <code>',
 195                 view['query-string'],
 196                 '  </code>',
 197                 '</p>',
 198                 ]:
 199             stream.write(line)
 200             stream.write('\n')
 201
 202     def _write_threads(self, threads, stream):
 203         if not threads:
 204             return
 205         stream.write('<table>\n')
 206         for thread in threads:
 207             stream.write('  <tbody>\n')
 208             for message_display_data in thread:
 209                 stream.write((
 210                     '    <tr class="message-first">\n'
 211                     '      <td>{date}</td>\n'
 212                     '      <td><code>{message-id-term}</code></td>\n'
 213                     '    </tr>\n'
 214                     '    <tr class="message-last">\n'
 215                     '      <td>{from}</td>\n'
 216                     '      <td>{subject}</td>\n'
 217                     '    </tr>\n'
 218                     ).format(**message_display_data))
 219             stream.write('  </tbody>\n')
 220             if thread != threads[-1]:
 221                 stream.write(
 222                     '  <tbody><tr><td colspan="2"><br /></td></tr></tbody>\n')
 223         stream.write('</table>\n')
 224
 225     def _message_display_data(self, *args, **kwargs):
 226         running_data, display_data = super(
 227             HtmlPage, self)._message_display_data(
 228                 *args, **kwargs)
 229         if 'subject' in display_data and 'message-id' in display_data:
 230             d = {
 231                 'message-id': quote(display_data['message-id']),
 232                 'subject': xml.sax.saxutils.escape(display_data['subject']),
 233                 }
 234             display_data['subject'] = (
 235                 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
 236                 ).format(**d)
 237         for key in ['message-id', 'from']:
 238             if key in display_data:
 239                 display_data[key] = xml.sax.saxutils.escape(display_data[key])
 240         return (running_data, display_data)
 241
 242     def _slug(self, string):
 243         return self._slug_regexp.sub('-', string)
 244
 245
 246 _PAGES['text'] = Page()
 247 _PAGES['html'] = HtmlPage(
 248     header='''<!DOCTYPE html>
 249 <html lang="en">
 250 <head>
 251   <meta http-equiv="Content-Type" content="text/html; charset={encoding}" />
 252   <title>{title}</title>
 253   <style media="screen" type="text/css">
 254     table {{
 255       border-spacing: 0;
 256     }}
 257     tr.message-first td {{
 258       padding-top: {inter_message_padding};
 259     }}
 260     tr.message-last td {{
 261       padding-bottom: {inter_message_padding};
 262     }}
 263     td {{
 264       padding-left: {border_radius};
 265       padding-right: {border_radius};
 266     }}
 267     tr:first-child td:first-child {{
 268       border-top-left-radius: {border_radius};
 269     }}
 270     tr:first-child td:last-child {{
 271       border-top-right-radius: {border_radius};
 272     }}
 273     tr:last-child td:first-child {{
 274       border-bottom-left-radius: {border_radius};
 275     }}
 276     tr:last-child td:last-child {{
 277       border-bottom-right-radius: {border_radius};
 278     }}
 279     tbody:nth-child(4n+1) tr td {{
 280       background-color: #ffd96e;
 281     }}
 282     tbody:nth-child(4n+3) tr td {{
 283       background-color: #bce;
 284     }}
 285   </style>
 286 </head>
 287 <body>
 288 <h2>{title}</h2>
 289 <p>
 290 Generated: {date}<br />
 291 {blurb}
 292 </p>
 293 <h3>Views</h3>
 294 '''.format(date=datetime.datetime.utcnow().date(),
 295            title='Notmuch Patches',
 296            blurb='For more infomation see <a href="http://notmuchmail.org/nmbug">nmbug</a>',
 297            encoding=_ENCODING,
 298            inter_message_padding='0.25em',
 299            border_radius='0.5em'),
 300     footer='</body>\n</html>\n',
 301     )
 302
 303
 304 parser = argparse.ArgumentParser()
 305 parser.add_argument('--text', help='output plain text format',
 306                     action='store_true')
 307 parser.add_argument('--config', help='load config from given file',
 308                     metavar='PATH')
 309 parser.add_argument('--list-views', help='list views',
 310                     action='store_true')
 311 parser.add_argument('--get-query', help='get query for view',
 312                     metavar='VIEW')
 313
 314 args = parser.parse_args()
 315
 316 config = read_config(path=args.config)
 317
 318 if args.list_views:
 319     for view in config['views']:
 320         print(view['title'])
 321     sys.exit(0)
 322 elif args.get_query != None:
 323     for view in config['views']:
 324         if args.get_query == view['title']:
 325             print(' and '.join(view['query']))
 326     sys.exit(0)
 327 else:
 328     # only import notmuch if needed
 329     import notmuch
 330
 331 if args.text:
 332     page = _PAGES['text']
 333 else:
 334     page = _PAGES['html']
 335
 336 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
 337 page.write(database=db, views=config['views'])