libervia-backend: src/plugins/plugin_misc

annotate src/plugins/plugin_misc_maildir.py @ 1316:8adcdf2cdfe1 frontends_multi_profiles

core: added a "profileConnecting" method check: if a plugin has a profileConnecting method, it will be called when the profile is being connected but before the client stream is started. That can be usefull if things need to be done before the communication is started: e.g. putting triggers, loading PersistentDict, etc.

author	Goffi <goffi@goffi.org>
date	Mon, 09 Feb 2015 21:39:51 +0100
parents	3b1c5f723c4b
children	3265a2639182

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
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	4 # SàT plugin for managing Maildir type mail boxes
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	5 # Copyright (C) 2011 Jérôme Poisson (goffi@goffi.org)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	10 # (at your option) any later version.
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	15 # GNU Affero General Public License for more details.
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 663 diff changeset	20 from sat.core.i18n import _
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 771 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	23 log = getLogger(__name__)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	24 import warnings
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	25 warnings.filterwarnings('ignore', 'the MimeWriter', DeprecationWarning, 'twisted') # FIXME: to be removed, see http://twistedmatrix.com/trac/ticket/4038
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	26 from twisted.internet import protocol
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	27 from twisted.words.protocols import jabber
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	28 from twisted.cred import portal, checkers
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	29 from twisted.mail import imap4, maildir
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	30 from email.parser import Parser
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	31 import email.message
1218 3b1c5f723c4b plugin maildir: fixes missing import souliane <souliane@mailoo.org> parents: 993 diff changeset	32 import email.utils
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	33 from email.charset import Charset
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	34 import os
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	35 from cStringIO import StringIO
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	36 from twisted.internet import reactor
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 445 diff changeset	37 from sat.core.exceptions import ProfileUnknownError
439 866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	38 from sat.memory.persistent import PersistentBinaryDict
253 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 from zope.interface import implements
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	41
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	42 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	43 "name": "Maildir Plugin",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	44 "import_name": "Maildir",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	45 "type": "Misc",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	46 "protocols": [],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	47 "dependencies": [],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	48 "main": "MaildirBox",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	49 "handler": "no",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	50 "description": _("""Intercept "normal" type messages, and put them in a Maildir type box""")
253 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
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	53 MAILDIR_PATH = "Maildir"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	54
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	55
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	56 class MaildirError(Exception):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	57 pass
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	58
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	59
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	60 class MaildirBox(object):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	61
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	62 def __init__(self, host):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	63 log.info(_("Plugin Maildir initialization"))
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	64 self.host = host
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	65
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	66 self.__observed = {}
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	67 self.data = {} # list of profile spectific data. key = profile, value = PersistentBinaryDict where key=mailbox name,
439 866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	68 # and value is a dictionnary with the following value
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	69 # - cur_idx: value of the current unique integer increment (UID)
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	70 # - message_id (as returned by MaildirMailbox): a tuple of (UID, [flag1, flag2, ...])
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	71 pList = host.memory.getProfilesList # shorter :)
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	72 self.__mailboxes = {} # key: profile, value: {boxname: MailboxUser instance}
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	73
259 11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	74 #the triggers
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	75 host.trigger.add("MessageReceived", self.messageReceivedTrigger)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	76
439 866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	77 def profileConnected(self, profile):
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	78 """Called on profile connection, create profile data"""
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	79 self.data[profile] = PersistentBinaryDict("plugin_maildir", profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	80 self.__mailboxes[profile] = {}
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	81
439 866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	82 def dataLoaded(ignore):
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	83 if not self.data[profile]:
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	84 #the mailbox is new, we initiate the data
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	85 self.data[profile]["INBOX"] = {"cur_idx": 0}
439 866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	86 self.data[profile].load().addCallback(dataLoaded)
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	87
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	88 def profileDisconnected(self, profile):
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	89 """Called on profile disconnection, free profile's resources"""
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	90 del self.__mailboxes[profile]
866dbb0d7d87 plugin maildir: maildir now use PersistentBinaryDictionary to store profile specific data Goffi <goffi@goffi.org> parents: 365 diff changeset	91 del self.data[profile]
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	92
663 8004c7d4aba7 core: Deferred in onMessage. Goffi <goffi@goffi.org> parents: 622 diff changeset	93 def messageReceivedTrigger(self, message, post_treat, profile):
259 11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	94 """This trigger catch normal message and put the in the Maildir box.
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	95 If the message is not of "normal" type, do nothing
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	96 @param message: message xmlstrem
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	97 @return: False if it's a normal message, True else"""
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	98 for e in message.elements():
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	99 if e.name == "body":
264 27bc5d7732a3 core: fixed default message type Goffi <goffi@goffi.org> parents: 259 diff changeset	100 mess_type = message['type'] if message.hasAttribute('type') else 'normal'
27bc5d7732a3 core: fixed default message type Goffi <goffi@goffi.org> parents: 259 diff changeset	101 if mess_type != 'normal':
259 11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	102 return True
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	103 self.accessMessageBox("INBOX", profile_key=profile).addMessage(message)
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	104 return False
11f71187d5e4 core, plugin Maildir: added "ProfileCreation" Trigger Goffi <goffi@goffi.org> parents: 257 diff changeset	105
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 771 diff changeset	106 def accessMessageBox(self, boxname, observer=None, profile_key=C.PROF_KEY_NONE):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	107 """Create and return a MailboxUser instance
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	108 @param boxname: name of the box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	109 @param observer: method to call when a NewMessage arrive"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	110 profile = self.host.memory.getProfileName(profile_key)
012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	111 if not profile:
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 445 diff changeset	112 raise ProfileUnknownError(profile_key)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	113 if boxname not in self.__mailboxes[profile]:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	114 self.__mailboxes[profile][boxname] = MailboxUser(self, boxname, observer, profile=profile)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	115 else:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	116 if observer:
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	117 self.addObserver(observer, profile, boxname)
012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	118 return self.__mailboxes[profile][boxname]
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	119
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	120 def _getProfilePath(self, profile):
012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	121 """Return a unique path for profile's mailbox
012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	122 The path must be unique, usable as a dir name, and bijectional"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	123 return profile.replace('/', '_').replace('..', '_') # FIXME: this is too naive to work well, must be improved
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	124
012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	125 def _removeBoxAccess(self, boxname, mailboxUser, profile):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	126 """Remove a reference to a box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	127 @param name: name of the box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	128 @param mailboxUser: MailboxUser instance"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	129 if boxname not in self.__mailboxes:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	130 err_msg = _("Trying to remove an mailboxUser not referenced")
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	131 log.error(_("INTERNAL ERROR: ") + err_msg)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	132 raise MaildirError(err_msg)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	133 assert self.__mailboxes[profile][boxname] == mailboxUser
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	134 del self.__mailboxes[profile][boxname]
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	135
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	136 def _checkBoxReference(self, boxname, profile):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	137 """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	138 @param boxname: name of the box to check
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	139 @return: MailboxUser instance or None"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	140 if profile in self.__mailboxes:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	141 if boxname in self.__mailboxes[profile]:
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	142 return self.__mailboxes[profile][boxname]
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	143
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	144 def __getBoxData(self, boxname, profile):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	145 """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	146 try:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	147 return self.data[profile][boxname] # the boxname MUST exist in the data
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	148 except KeyError:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	149 err_msg = _("Boxname doesn't exist in internal data")
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	150 log.error(_("INTERNAL ERROR: ") + err_msg)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	151 raise MaildirError(err_msg)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	152
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	153 def getUid(self, boxname, message_id, profile):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	154 """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	155 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	156 @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	157 @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	158 @return: Integer UID"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	159 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	160 if message_id in box_data:
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	161 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	162 else:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	163 box_data['cur_idx'] += 1
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	164 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	165 ret = box_data[message_id]
445 1c1d1a4994c4 plugin maildir: replaced forgotten setPrivate by PersistentBinaryDict.force Goffi <goffi@goffi.org> parents: 439 diff changeset	166 self.data[profile].force(boxname)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	167 return ret
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	168
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	169 def getNextUid(self, boxname, profile):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	170 """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	171 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	172 @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	173 @return: Integer UID"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	174 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	175 return box_data['cur_idx'] + 1
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	176
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	177 def getNextExistingUid(self, boxname, uid, profile):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	178 """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	179 @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	180 @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	181 @return: uid or None if the is no more message"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	182 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	183 idx = uid + 1
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	184 while self.getIdFromUid(boxname, idx, profile) is None: # TODO: this is highly inefficient because getIdfromUid is inefficient, fix this
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	185 idx += 1
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	186 if idx > 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	187 return None
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	188 return idx
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	189
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	190 def getMaxUid(self, boxname, profile):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	191 """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	192 @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	193 @return: uid"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	194 box_data = self.__getBoxData(boxname, profile)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	195 return box_data['cur_idx']
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	196
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	197 def getIdFromUid(self, boxname, message_uid, profile):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	198 """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	199 @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	200 @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	201 @return: unique id of the message as given by MaildirMailbox or None if not found"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	202 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	203 for message_id in box_data.keys(): # TODO: this is highly inefficient on big mailbox, must be replaced in the future
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	204 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	205 continue
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	206 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	207 return message_id
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	208 return None
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	209
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	210 def getFlags(self, boxname, mess_id, profile):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	211 """Return the messages flags
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 @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	214 @return: list of strings"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	215 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	216 if mess_id not in box_data:
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	217 raise MaildirError("Trying to get flags from an unexisting message")
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	218 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	219
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	220 def setFlags(self, boxname, mess_id, flags, profile):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	221 """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	222 @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	223 @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	224 @param flags: list of strings
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	225 """
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	226 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	227 assert(type(flags) == list)
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	228 flags = [flag.upper() for flag in flags] # we store every flag UPPERCASE
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	229 if mess_id not in box_data:
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	230 raise MaildirError("Trying to set flags for an unexisting message")
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	231 box_data[mess_id][1] = flags
445 1c1d1a4994c4 plugin maildir: replaced forgotten setPrivate by PersistentBinaryDict.force Goffi <goffi@goffi.org> parents: 439 diff changeset	232 self.data[profile].force(boxname)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	233
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	234 def getMessageIdsWithFlag(self, boxname, flag, profile):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	235 """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	236 @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	237 @param flag: flag to check
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	238 @return: list of id (as given by MaildirMailbox)"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	239 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	240 assert(isinstance(flag, basestring))
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	241 flag = flag.upper()
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	242 result = []
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	243 for key in box_data:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	244 if key == 'cur_idx':
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	245 continue
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	246 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	247 result.append(key)
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	248 return result
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	249
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	250 def purgeDeleted(self, boxname, profile):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	251 """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	252 @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	253 """
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	254 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	255 for mess_id in self.getMessageIdsWithFlag(boxname, "\\Deleted", profile):
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	256 del(box_data[mess_id])
445 1c1d1a4994c4 plugin maildir: replaced forgotten setPrivate by PersistentBinaryDict.force Goffi <goffi@goffi.org> parents: 439 diff changeset	257 self.data[profile].force(boxname)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	258
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	259 def cleanTable(self, boxname, existant_id, profile):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	260 """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	261 @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	262 @param existant_id: list of id which actually exist"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	263 box_data = self.__getBoxData(boxname, profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	264 to_remove = []
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	265 for key in box_data:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	266 if key not in existant_id and key != "cur_idx":
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	267 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	268 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	269 del box_data[key]
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	270
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	271 def addObserver(self, callback, profile, boxname, signal="NEW_MESSAGE"):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	272 """Add an observer for maildir box changes
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	273 @param callback: method to call when the the box is updated
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	274 @param boxname: name of the box to observe
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	275 @param signal: which signal is observed by the caller"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	276 if (profile, boxname) not in self.__observed:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	277 self.__observed[(profile, boxname)] = {}
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	278 if signal not in self.__observed[(profile, boxname)]:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	279 self.__observed[(profile, boxname)][signal] = set()
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	280 self.__observed[(profile, boxname)][signal].add(callback)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	281
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	282 def removeObserver(self, callback, profile, boxname, signal="NEW_MESSAGE"):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	283 """Remove an observer of maildir box changes
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	284 @param callback: method to remove from obervers
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	285 @param boxname: name of the box which was observed
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	286 @param signal: which signal was observed by the caller"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	287 if (profile, boxname) not in self.__observed:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	288 err_msg = _("Trying to remove an observer for an inexistant mailbox")
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	289 log.error(_("INTERNAL ERROR: ") + err_msg)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	290 raise MaildirError(err_msg)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	291 if signal not in self.__observed[(profile, boxname)]:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	292 err_msg = _("Trying to remove an inexistant observer, no observer for this signal")
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	293 log.error(_("INTERNAL ERROR: ") + err_msg)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	294 raise MaildirError(err_msg)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	295 if not callback in self.__observed[(profile, boxname)][signal]:
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	296 err_msg = _("Trying to remove an inexistant observer")
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	297 log.error(_("INTERNAL ERROR: ") + err_msg)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	298 raise MaildirError(err_msg)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	299 self.__observed[(profile, boxname)][signal].remove(callback)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	300
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	301 def emitSignal(self, profile, boxname, signal_name):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	302 """Emit the signal to observer"""
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	303 log.debug('emitSignal %s %s %s' % (profile, boxname, signal_name))
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	304 try:
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	305 for observer_cb in self.__observed[(profile, boxname)][signal_name]:
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	306 observer_cb()
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	307 except KeyError:
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	308 pass
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	309
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	310
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	311 class MailboxUser(object):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	312 """This class is used to access a mailbox"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	313
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	314 def xmppMessage2mail(self, message):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	315 """Convert the XMPP's XML message to a basic rfc2822 message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	316 @param xml: domish.Element of the message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	317 @return: string email"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	318 mail = email.message.Message()
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	319 mail['MIME-Version'] = "1.0"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	320 mail['Content-Type'] = "text/plain; charset=UTF-8; format=flowed"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	321 mail['Content-Transfer-Encoding'] = "8bit"
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	322 mail['From'] = message['from'].encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	323 mail['To'] = message['to'].encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	324 mail['Date'] = email.utils.formatdate().encode('utf-8')
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	325 #TODO: save thread id
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	326 for e in message.elements():
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	327 if e.name == "body":
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	328 mail.set_payload(e.children[0].encode('utf-8'))
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	329 elif e.name == "subject":
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	330 mail['Subject'] = e.children[0].encode('utf-8')
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	331 return mail.as_string()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	332
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 771 diff changeset	333 def __init__(self, _maildir, name, observer=None, profile=C.PROF_KEY_NONE):
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	334 """@param _maildir: the main MaildirBox instance
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	335 @param name: name of the mailbox
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	336 @param profile: real profile (ie not a profile_key)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	337 THIS OBJECT MUST NOT BE USED DIRECTLY: use MaildirBox.accessMessageBox instead"""
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	338 if _maildir._checkBoxReference(name, profile):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	339 log.error("INTERNAL ERROR: MailboxUser MUST NOT be instancied directly")
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	340 raise MaildirError('double MailboxUser instanciation')
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	341 if name != "INBOX":
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	342 raise NotImplementedError
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	343 self.name = name
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	344 self.profile = profile
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	345 self.maildir = _maildir
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	346 profile_path = self.maildir._getProfilePath(profile)
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	347 full_profile_path = os.path.join(self.maildir.host.memory.getConfig('', 'local_dir'), 'maildir', profile_path)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	348 if not os.path.exists(full_profile_path):
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	349 os.makedirs(full_profile_path, 0700)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	350 mailbox_path = os.path.join(full_profile_path, MAILDIR_PATH)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	351 self.mailbox_path = mailbox_path
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	352 self.mailbox = maildir.MaildirMailbox(mailbox_path)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	353 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	354 self.__uid_table_update()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	355
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	356 if observer:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	357 log.debug("adding observer for %s (%s)" % (name, profile))
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	358 self.maildir.addObserver(observer, profile, name, "NEW_MESSAGE")
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	359
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	360 def __uid_table_update(self):
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	361 existant_id = []
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	362 for mess_idx in range(self.getMessageCount()):
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	363 #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	364 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	365 self.getUid(mess_idx)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	366 self.maildir.cleanTable(self.name, existant_id, profile=self.profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	367
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	368 def __del__(self):
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	369 if self.observer:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	370 log.debug("removing observer for %s" % self.name)
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	371 self._maildir.removeObserver(self.observer, self.name, "NEW_MESSAGE")
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	372 self.maildir._removeBoxAccess(self.name, self, profile=self.profile)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	373
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	374 def addMessage(self, message):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	375 """Add a message to the box
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	376 @param message: XMPP XML message"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	377 self.mailbox.appendMessage(self.xmppMessage2mail(message)).addCallback(self.emitSignal, "NEW_MESSAGE")
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	378
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	379 def emitSignal(self, ignore, signal):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	380 """Emit the signal to the observers"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	381 if signal == "NEW_MESSAGE":
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	382 self.getUid(self.getMessageCount() - 1) # XXX: we make an uid for the last message added
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	383 self.maildir.emitSignal(self.profile, self.name, signal)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	384
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	385 def getId(self, mess_idx):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	386 """Return the Unique ID of the message
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	387 @mess_idx: message index"""
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	388 return self.mailbox.getUidl(mess_idx)
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	389
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	390 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	391 """Return a unique interger id for the message, always ascending"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	392 mess_id = self.getId(mess_idx)
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	393 return self.maildir.getUid(self.name, mess_id, profile=self.profile)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	394
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	395 def getNextUid(self):
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	396 return self.maildir.getNextUid(self.name, profile=self.profile)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	397
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	398 def getNextExistingUid(self, uid):
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	399 return self.maildir.getNextExistingUid(self.name, uid, profile=self.profile)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	400
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	401 def getMaxUid(self):
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	402 return self.maildir.getMaxUid(self.name, profile=self.profile)
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	403
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	404 def getMessageCount(self):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	405 """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	406 return len(self.mailbox.list)
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	407
254 9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	408 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	409 """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	410 @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	411 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	412
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	413 def getIdxFromUid(self, mess_uid):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	414 """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	415 @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	416 @return: message index, as managed by MaildirMailbox"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	417 for mess_idx in range(self.getMessageCount()):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	418 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	419 return mess_idx
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	420 raise IndexError
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	421
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	422 def getIdxFromId(self, mess_id):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	423 """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	424 @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	425 @return: message sequence index"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	426 for mess_idx in range(self.getMessageCount()):
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	427 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	428 return mess_idx
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	429 raise IndexError
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	430
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	431 def getMessage(self, mess_idx):
f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	432 """Return the full message
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	433 @param mess_idx: message index"""
253 f45ffbf211e9 MAILDIR + IMAP plugins: first draft Goffi <goffi@goffi.org> parents: diff changeset	434 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	435
9fc32d1d9046 Plugin IMAP, plugin MAILDIR: added IMAP's UID management, mailbox data persistence Goffi <goffi@goffi.org> parents: 253 diff changeset	436 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	437 """Return the full message
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	438 @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	439 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	440
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	441 def getFlags(self, mess_idx):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	442 """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	443 @param mess_idx: message index
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	444 @return: list of strings"""
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	445 id = self.getId(mess_idx)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	446 return self.maildir.getFlags(self.name, id, profile=self.profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 480 diff changeset	447
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	448 def getFlagsUid(self, mess_uid):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	449 """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	450 @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	451 @return: list of strings"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	452 id = self.maildir.getIdFromUid(self.name, mess_uid, profile=self.profile)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	453 return self.maildir.getFlags(self.name, id, profile=self.profile)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	454
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	455 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	456 """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	457 @param mess_idx: message index
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	458 @param flags: list of strings
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	459 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	460 id = self.getId(mess_idx)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	461 self.maildir.setFlags(self.name, id, flags, profile=self.profile)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	462
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	463 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	464 """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	465 @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	466 @param flags: list of strings
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	467 """
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	468 id = self.maildir.getIdFromUid(self.name, mess_uid, profile=self.profile)
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	469 return self.maildir.setFlags(self.name, id, flags, profile=self.profile)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	470
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	471 def getMessageIdsWithFlag(self, flag):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	472 """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	473 @param flag: flag to check
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	474 @return: list of id (as given by MaildirMailbox)"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	475 return self.maildir.getMessageIdsWithFlag(self.name, flag, profile=self.profile)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	476
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	477 def removeDeleted(self):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	478 """Actually delete message flagged "\\Deleted"
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	479 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	480 """
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	481 for mess_id in self.getMessageIdsWithFlag("\\Deleted"):
338 6dcdc4cf8622 plugin maildir: fixed typo Goffi <goffi@goffi.org> parents: 264 diff changeset	482 print ("Deleting %s" % mess_id)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	483 self.mailbox.deleteMessage(self.getIdxFromId(mess_id))
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	484 self.mailbox = maildir.MaildirMailbox(self.mailbox_path) # We need to reparse the dir to have coherent indexing
257 012c38b56cdd plugin IMAP, plugin Maildir: profile management Goffi <goffi@goffi.org> parents: 255 diff changeset	485 self.maildir.purgeDeleted(self.name, profile=self.profile)
255 55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	486
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	487 def emptyTrash(self):
55b750017b71 plugin IMAP, plugin Maildir: added flag, IMAP's uid management Goffi <goffi@goffi.org> parents: 254 diff changeset	488 """Delete everything in the .Trash dir"""
622 9a8fbf0e8691 pluging maildir: some trivial fixes: Goffi <goffi@goffi.org> parents: 609 diff changeset	489 pass #TODO

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_maildir.py @ 1316:8adcdf2cdfe1 frontends_multi_profiles