3 # Copyright (c) 2011-2012 David Bremner <david@tethera.net>
4 # License: Same as notmuch
6 # - python 2.6 for json
7 # - argparse; either python 2.7, or install separately
9 from __future__ import print_function
10 from __future__ import unicode_literals
17 from urllib.parse import quote
18 except ImportError: # Python 2
19 from urllib import quote
26 import xml.sax.saxutils
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
40 def __setitem__(self, key, value):
41 super(_OrderedDict, self).__setitem__(key, value)
42 self._keys.append(key)
45 for key in self._keys:
49 collections.OrderedDict = _OrderedDict
52 def read_config(path=None, encoding=None):
53 "Read config from json file"
59 nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
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()
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)
78 self.running_data = {}
82 def __init__(self, header=None, footer=None):
86 def write(self, database, views, stream=None):
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)
95 self._write_view(database=database, view=view, stream=stream)
96 self._write_footer(views=views, stream=stream)
98 def _write_header(self, views, stream):
100 stream.write(self.header)
102 def _write_footer(self, views, stream):
104 stream.write(self.footer)
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)
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]
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())
130 def _write_view_header(self, view, stream):
133 def _write_threads(self, threads, stream):
134 for thread in threads:
135 for message_display_data in thread:
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]:
143 def _message_display_data(self, running_data, message):
144 headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
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())
156 value = message.get_header(header)
158 (value, addr) = email.utils.parseaddr(value)
160 value = addr.split('@')[0]
162 next_running_data = data.copy()
163 for header, value in data.items():
164 if header in ['message-id', 'subject']:
166 if value == running_data.get(header, None):
168 return (next_running_data, data)
171 class HtmlPage (Page):
172 _slug_regexp = re.compile('\W+')
174 def _write_header(self, views, stream):
175 super(HtmlPage, self)._write_header(views=views, stream=stream)
176 stream.write('<ul>\n')
179 view['id'] = self._slug(view['title'])
181 '<li><a href="#{id}">{title}</a></li>\n'.format(**view))
182 stream.write('</ul>\n')
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'])
191 'The view is generated from the following query:',
195 view['query-string'],
202 def _write_threads(self, threads, stream):
205 stream.write('<table>\n')
206 for thread in threads:
207 stream.write(' <tbody>\n')
208 for message_display_data in thread:
210 ' <tr class="message-first">\n'
212 ' <td><code>{message-id-term}</code></td>\n'
214 ' <tr class="message-last">\n'
216 ' <td>{subject}</td>\n'
218 ).format(**message_display_data))
219 stream.write(' </tbody>\n')
220 if thread != threads[-1]:
222 ' <tbody><tr><td colspan="2"><br /></td></tr></tbody>\n')
223 stream.write('</table>\n')
225 def _message_display_data(self, *args, **kwargs):
226 running_data, display_data = super(
227 HtmlPage, self)._message_display_data(
229 if 'subject' in display_data and 'message-id' in display_data:
231 'message-id': quote(display_data['message-id']),
232 'subject': xml.sax.saxutils.escape(display_data['subject']),
234 display_data['subject'] = (
235 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
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)
242 def _slug(self, string):
243 return self._slug_regexp.sub('-', string)
245 parser = argparse.ArgumentParser()
246 parser.add_argument('--text', help='output plain text format',
248 parser.add_argument('--config', help='load config from given file',
250 parser.add_argument('--list-views', help='list views',
252 parser.add_argument('--get-query', help='get query for view',
255 args = parser.parse_args()
257 config = read_config(path=args.config)
259 _PAGES['text'] = Page()
260 _PAGES['html'] = HtmlPage(
261 header='''<!DOCTYPE html>
264 <meta http-equiv="Content-Type" content="text/html; charset={encoding}" />
265 <title>{title}</title>
266 <style media="screen" type="text/css">
270 tr.message-first td {{
271 padding-top: {inter_message_padding};
273 tr.message-last td {{
274 padding-bottom: {inter_message_padding};
277 padding-left: {border_radius};
278 padding-right: {border_radius};
280 tr:first-child td:first-child {{
281 border-top-left-radius: {border_radius};
283 tr:first-child td:last-child {{
284 border-top-right-radius: {border_radius};
286 tr:last-child td:first-child {{
287 border-bottom-left-radius: {border_radius};
289 tr:last-child td:last-child {{
290 border-bottom-right-radius: {border_radius};
292 tbody:nth-child(4n+1) tr td {{
293 background-color: #ffd96e;
295 tbody:nth-child(4n+3) tr td {{
296 background-color: #bce;
303 Generated: {date}<br />
307 '''.format(date=datetime.datetime.utcnow().date(),
308 title=config['meta']['title'],
309 blurb=config['meta']['blurb'],
311 inter_message_padding='0.25em',
312 border_radius='0.5em'),
313 footer='</body>\n</html>\n',
317 for view in config['views']:
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']))
326 # only import notmuch if needed
330 page = _PAGES['text']
332 page = _PAGES['html']
334 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
335 page.write(database=db, views=config['views'])