libervia-backend: src/plugins/plugin_misc

comparison src/plugins/plugin_misc_imap.py @ 257:012c38b56cdd

plugin IMAP, plugin Maildir: profile management - IMAP Login/pass is now checked against profile name/jabber pass - Mailboxes are now per-profile - flags are now checked without case sensitiveness

author	Goffi <goffi@goffi.org>
date	Tue, 18 Jan 2011 00:57:26 +0100
parents	55b750017b71
children	c8406fe5e81e

comparison

equal deleted inserted replaced

-:f5181f6dd98f
+:012c38b56cdd
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 """
-SAT plugin for managing imap server
+SàT plugin for managing imap server
 Copyright (C) 2011  Jérôme Poisson (goffi@goffi.org)
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 from logging import debug, info, error
 import warnings
-from twisted.internet import protocol
+from twisted.internet import protocol,defer
 from twisted.words.protocols.jabber import error as jab_error
-from twisted.cred import portal,checkers
+from twisted.cred import portal,checkers,credentials
+from twisted.cred import error as cred_error
 from twisted.mail import imap4
 from email.parser import Parser
 import email.message
 import os,os.path
 from cStringIO import StringIO
 def getUID(self):
 """Retrieve the unique identifier associated with this message.
 """
 debug('getUID (message)')
-debug ('===>%i', self.uid)
 return self.uid
 def getFlags(self):
 """Retrieve the flags associated with this message.
 @return: The flags, represented as strings.
 class SatMailbox:
 implements(imap4.IMailbox)
-def __init__(self,host,name):
+def __init__(self,host,name,profile):
 self.host = host
 self.listeners=set()
 debug ('Mailbox init (%s)', name)
 if name!="INBOX":
 raise imap4.MailboxException("Only INBOX is managed for the moment")
-self.name=name
+self.mailbox=self.host.plugins["Maildir"].accessMessageBox(name,self.newMessage, profile)
-self.mailbox=self.host.plugins["Maildir"].accessMessageBox("INBOX",self.newMessage)
 def newMessage(self):
 """Called when a new message is in the mailbox"""
 debug ("newMessage signal received")
 nb_messages=self.getMessageCount()
 def getUnseenCount(self):
 """Return the number of messages with the 'Unseen' flag.
 """
 debug('getUnseenCount')
