libervia-backend: src/plugins/plugin_misc

annotate src/plugins/plugin_misc_maildir.py @ 255:55b750017b71

plugin IMAP, plugin Maildir: added flag, IMAP's uid management

author	Goffi <goffi@goffi.org>
date	Mon, 17 Jan 2011 21:26:16 +0100
parents	9fc32d1d9046
children	012c38b56cdd

rev	line source
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	3
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	4 """
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	5 SAT plugin for managing imap server
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	6 Copyright (C) 2011 Jérôme Poisson (goffi@goffi.org)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	7
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	8 This program is free software: you can redistribute it and/or modify
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	9 it under the terms of the GNU General Public License as published by
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	10 the Free Software Foundation, either version 3 of the License, or
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	11 (at your option) any later version.
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	12
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	13 This program is distributed in the hope that it will be useful,
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	14 but WITHOUT ANY WARRANTY; without even the implied warranty of
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	16 GNU General Public License for more details.
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	17
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	18 You should have received a copy of the GNU General Public License
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	19 along with this program. If not, see <http://www.gnu.org/licenses/>.
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	20 """
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	21
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	22 from logging import debug, info, error
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	23 import warnings
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	24 warnings.filterwarnings('ignore','the MimeWriter',DeprecationWarning,'twisted' ) #FIXME: to be removed, see http://twistedmatrix.com/trac/ticket/4038
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	25 from twisted.internet import protocol
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	26 from twisted.words.protocols.jabber import error as jab_error
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	27 from twisted.cred import portal,checkers
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	28 from twisted.mail import imap4,maildir
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	29 from email.parser import Parser
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	30 import email.message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	31 from email.charset import Charset
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	32 import os,os.path
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	33 from cStringIO import StringIO
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	34 from twisted.internet import reactor
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	35 import pdb
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	36
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	37
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	38 from zope.interface import implements
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	39
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	40
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	41 PLUGIN_INFO = {
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	42 "name": "Maildir Plugin",
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	43 "import_name": "Maildir",
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	44 "type": "Misc",
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	45 "protocols": [],
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	46 "dependencies": [],
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	47 "main": "MaildirBox",
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	48 "handler": "no",
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	49 "description": _("""Intercept "normal" type messages, and put them in a Maildir type box""")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	50 }
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	51
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	52 MAILDIR_PATH = "Maildir"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	53
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	54 class MaildirError(Exception):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	55 pass
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	56
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	57 class MaildirBox():
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	58
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	59 def __init__(self, host):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	60 info(_("Plugin Maildir initialization"))
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	61 self.host = host
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	62
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	63 self.__observed={}
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	64 self.__mailboxes={}
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	65 self.data=host.memory.getPrivate("MAILDIR_data") or {"INBOX":{"cur_idx":0}}
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	66 #a value in the dictionnary for a mailbox is a dictionnary with the following value
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	67 # - cur_idx: value of the current unique integer increment (UID)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	68 # - message_id (as returned by MaildirMailbox): a tuple of (UID, [flag1, flag2, ...])
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	69
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	70 #the trigger
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	71 host.trigger.add("MessageReceived", self.MessageReceivedTrigger)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	72
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	73 def __del__(self):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	74 debug('Destroying MaildirBox')
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	75 self.host.memory.setPrivate('MAILDIR_data',self.data)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	76
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	77 def accessMessageBox(self, boxname, observer=None):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	78 """Create and return a MailboxUser instance
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	79 @param boxname: name of the box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	80 @param observer: method to call when a NewMessage arrive"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	81 if not self.__mailboxes.has_key(boxname):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	82 self.__mailboxes[boxname]=MailboxUser(self, boxname, observer)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	83 else:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	84 if observer:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	85 self.addObserver(observer, boxname)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	86 return self.__mailboxes[boxname]
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	87
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	88 def _removeBoxAccess(self, boxname, mailboxUser):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	89 """Remove a reference to a box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	90 @param name: name of the box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	91 @param mailboxUser: MailboxUser instance"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	92 if not self.__mailboxes.has_key(boxname):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	93 err_msg=_("Trying to remove an mailboxUser not referenced")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	94 error(_("INTERNAL ERROR: ") + err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	95 raise MaildirError(err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	96 assert self.__mailboxes[boxname]==mailboxUser
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	97 del __mailboxes[boxname]
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	98
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	99 def _checkBoxReference(self, boxname):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	100 """Check if there is a reference on a box, and return it
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	101 @param boxname: name of the box to check
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	102 @return: MailboxUser instance or None"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	103 if self.__mailboxes.has_key(boxname):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	104 return self.__mailboxes[boxname]
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	105
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	106 def __getBoxData(self, boxname):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	107 """Return the date of a box"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	108 try:
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	109 return self.data[boxname] #the boxname MUST exist in the data
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	110 except KeyError:
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	111 err_msg=_("Boxname doesn't exist in internal data")
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	112 error(_("INTERNAL ERROR: ") + err_msg)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	113 raise MaildirError(err_msg)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	114
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	115 def getUid(self, boxname, message_id):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	116 """Return an unique integer, always ascending, for a message
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	117 This is mainly needed for the IMAP protocol
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	118 @param boxname: name of the box where the message is
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	119 @param message_id: unique id of the message as given by MaildirMailbox
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	120 @return: Integer UID"""
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	121 box_data = self.__getBoxData(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	122 if box_data.has_key(message_id):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	123 ret = box_data[message_id][0]
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	124 else:
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	125 box_data['cur_idx']+=1
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	126 box_data[message_id]=[box_data['cur_idx'],[]]
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	127 ret = box_data[message_id]
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	128 self.host.memory.setPrivate('MAILDIR_data',self.data)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	129 return ret
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	130
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	131 def getNextUid(self, boxname):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	132 """Return next unique integer that will generated
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	133 This is mainly needed for the IMAP protocol
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	134 @param boxname: name of the box where the message is
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	135 @return: Integer UID"""
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	136 box_data = self.__getBoxData(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	137 return box_data['cur_idx']+1
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	138
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	139 def getNextExistingUid(self, boxname, uid):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	140 """Give the next uid of existing message
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	141 @param boxname: name of the box where the message is
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	142 @param uid: uid to start from
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	143 @return: uid or None if the is no more message"""
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	144 box_data = self.__getBoxData(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	145 idx=uid+1
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	146 while self.getIdFromUid(boxname, idx) == None: #TODO: this is highly inefficient because getIdfromUid is inefficient, fix this
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	147 idx+=1
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	148 if idx>box_data['cur_idx']:
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	149 return None
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	150 return idx
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	151
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	152 def getMaxUid(self, boxname):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	153 """Give the max existing uid
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	154 @param boxname: name of the box where the message is
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	155 @return: uid"""
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	156 box_data = self.__getBoxData(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	157 return box_data['cur_idx']
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	158
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	159 def getIdFromUid(self, boxname, message_uid):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	160 """Return the message unique id from it's integer UID
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	161 @param boxname: name of the box where the message is
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	162 @param message_uid: unique integer identifier
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	163 @return: unique id of the message as given by MaildirMailbox or None if not found"""
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	164 box_data = self.__getBoxData(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	165 for message_id in box_data.keys(): #TODO: this is highly inefficient on big mailbox, must be replaced in the future
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	166 if message_id == 'cur_idx':
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	167 continue
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	168 if box_data[message_id][0] == message_uid:
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	169 return message_id
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	170 return None
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	171
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	172 def getFlags(self, boxname, mess_id):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	173 """Return the messages flags
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	174 @param boxname: name of the box where the message is
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	175 @param message_idx: message id as given by MaildirMailbox
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	176 @return: list of strings"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	177 box_data = self.__getBoxData(boxname)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	178 if not box_data.has_key(mess_id):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	179 raise MailboxException("Trying to get flags from an unexisting message")
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	180 return box_data[mess_id][1]
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	181
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	182 def setFlags(self, boxname, mess_id, flags):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	183 """Change the flags of the message
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	184 @param boxname: name of the box where the message is
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	185 @param message_idx: message id as given by MaildirMailbox
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	186 @param flags: list of strings
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	187 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	188 box_data = self.__getBoxData(boxname)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	189 assert(type(flags)==list)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	190 if not box_data.has_key(mess_id):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	191 raise MailboxException("Trying to set flags for an unexisting message")
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	192 box_data[mess_id][1]=flags
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	193 self.host.memory.setPrivate('MAILDIR_data',self.data)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	194
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	195 def getMessageIdsWithFlag(self, boxname, flag):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	196 """Return ids of messages where a flag is set
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	197 @param boxname: name of the box where the message is
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	198 @param flag: flag to check
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	199 @return: list of id (as given by MaildirMailbox)"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	200 box_data = self.__getBoxData(boxname)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	201 assert(isinstance(flag,basestring))
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	202 result = []
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	203 for key in box_data:
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	204 if key=='cur_idx':
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	205 continue
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	206 if flag in box_data[key][1]:
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	207 result.append(key)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	208 return result
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	209
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	210 def purgeDeleted(self, boxname):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	211 """Remove data for messages with flag "\\Deleted"
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	212 @param boxname: name of the box where the message is
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	213 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	214 box_data = self.__getBoxData(boxname)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	215 for mess_id in self.getMessageIdsWithFlag(boxname,"\\Deleted"):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	216 del(box_data[mess_id])
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	217 self.host.memory.setPrivate('MAILDIR_data',self.data)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	218
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	219 def cleanTable(self, boxname, existant_id):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	220 """Remove mails which no longuer exist from the table
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	221 @param boxname: name of the box to clean
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	222 @param existant_id: list of id which actually exist"""
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	223 box_data = self.__getBoxData(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	224 to_remove=[]
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	225 for key in box_data:
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	226 if key not in existant_id and key!="cur_idx":
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	227 to_remove.append(key)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	228 for key in to_remove:
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	229 del box_data[key]
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	230
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	231
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	232 def MessageReceivedTrigger(self, message):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	233 """This trigger catch normal message and put the in the Maildir box.
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	234 If the message is not of "normal" type, do nothing
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	235 @param message: message xmlstrem
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	236 @return: False if it's a normal message, True else"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	237 for e in message.elements():
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	238 if e.name == "body":
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	239 type = message['type'] if message.hasAttribute('type') else 'chat' #FIXME: check specs
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	240 if message['type'] != 'normal':
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	241 return True
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	242 self.accessMessageBox("INBOX").addMessage(message)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	243 return False
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	244
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	245 def addObserver(self, callback, boxname, signal="NEW_MESSAGE"):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	246 """Add an observer for maildir box changes
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	247 @param callback: method to call when the the box is updated
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	248 @param boxname: name of the box to observe
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	249 @param signal: which signal is observed by the caller"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	250 if not self.__observed.has_key(boxname):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	251 self.__observed[boxname]={}
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	252 if not self.__observed[boxname].has_key(signal):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	253 self.__observed[boxname][signal]=set()
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	254 self.__observed[boxname][signal].add(callback)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	255
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	256 def removeObserver(self, callback, boxname, signal="NEW_MESSAGE"):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	257 """Remove an observer of maildir box changes
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	258 @param callback: method to remove from obervers
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	259 @param boxname: name of the box which was observed
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	260 @param signal: which signal was observed by the caller"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	261 if not self.__observed.has_key(boxname):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	262 err_msg=_("Trying to remove an observer for an inexistant mailbox")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	263 error(_("INTERNAL ERROR: ") + err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	264 raise MaildirError(err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	265 if not self.__observed[boxname].has_key(signal):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	266 err_msg=_("Trying to remove an inexistant observer, no observer for this signal")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	267 error(_("INTERNAL ERROR: ") + err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	268 raise MaildirError(err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	269 if not callback in self.__observed[boxname][signal]:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	270 err_msg=_("Trying to remove an inexistant observer")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	271 error(_("INTERNAL ERROR: ") + err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	272 raise MaildirError(err_msg)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	273 self.__observed[boxname][signal].remove(callback)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	274
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	275 def emitSignal(self, boxname, signal_name):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	276 """Emit the signal to observer"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	277 debug('emitSignal %s %s' %(boxname, signal_name))
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	278 try:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	279 for observer_cb in self.__observed[boxname][signal_name]:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	280 observer_cb()
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	281 except KeyError:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	282 pass
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	283
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	284
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	285 class MailboxUser:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	286 """This class is used to access a mailbox"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	287
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	288 def xmppMessage2mail(self, message):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	289 """Convert the XMPP's XML message to a basic rfc2822 message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	290 @param xml: domish.Element of the message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	291 @return: string email"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	292 mail = email.message.Message()
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	293 mail['MIME-Version'] = "1.0"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	294 mail['Content-Type'] = "text/plain; charset=UTF-8; format=flowed"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	295 mail['Content-Transfer-Encoding'] = "8bit"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	296 mail['From'] = message['from'].encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	297 mail['To'] = message['to'].encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	298 mail['Date'] = email.utils.formatdate().encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	299 #TODO: save thread id
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	300 for e in message.elements():
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	301 if e.name == "body":
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	302 mail.set_payload(e.children[0].encode('utf-8'))
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	303 elif e.name == "subject":
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	304 mail['Subject'] = e.children[0].encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	305 return mail.as_string()
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	306
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	307 def __init__(self, _maildir, name, observer=None):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	308 """@param _maildir: the main MaildirBox instance
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	309 @param name: name of the mailbox
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	310 THIS OBJECT MUST NOT BE USED DIRECTLY: use MaildirBox.accessMessageBox instead"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	311 if _maildir._checkBoxReference(self):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	312 error ("INTERNAL ERROR: MailboxUser MUST NOT be instancied directly")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	313 raise MailboxException('double MailboxUser instanciation')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	314 if name!="INBOX":
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	315 raise NotImplementedError
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	316 self.name=name
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	317 self.maildir=_maildir
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	318 mailbox_path = os.path.expanduser(os.path.join(self.maildir.host.get_const('local_dir'), MAILDIR_PATH))
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	319 self.mailbox_path=mailbox_path
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	320 self.mailbox = maildir.MaildirMailbox(mailbox_path)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	321 self.observer=observer
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	322 self.__uid_table_update()
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	323
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	324
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	325 if observer:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	326 debug("adding observer for %s" % name)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	327 self.maildir.addObserver(observer, name, "NEW_MESSAGE")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	328
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	329 def __uid_table_update(self):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	330 existant_id=[]
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	331 for mess_idx in range (self.getMessageCount()):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	332 #we update the uid table
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	333 existant_id.append(self.getId(mess_idx))
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	334 self.getUid(mess_idx)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	335 self.maildir.cleanTable(self.name, existant_id)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	336
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	337
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	338 def __del__(self):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	339 if observer:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	340 debug("removing observer for %s" % self.name)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	341 self._maildir.removeObserver(observer, self.name, "NEW_MESSAGE")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	342 self._maildir._removeBoxAccess(self.name, self)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	343
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	344 def addMessage(self, message):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	345 """Add a message to the box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	346 @param message: XMPP XML message"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	347 self.mailbox.appendMessage(self.xmppMessage2mail(message)).addCallback(self.emitSignal, "NEW_MESSAGE")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	348
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	349 def emitSignal(self, ignore, signal):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	350 """Emit the signal to the observers"""
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	351 self.getUid(self.getMessageCount()-1) #we make an uid for the last message added
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	352 self.maildir.emitSignal(self.name, signal)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	353
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	354 def getId(self, mess_idx):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	355 """Return the Unique ID of the message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	356 @mess_idx: message index"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	357 return self.mailbox.getUidl(mess_idx)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	358
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	359 def getUid(self, mess_idx):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	360 """Return a unique interger id for the message, always ascending"""
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	361 mess_id=self.getId(mess_idx)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	362 return self.maildir.getUid(self.name,mess_id)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	363
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	364 def getNextUid(self):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	365 return self.maildir.getNextUid(self.name)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	366
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	367 def getNextExistingUid(self, uid):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	368 return self.maildir.getNextExistingUid(self.name, uid)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	369
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	370 def getMaxUid(self):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	371 return self.maildir.getMaxUid(self.name)
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	372
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	373 def getMessageCount(self):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	374 """Return number of mails present in this box"""
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	375 return len(self.mailbox.list)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	376
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	377 def getMessageIdx(self, mess_idx):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	378 """Return the full message
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	379 @mess_idx: message index"""
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	380 return self.mailbox.getMessage(mess_idx)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	381
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	382 def getIdxFromUid(self, mess_uid):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	383 """Return the message index from the uid
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	384 @param mess_uid: message unique identifier
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	385 @return: message index, as managed by MaildirMailbox"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	386 for mess_idx in range (self.getMessageCount()):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	387 if self.getUid(mess_idx) == mess_uid:
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	388 return mess_idx
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	389 raise IndexError
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	390
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	391 def getIdxFromId(self, mess_id):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	392 """Return the message index from the unique index
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	393 @param mess_id: message unique index as given by MaildirMailbox
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	394 @return: message sequence index"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	395 for mess_idx in range (self.getMessageCount()):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	396 if self.mailbox.getUidl(mess_idx) == mess_id:
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	397 return mess_idx
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	398 raise IndexError
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	399
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	400 def getMessage(self, mess_idx):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	401 """Return the full message
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	402 @param mess_idx: message index"""
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	403 return self.mailbox.getMessage(mess_idx)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	404
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	405 def getMessageUid(self, mess_uid):
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	406 """Return the full message
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	407 @param mess_idx: message unique identifier"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	408 return self.mailbox.getMessage(self.getIdxFromUid(mess_uid))
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	409
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	410 def getFlags(self, mess_idx):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	411 """Return the flags of the message
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	412 @param mess_idx: message index
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	413 @return: list of strings"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	414 id = self.getId(mess_idx)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	415 return self.maildir.getFlags(self.name, id)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	416
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	417 def getFlagsUid(self, mess_uid):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	418 """Return the flags of the message
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	419 @param mess_uid: message unique identifier
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	420 @return: list of strings"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	421 id = self.maildir.getIdFromUid(self.name,mess_uid)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	422 return self.maildir.getFlags(self.name, id)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	423
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	424 def setFlags(self, mess_idx, flags):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	425 """Change the flags of the message
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	426 @param mess_idx: message index
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	427 @param flags: list of strings
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	428 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	429 id = self.getId(mess_idx)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	430 return self.maildir.setFlags(self.name, id, flags)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	431
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	432 def setFlagsUid(self, mess_uid, flags):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	433 """Change the flags of the message
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	434 @param mess_uid: message unique identifier
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	435 @param flags: list of strings
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	436 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	437 id = self.maildir.getIdFromUid(self.name,mess_uid)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	438 return self.maildir.setFlags(self.name, id, flags)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	439
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	440 def getMessageIdsWithFlag(self, flag):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	441 """Return ids of messages where a flag is set
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	442 @param flag: flag to check
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	443 @return: list of id (as given by MaildirMailbox)"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	444 return self.maildir.getMessageIdsWithFlag(self.name,flag)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	445
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	446 def removeDeleted(self):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	447 """Actually delete message flagged "\\Deleted"
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	448 Also purge the internal data of these messages
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	449 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	450 for mess_id in self.getMessageIdsWithFlag("\\Deleted"):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	451 print ("Deleting %s", mess_id)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	452 self.mailbox.deleteMessage(self.getIdxFromId(mess_id))
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	453 self.mailbox = maildir.MaildirMailbox(self.mailbox_path) #We need to reparse the dir to have coherent indexing
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	454 self.maildir.purgeDeleted(self.name)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	455
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	456 def emptyTrash(self):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	457 """Delete everything in the .Trash dir"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	458 import shutils
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	459 pdb.set_trace()
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	460

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_maildir.py @ 255:55b750017b71