wsgi.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983
  1. import errno
  2. import os
  3. import sys
  4. import time
  5. import traceback
  6. import types
  7. import warnings
  8. import eventlet
  9. from eventlet import greenio
  10. from eventlet import support
  11. from eventlet.green import BaseHTTPServer
  12. from eventlet.green import socket
  13. import six
  14. from six.moves import urllib
  15. DEFAULT_MAX_SIMULTANEOUS_REQUESTS = 1024
  16. DEFAULT_MAX_HTTP_VERSION = 'HTTP/1.1'
  17. MAX_REQUEST_LINE = 8192
  18. MAX_HEADER_LINE = 8192
  19. MAX_TOTAL_HEADER_SIZE = 65536
  20. MINIMUM_CHUNK_SIZE = 4096
  21. # %(client_port)s is also available
  22. DEFAULT_LOG_FORMAT = ('%(client_ip)s - - [%(date_time)s] "%(request_line)s"'
  23. ' %(status_code)s %(body_length)s %(wall_seconds).6f')
  24. RESPONSE_414 = b'''HTTP/1.0 414 Request URI Too Long\r\n\
  25. Connection: close\r\n\
  26. Content-Length: 0\r\n\r\n'''
  27. is_accepting = True
  28. STATE_IDLE = 'idle'
  29. STATE_REQUEST = 'request'
  30. STATE_CLOSE = 'close'
  31. __all__ = ['server', 'format_date_time']
  32. # Weekday and month names for HTTP date/time formatting; always English!
  33. _weekdayname = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]
  34. _monthname = [None, # Dummy so we can use 1-based month numbers
  35. "Jan", "Feb", "Mar", "Apr", "May", "Jun",
  36. "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
  37. def format_date_time(timestamp):
  38. """Formats a unix timestamp into an HTTP standard string."""
  39. year, month, day, hh, mm, ss, wd, _y, _z = time.gmtime(timestamp)
  40. return "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (
  41. _weekdayname[wd], day, _monthname[month], year, hh, mm, ss
  42. )
  43. def addr_to_host_port(addr):
  44. host = 'unix'
  45. port = ''
  46. if isinstance(addr, tuple):
  47. host = addr[0]
  48. port = addr[1]
  49. return (host, port)
  50. def encode_dance(s):
  51. if not isinstance(s, bytes):
  52. s = s.encode('utf-8', 'replace')
  53. if six.PY2:
  54. return s
  55. return s.decode('latin1')
  56. # Collections of error codes to compare against. Not all attributes are set
  57. # on errno module on all platforms, so some are literals :(
  58. BAD_SOCK = set((errno.EBADF, 10053))
  59. BROKEN_SOCK = set((errno.EPIPE, errno.ECONNRESET))
  60. class ChunkReadError(ValueError):
  61. pass
  62. # special flag return value for apps
  63. class _AlreadyHandled(object):
  64. def __iter__(self):
  65. return self
  66. def next(self):
  67. raise StopIteration
  68. __next__ = next
  69. ALREADY_HANDLED = _AlreadyHandled()
  70. class Input(object):
  71. def __init__(self,
  72. rfile,
  73. content_length,
  74. sock,
  75. wfile=None,
  76. wfile_line=None,
  77. chunked_input=False):
  78. self.rfile = rfile
  79. self._sock = sock
  80. if content_length is not None:
  81. content_length = int(content_length)
  82. self.content_length = content_length
  83. self.wfile = wfile
  84. self.wfile_line = wfile_line
  85. self.position = 0
  86. self.chunked_input = chunked_input
  87. self.chunk_length = -1
  88. # (optional) headers to send with a "100 Continue" response. Set by
  89. # calling set_hundred_continue_respose_headers() on env['wsgi.input']
  90. self.hundred_continue_headers = None
  91. self.is_hundred_continue_response_sent = False
  92. def send_hundred_continue_response(self):
  93. towrite = []
  94. # 100 Continue status line
  95. towrite.append(self.wfile_line)
  96. # Optional headers
  97. if self.hundred_continue_headers is not None:
  98. # 100 Continue headers
  99. for header in self.hundred_continue_headers:
  100. towrite.append(six.b('%s: %s\r\n' % header))
  101. # Blank line
  102. towrite.append(b'\r\n')
  103. self.wfile.writelines(towrite)
  104. self.wfile.flush()
  105. # Reinitialize chunk_length (expect more data)
  106. self.chunk_length = -1
  107. def _do_read(self, reader, length=None):
  108. if self.wfile is not None and not self.is_hundred_continue_response_sent:
  109. # 100 Continue response
  110. self.send_hundred_continue_response()
  111. self.is_hundred_continue_response_sent = True
  112. if (self.content_length is not None) and (
  113. length is None or length > self.content_length - self.position):
  114. length = self.content_length - self.position
  115. if not length:
  116. return b''
  117. try:
  118. read = reader(length)
  119. except greenio.SSL.ZeroReturnError:
  120. read = b''
  121. self.position += len(read)
  122. return read
  123. def _chunked_read(self, rfile, length=None, use_readline=False):
  124. if self.wfile is not None and not self.is_hundred_continue_response_sent:
  125. # 100 Continue response
  126. self.send_hundred_continue_response()
  127. self.is_hundred_continue_response_sent = True
  128. try:
  129. if length == 0:
  130. return ""
  131. if length and length < 0:
  132. length = None
  133. if use_readline:
  134. reader = self.rfile.readline
  135. else:
  136. reader = self.rfile.read
  137. response = []
  138. while self.chunk_length != 0:
  139. maxreadlen = self.chunk_length - self.position
  140. if length is not None and length < maxreadlen:
  141. maxreadlen = length
  142. if maxreadlen > 0:
  143. data = reader(maxreadlen)
  144. if not data:
  145. self.chunk_length = 0
  146. raise IOError("unexpected end of file while parsing chunked data")
  147. datalen = len(data)
  148. response.append(data)
  149. self.position += datalen
  150. if self.chunk_length == self.position:
  151. rfile.readline()
  152. if length is not None:
  153. length -= datalen
  154. if length == 0:
  155. break
  156. if use_readline and data[-1] == "\n":
  157. break
  158. else:
  159. try:
  160. self.chunk_length = int(rfile.readline().split(b";", 1)[0], 16)
  161. except ValueError as err:
  162. raise ChunkReadError(err)
  163. self.position = 0
  164. if self.chunk_length == 0:
  165. rfile.readline()
  166. except greenio.SSL.ZeroReturnError:
  167. pass
  168. return b''.join(response)
  169. def read(self, length=None):
  170. if self.chunked_input:
  171. return self._chunked_read(self.rfile, length)
  172. return self._do_read(self.rfile.read, length)
  173. def readline(self, size=None):
  174. if self.chunked_input:
  175. return self._chunked_read(self.rfile, size, True)
  176. else:
  177. return self._do_read(self.rfile.readline, size)
  178. def readlines(self, hint=None):
  179. return self._do_read(self.rfile.readlines, hint)
  180. def __iter__(self):
  181. return iter(self.read, b'')
  182. def get_socket(self):
  183. return self._sock
  184. def set_hundred_continue_response_headers(self, headers,
  185. capitalize_response_headers=True):
  186. # Response headers capitalization (default)
  187. # CONTent-TYpe: TExt/PlaiN -> Content-Type: TExt/PlaiN
  188. # Per HTTP RFC standard, header name is case-insensitive.
  189. # Please, fix your client to ignore header case if possible.
  190. if capitalize_response_headers:
  191. headers = [
  192. ('-'.join([x.capitalize() for x in key.split('-')]), value)
  193. for key, value in headers]
  194. self.hundred_continue_headers = headers
  195. def discard(self, buffer_size=16 << 10):
  196. while self.read(buffer_size):
  197. pass
  198. class HeaderLineTooLong(Exception):
  199. pass
  200. class HeadersTooLarge(Exception):
  201. pass
  202. def get_logger(log, debug):
  203. if callable(getattr(log, 'info', None)) \
  204. and callable(getattr(log, 'debug', None)):
  205. return log
  206. else:
  207. return LoggerFileWrapper(log or sys.stderr, debug)
  208. class LoggerNull(object):
  209. def __init__(self):
  210. pass
  211. def error(self, msg, *args, **kwargs):
  212. pass
  213. def info(self, msg, *args, **kwargs):
  214. pass
  215. def debug(self, msg, *args, **kwargs):
  216. pass
  217. def write(self, msg, *args):
  218. pass
  219. class LoggerFileWrapper(LoggerNull):
  220. def __init__(self, log, debug):
  221. self.log = log
  222. self._debug = debug
  223. def error(self, msg, *args, **kwargs):
  224. self.write(msg, *args)
  225. def info(self, msg, *args, **kwargs):
  226. self.write(msg, *args)
  227. def debug(self, msg, *args, **kwargs):
  228. if self._debug:
  229. self.write(msg, *args)
  230. def write(self, msg, *args):
  231. msg = msg + '\n'
  232. if args:
  233. msg = msg % args
  234. self.log.write(msg)
  235. class FileObjectForHeaders(object):
  236. def __init__(self, fp):
  237. self.fp = fp
  238. self.total_header_size = 0
  239. def readline(self, size=-1):
  240. sz = size
  241. if size < 0:
  242. sz = MAX_HEADER_LINE
  243. rv = self.fp.readline(sz)
  244. if len(rv) >= MAX_HEADER_LINE:
  245. raise HeaderLineTooLong()
  246. self.total_header_size += len(rv)
  247. if self.total_header_size > MAX_TOTAL_HEADER_SIZE:
  248. raise HeadersTooLarge()
  249. return rv
  250. class HttpProtocol(BaseHTTPServer.BaseHTTPRequestHandler):
  251. protocol_version = 'HTTP/1.1'
  252. minimum_chunk_size = MINIMUM_CHUNK_SIZE
  253. capitalize_response_headers = True
  254. # https://github.com/eventlet/eventlet/issues/295
  255. # Stdlib default is 0 (unbuffered), but then `wfile.writelines()` looses data
  256. # so before going back to unbuffered, remove any usage of `writelines`.
  257. wbufsize = 16 << 10
  258. def __init__(self, conn_state, server):
  259. self.request = conn_state[1]
  260. self.client_address = conn_state[0]
  261. self.conn_state = conn_state
  262. self.server = server
  263. self.setup()
  264. try:
  265. self.handle()
  266. finally:
  267. self.finish()
  268. def setup(self):
  269. # overriding SocketServer.setup to correctly handle SSL.Connection objects
  270. conn = self.connection = self.request
  271. # TCP_QUICKACK is a better alternative to disabling Nagle's algorithm
  272. # https://news.ycombinator.com/item?id=10607422
  273. if getattr(socket, 'TCP_QUICKACK', None):
  274. try:
  275. conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_QUICKACK, True)
  276. except socket.error:
  277. pass
  278. try:
  279. self.rfile = conn.makefile('rb', self.rbufsize)
  280. self.wfile = conn.makefile('wb', self.wbufsize)
  281. except (AttributeError, NotImplementedError):
  282. if hasattr(conn, 'send') and hasattr(conn, 'recv'):
  283. # it's an SSL.Connection
  284. self.rfile = socket._fileobject(conn, "rb", self.rbufsize)
  285. self.wfile = socket._fileobject(conn, "wb", self.wbufsize)
  286. else:
  287. # it's a SSLObject, or a martian
  288. raise NotImplementedError(
  289. '''eventlet.wsgi doesn't support sockets of type {0}'''.format(type(conn)))
  290. def handle(self):
  291. self.close_connection = True
  292. while True:
  293. self.handle_one_request()
  294. if self.conn_state[2] == STATE_CLOSE:
  295. self.close_connection = 1
  296. if self.close_connection:
  297. break
  298. def _read_request_line(self):
  299. if self.rfile.closed:
  300. self.close_connection = 1
  301. return ''
  302. try:
  303. return self.rfile.readline(self.server.url_length_limit)
  304. except greenio.SSL.ZeroReturnError:
  305. pass
  306. except socket.error as e:
  307. last_errno = support.get_errno(e)
  308. if last_errno in BROKEN_SOCK:
  309. self.server.log.debug('({0}) connection reset by peer {1!r}'.format(
  310. self.server.pid,
  311. self.client_address))
  312. elif last_errno not in BAD_SOCK:
  313. raise
  314. return ''
  315. def handle_one_request(self):
  316. if self.server.max_http_version:
  317. self.protocol_version = self.server.max_http_version
  318. self.raw_requestline = self._read_request_line()
  319. if not self.raw_requestline:
  320. self.close_connection = 1
  321. return
  322. if len(self.raw_requestline) >= self.server.url_length_limit:
  323. self.wfile.write(RESPONSE_414)
  324. self.close_connection = 1
  325. return
  326. orig_rfile = self.rfile
  327. try:
  328. self.rfile = FileObjectForHeaders(self.rfile)
  329. if not self.parse_request():
  330. return
  331. except HeaderLineTooLong:
  332. self.wfile.write(
  333. b"HTTP/1.0 400 Header Line Too Long\r\n"
  334. b"Connection: close\r\nContent-length: 0\r\n\r\n")
  335. self.close_connection = 1
  336. return
  337. except HeadersTooLarge:
  338. self.wfile.write(
  339. b"HTTP/1.0 400 Headers Too Large\r\n"
  340. b"Connection: close\r\nContent-length: 0\r\n\r\n")
  341. self.close_connection = 1
  342. return
  343. finally:
  344. self.rfile = orig_rfile
  345. content_length = self.headers.get('content-length')
  346. if content_length is not None:
  347. try:
  348. int(content_length)
  349. except ValueError:
  350. self.wfile.write(
  351. b"HTTP/1.0 400 Bad Request\r\n"
  352. b"Connection: close\r\nContent-length: 0\r\n\r\n")
  353. self.close_connection = 1
  354. return
  355. self.environ = self.get_environ()
  356. self.application = self.server.app
  357. try:
  358. self.server.outstanding_requests += 1
  359. try:
  360. self.handle_one_response()
  361. except socket.error as e:
  362. # Broken pipe, connection reset by peer
  363. if support.get_errno(e) not in BROKEN_SOCK:
  364. raise
  365. finally:
  366. self.server.outstanding_requests -= 1
  367. def handle_one_response(self):
  368. start = time.time()
  369. headers_set = []
  370. headers_sent = []
  371. wfile = self.wfile
  372. result = None
  373. use_chunked = [False]
  374. length = [0]
  375. status_code = [200]
  376. def write(data):
  377. towrite = []
  378. if not headers_set:
  379. raise AssertionError("write() before start_response()")
  380. elif not headers_sent:
  381. status, response_headers = headers_set
  382. headers_sent.append(1)
  383. header_list = [header[0].lower() for header in response_headers]
  384. towrite.append(six.b('%s %s\r\n' % (self.protocol_version, status)))
  385. for header in response_headers:
  386. towrite.append(six.b('%s: %s\r\n' % header))
  387. # send Date header?
  388. if 'date' not in header_list:
  389. towrite.append(six.b('Date: %s\r\n' % (format_date_time(time.time()),)))
  390. client_conn = self.headers.get('Connection', '').lower()
  391. send_keep_alive = False
  392. if self.close_connection == 0 and \
  393. self.server.keepalive and (client_conn == 'keep-alive' or
  394. (self.request_version == 'HTTP/1.1' and
  395. not client_conn == 'close')):
  396. # only send keep-alives back to clients that sent them,
  397. # it's redundant for 1.1 connections
  398. send_keep_alive = (client_conn == 'keep-alive')
  399. self.close_connection = 0
  400. else:
  401. self.close_connection = 1
  402. if 'content-length' not in header_list:
  403. if self.request_version == 'HTTP/1.1':
  404. use_chunked[0] = True
  405. towrite.append(b'Transfer-Encoding: chunked\r\n')
  406. elif 'content-length' not in header_list:
  407. # client is 1.0 and therefore must read to EOF
  408. self.close_connection = 1
  409. if self.close_connection:
  410. towrite.append(b'Connection: close\r\n')
  411. elif send_keep_alive:
  412. towrite.append(b'Connection: keep-alive\r\n')
  413. towrite.append(b'\r\n')
  414. # end of header writing
  415. if use_chunked[0]:
  416. # Write the chunked encoding
  417. towrite.append(six.b("%x" % (len(data),)) + b"\r\n" + data + b"\r\n")
  418. else:
  419. towrite.append(data)
  420. wfile.writelines(towrite)
  421. wfile.flush()
  422. length[0] = length[0] + sum(map(len, towrite))
  423. def start_response(status, response_headers, exc_info=None):
  424. status_code[0] = status.split()[0]
  425. if exc_info:
  426. try:
  427. if headers_sent:
  428. # Re-raise original exception if headers sent
  429. six.reraise(exc_info[0], exc_info[1], exc_info[2])
  430. finally:
  431. # Avoid dangling circular ref
  432. exc_info = None
  433. # Response headers capitalization
  434. # CONTent-TYpe: TExt/PlaiN -> Content-Type: TExt/PlaiN
  435. # Per HTTP RFC standard, header name is case-insensitive.
  436. # Please, fix your client to ignore header case if possible.
  437. if self.capitalize_response_headers:
  438. response_headers = [
  439. ('-'.join([x.capitalize() for x in key.split('-')]), value)
  440. for key, value in response_headers]
  441. headers_set[:] = [status, response_headers]
  442. return write
  443. try:
  444. try:
  445. result = self.application(self.environ, start_response)
  446. if (isinstance(result, _AlreadyHandled)
  447. or isinstance(getattr(result, '_obj', None), _AlreadyHandled)):
  448. self.close_connection = 1
  449. return
  450. # Set content-length if possible
  451. if not headers_sent and hasattr(result, '__len__') and \
  452. 'Content-Length' not in [h for h, _v in headers_set[1]]:
  453. headers_set[1].append(('Content-Length', str(sum(map(len, result)))))
  454. towrite = []
  455. towrite_size = 0
  456. just_written_size = 0
  457. minimum_write_chunk_size = int(self.environ.get(
  458. 'eventlet.minimum_write_chunk_size', self.minimum_chunk_size))
  459. for data in result:
  460. if len(data) == 0:
  461. continue
  462. if isinstance(data, six.text_type):
  463. data = data.encode('ascii')
  464. towrite.append(data)
  465. towrite_size += len(data)
  466. if towrite_size >= minimum_write_chunk_size:
  467. write(b''.join(towrite))
  468. towrite = []
  469. just_written_size = towrite_size
  470. towrite_size = 0
  471. if towrite:
  472. just_written_size = towrite_size
  473. write(b''.join(towrite))
  474. if not headers_sent or (use_chunked[0] and just_written_size):
  475. write(b'')
  476. except Exception:
  477. self.close_connection = 1
  478. tb = traceback.format_exc()
  479. self.server.log.info(tb)
  480. if not headers_sent:
  481. err_body = six.b(tb) if self.server.debug else b''
  482. start_response("500 Internal Server Error",
  483. [('Content-type', 'text/plain'),
  484. ('Content-length', len(err_body))])
  485. write(err_body)
  486. finally:
  487. if hasattr(result, 'close'):
  488. result.close()
  489. request_input = self.environ['eventlet.input']
  490. if (request_input.chunked_input or
  491. request_input.position < (request_input.content_length or 0)):
  492. # Read and discard body if there was no pending 100-continue
  493. if not request_input.wfile and self.close_connection == 0:
  494. try:
  495. request_input.discard()
  496. except ChunkReadError as e:
  497. self.close_connection = 1
  498. self.server.log.error((
  499. 'chunked encoding error while discarding request body.'
  500. + ' client={0} request="{1}" error="{2}"').format(
  501. self.get_client_address()[0], self.requestline, e,
  502. ))
  503. finish = time.time()
  504. for hook, args, kwargs in self.environ['eventlet.posthooks']:
  505. hook(self.environ, *args, **kwargs)
  506. if self.server.log_output:
  507. client_host, client_port = self.get_client_address()
  508. self.server.log.info(self.server.log_format % {
  509. 'client_ip': client_host,
  510. 'client_port': client_port,
  511. 'date_time': self.log_date_time_string(),
  512. 'request_line': self.requestline,
  513. 'status_code': status_code[0],
  514. 'body_length': length[0],
  515. 'wall_seconds': finish - start,
  516. })
  517. def get_client_address(self):
  518. host, port = addr_to_host_port(self.client_address)
  519. if self.server.log_x_forwarded_for:
  520. forward = self.headers.get('X-Forwarded-For', '').replace(' ', '')
  521. if forward:
  522. host = forward + ',' + host
  523. return (host, port)
  524. def get_environ(self):
  525. env = self.server.get_environ()
  526. env['REQUEST_METHOD'] = self.command
  527. env['SCRIPT_NAME'] = ''
  528. pq = self.path.split('?', 1)
  529. env['RAW_PATH_INFO'] = pq[0]
  530. env['PATH_INFO'] = encode_dance(urllib.parse.unquote(pq[0]))
  531. if len(pq) > 1:
  532. env['QUERY_STRING'] = pq[1]
  533. ct = self.headers.get('content-type')
  534. if ct is None:
  535. try:
  536. ct = self.headers.type
  537. except AttributeError:
  538. ct = self.headers.get_content_type()
  539. env['CONTENT_TYPE'] = ct
  540. length = self.headers.get('content-length')
  541. if length:
  542. env['CONTENT_LENGTH'] = length
  543. env['SERVER_PROTOCOL'] = 'HTTP/1.0'
  544. sockname = self.request.getsockname()
  545. server_addr = addr_to_host_port(sockname)
  546. env['SERVER_NAME'] = server_addr[0]
  547. env['SERVER_PORT'] = str(server_addr[1])
  548. client_addr = addr_to_host_port(self.client_address)
  549. env['REMOTE_ADDR'] = client_addr[0]
  550. env['REMOTE_PORT'] = str(client_addr[1])
  551. env['GATEWAY_INTERFACE'] = 'CGI/1.1'
  552. try:
  553. headers = self.headers.headers
  554. except AttributeError:
  555. headers = self.headers._headers
  556. else:
  557. headers = [h.split(':', 1) for h in headers]
  558. env['headers_raw'] = headers_raw = tuple((k, v.strip(' \t\n\r')) for k, v in headers)
  559. for k, v in headers_raw:
  560. k = k.replace('-', '_').upper()
  561. if k in ('CONTENT_TYPE', 'CONTENT_LENGTH'):
  562. # These do not get the HTTP_ prefix and were handled above
  563. continue
  564. envk = 'HTTP_' + k
  565. if envk in env:
  566. env[envk] += ',' + v
  567. else:
  568. env[envk] = v
  569. if env.get('HTTP_EXPECT') == '100-continue':
  570. wfile = self.wfile
  571. wfile_line = b'HTTP/1.1 100 Continue\r\n'
  572. else:
  573. wfile = None
  574. wfile_line = None
  575. chunked = env.get('HTTP_TRANSFER_ENCODING', '').lower() == 'chunked'
  576. env['wsgi.input'] = env['eventlet.input'] = Input(
  577. self.rfile, length, self.connection, wfile=wfile, wfile_line=wfile_line,
  578. chunked_input=chunked)
  579. env['eventlet.posthooks'] = []
  580. return env
  581. def finish(self):
  582. try:
  583. BaseHTTPServer.BaseHTTPRequestHandler.finish(self)
  584. except socket.error as e:
  585. # Broken pipe, connection reset by peer
  586. if support.get_errno(e) not in BROKEN_SOCK:
  587. raise
  588. greenio.shutdown_safe(self.connection)
  589. self.connection.close()
  590. def handle_expect_100(self):
  591. return True
  592. class Server(BaseHTTPServer.HTTPServer):
  593. def __init__(self,
  594. socket,
  595. address,
  596. app,
  597. log=None,
  598. environ=None,
  599. max_http_version=None,
  600. protocol=HttpProtocol,
  601. minimum_chunk_size=None,
  602. log_x_forwarded_for=True,
  603. keepalive=True,
  604. log_output=True,
  605. log_format=DEFAULT_LOG_FORMAT,
  606. url_length_limit=MAX_REQUEST_LINE,
  607. debug=True,
  608. socket_timeout=None,
  609. capitalize_response_headers=True):
  610. self.outstanding_requests = 0
  611. self.socket = socket
  612. self.address = address
  613. self.log = LoggerNull()
  614. if log_output:
  615. self.log = get_logger(log, debug)
  616. self.app = app
  617. self.keepalive = keepalive
  618. self.environ = environ
  619. self.max_http_version = max_http_version
  620. self.protocol = protocol
  621. self.pid = os.getpid()
  622. self.minimum_chunk_size = minimum_chunk_size
  623. self.log_x_forwarded_for = log_x_forwarded_for
  624. self.log_output = log_output
  625. self.log_format = log_format
  626. self.url_length_limit = url_length_limit
  627. self.debug = debug
  628. self.socket_timeout = socket_timeout
  629. self.capitalize_response_headers = capitalize_response_headers
  630. if not self.capitalize_response_headers:
  631. warnings.warn("""capitalize_response_headers is disabled.
  632. Please, make sure you know what you are doing.
  633. HTTP headers names are case-insensitive per RFC standard.
  634. Most likely, you need to fix HTTP parsing in your client software.""",
  635. DeprecationWarning, stacklevel=3)
  636. def get_environ(self):
  637. d = {
  638. 'wsgi.errors': sys.stderr,
  639. 'wsgi.version': (1, 0),
  640. 'wsgi.multithread': True,
  641. 'wsgi.multiprocess': False,
  642. 'wsgi.run_once': False,
  643. 'wsgi.url_scheme': 'http',
  644. }
  645. # detect secure socket
  646. if hasattr(self.socket, 'do_handshake'):
  647. d['wsgi.url_scheme'] = 'https'
  648. d['HTTPS'] = 'on'
  649. if self.environ is not None:
  650. d.update(self.environ)
  651. return d
  652. def process_request(self, conn_state):
  653. # The actual request handling takes place in __init__, so we need to
  654. # set minimum_chunk_size before __init__ executes and we don't want to modify
  655. # class variable
  656. proto = new(self.protocol)
  657. if self.minimum_chunk_size is not None:
  658. proto.minimum_chunk_size = self.minimum_chunk_size
  659. proto.capitalize_response_headers = self.capitalize_response_headers
  660. try:
  661. proto.__init__(conn_state, self)
  662. except socket.timeout:
  663. # Expected exceptions are not exceptional
  664. conn_state[1].close()
  665. # similar to logging "accepted" in server()
  666. self.log.debug('({0}) timed out {1!r}'.format(self.pid, conn_state[0]))
  667. def log_message(self, message):
  668. raise AttributeError('''\
  669. eventlet.wsgi.server.log_message was deprecated and deleted.
  670. Please use server.log.info instead.''')
  671. try:
  672. new = types.InstanceType
  673. except AttributeError:
  674. new = lambda cls: cls.__new__(cls)
  675. try:
  676. import ssl
  677. ACCEPT_EXCEPTIONS = (socket.error, ssl.SSLError)
  678. ACCEPT_ERRNO = set((errno.EPIPE, errno.EBADF, errno.ECONNRESET,
  679. ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_SSL))
  680. except ImportError:
  681. ACCEPT_EXCEPTIONS = (socket.error,)
  682. ACCEPT_ERRNO = set((errno.EPIPE, errno.EBADF, errno.ECONNRESET))
  683. def socket_repr(sock):
  684. scheme = 'http'
  685. if hasattr(sock, 'do_handshake'):
  686. scheme = 'https'
  687. name = sock.getsockname()
  688. if sock.family == socket.AF_INET:
  689. hier_part = '//{0}:{1}'.format(*name)
  690. elif sock.family == socket.AF_INET6:
  691. hier_part = '//[{0}]:{1}'.format(*name[:2])
  692. elif sock.family == socket.AF_UNIX:
  693. hier_part = name
  694. else:
  695. hier_part = repr(name)
  696. return scheme + ':' + hier_part
  697. def server(sock, site,
  698. log=None,
  699. environ=None,
  700. max_size=None,
  701. max_http_version=DEFAULT_MAX_HTTP_VERSION,
  702. protocol=HttpProtocol,
  703. server_event=None,
  704. minimum_chunk_size=None,
  705. log_x_forwarded_for=True,
  706. custom_pool=None,
  707. keepalive=True,
  708. log_output=True,
  709. log_format=DEFAULT_LOG_FORMAT,
  710. url_length_limit=MAX_REQUEST_LINE,
  711. debug=True,
  712. socket_timeout=None,
  713. capitalize_response_headers=True):
  714. """Start up a WSGI server handling requests from the supplied server
  715. socket. This function loops forever. The *sock* object will be
  716. closed after server exits, but the underlying file descriptor will
  717. remain open, so if you have a dup() of *sock*, it will remain usable.
  718. .. warning::
  719. At the moment :func:`server` will always wait for active connections to finish before
  720. exiting, even if there's an exception raised inside it
  721. (*all* exceptions are handled the same way, including :class:`greenlet.GreenletExit`
  722. and those inheriting from `BaseException`).
  723. While this may not be an issue normally, when it comes to long running HTTP connections
  724. (like :mod:`eventlet.websocket`) it will become problematic and calling
  725. :meth:`~eventlet.greenthread.GreenThread.wait` on a thread that runs the server may hang,
  726. even after using :meth:`~eventlet.greenthread.GreenThread.kill`, as long
  727. as there are active connections.
  728. :param sock: Server socket, must be already bound to a port and listening.
  729. :param site: WSGI application function.
  730. :param log: logging.Logger instance or file-like object that logs should be written to.
  731. If a Logger instance is supplied, messages are sent to the INFO log level.
  732. If not specified, sys.stderr is used.
  733. :param environ: Additional parameters that go into the environ dictionary of every request.
  734. :param max_size: Maximum number of client connections opened at any time by this server.
  735. Default is 1024.
  736. :param max_http_version: Set to "HTTP/1.0" to make the server pretend it only supports HTTP 1.0.
  737. This can help with applications or clients that don't behave properly using HTTP 1.1.
  738. :param protocol: Protocol class. Deprecated.
  739. :param server_event: Used to collect the Server object. Deprecated.
  740. :param minimum_chunk_size: Minimum size in bytes for http chunks. This can be used to improve
  741. performance of applications which yield many small strings, though
  742. using it technically violates the WSGI spec. This can be overridden
  743. on a per request basis by setting environ['eventlet.minimum_write_chunk_size'].
  744. :param log_x_forwarded_for: If True (the default), logs the contents of the x-forwarded-for
  745. header in addition to the actual client ip address in the 'client_ip' field of the
  746. log line.
  747. :param custom_pool: A custom GreenPool instance which is used to spawn client green threads.
  748. If this is supplied, max_size is ignored.
  749. :param keepalive: If set to False, disables keepalives on the server; all connections will be
  750. closed after serving one request.
  751. :param log_output: A Boolean indicating if the server will log data or not.
  752. :param log_format: A python format string that is used as the template to generate log lines.
  753. The following values can be formatted into it: client_ip, date_time, request_line,
  754. status_code, body_length, wall_seconds. The default is a good example of how to
  755. use it.
  756. :param url_length_limit: A maximum allowed length of the request url. If exceeded, 414 error
  757. is returned.
  758. :param debug: True if the server should send exception tracebacks to the clients on 500 errors.
  759. If False, the server will respond with empty bodies.
  760. :param socket_timeout: Timeout for client connections' socket operations. Default None means
  761. wait forever.
  762. :param capitalize_response_headers: Normalize response headers' names to Foo-Bar.
  763. Default is True.
  764. """
  765. serv = Server(
  766. sock, sock.getsockname(),
  767. site, log,
  768. environ=environ,
  769. max_http_version=max_http_version,
  770. protocol=protocol,
  771. minimum_chunk_size=minimum_chunk_size,
  772. log_x_forwarded_for=log_x_forwarded_for,
  773. keepalive=keepalive,
  774. log_output=log_output,
  775. log_format=log_format,
  776. url_length_limit=url_length_limit,
  777. debug=debug,
  778. socket_timeout=socket_timeout,
  779. capitalize_response_headers=capitalize_response_headers,
  780. )
  781. if server_event is not None:
  782. warnings.warn(
  783. 'eventlet.wsgi.Server() server_event kwarg is deprecated and will be removed soon',
  784. DeprecationWarning, stacklevel=2)
  785. server_event.send(serv)
  786. if max_size is None:
  787. max_size = DEFAULT_MAX_SIMULTANEOUS_REQUESTS
  788. if custom_pool is not None:
  789. pool = custom_pool
  790. else:
  791. pool = eventlet.GreenPool(max_size)
  792. if not (hasattr(pool, 'spawn') and hasattr(pool, 'waitall')):
  793. raise AttributeError('''\
  794. eventlet.wsgi.Server pool must provide methods: `spawn`, `waitall`.
  795. If unsure, use eventlet.GreenPool.''')
  796. # [addr, socket, state]
  797. connections = {}
  798. def _clean_connection(_, conn):
  799. connections.pop(conn[0], None)
  800. conn[2] = STATE_CLOSE
  801. greenio.shutdown_safe(conn[1])
  802. conn[1].close()
  803. try:
  804. serv.log.info('({0}) wsgi starting up on {1}'.format(serv.pid, socket_repr(sock)))
  805. while is_accepting:
  806. try:
  807. client_socket, client_addr = sock.accept()
  808. client_socket.settimeout(serv.socket_timeout)
  809. serv.log.debug('({0}) accepted {1!r}'.format(serv.pid, client_addr))
  810. connections[client_addr] = connection = [client_addr, client_socket, STATE_IDLE]
  811. (pool.spawn(serv.process_request, connection)
  812. .link(_clean_connection, connection))
  813. except ACCEPT_EXCEPTIONS as e:
  814. if support.get_errno(e) not in ACCEPT_ERRNO:
  815. raise
  816. except (KeyboardInterrupt, SystemExit):
  817. serv.log.info('wsgi exiting')
  818. break
  819. finally:
  820. for cs in six.itervalues(connections):
  821. prev_state = cs[2]
  822. cs[2] = STATE_CLOSE
  823. if prev_state == STATE_IDLE:
  824. greenio.shutdown_safe(cs[1])
  825. pool.waitall()
  826. serv.log.info('({0}) wsgi exited, is_accepting={1}'.format(serv.pid, is_accepting))
  827. try:
  828. # NOTE: It's not clear whether we want this to leave the
  829. # socket open or close it. Use cases like Spawning want
  830. # the underlying fd to remain open, but if we're going
  831. # that far we might as well not bother closing sock at
  832. # all.
  833. sock.close()
  834. except socket.error as e:
  835. if support.get_errno(e) not in BROKEN_SOCK:
  836. traceback.print_exc()