python: Update Database.get_directory documentation
[notmuch] / bindings / python / notmuch / database.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 import os
21 import codecs
22 from ctypes import c_char_p, c_void_p, c_uint, byref, POINTER
23 from notmuch.globals import (
24     nmlib,
25     Enum,
26     _str,
27     NotmuchDatabaseP,
28     NotmuchDirectoryP,
29     NotmuchMessageP,
30     NotmuchTagsP,
31 )
32 from .errors import (
33     STATUS,
34     FileError,
35     NotmuchError,
36     NullPointerError,
37     NotInitializedError,
38     ReadOnlyDatabaseError,
39 )
40 from notmuch.message import Message
41 from notmuch.tag import Tags
42 from .query import Query
43 from .directory import Directory
44
45 class Database(object):
46     """The :class:`Database` is the highest-level object that notmuch
47     provides. It references a notmuch database, and can be opened in
48     read-only or read-write mode. A :class:`Query` can be derived from
49     or be applied to a specific database to find messages. Also adding
50     and removing messages to the database happens via this
51     object. Modifications to the database are not atmic by default (see
52     :meth:`begin_atomic`) and once a database has been modified, all
53     other database objects pointing to the same data-base will throw an
54     :exc:`XapianError` as the underlying database has been
55     modified. Close and reopen the database to continue working with it.
56
57     :class:`Database` objects implement the context manager protocol
58     so you can use the :keyword:`with` statement to ensure that the
59     database is properly closed. See :meth:`close` for more
60     information.
61
62     .. note::
63
64         Any function in this class can and will throw an
65         :exc:`NotInitializedError` if the database was not intitialized
66         properly.
67     """
68     _std_db_path = None
69     """Class attribute to cache user's default database"""
70
71     MODE = Enum(['READ_ONLY', 'READ_WRITE'])
72     """Constants: Mode in which to open the database"""
73
74     """notmuch_database_get_directory"""
75     _get_directory = nmlib.notmuch_database_get_directory
76     _get_directory.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(NotmuchDirectoryP)]
77     _get_directory.restype = c_uint
78
79     """notmuch_database_get_path"""
80     _get_path = nmlib.notmuch_database_get_path
81     _get_path.argtypes = [NotmuchDatabaseP]
82     _get_path.restype = c_char_p
83
84     """notmuch_database_get_version"""
85     _get_version = nmlib.notmuch_database_get_version
86     _get_version.argtypes = [NotmuchDatabaseP]
87     _get_version.restype = c_uint
88
89     """notmuch_database_open"""
90     _open = nmlib.notmuch_database_open
91     _open.argtypes = [c_char_p, c_uint, POINTER(NotmuchDatabaseP)]
92     _open.restype = c_uint
93
94     """notmuch_database_upgrade"""
95     _upgrade = nmlib.notmuch_database_upgrade
96     _upgrade.argtypes = [NotmuchDatabaseP, c_void_p, c_void_p]
97     _upgrade.restype = c_uint
98
99     """ notmuch_database_find_message"""
100     _find_message = nmlib.notmuch_database_find_message
101     _find_message.argtypes = [NotmuchDatabaseP, c_char_p,
102                               POINTER(NotmuchMessageP)]
103     _find_message.restype = c_uint
104
105     """notmuch_database_find_message_by_filename"""
106     _find_message_by_filename = nmlib.notmuch_database_find_message_by_filename
107     _find_message_by_filename.argtypes = [NotmuchDatabaseP, c_char_p,
108                                           POINTER(NotmuchMessageP)]
109     _find_message_by_filename.restype = c_uint
110
111     """notmuch_database_get_all_tags"""
112     _get_all_tags = nmlib.notmuch_database_get_all_tags
113     _get_all_tags.argtypes = [NotmuchDatabaseP]
114     _get_all_tags.restype = NotmuchTagsP
115
116     """notmuch_database_create"""
117     _create = nmlib.notmuch_database_create
118     _create.argtypes = [c_char_p, POINTER(NotmuchDatabaseP)]
119     _create.restype = c_uint
120
121     def __init__(self, path = None, create = False,
122                  mode = MODE.READ_ONLY):
123         """If *path* is `None`, we will try to read a users notmuch
124         configuration and use his configured database. The location of the
125         configuration file can be specified through the environment variable
126         *NOTMUCH_CONFIG*, falling back to the default `~/.notmuch-config`.
127
128         If *create* is `True`, the database will always be created in
129         :attr:`MODE`.READ_WRITE mode. Default mode for opening is READ_ONLY.
130
131         :param path:   Directory to open/create the database in (see
132                        above for behavior if `None`)
133         :type path:    `str` or `None`
134         :param create: Pass `False` to open an existing, `True` to create a new
135                        database.
136         :type create:  bool
137         :param mode:   Mode to open a database in. Is always
138                        :attr:`MODE`.READ_WRITE when creating a new one.
139         :type mode:    :attr:`MODE`
140         :raises: :exc:`NotmuchError` or derived exception in case of
141             failure.
142         """
143         self._db = None
144         self.mode = mode
145         if path is None:
146             # no path specified. use a user's default database
147             if Database._std_db_path is None:
148                 #the following line throws a NotmuchError if it fails
149                 Database._std_db_path = self._get_user_default_db()
150             path = Database._std_db_path
151
152         if create == False:
153             self.open(path, mode)
154         else:
155             self.create(path)
156
157     _destroy = nmlib.notmuch_database_destroy
158     _destroy.argtypes = [NotmuchDatabaseP]
159     _destroy.restype = None
160
161     def __del__(self):
162         if self._db:
163             self._destroy(self._db)
164
165     def _assert_db_is_initialized(self):
166         """Raises :exc:`NotInitializedError` if self._db is `None`"""
167         if not self._db:
168             raise NotInitializedError()
169
170     def create(self, path):
171         """Creates a new notmuch database
172
173         This function is used by __init__() and usually does not need
174         to be called directly. It wraps the underlying
175         *notmuch_database_create* function and creates a new notmuch
176         database at *path*. It will always return a database in :attr:`MODE`
177         .READ_WRITE mode as creating an empty database for
178         reading only does not make a great deal of sense.
179
180         :param path: A directory in which we should create the database.
181         :type path: str
182         :raises: :exc:`NotmuchError` in case of any failure
183                     (possibly after printing an error message on stderr).
184         """
185         if self._db:
186             raise NotmuchError(message="Cannot create db, this Database() "
187                                        "already has an open one.")
188
189         db = NotmuchDatabaseP()
190         status = Database._create(_str(path), Database.MODE.READ_WRITE, byref(db))
191
192         if status != STATUS.SUCCESS:
193             raise NotmuchError(status)
194         self._db = db
195         return status
196
197     def open(self, path, mode=0):
198         """Opens an existing database
199
200         This function is used by __init__() and usually does not need
201         to be called directly. It wraps the underlying
202         *notmuch_database_open* function.
203
204         :param status: Open the database in read-only or read-write mode
205         :type status:  :attr:`MODE`
206         :raises: Raises :exc:`NotmuchError` in case of any failure
207                     (possibly after printing an error message on stderr).
208         """
209         db = NotmuchDatabaseP()
210         status = Database._open(_str(path), mode, byref(db))
211
212         if status != STATUS.SUCCESS:
213             raise NotmuchError(status)
214         self._db = db
215         return status
216
217     _close = nmlib.notmuch_database_close
218     _close.argtypes = [NotmuchDatabaseP]
219     _close.restype = None
220
221     def close(self):
222         '''
223         Closes the notmuch database.
224
225         .. warning::
226
227             This function closes the notmuch database. From that point
228             on every method invoked on any object ever derived from
229             the closed database may cease to function and raise a
230             NotmuchError.
231         '''
232         if self._db:
233             self._close(self._db)
234
235     def __enter__(self):
236         '''
237         Implements the context manager protocol.
238         '''
239         return self
240
241     def __exit__(self, exc_type, exc_value, traceback):
242         '''
243         Implements the context manager protocol.
244         '''
245         self.close()
246
247     def get_path(self):
248         """Returns the file path of an open database"""
249         self._assert_db_is_initialized()
250         return Database._get_path(self._db).decode('utf-8')
251
252     def get_version(self):
253         """Returns the database format version
254
255         :returns: The database version as positive integer
256         """
257         self._assert_db_is_initialized()
258         return Database._get_version(self._db)
259
260     _needs_upgrade = nmlib.notmuch_database_needs_upgrade
261     _needs_upgrade.argtypes = [NotmuchDatabaseP]
262     _needs_upgrade.restype = bool
263
264     def needs_upgrade(self):
265         """Does this database need to be upgraded before writing to it?
266
267         If this function returns `True` then no functions that modify the
268         database (:meth:`add_message`,
269         :meth:`Message.add_tag`, :meth:`Directory.set_mtime`,
270         etc.) will work unless :meth:`upgrade` is called successfully first.
271
272         :returns: `True` or `False`
273         """
274         self._assert_db_is_initialized()
275         return self._needs_upgrade(self._db)
276
277     def upgrade(self):
278         """Upgrades the current database
279
280         After opening a database in read-write mode, the client should
281         check if an upgrade is needed (notmuch_database_needs_upgrade) and
282         if so, upgrade with this function before making any modifications.
283
284         NOT IMPLEMENTED: The optional progress_notify callback can be
285         used by the caller to provide progress indication to the
286         user. If non-NULL it will be called periodically with
287         'progress' as a floating-point value in the range of [0.0..1.0]
288         indicating the progress made so far in the upgrade process.
289
290         :TODO: catch exceptions, document return values and etc...
291         """
292         self._assert_db_is_initialized()
293         status = Database._upgrade(self._db, None, None)
294         #TODO: catch exceptions, document return values and etc
295         return status
296
297     _begin_atomic = nmlib.notmuch_database_begin_atomic
298     _begin_atomic.argtypes = [NotmuchDatabaseP]
299     _begin_atomic.restype = c_uint
300
301     def begin_atomic(self):
302         """Begin an atomic database operation
303
304         Any modifications performed between a successful
305         :meth:`begin_atomic` and a :meth:`end_atomic` will be applied to
306         the database atomically.  Note that, unlike a typical database
307         transaction, this only ensures atomicity, not durability;
308         neither begin nor end necessarily flush modifications to disk.
309
310         :returns: :attr:`STATUS`.SUCCESS or raises
311         :raises: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION
312                     Xapian exception occurred; atomic section not entered.
313
314         *Added in notmuch 0.9*"""
315         self._assert_db_is_initialized()
316         status = self._begin_atomic(self._db)
317         if status != STATUS.SUCCESS:
318             raise NotmuchError(status)
319         return status
320
321     _end_atomic = nmlib.notmuch_database_end_atomic
322     _end_atomic.argtypes = [NotmuchDatabaseP]
323     _end_atomic.restype = c_uint
324
325     def end_atomic(self):
326         """Indicate the end of an atomic database operation
327
328         See :meth:`begin_atomic` for details.
329
330         :returns: :attr:`STATUS`.SUCCESS or raises
331
332         :raises:
333             :exc:`NotmuchError`:
334                 :attr:`STATUS`.XAPIAN_EXCEPTION
335                     A Xapian exception occurred; atomic section not
336                     ended.
337                 :attr:`STATUS`.UNBALANCED_ATOMIC:
338                     end_atomic has been called more times than begin_atomic.
339
340         *Added in notmuch 0.9*"""
341         self._assert_db_is_initialized()
342         status = self._end_atomic(self._db)
343         if status != STATUS.SUCCESS:
344             raise NotmuchError(status)
345         return status
346
347     def get_directory(self, path):
348         """Returns a :class:`Directory` of path,
349
350         :param path: An unicode string containing the path relative to the path
351               of database (see :meth:`get_path`), or else should be an absolute
352               path with initial components that match the path of 'database'.
353         :returns: :class:`Directory` or raises an exception.
354         :raises: :exc:`FileError` if path is not relative database or absolute
355                  with initial components same as database.
356         """
357         self._assert_db_is_initialized()
358
359         # sanity checking if path is valid, and make path absolute
360         if path and path[0] == os.sep:
361             # we got an absolute path
362             if not path.startswith(self.get_path()):
363                 # but its initial components are not equal to the db path
364                 raise FileError('Database().get_directory() called '
365                                 'with a wrong absolute path')
366             abs_dirpath = path
367         else:
368             #we got a relative path, make it absolute
369             abs_dirpath = os.path.abspath(os.path.join(self.get_path(), path))
370
371         dir_p = NotmuchDirectoryP()
372         status = Database._get_directory(self._db, _str(path), byref(dir_p))
373
374         if status != STATUS.SUCCESS:
375             raise NotmuchError(status)
376         if not dir_p:
377             return None
378
379         # return the Directory, init it with the absolute path
380         return Directory(abs_dirpath, dir_p, self)
381
382     _add_message = nmlib.notmuch_database_add_message
383     _add_message.argtypes = [NotmuchDatabaseP, c_char_p,
384                              POINTER(NotmuchMessageP)]
385     _add_message.restype = c_uint
386
387     def add_message(self, filename, sync_maildir_flags=False):
388         """Adds a new message to the database
389
390         :param filename: should be a path relative to the path of the
391             open database (see :meth:`get_path`), or else should be an
392             absolute filename with initial components that match the
393             path of the database.
394
395             The file should be a single mail message (not a
396             multi-message mbox) that is expected to remain at its
397             current location, since the notmuch database will reference
398             the filename, and will not copy the entire contents of the
399             file.
400
401         :param sync_maildir_flags: If the message contains Maildir
402             flags, we will -depending on the notmuch configuration- sync
403             those tags to initial notmuch tags, if set to `True`. It is
404             `False` by default to remain consistent with the libnotmuch
405             API. You might want to look into the underlying method
406             :meth:`Message.maildir_flags_to_tags`.
407
408         :returns: On success, we return
409
410            1) a :class:`Message` object that can be used for things
411               such as adding tags to the just-added message.
412            2) one of the following :attr:`STATUS` values:
413
414               :attr:`STATUS`.SUCCESS
415                   Message successfully added to database.
416               :attr:`STATUS`.DUPLICATE_MESSAGE_ID
417                   Message has the same message ID as another message already
418                   in the database. The new filename was successfully added
419                   to the list of the filenames for the existing message.
420
421         :rtype:   2-tuple(:class:`Message`, :attr:`STATUS`)
422
423         :raises: Raises a :exc:`NotmuchError` with the following meaning.
424               If such an exception occurs, nothing was added to the database.
425
426               :attr:`STATUS`.FILE_ERROR
427                       An error occurred trying to open the file, (such as
428                       permission denied, or file not found, etc.).
429               :attr:`STATUS`.FILE_NOT_EMAIL
430                       The contents of filename don't look like an email
431                       message.
432               :attr:`STATUS`.READ_ONLY_DATABASE
433                       Database was opened in read-only mode so no message can
434                       be added.
435         """
436         self._assert_db_is_initialized()
437         msg_p = NotmuchMessageP()
438         status = self._add_message(self._db, _str(filename), byref(msg_p))
439
440         if not status in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]:
441             raise NotmuchError(status)
442
443         #construct Message() and return
444         msg = Message(msg_p, self)
445         #automatic sync initial tags from Maildir flags
446         if sync_maildir_flags:
447             msg.maildir_flags_to_tags()
448         return (msg, status)
449
450     _remove_message = nmlib.notmuch_database_remove_message
451     _remove_message.argtypes = [NotmuchDatabaseP, c_char_p]
452     _remove_message.restype = c_uint
453
454     def remove_message(self, filename):
455         """Removes a message (filename) from the given notmuch database
456
457         Note that only this particular filename association is removed from
458         the database. If the same message (as determined by the message ID)
459         is still available via other filenames, then the message will
460         persist in the database for those filenames. When the last filename
461         is removed for a particular message, the database content for that
462         message will be entirely removed.
463
464         :returns: A :attr:`STATUS` value with the following meaning:
465
466              :attr:`STATUS`.SUCCESS
467                The last filename was removed and the message was removed
468                from the database.
469              :attr:`STATUS`.DUPLICATE_MESSAGE_ID
470                This filename was removed but the message persists in the
471                database with at least one other filename.
472
473         :raises: Raises a :exc:`NotmuchError` with the following meaning.
474              If such an exception occurs, nothing was removed from the
475              database.
476
477              :attr:`STATUS`.READ_ONLY_DATABASE
478                Database was opened in read-only mode so no message can be
479                removed.
480         """
481         self._assert_db_is_initialized()
482         return self._remove_message(self._db, _str(filename))
483
484     def find_message(self, msgid):
485         """Returns a :class:`Message` as identified by its message ID
486
487         Wraps the underlying *notmuch_database_find_message* function.
488
489         :param msgid: The message ID
490         :type msgid: unicode or str
491         :returns: :class:`Message` or `None` if no message is found.
492         :raises:
493             :exc:`OutOfMemoryError`
494                   If an Out-of-memory occured while constructing the message.
495             :exc:`XapianError`
496                   In case of a Xapian Exception. These exceptions
497                   include "Database modified" situations, e.g. when the
498                   notmuch database has been modified by another program
499                   in the meantime. In this case, you should close and
500                   reopen the database and retry.
501             :exc:`NotInitializedError` if
502                     the database was not intitialized.
503         """
504         self._assert_db_is_initialized()
505         msg_p = NotmuchMessageP()
506         status = Database._find_message(self._db, _str(msgid), byref(msg_p))
507         if status != STATUS.SUCCESS:
508             raise NotmuchError(status)
509         return msg_p and Message(msg_p, self) or None
510
511     def find_message_by_filename(self, filename):
512         """Find a message with the given filename
513
514         :returns: If the database contains a message with the given
515             filename, then a class:`Message:` is returned.  This
516             function returns None if no message is found with the given
517             filename.
518
519         :raises: :exc:`OutOfMemoryError` if an Out-of-memory occured while
520                  constructing the message.
521         :raises: :exc:`XapianError` in case of a Xapian Exception.
522                  These exceptions include "Database modified"
523                  situations, e.g. when the notmuch database has been
524                  modified by another program in the meantime. In this
525                  case, you should close and reopen the database and
526                  retry.
527         :raises: :exc:`NotInitializedError` if the database was not
528                  intitialized.
529         :raises: :exc:`ReadOnlyDatabaseError` if the database has not been
530                  opened in read-write mode
531
532         *Added in notmuch 0.9*"""
533         self._assert_db_is_initialized()
534
535         # work around libnotmuch calling exit(3), see
536         # id:20120221002921.8534.57091@thinkbox.jade-hamburg.de
537         # TODO: remove once this issue is resolved
538         if self.mode != Database.MODE.READ_WRITE:
539             raise ReadOnlyDatabaseError('The database has to be opened in '
540                                         'read-write mode for get_directory')
541
542         msg_p = NotmuchMessageP()
543         status = Database._find_message_by_filename(self._db, _str(filename),
544                                                     byref(msg_p))
545         if status != STATUS.SUCCESS:
546             raise NotmuchError(status)
547         return msg_p and Message(msg_p, self) or None
548
549     def get_all_tags(self):
550         """Returns :class:`Tags` with a list of all tags found in the database
551
552         :returns: :class:`Tags`
553         :execption: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER
554                     on error
555         """
556         self._assert_db_is_initialized()
557         tags_p = Database._get_all_tags(self._db)
558         if tags_p == None:
559             raise NullPointerError()
560         return Tags(tags_p, self)
561
562     def create_query(self, querystring):
563         """Returns a :class:`Query` derived from this database
564
565         This is a shorthand method for doing::
566
567           # short version
568           # Automatically frees the Database() when 'q' is deleted
569
570           q  = Database(dbpath).create_query('from:"Biene Maja"')
571
572           # long version, which is functionally equivalent but will keep the
573           # Database in the 'db' variable around after we delete 'q':
574
575           db = Database(dbpath)
576           q  = Query(db,'from:"Biene Maja"')
577
578         This function is a python extension and not in the underlying C API.
579         """
580         return Query(self, querystring)
581
582     def __repr__(self):
583         return "'Notmuch DB " + self.get_path() + "'"
584
585     def _get_user_default_db(self):
586         """ Reads a user's notmuch config and returns his db location
587
588         Throws a NotmuchError if it cannot find it"""
589         try:
590             # python3.x
591             from configparser import SafeConfigParser
592         except ImportError:
593             # python2.x
594             from ConfigParser import SafeConfigParser
595
596         config = SafeConfigParser()
597         conf_f = os.getenv('NOTMUCH_CONFIG',
598                            os.path.expanduser('~/.notmuch-config'))
599         config.readfp(codecs.open(conf_f, 'r', 'utf-8'))
600         if not config.has_option('database', 'path'):
601             raise NotmuchError(message="No DB path specified"
602                                        " and no user default found")
603         return config.get('database', 'path')
604
605     @property
606     def db_p(self):
607         """Property returning a pointer to `notmuch_database_t` or `None`
608
609         This should normally not be needed by a user (and is not yet
610         guaranteed to remain stable in future versions).
611         """
612         return self._db