U  W[OSã@s>dZddlmZmZddlZddlmZmZddlm Z m Z m Z ddl m Z ddlmZddlmZd d „ZGd d „d e ƒZGd d„de ƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„de ƒZGdd„deƒZGdd„deƒZGdd „d eƒZGd!d"„d"eƒZGd#d$„d$ƒZdS)%z] Resource limiting policies. @seealso: See also L{twisted.protocols.htb} for rate limiting. é)ÚdivisionÚabsolute_importN)ÚdirectlyProvidesÚ providedBy)Ú ServerFactoryÚProtocolÚ ClientFactory)Úerror)ÚILoggingContext)ÚlogcCs,t |¡r| ¡}n|jj}d||jjfS)zY Compute a log prefix for a wrapper and the object it wraps. @rtype: C{str} z%s (%s))r rÚ logPrefixÚ __class__Ú__name__)ÚwrapperÚwrappedr ©rú} provider to which L{IProtocol} method calls onto this L{ProtocolWrapper} will be proxied. @ivar factory: The L{WrappingFactory} which created this L{ProtocolWrapper}. rcCs||_||_dS©N)ÚwrappedProtocolÚfactory)ÚselfrrrrrÚ__init__5szProtocolWrapper.__init__cCs t||jƒS)zo Use a customized log prefix mentioning both the wrapped protocol and the current one. )rr©rrrrr :szProtocolWrapper.logPrefixcCs6t|t|ƒƒt ||¡|j |¡|j |¡dS)zä When a connection is made, register this wrapper with its factory, save the real transport, and connect the wrapped protocol to this L{ProtocolWrapper} to intercept any transport calls it makes. N)rrrÚmakeConnectionrÚregisterProtocolr)rÚ transportrrrrBs  zProtocolWrapper.makeConnectioncCs|j |¡dSr)rÚwrite©rÚdatarrrrPszProtocolWrapper.writecCs|j |¡dSr)rÚ writeSequencerrrrr!TszProtocolWrapper.writeSequencecCsd|_|j ¡dS©Né)Ú disconnectingrÚloseConnectionrrrrr%XszProtocolWrapper.loseConnectioncCs |j ¡Sr)rÚgetPeerrrrrr&]szProtocolWrapper.getPeercCs |j ¡Sr)rÚgetHostrrrrr'aszProtocolWrapper.getHostcCs|j ||¡dSr)rÚregisterProducer©rÚproducerZ streamingrrrr(esz ProtocolWrapper.registerProducercCs|j ¡dSr)rÚunregisterProducerrrrrr+isz"ProtocolWrapper.unregisterProducercCs|j ¡dSr)rÚ stopConsumingrrrrr,mszProtocolWrapper.stopConsumingcCs t|j|ƒSr)Úgetattrr©rÚnamerrrÚ __getattr__qszProtocolWrapper.__getattr__cCs|j |¡dSr)rÚ dataReceivedrrrrr1wszProtocolWrapper.dataReceivedcCs"|j |¡|j |¡d|_dSr)rÚunregisterProtocolrÚconnectionLost©rÚreasonrrrr3{s  zProtocolWrapper.connectionLostN)rÚ __module__Ú __qualname__Ú__doc__r$rr rrr!r%r&r'r(r+r,r0r1r3rrrrr's  rc@sdeZdZdZeZdd„Zdd„Zdd„Zdd „Z d d „Z d d „Z dd„Z dd„Z dd„Zdd„ZdS)ÚWrappingFactoryzE Wraps a factory and its protocols, and keeps track of them. cCs||_i|_dSr)ÚwrappedFactoryÚ protocols)rr:rrrrŠszWrappingFactory.__init__cCs t||jƒS)zY Generate a log prefix mentioning both the wrapped factory and this one. )rr:rrrrr szWrappingFactory.logPrefixcCs|j ¡t |¡dSr)r:ÚdoStartrrrrrr<–s zWrappingFactory.doStartcCs|j ¡t |¡dSr)r:ÚdoStoprrrrrr=›s zWrappingFactory.doStopcCs|j |¡dSr)r:ÚstartedConnecting)rÚ connectorrrrr> sz!WrappingFactory.startedConnectingcCs|j ||¡dSr)r:ÚclientConnectionFailed©rr?r5rrrr@¤sz&WrappingFactory.clientConnectionFailedcCs|j ||¡dSr)r:ÚclientConnectionLostrArrrrB¨sz$WrappingFactory.clientConnectionLostcCs| ||j |¡¡Sr)Úprotocolr:Ú buildProtocol©rÚaddrrrrrD¬szWrappingFactory.buildProtocolcCsd|j|<dS)z8 Called by protocol to register itself. r#N©r;©rÚprrrr°sz WrappingFactory.registerProtocolcCs |j|=dS)z8 Called by protocols when they go away. NrGrHrrrr2·sz"WrappingFactory.unregisterProtocolN)rr6r7r8rrCrr r<r=r>r@rBrDrr2rrrrr9ƒsr9c@sXeZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z dd„Z dd„Z dS)ÚThrottlingProtocolz, Protocol for L{ThrottlingFactory}. cCs |j t|ƒ¡t ||¡dSr)rÚregisterWrittenÚlenrrrrrrrÆszThrottlingProtocol.writecCs&|j ttt|ƒƒ¡t ||¡dSr)rrKÚsumÚmaprLrr!©rÚseqrrrr!Ësz ThrottlingProtocol.writeSequencecCs |j t|ƒ¡t ||¡dSr)rÚ registerReadrLrr1rrrrr1ÐszThrottlingProtocol.dataReceivedcCs||_t |||¡dSr)r*rr(r)rrrr(Õsz#ThrottlingProtocol.registerProducercCs|`t |¡dSr)r*rr+rrrrr+Úsz%ThrottlingProtocol.unregisterProducercCs|j ¡dSr)rÚpauseProducingrrrrÚ throttleReadsßsz ThrottlingProtocol.throttleReadscCs|j ¡dSr)rÚresumeProducingrrrrÚunthrottleReadsãsz"ThrottlingProtocol.unthrottleReadscCst|dƒr|j ¡dS©Nr*)Úhasattrr*rRrrrrÚthrottleWritesçs z!ThrottlingProtocol.throttleWritescCst|dƒr|j ¡dSrV)rWr*rTrrrrÚunthrottleWritesìs z#ThrottlingProtocol.unthrottleWritesN) rr6r7r8rr!r1r(r+rSrUrXrYrrrrrJ¿srJc@s~eZdZdZeZejddfdd„Zdd„Z dd„Z d d „Z d d „Z d d„Z dd„Zdd„Zdd„Zdd„Zdd„Zdd„ZdS)ÚThrottlingFactoryz‹ Throttles bandwidth and number of connections. Write bandwidth will only be throttled if there is a producer registered. NcCsLt ||¡d|_||_||_||_d|_d|_d|_d|_ d|_ d|_ dS)Nr) r9rÚconnectionCountÚmaxConnectionCountÚ readLimitÚ writeLimitÚreadThisSecondÚwrittenThisSecondÚunthrottleReadsIDÚcheckReadBandwidthIDÚunthrottleWritesIDÚcheckWriteBandwidthID)rr:r\r]r^rrrrüs zThrottlingFactory.__init__cCsddlm}| ||¡S©z‹ Wrapper around L{reactor.callLater} for test purpose. r)Úreactor©Útwisted.internetrfÚ callLater©rÚperiodÚfuncrfrrrri s zThrottlingFactory.callLatercCs|j|7_dS)zH Called by protocol to tell us more bytes were written. N)r`©rZlengthrrrrKsz!ThrottlingFactory.registerWrittencCs|j|7_dS)zE Called by protocol to tell us more bytes were read. N)r_rmrrrrQszThrottlingFactory.registerReadcCsR|j|jkr8| ¡t|jƒ|jd}| ||j¡|_d|_| d|j¡|_dS)z: Checks if we've passed bandwidth limits. çð?rr#N) r_r]rSÚfloatrirUraÚcheckReadBandwidthrb©rZ throttleTimerrrrp#s ÿz$ThrottlingFactory.checkReadBandwidthcCsR|j|jkr8| ¡t|jƒ|jd}| ||j¡|_d|_| d|j¡|_dS)Nrnrr#) r`r^rXrorirYrcÚcheckWriteBandwidthrdrqrrrrr0s ÿz%ThrottlingFactory.checkWriteBandwidthcCs*t d|¡|j ¡D] }| ¡qdS)z2 Throttle reads on all protocols. zThrottling reads on %sN)r Úmsgr;ÚkeysrSrHrrrrS;szThrottlingFactory.throttleReadscCs0d|_t d|¡|j ¡D] }| ¡qdS)z9 Stop throttling reads on all protocols. NzStopped throttling reads on %s)rar rsr;rtrUrHrrrrUDsz!ThrottlingFactory.unthrottleReadscCs*t d|¡|j ¡D] }| ¡qdS)z3 Throttle writes on all protocols. zThrottling writes on %sN)r rsr;rtrXrHrrrrXNsz ThrottlingFactory.throttleWritescCs0d|_t d|¡|j ¡D] }| ¡qdS)z: Stop throttling writes on all protocols. NzStopped throttling writes on %s)rcr rsr;rtrYrHrrrrYWsz"ThrottlingFactory.unthrottleWritescCsf|jdkr.|jdk r| ¡|jdk r.| ¡|j|jkrT|jd7_t ||¡St  d¡dSdS)Nrr#zMax connection count reached!) r[r]rpr^rrr\r9rDr rsrErrrrDas      zThrottlingFactory.buildProtocolcCsxt ||¡|jd8_|jdkrt|jdk r8|j ¡|jdk rL|j ¡|jdk r`|j ¡|jdk rt|j ¡dS©Nr#r)r9r2r[raÚcancelrbrcrdrHrrrr2ps         z$ThrottlingFactory.unregisterProtocol)rr6r7r8rJrCÚsysÚmaxsizerrirKrQrprrrSrUrXrYrDr2rrrrrZòs"ÿ        rZc@seZdZdd„Zdd„ZdS)ÚSpewingProtocolcCst d|¡t ||¡dS)Nz Received: %r)r rsrr1rrrrr1€szSpewingProtocol.dataReceivedcCst d|¡t ||¡dS)Nz Sending: %r)r rsrrrrrrr„szSpewingProtocol.writeN)rr6r7r1rrrrrrysryc@seZdZeZdS)ÚSpewingFactoryN)rr6r7ryrCrrrrrzŠsrzc@s(eZdZdZdd„Zdd„Zdd„ZdS) ÚLimitConnectionsByPeerécCs i|_dSr)ÚpeerConnectionsrrrrÚ startFactory“sz#LimitConnectionsByPeer.startFactorycCs>|d}|j |d¡}||jkr$dS|d|j|<t ||¡S)Nrr#)r}ÚgetÚmaxConnectionsPerPeerr9rD)rrFÚpeerHostr[rrrrD–s  z$LimitConnectionsByPeer.buildProtocolcCs8| ¡d}|j|d8<|j|dkr4|j|=dSru)r&r})rrIrrrrr2žs z)LimitConnectionsByPeer.unregisterProtocolN)rr6r7r€r~rDr2rrrrr{sr{c@s4eZdZdZdZdZdZdd„Zdd„Zdd „Z dS) ÚLimitTotalConnectionsFactoryaþ Factory that limits the number of simultaneous connections. @type connectionCount: C{int} @ivar connectionCount: number of current connections. @type connectionLimit: C{int} or L{None} @cvar connectionLimit: maximum number of connections. @type overflowProtocol: L{Protocol} or L{None} @cvar overflowProtocol: Protocol to use for new connections when connectionLimit is exceeded. If L{None} (the default value), excess connections will be closed immediately. rNcCsX|jdks|j|jkr | ¡}n|jdkr.dS| ¡}||_t||ƒ}|jd7_|Sr")ÚconnectionLimitr[rCÚoverflowProtocolrr)rrFrrCrrrrD¶s  ÿ   z*LimitTotalConnectionsFactory.buildProtocolcCsdSrrrHrrrrÇsz-LimitTotalConnectionsFactory.registerProtocolcCs|jd8_dSr")r[rHrrrr2Êsz/LimitTotalConnectionsFactory.unregisterProtocol) rr6r7r8r[rƒr„rDrr2rrrrr‚¥s r‚c@sZeZdZdZdd„Zddd„Zdd„Zd d „Zd d „Zd d„Z dd„Z dd„Z dd„Z dS)ÚTimeoutProtocolzN Protocol that automatically disconnects when the connection is idle. cCs(t |||¡d|_d|_| |¡dS)zé Constructor. @param factory: An L{TimeoutFactory}. @param wrappedProtocol: A L{Protocol} to wrapp. @param timeoutPeriod: Number of seconds to wait for activity before timing out. N)rrÚ timeoutCallÚ timeoutPeriodÚ setTimeout)rrrr‡rrrrÔs zTimeoutProtocol.__init__NcCs.| ¡||_|dk r*|j |j|j¡|_dS)zÊ Set a timeout. This will cancel any existing timeouts. @param timeoutPeriod: If not L{None}, change the timeout period. Otherwise, use the existing value. N)Ú cancelTimeoutr‡rriÚ timeoutFuncr†)rr‡rrrrˆãs zTimeoutProtocol.setTimeoutc CsBd|_|jr>z|j ¡Wntjtjfk r6YnXd|_dS)zg Cancel the timeout. If the timeout was already cancelled, this does nothing. N)r‡r†rvr Ú AlreadyCalledÚAlreadyCancelledrrrrr‰òszTimeoutProtocol.cancelTimeoutcCs|jr|j |j¡dS)zQ Reset the timeout, usually because some activity just happened. N)r†Úresetr‡rrrrÚ resetTimeoutszTimeoutProtocol.resetTimeoutcCs| ¡t ||¡dSr)rŽrrrrrrr szTimeoutProtocol.writecCs| ¡t ||¡dSr)rŽrr!rOrrrr!szTimeoutProtocol.writeSequencecCs| ¡t ||¡dSr)rŽrr1rrrrr1szTimeoutProtocol.dataReceivedcCs| ¡t ||¡dSr)r‰rr3r4rrrr3szTimeoutProtocol.connectionLostcCs | ¡dS)z³ This method is called when the timeout is triggered. By default it calls I{loseConnection}. Override this if you want something else to happen. N)r%rrrrrŠszTimeoutProtocol.timeoutFunc)N) rr6r7r8rrˆr‰rŽrr!r1r3rŠrrrrr…Ïs r…c@s.eZdZdZeZd dd„Zdd„Zdd„Zd S) ÚTimeoutFactoryz% Factory for TimeoutWrapper. écCs||_t ||¡dSr)r‡r9r)rr:r‡rrrr/szTimeoutFactory.__init__cCs|j||j |¡|jdS)N)r‡)rCr:rDr‡rErrrrD4sÿzTimeoutFactory.buildProtocolcCsddlm}| ||¡Srergrjrrrri9s zTimeoutFactory.callLaterN)r) rr6r7r8r…rCrrDrirrrrr(s  rc@sVeZdZddd„Zdd„Zdd„Zd d „Zd d „Zd d„Zdd„Z dd„Z dd„Z dS)ÚTrafficLoggingProtocolNrcCs$t |||¡||_||_||_dS)a @param factory: factory which created this protocol. @type factory: L{protocol.Factory}. @param wrappedProtocol: the underlying protocol. @type wrappedProtocol: C{protocol.Protocol}. @param logfile: file opened for writing used to write log messages. @type logfile: C{file} @param lengthLimit: maximum size of the datareceived logged. @type lengthLimit: C{int} @param number: identifier of the connection. @type number: C{int}. N)rrÚlogfileÚ lengthLimitÚ_number)rrrr’r“ZnumberrrrrFszTrafficLoggingProtocol.__init__cCs|j |d¡|j ¡dS)NÚ )r’rÚflush)rÚlinerrrÚ_logZszTrafficLoggingProtocol._logcCs.|jr*t|ƒ|jkr*|d|jd…d}|S)Né z <... elided>)r“rLrrrrÚ _mungeData_sz!TrafficLoggingProtocol._mungeDatacCs| d¡t |¡S)NÚ*)r˜rÚconnectionMaderrrrrœfs z%TrafficLoggingProtocol.connectionMadecCs&| d|j| |¡f¡t ||¡S©NzC %d: %r)r˜r”ršrr1rrrrr1ksz#TrafficLoggingProtocol.dataReceivedcCs | d|j|f¡t ||¡Sr)r˜r”rr3r4rrrr3psz%TrafficLoggingProtocol.connectionLostcCs&| d|j| |¡f¡t ||¡S)NzS %d: %r)r˜r”ršrrrrrrrvszTrafficLoggingProtocol.writecs.ˆ dˆj‡fdd„|Dƒf¡t ˆ|¡S)Nz SV %d: %rcsg|]}ˆ |¡‘qSr)rš)Ú.0ÚdrrrÚ |sz8TrafficLoggingProtocol.writeSequence..)r˜r”rr!)rZiovecrrrr!{s"z$TrafficLoggingProtocol.writeSequencecCs| d|jf¡t |¡S)NzS %d: *)r˜r”rr%rrrrr%€sz%TrafficLoggingProtocol.loseConnection)Nr) rr6r7rr˜ršrœr1r3rr!r%rrrrr‘Dsÿ r‘c@s6eZdZeZdZd dd„Zdd„Zdd„Zd d „Z dS) ÚTrafficLoggingFactoryrNcCs||_||_t ||¡dSr)Ú logfilePrefixr“r9r)rr:r¢r“rrrr‹szTrafficLoggingFactory.__init__cCs t|dƒS)NÚw)Úopenr.rrrr¤‘szTrafficLoggingFactory.opencCsF|jd7_| |jdt|jƒ¡}| ||j |¡||j|j¡S)Nr#ú-)Ú_counterr¤r¢ÚstrrCr:rDr“)rrFr’rrrrD•sÿz#TrafficLoggingFactory.buildProtocolcCs d|_dS)zN Reset the value of the counter used to identify connections. rN)r¦rrrrÚ resetCounterœsz"TrafficLoggingFactory.resetCounter)N) rr6r7r‘rCr¦rr¤rDr¨rrrrr¡†s  r¡c@s@eZdZdZdZdZdd„Zdd„Zdd„Zd d „Z d d „Z dS) Ú TimeoutMixinaL Mixin for protocols which wish to timeout connections. Protocols that mix this in have a single timeout, set using L{setTimeout}. When the timeout is hit, L{timeoutConnection} is called, which, by default, closes the connection. @cvar timeOut: The number of seconds after which to timeout the connection. NcCsddlm}| ||¡Srergrjrrrri²s zTimeoutMixin.callLatercCs&|jdk r"|jdk r"|j |j¡dS)a³ Reset the timeout count down. If the connection has already timed out, then do nothing. If the timeout has been cancelled (probably using C{setTimeout(None)}), also do nothing. It's often a good idea to call this when the protocol has received some meaningful input from the other end of the connection. "I've got some data, they're still there, reset the timeout". N)Ú_TimeoutMixin__timeoutCallÚtimeOutrrrrrrŽ¼s zTimeoutMixin.resetTimeoutc Cs||j}||_|jdk r`|dkrRz|j ¡Wntjtjfk rHYnXd|_qx|j |¡n|dk rx| ||j¡|_|S)zÈ Change the timeout period @type period: C{int} or L{None} @param period: The period, in seconds, to change the timeout to, or L{None} to disable the timeout. N) r«rªrvr rŒr‹rriÚ_TimeoutMixin__timedOut)rrkÚprevrrrrˆËs zTimeoutMixin.setTimeoutcCsd|_| ¡dSr)rªÚtimeoutConnectionrrrrZ __timedOutåszTimeoutMixin.__timedOutcCs|j ¡dS)z€ Called when the connection times out. Override to define behavior other than dropping the connection. N)rr%rrrrr®észTimeoutMixin.timeoutConnection) rr6r7r8r«rªrirŽrˆr¬r®rrrrr©¤s  r©) r8Z __future__rrrwZzope.interfacerrZtwisted.internet.protocolrrrrhr Ztwisted.internet.interfacesr Ztwisted.pythonr rrr9rJrZryrzr{r‚r…rr‘r¡r©rrrrÚs,   \<3 *YB