import os
from ctypes import c_int, c_char_p, c_void_p, c_uint, c_long, byref
-from notmuch.globals import nmlib, STATUS, NotmuchError, Enum
+from notmuch.globals import nmlib, STATUS, NotmuchError, Enum, _str
from notmuch.thread import Threads
from notmuch.message import Messages, Message
from notmuch.tag import Tags
_std_db_path = None
"""Class attribute to cache user's default database"""
- MODE = Enum(['READ_ONLY','READ_WRITE'])
+ MODE = Enum(['READ_ONLY', 'READ_WRITE'])
"""Constants: Mode in which to open the database"""
"""notmuch_database_get_directory"""
_get_version.restype = c_uint
"""notmuch_database_open"""
- _open = nmlib.notmuch_database_open
+ _open = nmlib.notmuch_database_open
_open.restype = c_void_p
"""notmuch_database_upgrade"""
_find_message = nmlib.notmuch_database_find_message
_find_message.restype = c_void_p
+ """notmuch_database_find_message_by_filename"""
+ _find_message_by_filename = nmlib.notmuch_database_find_message_by_filename
+ _find_message_by_filename.restype = c_void_p
+
"""notmuch_database_get_all_tags"""
_get_all_tags = nmlib.notmuch_database_get_all_tags
_get_all_tags.restype = c_void_p
_create = nmlib.notmuch_database_create
_create.restype = c_void_p
- def __init__(self, path=None, create=False, mode= 0):
- """If *path* is `None`, we will try to read a users notmuch
- configuration and use his configured database. The location of the
+ def __init__(self, path=None, create=False, mode=0):
+ """If *path* is `None`, we will try to read a users notmuch
+ configuration and use his configured database. The location of the
configuration file can be specified through the environment variable
*NOTMUCH_CONFIG*, falling back to the default `~/.notmuch-config`.
above for behavior if `None`)
:type path: `str` or `None`
:param create: Pass `False` to open an existing, `True` to create a new
- database.
+ database.
:type create: bool
- :param mode: Mode to open a database in. Is always
+ :param mode: Mode to open a database in. Is always
:attr:`MODE`.READ_WRITE when creating a new one.
:type mode: :attr:`MODE`
:returns: Nothing
else:
self.create(path)
- def _verify_initialized_db(self):
+ def _assert_db_is_initialized(self):
"""Raises a NotmuchError in case self._db is still None"""
if self._db is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
def create(self, path):
"""Creates a new notmuch database
(after printing an error message on stderr).
"""
if self._db is not None:
- raise NotmuchError(
- message="Cannot create db, this Database() already has an open one.")
+ raise NotmuchError(message="Cannot create db, this Database() "
+ "already has an open one.")
- res = Database._create(path, Database.MODE.READ_WRITE)
+ res = Database._create(_str(path), Database.MODE.READ_WRITE)
if res is None:
raise NotmuchError(
message="Could not create the specified database")
self._db = res
- def open(self, path, mode= 0):
+ def open(self, path, mode=0):
"""Opens an existing database
This function is used by __init__() and usually does not need
*notmuch_database_open* function.
:param status: Open the database in read-only or read-write mode
- :type status: :attr:`MODE`
+ :type status: :attr:`MODE`
:returns: Nothing
:exception: Raises :exc:`NotmuchError` in case
of any failure (after printing an error message on stderr).
"""
-
- res = Database._open(path, mode)
+ res = Database._open(_str(path), mode)
if res is None:
raise NotmuchError(
"""Returns the file path of an open database
Wraps *notmuch_database_get_path*."""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
- return Database._get_path(self._db)
+ self._assert_db_is_initialized()
+ return Database._get_path(self._db).decode('utf-8')
def get_version(self):
"""Returns the database format version
:exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
the database was not intitialized.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
- return Database._get_version (self._db)
+ self._assert_db_is_initialized()
+ return Database._get_version(self._db)
def needs_upgrade(self):
"""Does this database need to be upgraded before writing to it?
:exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
the database was not intitialized.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
- return notmuch_database_needs_upgrade(self._db)
+ self._assert_db_is_initialized()
+ return nmlib.notmuch_database_needs_upgrade(self._db)
def upgrade(self):
"""Upgrades the current database
NOT IMPLEMENTED: The optional progress_notify callback can be
used by the caller to provide progress indication to the
user. If non-NULL it will be called periodically with
- 'progress' as a floating-point value in the range of [0.0..1.0]
+ 'progress' as a floating-point value in the range of [0.0..1.0]
indicating the progress made so far in the upgrade process.
:TODO: catch exceptions, document return values and etc...
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
- status = Database._upgrade (self._db, None, None)
+ self._assert_db_is_initialized()
+ status = Database._upgrade(self._db, None, None)
#TODO: catch exceptions, document return values and etc
return status
+ def begin_atomic(self):
+ """Begin an atomic database operation
+
+ Any modifications performed between a successful
+ :meth:`begin_atomic` and a :meth:`end_atomic` will be applied to
+ the database atomically. Note that, unlike a typical database
+ transaction, this only ensures atomicity, not durability;
+ neither begin nor end necessarily flush modifications to disk.
+
+ :returns: STATUS.SUCCESS or raises
+
+ :exception: :exc:`NotmuchError` STATUS.XAPIAN_EXCEPTION::
+
+ A Xapian exception occurred; atomic section not
+ entered."""
+ self._assert_db_is_initialized()
+ status = nmlib.notmuch_database_begin_atomic(self._db)
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
+ return status
+
+ def end_atomic(self):
+ """Indicate the end of an atomic database operation
+
+ See :meth:`begin_atomic` for details.
+
+ :returns: STATUS.SUCCESS or raises
+
+ :exception:
+ :exc:`NotmuchError`:
+ STATUS.XAPIAN_EXCEPTION
+ A Xapian exception occurred; atomic section not
+ ended.
+ STATUS.UNBALANCED_ATOMIC:
+ end_atomic has been called more times than begin_atomic."""
+ self._assert_db_is_initialized()
+ status = nmlib.notmuch_database_end_atomic(self._db)
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
+ return status
+
def get_directory(self, path):
- """Returns a :class:`Directory` of path,
+ """Returns a :class:`Directory` of path,
(creating it if it does not exist(?))
- .. warning:: This call needs a writeable database in
+ .. warning:: This call needs a writeable database in
Database.MODE.READ_WRITE mode. The underlying library will exit the
program if this method is used on a read-only database!
- :param path: A str containing the path relative to the path of database
- (see :meth:`get_path`), or else should be an absolute path
+ :param path: An unicode string containing the path relative to the path
+ of database (see :meth:`get_path`), or else should be an absolute path
with initial components that match the path of 'database'.
:returns: :class:`Directory` or raises an exception.
:exception: :exc:`NotmuchError`
- STATUS.NOT_INITIALIZED
+ STATUS.NOT_INITIALIZED
If the database was not intitialized.
STATUS.FILE_ERROR
- If path is not relative database or absolute with initial
+ If path is not relative database or absolute with initial
components same as database.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
+ self._assert_db_is_initialized()
# sanity checking if path is valid, and make path absolute
if path[0] == os.sep:
# we got an absolute path
if not path.startswith(self.get_path()):
# but its initial components are not equal to the db path
- raise NotmuchError(STATUS.FILE_ERROR,
- message="Database().get_directory() called with a wrong absolute path.")
+ raise NotmuchError(STATUS.FILE_ERROR,
+ message="Database().get_directory() called "
+ "with a wrong absolute path.")
abs_dirpath = path
else:
#we got a relative path, make it absolute
- abs_dirpath = os.path.abspath(os.path.join(self.get_path(),path))
+ abs_dirpath = os.path.abspath(os.path.join(self.get_path(), path))
- dir_p = Database._get_directory(self._db, path);
+ dir_p = Database._get_directory(self._db, _str(path))
# return the Directory, init it with the absolute path
- return Directory(abs_dirpath, dir_p, self)
+ return Directory(_str(abs_dirpath), dir_p, self)
- def add_message(self, filename):
+ def add_message(self, filename, sync_maildir_flags=False):
"""Adds a new message to the database
- `filename` should be a path relative to the path of the open
+ :param filename: should be a path relative to the path of the open
database (see :meth:`get_path`), or else should be an absolute
filename with initial components that match the path of the
database.
notmuch database will reference the filename, and will not copy the
entire contents of the file.
- :returns: On success, we return
+ :param sync_maildir_flags: If the message contains Maildir
+ flags, we will -depending on the notmuch configuration- sync
+ those tags to initial notmuch tags, if set to `True`. It is
+ `False` by default to remain consistent with the libnotmuch
+ API. You might want to look into the underlying method
+ :meth:`Message.maildir_flags_to_tags`.
+
+ :returns: On success, we return
1) a :class:`Message` object that can be used for things
such as adding tags to the just-added message.
STATUS.DUPLICATE_MESSAGE_ID
Message has the same message ID as another message already
in the database. The new filename was successfully added
- to the message in the database.
+ to the list of the filenames for the existing message.
:rtype: 2-tuple(:class:`Message`, STATUS)
If such an exception occurs, nothing was added to the database.
STATUS.FILE_ERROR
- An error occurred trying to open the file, (such as
+ An error occurred trying to open the file, (such as
permission denied, or file not found, etc.).
STATUS.FILE_NOT_EMAIL
- The contents of filename don't look like an email message.
+ The contents of filename don't look like an email
+ message.
STATUS.READ_ONLY_DATABASE
Database was opened in read-only mode so no message can
be added.
STATUS.NOT_INITIALIZED
The database has not been initialized.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
+ self._assert_db_is_initialized()
msg_p = c_void_p()
status = nmlib.notmuch_database_add_message(self._db,
- filename,
+ _str(filename),
byref(msg_p))
-
- if not status in [STATUS.SUCCESS,STATUS.DUPLICATE_MESSAGE_ID]:
+
+ if not status in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]:
raise NotmuchError(status)
#construct Message() and return
msg = Message(msg_p, self)
+ #automatic sync initial tags from Maildir flags
+ if sync_maildir_flags:
+ msg.maildir_flags_to_tags()
return (msg, status)
def remove_message(self, filename):
- """Removes a message from the given notmuch database
+ """Removes a message (filename) from the given notmuch database
Note that only this particular filename association is removed from
the database. If the same message (as determined by the message ID)
:returns: A STATUS value with the following meaning:
STATUS.SUCCESS
- The last filename was removed and the message was removed
+ The last filename was removed and the message was removed
from the database.
STATUS.DUPLICATE_MESSAGE_ID
- This filename was removed but the message persists in the
+ This filename was removed but the message persists in the
database with at least one other filename.
:exception: Raises a :exc:`NotmuchError` with the following meaning.
- If such an exception occurs, nothing was removed from the database.
+ If such an exception occurs, nothing was removed from the
+ database.
STATUS.READ_ONLY_DATABASE
- Database was opened in read-only mode so no message can be
+ Database was opened in read-only mode so no message can be
removed.
STATUS.NOT_INITIALIZED
The database has not been initialized.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
+ self._assert_db_is_initialized()
return nmlib.notmuch_database_remove_message(self._db,
filename)
:param msgid: The message ID
:type msgid: string
- :returns: :class:`Message` or `None` if no message is found or if an
- out-of-memory situation occurs.
+ :returns: :class:`Message` or `None` if no message is found or
+ if any xapian exception or out-of-memory situation
+ occurs. Do note that Xapian Exceptions include
+ "Database modified" situations, e.g. when the
+ notmuch database has been modified by
+ another program in the meantime. A return value of
+ `None` is therefore no guarantee that the message
+ does not exist.
:exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
the database was not intitialized.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
+ self._assert_db_is_initialized()
+ msg_p = Database._find_message(self._db, _str(msgid))
+ return msg_p and Message(msg_p, self) or None
- msg_p = Database._find_message(self._db, msgid)
- if msg_p is None:
- return None
- return Message(msg_p, self)
+ def find_message_by_filename(self, filename):
+ """Find a message with the given filename
+
+ :returns: If the database contains a message with the given
+ filename, then a class:`Message:` is returned. This
+ function returns None in the following situations:
+
+ * No message is found with the given filename
+ * An out-of-memory situation occurs
+ * A Xapian exception occurs"""
+ self._assert_db_is_initialized()
+ msg_p = Database._find_message_by_filename(self._db, _str(filename))
+ return msg_p and Message(msg_p, self) or None
def get_all_tags(self):
"""Returns :class:`Tags` with a list of all tags found in the database
:returns: :class:`Tags`
:execption: :exc:`NotmuchError` with STATUS.NULL_POINTER on error
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
- tags_p = Database._get_all_tags (self._db)
+ self._assert_db_is_initialized()
+ tags_p = Database._get_all_tags(self._db)
if tags_p == None:
raise NotmuchError(STATUS.NULL_POINTER)
return Tags(tags_p, self)
This function is a python extension and not in the underlying C API.
"""
- # Raise a NotmuchError if not initialized
- self._verify_initialized_db()
-
+ self._assert_db_is_initialized()
return Query(self, querystring)
def __repr__(self):
conf_f = os.getenv('NOTMUCH_CONFIG',
os.path.expanduser('~/.notmuch-config'))
config.read(conf_f)
- if not config.has_option('database','path'):
- raise NotmuchError(message=
- "No DB path specified and no user default found")
- return config.get('database','path')
+ if not config.has_option('database', 'path'):
+ raise NotmuchError(message="No DB path specified"
+ " and no user default found")
+ return config.get('database', 'path').decode('utf-8')
@property
def db_p(self):
"""
return self._db
-#------------------------------------------------------------------------------
+
class Query(object):
"""Represents a search query on an opened :class:`Database`.
other unexpected behavior. See above for more details.
"""
# constants
- SORT = Enum(['OLDEST_FIRST','NEWEST_FIRST','MESSAGE_ID', 'UNSORTED'])
+ SORT = Enum(['OLDEST_FIRST', 'NEWEST_FIRST', 'MESSAGE_ID', 'UNSORTED'])
"""Constants: Sort order in which to return results"""
"""notmuch_query_create"""
_search_messages = nmlib.notmuch_query_search_messages
_search_messages.restype = c_void_p
-
"""notmuch_query_count_messages"""
_count_messages = nmlib.notmuch_query_count_messages
_count_messages.restype = c_uint
:param db: An open database which we derive the Query from.
:type db: :class:`Database`
:param querystr: The query string for the message.
- :type querystr: str
+ :type querystr: utf-8 encoded str or unicode
"""
self._db = None
self._query = None
def create(self, db, querystr):
"""Creates a new query derived from a Database
- This function is utilized by __init__() and usually does not need to
+ This function is utilized by __init__() and usually does not need to
be called directly.
:param db: Database to create the query from.
:type db: :class:`Database`
:param querystr: The query string
- :type querystr: str
+ :type querystr: utf-8 encoded str or unicode
:returns: Nothing
:exception: :exc:`NotmuchError`
* STATUS.NOT_INITIALIZED if db is not inited
- * STATUS.NULL_POINTER if the query creation failed
+ * STATUS.NULL_POINTER if the query creation failed
(too little memory)
"""
if db.db_p is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
# create reference to parent db to keep it alive
self._db = db
-
# create query, return None if too little mem available
- query_p = Query._create(db.db_p, querystr)
+ query_p = Query._create(db.db_p, _str(querystr))
if query_p is None:
NotmuchError(STATUS.NULL_POINTER)
self._query = query_p
:param sort: Sort order (see :attr:`Query.SORT`)
:returns: Nothing
- :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if query has not
+ :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if query has not
been initialized.
"""
if self._query is None:
"""Execute a query for threads
Execute a query for threads, returning a :class:`Threads` iterator.
- The returned threads are owned by the query and as such, will only be
+ The returned threads are owned by the query and as such, will only be
valid until the Query is deleted.
The method sets :attr:`Message.FLAG`\.MATCH for those messages that
:exception: :exc:`NotmuchError`
* STATUS.NOT_INITIALIZED if query is not inited
- * STATUS.NULL_POINTER if search_threads failed
+ * STATUS.NULL_POINTER if search_threads failed
"""
if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
threads_p = Query._search_threads(self._query)
if threads_p is None:
- NotmuchError(STATUS.NULL_POINTER)
+ raise NotmuchError(STATUS.NULL_POINTER)
- return Threads(threads_p,self)
+ return Threads(threads_p, self)
def search_messages(self):
"""Filter messages according to the query and return
:exception: :exc:`NotmuchError`
* STATUS.NOT_INITIALIZED if query is not inited
- * STATUS.NULL_POINTER if search_messages failed
+ * STATUS.NULL_POINTER if search_messages failed
"""
if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
msgs_p = Query._search_messages(self._query)
if msgs_p is None:
NotmuchError(STATUS.NULL_POINTER)
- return Messages(msgs_p,self)
+ return Messages(msgs_p, self)
def count_messages(self):
"""Estimate the number of messages matching the query
* STATUS.NOT_INITIALIZED if query is not inited
"""
if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
return Query._count_messages(self._query)
def __del__(self):
"""Close and free the Query"""
if self._query is not None:
- nmlib.notmuch_query_destroy (self._query)
+ nmlib.notmuch_query_destroy(self._query)
-#------------------------------------------------------------------------------
class Directory(object):
"""Represents a directory entry in the notmuch directory
_get_child_directories.restype = c_void_p
def _verify_dir_initialized(self):
- """Raises a NotmuchError(STATUS.NOT_INITIALIZED) if the dir_p is None"""
+ """Raises a NotmuchError(STATUS.NOT_INITIALIZED) if dir_p is None"""
if self._dir_p is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
def __init__(self, path, dir_p, parent):
"""
- :param path: The absolute path of the directory object.
+ :param path: The absolute path of the directory object as unicode.
:param dir_p: The pointer to an internal notmuch_directory_t object.
:param parent: The object this Directory is derived from
(usually a :class:`Database`). We do not directly use
this Directory object lives. This keeps the
parent object alive.
"""
+ assert isinstance(path, unicode), "Path needs to be an UNICODE object"
self._path = path
self._dir_p = dir_p
self._parent = parent
-
- def set_mtime (self, mtime):
+ def set_mtime(self, mtime):
"""Sets the mtime value of this directory in the database
The intention is for the caller to use the mtime to allow efficient
recommended usage is as follows:
* Read the mtime of a directory from the filesystem
-
+
* Call :meth:`Database.add_message` for all mail files in
the directory
- * Call notmuch_directory_set_mtime with the mtime read from the
+ * Call notmuch_directory_set_mtime with the mtime read from the
filesystem. Then, when wanting to check for updates to the
directory in the future, the client can call :meth:`get_mtime`
- and know that it only needs to add files if the mtime of the
+ and know that it only needs to add files if the mtime of the
directory and files are newer than the stored timestamp.
- .. note:: :meth:`get_mtime` function does not allow the caller
+ .. note:: :meth:`get_mtime` function does not allow the caller
to distinguish a timestamp of 0 from a non-existent
timestamp. So don't store a timestamp of 0 unless you are
- comfortable with that.
+ comfortable with that.
- :param mtime: A (time_t) timestamp
+ :param mtime: A (time_t) timestamp
:returns: Nothing on success, raising an exception on failure.
:exception: :exc:`NotmuchError`:
STATUS.XAPIAN_EXCEPTION
A Xapian exception occurred, mtime not stored.
STATUS.READ_ONLY_DATABASE
- Database was opened in read-only mode so directory
+ Database was opened in read-only mode so directory
mtime cannot be modified.
STATUS.NOT_INITIALIZED
The directory has not been initialized
#fail with Exception otherwise
raise NotmuchError(status)
- def get_mtime (self):
+ def get_mtime(self):
"""Gets the mtime value of this directory in the database
Retrieves a previously stored mtime for this directory.
- :param mtime: A (time_t) timestamp
+ :param mtime: A (time_t) timestamp
:returns: Nothing on success, raising an exception on failure.
:exception: :exc:`NotmuchError`:
#Raise a NotmuchError(STATUS.NOT_INITIALIZED) if self.dir_p is None
self._verify_dir_initialized()
- return Directory._get_mtime (self._dir_p)
+ return Directory._get_mtime(self._dir_p)
# Make mtime attribute a property of Directory()
mtime = property(get_mtime, set_mtime, doc="""Property that allows getting
and setting of the Directory *mtime* (read-write)
- See :meth:`get_mtime` and :meth:`set_mtime` for usage and
+ See :meth:`get_mtime` and :meth:`set_mtime` for usage and
possible exceptions.""")
def get_child_files(self):
"""Gets a Filenames iterator listing all the filenames of
messages in the database within the given directory.
-
+
The returned filenames will be the basename-entries only (not
complete paths.
"""
def get_child_directories(self):
"""Gets a :class:`Filenames` iterator listing all the filenames of
sub-directories in the database within the given directory
-
+
The returned filenames will be the basename-entries only (not
complete paths.
"""
if self._dir_p is not None:
nmlib.notmuch_directory_destroy(self._dir_p)
-#------------------------------------------------------------------------------
+
class Filenames(object):
- """An iterator over File- or Directory names that are stored in the database
- """
+ """An iterator over File- or Directory names stored in the database"""
#notmuch_filenames_get
_get = nmlib.notmuch_filenames_get
self._files_p = None
raise StopIteration
- file = Filenames._get (self._files_p)
+ file = Filenames._get(self._files_p)
nmlib.notmuch_filenames_move_to_next(self._files_p)
return file
def __len__(self):
"""len(:class:`Filenames`) returns the number of contained files
- .. note:: As this iterates over the files, we will not be able to
+ .. note:: As this iterates over the files, we will not be able to
iterate over them again! So this will fail::
#THIS FAILS
if self._files_p is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
- i=0
+ i = 0
while nmlib.notmuch_filenames_valid(self._files_p):
nmlib.notmuch_filenames_move_to_next(self._files_p)
i += 1