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
27 import xml.sax.saxutils
30 _ENCODING = locale.getpreferredencoding() or sys.getdefaultencoding()
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
41 def __setitem__(self, key, value):
42 super(_OrderedDict, self).__setitem__(key, value)
43 self._keys.append(key)
46 for key in self._keys:
50 collections.OrderedDict = _OrderedDict
53 def read_config(path=None, encoding=None):
54 "Read config from json file"
60 nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
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()
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)
79 self.running_data = {}
83 def __init__(self, header=None, footer=None):
87 def write(self, database, views, stream=None):
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)
96 self._write_view(database=database, view=view, stream=stream)
97 self._write_footer(views=views, stream=stream)
99 def _write_header(self, views, stream):
101 stream.write(self.header)
103 def _write_footer(self, views, stream):
105 stream.write(self.footer)
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)
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]
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())
131 def _write_view_header(self, view, stream):
134 def _write_threads(self, threads, stream):
135 for thread in threads:
136 for message_display_data in thread:
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]:
144 def _message_display_data(self, running_data, message):
145 headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
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())
157 value = message.get_header(header)
159 (value, addr) = email.utils.parseaddr(value)
161 value = addr.split('@')[0]
163 next_running_data = data.copy()
164 for header, value in data.items():
165 if header in ['message-id', 'subject']:
167 if value == running_data.get(header, None):
169 return (next_running_data, data)
172 class HtmlPage (Page):
173 _slug_regexp = re.compile('\W+')
175 def _write_header(self, views, stream):
176 super(HtmlPage, self)._write_header(views=views, stream=stream)
177 stream.write('<ul>\n')
180 view['id'] = self._slug(view['title'])
182 '<li><a href="#{id}">{title}</a></li>\n'.format(**view))
183 stream.write('</ul>\n')
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'])
192 'The view is generated from the following query:',
196 view['query-string'],
203 def _write_threads(self, threads, stream):
206 stream.write('<table>\n')
207 for thread in threads:
208 for message_display_data in thread:
212 ' <td><code>{message-id-term}</code></td>\n'
216 ' <td>{subject}</td>\n'
218 ).format(**message_display_data))
219 if thread != threads[-1]:
220 stream.write('<tr><td colspan="2"><br /></td></tr>\n')
221 stream.write('</table>\n')
223 def _message_display_data(self, *args, **kwargs):
224 running_data, display_data = super(
225 HtmlPage, self)._message_display_data(
227 if 'subject' in display_data and 'message-id' in display_data:
229 'message-id': quote(display_data['message-id']),
230 'subject': xml.sax.saxutils.escape(display_data['subject']),
232 display_data['subject'] = (
233 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
235 for key in ['message-id', 'from']:
236 if key in display_data:
237 display_data[key] = xml.sax.saxutils.escape(display_data[key])
238 return (running_data, display_data)
240 def _slug(self, string):
241 return self._slug_regexp.sub('-', string)
244 _PAGES['text'] = Page()
245 _PAGES['html'] = HtmlPage(
246 header='''<!DOCTYPE html>
249 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
250 <title>Notmuch Patches</title>
253 <h2>Notmuch Patches</h2>
255 Generated: {date}<br />
256 For more infomation see <a href="http://notmuchmail.org/nmbug">nmbug</a>
259 '''.format(date=datetime.datetime.utcnow().date()),
260 footer='</body>\n</html>\n',
264 parser = argparse.ArgumentParser()
265 parser.add_argument('--text', help='output plain text format',
267 parser.add_argument('--config', help='load config from given file',
269 parser.add_argument('--list-views', help='list views',
271 parser.add_argument('--get-query', help='get query for view',
274 args = parser.parse_args()
276 config = read_config(path=args.config)
279 for view in config['views']:
282 elif args.get_query != None:
283 for view in config['views']:
284 if args.get_query == view['title']:
285 print(' and '.join(view['query']))
288 # only import notmuch if needed
292 page = _PAGES['text']
294 page = _PAGES['html']
296 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
297 page.write(database=db, views=config['views'])