Merge Sebastian Spaeth's python bindings into bindings/python
[notmuch] / bindings / python / notmuch / thread.py
1 """
2 This file is part of notmuch.
3
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.
8
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
12 for more details.
13
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/>.
16
17 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
18 """
19
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
25
26 #------------------------------------------------------------------------------
27 class Threads(object):
28     """Represents a list of notmuch threads
29
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::
39
40       for thread in threads: print thread
41
42     as well as::
43
44        number_of_msgs = len(threads)
45
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.
48
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::
55
56       db   = Database()
57       threads = Query(db,'').search_threads() #get a Threads() object
58       threadlist = []
59       for thread in threads:
60          threadlist.append(thread)
61
62       # threads is "exhausted" now and even len(threads) will raise an 
63       # exception.
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.
67       
68       # You can reiterate over *threadlist* however as often as you want. 
69       # It is simply a list with Thread objects.
70
71       print (threadlist[0].get_thread_id())
72       print (threadlist[1].get_thread_id())
73       print (threadlist[0].get_total_messages())
74     """
75
76     #notmuch_threads_get
77     _get = nmlib.notmuch_threads_get
78     _get.restype = c_void_p
79
80     def __init__(self, threads_p, parent=None):
81         """
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 
95                the Python object.(?)
96         """
97         if threads_p is None:
98             NotmuchError(STATUS.NULL_POINTER)
99
100         self._threads = threads_p
101         #store parent, so we keep them alive as long as self  is alive
102         self._parent = parent
103
104     def __iter__(self):
105         """ Make Threads an iterator """
106         return self
107
108     def next(self):
109         if self._threads is None:
110             raise NotmuchError(STATUS.NOT_INITIALIZED)
111
112         if not nmlib.notmuch_threads_valid(self._threads):
113             self._threads = None
114             raise StopIteration
115
116         thread = Thread(Threads._get (self._threads), self)
117         nmlib.notmuch_threads_move_to_next(self._threads)
118         return thread
119
120     def __len__(self):
121         """len(:class:`Threads`) returns the number of contained Threads
122
123         .. note:: As this iterates over the threads, we will not be able to 
124                iterate over them again! So this will fail::
125
126                  #THIS FAILS
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
131         """
132         if self._threads is None:
133             raise NotmuchError(STATUS.NOT_INITIALIZED)
134
135         i=0
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)
139             i += 1
140         # reset self._threads to mark as "exhausted"
141         self._threads = None
142         return i
143
144
145
146     def __del__(self):
147         """Close and free the notmuch Threads"""
148         if self._threads is not None:
149             nmlib.notmuch_messages_destroy (self._threads)
150
151 #------------------------------------------------------------------------------
152 class Thread(object):
153     """Represents a single message thread."""
154
155     """notmuch_thread_get_thread_id"""
156     _get_thread_id = nmlib.notmuch_thread_get_thread_id
157     _get_thread_id.restype = c_char_p
158
159     """notmuch_thread_get_authors"""
160     _get_authors = nmlib.notmuch_thread_get_authors
161     _get_authors.restype = c_char_p
162
163     """notmuch_thread_get_subject"""
164     _get_subject = nmlib.notmuch_thread_get_subject
165     _get_subject.restype = c_char_p
166
167     """notmuch_thread_get_toplevel_messages"""
168     _get_toplevel_messages = nmlib.notmuch_thread_get_toplevel_messages
169     _get_toplevel_messages.restype = c_void_p
170
171     _get_newest_date = nmlib.notmuch_thread_get_newest_date
172     _get_newest_date.restype = c_long
173
174     _get_oldest_date = nmlib.notmuch_thread_get_oldest_date
175     _get_oldest_date.restype = c_long
176
177     """notmuch_thread_get_tags"""
178     _get_tags = nmlib.notmuch_thread_get_tags
179     _get_tags.restype = c_void_p
180
181     def __init__(self, thread_p, parent=None):
182         """
183         :param thread_p: A pointer to an internal notmuch_thread_t
184             Structure.  These are not publically exposed, so a user
185             will almost never instantiate a :class:`Thread` object
186             herself. They are usually handed back as a result,
187             e.g. when iterating through :class:`Threads`. *thread_p*
188             must be valid, we will raise an :exc:`NotmuchError`
189             (STATUS.NULL_POINTER) if it is `None`.
190
191         :param parent: A 'parent' object is passed which this message is
192               derived from. We save a reference to it, so we can
193               automatically delete the parent object once all derived
194               objects are dead.
195         """
196         if thread_p is None:
197             NotmuchError(STATUS.NULL_POINTER)
198         self._thread = thread_p
199         #keep reference to parent, so we keep it alive
200         self._parent = parent
201
202     def get_thread_id(self):
203         """Get the thread ID of 'thread'
204
205         The returned string belongs to 'thread' and will only be valid
206         for as long as the thread is valid.
207
208         :returns: String with a message ID
209         :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread 
210                     is not initialized.
211         """
212         if self._thread is None:
213             raise NotmuchError(STATUS.NOT_INITIALIZED)
214         return Thread._get_thread_id(self._thread)
215
216     def get_total_messages(self):
217         """Get the total number of messages in 'thread'
218
219         :returns: The number of all messages in the database
220                   belonging to this thread. Contrast with
221                   :meth:`get_matched_messages`.
222         :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread 
223                     is not initialized.
224         """
225         if self._thread is None:
226             raise NotmuchError(STATUS.NOT_INITIALIZED)
227         return nmlib.notmuch_thread_get_total_messages(self._thread)
228
229
230     def get_toplevel_messages(self):
231         """Returns a :class:`Messages` iterator for the top-level messages in
232            'thread'
233
234            This iterator will not necessarily iterate over all of the messages
235            in the thread. It will only iterate over the messages in the thread
236            which are not replies to other messages in the thread.
237  
238            To iterate over all messages in the thread, the caller will need to
239            iterate over the result of :meth:`Message.get_replies` for each
240            top-level message (and do that recursively for the resulting
241            messages, etc.).
242
243         :returns: :class:`Messages`
244         :exception: :exc:`NotmuchError`
245
246                       * STATUS.NOT_INITIALIZED if query is not inited
247                       * STATUS.NULL_POINTER if search_messages failed 
248         """
249         if self._thread is None:
250             raise NotmuchError(STATUS.NOT_INITIALIZED)
251
252         msgs_p = Thread._get_toplevel_messages(self._thread)
253
254         if msgs_p is None:
255             NotmuchError(STATUS.NULL_POINTER)
256
257         return Messages(msgs_p,self)
258
259     def get_matched_messages(self):
260         """Returns the number of messages in 'thread' that matched the query
261
262         :returns: The number of all messages belonging to this thread that 
263                   matched the :class:`Query`from which this thread was created.
264                   Contrast with :meth:`get_total_messages`.
265         :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread 
266                     is not initialized.
267         """
268         if self._thread is None:
269             raise NotmuchError(STATUS.NOT_INITIALIZED)
270         return nmlib.notmuch_thread_get_matched_messages(self._thread)
271
272     def get_authors(self):
273         """Returns the authors of 'thread'
274
275         The returned string is a comma-separated list of the names of the
276         authors of mail messages in the query results that belong to this
277         thread.
278
279         The returned string belongs to 'thread' and will only be valid for 
280         as long as this Thread() is not deleted.
281         """
282         if self._thread is None:
283             raise NotmuchError(STATUS.NOT_INITIALIZED)
284         return Thread._get_authors(self._thread)
285
286     def get_subject(self):
287         """Returns the Subject of 'thread'
288
289         The returned string belongs to 'thread' and will only be valid for 
290         as long as this Thread() is not deleted.
291         """
292         if self._thread is None:
293             raise NotmuchError(STATUS.NOT_INITIALIZED)
294         return Thread._get_subject(self._thread)
295
296     def get_newest_date(self):
297         """Returns time_t of the newest message date
298
299         :returns: A time_t timestamp.
300         :rtype: c_unit64
301         :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
302                     is not initialized.
303         """
304         if self._thread is None:
305             raise NotmuchError(STATUS.NOT_INITIALIZED)
306         return Thread._get_newest_date(self._thread)
307
308     def get_oldest_date(self):
309         """Returns time_t of the oldest message date
310
311         :returns: A time_t timestamp.
312         :rtype: c_unit64
313         :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
314                     is not initialized.
315         """
316         if self._thread is None:
317             raise NotmuchError(STATUS.NOT_INITIALIZED)
318         return Thread._get_oldest_date(self._thread)
319
320     def get_tags(self):
321         """ Returns the message tags
322
323         In the Notmuch database, tags are stored on individual
324         messages, not on threads. So the tags returned here will be all
325         tags of the messages which matched the search and which belong to
326         this thread.
327
328         The :class:`Tags` object is owned by the thread and as such, will only 
329         be valid for as long as this :class:`Thread` is valid (e.g. until the 
330         query from which it derived is explicitely deleted).
331
332         :returns: A :class:`Tags` iterator.
333         :exception: :exc:`NotmuchError`
334
335                       * STATUS.NOT_INITIALIZED if the thread 
336                         is not initialized.
337                       * STATUS.NULL_POINTER, on error
338         """
339         if self._thread is None:
340             raise NotmuchError(STATUS.NOT_INITIALIZED)
341
342         tags_p = Thread._get_tags(self._thread)
343         if tags_p == None:
344             raise NotmuchError(STATUS.NULL_POINTER)
345         return Tags(tags_p, self)
346  
347     def __str__(self):
348         """A str(Thread()) is represented by a 1-line summary"""
349         thread = {}
350         thread['id'] = self.get_thread_id()
351
352         ###TODO: How do we find out the current sort order of Threads?
353         ###Add a "sort" attribute to the Threads() object?
354         #if (sort == NOTMUCH_SORT_OLDEST_FIRST)
355         #         date = notmuch_thread_get_oldest_date (thread);
356         #else
357         #         date = notmuch_thread_get_newest_date (thread);
358         thread['date'] = date.fromtimestamp(self.get_newest_date())
359         thread['matched'] = self.get_matched_messages()
360         thread['total'] = self.get_total_messages()
361         thread['authors'] = self.get_authors()
362         thread['subject'] = self.get_subject()
363         thread['tags'] = self.get_tags()
364
365         return "thread:%(id)s %(date)12s [%(matched)d/%(total)d] %(authors)s; %(subject)s (%(tags)s)" % (thread)
366
367     def __del__(self):
368         """Close and free the notmuch Thread"""
369         if self._thread is not None:
370             nmlib.notmuch_thread_destroy (self._thread)