/
HTTPResponse.py
1066 lines (875 loc) · 36.8 KB
/
HTTPResponse.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
##############################################################################
#
# Copyright (c) 2001-2009 Zope Foundation and Contributors.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
""" CGI Response Output formatter
"""
import html
import os
import re
import struct
import sys
import time
import zlib
from io import BytesIO
from io import IOBase
from urllib.parse import quote
from urllib.parse import urlparse
from urllib.parse import urlunparse
from zExceptions import BadRequest
from zExceptions import HTTPRedirection
from zExceptions import InternalError
from zExceptions import NotFound
from zExceptions import Redirect
from zExceptions import Unauthorized
from zExceptions import status_reasons
from zExceptions.ExceptionFormatter import format_exception
from zope.event import notify
from ZPublisher import pubevents
from ZPublisher.BaseResponse import BaseResponse
from ZPublisher.Iterators import IStreamIterator
from ZPublisher.Iterators import IUnboundStreamIterator
# This may get overwritten during configuration
default_encoding = 'utf-8'
# Enable APPEND_TRACEBACKS to make Zope append tracebacks like it used to,
# but a better solution is to make standard_error_message display error_tb.
APPEND_TRACEBACKS = 0
status_codes = {}
# Add mappings for builtin exceptions and
# provide text -> error code lookups.
for key, val in status_reasons.items():
status_codes[''.join(val.split(' ')).lower()] = key
status_codes[val.lower()] = key
status_codes[key] = key
status_codes[str(key)] = key
en = [n for n in dir(__builtins__) if n[-5:] == 'Error']
for name in en:
status_codes[name.lower()] = 500
status_codes['nameerror'] = 503
status_codes['keyerror'] = 503
status_codes['redirect'] = 302
status_codes['resourcelockederror'] = 423
start_of_header_search = re.compile('(<head[^>]*>)', re.IGNORECASE).search
base_re_search = re.compile('(<base.*?>)', re.I).search
bogus_str_search = re.compile(b" [a-fA-F0-9]+>$").search
charset_re_str = (r'(?:application|text)/[-+0-9a-z]+\s*;\s*'
r'charset=([-_0-9a-z]+)(?:(?:\s*;)|\Z)')
charset_re_match = re.compile(charset_re_str, re.IGNORECASE).match
absuri_match = re.compile(r'\w+://[\w\.]+').match
tag_search = re.compile('[a-zA-Z]>').search
_gzip_header = (b"\037\213" # magic
b"\010" # compression method
b"\000" # flags
b"\000\000\000\000" # time
b"\002"
b"\377")
# these mime major types should not be gzip content encoded
uncompressableMimeMajorTypes = ('image',)
# The environment variable DONT_GZIP_MAJOR_MIME_TYPES can be set to a list
# of comma separated mime major types which should also not be compressed
otherTypes = os.environ.get('DONT_GZIP_MAJOR_MIME_TYPES', '').lower()
if otherTypes:
uncompressableMimeMajorTypes += tuple(otherTypes.split(','))
_CRLF = re.compile(r'[\r\n]')
def _scrubHeader(name, value):
return ''.join(_CRLF.split(str(name))), ''.join(_CRLF.split(str(value)))
_NOW = None # overwrite for testing
MONTHNAME = [None, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
WEEKDAYNAME = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
def _now():
if _NOW is not None:
return _NOW
return time.time()
def build_http_date(when):
year, month, day, hh, mm, ss, wd, y, z = time.gmtime(when)
return "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (
WEEKDAYNAME[wd], day, MONTHNAME[month], year, hh, mm, ss)
class HTTPBaseResponse(BaseResponse):
""" An object representation of an HTTP response.
The Response type encapsulates all possible responses to HTTP
requests. Responses are normally created by the object publisher.
A published object may receive the response object as an argument
named 'RESPONSE'. A published object may also create it's own
response object. Normally, published objects use response objects
to:
- Provide specific control over output headers,
- Set cookies, or
- Provide stream-oriented output.
If stream oriented output is used, then the response object
passed into the object must be used.
"""
body = b''
base = ''
charset = default_encoding
realm = 'Zope'
_error_format = 'text/html'
_locked_status = 0
_locked_body = 0
# Indicate if setBody should content-compress output.
# 0 - no compression
# 1 - compress if accept-encoding ok
# 2 - ignore accept-encoding (i.e. force)
use_HTTP_content_compression = 0
def __init__(self,
body=b'',
status=200,
headers=None,
stdout=None,
stderr=None):
""" Create a new response using the given values.
"""
self.accumulated_headers = []
self.cookies = {}
self.headers = {}
if headers is not None:
for key, value in headers.items():
self.setHeader(key, value)
self.setStatus(status)
if stdout is None:
stdout = BytesIO()
self.stdout = stdout
if stderr is None:
stderr = BytesIO()
self.stderr = stderr
if body:
self.setBody(body)
@property
def text(self):
return self.body.decode(self.charset)
@text.setter
def text(self, value):
self.body = value.encode(self.charset)
def redirect(self, location, status=302, lock=0):
"""Cause a redirection without raising an error"""
if isinstance(location, HTTPRedirection):
status = location.getStatus()
location = location.headers['Location']
if isinstance(location, bytes):
location = location.decode(self.charset)
# To be entirely correct, we must make sure that all non-ASCII
# characters in the path part are quoted correctly. This is required
# as we now allow non-ASCII IDs
parsed = list(urlparse(location))
# Make a hacky guess whether the path component is already
# URL-encoded by checking for %. If it is, we don't touch it.
if '%' not in parsed[2]:
# The list of "safe" characters is from RFC 2396 section 2.3
# (unreserved characters that should not be escaped) plus
# section 3.3 (reserved characters in path components)
parsed[2] = quote(parsed[2], safe="/@!*'~();,=+$")
location = urlunparse(parsed)
self.setStatus(status, lock=lock)
self.setHeader('Location', location)
return location
def retry(self):
""" Return a cloned response object to be used in a retry attempt.
"""
# This implementation is a bit lame, because it assumes that
# only stdout stderr were passed to the constructor. OTOH, I
# think that that's all that is ever passed.
return self.__class__(stdout=self.stdout, stderr=self.stderr)
def setStatus(self, status, reason=None, lock=None):
""" Set the HTTP status code of the response
o The argument may either be an integer or a string from the
'status_reasons' dict values: status messages will be converted
to the correct integer value.
"""
if self._locked_status:
# Don't change the response status.
# It has already been determined.
return
if isinstance(status, type) and issubclass(status, Exception):
status = status.__name__
if isinstance(status, str):
status = status.lower()
if status in status_codes:
status = status_codes[status]
else:
status = 500
self.status = status
if reason is None:
if status in status_reasons:
reason = status_reasons[status]
else:
reason = 'Unknown'
self.errmsg = reason
# lock the status if we're told to
if lock:
self._locked_status = 1
def setCookie(self, name, value, quoted=True, **kw):
""" Set an HTTP cookie.
The response will include an HTTP header that sets a cookie on
cookie-enabled browsers with a key "name" and value
"value".
This value overwrites any previously set value for the
cookie in the Response object.
`name` has to be text in Python 3.
`value` may be text or bytes. The default encoding of respective python
version is used.
"""
cookies = self.cookies
if name in cookies:
cookie = cookies[name]
else:
cookie = cookies[name] = {}
for k, v in kw.items():
cookie[k] = v
cookie['value'] = value
cookie['quoted'] = quoted
def appendCookie(self, name, value):
""" Set an HTTP cookie.
Returns an HTTP header that sets a cookie on cookie-enabled
browsers with a key "name" and value "value". If a value for the
cookie has previously been set in the response object, the new
value is appended to the old one separated by a colon.
`name` has to be text in Python 3.
`value` may be text or bytes. The default encoding of respective python
version is used.
"""
cookies = self.cookies
if name in cookies:
cookie = cookies[name]
else:
cookie = cookies[name] = {}
if 'value' in cookie:
cookie['value'] = '%s:%s' % (cookie['value'], value)
else:
cookie['value'] = value
def expireCookie(self, name, **kw):
""" Clear an HTTP cookie.
The response will include an HTTP header that will remove the cookie
corresponding to "name" on the client, if one exists. This is
accomplished by sending a new cookie with an expiration date
that has already passed. Note that some clients require a path
to be specified - this path must exactly match the path given
when creating the cookie. The path can be specified as a keyword
argument.
`name` has to be text in Python 3.
"""
d = kw.copy()
if 'value' in d:
d.pop('value')
d['max_age'] = 0
d['expires'] = 'Wed, 31 Dec 1997 23:59:59 GMT'
self.setCookie(name, value='deleted', **d)
def getHeader(self, name, literal=0):
""" Get a previously set header value.
Return the value associated with a HTTP return header, or
None if no such header has been set in the response
yet.
If the 'literal' flag is true, preserve the case of the header name;
otherwise lower-case the header name before looking up the value.
"""
key = literal and name or name.lower()
return self.headers.get(key, None)
def setHeader(self, name, value, literal=0, scrubbed=False):
""" Set an HTTP return header on the response.
Replay any existing value set for the header.
If the 'literal' flag is true, preserve the case of the header name;
otherwise the header name will be lowercased.
'scrubbed' is for internal use, to indicate that another API has
already removed any CRLF from the name and value.
"""
if not scrubbed:
name, value = _scrubHeader(name, value)
key = name.lower()
if key == 'content-type':
if 'charset' in value:
# Update self.charset with the charset from the header
match = charset_re_match(value)
if match:
self.charset = match.group(1)
else:
# Update the header value with self.charset
if value.startswith('text/'):
value = value + '; charset=' + self.charset
name = literal and name or key
self.headers[name] = value
def appendHeader(self, name, value, delimiter=", "):
""" Append a value to an HTTP return header.
Set an HTTP return header "name" with value "value",
appending it following a comma if there was a previous value
set for the header.
'name' is always lowercased before use.
"""
name, value = _scrubHeader(name, value)
name = name.lower()
headers = self.headers
if name in headers:
h = headers[name]
h = "%s%s%s" % (h, delimiter, value)
else:
h = value
self.setHeader(name, h, scrubbed=True)
def addHeader(self, name, value):
""" Set a new HTTP return header with the given value,
Retain any previously set headers with the same name.
Note that this API appends to the 'accumulated_headers' attribute;
it does not update the 'headers' mapping.
"""
name, value = _scrubHeader(name, value)
self.accumulated_headers.append((name, value))
__setitem__ = setHeader
def setBase(self, base):
"""Set the base URL for the returned document.
If base is None, set to the empty string.
If base is not None, ensure that it has a trailing slash.
"""
if base is None:
base = ''
elif not base.endswith('/'):
base = base + '/'
self.base = str(base)
def insertBase(self):
# Only insert a base tag if content appears to be HTML.
content_type = self.headers.get('content-type', '').split(';')[0]
if content_type and (content_type != 'text/html'):
return
if self.base and self.body:
text = self.text
match = start_of_header_search(text)
if match is not None:
index = match.start(0) + len(match.group(0))
ibase = base_re_search(text)
if ibase is None:
text = (text[:index] + '\n<base href="'
+ html.escape(self.base, True) + '" />\n'
+ text[index:])
self.text = text
self.setHeader('content-length', len(self.body))
def isHTML(self, text):
if isinstance(text, bytes):
try:
text = text.decode(self.charset)
except UnicodeDecodeError:
return False
text = text.lstrip()
# Note that the string can be big, so text.lower().startswith()
# is more expensive than s[:n].lower().
if text[:6].lower() == '<html>' or \
text[:14].lower() == '<!doctype html':
return True
if text.find('</') > 0:
return True
return False
def setBody(self, body, title='', is_error=False, lock=None):
""" Set the body of the response
Sets the return body equal to the (string) argument "body". Also
updates the "content-length" return header.
If the body is already locked via a previous call, do nothing and
return None.
You can also specify a title, in which case the title and body
will be wrapped up in html, head, title, and body tags.
If the body is a 2-element tuple, then it will be treated
as (title,body)
If body is unicode, encode it.
If body is not a string or unicode, but has an 'asHTML' method, use
the result of that method as the body; otherwise, use the 'str'
of body.
If is_error is true, format the HTML as a Zope error message instead
of a generic HTML page.
Return 'self' (XXX as a true value?).
"""
# allow locking of the body in the same way as the status
if self._locked_body:
return
elif lock:
self._locked_body = 1
if not body:
return self
if isinstance(body, tuple) and len(body) == 2:
title, body = body
if hasattr(body, 'asHTML'):
body = body.asHTML()
if isinstance(body, str):
body = self._encode_unicode(body)
elif isinstance(body, bytes):
pass
else:
try:
body = bytes(body)
except (TypeError, UnicodeError):
body = self._encode_unicode(str(body))
# At this point body is always binary
b_len = len(body)
if b_len < 200 and \
body[:1] == b'<' and \
body.find(b'>') == b_len - 1 and \
bogus_str_search(body) is not None:
self.notFoundError(body[1:-1].decode(self.charset))
else:
if title:
title = str(title)
if not is_error:
self.body = body = self._html(
title, body.decode(self.charset)).encode(self.charset)
else:
self.body = body = self._error_html(
title, body.decode(self.charset)).encode(self.charset)
else:
self.body = body
content_type = self.headers.get('content-type')
if content_type is None:
if self.isHTML(body):
content_type = 'text/html; charset=%s' % self.charset
else:
content_type = 'text/plain; charset=%s' % self.charset
self.setHeader('content-type', content_type)
else:
if content_type.startswith('text/') and \
'charset=' not in content_type:
content_type = '%s; charset=%s' % (content_type,
self.charset)
self.setHeader('content-type', content_type)
self.setHeader('content-length', len(self.body))
self.insertBase()
if self.use_HTTP_content_compression and \
self.headers.get('content-encoding', 'gzip') == 'gzip':
# use HTTP content encoding to compress body contents unless
# this response already has another type of content encoding
if content_type.split('/')[0] not in uncompressableMimeMajorTypes:
# only compress if not listed as uncompressable
body = self.body
startlen = len(body)
co = zlib.compressobj(6, zlib.DEFLATED, -zlib.MAX_WBITS,
zlib.DEF_MEM_LEVEL, 0)
chunks = [_gzip_header, co.compress(body),
co.flush(),
struct.pack("<LL",
zlib.crc32(body) & 0xffffffff,
startlen)]
z = b''.join(chunks)
newlen = len(z)
if newlen < startlen:
self.body = z
self.setHeader('content-length', newlen)
self.setHeader('content-encoding', 'gzip')
if self.use_HTTP_content_compression == 1:
# use_HTTP_content_compression == 1 if force was
# NOT used in enableHTTPCompression().
# If we forced it, then Accept-Encoding
# was ignored anyway, so cache should not
# vary on it. Otherwise if not forced, cache should
# respect Accept-Encoding client header
vary = self.getHeader('Vary')
if vary is None or 'Accept-Encoding' not in vary:
self.appendHeader('Vary', 'Accept-Encoding')
return self
def enableHTTPCompression(self, REQUEST={}, force=0, disable=0, query=0):
"""Enable HTTP Content Encoding with gzip compression if possible
REQUEST -- used to check if client can accept compression
force -- set true to ignore REQUEST headers
disable -- set true to disable compression
query -- just return if compression has been previously requested
returns -- 1 if compression will be attempted, 2 if compression
is forced, 0 if no compression
The HTTP specification allows for transfer encoding and content
encoding. Unfortunately many web browsers still do not support
transfer encoding, but they all seem to support content encoding.
This function is designed to be called on each request to specify
on a request-by-request basis that the response content should
be compressed.
The REQUEST headers are used to determine if the client accepts
gzip content encoding. The force parameter can force the use
of gzip encoding regardless of REQUEST, and the disable parameter
can be used to "turn off" previously enabled encoding (but note
that any existing content-encoding header will not be changed).
The query parameter can be used to determine the if compression
has been previously requested.
In setBody, the major mime type is used to determine if content
encoding should actually be performed.
By default, image types are not compressed.
Additional major mime types can be specified by setting the
environment variable DONT_GZIP_MAJOR_MIME_TYPES to a comma-seperated
list of major mime types that should also not be gzip compressed.
"""
if query:
return self.use_HTTP_content_compression
elif disable:
# in the future, a gzip cache manager will need to ensure that
# compression is off
self.use_HTTP_content_compression = 0
elif force or 'gzip' in REQUEST.get('HTTP_ACCEPT_ENCODING', ''):
if force:
self.use_HTTP_content_compression = 2
else:
self.use_HTTP_content_compression = 1
return self.use_HTTP_content_compression
def _encode_unicode(self, text):
# Fixes the encoding in the XML preamble according
# to the charset specified in the content-type header.
if text.startswith('<?xml'):
pos_right = text.find('?>') # right end of the XML preamble
text = ('<?xml version="1.0" encoding="' + self.charset
+ '" ?>' + text[pos_right + 2:])
# Encode the text data using the response charset
text = text.encode(self.charset, 'replace')
return text
def _cookie_list(self):
cookie_list = []
for name, attrs in self.cookies.items():
# Note that as of May 98, IE4 ignores cookies with
# quoted cookie attr values, so only the value part
# of name=value pairs may be quoted.
if attrs.get('quoted', True):
cookie = '%s="%s"' % (name, quote(attrs['value']))
else:
cookie = '%s=%s' % (name, quote(attrs['value']))
for name, v in attrs.items():
name = name.lower()
if name == 'expires':
cookie = '%s; Expires=%s' % (cookie, v)
elif name == 'domain':
cookie = '%s; Domain=%s' % (cookie, v)
elif name == 'path':
cookie = '%s; Path=%s' % (cookie, v)
elif name == 'max_age':
cookie = '%s; Max-Age=%s' % (cookie, v)
elif name == 'comment':
cookie = '%s; Comment=%s' % (cookie, v)
elif name == 'secure' and v:
cookie = '%s; Secure' % cookie
# Some browsers recognize this cookie attribute
# and block read/write access via JavaScript
elif name == 'http_only' and v:
cookie = '%s; HTTPOnly' % cookie
# Some browsers recognize the SameSite cookie attribute
# and do not send the cookie along with cross-site requests
# providing some protection against CSRF attacks
# https://tools.ietf.org/html/draft-west-first-party-cookies-07
elif name == 'same_site' and v:
cookie = '%s; SameSite=%s' % (cookie, v)
cookie_list.append(('Set-Cookie', cookie))
# Should really check size of cookies here!
return cookie_list
def listHeaders(self):
""" Return a list of (key, value) pairs for our headers.
o Do appropriate case normalization.
"""
result = [
('X-Powered-By', 'Zope (www.zope.org), Python (www.python.org)')
]
for key, value in self.headers.items():
if key.lower() == key:
# only change non-literal header names
key = '-'.join([x.capitalize() for x in key.split('-')])
result.append((key, value))
result.extend(self._cookie_list())
result.extend(self.accumulated_headers)
return result
def _unauthorized(self):
realm = self.realm
if realm:
self.setHeader('WWW-Authenticate', 'basic realm="%s"' % realm, 1)
@staticmethod
def _html(title, body):
return ("<html>\n"
"<head>\n<title>%s</title>\n</head>\n"
"<body>\n%s\n</body>\n"
"</html>\n" % (title, body))
class HTTPResponse(HTTPBaseResponse):
_wrote = None
def __bytes__(self):
if self._wrote:
return b'' # Streaming output was used.
status, headers = self.finalize()
body = self.body
chunks = []
# status header must come first.
chunks.append(b"Status: " + status.encode('ascii'))
for key, value in headers:
chunks.append(key.encode('ascii') + b': ' + value.encode('ascii'))
# RFC 2616 mandates empty line between headers and payload
chunks.append(b'')
chunks.append(body)
return b'\r\n'.join(chunks)
# deprecated
def quoteHTML(self, text):
return html.escape(text, 1)
def _traceback(self, t, v, tb, as_html=1):
tb = format_exception(t, v, tb, as_html=as_html)
return '\n'.join(tb)
def _error_html(self, title, body):
return ("""<!DOCTYPE html><html>
<head><title>Site Error</title><meta charset="utf-8" /></head>
<body bgcolor="#FFFFFF">
<h2>Site Error</h2>
<p>An error was encountered while publishing this resource.
</p>
<p><strong>""" + title + """</strong></p>
""" + body + """
<hr noshade="noshade"/>
<p>Troubleshooting Suggestions</p>
<ul>
<li>The URL may be incorrect.</li>
<li>The parameters passed to this resource may be incorrect.</li>
<li>A resource that this resource relies on may be
encountering an error.</li>
</ul>
<p>If the error persists please contact the site maintainer.
Thank you for your patience.
</p></body></html>""")
def notFoundError(self, entry='Unknown'):
self.setStatus(404)
raise NotFound(self._error_html(
"Resource not found",
("Sorry, the requested resource does not exist."
"<p>Check the URL and try again.</p>"
"<p><b>Resource:</b> " + html.escape(entry) + "</p>")))
# If a resource is forbidden, why reveal that it exists?
forbiddenError = notFoundError
def debugError(self, entry):
raise NotFound(self._error_html(
"Debugging Notice",
(
"Zope has encountered a problem publishing your object. "
"<p>%r</p>" % entry
)
))
def badRequestError(self, name):
self.setStatus(400)
if re.match('^[A-Z_0-9]+$', name):
raise InternalError(self._error_html(
"Internal Error",
"Sorry, an internal error occurred in this resource."))
raise BadRequest(self._error_html(
"Invalid request",
("The parameter, <em>" + name + "</em>, "
"was omitted from the request.<p>"
"Make sure to specify all required parameters, "
"and try the request again.</p>")))
def unauthorized(self):
m = "You are not authorized to access this resource."
if self.debug_mode:
if self._auth:
m = m + '\nUsername and password are not correct.'
else:
m = m + '\nNo Authorization header found.'
raise Unauthorized(m)
def exception(self, fatal=0, info=None, abort=1):
if isinstance(info, tuple) and len(info) == 3:
t, v, tb = info
else:
t, v, tb = sys.exc_info()
if issubclass(t, Unauthorized):
self._unauthorized()
self.setStatus(t)
if 300 <= self.status < 400:
if isinstance(v, str) and absuri_match(v) is not None:
if self.status == 300:
self.setStatus(302)
self.setHeader('location', v)
tb = None # just one path covered
return self
elif isinstance(v, Redirect):
if self.status == 300:
self.setStatus(302)
self.setHeader('location', v.args[0])
self.setBody(b'')
tb = None
return self
else:
try:
l, b = v
if isinstance(l, str) and absuri_match(l) is not None:
if self.status == 300:
self.setStatus(302)
self.setHeader('location', l)
self.setBody(b)
tb = None # one more patch covered
return self
except Exception:
pass # tb is not cleared in this case
b = v
if isinstance(b, Exception):
try:
try:
b = str(b)
except UnicodeDecodeError:
b = self._encode_unicode(str(b)).decode(self.charset)
except Exception:
b = '<unprintable %s object>' % type(b).__name__
if fatal and t is SystemExit and v.code == 0:
body = self.setBody(
(str(t),
'Zope has exited normally.<p>'
+ self._traceback(t, v, tb) + '</p>'),
is_error=True)
else:
try:
match = tag_search(b)
except TypeError:
match = None
if match is None:
body = self.setBody(
(str(t),
'Sorry, a site error occurred.<p>'
+ self._traceback(t, v, tb) + '</p>'),
is_error=True)
elif self.isHTML(b):
# error is an HTML document, not just a snippet of html
if APPEND_TRACEBACKS:
body = self.setBody(b + self._traceback(
t, '(see above)', tb), is_error=True)
else:
body = self.setBody(b, is_error=True)
else:
body = self.setBody(
(str(t),
b + self._traceback(t, '(see above)', tb, 0)),
is_error=True)
del tb
return body
def finalize(self):
""" Set headers required by various parts of protocol.
"""
body = self.body
if 'content-length' not in self.headers and \
'transfer-encoding' not in self.headers:
self.setHeader('content-length', len(body))
return "%d %s" % (self.status, self.errmsg), self.listHeaders()
def write(self, data):
"""
Return data as a stream
HTML data may be returned using a stream-oriented interface.
This allows the browser to display partial results while
computation of a response to proceed.
The published object should first set any output headers or
cookies on the response object.
Note that published objects must not generate any errors
after beginning stream-oriented output.
"""
if not self._wrote:
notify(pubevents.PubBeforeStreaming(self))
self.outputBody()
self._wrote = 1
self.stdout.flush()
self.stdout.write(data)
class WSGIResponse(HTTPBaseResponse):
"""A response object for WSGI
"""
_streaming = 0
_http_version = None
_server_version = None
# Append any "cleanup" functions to this list.
after_list = ()
def notFoundError(self, entry='Unknown'):
self.setStatus(404)
exc = NotFound(entry)
exc.title = 'Resource not found'
exc.detail = (
'Sorry, the requested resource does not exist.'
'<p>Check the URL and try again.</p>'
'<p><b>Resource:</b> %s</p>' % html.escape(entry, True))
raise exc
# If a resource is forbidden, why reveal that it exists?
forbiddenError = notFoundError
def debugError(self, entry):
self.setStatus(404)
exc = NotFound(entry)
exc.title = 'Debugging Notice'
exc.detail = (
'Zope has encountered a problem publishing your object.<p>'
'\n%s</p>' % entry)
raise exc
def badRequestError(self, name):
if re.match('^[A-Z_0-9]+$', name):
self.setStatus(500)
exc = InternalError(name)
exc.title = 'Internal Error'
exc.detail = 'Sorry, an internal error occurred in this resource.'
raise exc
self.setStatus(400)
exc = BadRequest(name)
exc.title = 'Invalid request'
exc.detail = (
'The parameter, <em>%s</em>, '
'was omitted from the request.<p>'
'Make sure to specify all required parameters, '
'and try the request again.</p>' % name)
raise exc
def unauthorized(self):
message = 'You are not authorized to access this resource.'
exc = Unauthorized(message)
exc.title = message
if self.debug_mode:
if self._auth:
exc.detail = 'Username and password are not correct.'
else:
exc.detail = 'No Authorization header found.'
raise exc
def exception(self, fatal=0, info=None, abort=1):
if isinstance(info, tuple) and len(info) == 3:
t, v, tb = info
else:
t, v, tb = sys.exc_info()
if issubclass(t, Unauthorized):
self._unauthorized()
raise v.with_traceback(tb)
def finalize(self):
# Set 204 (no content) status if 200 and response is empty
# and not streaming.
if 'content-type' not in self.headers and \