diff options
author | Kali Kaneko <kali@leap.se> | 2015-07-10 12:41:14 -0400 |
---|---|---|
committer | Ruben Pollan <meskio@sindominio.net> | 2015-07-13 11:55:30 -0400 |
commit | 4ac9aef0b101975d70d3c33e30c6f01877c1bf2d (patch) | |
tree | 83abcbff10a8ad2c24821c5422c97a00fbaac075 /mail/src/leap/mail | |
parent | 6b2a3b5943e29cab4cc8d0bd6d8ff6c74ad3c077 (diff) |
[feature] add very basic support for message sequence numbers
this is just the bare minimum implementation of MSN (message sequence
numbers). It is not enough feature-wise, but I'm doing it now just to
support testing with the default imap client that we're using with the
regression tests.
Diffstat (limited to 'mail/src/leap/mail')
-rw-r--r-- | mail/src/leap/mail/imap/mailbox.py | 100 | ||||
-rw-r--r-- | mail/src/leap/mail/imap/messages.py | 4 | ||||
-rw-r--r-- | mail/src/leap/mail/mail.py | 31 |
3 files changed, 81 insertions, 54 deletions
diff --git a/mail/src/leap/mail/imap/mailbox.py b/mail/src/leap/mail/imap/mailbox.py index 0de4b40..4339bd2 100644 --- a/mail/src/leap/mail/imap/mailbox.py +++ b/mail/src/leap/mail/imap/mailbox.py @@ -457,7 +457,33 @@ class IMAPMailbox(object): raise imap4.ReadOnlyMailbox return self.collection.delete_all_flagged() - def _bound_seq(self, messages_asked): + def _get_message_fun(self, uid): + """ + Return the proper method to get a message for this mailbox, depending + on the passed uid flag. + + :param uid: If true, the IDs specified in the query are UIDs; + otherwise they are message sequence IDs. + :type uid: bool + :rtype: callable + """ + get_message_fun = [ + self.collection.get_message_by_sequence_number, + self.collection.get_message_by_uid][uid] + return get_message_fun + + def _get_messages_range(self, messages_asked, uid=True): + + def get_range(messages_asked): + return self._filter_msg_seq(messages_asked) + + d = defer.maybeDeferred(self._bound_seq, messages_asked, uid) + if uid: + d.addCallback(get_range) + d.addErrback(lambda f: log.err(f)) + return d + + def _bound_seq(self, messages_asked, uid): """ Put an upper bound to a messages sequence if this is open. @@ -465,17 +491,26 @@ class IMAPMailbox(object): :type messages_asked: MessageSet :rtype: MessageSet """ - def set_last(last_uid): + + def set_last_uid(last_uid): messages_asked.last = last_uid return messages_asked + def set_last_seq(all_uid): + messages_asked.last = len(all_uid) + return messages_asked + if not messages_asked.last: try: iter(messages_asked) except TypeError: # looks like we cannot iterate - d = self.collection.get_last_uid() - d.addCallback(set_last) + if uid: + d = self.collection.get_last_uid() + d.addCallback(set_last_uid) + else: + d = self.collection.all_uid_iter() + d.addCallback(set_last_seq) return d return messages_asked @@ -516,15 +551,7 @@ class IMAPMailbox(object): :rtype: deferred with a generator that yields... """ - # TODO implement sequence - # is_sequence = True if uid == 0 else False - # XXX DEBUG --- if you attempt to use the `getmail` utility under - # imap/tests, or muas like mutt, it will choke until we implement - # sequence numbers. This is an easy hack meanwhile. - is_sequence = False - # ----------------------------------------------------------------- - - getmsg = self.collection.get_message_by_uid + get_msg_fun = self._get_message_fun(uid) getimapmsg = self.get_imap_message def get_imap_messages_for_range(msg_range): @@ -551,7 +578,7 @@ class IMAPMailbox(object): # body. We should be smarter at do_FETCH and pass a parameter # to this method in order not to prefetch cdocs if they're not # going to be used. - d_msg.append(getmsg(msgid, get_cdocs=True)) + d_msg.append(get_msg_fun(msgid, get_cdocs=True)) d = defer.gatherResults(d_msg, consumeErrors=True) d.addCallback(_get_imap_msg) @@ -559,24 +586,9 @@ class IMAPMailbox(object): d.addErrback(lambda failure: log.err(failure)) return d - # for sequence numbers (uid = 0) - if is_sequence: - # TODO --- implement sequences in mailbox indexer - raise NotImplementedError - - else: - d = self._get_messages_range(messages_asked) - d.addCallback(get_imap_messages_for_range) - d.addErrback(lambda failure: log.err(failure)) - - return d - - def _get_messages_range(self, messages_asked): - def get_range(messages_asked): - return self._filter_msg_seq(messages_asked) - - d = defer.maybeDeferred(self._bound_seq, messages_asked) - d.addCallback(get_range) + d = self._get_messages_range(messages_asked, uid) + d.addCallback(get_imap_messages_for_range) + d.addErrback(lambda failure: log.err(failure)) return d def fetch_flags(self, messages_asked, uid): @@ -611,7 +623,8 @@ class IMAPMailbox(object): # --------------------------------------------------------------- if is_sequence: - raise NotImplementedError + raise NotImplementedError( + "FETCH FLAGS NOT IMPLEMENTED FOR MESSAGE SEQUENCE NUMBERS YET") d = defer.Deferred() reactor.callLater(0, self._do_fetch_flags, messages_asked, uid, d) @@ -652,6 +665,7 @@ class IMAPMailbox(object): def get_flags_for_seq(sequence): d_all_flags = [] for msgid in sequence: + # TODO implement sequence numbers here too d_flags_per_uid = self.collection.get_flags_by_uid(msgid) d_flags_per_uid.addCallback(pack_flags) d_all_flags.append(d_flags_per_uid) @@ -663,7 +677,7 @@ class IMAPMailbox(object): generator = (item for item in result) d.callback(generator) - d_seq = self._get_messages_range(messages_asked) + d_seq = self._get_messages_range(messages_asked, uid) d_seq.addCallback(get_flags_for_seq) return d_seq @@ -694,7 +708,8 @@ class IMAPMailbox(object): # TODO implement sequences is_sequence = True if uid == 0 else False if is_sequence: - raise NotImplementedError + raise NotImplementedError( + "FETCH HEADERS NOT IMPLEMENTED FOR SEQUENCE NUMBER YET") class headersPart(object): def __init__(self, uid, headers): @@ -748,11 +763,6 @@ class IMAPMailbox(object): :raise ReadOnlyMailbox: Raised if this mailbox is not open for read-write. """ - # TODO implement sequences - is_sequence = True if uid == 0 else False - if is_sequence: - raise NotImplementedError - if not self.isWriteable(): log.msg('read only mailbox!') raise imap4.ReadOnlyMailbox @@ -762,8 +772,9 @@ class IMAPMailbox(object): mode, uid, d) if PROFILE_CMD: do_profile_cmd(d, "STORE") + d.addCallback(self.collection.cb_signal_unread_to_ui) - d.addErrback(lambda f: log.msg(f.getTraceback())) + d.addErrback(lambda f: log.err(f)) return d def _do_store(self, messages_asked, flags, mode, uid, observer): @@ -777,14 +788,13 @@ class IMAPMailbox(object): done. :type observer: deferred """ - # TODO implement also sequence (uid = 0) # TODO we should prevent client from setting Recent flag + get_msg_fun = self._get_message_fun(uid) leap_assert(not isinstance(flags, basestring), "flags cannot be a string") flags = tuple(flags) def set_flags_for_seq(sequence): - def return_result_dict(list_of_flags): result = dict(zip(list(sequence), list_of_flags)) observer.callback(result) @@ -792,7 +802,7 @@ class IMAPMailbox(object): d_all_set = [] for msgid in sequence: - d = self.collection.get_message_by_uid(msgid) + d = get_msg_fun(msgid) d.addCallback(lambda msg: self.collection.update_flags( msg, flags, mode)) d_all_set.append(d) @@ -800,7 +810,7 @@ class IMAPMailbox(object): got_flags_setted.addCallback(return_result_dict) return got_flags_setted - d_seq = self._get_messages_range(messages_asked) + d_seq = self._get_messages_range(messages_asked, uid) d_seq.addCallback(set_flags_for_seq) return d_seq diff --git a/mail/src/leap/mail/imap/messages.py b/mail/src/leap/mail/imap/messages.py index 4c6f10d..9af4c99 100644 --- a/mail/src/leap/mail/imap/messages.py +++ b/mail/src/leap/mail/imap/messages.py @@ -173,7 +173,7 @@ class IMAPMessage(object): :rtype: Any object implementing C{IMessagePart}. :return: The specified sub-part. """ - subpart = self.message.get_subpart(part) + subpart = self.message.get_subpart(part + 1) return IMAPMessagePart(subpart) def __prefetch_body_file(self): @@ -204,7 +204,7 @@ class IMAPMessagePart(object): return self.message_part.is_multipart() def getSubPart(self, part): - subpart = self.message_part.get_subpart(part) + subpart = self.message_part.get_subpart(part + 1) return IMAPMessagePart(subpart) diff --git a/mail/src/leap/mail/mail.py b/mail/src/leap/mail/mail.py index f6936dd..6a7c558 100644 --- a/mail/src/leap/mail/mail.py +++ b/mail/src/leap/mail/mail.py @@ -149,7 +149,7 @@ class MessagePart(object): # TODO support arbitrarily nested multiparts (right now we only support # the trivial case) - def __init__(self, part_map, cdocs={}): + def __init__(self, part_map, cdocs={}, nested=False): """ :param part_map: a dictionary mapping the subparts for this MessagePart (1-indexed). @@ -170,6 +170,7 @@ class MessagePart(object): """ self._pmap = part_map self._cdocs = cdocs + self._nested = nested index = _get_index_for_cdoc(part_map, self._cdocs) or 1 self._index = index @@ -230,7 +231,7 @@ class MessagePart(object): cdoc_index = _get_index_for_cdoc(part_map, self._cdocs) cdoc = self._cdocs.get(cdoc_index, {}) - return MessagePart(part_map, cdocs={1: cdoc}) + return MessagePart(part_map, cdocs={1: cdoc}, nested=True) def _get_payload(self, index): cdoc_wrapper = self._cdocs.get(index, None) @@ -329,20 +330,17 @@ class Message(object): def get_subpart(self, part): """ - :param part: The number of the part to retrieve, indexed from 0. + :param part: The number of the part to retrieve, indexed from 1. :type part: int :rtype: MessagePart """ if not self.is_multipart(): raise TypeError - part_index = part + 1 try: - subpart_dict = self._wrapper.get_subpart_dict(part_index) + subpart_dict = self._wrapper.get_subpart_dict(part) except KeyError: raise IndexError - # FIXME instead of passing the index, let the MessagePart figure it out - # by getting the phash and iterating through the cdocs return MessagePart( subpart_dict, cdocs=self._wrapper.cdocs) @@ -467,6 +465,21 @@ class MessageCollection(object): self.messageklass, self.store, metamsg_id, get_cdocs=get_cdocs) + def get_message_by_sequence_number(self, msn, get_cdocs=False): + """ + Retrieve a message by its Message Sequence Number. + :rtype: Deferred + """ + def get_uid_for_msn(all_uid): + return all_uid[msn - 1] + d = self.all_uid_iter() + d.addCallback(get_uid_for_msn) + d.addCallback( + lambda uid: self.get_message_by_uid( + uid, get_cdocs=get_cdocs)) + d.addErrback(lambda f: log.err(f)) + return d + def get_message_by_uid(self, uid, absolute=True, get_cdocs=False): """ Retrieve a message by its Unique Identifier. @@ -476,6 +489,8 @@ class MessageCollection(object): flag. For now, only absolute identifiers are supported. :rtype: Deferred """ + # TODO deprecate absolute flag, it doesn't make sense UID and + # !absolute. use _by_sequence_number instead. if not absolute: raise NotImplementedError("Does not support relative ids yet") @@ -502,6 +517,7 @@ class MessageCollection(object): return d def get_flags_by_uid(self, uid, absolute=True): + # TODO use sequence numbers if not absolute: raise NotImplementedError("Does not support relative ids yet") @@ -825,6 +841,7 @@ class MessageCollection(object): self.store, self.mbox_uuid) mdocs_deleted.addCallback(get_uid_list) mdocs_deleted.addCallback(delete_uid_entries) + mdocs_deleted.addErrback(lambda f: log.err(f)) return mdocs_deleted # TODO should add a delete-by-uid to collection? |