/usr/lib/python3/dist-packages/twisted/mail/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/mail/__pycache__/maildir.cpython-310.pyc (29890B)
o
bMl @ s~ d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
ddl m Z m
Z
mZ ddlmZ ddlmZmZmZ dd lmZmZmZ dd
lmZ dd lm Z dd l m Z m Z d
Z G dd dZ!e!ej"Z#dd Z$G dd dej%Z&e
ej'G dd dZ(e
ej)G dd dZ*G dd dej+Z,e
ej-G dd dZ.e
ej/G d d d e(Z0e
e j1G d d d Z2dS ) z
Maildir-style mailbox support.
N)md5)IO) implementer)checkers credentialsportal)UnauthorizedLogin)defer
interfacesreactor)mailpop3smtpdirdbm)basic)failurelogzFrom: Twisted.mail Internals
Subject: An Error Occurred
An internal server error has occurred. Please contact the
server administrator.
c @ sD e Zd ZdZdZe Ze
dd
ddZ dd Z d d
Z
d S ) _MaildirNameGeneratoraK
A utility class to generate a unique maildir name.
@type n: L{int}
@ivar n: A counter used to generate unique integers.
@type p: L{int}
@ivar p: The ID of the current process.
@type s: L{bytes}
@ivar s: A representation of the hostname.
@ivar _clock: See C{clock} parameter of L{__init__}.
r /z\057:z\072c C
|| _ dS )z
@type clock: L{IReactorTime
} provider
@param clock: A reactor which will be used to learn the current time.
N)_clock)selfclock r 6/usr/lib/python3/dist-packages/twisted/mail/maildir.py__init__8
z _MaildirNameGenerator.__init__c C sb | j d | _ | j }tt|}dt|t| d f }| d| d| j d| j d| j S )a
Generate a string which is intended to be 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.
@rtype: L{bytes}
@return: A unique string.
z%07dg cAz.MPQ.)nr secondsstrintps)r tr$ microsecondsr r r generate? s
&z _MaildirNameGenerator.generateN)__name__
__module__ __qualname____doc__r# osgetpidr' socket gethostnamereplacer( r r+ r r r r r $ s r c C s t | } t j| sAt | d dD ]
}t t j| |d qdD ]}t t j| d|d q#tt j| ddd dS dS )z
Create a maildir user directory if it doesn't already exist.
@type dir: L{bytes}
@param dir: The path name for a user directory.
i )newcurtmp.Trash)r5 r6 r7 r8
maildirfolderwN)r0 fsdecodepathisdirmkdirjoinopenclose)dirsubdirr r r initializeMaildirU s
rD c @ s, e Zd ZdZdZdd Zdd Zdd ZdS ) MaildirMessagez
A message receiver which adds a header and delivers a message to a file
whose name includes the size of the message.
@type size: L{int}
@ivar size: The number of octets in the message.
Nc O s< d| }| | t|| _tjj| |g|R i | dS )a
@type address: L{bytes}
@param address: The address of the message recipient.
@type fp: file-like object
@param fp: The file in which to store the message while it is being
received.
@type a: 2-L{tuple} of (0) L{bytes}, (1) L{bytes}
@param a: Positional arguments for L{FileMessage.__init__}.
@type kw: L{dict}
@param kw: Keyword arguments for L{FileMessage.__init__}.
zDelivered-To: %s
N)writelensizer FileMessager )r addressfpakwheaderr r r r r s
zMaildirMessage.__init__c C s( t j| | | jt|d 7 _dS )zo
Write a line to the file.
@type line: L{bytes}
@param line: A received line.
r N)r rI lineReceivedrH rG )r liner r r rO s zMaildirMessage.lineReceivedc C s | j d| j | _ tj| S )aO
At the end of message, rename the file holding the message to its final
name concatenated with the size of the file.
@rtype: L{Deferred } which successfully results in
L{bytes}
@return: A deferred which returns the name of the file holding the
message.
z,S=%d) finalNamerH r rI eomReceivedr r r r rR s
zMaildirMessage.eomReceived)r, r- r. r/ rH r rO rR r r r r rE g s
rE c @ sZ e Zd ZdZdZdZdd Zdd Zdd Zdd d
Z d d Z
d
d Z dd Z dd Z
dS )AbstractMaildirDomainz
An abstract maildir-backed domain.
@type alias: L{None} or L{dict} mapping
L{bytes} to L{AliasBase}
@ivar alias: A mapping of username to alias.
@ivar root: See L{__init__}.
Nc C s
|| _ dS )z
@type service: L{MailService}
@param service: An email service.
@type root: L{bytes}
@param root: The maildir root directory.
N)root)r servicerU r r r r s
z AbstractMaildirDomain.__init__c C dS )z
Return the maildir directory for a user.
@type user: L{bytes}
@param user: A username.
@rtype: L{bytes} or L{None}
@return: The user's mail directory for a valid user. Otherwise,
L{None}.
Nr r userr r r
userDirectory s z#AbstractMaildirDomain.userDirectoryc C r )z
Set the group of defined aliases for this domain.
@type alias: L{dict} mapping L{bytes} to L{IAlias} provider.
@param alias: A mapping of domain name to alias.
N)alias)r r[ r r r
setAliasGroup s
z#AbstractMaildirDomain.setAliasGroupc s jjdurfddS z jjj }W n ty% tw |j| r5 fddS t dt
t)a
Check whether a user exists in this domain or an alias of it.
@type user: L{User}
@param user: A user.
@type memo: L{None} or L{dict} of L{AliasBase}
@param memo: A record of the addresses already considered while
resolving aliases. The default value should be used by all
external code.
@rtype: no-argument callable which returns L{IMessage }
provider.
@return: A function which takes no arguments and returns a message
receiver for the user.
@raises SMTPBadRcpt: When the given user does not exist in this domain
or an alias of it.
Nc s
S N) startMessager rX r r s
z.AbstractMaildirDomain.exists..c s S r] r r )aliasesr r r_ zBad alias configuration: ) rZ destlocalr[
BaseExceptionr SMTPBadRcptresolver errr% )r rY memorL r )r` r rY r exists s
z AbstractMaildirDomain.existsc C s| t |tr|dd\}}n |jj|jj}}| |}t }tj
|d|}t |d}t | d| ||tj
|d|S )z
Create a maildir message for a user.
@type user: L{bytes}
@param user: A username.
@rtype: L{MaildirMessage}
@return: A message receiver for this user.
@r r7 r: r5 )
isinstancer% splitrb rc domainrZ _generateMaildirNamer0 r< r? r@ rE )r rY namerm rB fnamefilenamerK r r r r^ s
z"AbstractMaildirDomain.startMessagec C rW )a
Check whether this domain will relay.
@type user: L{Address}
@param user: The destination address.
@type protocol: L{SMTP}
@param protocol: The protocol over which the message to be relayed is
being received.
@rtype: L{bool}
@return: An indication of whether this domain will relay the message to
the destination.
Fr )r rY protocolr r r willRelay s z AbstractMaildirDomain.willRelayc C t )z
Add a user to this domain.
Subclasses should override this method.
@type user: L{bytes}
@param user: A username.
@type password: L{bytes}
@param password: A password.
NotImplementedErrorr rY passwordr r r addUser s z AbstractMaildirDomain.addUserc C rt )a
Return credentials checkers for this domain.
Subclasses should override this method.
@rtype: L{list} of L{ICredentialsChecker
} provider
@return: Credentials checkers for this domain.
ru rS r r r getCredentialsCheckers# s
z,AbstractMaildirDomain.getCredentialsCheckersr] )r, r- r. r/ r[ rU r rZ r\ ri r^ rs ry rz r r r r rT s
! rT c @ s e Zd ZdZeejZeejZ eej
Z eej Z
dd Zdd Zdd Zdd Zd
d Zd d
ZdddZdd Zdd ZdS ) _MaildirMailboxAppendMessageTaska
A task which adds a message to a maildir mailbox.
@ivar mbox: See L{__init__}.
@type defer: L{Deferred } which successfully returns
L{None}
@ivar defer: A deferred which fires when the task has completed.
@type opencall: L{IDelayedCall } provider or
L{None}
@ivar opencall: A scheduled call to L{prodProducer}.
@type msg: file-like object
@ivar msg: The message to add.
@type tmpname: L{bytes}
@ivar tmpname: The pathname of the temporary file holding the message while
it is being transferred.
@type fh: file
@ivar fh: The new maildir file.
@type filesender: L{FileSender }
@ivar filesender: A file sender which sends the message.
@type myproducer: L{IProducer }
@ivar myproducer: The registered producer.
@type streaming: L{bool}
@ivar streaming: Indicates whether the registered producer provides a
streaming interface.
c C s4 || _ t | _d| _t|dst|}|| _dS )z
@type mbox: L{MaildirMailbox}
@param mbox: A maildir mailbox.
@type msg: L{bytes} or file-like object
@param msg: The message to add.
Nread)mboxr DeferredopenCallhasattrioBytesIOmsg)r r} r r r r r Y s
z)_MaildirMailboxAppendMessageTask.__init__c C s4 | | jdkrt | _| j| j| dS dS )z@
Start transferring the message to the mailbox.
N)createTempFilefhr
FileSender
filesenderbeginFileTransferr rS r r r startUph s
z(_MaildirMailboxAppendMessageTask.startUpc C s || _ || _|s| dS dS )aS
Register a producer and start asking it for data if it is
non-streaming.
@type producer: L{IProducer }
@param producer: A producer.
@type streaming: L{bool}
@param streaming: A flag indicating whether the producer provides a
streaming interface.
N)
myproducer streaming prodProducer)r producerr r r r registerProducerq s
z1_MaildirMailboxAppendMessageTask.registerProducerc C s2 d| _ | jdurtd| j| _ | j dS dS )zK
Repeatedly prod a non-streaming producer to produce data.
Nr )r r r callLaterr resumeProducingrS r r r r s
z-_MaildirMailboxAppendMessageTask.prodProducerc C s$ d| _ d| _| | j | dS )zA
Finish transferring the message to the mailbox.
N)r r oscloser
moveFileToNewrS r r r unregisterProducer s z3_MaildirMailboxAppendMessageTask.unregisterProducerc C s2 z
| | j| W dS ty | Y dS w )z
Write data to the maildir file.
@type data: L{bytes}
@param data: Data to be written to the file.
N)oswriter rd fail)r datar r r rF s
z&_MaildirMailboxAppendMessageTask.writeNc C s: |du rt }| jdur| j | j| d| _dS )z
Fire the deferred to indicate the task completed with a failure.
@type err: L{Failure }
@param err: The error that occurred.
N)r Failurer cancelr errback)r rg r r r r s
z%_MaildirMailboxAppendMessageTask.failc
C s t j| jjdt }z | | j| W n- tyA } z |j\}}ddl }||j
kr7| d}W Y d}~n W Y d}~nd}~ww q|durY| jj
| | jd d| _dS dS )z
Place the message in the I{new/} directory, add it to the mailbox and
fire the deferred to indicate that the task has completed
successfully.
Tr5 r N)r0 r< r? r} rn osrenametmpnameOSErrorargserrnoEEXISTr listappendr callback)r newnameerg estrr r r r r s*
z._MaildirMailboxAppendMessageTask.moveFileToNewc C s t jt jB t jB tt ddB tt ddB }d}d| _ t j| jjdt | _
z | | j
|d| _W dS t yV |d 7 }|d
krT| j
td | jj d| _
Y dS Y nw q) zY
Create a temporary file to hold the message as it is being transferred.
O_NOINHERITr
O_NOFOLLOWr Tr7 i Nr i z Could not create tmp file for %s)r0 O_RDWRO_CREATO_EXCLgetattrr r< r? r} rn r osopenr r r RuntimeError)r attrtriesr r r r s<
z/_MaildirMailboxAppendMessageTask.createTempFiler] )r, r- r. r/ staticmethodr0 r@ r rF r rA r renamer r r r r r r r r r r r r r{ 0 s
"
r{ c @ sN e Zd ZdZeZdd ZdddZdd Zd d
Z d d Z
d
d Z dd Z dS )MaildirMailboxa
A maildir-backed mailbox.
@ivar path: See L{__init__}.
@type list: L{list} of L{int} or 2-L{tuple} of (0) file-like object,
(1) L{bytes}
@ivar list: Information about the messages in the mailbox. For undeleted
messages, the file containing the message and the
full path name of the file are stored. Deleted messages are indicated
by 0.
@type deleted: L{dict} mapping 2-L{tuple} of (0) file-like object,
(1) L{bytes} to L{bytes}
@type deleted: A mapping of the information about a file before it was
deleted to the full path name of the deleted file in the I{.Trash/}
subfolder.
c
C sz || _ g | _i | _t| dD ] }ttj ||D ]}| j|tj |||f qq| j dd | jD | _dS )ze
@type path: L{bytes}
@param path: The directory name for a maildir mailbox.
)r6 r5 c S s g | ]}|d qS )r r ).0r r r r
s z+MaildirMailbox.__init__..N) r< r deletedrD r0 listdirr? r sort)r r< ro filer r r r s
zMaildirMailbox.__init__Nc C sf |du r!g }| j D ]}|r|t|tj q |d q |S | j | r1t| j | tj p2dS )al
Retrieve the size of a message, or, if none is specified, the size of
each message in the mailbox.
@type i: L{int} or L{None}
@param i: The 0-based index of a message.
@rtype: L{int} or L{list} of L{int}
@return: The number of octets in the specified message, or, if an index
is not specified, a list of the number of octets for all messages
in the mailbox. Any value which corresponds to a deleted message
is set to 0.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
Nr )r r r0 statST_SIZE)r iretmessr r r listMessages
s
$zMaildirMailbox.listMessagesc C s t | j| S )aR
Retrieve a file-like object with the contents of a message.
@type i: L{int}
@param i: The 0-based index of a message.
@rtype: file-like object
@return: A file containing the message.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
)r@ r r r r r r
getMessage% s
zMaildirMailbox.getMessagec C s t j| j| }t| S )ar
Get a unique identifier for a message.
@type i: L{int}
@param i: The 0-based index of a message.
@rtype: L{bytes}
@return: A string of printable characters uniquely identifying the
message for all time.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
)r0 r< basenamer r hexdigest)r r baser r r getUidl4 s zMaildirMailbox.getUidlc C sR t j| jddt j| j| }t | j| | || j| j| < d| j|< dS )aK
Mark a message for deletion.
Move the message to the I{.Trash/} subfolder so it can be undeleted
by an administrator.
@type i: L{int}
@param i: The 0-based index of a message.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
r8 r6 r N)r0 r< r? r r r r )r r trashFiler r r
deleteMessageF s
z MaildirMailbox.deleteMessagec C s | j D ]H\}}zt|| W n! ty2 } z|j\}}ddl}||jkr( W Y d}~qd}~ww z || j| j d< W q t
yM | j | Y qw | j dS )z
Undelete all messages marked for deletion.
Move each message marked for deletion from the I{.Trash/} subfolder back
to its original position.
r N)
r itemsr0 r r r r ENOENTr index
ValueErrorr clear)r realtrashr rg r r r r r undeleteMessagesZ s"
z MaildirMailbox.undeleteMessagesc C s | | |}|j}| |S )a
Add a message to the mailbox.
@type txt: L{bytes} or file-like object
@param txt: A message to add.
@rtype: L{Deferred }
@return: A deferred which fires when the message has been added to
the mailbox.
)
AppendFactoryr r )r txttaskresultr r r
appendMessages s z MaildirMailbox.appendMessager] )
r, r- r. r/ r{ r r r r r r r r r r r r r s
r c @ sX e Zd ZdZdd ZdddZdedee fd d
Z d d Z
d
d Z dd Z dd Z
dS )StringListMailboxz
An in-memory mailbox.
@ivar msgs: See L{__init__}.
@type _delete: L{set} of L{int}
@ivar _delete: The indices of messages which have been marked for deletion.
c C s || _ t | _dS )zs
@type msgs: L{list} of L{bytes}
@param msgs: The contents of each message in the mailbox.
N)msgsset_delete)r r r r r r s zStringListMailbox.__init__Nc s@ |du r fddt t jD S | jv rdS t j| S )ak
Retrieve the size of a message, or, if none is specified, the size of
each message in the mailbox.
@type i: L{int} or L{None}
@param i: The 0-based index of a message.
@rtype: L{int} or L{list} of L{int}
@return: The number of octets in the specified message, or, if an index
is not specified, a list of the number of octets in each message in
the mailbox. Any value which corresponds to a deleted message is
set to 0.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
Nc s g | ]} |qS r )r )r r rS r r r s z2StringListMailbox.listMessages..r )rangerG r r r r rS r r s
z StringListMailbox.listMessagesr returnc C s t | j| S )a9
Return an in-memory file-like object with the contents of a message.
@param i: The 0-based index of a message.
@return: An in-memory file-like object containing the message.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
)r r r r r r r r s z StringListMailbox.getMessagec C s t | j| S )aP
Get a unique identifier for a message.
@type i: L{int}
@param i: The 0-based index of a message.
@rtype: L{bytes}
@return: A hash of the contents of the message at the given index.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
)r r r r r r r r s
zStringListMailbox.getUidlc C s | j | dS )z
Mark a message for deletion.
@type i: L{int}
@param i: The 0-based index of a message to delete.
@raise IndexError: When the index does not correspond to a message in
the mailbox.
N)r addr r r r r s
z StringListMailbox.deleteMessagec C s t | _dS )zL
Undelete any messages which have been marked for deletion.
N)r r rS r r r r s z"StringListMailbox.undeleteMessagesc C s" | j D ]}d| j|< qt | _ dS )zK
Discard the contents of any messages marked for deletion.
N)r r r )r r r r r sync s
zStringListMailbox.syncr] )r, r- r. r/ r r r& r bytesr r r r r r r r r r s
r c @ sB e Zd ZdZdZdZdddZdd Zdd Zd
d Z d d
Z
dS )MaildirDirdbmDomaina
A maildir-backed domain where membership is checked with a
L{DirDBM } database.
The directory structure of a MaildirDirdbmDomain is:
/passwd <-- a DirDBM directory
/USER/{cur, new, del} <-- each user has these three directories
@ivar postmaster: See L{__init__}.
@type dbm: L{DirDBM }
@ivar dbm: The authentication database for the domain.
Nr c C sR t |}t| || t j|d}t j|s t | t || _
|| _ dS )av
@type service: L{MailService}
@param service: An email service.
@type root: L{bytes}
@param root: The maildir root directory.
@type postmaster: L{bool}
@param postmaster: A flag indicating whether non-existent addresses
should be forwarded to the postmaster (C{True}) or
bounced (C{False}).
s passwdN) r0 fsencoderT r r< r? ri makedirsr r@ dbm
postmaster)r rV rU r r r r r r s
z MaildirDirdbmDomain.__init__c C s@ || j vr | js
dS d}tj| j|}tj|s t| |S )aq
Return the path to a user's mail directory.
@type name: L{bytes}
@param name: A username.
@rtype: L{bytes} or L{None}
@return: The path to the user's mail directory for a valid user. For
an invalid user, the path to the postmaster's mailbox if bounces
are redirected there. Otherwise, L{None}.
Nr )r r r0 r< r? rU ri rD )r ro rB r r r rZ s
z!MaildirDirdbmDomain.userDirectoryc C s || j |< | | dS )a
Add a user to this domain by adding an entry in the authentication
database and initializing the user's mail directory.
@type user: L{bytes}
@param user: A username.
@type password: L{bytes}
@param password: A password.
N)r rZ rw r r r ry $ s
zMaildirDirdbmDomain.addUserc C s | j du r t| jg| _ | j S )z
Return credentials checkers for this domain.
@rtype: L{list} of L{ICredentialsChecker
} provider
@return: Credentials checkers for this domain.
N)
_credcheckersDirdbmDatabaser rS r r r rz 3 s
z*MaildirDirdbmDomain.getCredentialsCheckersc G sL t j|vr td|tjkrttg}n
ttj
| j |}t j|dd fS )aw
Get the mailbox for an authenticated user.
The mailbox for the authenticated user will be returned only if the
given interfaces include L{IMailbox }. Requests for
anonymous access will be met with a mailbox containing a message
indicating that an internal error has occurred.
@type avatarId: L{bytes} or C{twisted.cred.checkers.ANONYMOUS}
@param avatarId: A string which identifies a user or an object which
signals a request for anonymous access.
@type mind: L{None}
@param mind: Unused.
@type interfaces: n-L{tuple} of C{zope.interface.Interface}
@param interfaces: A group of interfaces, one of which the avatar
must support.
@rtype: 3-L{tuple} of (0) L{IMailbox },
(1) L{IMailbox } provider, (2) no-argument
callable
@return: A tuple of the supported interface, a mailbox, and a
logout function.
@raise NotImplementedError: When the given interfaces do not include
L{IMailbox }.
z No interfacec S s d S r] r r r r r r_ c ra z3MaildirDirdbmDomain.requestAvatar..) r
IMailboxrv r ANONYMOUSr INTERNAL_ERRORr r0 r< r? rU )r avatarIdmindr
r} r r r
requestAvatar? s
z!MaildirDirdbmDomain.requestAvatar)r ) r, r- r. r/ r r r rZ ry rz r r r r r r s
r c @ s, e Zd ZdZejejfZdd Zdd Z dS )r z
A credentials checker which authenticates users out of a
L{DirDBM } database.
@type dirdbm: L{DirDBM }
@ivar dirdbm: An authentication database.
c C r )zf
@type dbm: L{DirDBM }
@param dbm: An authentication database.
Nr )r r r r r r v r zDirdbmDatabase.__init__c C s* |j | jv r|| j|j r|j S t )a
Authenticate a user and, if successful, return their username.
@type c: L{IUsernamePassword } or
L{IUsernameHashedPassword }
provider.
@param c: Credentials.
@rtype: L{bytes}
@return: A string which identifies an user.
@raise UnauthorizedLogin: When the credentials check fails.
)usernamer
checkPasswordr )r cr r r requestAvatarId} s z DirdbmDatabase.requestAvatarIdN)
r, r- r. r/ r IUsernamePasswordIUsernameHashedPasswordcredentialInterfacesr r r r r r r f s
r )3r/ r r0 r2 r hashlibr typingr zope.interfacer twisted.credr r r twisted.cred.errorr twisted.internetr r
r twisted.mailr r
r twisted.persistedr twisted.protocolsr twisted.pythonr r r r r+ rn rD rI rE IAliasableDomainrT IConsumerr{ Mailboxr r r IRealmr ICredentialsCheckerr r r r r sF
.7 5 `