o b]@sJdZddlZddlZddlmZddlmZmZmZddl m Z ddl m Z ddl mZmZdd Zd d d ZGd d d Zee GdddeZee jGdddZee GdddeZGdddeZee jGdddZGdddejZee GdddeZee jGdddZee GdddeZdS)!zD Support for aliases(5) configuration files. @author: Jp Calderone N) implementer)deferprotocolreactor)smtp)IAlias)failurelogc Cspdd|ddD}t|dkr d}||f}t||dS|\}}||gttj|ddS) a Parse a line from an aliases file. @type result: L{dict} mapping L{bytes} to L{list} of L{bytes} @param result: A dictionary mapping username to aliases to which the results of parsing the line are added. @type line: L{bytes} @param line: A line from an aliases file. @type filename: L{bytes} @param filename: The full or relative path to the aliases file. @type lineNo: L{int} @param lineNo: The position of the line within the aliases file. cSg|]}|qSstrip).0pr r 4/usr/lib/python3/dist-packages/twisted/mail/alias.py )zhandle..:z+Invalid format on line %d of alias file %s.,N) splitlenr err setdefaultr extendmapstr) resultlinefilenamelineNopartsfmtarguseraliasr r rhandles (r'c Csi}d}|durt|}d}nt|dd}d}d}z7|D],}|d7}|}|d r.q|d s8|d r=||}q|rFt|||||}qW|rP|n|rX|ww|rbt|||||D] \}} t| ||||<qf|S) a Load a file containing email aliases. Lines in the file should be formatted like so:: username: alias1, alias2, ..., aliasN Aliases beginning with a C{|} will be treated as programs, will be run, and the message will be written to their stdin. Aliases beginning with a C{:} will be treated as a file containing additional aliases for the username. Aliases beginning with a C{/} will be treated as the full pathname to a file to which the message will be appended. Aliases without a host part will be assumed to be addresses on localhost. If a username is specified multiple times, the aliases for each are joined together as if they had all been on one line. Lines beginning with a space or a tab are continuations of the previous line. Lines beginning with a C{#} are comments. @type domains: L{dict} mapping L{bytes} to L{IDomain} provider @param domains: A mapping of domain name to domain object. @type filename: L{bytes} or L{None} @param filename: The full or relative path to a file from which to load aliases. If omitted, the C{fp} parameter must be specified. @type fp: file-like object or L{None} @param fp: The file from which to load aliases. If specified, the C{filename} parameter is ignored. @rtype: L{dict} mapping L{bytes} to L{AliasGroup} @return: A mapping from username to group of aliases. FNTnamez rr#  ) opengetattrrstriplstrip startswithr'closeitems AliasGroup) domainsr fprr2iprevruar r r loadAliasFile3s>)    r;c@s*eZdZdZddZddZd ddZdS) AliasBasez The default base class for aliases. @ivar domains: See L{__init__}. @type original: L{Address} @ivar original: The original address being aliased. cCs||_t||_dS)z @type domains: L{dict} mapping L{bytes} to L{IDomain} provider @param domains: A mapping of domain name to domain object. @type original: L{bytes} @param original: The original address being aliased. N)r5rAddressoriginal)selfr5r>r r r__init__szAliasBase.__init__cCs|j|jjS)z Return the domain associated with original address. @rtype: L{IDomain} provider @return: The domain for the original address. )r5r>domainr?r r rrAzAliasBase.domainNcCs0|duri}t||vrdSd|t|<|SaY Map this alias to its ultimate destination. @type aliasmap: L{dict} mapping L{bytes} to L{AliasBase} @param aliasmap: A mapping of username to alias or group of aliases. @type memo: L{None} or L{dict} of L{AliasBase} @param memo: A record of the aliases already considered in the resolution process. If provided, C{memo} is modified to include this alias. @rtype: L{IMessage } or L{None} @return: A message receiver for the ultimate destination or None for an invalid destination. N)rcreateMessageReceiverr?aliasmapmemor r rresolves   zAliasBase.resolveN)__name__ __module__ __qualname____doc__r@rArIr r r rr<{s    r<c@s8eZdZdZddZdefddZddZd d d Zd S) AddressAliasz An alias which translates one email address into another. @type alias : L{Address} @ivar alias: The destination address. cGs"tj|g|Rt||_dS)aQ @type alias: L{Address}, L{User}, L{bytes} or object which can be converted into L{bytes} @param alias: The destination address. @type args: 2-L{tuple} of (0) L{dict} mapping L{bytes} to L{IDomain} provider, (1) L{bytes} @param args: Arguments for L{AliasBase.__init__}. N)r<r@rr=r&)r?r&argsr r rr@s zAddressAlias.__init__returncCd|jdS)z Build a string representation of this L{AddressAlias} instance. @rtype: L{bytes} @return: A string containing the destination address. z
)r&rBr r r__str__rCzAddressAlias.__str__cCs|t|jS)z Create a message receiver which delivers a message to the destination address. @rtype: L{IMessage } provider @return: A message receiver. )rAexistsrr&rBr r rrEsz"AddressAlias.createMessageReceiverNcCs|duri}t||vrdSd|t|<z|t|jddd|WStjy/Ynw|jj|vr@||jj||SdSrD) rrArUrUserr& SMTPBadRcptlocalrIrFr r rrIs  " zAddressAlias.resolverJ) rKrLrMrNr@rrTrErIr r r rrOs    rOc@>eZdZdZddZddZddZdd Zd efd d Z d S) FileWrappera A message receiver which delivers a message to a file. @type fp: file-like object @ivar fp: A file used for temporary storage of the message. @type finalname: L{bytes} @ivar finalname: The name of the file in which the message should be stored. cCst|_||_dS)z @type filename: L{bytes} @param filename: The name of the file in which the message should be stored. N)tempfile TemporaryFiler6 finalname)r?r r r rr@s  zFileWrapper.__init__cCs|j|ddS)z Write a received line to the temporary file. @type line: L{bytes} @param line: A received line of the message.  N)r6writer?rr r r lineReceivedzFileWrapper.lineReceivedcCs|jddzt|jd}WntyttYSw|| |j |j Wdn1s:wYt |jS)ac Handle end of message by writing the message to the file. @rtype: L{Deferred } which successfully results in L{bytes} @return: A deferred which succeeds with the name of the file to which the message has been stored or fails if the message cannot be saved to the file. rr:N) r6seekr-r] BaseExceptionrfailrFailurer_readr2succeed)r?fr r r eomReceiveds    zFileWrapper.eomReceivedcCs|jd|_dS)zG Close the temporary file when the connection is lost. N)r6r2rBr r rconnectionLost-s  zFileWrapper.connectionLostrQcCrR)z Build a string representation of this L{FileWrapper} instance. @rtype: L{bytes} @return: A string containing the file name of the message. z s  rmc@seZdZdZdS)ProcessAliasTimeoutzb An error indicating that a timeout occurred while waiting for a process to complete. N)rKrLrMrNr r r rrpesrpc@s`eZdZdZdZdZdZeZdddZddZ d d Z d d Z d dZ ddZ defddZdS)MessageWrapperaF A message receiver which delivers a message to a child process. @type completionTimeout: L{int} or L{float} @ivar completionTimeout: The number of seconds to wait for the child process to exit before reporting the delivery as a failure. @type _timeoutCallID: L{None} or L{IDelayedCall } provider @ivar _timeoutCallID: The call used to time out delivery, started when the connection to the child process is closed. @type done: L{bool} @ivar done: A flag indicating whether the child process has exited (C{True}) or not (C{False}). @type reactor: L{IReactorTime } provider @ivar reactor: A reactor which will be used to schedule timeouts. @ivar protocol: See L{__init__}. @type processName: L{bytes} or L{None} @ivar processName: The process name. @type completion: L{Deferred } @ivar completion: The deferred which will be triggered by the protocol when the child process exits. F<NcCsD||_||_t|_|j|j_|j|j|dur ||_dSdS)a @type protocol: L{ProcessAliasProtocol} @param protocol: The protocol associated with the child process. @type process: L{bytes} or L{None} @param process: The process name. @type reactor: L{None} or L{IReactorTime } provider @param reactor: A reactor which will be used to schedule timeouts. N) processNamerrDeferred completiononEndaddBoth _processEndedr)r?rprocessrr r rr@s    zMessageWrapper.__init__cCs(d|_|jdur|jd|_dS|S)a Record process termination and cancel the timeout call if it is active. @type result: L{Failure } @param result: The reason the child process terminated. @rtype: L{None} or L{Failure } @return: None, if the process end is expected, or the reason the child process terminated, if the process end is unexpected. TN)done_timeoutCallIDcancel)r?rr r rrxs    zMessageWrapper._processEndedcCs |jrdS|jj|ddS)z Write a received line to the child process. @type line: L{bytes} @param line: A received line of the message. Nr^)rzr transportr_r`r r rraszMessageWrapper.lineReceivedcCs,|js|jj|j|j|j|_|j S)z Disconnect from the child process and set up a timeout to wait for it to exit. @rtype: L{Deferred } @return: A deferred which will be called back when the child process exits. ) rzrr}loseConnectionr callLatercompletionTimeout_completionCancelr{rurBr r rrjs  zMessageWrapper.eomReceivedcCsDd|_|jjdtd|jd}d|j_|jt |dS)z Handle the expiration of the timeout for the child process to exit by terminating the child process forcefully and issuing a failure to the L{completion} deferred. NKILLzNo answer after z seconds) r{rr} signalProcessrprrvruerrbackrrf)r?excr r rrs z MessageWrapper._completionCancelcCsdS)z9 Ignore notification of lost connection. Nr rBr r rrkszMessageWrapper.connectionLostrQcCrR)z Build a string representation of this L{MessageWrapper} instance. @rtype: L{bytes} @return: A string containing the name of the process. z} @ivar onEnd: If set, a deferred on which to errback when the process ends. NcCs|jdur |j|dSdS)z Call an errback. @type reason: L{Failure } @param reason: The reason the child process terminated. N)rvr)r?reasonr r r processEndeds z!ProcessAliasProtocol.processEnded)rKrLrMrNrvrr r r rrs rc@s:eZdZdZeZddZdefddZddZd d Z d S) ProcessAliasa6 An alias which is handled by the execution of a program. @type path: L{list} of L{bytes} @ivar path: The arguments to pass to the process. The first string is the executable's name. @type program: L{bytes} @ivar program: The path of the program to be executed. @type reactor: L{IReactorTime } and L{IReactorProcess } provider @ivar reactor: A reactor which will be used to create and timeout the child process. cGs,tj|g|R||_|jd|_dS)aX @type path: L{bytes} @param path: The command to invoke the program consisting of the path to the executable followed by any arguments. @type args: 2-L{tuple} of (0) L{dict} mapping L{bytes} to L{IDomain} provider, (1) L{bytes} @param args: Arguments for L{AliasBase.__init__}. rN)r<r@rpathprogram)r?rrPr r rr@s zProcessAlias.__init__rQcCrR)z Build a string representation of this L{ProcessAlias} instance. @rtype: L{bytes} @return: A string containing the command used to invoke the process. z } method on L{reactor} so that it can be customized for test purposes. @type proto: L{IProcessProtocol } provider @param proto: An object which will be notified of all events related to the created process. @type program: L{bytes} @param program: The full path name of the file to execute. @type path: L{list} of L{bytes} @param path: The arguments to pass to the process. The first string should be the executable's name. @rtype: L{IProcessTransport } provider @return: A process transport. )r spawnProcess)r?protorrr r rr7szProcessAlias.spawnProcesscCs,t}t||j|j}|||j|j|S)z Launch a process and create a message receiver to pass a message to the process. @rtype: L{MessageWrapper} @return: A message receiver which delivers a message to the process. )rrqrrrr)r?rmr r rrEQsz"ProcessAlias.createMessageReceiverN) rKrLrMrNrr@rrTrrEr r r rr s rc@rY) MultiWrapperz A message receiver which delivers a single message to multiple other message receivers. @ivar objs: See L{__init__}. cCs ||_dS)z @type objs: L{list} of L{IMessage } provider @param objs: Message receivers to which the incoming message should be directed. N)objs)r?rr r rr@hs zMultiWrapper.__init__cCs|jD]}||qdS)z Pass a received line to the message receivers. @type line: L{bytes} @param line: A line of the message. N)rra)r?ror r rraps  zMultiWrapper.lineReceivedcCstdd|jDS)aG Pass the end of message along to the message receivers. @rtype: L{DeferredList } whose successful results are L{bytes} or L{None} @return: A deferred list which triggers when all of the message receivers have finished handling their end of message. cSr r )rj)rrr r rrrz,MultiWrapper.eomReceived..)r DeferredListrrBr r rrjzs zMultiWrapper.eomReceivedcCs|jD]}|qdS)zQ Inform the message receivers that the connection has been lost. N)rrk)r?rr r rrks  zMultiWrapper.connectionLostrQcCsdtt|jdS)z Build a string representation of this L{MultiWrapper} instance. @rtype: L{bytes} @return: A string containing a list of the message receivers. z.r|/z Directory delivery not supported)r<r@aliasespopr r1r-rdr rjoinrrappendprocessAliasFactoryosrisdirrmrO)r?r3rPaddrrir r rr@s,    $    zAliasGroup.__init__cCrn)z Return the number of aliases in the group. @rtype: L{int} @return: The number of aliases in the group. )rrrBr r r__len__rozAliasGroup.__len__rQcCsddtt|jS)z Build a string representation of this L{AliasGroup} instance. @rtype: L{bytes} @return: A string containing the aliases in the group. zz, )rrrrrBr r rrTszAliasGroup.__str__cCstdd|jDS)a, Create a message receiver for each alias and return a message receiver which will pass on a message to each of those. @rtype: L{MultiWrapper} @return: A message receiver which passes a message on to message receivers for each alias in the group. cSr r )rE)rr:r r rrrz4AliasGroup.createMessageReceiver..)rrrBr r rrEs z AliasGroup.createMessageReceiverNcCs<|duri}g}|jD] }||||q ttd|S)a Map each of the aliases in the group to its ultimate destination. @type aliasmap: L{dict} mapping L{bytes} to L{AliasBase} @param aliasmap: A mapping of username to alias or group of aliases. @type memo: L{None} or L{dict} of L{AliasBase} @param memo: A record of the aliases already considered in the resolution process. If provided, C{memo} is modified to include this alias. @rtype: L{MultiWrapper} @return: A message receiver which passes the message on to message receivers for the ultimate destination of each alias in the group. N)rrrIrfilter)r?rGrHrr:r r rrIs  zAliasGroup.resolverJ) rKrLrMrNrrr@rrrTrErIr r r rr4s &   r4r)rNrr[zope.interfacertwisted.internetrrr twisted.mailrtwisted.mail.interfacesrtwisted.pythonrr r'r;r<rOIMessagerZrm ExceptionrprqProcessProtocolrrrr4r r r rs8    H6FE&T6