2 from ctypes import c_int, c_char_p, c_void_p
3 from cnotmuch.globals import nmlib, STATUS, NotmuchError
6 class Database(object):
7 """ Wrapper around a notmuch_database_t
9 Do note that as soon as we tear down this object, all derived queries,
10 threads, and messages will be freed as well.
17 """Class attribute of users default database"""
19 """notmuch_database_get_path (notmuch_database_t *database)"""
20 _get_path = nmlib.notmuch_database_get_path
21 _get_path.restype = c_char_p
23 """notmuch_database_open (const char *path, notmuch_database_mode_t mode)"""
24 _open = nmlib.notmuch_database_open
25 _open.restype = c_void_p
27 """ notmuch_database_find_message """
28 _find_message = nmlib.notmuch_database_find_message
29 _find_message.restype = c_void_p
31 """notmuch_database_get_all_tags (notmuch_database_t *database)"""
32 _get_all_tags = nmlib.notmuch_database_get_all_tags
33 _get_all_tags.restype = c_void_p
35 """ notmuch_database_create(const char *path):"""
36 _create = nmlib.notmuch_database_create
37 _create.restype = c_void_p
39 def __init__(self, path=None, create=False, status= MODE_READ_ONLY):
40 """ Open or create a notmuch database
42 If path is None, we will try to read a users notmuch configuration and
43 use his default database.
44 Throws a NotmuchError in case of failure.
48 # no path specified. use a user's default database
49 if Database._std_db_path is None:
50 #the following line throws a NotmuchError if it fails
51 Database._std_db_path = self._get_user_default_db()
52 path = Database._std_db_path
55 self.open(path, status)
57 self.create(path, status)
59 def create(self, path, status=MODE_READ_ONLY):
60 """ notmuch_database_create(const char *path)
62 :returns: Raises :exc:`notmuch.NotmuchError` in case
63 of any failure (after printing an error message on stderr).
65 res = Database._create(path, status)
69 message="Could not create the specified database")
72 def open(self, path, status= MODE_READ_ONLY):
73 """calls notmuch_database_open
75 :returns: Raises :exc:`notmuch.NotmuchError` in case
76 of any failure (after printing an error message on stderr).
78 res = Database._open(path, status)
82 message="Could not open the specified database")
86 """notmuch_database_get_path (notmuch_database_t *database); """
87 return Database._get_path(self._db)
89 def find_message(self, msgid):
90 """notmuch_database_find_message
91 :param msgid: The message id
94 :returns: Message() or None if no message is found or if an
95 out-of-memory situation occurs.
98 raise NotmuchError(STATUS.NOT_INITIALIZED)
99 msg_p = Database._find_message(self._db, msgid)
102 return Message(msg_p, self)
104 def get_all_tags(self):
105 """Return a Tags() object (list of all tags found in the database)
107 :returns: Tags() object or raises :exc:`NotmuchError` with
108 STATUS.NULL_POINTER on error
111 raise NotmuchError(STATUS.NOT_INITIALIZED)
113 tags_p = Database._get_all_tags (self._db)
115 raise NotmuchError(STATUS.NULL_POINTER)
116 return Tags(tags_p, self)
119 return "'Notmuch DB " + self.get_path() + "'"
122 """Close and free the notmuch database if needed"""
123 if self._db is not None:
124 logging.debug("Freeing the database now")
125 nmlib.notmuch_database_close(self._db)
127 def _get_user_default_db(self):
128 """ Reads a user's notmuch config and returns his db location
130 Throws a NotmuchError if it cannot find it"""
131 from ConfigParser import SafeConfigParser
133 config = SafeConfigParser()
134 config.read(os.path.expanduser('~/.notmuch-config'))
135 if not config.has_option('database','path'):
136 raise NotmuchError(message=
137 "No DB path specified and no user default found")
138 return config.get('database','path')
142 """Returns a pointer to the current notmuch_database_t or None"""
145 #------------------------------------------------------------------------------
147 """ Wrapper around a notmuch_query_t
149 Do note that as soon as we tear down this object, all derived
150 threads, and messages will be freed as well.
153 SORT_OLDEST_FIRST = 0
154 SORT_NEWEST_FIRST = 1
157 """notmuch_query_create"""
158 _create = nmlib.notmuch_query_create
159 _create.restype = c_void_p
161 """notmuch_query_search_messages"""
162 _search_messages = nmlib.notmuch_query_search_messages
163 _search_messages.restype = c_void_p
165 def __init__(self, db, querystr):
169 self.create(db, querystr)
171 def create(self, db, querystr):
172 """db is a Database() and querystr a string
174 raises NotmuchError STATUS.NOT_INITIALIZED if db is not inited and
175 STATUS.NULL_POINTER if the query creation failed (too little memory)
178 raise NotmuchError(STATUS.NOT_INITIALIZED)
179 # create reference to parent db to keep it alive
182 # create query, return None if too little mem available
183 query_p = Query._create(db.db_p, querystr)
185 NotmuchError(STATUS.NULL_POINTER)
186 self._query = query_p
188 def set_sort(self, sort):
189 """notmuch_query_set_sort
191 :param sort: one of Query.SORT_OLDEST_FIRST|SORT_NEWEST_FIRST|SORT_MESSAGE_ID
192 :returns: Nothing, but raises NotmuchError if query is not inited
194 if self._query is None:
195 raise NotmuchError(STATUS.NOT_INITIALIZED)
197 nmlib.notmuch_query_set_sort(self._query, sort)
199 def search_messages(self):
200 """notmuch_query_search_messages
201 Returns Messages() or a raises a NotmuchError()
203 if self._query is None:
204 raise NotmuchError(STATUS.NOT_INITIALIZED)
206 msgs_p = Query._search_messages(self._query)
209 NotmuchError(STATUS.NULL_POINTER)
211 return Messages(msgs_p,self)
215 """Close and free the Query"""
216 if self._query is not None:
217 logging.debug("Freeing the Query now")
218 nmlib.notmuch_query_destroy (self._query)
220 #------------------------------------------------------------------------------
222 """Wrapper around notmuch_tags_t"""
225 _get = nmlib.notmuch_tags_get
226 _get.restype = c_char_p
228 def __init__(self, tags_p, db=None):
230 msg_p is a pointer to an notmuch_message_t Structure. If it is None,
231 we will raise an NotmuchError(STATUS.NULL_POINTER).
233 Is passed the db these tags are derived from, and saves a
234 reference to it, so we can automatically delete the db object
235 once all derived objects are dead.
237 Tags() provides an iterator over all contained tags. However, you will
238 only be able to iterate over the Tags once, because the underlying C
239 function only allows iterating once.
240 #TODO: make the iterator work more than once and cache the tags in
244 NotmuchError(STATUS.NULL_POINTER)
248 logging.debug("Inited Tags derived from %s" %(str(db)))
251 """ Make Tags an iterator """
255 if self._tags is None:
256 raise NotmuchError(STATUS.NOT_INITIALIZED)
258 if not nmlib.notmuch_tags_valid(self._tags):
262 tag = Tags._get (self._tags)
263 nmlib.notmuch_tags_move_to_next(self._tags)
267 """str() of Tags() is a space separated list of tags
269 This iterates over the list of Tags and will therefore 'exhaust' Tags()
271 return " ".join(self)
274 """Close and free the notmuch tags"""
275 if self._tags is not None:
276 logging.debug("Freeing the Tags now")
277 nmlib.notmuch_tags_destroy (self._tags)
280 #------------------------------------------------------------------------------
281 class Messages(object):
282 """Wrapper around notmuch_messages_t"""
285 _get = nmlib.notmuch_messages_get
286 _get.restype = c_void_p
288 _collect_tags = nmlib.notmuch_messages_collect_tags
289 _collect_tags.restype = c_void_p
291 def __init__(self, msgs_p, parent=None):
293 msg_p is a pointer to an notmuch_messages_t Structure. If it is None,
294 we will raise an NotmuchError(STATUS.NULL_POINTER).
296 If passed the parent query this Messages() is derived from, it saves a
297 reference to it, so we can automatically delete the parent query object
298 once all derived objects are dead.
300 Messages() provides an iterator over all contained Message()s.
301 However, you will only be able to iterate over it once,
302 because the underlying C function only allows iterating once.
303 #TODO: make the iterator work more than once and cache the tags in
307 NotmuchError(STATUS.NULL_POINTER)
310 #store parent, so we keep them alive as long as self is alive
311 self._parent = parent
312 logging.debug("Inited Messages derived from %s" %(str(parent)))
314 def collect_tags(self):
315 """ return the Tags() belonging to the messages
317 Do note that collect_tags will iterate over the messages and
318 therefore will not allow further iterationsl
319 Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
321 if self._msgs is None:
322 raise NotmuchError(STATUS.NOT_INITIALIZED)
324 # collect all tags (returns NULL on error)
325 tags_p = Messages._collect_tags (self._msgs)
326 #reset _msgs as we iterated over it and can do so only once
330 raise NotmuchError(STATUS.NULL_POINTER)
331 return Tags(tags_p, self)
334 """ Make Messages an iterator """
338 if self._msgs is None:
339 raise NotmuchError(STATUS.NOT_INITIALIZED)
341 if not nmlib.notmuch_messages_valid(self._msgs):
345 msg = Message(Messages._get (self._msgs), self)
346 nmlib.notmuch_messages_move_to_next(self._msgs)
350 """ Returns the number of contained messages
352 :note: As this iterates over the messages, we will not be able to
353 iterate over them again (as in retrieve them)!
355 if self._msgs is None:
356 raise NotmuchError(STATUS.NOT_INITIALIZED)
359 while nmlib.notmuch_messages_valid(self._msgs):
360 nmlib.notmuch_messages_move_to_next(self._msgs)
368 """Close and free the notmuch Messages"""
369 if self._msgs is not None:
370 logging.debug("Freeing the Messages now")
371 nmlib.notmuch_messages_destroy (self._msgs)
374 #------------------------------------------------------------------------------
375 class Message(object):
376 """Wrapper around notmuch_message_t"""
378 """notmuch_message_get_filename (notmuch_message_t *message)"""
379 _get_filename = nmlib.notmuch_message_get_filename
380 _get_filename.restype = c_char_p
381 """notmuch_message_get_message_id (notmuch_message_t *message)"""
382 _get_message_id = nmlib.notmuch_message_get_message_id
383 _get_message_id.restype = c_char_p
385 """notmuch_message_get_tags (notmuch_message_t *message)"""
386 _get_tags = nmlib.notmuch_message_get_tags
387 _get_tags.restype = c_void_p
389 def __init__(self, msg_p, parent=None):
391 msg_p is a pointer to an notmuch_message_t Structure. If it is None,
392 we will raise an NotmuchError(STATUS.NULL_POINTER).
394 Is a 'parent' object is passed which this message is derived from,
395 we save a reference to it, so we can automatically delete the parent
396 object once all derived objects are dead.
399 NotmuchError(STATUS.NULL_POINTER)
401 #keep reference to parent, so we keep it alive
402 self._parent = parent
403 logging.debug("Inited Message derived from %s" %(str(parent)))
406 def get_message_id(self):
407 """ return the msg id
409 Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
411 if self._msg is None:
412 raise NotmuchError(STATUS.NOT_INITIALIZED)
413 return Message._get_message_id(self._msg)
416 def get_filename(self):
417 """ return the msg filename
419 Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
421 if self._msg is None:
422 raise NotmuchError(STATUS.NOT_INITIALIZED)
423 return Message._get_filename(self._msg)
426 """ return the msg tags
428 Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
429 Raises NotmuchError(STATUS.NULL_POINTER) on error.
431 if self._msg is None:
432 raise NotmuchError(STATUS.NOT_INITIALIZED)
434 tags_p = Message._get_tags(self._msg)
436 raise NotmuchError(STATUS.NULL_POINTER)
437 return Tags(tags_p, self)
440 """Close and free the notmuch Message"""
441 if self._msg is not None:
442 logging.debug("Freeing the Message now")
443 nmlib.notmuch_message_destroy (self._msg)