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>'
22 from ctypes import c_char_p, c_void_p, c_uint, c_long, byref, POINTER
23 from notmuch.globals import (nmlib, STATUS, NotmuchError, NotInitializedError,
24 NullPointerError, Enum, _str,
25 NotmuchDatabaseP, NotmuchDirectoryP, NotmuchMessageP, NotmuchTagsP,
26 NotmuchQueryP, NotmuchMessagesP, NotmuchThreadsP, NotmuchFilenamesP)
27 from notmuch.thread import Threads
28 from notmuch.message import Messages, Message
29 from notmuch.tag import Tags
32 class Database(object):
33 """The :class:`Database` is the highest-level object that notmuch
34 provides. It references a notmuch database, and can be opened in
35 read-only or read-write mode. A :class:`Query` can be derived from
36 or be applied to a specific database to find messages. Also adding
37 and removing messages to the database happens via this
38 object. Modifications to the database are not atmic by default (see
39 :meth:`begin_atomic`) and once a database has been modified, all
40 other database objects pointing to the same data-base will throw an
41 :exc:`XapianError` as the underlying database has been
42 modified. Close and reopen the database to continue working with it.
46 Any function in this class can and will throw an
47 :exc:`NotInitializedError` if the database was not intitialized
52 Do remember that as soon as we tear down (e.g. via `del db`) this
53 object, all underlying derived objects such as queries, threads,
54 messages, tags etc will be freed by the underlying library as well.
55 Accessing these objects will lead to segfaults and other unexpected
56 behavior. See above for more details.
59 """Class attribute to cache user's default database"""
61 MODE = Enum(['READ_ONLY', 'READ_WRITE'])
62 """Constants: Mode in which to open the database"""
64 """notmuch_database_get_directory"""
65 _get_directory = nmlib.notmuch_database_get_directory
66 _get_directory.argtypes = [NotmuchDatabaseP, c_char_p]
67 _get_directory.restype = NotmuchDirectoryP
69 """notmuch_database_get_path"""
70 _get_path = nmlib.notmuch_database_get_path
71 _get_path.argtypes = [NotmuchDatabaseP]
72 _get_path.restype = c_char_p
74 """notmuch_database_get_version"""
75 _get_version = nmlib.notmuch_database_get_version
76 _get_version.argtypes = [NotmuchDatabaseP]
77 _get_version.restype = c_uint
79 """notmuch_database_open"""
80 _open = nmlib.notmuch_database_open
81 _open.argtypes = [c_char_p, c_uint]
82 _open.restype = NotmuchDatabaseP
84 """notmuch_database_upgrade"""
85 _upgrade = nmlib.notmuch_database_upgrade
86 _upgrade.argtypes = [NotmuchDatabaseP, c_void_p, c_void_p]
87 _upgrade.restype = c_uint
89 """ notmuch_database_find_message"""
90 _find_message = nmlib.notmuch_database_find_message
91 _find_message.argtypes = [NotmuchDatabaseP, c_char_p,
92 POINTER(NotmuchMessageP)]
93 _find_message.restype = c_uint
95 """notmuch_database_find_message_by_filename"""
96 _find_message_by_filename = nmlib.notmuch_database_find_message_by_filename
97 _find_message_by_filename.argtypes = [NotmuchDatabaseP, c_char_p,
98 POINTER(NotmuchMessageP)]
99 _find_message_by_filename.restype = c_uint
101 """notmuch_database_get_all_tags"""
102 _get_all_tags = nmlib.notmuch_database_get_all_tags
103 _get_all_tags.argtypes = [NotmuchDatabaseP]
104 _get_all_tags.restype = NotmuchTagsP
106 """notmuch_database_create"""
107 _create = nmlib.notmuch_database_create
108 _create.argtypes = [c_char_p]
109 _create.restype = NotmuchDatabaseP
111 def __init__(self, path=None, create=False, mode=0):
112 """If *path* is `None`, we will try to read a users notmuch
113 configuration and use his configured database. The location of the
114 configuration file can be specified through the environment variable
115 *NOTMUCH_CONFIG*, falling back to the default `~/.notmuch-config`.
117 If *create* is `True`, the database will always be created in
118 :attr:`MODE`.READ_WRITE mode. Default mode for opening is READ_ONLY.
120 :param path: Directory to open/create the database in (see
121 above for behavior if `None`)
122 :type path: `str` or `None`
123 :param create: Pass `False` to open an existing, `True` to create a new
126 :param mode: Mode to open a database in. Is always
127 :attr:`MODE`.READ_WRITE when creating a new one.
128 :type mode: :attr:`MODE`
129 :exception: :exc:`NotmuchError` or derived exception in case of
134 # no path specified. use a user's default database
135 if Database._std_db_path is None:
136 #the following line throws a NotmuchError if it fails
137 Database._std_db_path = self._get_user_default_db()
138 path = Database._std_db_path
141 self.open(path, mode)
148 def _assert_db_is_initialized(self):
149 """Raises :exc:`NotInitializedError` if self._db is `None`"""
151 raise NotInitializedError()
153 def create(self, path):
154 """Creates a new notmuch database
156 This function is used by __init__() and usually does not need
157 to be called directly. It wraps the underlying
158 *notmuch_database_create* function and creates a new notmuch
159 database at *path*. It will always return a database in :attr:`MODE`
160 .READ_WRITE mode as creating an empty database for
161 reading only does not make a great deal of sense.
163 :param path: A directory in which we should create the database.
166 :exception: :exc:`NotmuchError` in case of any failure
167 (possibly after printing an error message on stderr).
169 if self._db is not None:
170 raise NotmuchError(message="Cannot create db, this Database() "
171 "already has an open one.")
173 res = Database._create(_str(path), Database.MODE.READ_WRITE)
177 message="Could not create the specified database")
180 def open(self, path, mode=0):
181 """Opens an existing database
183 This function is used by __init__() and usually does not need
184 to be called directly. It wraps the underlying
185 *notmuch_database_open* function.
187 :param status: Open the database in read-only or read-write mode
188 :type status: :attr:`MODE`
190 :exception: Raises :exc:`NotmuchError` in case of any failure
191 (possibly after printing an error message on stderr).
193 res = Database._open(_str(path), mode)
196 raise NotmuchError(message="Could not open the specified database")
199 _close = nmlib.notmuch_database_close
200 _close.argtypes = [NotmuchDatabaseP]
201 _close.restype = None
204 """Close and free the notmuch database if needed"""
205 if self._db is not None:
206 self._close(self._db)
210 """Returns the file path of an open database"""
211 self._assert_db_is_initialized()
212 return Database._get_path(self._db).decode('utf-8')
214 def get_version(self):
215 """Returns the database format version
217 :returns: The database version as positive integer
219 self._assert_db_is_initialized()
220 return Database._get_version(self._db)
222 _needs_upgrade = nmlib.notmuch_database_needs_upgrade
223 _needs_upgrade.argtypes = [NotmuchDatabaseP]
224 _needs_upgrade.restype = bool
226 def needs_upgrade(self):
227 """Does this database need to be upgraded before writing to it?
229 If this function returns `True` then no functions that modify the
230 database (:meth:`add_message`,
231 :meth:`Message.add_tag`, :meth:`Directory.set_mtime`,
232 etc.) will work unless :meth:`upgrade` is called successfully first.
234 :returns: `True` or `False`
236 self._assert_db_is_initialized()
237 return self._needs_upgrade(self._db)
240 """Upgrades the current database
242 After opening a database in read-write mode, the client should
243 check if an upgrade is needed (notmuch_database_needs_upgrade) and
244 if so, upgrade with this function before making any modifications.
246 NOT IMPLEMENTED: The optional progress_notify callback can be
247 used by the caller to provide progress indication to the
248 user. If non-NULL it will be called periodically with
249 'progress' as a floating-point value in the range of [0.0..1.0]
250 indicating the progress made so far in the upgrade process.
252 :TODO: catch exceptions, document return values and etc...
254 self._assert_db_is_initialized()
255 status = Database._upgrade(self._db, None, None)
256 #TODO: catch exceptions, document return values and etc
259 _begin_atomic = nmlib.notmuch_database_begin_atomic
260 _begin_atomic.argtypes = [NotmuchDatabaseP]
261 _begin_atomic.restype = c_uint
263 def begin_atomic(self):
264 """Begin an atomic database operation
266 Any modifications performed between a successful
267 :meth:`begin_atomic` and a :meth:`end_atomic` will be applied to
268 the database atomically. Note that, unlike a typical database
269 transaction, this only ensures atomicity, not durability;
270 neither begin nor end necessarily flush modifications to disk.
272 :returns: :attr:`STATUS`.SUCCESS or raises
273 :exception: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION
274 Xapian exception occurred; atomic section not entered.
276 *Added in notmuch 0.9*"""
277 self._assert_db_is_initialized()
278 status = self._begin_atomic(self._db)
279 if status != STATUS.SUCCESS:
280 raise NotmuchError(status)
283 _end_atomic = nmlib.notmuch_database_end_atomic
284 _end_atomic.argtypes = [NotmuchDatabaseP]
285 _end_atomic.restype = c_uint
287 def end_atomic(self):
288 """Indicate the end of an atomic database operation
290 See :meth:`begin_atomic` for details.
292 :returns: :attr:`STATUS`.SUCCESS or raises
296 :attr:`STATUS`.XAPIAN_EXCEPTION
297 A Xapian exception occurred; atomic section not
299 :attr:`STATUS`.UNBALANCED_ATOMIC:
300 end_atomic has been called more times than begin_atomic.
302 *Added in notmuch 0.9*"""
303 self._assert_db_is_initialized()
304 status = self._end_atomic(self._db)
305 if status != STATUS.SUCCESS:
306 raise NotmuchError(status)
309 def get_directory(self, path):
310 """Returns a :class:`Directory` of path,
311 (creating it if it does not exist(?))
315 This call needs a writeable database in
316 :attr:`Database.MODE`.READ_WRITE mode. The underlying library will
317 exit the program if this method is used on a read-only database!
319 :param path: An unicode string containing the path relative to the path
320 of database (see :meth:`get_path`), or else should be an absolute
321 path with initial components that match the path of 'database'.
322 :returns: :class:`Directory` or raises an exception.
324 :exc:`NotmuchError` with :attr:`STATUS`.FILE_ERROR
325 If path is not relative database or absolute with initial
326 components same as database.
328 self._assert_db_is_initialized()
329 # sanity checking if path is valid, and make path absolute
330 if path[0] == os.sep:
331 # we got an absolute path
332 if not path.startswith(self.get_path()):
333 # but its initial components are not equal to the db path
334 raise NotmuchError(STATUS.FILE_ERROR,
335 message="Database().get_directory() called "
336 "with a wrong absolute path.")
339 #we got a relative path, make it absolute
340 abs_dirpath = os.path.abspath(os.path.join(self.get_path(), path))
342 dir_p = Database._get_directory(self._db, _str(path))
344 # return the Directory, init it with the absolute path
345 return Directory(_str(abs_dirpath), dir_p, self)
347 _add_message = nmlib.notmuch_database_add_message
348 _add_message.argtypes = [NotmuchDatabaseP, c_char_p,
349 POINTER(NotmuchMessageP)]
350 _add_message.restype = c_uint
352 def add_message(self, filename, sync_maildir_flags=False):
353 """Adds a new message to the database
355 :param filename: should be a path relative to the path of the
356 open database (see :meth:`get_path`), or else should be an
357 absolute filename with initial components that match the
358 path of the database.
360 The file should be a single mail message (not a
361 multi-message mbox) that is expected to remain at its
362 current location, since the notmuch database will reference
363 the filename, and will not copy the entire contents of the
366 :param sync_maildir_flags: If the message contains Maildir
367 flags, we will -depending on the notmuch configuration- sync
368 those tags to initial notmuch tags, if set to `True`. It is
369 `False` by default to remain consistent with the libnotmuch
370 API. You might want to look into the underlying method
371 :meth:`Message.maildir_flags_to_tags`.
373 :returns: On success, we return
375 1) a :class:`Message` object that can be used for things
376 such as adding tags to the just-added message.
377 2) one of the following :attr:`STATUS` values:
379 :attr:`STATUS`.SUCCESS
380 Message successfully added to database.
381 :attr:`STATUS`.DUPLICATE_MESSAGE_ID
382 Message has the same message ID as another message already
383 in the database. The new filename was successfully added
384 to the list of the filenames for the existing message.
386 :rtype: 2-tuple(:class:`Message`, :attr:`STATUS`)
388 :exception: Raises a :exc:`NotmuchError` with the following meaning.
389 If such an exception occurs, nothing was added to the database.
391 :attr:`STATUS`.FILE_ERROR
392 An error occurred trying to open the file, (such as
393 permission denied, or file not found, etc.).
394 :attr:`STATUS`.FILE_NOT_EMAIL
395 The contents of filename don't look like an email
397 :attr:`STATUS`.READ_ONLY_DATABASE
398 Database was opened in read-only mode so no message can
401 self._assert_db_is_initialized()
402 msg_p = NotmuchMessageP()
403 status = self._add_message(self._db, _str(filename), byref(msg_p))
405 if not status in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]:
406 raise NotmuchError(status)
408 #construct Message() and return
409 msg = Message(msg_p, self)
410 #automatic sync initial tags from Maildir flags
411 if sync_maildir_flags:
412 msg.maildir_flags_to_tags()
415 _remove_message = nmlib.notmuch_database_remove_message
416 _remove_message.argtypes = [NotmuchDatabaseP, c_char_p]
417 _remove_message.restype = c_uint
419 def remove_message(self, filename):
420 """Removes a message (filename) from the given notmuch database
422 Note that only this particular filename association is removed from
423 the database. If the same message (as determined by the message ID)
424 is still available via other filenames, then the message will
425 persist in the database for those filenames. When the last filename
426 is removed for a particular message, the database content for that
427 message will be entirely removed.
429 :returns: A :attr:`STATUS` value with the following meaning:
431 :attr:`STATUS`.SUCCESS
432 The last filename was removed and the message was removed
434 :attr:`STATUS`.DUPLICATE_MESSAGE_ID
435 This filename was removed but the message persists in the
436 database with at least one other filename.
438 :exception: Raises a :exc:`NotmuchError` with the following meaning.
439 If such an exception occurs, nothing was removed from the
442 :attr:`STATUS`.READ_ONLY_DATABASE
443 Database was opened in read-only mode so no message can be
446 self._assert_db_is_initialized()
447 return self._remove_message(self._db, _str(filename))
449 def find_message(self, msgid):
450 """Returns a :class:`Message` as identified by its message ID
452 Wraps the underlying *notmuch_database_find_message* function.
454 :param msgid: The message ID
455 :type msgid: unicode or str
456 :returns: :class:`Message` or `None` if no message is found.
458 :exc:`OutOfMemoryError`
459 If an Out-of-memory occured while constructing the message.
461 In case of a Xapian Exception. These exceptions
462 include "Database modified" situations, e.g. when the
463 notmuch database has been modified by another program
464 in the meantime. In this case, you should close and
465 reopen the database and retry.
466 :exc:`NotInitializedError` if
467 the database was not intitialized.
469 self._assert_db_is_initialized()
470 msg_p = NotmuchMessageP()
471 status = Database._find_message(self._db, _str(msgid), byref(msg_p))
472 if status != STATUS.SUCCESS:
473 raise NotmuchError(status)
474 return msg_p and Message(msg_p, self) or None
476 def find_message_by_filename(self, filename):
477 """Find a message with the given filename
481 This call needs a writeable database in
482 :attr:`Database.MODE`.READ_WRITE mode. The underlying library will
483 exit the program if this method is used on a read-only database!
485 :returns: If the database contains a message with the given
486 filename, then a class:`Message:` is returned. This
487 function returns None if no message is found with the given
491 :exc:`OutOfMemoryError`
492 If an Out-of-memory occured while constructing the message.
494 In case of a Xapian Exception. These exceptions
495 include "Database modified" situations, e.g. when the
496 notmuch database has been modified by another program
497 in the meantime. In this case, you should close and
498 reopen the database and retry.
499 :exc:`NotInitializedError` if
500 the database was not intitialized.
502 *Added in notmuch 0.9*"""
503 self._assert_db_is_initialized()
504 msg_p = NotmuchMessageP()
505 status = Database._find_message_by_filename(self._db, _str(filename),
507 if status != STATUS.SUCCESS:
508 raise NotmuchError(status)
509 return msg_p and Message(msg_p, self) or None
511 def get_all_tags(self):
512 """Returns :class:`Tags` with a list of all tags found in the database
514 :returns: :class:`Tags`
515 :execption: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER
518 self._assert_db_is_initialized()
519 tags_p = Database._get_all_tags(self._db)
521 raise NotmuchError(STATUS.NULL_POINTER)
522 return Tags(tags_p, self)
524 def create_query(self, querystring):
525 """Returns a :class:`Query` derived from this database
527 This is a shorthand method for doing::
530 # Automatically frees the Database() when 'q' is deleted
532 q = Database(dbpath).create_query('from:"Biene Maja"')
534 # long version, which is functionally equivalent but will keep the
535 # Database in the 'db' variable around after we delete 'q':
537 db = Database(dbpath)
538 q = Query(db,'from:"Biene Maja"')
540 This function is a python extension and not in the underlying C API.
542 return Query(self, querystring)
545 return "'Notmuch DB " + self.get_path() + "'"
547 def _get_user_default_db(self):
548 """ Reads a user's notmuch config and returns his db location
550 Throws a NotmuchError if it cannot find it"""
553 from configparser import SafeConfigParser
556 from ConfigParser import SafeConfigParser
558 config = SafeConfigParser()
559 conf_f = os.getenv('NOTMUCH_CONFIG',
560 os.path.expanduser('~/.notmuch-config'))
561 config.readfp(codecs.open(conf_f, 'r', 'utf-8'))
562 if not config.has_option('database', 'path'):
563 raise NotmuchError(message="No DB path specified"
564 " and no user default found")
565 return config.get('database', 'path')
569 """Property returning a pointer to `notmuch_database_t` or `None`
571 This should normally not be needed by a user (and is not yet
572 guaranteed to remain stable in future versions).
578 """Represents a search query on an opened :class:`Database`.
580 A query selects and filters a subset of messages from the notmuch
581 database we derive from.
583 :class:`Query` provides an instance attribute :attr:`sort`, which
584 contains the sort order (if specified via :meth:`set_sort`) or
587 Any function in this class may throw an :exc:`NotInitializedError`
588 in case the underlying query object was not set up correctly.
590 .. note:: Do remember that as soon as we tear down this object,
591 all underlying derived objects such as threads,
592 messages, tags etc will be freed by the underlying library
593 as well. Accessing these objects will lead to segfaults and
594 other unexpected behavior. See above for more details.
597 SORT = Enum(['OLDEST_FIRST', 'NEWEST_FIRST', 'MESSAGE_ID', 'UNSORTED'])
598 """Constants: Sort order in which to return results"""
600 """notmuch_query_create"""
601 _create = nmlib.notmuch_query_create
602 _create.argtypes = [NotmuchDatabaseP, c_char_p]
603 _create.restype = NotmuchQueryP
605 """notmuch_query_search_threads"""
606 _search_threads = nmlib.notmuch_query_search_threads
607 _search_threads.argtypes = [NotmuchQueryP]
608 _search_threads.restype = NotmuchThreadsP
610 """notmuch_query_search_messages"""
611 _search_messages = nmlib.notmuch_query_search_messages
612 _search_messages.argtypes = [NotmuchQueryP]
613 _search_messages.restype = NotmuchMessagesP
615 """notmuch_query_count_messages"""
616 _count_messages = nmlib.notmuch_query_count_messages
617 _count_messages.argtypes = [NotmuchQueryP]
618 _count_messages.restype = c_uint
620 def __init__(self, db, querystr):
622 :param db: An open database which we derive the Query from.
623 :type db: :class:`Database`
624 :param querystr: The query string for the message.
625 :type querystr: utf-8 encoded str or unicode
630 self.create(db, querystr)
632 def _assert_query_is_initialized(self):
633 """Raises :exc:`NotInitializedError` if self._query is `None`"""
634 if self._query is None:
635 raise NotInitializedError()
637 def create(self, db, querystr):
638 """Creates a new query derived from a Database
640 This function is utilized by __init__() and usually does not need to
643 :param db: Database to create the query from.
644 :type db: :class:`Database`
645 :param querystr: The query string
646 :type querystr: utf-8 encoded str or unicode
649 :exc:`NullPointerError` if the query creation failed
650 (e.g. too little memory).
651 :exc:`NotInitializedError` if the underlying db was not
654 db._assert_db_is_initialized()
655 # create reference to parent db to keep it alive
657 # create query, return None if too little mem available
658 query_p = Query._create(db.db_p, _str(querystr))
660 raise NullPointerError
661 self._query = query_p
663 _set_sort = nmlib.notmuch_query_set_sort
664 _set_sort.argtypes = [NotmuchQueryP, c_uint]
665 _set_sort.argtypes = None
667 def set_sort(self, sort):
668 """Set the sort order future results will be delivered in
670 :param sort: Sort order (see :attr:`Query.SORT`)
672 self._assert_query_is_initialized()
674 self._set_sort(self._query, sort)
676 def search_threads(self):
677 """Execute a query for threads
679 Execute a query for threads, returning a :class:`Threads` iterator.
680 The returned threads are owned by the query and as such, will only be
681 valid until the Query is deleted.
683 The method sets :attr:`Message.FLAG`\.MATCH for those messages that
684 match the query. The method :meth:`Message.get_flag` allows us
685 to get the value of this flag.
687 :returns: :class:`Threads`
688 :exception: :exc:`NullPointerError` if search_threads failed
690 self._assert_query_is_initialized()
691 threads_p = Query._search_threads(self._query)
694 raise NullPointerError
695 return Threads(threads_p, self)
697 def search_messages(self):
698 """Filter messages according to the query and return
699 :class:`Messages` in the defined sort order
701 :returns: :class:`Messages`
702 :exception: :exc:`NullPointerError` if search_messages failed
704 self._assert_query_is_initialized()
705 msgs_p = Query._search_messages(self._query)
708 raise NullPointerError
709 return Messages(msgs_p, self)
711 def count_messages(self):
712 """Estimate the number of messages matching the query
714 This function performs a search and returns Xapian's best
715 guess as to the number of matching messages. It is much faster
716 than performing :meth:`search_messages` and counting the
717 result with `len()` (although it always returned the same
718 result in my tests). Technically, it wraps the underlying
719 *notmuch_query_count_messages* function.
721 :returns: :class:`Messages`
723 self._assert_query_is_initialized()
724 return Query._count_messages(self._query)
726 _destroy = nmlib.notmuch_query_destroy
727 _destroy.argtypes = [NotmuchQueryP]
728 _destroy.restype = None
731 """Close and free the Query"""
732 if self._query is not None:
733 self._destroy(self._query)
736 class Directory(object):
737 """Represents a directory entry in the notmuch directory
739 Modifying attributes of this object will modify the
740 database, not the real directory attributes.
742 The Directory object is usually derived from another object
743 e.g. via :meth:`Database.get_directory`, and will automatically be
744 become invalid whenever that parent is deleted. You should
745 therefore initialized this object handing it a reference to the
746 parent, preventing the parent from automatically being garbage
750 """notmuch_directory_get_mtime"""
751 _get_mtime = nmlib.notmuch_directory_get_mtime
752 _get_mtime.argtypes = [NotmuchDirectoryP]
753 _get_mtime.restype = c_long
755 """notmuch_directory_set_mtime"""
756 _set_mtime = nmlib.notmuch_directory_set_mtime
757 _set_mtime.argtypes = [NotmuchDirectoryP, c_long]
758 _set_mtime.restype = c_uint
760 """notmuch_directory_get_child_files"""
761 _get_child_files = nmlib.notmuch_directory_get_child_files
762 _get_child_files.argtypes = [NotmuchDirectoryP]
763 _get_child_files.restype = NotmuchFilenamesP
765 """notmuch_directory_get_child_directories"""
766 _get_child_directories = nmlib.notmuch_directory_get_child_directories
767 _get_child_directories.argtypes = [NotmuchDirectoryP]
768 _get_child_directories.restype = NotmuchFilenamesP
770 def _assert_dir_is_initialized(self):
771 """Raises a NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)
774 raise NotmuchError(STATUS.NOT_INITIALIZED)
776 def __init__(self, path, dir_p, parent):
778 :param path: The absolute path of the directory object as unicode.
779 :param dir_p: The pointer to an internal notmuch_directory_t object.
780 :param parent: The object this Directory is derived from
781 (usually a :class:`Database`). We do not directly use
782 this, but store a reference to it as long as
783 this Directory object lives. This keeps the
786 assert isinstance(path, unicode), "Path needs to be an UNICODE object"
789 self._parent = parent
791 def set_mtime(self, mtime):
792 """Sets the mtime value of this directory in the database
794 The intention is for the caller to use the mtime to allow efficient
795 identification of new messages to be added to the database. The
796 recommended usage is as follows:
798 * Read the mtime of a directory from the filesystem
800 * Call :meth:`Database.add_message` for all mail files in
803 * Call notmuch_directory_set_mtime with the mtime read from the
804 filesystem. Then, when wanting to check for updates to the
805 directory in the future, the client can call :meth:`get_mtime`
806 and know that it only needs to add files if the mtime of the
807 directory and files are newer than the stored timestamp.
811 :meth:`get_mtime` function does not allow the caller to
812 distinguish a timestamp of 0 from a non-existent timestamp. So
813 don't store a timestamp of 0 unless you are comfortable with
816 :param mtime: A (time_t) timestamp
817 :returns: Nothing on success, raising an exception on failure.
818 :exception: :exc:`NotmuchError`:
820 :attr:`STATUS`.XAPIAN_EXCEPTION
821 A Xapian exception occurred, mtime not stored.
822 :attr:`STATUS`.READ_ONLY_DATABASE
823 Database was opened in read-only mode so directory
824 mtime cannot be modified.
825 :attr:`STATUS`.NOT_INITIALIZED
826 The directory has not been initialized
828 self._assert_dir_is_initialized()
829 #TODO: make sure, we convert the mtime parameter to a 'c_long'
830 status = Directory._set_mtime(self._dir_p, mtime)
833 if status == STATUS.SUCCESS:
835 #fail with Exception otherwise
836 raise NotmuchError(status)
839 """Gets the mtime value of this directory in the database
841 Retrieves a previously stored mtime for this directory.
843 :param mtime: A (time_t) timestamp
844 :returns: Nothing on success, raising an exception on failure.
845 :exception: :exc:`NotmuchError`:
847 :attr:`STATUS`.NOT_INITIALIZED
848 The directory has not been initialized
850 self._assert_dir_is_initialized()
851 return Directory._get_mtime(self._dir_p)
853 # Make mtime attribute a property of Directory()
854 mtime = property(get_mtime, set_mtime, doc="""Property that allows getting
855 and setting of the Directory *mtime* (read-write)
857 See :meth:`get_mtime` and :meth:`set_mtime` for usage and
858 possible exceptions.""")
860 def get_child_files(self):
861 """Gets a Filenames iterator listing all the filenames of
862 messages in the database within the given directory.
864 The returned filenames will be the basename-entries only (not
867 self._assert_dir_is_initialized()
868 files_p = Directory._get_child_files(self._dir_p)
869 return Filenames(files_p, self)
871 def get_child_directories(self):
872 """Gets a :class:`Filenames` iterator listing all the filenames of
873 sub-directories in the database within the given directory
875 The returned filenames will be the basename-entries only (not
878 self._assert_dir_is_initialized()
879 files_p = Directory._get_child_directories(self._dir_p)
880 return Filenames(files_p, self)
884 """Returns the absolute path of this Directory (read-only)"""
888 """Object representation"""
889 return "<notmuch Directory object '%s'>" % self._path
891 _destroy = nmlib.notmuch_directory_destroy
892 _destroy.argtypes = [NotmuchDirectoryP]
893 _destroy.argtypes = None
896 """Close and free the Directory"""
897 if self._dir_p is not None:
898 self._destroy(self._dir_p)
901 class Filenames(object):
902 """An iterator over File- or Directory names stored in the database"""
904 #notmuch_filenames_get
905 _get = nmlib.notmuch_filenames_get
906 _get.argtypes = [NotmuchFilenamesP]
907 _get.restype = c_char_p
909 def __init__(self, files_p, parent):
911 :param files_p: The pointer to an internal notmuch_filenames_t object.
912 :param parent: The object this Directory is derived from
913 (usually a Directory()). We do not directly use
914 this, but store a reference to it as long as
915 this Directory object lives. This keeps the
918 self._files_p = files_p
919 self._parent = parent
922 """ Make Filenames an iterator """
925 _valid = nmlib.notmuch_filenames_valid
926 _valid.argtypes = [NotmuchFilenamesP]
927 _valid.restype = bool
929 _move_to_next = nmlib.notmuch_filenames_move_to_next
930 _move_to_next.argtypes = [NotmuchFilenamesP]
931 _move_to_next.restype = None
934 if not self._files_p:
935 raise NotmuchError(STATUS.NOT_INITIALIZED)
937 if not self._valid(self._files_p):
941 file_ = Filenames._get(self._files_p)
942 self._move_to_next(self._files_p)
943 return file_.decode('utf-8', 'ignore')
944 next = __next__ # python2.x iterator protocol compatibility
947 """len(:class:`Filenames`) returns the number of contained files
951 As this iterates over the files, we will not be able to
952 iterate over them again! So this will fail::
955 files = Database().get_directory('').get_child_files()
956 if len(files) > 0: # this 'exhausts' msgs
958 # NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)
959 for file in files: print file
961 if not self._files_p:
962 raise NotmuchError(STATUS.NOT_INITIALIZED)
965 while self._valid(self._files_p):
966 self._move_to_next(self._files_p)
971 _destroy = nmlib.notmuch_filenames_destroy
972 _destroy.argtypes = [NotmuchFilenamesP]
973 _destroy.restype = None
976 """Close and free Filenames"""
977 if self._files_p is not None:
978 self._destroy(self._files_p)