3 # Copyright (c) 2011-2012 David Bremner <david@tethera.net>
6 # - python 2.6 for json
7 # - argparse; either python 2.7, or install separately
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see http://www.gnu.org/licenses/ .
22 """Generate HTML for one or more notmuch searches.
24 Messages matching each search are grouped by thread. Each message
25 that contains both a subject and message-id will have the displayed
26 subject link to the Gmane view of the message.
29 from __future__ import print_function
30 from __future__ import unicode_literals
37 from urllib.parse import quote
38 except ImportError: # Python 2
39 from urllib import quote
46 import xml.sax.saxutils
53 if not hasattr(collections, 'OrderedDict'): # Python 2.6 or earlier
54 class _OrderedDict (dict):
55 "Just enough of a stub to get through Page._get_threads"
56 def __init__(self, *args, **kwargs):
57 super(_OrderedDict, self).__init__(*args, **kwargs)
58 self._keys = [] # record key order
60 def __setitem__(self, key, value):
61 super(_OrderedDict, self).__setitem__(key, value)
62 self._keys.append(key)
65 for key in self._keys:
69 collections.OrderedDict = _OrderedDict
72 def read_config(path=None, encoding=None):
73 "Read config from json file"
79 nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
81 # read only the first line from the pipe
82 sha1_bytes = subprocess.Popen(
83 ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'],
84 stdout=subprocess.PIPE).stdout.readline()
85 sha1 = sha1_bytes.decode(encoding).rstrip()
87 fp_byte_stream = subprocess.Popen(
88 ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
89 sha1+':status-config.json'],
90 stdout=subprocess.PIPE).stdout
91 fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream)
98 self.running_data = {}
102 def __init__(self, header=None, footer=None):
106 def write(self, database, views, stream=None):
109 byte_stream = sys.stdout.buffer
110 except AttributeError: # Python 2
111 byte_stream = sys.stdout
112 stream = codecs.getwriter(encoding=_ENCODING)(stream=byte_stream)
113 self._write_header(views=views, stream=stream)
115 self._write_view(database=database, view=view, stream=stream)
116 self._write_footer(views=views, stream=stream)
118 def _write_header(self, views, stream):
120 stream.write(self.header)
122 def _write_footer(self, views, stream):
124 stream.write(self.footer)
126 def _write_view(self, database, view, stream):
127 if 'query-string' not in view:
128 query = view['query']
129 view['query-string'] = ' and '.join(query)
130 q = notmuch.Query(database, view['query-string'])
131 q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
132 threads = self._get_threads(messages=q.search_messages())
133 self._write_view_header(view=view, stream=stream)
134 self._write_threads(threads=threads, stream=stream)
136 def _get_threads(self, messages):
137 threads = collections.OrderedDict()
138 for message in messages:
139 thread_id = message.get_thread_id()
140 if thread_id in threads:
141 thread = threads[thread_id]
144 threads[thread_id] = thread
145 thread.running_data, display_data = self._message_display_data(
146 running_data=thread.running_data, message=message)
147 thread.append(display_data)
148 return list(threads.values())
150 def _write_view_header(self, view, stream):
153 def _write_threads(self, threads, stream):
154 for thread in threads:
155 for message_display_data in thread:
157 ('{date:10.10s} {from:20.20s} {subject:40.40s}\n'
158 '{message-id-term:>72}\n'
159 ).format(**message_display_data))
160 if thread != threads[-1]:
163 def _message_display_data(self, running_data, message):
164 headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
166 for header in headers:
167 if header == 'thread-id':
168 value = message.get_thread_id()
169 elif header == 'message-id':
170 value = message.get_message_id()
171 data['message-id-term'] = 'id:"{0}"'.format(value)
172 elif header == 'date':
173 value = str(datetime.datetime.utcfromtimestamp(
174 message.get_date()).date())
176 value = message.get_header(header)
178 (value, addr) = email.utils.parseaddr(value)
180 value = addr.split('@')[0]
182 next_running_data = data.copy()
183 for header, value in data.items():
184 if header in ['message-id', 'subject']:
186 if value == running_data.get(header, None):
188 return (next_running_data, data)
191 class HtmlPage (Page):
192 _slug_regexp = re.compile('\W+')
194 def _write_header(self, views, stream):
195 super(HtmlPage, self)._write_header(views=views, stream=stream)
196 stream.write('<ul>\n')
199 view['id'] = self._slug(view['title'])
201 '<li><a href="#{id}">{title}</a></li>\n'.format(**view))
202 stream.write('</ul>\n')
204 def _write_view_header(self, view, stream):
205 stream.write('<h3 id="{id}">{title}</h3>\n'.format(**view))
206 stream.write('<p>\n')
207 if 'comment' in view:
208 stream.write(view['comment'])
211 'The view is generated from the following query:',
215 view['query-string'],
222 def _write_threads(self, threads, stream):
225 stream.write('<table>\n')
226 for thread in threads:
227 stream.write(' <tbody>\n')
228 for message_display_data in thread:
230 ' <tr class="message-first">\n'
232 ' <td><code>{message-id-term}</code></td>\n'
234 ' <tr class="message-last">\n'
236 ' <td>{subject}</td>\n'
238 ).format(**message_display_data))
239 stream.write(' </tbody>\n')
240 if thread != threads[-1]:
242 ' <tbody><tr><td colspan="2"><br /></td></tr></tbody>\n')
243 stream.write('</table>\n')
245 def _message_display_data(self, *args, **kwargs):
246 running_data, display_data = super(
247 HtmlPage, self)._message_display_data(
249 if 'subject' in display_data and 'message-id' in display_data:
251 'message-id': quote(display_data['message-id']),
252 'subject': xml.sax.saxutils.escape(display_data['subject']),
254 display_data['subject'] = (
255 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
257 for key in ['message-id', 'from']:
258 if key in display_data:
259 display_data[key] = xml.sax.saxutils.escape(display_data[key])
260 return (running_data, display_data)
262 def _slug(self, string):
263 return self._slug_regexp.sub('-', string)
265 parser = argparse.ArgumentParser(description=__doc__)
266 parser.add_argument('--text', help='output plain text format',
268 parser.add_argument('--config', help='load config from given file',
270 parser.add_argument('--list-views', help='list views',
272 parser.add_argument('--get-query', help='get query for view',
275 args = parser.parse_args()
277 config = read_config(path=args.config)
279 header_template = config['meta'].get('header', '''<!DOCTYPE html>
282 <meta http-equiv="Content-Type" content="text/html; charset={encoding}" />
283 <title>{title}</title>
284 <style media="screen" type="text/css">
288 tr.message-first td {{
289 padding-top: {inter_message_padding};
291 tr.message-last td {{
292 padding-bottom: {inter_message_padding};
295 padding-left: {border_radius};
296 padding-right: {border_radius};
298 tr:first-child td:first-child {{
299 border-top-left-radius: {border_radius};
301 tr:first-child td:last-child {{
302 border-top-right-radius: {border_radius};
304 tr:last-child td:first-child {{
305 border-bottom-left-radius: {border_radius};
307 tr:last-child td:last-child {{
308 border-bottom-right-radius: {border_radius};
310 tbody:nth-child(4n+1) tr td {{
311 background-color: #ffd96e;
313 tbody:nth-child(4n+3) tr td {{
314 background-color: #bce;
320 background-color: #ccc;
331 footer_template = config['meta'].get('footer', '''
333 <p>Generated: {datetime}
338 now = datetime.datetime.utcnow()
341 'datetime': now.strftime('%Y-%m-%d %H:%M:%SZ'),
342 'title': config['meta']['title'],
343 'blurb': config['meta']['blurb'],
344 'encoding': _ENCODING,
345 'inter_message_padding': '0.25em',
346 'border_radius': '0.5em',
349 _PAGES['text'] = Page()
350 _PAGES['html'] = HtmlPage(
351 header=header_template.format(**context),
352 footer=footer_template.format(**context),
356 for view in config['views']:
359 elif args.get_query != None:
360 for view in config['views']:
361 if args.get_query == view['title']:
362 print(' and '.join(view['query']))
365 # only import notmuch if needed
369 page = _PAGES['text']
371 page = _PAGES['html']
373 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
374 page.write(database=db, views=config['views'])