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 class ConfigError (Exception):
73 """Errors with config file usage
78 def read_config(path=None, encoding=None):
79 "Read config from json file"
84 with open(path, 'rb') as f:
85 config_bytes = f.read()
87 raise ConfigError('Could not read config from {}'.format(path))
89 nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
91 filename = 'status-config.json'
93 # read only the first line from the pipe
94 sha1_bytes = subprocess.Popen(
95 ['git', '--git-dir', nmbhome, 'show-ref', '-s', '--heads', branch],
96 stdout=subprocess.PIPE).stdout.readline()
97 sha1 = sha1_bytes.decode(encoding).rstrip()
100 ("No local branch '{branch}' in {nmbgit}. "
101 'Checkout a local {branch} branch or explicitly set --config.'
102 ).format(branch=branch, nmbgit=nmbhome))
104 p = subprocess.Popen(
105 ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
106 '{}:{}'.format(sha1, filename)],
107 stdout=subprocess.PIPE)
108 config_bytes, err = p.communicate()
112 ("Missing {filename} in branch '{branch}' of {nmbgit}. "
113 'Add the file or explicitly set --config.'
114 ).format(filename=filename, branch=branch, nmbgit=nmbhome))
116 config_json = config_bytes.decode(encoding)
118 return json.loads(config_json)
119 except ValueError as e:
121 path = "{} in branch '{}' of {}".format(
122 filename, branch, nmbhome)
124 'Could not parse JSON from the config file {}:\n{}'.format(
130 self.running_data = {}
134 def __init__(self, header=None, footer=None):
138 def write(self, database, views, stream=None):
141 byte_stream = sys.stdout.buffer
142 except AttributeError: # Python 2
143 byte_stream = sys.stdout
144 stream = codecs.getwriter(encoding=_ENCODING)(stream=byte_stream)
145 self._write_header(views=views, stream=stream)
147 self._write_view(database=database, view=view, stream=stream)
148 self._write_footer(views=views, stream=stream)
150 def _write_header(self, views, stream):
152 stream.write(self.header)
154 def _write_footer(self, views, stream):
156 stream.write(self.footer)
158 def _write_view(self, database, view, stream):
159 # sort order, default to oldest-first
160 sort_key = view.get('sort', 'oldest-first')
161 # dynamically accept all values in Query.SORT
162 sort_attribute = sort_key.upper().replace('-', '_')
164 sort = getattr(notmuch.Query.SORT, sort_attribute)
165 except AttributeError:
166 raise ConfigError('Invalid sort setting for {}: {!r}'.format(
167 view['title'], sort_key))
168 if 'query-string' not in view:
169 query = view['query']
170 view['query-string'] = ' and '.join(query)
171 q = notmuch.Query(database, view['query-string'])
173 threads = self._get_threads(messages=q.search_messages())
174 self._write_view_header(view=view, stream=stream)
175 self._write_threads(threads=threads, stream=stream)
177 def _get_threads(self, messages):
178 threads = collections.OrderedDict()
179 for message in messages:
180 thread_id = message.get_thread_id()
181 if thread_id in threads:
182 thread = threads[thread_id]
185 threads[thread_id] = thread
186 thread.running_data, display_data = self._message_display_data(
187 running_data=thread.running_data, message=message)
188 thread.append(display_data)
189 return list(threads.values())
191 def _write_view_header(self, view, stream):
194 def _write_threads(self, threads, stream):
195 for thread in threads:
196 for message_display_data in thread:
198 ('{date:10.10s} {from:20.20s} {subject:40.40s}\n'
199 '{message-id-term:>72}\n'
200 ).format(**message_display_data))
201 if thread != threads[-1]:
204 def _message_display_data(self, running_data, message):
205 headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
207 for header in headers:
208 if header == 'thread-id':
209 value = message.get_thread_id()
210 elif header == 'message-id':
211 value = message.get_message_id()
212 data['message-id-term'] = 'id:"{0}"'.format(value)
213 elif header == 'date':
214 value = str(datetime.datetime.utcfromtimestamp(
215 message.get_date()).date())
217 value = message.get_header(header)
219 (value, addr) = email.utils.parseaddr(value)
221 value = addr.split('@')[0]
223 next_running_data = data.copy()
224 for header, value in data.items():
225 if header in ['message-id', 'subject']:
227 if value == running_data.get(header, None):
229 return (next_running_data, data)
232 class HtmlPage (Page):
233 _slug_regexp = re.compile('\W+')
235 def _write_header(self, views, stream):
236 super(HtmlPage, self)._write_header(views=views, stream=stream)
237 stream.write('<ul>\n')
240 view['id'] = self._slug(view['title'])
242 '<li><a href="#{id}">{title}</a></li>\n'.format(**view))
243 stream.write('</ul>\n')
245 def _write_view_header(self, view, stream):
246 stream.write('<h3 id="{id}">{title}</h3>\n'.format(**view))
247 stream.write('<p>\n')
248 if 'comment' in view:
249 stream.write(view['comment'])
252 'The view is generated from the following query:',
256 view['query-string'],
263 def _write_threads(self, threads, stream):
266 stream.write('<table>\n')
267 for thread in threads:
268 stream.write(' <tbody>\n')
269 for message_display_data in thread:
271 ' <tr class="message-first">\n'
273 ' <td><code>{message-id-term}</code></td>\n'
275 ' <tr class="message-last">\n'
277 ' <td>{subject}</td>\n'
279 ).format(**message_display_data))
280 stream.write(' </tbody>\n')
281 if thread != threads[-1]:
283 ' <tbody><tr><td colspan="2"><br /></td></tr></tbody>\n')
284 stream.write('</table>\n')
286 def _message_display_data(self, *args, **kwargs):
287 running_data, display_data = super(
288 HtmlPage, self)._message_display_data(
290 if 'subject' in display_data and 'message-id' in display_data:
292 'message-id': quote(display_data['message-id']),
293 'subject': xml.sax.saxutils.escape(display_data['subject']),
295 display_data['subject'] = (
296 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
298 for key in ['message-id', 'from']:
299 if key in display_data:
300 display_data[key] = xml.sax.saxutils.escape(display_data[key])
301 return (running_data, display_data)
303 def _slug(self, string):
304 return self._slug_regexp.sub('-', string)
306 parser = argparse.ArgumentParser(description=__doc__)
307 parser.add_argument('--text', help='output plain text format',
309 parser.add_argument('--config', help='load config from given file',
311 parser.add_argument('--list-views', help='list views',
313 parser.add_argument('--get-query', help='get query for view',
316 args = parser.parse_args()
319 config = read_config(path=args.config)
320 except ConfigError as e:
321 print(e, file=sys.stderr)
324 header_template = config['meta'].get('header', '''<!DOCTYPE html>
327 <meta http-equiv="Content-Type" content="text/html; charset={encoding}" />
328 <title>{title}</title>
329 <style media="screen" type="text/css">
342 tr.message-first td {{
343 padding-top: {inter_message_padding};
345 tr.message-last td {{
346 padding-bottom: {inter_message_padding};
349 padding-left: {border_radius};
350 padding-right: {border_radius};
352 tr:first-child td:first-child {{
353 border-top-left-radius: {border_radius};
355 tr:first-child td:last-child {{
356 border-top-right-radius: {border_radius};
358 tr:last-child td:first-child {{
359 border-bottom-left-radius: {border_radius};
361 tr:last-child td:last-child {{
362 border-bottom-right-radius: {border_radius};
364 tbody:nth-child(4n+1) tr td {{
365 background-color: #ffd96e;
367 tbody:nth-child(4n+3) tr td {{
368 background-color: #bce;
374 background-color: #ccc;
386 footer_template = config['meta'].get('footer', '''
388 <p>Generated: {datetime}</p>
393 now = datetime.datetime.utcnow()
396 'datetime': now.strftime('%Y-%m-%d %H:%M:%SZ'),
397 'title': config['meta']['title'],
398 'blurb': config['meta']['blurb'],
399 'encoding': _ENCODING,
400 'inter_message_padding': '0.25em',
401 'border_radius': '0.5em',
404 _PAGES['text'] = Page()
405 _PAGES['html'] = HtmlPage(
406 header=header_template.format(**context),
407 footer=footer_template.format(**context),
411 for view in config['views']:
414 elif args.get_query != None:
415 for view in config['views']:
416 if args.get_query == view['title']:
417 print(' and '.join(view['query']))
420 # only import notmuch if needed
424 page = _PAGES['text']
426 page = _PAGES['html']
428 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
429 page.write(database=db, views=config['views'])