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