git.notmuchmail.org Git - notmuch/blob - bindings/python/notmuch/globals.py

   1 """
   2 This file is part of notmuch.
   3
   4 Notmuch is free software: you can redistribute it and/or modify it
   5 under the terms of the GNU General Public License as published by the
   6 Free Software Foundation, either version 3 of the License, or (at your
   7 option) any later version.
   8
   9 Notmuch is distributed in the hope that it will be useful, but WITHOUT
  10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with notmuch.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
  18 """
  19
  20 from ctypes import CDLL, c_char_p, c_int, Structure, POINTER
  21
  22 #-----------------------------------------------------------------------------
  23 #package-global instance of the notmuch library
  24 try:
  25     nmlib = CDLL("libnotmuch.so.2")
  26 except:
  27     raise ImportError("Could not find shared 'notmuch' library.")
  28
  29
  30 class Enum(object):
  31     """Provides ENUMS as "code=Enum(['a','b','c'])" where code.a=0 etc..."""
  32     def __init__(self, names):
  33         for number, name in enumerate(names):
  34             setattr(self, name, number)
  35
  36
  37 class Status(Enum):
  38     """Enum with a string representation of a notmuch_status_t value."""
  39     _status2str = nmlib.notmuch_status_to_string
  40     _status2str.restype = c_char_p
  41     _status2str.argtypes = [c_int]
  42
  43     def __init__(self, statuslist):
  44         """It is initialized with a list of strings that are available as
  45         Status().string1 - Status().stringn attributes.
  46         """
  47         super(Status, self).__init__(statuslist)
  48
  49     @classmethod
  50     def status2str(self, status):
  51         """Get a string representation of a notmuch_status_t value."""
  52         # define strings for custom error messages
  53         if status == STATUS.NOT_INITIALIZED:
  54             return "Operation on uninitialized object impossible."
  55         return str(Status._status2str(status))
  56
  57 STATUS = Status(['SUCCESS',
  58   'OUT_OF_MEMORY',
  59   'READ_ONLY_DATABASE',
  60   'XAPIAN_EXCEPTION',
  61   'FILE_ERROR',
  62   'FILE_NOT_EMAIL',
  63   'DUPLICATE_MESSAGE_ID',
  64   'NULL_POINTER',
  65   'TAG_TOO_LONG',
  66   'UNBALANCED_FREEZE_THAW',
  67   'UNBALANCED_ATOMIC',
  68   'NOT_INITIALIZED'])
  69 """STATUS is a class, whose attributes provide constants that serve as return
  70 indicators for notmuch functions. Currently the following ones are defined. For
  71 possible return values and specific meaning for each method, see the method
  72 description.
  73
  74   * SUCCESS
  75   * OUT_OF_MEMORY
  76   * READ_ONLY_DATABASE
  77   * XAPIAN_EXCEPTION
  78   * FILE_ERROR
  79   * FILE_NOT_EMAIL
  80   * DUPLICATE_MESSAGE_ID
  81   * NULL_POINTER
  82   * TAG_TOO_LONG
  83   * UNBALANCED_FREEZE_THAW
  84   * UNBALANCED_ATOMIC
  85   * NOT_INITIALIZED
  86
  87 Invoke the class method `notmuch.STATUS.status2str` with a status value as
  88 argument to receive a human readable string"""
  89 STATUS.__name__ = 'STATUS'
  90
  91
  92 class NotmuchError(Exception):
  93     """Is initiated with a (notmuch.STATUS[, message=None]). It will not
  94     return an instance of the class NotmuchError, but a derived instance
  95     of a more specific Error Message, e.g. OutOfMemoryError. Each status
  96     but SUCCESS has a corresponding subclassed Exception."""
  97
  98     @classmethod
  99     def get_exc_subclass(cls, status):
 100         """Returns a fine grained Exception() type,
 101         detailing the error status"""
 102         subclasses = {
 103             STATUS.OUT_OF_MEMORY: OutOfMemoryError,
 104             STATUS.READ_ONLY_DATABASE: ReadOnlyDatabaseError,
 105             STATUS.XAPIAN_EXCEPTION: XapianError,
 106             STATUS.FILE_ERROR: FileError,
 107             STATUS.FILE_NOT_EMAIL: FileNotEmailError,
 108             STATUS.DUPLICATE_MESSAGE_ID: DuplicateMessageIdError,
 109             STATUS.NULL_POINTER: NullPointerError,
 110             STATUS.TAG_TOO_LONG: TagTooLongError,
 111             STATUS.UNBALANCED_FREEZE_THAW: UnbalancedFreezeThawError,
 112             STATUS.UNBALANCED_ATOMIC: UnbalancedAtomicError,
 113             STATUS.NOT_INITIALIZED: NotInitializedError,
 114         }
 115         assert 0 < status <= len(subclasses)
 116         return subclasses[status]
 117
 118     def __new__(cls, *args, **kwargs):
 119         """Return a correct subclass of NotmuchError if needed
 120
 121         We return a NotmuchError instance if status is None (or 0) and a
 122         subclass that inherits from NotmuchError depending on the
 123         'status' parameter otherwise."""
 124         # get 'status'. Passed in as arg or kwarg?
 125         status = args[0] if len(args) else kwargs.get('status', None)
 126         # no 'status' or cls is subclass already, return 'cls' instance
 127         if not status or cls != NotmuchError:
 128             return super(NotmuchError, cls).__new__(cls)
 129         subclass = cls.get_exc_subclass(status)  # which class to use?
 130         return subclass.__new__(subclass, *args, **kwargs)
 131
 132     def __init__(self, status=None, message=None):
 133         self.status = status
 134         self.message = message
 135
 136     def __str__(self):
 137         if self.message is not None:
 138             return self.message
 139         elif self.status is not None:
 140             return STATUS.status2str(self.status)
 141         else:
 142             return 'Unknown error'
 143
 144
 145 # List of Subclassed exceptions that correspond to STATUS values and are
 146 # subclasses of NotmuchError.
 147 class OutOfMemoryError(NotmuchError):
 148     status = STATUS.OUT_OF_MEMORY
 149
 150
 151 class ReadOnlyDatabaseError(NotmuchError):
 152     status = STATUS.READ_ONLY_DATABASE
 153
 154
 155 class XapianError(NotmuchError):
 156     status = STATUS.XAPIAN_EXCEPTION
 157
 158
 159 class FileError(NotmuchError):
 160     status = STATUS.FILE_ERROR
 161
 162
 163 class FileNotEmailError(NotmuchError):
 164     status = STATUS.FILE_NOT_EMAIL
 165
 166
 167 class DuplicateMessageIdError(NotmuchError):
 168     status = STATUS.DUPLICATE_MESSAGE_ID
 169
 170
 171 class NullPointerError(NotmuchError):
 172     status = STATUS.NULL_POINTER
 173
 174
 175 class TagTooLongError(NotmuchError):
 176     status = STATUS.TAG_TOO_LONG
 177
 178
 179 class UnbalancedFreezeThawError(NotmuchError):
 180     status = STATUS.UNBALANCED_FREEZE_THAW
 181
 182
 183 class UnbalancedAtomicError(NotmuchError):
 184     status = STATUS.UNBALANCED_ATOMIC
 185
 186
 187 class NotInitializedError(NotmuchError):
 188     """Derived from NotmuchError, this occurs if the underlying data
 189     structure (e.g. database is not initialized (yet) or an iterator has
 190     been exhausted. You can test for NotmuchError with .status =
 191     STATUS.NOT_INITIALIZED"""
 192     status = STATUS.NOT_INITIALIZED
 193
 194
 195 def _str(value):
 196     """Ensure a nicely utf-8 encoded string to pass to libnotmuch
 197
 198     C++ code expects strings to be well formatted and
 199     unicode strings to have no null bytes."""
 200     if not isinstance(value, basestring):
 201         raise TypeError("Expected str or unicode, got %s" % str(type(value)))
 202     if isinstance(value, unicode):
 203         return value.encode('UTF-8')
 204     return value
 205
 206
 207 class NotmuchDatabaseS(Structure):
 208     pass
 209 NotmuchDatabaseP = POINTER(NotmuchDatabaseS)
 210
 211
 212 class NotmuchQueryS(Structure):
 213     pass
 214 NotmuchQueryP = POINTER(NotmuchQueryS)
 215
 216
 217 class NotmuchThreadsS(Structure):
 218     pass
 219 NotmuchThreadsP = POINTER(NotmuchThreadsS)
 220
 221
 222 class NotmuchThreadS(Structure):
 223     pass
 224 NotmuchThreadP = POINTER(NotmuchThreadS)
 225
 226
 227 class NotmuchMessagesS(Structure):
 228     pass
 229 NotmuchMessagesP = POINTER(NotmuchMessagesS)
 230
 231
 232 class NotmuchMessageS(Structure):
 233     pass
 234 NotmuchMessageP = POINTER(NotmuchMessageS)
 235
 236
 237 class NotmuchTagsS(Structure):
 238     pass
 239 NotmuchTagsP = POINTER(NotmuchTagsS)
 240
 241
 242 class NotmuchDirectoryS(Structure):
 243     pass
 244 NotmuchDirectoryP = POINTER(NotmuchDirectoryS)
 245
 246
 247 class NotmuchFilenamesS(Structure):
 248     pass
 249 NotmuchFilenamesP = POINTER(NotmuchFilenamesS)