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
8 # - collections.OrderedDict; python 2.7
10 from __future__ import print_function
11 from __future__ import unicode_literals
19 from urllib.parse import quote
20 except ImportError: # Python 2
21 from urllib import quote
29 _ENCODING = locale.getpreferredencoding() or sys.getdefaultencoding()
33 def read_config(path=None, encoding=None):
34 "Read config from json file"
40 nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
42 # read only the first line from the pipe
43 sha1_bytes = subprocess.Popen(
44 ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'],
45 stdout=subprocess.PIPE).stdout.readline()
46 sha1 = sha1_bytes.decode(encoding).rstrip()
48 fp_byte_stream = subprocess.Popen(
49 ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
50 sha1+':status-config.json'],
51 stdout=subprocess.PIPE).stdout
52 fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream)
59 self.running_data = {}
63 def __init__(self, header=None, footer=None):
67 def write(self, database, views, stream=None):
70 byte_stream = sys.stdout.buffer
71 except AttributeError: # Python 2
72 byte_stream = sys.stdout
73 stream = codecs.getwriter(encoding='UTF-8')(stream=byte_stream)
74 self._write_header(views=views, stream=stream)
76 self._write_view(database=database, view=view, stream=stream)
77 self._write_footer(views=views, stream=stream)
79 def _write_header(self, views, stream):
81 stream.write(self.header)
83 def _write_footer(self, views, stream):
85 stream.write(self.footer)
87 def _write_view(self, database, view, stream):
88 if 'query-string' not in view:
90 view['query-string'] = ' and '.join(query)
91 q = notmuch.Query(database, view['query-string'])
92 q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
93 threads = self._get_threads(messages=q.search_messages())
94 self._write_view_header(view=view, stream=stream)
95 self._write_threads(threads=threads, stream=stream)
97 def _get_threads(self, messages):
98 threads = collections.OrderedDict()
99 for message in messages:
100 thread_id = message.get_thread_id()
101 if thread_id in threads:
102 thread = threads[thread_id]
105 threads[thread_id] = thread
106 thread.running_data, display_data = self._message_display_data(
107 running_data=thread.running_data, message=message)
108 thread.append(display_data)
109 return list(threads.values())
111 def _write_view_header(self, view, stream):
114 def _write_threads(self, threads, stream):
115 for thread in threads:
116 for message_display_data in thread:
118 ('{date:10.10s} {from:20.20s} {subject:40.40s}\n'
119 '{message-id-term:>72}\n'
120 ).format(**message_display_data))
121 if thread != threads[-1]:
124 def _message_display_data(self, running_data, message):
125 headers = ('thread-id', 'message-id', 'date', 'from', 'subject')
127 for header in headers:
128 if header == 'thread-id':
129 value = message.get_thread_id()
130 elif header == 'message-id':
131 value = message.get_message_id()
132 data['message-id-term'] = 'id:"{0}"'.format(value)
133 elif header == 'date':
134 value = str(datetime.datetime.utcfromtimestamp(
135 message.get_date()).date())
137 value = message.get_header(header)
139 (value, addr) = email.utils.parseaddr(value)
141 value = addr.split('@')[0]
143 next_running_data = data.copy()
144 for header, value in data.items():
145 if header in ['message-id', 'subject']:
147 if value == running_data.get(header, None):
149 return (next_running_data, data)
152 class HtmlPage (Page):
153 def _write_header(self, views, stream):
154 super(HtmlPage, self)._write_header(views=views, stream=stream)
155 stream.write('<ul>\n')
158 '<li><a href="#{title}">{title}</a></li>\n'.format(**view))
159 stream.write('</ul>\n')
161 def _write_view_header(self, view, stream):
162 stream.write('<h3><a name="{title}" />{title}</h3>\n'.format(**view))
163 if 'comment' in view:
164 stream.write(view['comment'])
167 'The view is generated from the following query:',
169 view['query-string'],
175 def _write_threads(self, threads, stream):
178 stream.write('<table>\n')
179 for thread in threads:
180 for message_display_data in thread:
183 '</td><td>{message-id-term}\n'
186 '</td><td>{subject}\n'
188 ).format(**message_display_data))
189 if thread != threads[-1]:
190 stream.write('<tr><td colspan="2"><br /></td></tr>\n')
191 stream.write('</table>\n')
193 def _message_display_data(self, *args, **kwargs):
194 running_data, display_data = super(
195 HtmlPage, self)._message_display_data(
197 if 'subject' in display_data and 'message-id' in display_data:
199 'message-id': quote(display_data['message-id']),
200 'subject': display_data['subject'],
202 display_data['subject'] = (
203 '<a href="http://mid.gmane.org/{message-id}">{subject}</a>'
205 return (running_data, display_data)
208 _PAGES['text'] = Page()
209 _PAGES['html'] = HtmlPage(
210 header='''<?xml version="1.0" encoding="utf-8" ?>
211 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
212 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
214 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
215 <title>Notmuch Patches</title>
218 <h2>Notmuch Patches</h2>
219 Generated: {date}<br />
220 For more infomation see <a href="http://notmuchmail.org/nmbug">nmbug</a>
222 '''.format(date=datetime.datetime.utcnow().date()),
223 footer='</body>\n</html>\n',
227 parser = argparse.ArgumentParser()
228 parser.add_argument('--text', help='output plain text format',
230 parser.add_argument('--config', help='load config from given file',
232 parser.add_argument('--list-views', help='list views',
234 parser.add_argument('--get-query', help='get query for view',
237 args = parser.parse_args()
239 config = read_config(path=args.config)
242 for view in config['views']:
245 elif args.get_query != None:
246 for view in config['views']:
247 if args.get_query == view['title']:
248 print(' and '.join(view['query']))
251 # only import notmuch if needed
255 page = _PAGES['text']
257 page = _PAGES['html']
259 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
260 page.write(database=db, views=config['views'])