-return self.getMessageCount()-len(self.mailbox.getMessageIdsWithFlag('\\Seen'))
+return self.getMessageCount()-len(self.mailbox.getMessageIdsWithFlag('\\SEEN'))
 def isWriteable(self):
 """Get the read/write status of the mailbox.
 @return: A true value if write permission is allowed, a false value otherwise.
 """
 @return: A deferred whose callback is invoked with the message
 id if the message is added successfully and whose errback is
 invoked otherwise.
 """
 debug('addMessage')
-raise NotImplementedError
+raise imap4.MailboxException("Client message addition not implemented yet")
 def expunge(self):
 """Remove all messages flagged \\Deleted.
 @return: The list of message sequence numbers which were deleted,
 or a Deferred whose callback will be invoked with such a list.
 been performed, or a Deferred whose callback will be invoked with
 such a dict.
 """
 debug('store')
+flags=[flag.upper() for flag in flags]
 def updateFlags(getF,setF):
 ret = {}
 for mess_id in messages:
 if (uid and mess_id == None) or (not uid and mess_id>self.getMessageCount()):
 break
 _flags.difference_update(set(flags))
 else:
 _flags.update(set(flags))
 new_flags=list(_flags)
 setF(mess_id, new_flags)
-ret[mess_id] = new_flags
+ret[mess_id] = tuple(new_flags)
 return ret
 if uid:
 messages.last = self.mailbox.getMaxUid()
 messages.getnext = self.mailbox.getNextExistingUid
-return updateFlags(self.mailbox.getFlagsUid,self.mailbox.setFlagsUid)
+ret = updateFlags(self.mailbox.getFlagsUid,self.mailbox.setFlagsUid)
+for listener in self.listeners:
+listener.flagsChanged(ret)
+return ret
 else:
 messages.last = self.getMessageCount()
-return updateFlags(self.mailbox.getFlags,self.mailbox.setFlags)
+ret = updateFlags(self.mailbox.getFlags,self.mailbox.setFlags)
+newFlags={}
+for idx in ret:
+#we have to convert idx to uid for the listeners
+newFlags[self.mailbox.getUid(idx)] = ret[idx]
+for listener in self.listeners:
+listener.flagsChanged(newFlags)
+return ret
 def getFlags(self):
 """Return the flags defined in this mailbox
 Flags with the \\ prefix are reserved for use as system flags.
 @return: A list of the flags that can be set on messages in this mailbox.
 """
 debug('getFlags')
-return ['\Seen','\Answered','\Flagged','\Deleted','\Draft'] #TODO: add '\Recent'
+return ['\\SEEN','\\ANSWERED','\\FLAGGED','\\DELETED','\\DRAFT'] #TODO: add '\\RECENT'
 def getHierarchicalDelimiter(self):
 """Get the character which delimits namespaces for in this mailbox.
 """
 debug('getHierarchicalDelimiter')
 return '.'
+class ImapSatAccount(imap4.MemoryAccount):
-class ImapAccount(imap4.MemoryAccount):
 #implements(imap4.IAccount)
-# Actually implement the interface here
+def __init__(self, host, profile):
-def __init__(self, host, name):
 debug("ImapAccount init")
 self.host=host
-imap4.MemoryAccount.__init__(self,name)
+self.profile=profile
+imap4.MemoryAccount.__init__(self,profile)
 self.addMailbox("Inbox") #We only manage Inbox for the moment
 debug ('INBOX added')
 def _emptyMailbox(self, name, id):
-return SatMailbox(self.host,name)
+return SatMailbox(self.host,name,self.profile)
 class ImapRealm:
 implements(portal.IRealm)
 def __init__(self,host):
 self.host = host
 def requestAvatar(self, avatarID, mind, *interfaces):
 debug('requestAvatar')
+profile=avatarID.decode('utf-8')
 if imap4.IAccount not in interfaces:
 raise NotImplementedError
-return imap4.IAccount, ImapAccount(self.host,avatarID), lambda:None
+return imap4.IAccount, ImapSatAccount(self.host,profile), lambda:None
+class SatProfileCredentialChecker:
+"""
+This credential checker check against SàT's profile and associated jabber's password
+Check if the profile exists, and if the password is OK
+Return the profile as avatarId
+"""
+implements(checkers.ICredentialsChecker)
+credentialInterfaces = (credentials.IUsernamePassword,
+credentials.IUsernameHashedPassword)
+def __init__(self, host):
+self.host = host
+def _cbPasswordMatch(self, matched, profile):
+if matched:
+return profile.encode('utf-8')
+else:
+return failure.Failure(cred_error.UnauthorizedLogin())
+def requestAvatarId(self, credentials):
+profiles = self.host.memory.getProfilesList()
+if not credentials.username in profiles:
+return defer.fail(cred_error.UnauthorizedLogin())
+password = self.host.memory.getParamA("Password", "Connection", profile_key=credentials.username)
+return defer.maybeDeferred(
+credentials.checkPassword,
+password).addCallback(
+self._cbPasswordMatch, credentials.username)
 class ImapServerFactory(protocol.ServerFactory):
 protocol = imap4.IMAP4Server
 def __init__(self, host):
 def buildProtocol(self, addr):
 debug ("Building protocole")
 prot = protocol.ServerFactory.buildProtocol(self, addr)
 prot.portal = portal.Portal(ImapRealm(self.host))
-prot.portal.registerChecker(checkers.InMemoryUsernamePasswordDatabaseDontUse(goffi="toto"))
+prot.portal.registerChecker(SatProfileCredentialChecker(self.host))
 return prot

Mercurial > libervia-backend

comparison src/plugins/plugin_misc_imap.py @ 257:012c38b56cdd