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
18 from urllib.parse import quote
19 except ImportError: # Python 2
20 from urllib import quote
28 _ENCODING = locale.getpreferredencoding() or sys.getdefaultencoding()
32 if not hasattr(collections, 'OrderedDict'): # Python 2.6 or earlier
33 class _OrderedDict (dict):
34 "Just enough of a stub to get through Page._get_threads"
35 def __init__(self, *args, **kwargs):
36 super(_OrderedDict, self).__init__(*args, **kwargs)
37 self._keys = [] # record key order
39 def __setitem__(self, key, value):
40 super(_OrderedDict, self).__setitem__(key, value)
41 self._keys.append(key)
44 for key in self._keys:
48 collections.OrderedDict = _OrderedDict
51 def read_config(path=None, encoding=None):
52 "Read config from json file"
58 nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
60 # read only the first line from the pipe
61 sha1_bytes = subprocess.Popen(
62 ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'],
63 stdout=subprocess.PIPE).stdout.readline()
64 sha1 = sha1_bytes.decode(encoding).rstrip()
66 fp_byte_stream = subprocess.Popen(
67 ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
68 sha1+':status-config.json'],
69 stdout=subprocess.PIPE).stdout
70 fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream)
77 self.running_data = {}
81 def __init__(self, header=None, footer=None):
85 def write(self, database, views, stream=None):
88 byte_stream = sys.stdout.buffer
89 except AttributeError: # Python 2
90 byte_stream = sys.stdout
91 stream = codecs.getwriter(encoding='UTF-8')(stream=byte_stream)
92 self._write_header(views=views, stream=stream)
94 self._write_view(database=database, view=view, stream=stream)
95 self._write_footer(views=views, stream=stream)
97 def _write_header(self, views, stream):
99 stream.write(self.header)
101 def _write_footer(self, views, stream):
103 stream.write(self.footer)
105 def _write_view(self, database, view, stream):
106 if 'query-string' not in view:
107 query = view['query']
108 view['query-string'] = ' and '.join(query)
109 q = notmuch.Query(database, view['query-string'])
110 q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
111 threads = self._get_threads(messages=q.search_messages())
112 self._write_view_header(view=view, stream=stream)
113 self._write_threads(threads=threads, stream=stream)
115 def _get_threads(self, messages):
116 threads = collections.OrderedDict()
117 for message in messages:
118 thread_id = message.get_thread_id()
119 if thread_id in threads:
120 thread = threads[thread_id]
123 threads[thread_id] = thread
124 thread.running_data, display_data = self._message_display_data(
125 running_data=thread.running_data, message=message)
126 thread.append(display_data)
127 return list(threads.values())
129 def _write_view_header(self, view, stream):
132 def _write_threads(self, threads, stream):
133 for thread in threads:
134 for message_display_data in thread:
136 ('{date:10.10s} {from:20.20s} {subject:40.40s}\n'
137 '{message-id-term:>72}\n'
138 ).format(**message_display_data))
139 if thread != threads[-1]:
142 def _message_display_data(self, running_data, message):
143 headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
145 for header in headers:
146 if header == 'thread-id':
147 value = message.get_thread_id()
148 elif header == 'message-id':
149 value = message.get_message_id()
150 data['message-id-term'] = 'id:"{0}"'.format(value)
151 elif header == 'date':
152 value = str(datetime.datetime.utcfromtimestamp(
153 message.get_date()).date())
155 value = message.get_header(header)
157 (value, addr) = email.utils.parseaddr(value)
159 value = addr.split('@')[0]
161 next_running_data = data.copy()
162 for header, value in data.items():
163 if header in ['message-id', 'subject']:
165 if value == running_data.get(header, None):
167 return (next_running_data, data)
170 class HtmlPage (Page):
171 def _write_header(self, views, stream):
172 super(HtmlPage, self)._write_header(views=views, stream=stream)
173 stream.write('<ul>\n')
176 '<li><a href="#{title}">{title}</a></li>\n'.format(**view))
177 stream.write('</ul>\n')
179 def _write_view_header(self, view, stream):
180 stream.write('<h3><a name="{title}" />{title}</h3>\n'.format(**view))
181 if 'comment' in view:
182 stream.write(view['comment'])
185 'The view is generated from the following query:',
187 view['query-string'],
193 def _write_threads(self, threads, stream):
196 stream.write('<table>\n')
197 for thread in threads:
198 for message_display_data in thread:
201 '</td><td>{message-id-term}\n'
204 '</td><td>{subject}\n'
206 ).format(**message_display_data))
207 if thread != threads[-1]:
208 stream.write('<tr><td colspan="2"><br /></td></tr>\n')
209 stream.write('</table>\n')
211 def _message_display_data(self, *args, **kwargs):
212 running_data, display_data = super(
213 HtmlPage, self)._message_display_data(
215 if 'subject' in display_data and 'message-id' in display_data:
217 'message-id': quote(display_data['message-id']),
218 'subject': display_data['subject'],
220 display_data['subject'] = (
221 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
223 return (running_data, display_data)
226 _PAGES['text'] = Page()
227 _PAGES['html'] = HtmlPage(
228 header='''<?xml version="1.0" encoding="utf-8" ?>
229 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
230 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
232 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
233 <title>Notmuch Patches</title>
236 <h2>Notmuch Patches</h2>
237 Generated: {date}<br />
238 For more infomation see <a href="http://notmuchmail.org/nmbug">nmbug</a>
240 '''.format(date=datetime.datetime.utcnow().date()),
241 footer='</body>\n</html>\n',
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)
260 for view in config['views']:
263 elif args.get_query != None:
264 for view in config['views']:
265 if args.get_query == view['title']:
266 print(' and '.join(view['query']))
269 # only import notmuch if needed
273 page = _PAGES['text']
275 page = _PAGES['html']
277 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
278 page.write(database=db, views=config['views'])