tf<dZddlmZddgZddlmZddlmZmZm Z ddl m Z m Z ddl mZdd lmZmZdd lmZdd lmZmZdd lmZdd lmZddlmZddlmZddlm Z ddl!m"Z"ddl#m$Z$m%Z%m&Z&ddDZ'dZ(de'DZ)e(*dZ+e eGddZ,GddZ-GddZ.Gddej/Z0dS)z2 Helpers related to HTTP requests, used by tests. ) annotations DummyChannel DummyRequest)BytesIO)DictListOptional) implementerverify)Version) IPv4Address IPv6Address)Deferred)IAddress ISSLTransport)Clock) deprecated)unittest)FOUND)Headers)Resource) NOT_DONE_YETSessionSitecg|]}d|d S)Foobar).0lws ]/var/www/surfInsights/venv3-11/lib/python3.11/site-packages/twisted/web/test/requesthelper.py r"s !O!O!OB----!O!O!O)  z zFoo barc8g|]}|dS)ascii)encode)r components r!r"r"!s3###"+IW###r#r'ceZdZdZdS) NullAddressz/ A null implementation of L{IAddress}. N)__name__ __module__ __qualname____doc__rr#r!r+r+'sr#r+ceZdZGddZeeGddeZeeZ ddZ dZ dZ d Z d Zd Zd Zd ZdZdZdZdZdZdZdZdZdZdZdZdS)rcHeZdZdZdZd dZdZdZdZdZ d Z d Z d Z dS) DummyChannel.TCPPFNcn|tddd}||_t|_g|_dS)NTCPz 192.168.1.1i80)r _peerrwritten producersselfpeers r!__init__zDummyChannel.TCP.__init__3s5|"5-??DJ"99DLDNNNr#c|jSN)r6r:s r!getPeerzDummyChannel.TCP.getPeer:s : r#ct|tstd||j|dS)Nz)Can only write bytes to a transport, not ) isinstancebytes TypeErrorr7writer:datas r!rEzDummyChannel.TCP.write=sHdE** V TD T TUUU L  t $ $ $ $ $r#c:|D]}||dSr>)rE)r:iovecrGs r! writeSequencezDummyChannel.TCP.writeSequenceBs0 ! ! 4     ! !r#c.tdd|jS)Nr5z10.0.0.1)r portr?s r!getHostzDummyChannel.TCP.getHostFsuj$)<< |j||fdSr>)r8appendr:producer streamings r!registerProducerz!DummyChannel.TCP.registerProducerIs# N ! !8Y"7 8 8 8 8 8r#cdSr>rr?s r!unregisterProducerz#DummyChannel.TCP.unregisterProducerLs Dr#cd|_dS)NT) disconnectedr?s r!loseConnectionzDummyChannel.TCP.loseConnectionOs $D   r#r>) r,r-r.rLrWr<r@rErJrMrSrUrXrr#r!r5r2/s         % % %  ! ! ! = = = 9 9 9    % % % % %r#r5c8eZdZdZdZdZdZdZdZdZ dS) DummyChannel.SSLcdSr>rr?s r!abortConnectionz DummyChannel.SSL.abortConnectionT Dr#cdSr>rr?s r!getTcpKeepAlivez DummyChannel.SSL.getTcpKeepAliveXr]r#cdSr>rr?s r! getTcpNoDelayzDummyChannel.SSL.getTcpNoDelay\r]r#cdSr>rr?s r!loseWriteConnectionz$DummyChannel.SSL.loseWriteConnection`r]r#cdSr>rr:enableds r!setTcpKeepAlivez DummyChannel.SSL.setTcpKeepAlivedr]r#cdSr>rres r! setTcpNoDelayzDummyChannel.SSL.setTcpNoDelayhr]r#cdSr>rr?s r!getPeerCertificatez#DummyChannel.SSL.getPeerCertificatelr]r#N) r,r-r.r\r_rarcrgrirkrr#r!SSLrZRs}                       r#rlNc:|||_dSr>)r5 transportr9s r!r<zDummyChannel.__init__rs$r#cdSr>r)r:requests r! requestDonezDummyChannel.requestDoneu r#c0t|trd|D}|dz|zdz|zdz}|g}|d|D|d|j|dS)Nc&g|]\}}|D]}||fSrr)rkvaluesvs r!r"z-DummyChannel.writeHeaders..zsA&AvfIJAr#  c32K|]\}}|dz|zdzVdS)s: ryNr)rnamevalues r! z,DummyChannel.writeHeaders..s4XXudUlU2W<XXXXXXr#)rBrgetAllRawHeadersextendrOrnrJ)r:versioncodereasonheaders response_lineheaderSequences r! writeHeaderszDummyChannel.writeHeadersxs gw ' ' *1*B*B*D*DG $-4v=G 'XXPWXXXXXXg&&& $$^44444r#c4|jSr>)rnr@r?s r!r@zDummyChannel.getPeer~%%'''r#c4|jSr>)rnrMr?s r!rMzDummyChannel.getHostrr#c<|j||dSr>)rnrSrPs r!rSzDummyChannel.registerProducers  '')<<<<)rnrUr?s r!rUzDummyChannel.unregisterProducers ))+++++r#c:|j|dSr>)rnrErFs r!rEzDummyChannel.writes T"""""r#c:|j|dSr>)rnrJ)r:rIs r!rJzDummyChannel.writeSequences $$U+++++r#c8|jdSr>)rnrXr?s r!rXzDummyChannel.loseConnections %%'''''r#cdSr>rr?s r! endRequestzDummyChannel.endRequestrrr#c6t|j|jSr>)rBrnrlr?s r!isSecurezDummyChannel.isSecures$.$(333r#cdSr>rr?s r!r\zDummyChannel.abortConnection r#cdSr>rr?s r!r_zDummyChannel.getTcpKeepAliverr#cdSr>rr?s r!razDummyChannel.getTcpNoDelayrr#cdSr>rr?s r!rcz DummyChannel.loseWriteConnectionrr#cdSr>rr?s r!rgzDummyChannel.setTcpKeepAliverr#cdSr>rr?s r!rizDummyChannel.setTcpNoDelayrr#cdSr>rr?s r!rkzDummyChannel.getPeerCertificaterr#r>)r,r-r.r5r rrlrrsiter<rqrr@rMrSrUrErJrXrrr\r_rarcrgrirkrr#r!rr.s!%!%!%!%!%!%!%!%F[c : 4  D((((    5 5 5((((((===,,,###,,,(((   444                       r#c.eZdZUdZdZdZdZded<ded<ded <ded <d ed <d ed<dZdZ d2d3dZ dZ dZ dZ d4dZdZdZd5dZd Zd!Zd"Zd4d#Zd$Zd%Zeed&d'd(d)d*+d,Zd-Zd.Zd/Zd6d0Zd1ZdS)7ra Represents a dummy or fake request. See L{twisted.web.server.Request}. @ivar _finishedDeferreds: L{None} or a C{list} of L{Deferreds} which will be called back with L{None} when C{finish} is called or which will be errbacked if C{processingFailed} is called. @type requestheaders: C{Headers} @ivar requestheaders: A Headers instance that stores values for all request headers. @type responseHeaders: C{Headers} @ivar responseHeaders: A Headers instance that stores values for all response headers. @type responseCode: C{int} @ivar responseCode: The response code which was passed to C{setResponseCode}. @type written: C{list} of C{bytes} @ivar written: The bytes which have been written to the request. s http://dummy/sGETNOptional[IAddress]clientz List[bytes]sitepathr7prepathzDict[bytes, List[bytes]]argszList[Deferred[None]]_finishedDeferredsc\d|_|jr||jdSdS)z Call an L{IPullProducer}'s C{resumeProducing} method in a loop until it unregisters itself. @param prod: The producer. @type prod: L{IPullProducer} @param s: Whether or not the producer is streaming. N)goresumeProducing)r:prodss r!rSzDummyRequest.registerProducersGg #  " " "g # # # # #r#cd|_dS)Nr)rr?s r!rUzDummyRequest.unregisterProducers r#postpath list[bytes]sessionOptional[Session]returnNonec6g|_g|_d|_||_g|_d|_|pt ddt|_i|_ t|_ t|_ d|_ g|_d|_d|_dS)Nr0)ruidreactorsdummysHTTP/1.0)rr7finishedrrrrr protoSessionrrrequestHeadersresponseHeaders responseCoder _serverName clientproto)r:rrrs r!r<zDummyRequest.__init__s        #TwDdEGG'T'T'T %ii&yy "$#&r#ci}|jD]"\}}|d||<#|S)ah Return dictionary mapping the names of all received headers to the last value received for each. Since this method does not return all header information, C{self.requestHeaders.getAllRawHeaders()} may be preferred. NOTE: This function is a direct copy of C{twisted.web.http.Request.getAllRawHeaders}. )rr~lower)r:rrurws r! getAllHeaderszDummyRequest.getAllHeaderssI'88:: ' 'DAq!"2GAGGII  r#cj|j|dgdS)aH Retrieve the value of a request header. @type name: C{bytes} @param name: The name of the request header for which to retrieve the value. Header names are compared case-insensitively. @rtype: C{bytes} or L{None} @return: The value of the specified request header. Nr)r getRawHeadersr)r:r{s r! getHeaderzDummyRequest.getHeaders,"00vFFqIIr#c<|j||dS)zATODO: make this assert on write() if the header is content-lengthN)r addRawHeaderr:r{r|s r! setHeaderzDummyRequest.setHeader s! ))$66666r#cf|jr|jS|jr Jd|j|_|jS)Nz8Session cannot be requested after data has been written.)rr7r)r:sessionInterfaces r! getSessionzDummyRequest.getSession$sN < <   F F E F F F( |r#c||}|turdS|||dS)a Render the given resource as a response to this request. This implementation only handles a few of the most common behaviors of resources. It can handle a render method that returns a string or C{NOT_DONE_YET}. It doesn't know anything about the semantics of request methods (eg HEAD) nor how to set any particular headers. Basically, it's largely broken, but sufficient for some tests at least. It should B{not} be expanded to do all the same stuff L{Request} does. Instead, L{DummyRequest} should be phased out and L{Request} (or some other real code factored in a different way) used. N)renderrrEfinish)r:resourceresults r!rzDummyRequest.render-sH&& \ ! ! F 6 r#ct|tstd|j|dS)Nzwrite() only accepts bytes)rBrCrDr7rOrFs r!rEzDummyRequest.write@s?$&& :899 9 D!!!!!r#Deferred[None]cVt}|j||S)z Return a L{Deferred} which is called back with L{None} when the request is finished. This will probably only work if you haven't called C{finish} yet. )rrrO)r:rs r! notifyFinishzDummyRequest.notifyFinishEs) $,:: &&x000r#c|jdz|_|j(|j}d|_|D]}|ddSdS)z} Record that the request is finished and callback and L{Deferred}s waiting for notification of this. rN)rrcallback)r: observersobss r!rzDummyRequest.finishOsa  )  " ./I&*D #  # # T"""" / . # #r#ch|j(|j}d|_|D]}||dSdS)zK Errback and L{Deferreds} waiting for finish notification. N)rerrback)r:rrrs r!processingFailedzDummyRequest.processingFailed[sS  " ./I&*D #  $ $ F#### / . $ $r#c|g|j|<dSr>)rrs r!addArgzDummyRequest.addArges ' $r#c|jr5Jdd|j||_||_dS)z{ Set the HTTP status response code, but takes care that this is called before any data is written. z;Response code cannot be set after data hasbeen written: {}.@@@@N)r7formatjoinrresponseMessage)r:rmessages r!setResponseCodezDummyRequest.setResponseCodehs^    K R R KK % %     !&r#c~|jr5Jdd|jdS)Nz > $;# #tr#c:|jtS|jS)z Return the L{IAddress} of the client that made this request. @return: an address. @rtype: an L{IAddress} provider. )rr+r?s r!rzDummyRequest.getClientAddresss ; == {r#c|jS)z Get a dummy hostname associated to the HTTP request. @rtype: C{bytes} @returns: a dummy hostname )rr?s r!getRequestHostnamezDummyRequest.getRequestHostnames r#c$tdddS)zz Get a dummy transport's host. @rtype: C{IPv4Address} @returns: a dummy transport's host r5 127.0.0.1r3)r r?s r!rMzDummyRequest.getHosts5+r222r#c||_|rd}nd}||kr|}nd||fz}|jd|dS)a_ Change the host and port the request thinks it's using. @type host: C{bytes} @param host: The value to which to change the host header. @type ssl: C{bool} @param ssl: A flag which, if C{True}, indicates that the request is considered secure (if C{True}, L{isSecure} will return C{True}). ir3s%b:%dshostN) _forceSSLrrr)r:rrLssldefault hostHeaders r!setHostzDummyRequest.setHostsd ==?? GGG 7??JJ!T4L0J ((*=====r#cf|t|d|dS)zu Utility function that does a redirect. The request should have finish() called after this. slocationN)rrr)r:urls r!redirectzDummyRequest.redirects2 U### {C(((((r#)NN)rrrrrrrrr>)rr)r) r,r-r.r/urimethodr__annotations__rSrUr<rrrrrrErrrrrrrrr rrrrMrrrr#r!rrs. C F!%F%%%%"""",,,, # # # &*%) '''''* J J J777&"""  # # #$$$""" ' ' ' '      Z 2q!,,:LMMMNM      333>>>>,)))))r#c*eZdZdZdZdZdZdZdS)DummyRequestTestsz$ Tests for L{DummyRequest}. ctg}|||jg}|dt ||\}||dt||dddS)zp L{DummyRequest.getClientIP} is deprecated in favor of L{DummyRequest.getClientAddress} )offendingFunctionsrcategoryrz}twisted.web.test.requesthelper.DummyRequest.getClientIP was deprecated in Twisted 18.4.0; please use getClientAddress insteadN)rr flushWarningstest_getClientIPDeprecated assertEquallengetDeprecationWarning)r:rpwarningswarnings r!rz,DummyRequestTests.test_getClientIPDeprecateds r""%% $ ?@&   CMM***  Z002DEEE  KK " "6     r#ctg}tddd}||_|d|dS)z L{DummyRequest.getClientIP} supports IPv6 addresses, just like L{twisted.web.http.Request.getClientIP}. r5z::190N)rrrr r)r:rprs r!test_getClientIPSupportsIPv6z.DummyRequestTests.test_getClientIPSupportsIPv6sQ r""UE511  3 3 5 566666r#ctg}|}tjt|dS)zu L{DummyRequest.getClientAddress} returns an L{IAddress} provider no C{client} has been set. N)rrr verifyObjectr)r:rpnulls r!"test_getClientAddressWithoutClientz4DummyRequestTests.test_getClientAddressWithoutClients; r""''))Hd+++++r#ctg}tddd}||_|}|||dS)zI L{DummyRequest.getClientAddress} returns the C{client}. r5rrN)rr rrassertIs)r:rpraddresss r!test_getClientAddressz'DummyRequestTests.test_getClientAddresssTr""UK77**,, gv&&&&&r#N)r,r-r.r/rrrrrr#r!rrsZ   2 7 7 7,,,'''''r#rN)1r/ __future__r__all__iortypingrrr zope.interfacer r incrementalr twisted.internet.addressr rtwisted.internet.deferrtwisted.internet.interfacesrrtwisted.internet.taskrtwisted.python.deprecater twisted.trialrtwisted.web._responsesrtwisted.web.http_headersrtwisted.web.resourcertwisted.web.serverrrrtextLinearWhitespaceComponents sanitizedTextbytesLinearWhitespaceComponentsr(sanitizedBytesr+rrSynchronousTestCaserrr#r!r/sy#""""" > *''''''''''........========++++++????????''''''//////""""""((((((,,,,,,))))))::::::::::!O!O:N!O!O!O ##/M###%%g.. X J J J J J J J J ZL)L)L)L)L)L)L)L)^:':':':':'4:':':':':'r#