diff options
Diffstat (limited to 'lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/mail/maildir.py')
| -rwxr-xr-x | lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/mail/maildir.py | 518 |
1 files changed, 0 insertions, 518 deletions
diff --git a/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/mail/maildir.py b/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/mail/maildir.py deleted file mode 100755 index 7927b325..00000000 --- a/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/mail/maildir.py +++ /dev/null @@ -1,518 +0,0 @@ -# -*- test-case-name: twisted.mail.test.test_mail -*- -# Copyright (c) Twisted Matrix Laboratories. -# See LICENSE for details. - - -""" -Maildir-style mailbox support -""" - -import os -import stat -import socket - -from zope.interface import implements - -try: - import cStringIO as StringIO -except ImportError: - import StringIO - -from twisted.python.compat import set -from twisted.mail import pop3 -from twisted.mail import smtp -from twisted.protocols import basic -from twisted.persisted import dirdbm -from twisted.python import log, failure -from twisted.python.hashlib import md5 -from twisted.mail import mail -from twisted.internet import interfaces, defer, reactor -from twisted.cred import portal, credentials, checkers -from twisted.cred.error import UnauthorizedLogin - -INTERNAL_ERROR = '''\ -From: Twisted.mail Internals -Subject: An Error Occurred - - An internal server error has occurred. Please contact the - server administrator. -''' - -class _MaildirNameGenerator: - """ - Utility class to generate a unique maildir name - - @ivar _clock: An L{IReactorTime} provider which will be used to learn - the current time to include in names returned by L{generate} so that - they sort properly. - """ - n = 0 - p = os.getpid() - s = socket.gethostname().replace('/', r'\057').replace(':', r'\072') - - def __init__(self, clock): - self._clock = clock - - def generate(self): - """ - Return a string which is intended to unique across all calls to this - function (across all processes, reboots, etc). - - Strings returned by earlier calls to this method will compare less - than strings returned by later calls as long as the clock provided - doesn't go backwards. - """ - self.n = self.n + 1 - t = self._clock.seconds() - seconds = str(int(t)) - microseconds = '%07d' % (int((t - int(t)) * 10e6),) - return '%s.M%sP%sQ%s.%s' % (seconds, microseconds, - self.p, self.n, self.s) - -_generateMaildirName = _MaildirNameGenerator(reactor).generate - -def initializeMaildir(dir): - if not os.path.isdir(dir): - os.mkdir(dir, 0700) - for subdir in ['new', 'cur', 'tmp', '.Trash']: - os.mkdir(os.path.join(dir, subdir), 0700) - for subdir in ['new', 'cur', 'tmp']: - os.mkdir(os.path.join(dir, '.Trash', subdir), 0700) - # touch - open(os.path.join(dir, '.Trash', 'maildirfolder'), 'w').close() - - -class MaildirMessage(mail.FileMessage): - size = None - - def __init__(self, address, fp, *a, **kw): - header = "Delivered-To: %s\n" % address - fp.write(header) - self.size = len(header) - mail.FileMessage.__init__(self, fp, *a, **kw) - - def lineReceived(self, line): - mail.FileMessage.lineReceived(self, line) - self.size += len(line)+1 - - def eomReceived(self): - self.finalName = self.finalName+',S=%d' % self.size - return mail.FileMessage.eomReceived(self) - -class AbstractMaildirDomain: - """Abstract maildir-backed domain. - """ - alias = None - root = None - - def __init__(self, service, root): - """Initialize. - """ - self.root = root - - def userDirectory(self, user): - """Get the maildir directory for a given user - - Override to specify where to save mails for users. - Return None for non-existing users. - """ - return None - - ## - ## IAliasableDomain - ## - - def setAliasGroup(self, alias): - self.alias = alias - - ## - ## IDomain - ## - def exists(self, user, memo=None): - """Check for existence of user in the domain - """ - if self.userDirectory(user.dest.local) is not None: - return lambda: self.startMessage(user) - try: - a = self.alias[user.dest.local] - except: - raise smtp.SMTPBadRcpt(user) - else: - aliases = a.resolve(self.alias, memo) - if aliases: - return lambda: aliases - log.err("Bad alias configuration: " + str(user)) - raise smtp.SMTPBadRcpt(user) - - def startMessage(self, user): - """Save a message for a given user - """ - if isinstance(user, str): - name, domain = user.split('@', 1) - else: - name, domain = user.dest.local, user.dest.domain - dir = self.userDirectory(name) - fname = _generateMaildirName() - filename = os.path.join(dir, 'tmp', fname) - fp = open(filename, 'w') - return MaildirMessage('%s@%s' % (name, domain), fp, filename, - os.path.join(dir, 'new', fname)) - - def willRelay(self, user, protocol): - return False - - def addUser(self, user, password): - raise NotImplementedError - - def getCredentialsCheckers(self): - raise NotImplementedError - ## - ## end of IDomain - ## - -class _MaildirMailboxAppendMessageTask: - implements(interfaces.IConsumer) - - osopen = staticmethod(os.open) - oswrite = staticmethod(os.write) - osclose = staticmethod(os.close) - osrename = staticmethod(os.rename) - - def __init__(self, mbox, msg): - self.mbox = mbox - self.defer = defer.Deferred() - self.openCall = None - if not hasattr(msg, "read"): - msg = StringIO.StringIO(msg) - self.msg = msg - - def startUp(self): - self.createTempFile() - if self.fh != -1: - self.filesender = basic.FileSender() - self.filesender.beginFileTransfer(self.msg, self) - - def registerProducer(self, producer, streaming): - self.myproducer = producer - self.streaming = streaming - if not streaming: - self.prodProducer() - - def prodProducer(self): - self.openCall = None - if self.myproducer is not None: - self.openCall = reactor.callLater(0, self.prodProducer) - self.myproducer.resumeProducing() - - def unregisterProducer(self): - self.myproducer = None - self.streaming = None - self.osclose(self.fh) - self.moveFileToNew() - - def write(self, data): - try: - self.oswrite(self.fh, data) - except: - self.fail() - - def fail(self, err=None): - if err is None: - err = failure.Failure() - if self.openCall is not None: - self.openCall.cancel() - self.defer.errback(err) - self.defer = None - - def moveFileToNew(self): - while True: - newname = os.path.join(self.mbox.path, "new", _generateMaildirName()) - try: - self.osrename(self.tmpname, newname) - break - except OSError, (err, estr): - import errno - # if the newname exists, retry with a new newname. - if err != errno.EEXIST: - self.fail() - newname = None - break - if newname is not None: - self.mbox.list.append(newname) - self.defer.callback(None) - self.defer = None - - def createTempFile(self): - attr = (os.O_RDWR | os.O_CREAT | os.O_EXCL - | getattr(os, "O_NOINHERIT", 0) - | getattr(os, "O_NOFOLLOW", 0)) - tries = 0 - self.fh = -1 - while True: - self.tmpname = os.path.join(self.mbox.path, "tmp", _generateMaildirName()) - try: - self.fh = self.osopen(self.tmpname, attr, 0600) - return None - except OSError: - tries += 1 - if tries > 500: - self.defer.errback(RuntimeError("Could not create tmp file for %s" % self.mbox.path)) - self.defer = None - return None - -class MaildirMailbox(pop3.Mailbox): - """Implement the POP3 mailbox semantics for a Maildir mailbox - """ - AppendFactory = _MaildirMailboxAppendMessageTask - - def __init__(self, path): - """Initialize with name of the Maildir mailbox - """ - self.path = path - self.list = [] - self.deleted = {} - initializeMaildir(path) - for name in ('cur', 'new'): - for file in os.listdir(os.path.join(path, name)): - self.list.append((file, os.path.join(path, name, file))) - self.list.sort() - self.list = [e[1] for e in self.list] - - def listMessages(self, i=None): - """Return a list of lengths of all files in new/ and cur/ - """ - if i is None: - ret = [] - for mess in self.list: - if mess: - ret.append(os.stat(mess)[stat.ST_SIZE]) - else: - ret.append(0) - return ret - return self.list[i] and os.stat(self.list[i])[stat.ST_SIZE] or 0 - - def getMessage(self, i): - """Return an open file-pointer to a message - """ - return open(self.list[i]) - - def getUidl(self, i): - """Return a unique identifier for a message - - This is done using the basename of the filename. - It is globally unique because this is how Maildirs are designed. - """ - # Returning the actual filename is a mistake. Hash it. - base = os.path.basename(self.list[i]) - return md5(base).hexdigest() - - def deleteMessage(self, i): - """Delete a message - - This only moves a message to the .Trash/ subfolder, - so it can be undeleted by an administrator. - """ - trashFile = os.path.join( - self.path, '.Trash', 'cur', os.path.basename(self.list[i]) - ) - os.rename(self.list[i], trashFile) - self.deleted[self.list[i]] = trashFile - self.list[i] = 0 - - def undeleteMessages(self): - """Undelete any deleted messages it is possible to undelete - - This moves any messages from .Trash/ subfolder back to their - original position, and empties out the deleted dictionary. - """ - for (real, trash) in self.deleted.items(): - try: - os.rename(trash, real) - except OSError, (err, estr): - import errno - # If the file has been deleted from disk, oh well! - if err != errno.ENOENT: - raise - # This is a pass - else: - try: - self.list[self.list.index(0)] = real - except ValueError: - self.list.append(real) - self.deleted.clear() - - def appendMessage(self, txt): - """ - Appends a message into the mailbox. - - @param txt: A C{str} or file-like object giving the message to append. - - @return: A L{Deferred} which fires when the message has been appended to - the mailbox. - """ - task = self.AppendFactory(self, txt) - result = task.defer - task.startUp() - return result - -class StringListMailbox: - """ - L{StringListMailbox} is an in-memory mailbox. - - @ivar msgs: A C{list} of C{str} giving the contents of each message in the - mailbox. - - @ivar _delete: A C{set} of the indexes of messages which have been deleted - since the last C{sync} call. - """ - implements(pop3.IMailbox) - - def __init__(self, msgs): - self.msgs = msgs - self._delete = set() - - - def listMessages(self, i=None): - """ - Return the length of the message at the given offset, or a list of all - message lengths. - """ - if i is None: - return [self.listMessages(i) for i in range(len(self.msgs))] - if i in self._delete: - return 0 - return len(self.msgs[i]) - - - def getMessage(self, i): - """ - Return an in-memory file-like object for the message content at the - given offset. - """ - return StringIO.StringIO(self.msgs[i]) - - - def getUidl(self, i): - """ - Return a hash of the contents of the message at the given offset. - """ - return md5(self.msgs[i]).hexdigest() - - - def deleteMessage(self, i): - """ - Mark the given message for deletion. - """ - self._delete.add(i) - - - def undeleteMessages(self): - """ - Reset deletion tracking, undeleting any messages which have been - deleted since the last call to C{sync}. - """ - self._delete = set() - - - def sync(self): - """ - Discard the contents of any message marked for deletion and reset - deletion tracking. - """ - for index in self._delete: - self.msgs[index] = "" - self._delete = set() - - - -class MaildirDirdbmDomain(AbstractMaildirDomain): - """A Maildir Domain where membership is checked by a dirdbm file - """ - - implements(portal.IRealm, mail.IAliasableDomain) - - portal = None - _credcheckers = None - - def __init__(self, service, root, postmaster=0): - """Initialize - - The first argument is where the Domain directory is rooted. - The second is whether non-existing addresses are simply - forwarded to postmaster instead of outright bounce - - The directory structure of a MailddirDirdbmDomain is: - - /passwd <-- a dirdbm file - /USER/{cur,new,del} <-- each user has these three directories - """ - AbstractMaildirDomain.__init__(self, service, root) - dbm = os.path.join(root, 'passwd') - if not os.path.exists(dbm): - os.makedirs(dbm) - self.dbm = dirdbm.open(dbm) - self.postmaster = postmaster - - def userDirectory(self, name): - """Get the directory for a user - - If the user exists in the dirdbm file, return the directory - os.path.join(root, name), creating it if necessary. - Otherwise, returns postmaster's mailbox instead if bounces - go to postmaster, otherwise return None - """ - if not self.dbm.has_key(name): - if not self.postmaster: - return None - name = 'postmaster' - dir = os.path.join(self.root, name) - if not os.path.exists(dir): - initializeMaildir(dir) - return dir - - ## - ## IDomain - ## - def addUser(self, user, password): - self.dbm[user] = password - # Ensure it is initialized - self.userDirectory(user) - - def getCredentialsCheckers(self): - if self._credcheckers is None: - self._credcheckers = [DirdbmDatabase(self.dbm)] - return self._credcheckers - - ## - ## IRealm - ## - def requestAvatar(self, avatarId, mind, *interfaces): - if pop3.IMailbox not in interfaces: - raise NotImplementedError("No interface") - if avatarId == checkers.ANONYMOUS: - mbox = StringListMailbox([INTERNAL_ERROR]) - else: - mbox = MaildirMailbox(os.path.join(self.root, avatarId)) - - return ( - pop3.IMailbox, - mbox, - lambda: None - ) - -class DirdbmDatabase: - implements(checkers.ICredentialsChecker) - - credentialInterfaces = ( - credentials.IUsernamePassword, - credentials.IUsernameHashedPassword - ) - - def __init__(self, dbm): - self.dirdbm = dbm - - def requestAvatarId(self, c): - if c.username in self.dirdbm: - if c.checkPassword(self.dirdbm[c.username]): - return c.username - raise UnauthorizedLogin() |