2 This file is part of notmuch.
4 Notmuch is free software: you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation, either version 3 of the License, or (at your
7 option) any later version.
9 Notmuch is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with notmuch. If not, see <http://www.gnu.org/licenses/>.
17 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
20 from ctypes import c_char_p, c_void_p, c_long
21 from notmuch.globals import nmlib, STATUS, NotmuchError
22 from notmuch.message import Messages
23 from notmuch.tag import Tags
24 from datetime import date
26 #------------------------------------------------------------------------------
27 class Threads(object):
28 """Represents a list of notmuch threads
30 This object provides an iterator over a list of notmuch threads
31 (Technically, it provides a wrapper for the underlying
32 *notmuch_threads_t* structure). Do note that the underlying
33 library only provides a one-time iterator (it cannot reset the
34 iterator to the start). Thus iterating over the function will
35 "exhaust" the list of threads, and a subsequent iteration attempt
36 will raise a :exc:`NotmuchError` STATUS.NOT_INITIALIZED. Also
37 note, that any function that uses iteration will also
38 exhaust the messages. So both::
40 for thread in threads: print thread
44 number_of_msgs = len(threads)
46 will "exhaust" the threads. If you need to re-iterate over a list of
47 messages you will need to retrieve a new :class:`Threads` object.
49 Things are not as bad as it seems though, you can store and reuse
50 the single Thread objects as often as you want as long as you
51 keep the parent Threads object around. (Recall that due to
52 hierarchical memory allocation, all derived Threads objects will
53 be invalid when we delete the parent Threads() object, even if it
54 was already "exhausted".) So this works::
57 threads = Query(db,'').search_threads() #get a Threads() object
59 for thread in threads:
60 threadlist.append(thread)
62 # threads is "exhausted" now and even len(threads) will raise an
64 # However it will be kept around until all retrieved Thread() objects are
65 # also deleted. If you did e.g. an explicit del(threads) here, the
66 # following lines would fail.
68 # You can reiterate over *threadlist* however as often as you want.
69 # It is simply a list with Thread objects.
71 print (threadlist[0].get_thread_id())
72 print (threadlist[1].get_thread_id())
73 print (threadlist[0].get_total_messages())
77 _get = nmlib.notmuch_threads_get
78 _get.restype = c_void_p
80 def __init__(self, threads_p, parent=None):
82 :param threads_p: A pointer to an underlying *notmuch_threads_t*
83 structure. These are not publically exposed, so a user
84 will almost never instantiate a :class:`Threads` object
85 herself. They are usually handed back as a result,
86 e.g. in :meth:`Query.search_threads`. *threads_p* must be
87 valid, we will raise an :exc:`NotmuchError`
88 (STATUS.NULL_POINTER) if it is `None`.
89 :type threads_p: :class:`ctypes.c_void_p`
90 :param parent: The parent object
91 (ie :class:`Query`) these tags are derived from. It saves
92 a reference to it, so we can automatically delete the db
93 object once all derived objects are dead.
94 :TODO: Make the iterator work more than once and cache the tags in
98 NotmuchError(STATUS.NULL_POINTER)
100 self._threads = threads_p
101 #store parent, so we keep them alive as long as self is alive
102 self._parent = parent
105 """ Make Threads an iterator """
109 if self._threads is None:
110 raise NotmuchError(STATUS.NOT_INITIALIZED)
112 if not nmlib.notmuch_threads_valid(self._threads):
116 thread = Thread(Threads._get (self._threads), self)
117 nmlib.notmuch_threads_move_to_next(self._threads)
121 """len(:class:`Threads`) returns the number of contained Threads
123 .. note:: As this iterates over the threads, we will not be able to
124 iterate over them again! So this will fail::
127 threads = Database().create_query('').search_threads()
128 if len(threads) > 0: #this 'exhausts' threads
129 # next line raises NotmuchError(STATUS.NOT_INITIALIZED)!!!
130 for thread in threads: print thread
132 if self._threads is None:
133 raise NotmuchError(STATUS.NOT_INITIALIZED)
136 # returns 'bool'. On out-of-memory it returns None
137 while nmlib.notmuch_threads_valid(self._threads):
138 nmlib.notmuch_threads_move_to_next(self._threads)
140 # reset self._threads to mark as "exhausted"
144 def __nonzero__(self):
145 """Check if :class:`Threads` contains at least one more valid thread
147 The existence of this function makes 'if Threads: foo' work, as
148 that will implicitely call len() exhausting the iterator if
149 __nonzero__ does not exist. This function makes `bool(Threads())`
152 :return: True if there is at least one more thread in the
153 Iterator, False if not. None on a "Out-of-memory" error.
155 return self._threads is not None and \
156 nmlib.notmuch_threads_valid(self._threads) > 0
159 """Close and free the notmuch Threads"""
160 if self._threads is not None:
161 nmlib.notmuch_messages_destroy (self._threads)
163 #------------------------------------------------------------------------------
164 class Thread(object):
165 """Represents a single message thread."""
167 """notmuch_thread_get_thread_id"""
168 _get_thread_id = nmlib.notmuch_thread_get_thread_id
169 _get_thread_id.restype = c_char_p
171 """notmuch_thread_get_authors"""
172 _get_authors = nmlib.notmuch_thread_get_authors
173 _get_authors.restype = c_char_p
175 """notmuch_thread_get_subject"""
176 _get_subject = nmlib.notmuch_thread_get_subject
177 _get_subject.restype = c_char_p
179 """notmuch_thread_get_toplevel_messages"""
180 _get_toplevel_messages = nmlib.notmuch_thread_get_toplevel_messages
181 _get_toplevel_messages.restype = c_void_p
183 _get_newest_date = nmlib.notmuch_thread_get_newest_date
184 _get_newest_date.restype = c_long
186 _get_oldest_date = nmlib.notmuch_thread_get_oldest_date
187 _get_oldest_date.restype = c_long
189 """notmuch_thread_get_tags"""
190 _get_tags = nmlib.notmuch_thread_get_tags
191 _get_tags.restype = c_void_p
193 def __init__(self, thread_p, parent=None):
195 :param thread_p: A pointer to an internal notmuch_thread_t
196 Structure. These are not publically exposed, so a user
197 will almost never instantiate a :class:`Thread` object
198 herself. They are usually handed back as a result,
199 e.g. when iterating through :class:`Threads`. *thread_p*
200 must be valid, we will raise an :exc:`NotmuchError`
201 (STATUS.NULL_POINTER) if it is `None`.
203 :param parent: A 'parent' object is passed which this message is
204 derived from. We save a reference to it, so we can
205 automatically delete the parent object once all derived
209 NotmuchError(STATUS.NULL_POINTER)
210 self._thread = thread_p
211 #keep reference to parent, so we keep it alive
212 self._parent = parent
214 def get_thread_id(self):
215 """Get the thread ID of 'thread'
217 The returned string belongs to 'thread' and will only be valid
218 for as long as the thread is valid.
220 :returns: String with a message ID
221 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread
224 if self._thread is None:
225 raise NotmuchError(STATUS.NOT_INITIALIZED)
226 return Thread._get_thread_id(self._thread)
228 def get_total_messages(self):
229 """Get the total number of messages in 'thread'
231 :returns: The number of all messages in the database
232 belonging to this thread. Contrast with
233 :meth:`get_matched_messages`.
234 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread
237 if self._thread is None:
238 raise NotmuchError(STATUS.NOT_INITIALIZED)
239 return nmlib.notmuch_thread_get_total_messages(self._thread)
242 def get_toplevel_messages(self):
243 """Returns a :class:`Messages` iterator for the top-level messages in
246 This iterator will not necessarily iterate over all of the messages
247 in the thread. It will only iterate over the messages in the thread
248 which are not replies to other messages in the thread.
250 To iterate over all messages in the thread, the caller will need to
251 iterate over the result of :meth:`Message.get_replies` for each
252 top-level message (and do that recursively for the resulting
255 :returns: :class:`Messages`
256 :exception: :exc:`NotmuchError`
258 * STATUS.NOT_INITIALIZED if query is not inited
259 * STATUS.NULL_POINTER if search_messages failed
261 if self._thread is None:
262 raise NotmuchError(STATUS.NOT_INITIALIZED)
264 msgs_p = Thread._get_toplevel_messages(self._thread)
267 NotmuchError(STATUS.NULL_POINTER)
269 return Messages(msgs_p,self)
271 def get_matched_messages(self):
272 """Returns the number of messages in 'thread' that matched the query
274 :returns: The number of all messages belonging to this thread that
275 matched the :class:`Query`from which this thread was created.
276 Contrast with :meth:`get_total_messages`.
277 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread
280 if self._thread is None:
281 raise NotmuchError(STATUS.NOT_INITIALIZED)
282 return nmlib.notmuch_thread_get_matched_messages(self._thread)
284 def get_authors(self):
285 """Returns the authors of 'thread'
287 The returned string is a comma-separated list of the names of the
288 authors of mail messages in the query results that belong to this
291 The returned string belongs to 'thread' and will only be valid for
292 as long as this Thread() is not deleted.
294 if self._thread is None:
295 raise NotmuchError(STATUS.NOT_INITIALIZED)
296 return Thread._get_authors(self._thread)
298 def get_subject(self):
299 """Returns the Subject of 'thread'
301 The returned string belongs to 'thread' and will only be valid for
302 as long as this Thread() is not deleted.
304 if self._thread is None:
305 raise NotmuchError(STATUS.NOT_INITIALIZED)
306 return Thread._get_subject(self._thread)
308 def get_newest_date(self):
309 """Returns time_t of the newest message date
311 :returns: A time_t timestamp.
313 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
316 if self._thread is None:
317 raise NotmuchError(STATUS.NOT_INITIALIZED)
318 return Thread._get_newest_date(self._thread)
320 def get_oldest_date(self):
321 """Returns time_t of the oldest message date
323 :returns: A time_t timestamp.
325 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
328 if self._thread is None:
329 raise NotmuchError(STATUS.NOT_INITIALIZED)
330 return Thread._get_oldest_date(self._thread)
333 """ Returns the message tags
335 In the Notmuch database, tags are stored on individual
336 messages, not on threads. So the tags returned here will be all
337 tags of the messages which matched the search and which belong to
340 The :class:`Tags` object is owned by the thread and as such, will only
341 be valid for as long as this :class:`Thread` is valid (e.g. until the
342 query from which it derived is explicitely deleted).
344 :returns: A :class:`Tags` iterator.
345 :exception: :exc:`NotmuchError`
347 * STATUS.NOT_INITIALIZED if the thread
349 * STATUS.NULL_POINTER, on error
351 if self._thread is None:
352 raise NotmuchError(STATUS.NOT_INITIALIZED)
354 tags_p = Thread._get_tags(self._thread)
356 raise NotmuchError(STATUS.NULL_POINTER)
357 return Tags(tags_p, self)
360 """A str(Thread()) is represented by a 1-line summary"""
362 thread['id'] = self.get_thread_id()
364 ###TODO: How do we find out the current sort order of Threads?
365 ###Add a "sort" attribute to the Threads() object?
366 #if (sort == NOTMUCH_SORT_OLDEST_FIRST)
367 # date = notmuch_thread_get_oldest_date (thread);
369 # date = notmuch_thread_get_newest_date (thread);
370 thread['date'] = date.fromtimestamp(self.get_newest_date())
371 thread['matched'] = self.get_matched_messages()
372 thread['total'] = self.get_total_messages()
373 thread['authors'] = self.get_authors()
374 thread['subject'] = self.get_subject()
375 thread['tags'] = self.get_tags()
377 return "thread:%(id)s %(date)12s [%(matched)d/%(total)d] %(authors)s; %(subject)s (%(tags)s)" % (thread)
380 """Close and free the notmuch Thread"""
381 if self._thread is not None:
382 nmlib.notmuch_thread_destroy (self._thread)