root / lib / http.py @ 713faea6
History | View | Annotate | Download (21.8 kB)
1 |
#
|
---|---|
2 |
#
|
3 |
# This program is free software; you can redistribute it and/or modify
|
4 |
# it under the terms of the GNU General Public License as published by
|
5 |
# the Free Software Foundation; either version 2 of the License, or
|
6 |
# (at your option) any later version.
|
7 |
#
|
8 |
# This program is distributed in the hope that it will be useful, but
|
9 |
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
10 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
11 |
# General Public License for more details.
|
12 |
#
|
13 |
# You should have received a copy of the GNU General Public License
|
14 |
# along with this program; if not, write to the Free Software
|
15 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
16 |
# 02110-1301, USA.
|
17 |
|
18 |
"""HTTP server module.
|
19 |
|
20 |
"""
|
21 |
|
22 |
import BaseHTTPServer |
23 |
import cgi |
24 |
import logging |
25 |
import mimetools |
26 |
import OpenSSL |
27 |
import os |
28 |
import select |
29 |
import socket |
30 |
import sys |
31 |
import time |
32 |
import signal |
33 |
|
34 |
from ganeti import constants |
35 |
from ganeti import logger |
36 |
from ganeti import serializer |
37 |
|
38 |
|
39 |
WEEKDAYNAME = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'] |
40 |
MONTHNAME = [None,
|
41 |
'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', |
42 |
'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] |
43 |
|
44 |
# Default error message
|
45 |
DEFAULT_ERROR_CONTENT_TYPE = "text/html"
|
46 |
DEFAULT_ERROR_MESSAGE = """\
|
47 |
<head>
|
48 |
<title>Error response</title>
|
49 |
</head>
|
50 |
<body>
|
51 |
<h1>Error response</h1>
|
52 |
<p>Error code %(code)d.
|
53 |
<p>Message: %(message)s.
|
54 |
<p>Error code explanation: %(code)s = %(explain)s.
|
55 |
</body>
|
56 |
"""
|
57 |
|
58 |
HTTP_OK = 200
|
59 |
HTTP_NO_CONTENT = 204
|
60 |
HTTP_NOT_MODIFIED = 304
|
61 |
|
62 |
HTTP_0_9 = "HTTP/0.9"
|
63 |
HTTP_1_0 = "HTTP/1.0"
|
64 |
HTTP_1_1 = "HTTP/1.1"
|
65 |
|
66 |
HTTP_GET = "GET"
|
67 |
HTTP_HEAD = "HEAD"
|
68 |
HTTP_ETAG = "ETag"
|
69 |
|
70 |
|
71 |
class SocketClosed(socket.error): |
72 |
pass
|
73 |
|
74 |
|
75 |
class HTTPException(Exception): |
76 |
code = None
|
77 |
message = None
|
78 |
|
79 |
def __init__(self, message=None): |
80 |
Exception.__init__(self) |
81 |
if message is not None: |
82 |
self.message = message
|
83 |
|
84 |
|
85 |
class HTTPBadRequest(HTTPException): |
86 |
code = 400
|
87 |
|
88 |
|
89 |
class HTTPForbidden(HTTPException): |
90 |
code = 403
|
91 |
|
92 |
|
93 |
class HTTPNotFound(HTTPException): |
94 |
code = 404
|
95 |
|
96 |
|
97 |
class HTTPGone(HTTPException): |
98 |
code = 410
|
99 |
|
100 |
|
101 |
class HTTPLengthRequired(HTTPException): |
102 |
code = 411
|
103 |
|
104 |
|
105 |
class HTTPInternalError(HTTPException): |
106 |
code = 500
|
107 |
|
108 |
|
109 |
class HTTPNotImplemented(HTTPException): |
110 |
code = 501
|
111 |
|
112 |
|
113 |
class HTTPServiceUnavailable(HTTPException): |
114 |
code = 503
|
115 |
|
116 |
|
117 |
class HTTPVersionNotSupported(HTTPException): |
118 |
code = 505
|
119 |
|
120 |
|
121 |
class ApacheLogfile: |
122 |
"""Utility class to write HTTP server log files.
|
123 |
|
124 |
The written format is the "Common Log Format" as defined by Apache:
|
125 |
http://httpd.apache.org/docs/2.2/mod/mod_log_config.html#examples
|
126 |
|
127 |
"""
|
128 |
def __init__(self, fd): |
129 |
"""Constructor for ApacheLogfile class.
|
130 |
|
131 |
Args:
|
132 |
- fd: Open file object
|
133 |
|
134 |
"""
|
135 |
self._fd = fd
|
136 |
|
137 |
def LogRequest(self, request, format, *args): |
138 |
self._fd.write("%s %s %s [%s] %s\n" % ( |
139 |
# Remote host address
|
140 |
request.address_string(), |
141 |
|
142 |
# RFC1413 identity (identd)
|
143 |
"-",
|
144 |
|
145 |
# Remote user
|
146 |
"-",
|
147 |
|
148 |
# Request time
|
149 |
self._FormatCurrentTime(),
|
150 |
|
151 |
# Message
|
152 |
format % args, |
153 |
)) |
154 |
self._fd.flush()
|
155 |
|
156 |
def _FormatCurrentTime(self): |
157 |
"""Formats current time in Common Log Format.
|
158 |
|
159 |
"""
|
160 |
return self._FormatLogTime(time.time()) |
161 |
|
162 |
def _FormatLogTime(self, seconds): |
163 |
"""Formats time for Common Log Format.
|
164 |
|
165 |
All timestamps are logged in the UTC timezone.
|
166 |
|
167 |
Args:
|
168 |
- seconds: Time in seconds since the epoch
|
169 |
|
170 |
"""
|
171 |
(_, month, _, _, _, _, _, _, _) = tm = time.gmtime(seconds) |
172 |
format = "%d/" + MONTHNAME[month] + "/%Y:%H:%M:%S +0000" |
173 |
return time.strftime(format, tm)
|
174 |
|
175 |
|
176 |
class HTTPServer(BaseHTTPServer.HTTPServer, object): |
177 |
"""Class to provide an HTTP/HTTPS server.
|
178 |
|
179 |
"""
|
180 |
allow_reuse_address = True
|
181 |
|
182 |
def __init__(self, server_address, HandlerClass, httplog=None, |
183 |
enable_ssl=False, ssl_key=None, ssl_cert=None): |
184 |
"""Server constructor.
|
185 |
|
186 |
Args:
|
187 |
server_address: a touple containing:
|
188 |
ip: a string with IP address, localhost if empty string
|
189 |
port: port number, integer
|
190 |
HandlerClass: HTTPRequestHandler object
|
191 |
httplog: Access log object
|
192 |
enable_ssl: Whether to enable SSL
|
193 |
ssl_key: SSL key file
|
194 |
ssl_cert: SSL certificate key
|
195 |
|
196 |
"""
|
197 |
BaseHTTPServer.HTTPServer.__init__(self, server_address, HandlerClass)
|
198 |
|
199 |
self.httplog = httplog
|
200 |
|
201 |
if enable_ssl:
|
202 |
# Set up SSL
|
203 |
context = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD) |
204 |
context.use_privatekey_file(ssl_key) |
205 |
context.use_certificate_file(ssl_cert) |
206 |
self.socket = OpenSSL.SSL.Connection(context,
|
207 |
socket.socket(self.address_family,
|
208 |
self.socket_type))
|
209 |
else:
|
210 |
self.socket = socket.socket(self.address_family, self.socket_type) |
211 |
|
212 |
self.server_bind()
|
213 |
self.server_activate()
|
214 |
|
215 |
|
216 |
class HTTPJsonConverter: |
217 |
CONTENT_TYPE = "application/json"
|
218 |
|
219 |
def Encode(self, data): |
220 |
return serializer.DumpJson(data)
|
221 |
|
222 |
def Decode(self, data): |
223 |
return serializer.LoadJson(data)
|
224 |
|
225 |
|
226 |
class HTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler, object): |
227 |
"""Request handler class.
|
228 |
|
229 |
"""
|
230 |
def setup(self): |
231 |
"""Setup secure read and write file objects.
|
232 |
|
233 |
"""
|
234 |
self.connection = self.request |
235 |
self.rfile = socket._fileobject(self.request, "rb", self.rbufsize) |
236 |
self.wfile = socket._fileobject(self.request, "wb", self.wbufsize) |
237 |
|
238 |
def handle_one_request(self): |
239 |
"""Parses a request and calls the handler function.
|
240 |
|
241 |
"""
|
242 |
self.raw_requestline = None |
243 |
try:
|
244 |
self.raw_requestline = self.rfile.readline() |
245 |
except OpenSSL.SSL.Error, ex:
|
246 |
logger.Error("Error in SSL: %s" % str(ex)) |
247 |
if not self.raw_requestline: |
248 |
self.close_connection = 1 |
249 |
return
|
250 |
if not self.parse_request(): # An error code has been sent, just exit |
251 |
return
|
252 |
logging.debug("HTTP request: %s", self.raw_requestline.rstrip("\r\n")) |
253 |
|
254 |
try:
|
255 |
self._ReadPostData()
|
256 |
|
257 |
result = self.HandleRequest()
|
258 |
|
259 |
# TODO: Content-type
|
260 |
encoder = HTTPJsonConverter() |
261 |
encoded_result = encoder.Encode(result) |
262 |
|
263 |
self.send_response(200) |
264 |
self.send_header("Content-Type", encoder.CONTENT_TYPE) |
265 |
self.send_header("Content-Length", str(len(encoded_result))) |
266 |
self.end_headers()
|
267 |
|
268 |
self.wfile.write(encoded_result)
|
269 |
|
270 |
except HTTPException, err:
|
271 |
self.send_error(err.code, message=err.message)
|
272 |
|
273 |
except Exception, err: |
274 |
self.send_error(HTTPInternalError.code, message=str(err)) |
275 |
|
276 |
except:
|
277 |
self.send_error(HTTPInternalError.code, message="Unknown error") |
278 |
|
279 |
def _ReadPostData(self): |
280 |
if self.command.upper() not in ("POST", "PUT"): |
281 |
self.post_data = None |
282 |
return
|
283 |
|
284 |
# TODO: Decide what to do when Content-Length header was not sent
|
285 |
try:
|
286 |
content_length = int(self.headers.get('Content-Length', 0)) |
287 |
except ValueError: |
288 |
raise HTTPBadRequest("No Content-Length header or invalid format") |
289 |
|
290 |
try:
|
291 |
data = self.rfile.read(content_length)
|
292 |
except socket.error, err:
|
293 |
logger.Error("Socket error while reading: %s" % str(err)) |
294 |
return
|
295 |
|
296 |
# TODO: Content-type, error handling
|
297 |
self.post_data = HTTPJsonConverter().Decode(data)
|
298 |
|
299 |
logging.debug("HTTP POST data: %s", self.post_data) |
300 |
|
301 |
def HandleRequest(self): |
302 |
"""Handles a request.
|
303 |
|
304 |
"""
|
305 |
raise NotImplementedError() |
306 |
|
307 |
def log_message(self, format, *args): |
308 |
"""Log an arbitrary message.
|
309 |
|
310 |
This is used by all other logging functions.
|
311 |
|
312 |
The first argument, FORMAT, is a format string for the
|
313 |
message to be logged. If the format string contains
|
314 |
any % escapes requiring parameters, they should be
|
315 |
specified as subsequent arguments (it's just like
|
316 |
printf!).
|
317 |
|
318 |
"""
|
319 |
logging.debug("Handled request: %s", format % args)
|
320 |
if self.server.httplog: |
321 |
self.server.httplog.LogRequest(self, format, *args) |
322 |
|
323 |
|
324 |
class _HttpConnectionHandler(object): |
325 |
"""Implements server side of HTTP
|
326 |
|
327 |
This class implements the server side of HTTP. It's based on code of Python's
|
328 |
BaseHTTPServer, from both version 2.4 and 3k. It does not support non-ASCII
|
329 |
character encodings. Keep-alive connections are not supported.
|
330 |
|
331 |
"""
|
332 |
# String for "Server" header
|
333 |
server_version = "Ganeti %s" % constants.RELEASE_VERSION
|
334 |
|
335 |
# The default request version. This only affects responses up until
|
336 |
# the point where the request line is parsed, so it mainly decides what
|
337 |
# the client gets back when sending a malformed request line.
|
338 |
# Most web servers default to HTTP 0.9, i.e. don't send a status line.
|
339 |
default_request_version = HTTP_0_9 |
340 |
|
341 |
# Error message settings
|
342 |
error_message_format = DEFAULT_ERROR_MESSAGE |
343 |
error_content_type = DEFAULT_ERROR_CONTENT_TYPE |
344 |
|
345 |
responses = BaseHTTPServer.BaseHTTPRequestHandler.responses |
346 |
|
347 |
def __init__(self, server, conn, client_addr, fileio_class): |
348 |
"""Initializes this class.
|
349 |
|
350 |
Part of the initialization is reading the request and eventual POST/PUT
|
351 |
data sent by the client.
|
352 |
|
353 |
"""
|
354 |
self._server = server
|
355 |
|
356 |
# We default rfile to buffered because otherwise it could be
|
357 |
# really slow for large data (a getc() call per byte); we make
|
358 |
# wfile unbuffered because (a) often after a write() we want to
|
359 |
# read and we need to flush the line; (b) big writes to unbuffered
|
360 |
# files are typically optimized by stdio even when big reads
|
361 |
# aren't.
|
362 |
self.rfile = fileio_class(conn, mode="rb", bufsize=-1) |
363 |
self.wfile = fileio_class(conn, mode="wb", bufsize=0) |
364 |
|
365 |
self.client_addr = client_addr
|
366 |
|
367 |
self.request_headers = None |
368 |
self.request_method = None |
369 |
self.request_path = None |
370 |
self.request_requestline = None |
371 |
self.request_version = self.default_request_version |
372 |
|
373 |
self.response_body = None |
374 |
self.response_code = HTTP_OK
|
375 |
self.response_content_type = None |
376 |
self.response_headers = {}
|
377 |
|
378 |
self.should_fork = False |
379 |
|
380 |
try:
|
381 |
self._ReadRequest()
|
382 |
self._ReadPostData()
|
383 |
|
384 |
self.should_fork = self._server.ForkForRequest(self) |
385 |
except HTTPException, err:
|
386 |
self._SetErrorStatus(err)
|
387 |
|
388 |
def Close(self): |
389 |
if not self.wfile.closed: |
390 |
self.wfile.flush()
|
391 |
self.wfile.close()
|
392 |
self.rfile.close()
|
393 |
|
394 |
def _DateTimeHeader(self): |
395 |
"""Return the current date and time formatted for a message header.
|
396 |
|
397 |
"""
|
398 |
(year, month, day, hh, mm, ss, wd, _, _) = time.gmtime() |
399 |
return ("%s, %02d %3s %4d %02d:%02d:%02d GMT" % |
400 |
(WEEKDAYNAME[wd], day, MONTHNAME[month], year, hh, mm, ss)) |
401 |
|
402 |
def _SetErrorStatus(self, err): |
403 |
"""Sets the response code and body from a HTTPException.
|
404 |
|
405 |
@type err: HTTPException
|
406 |
@param err: Exception instance
|
407 |
|
408 |
"""
|
409 |
try:
|
410 |
(shortmsg, longmsg) = self.responses[err.code]
|
411 |
except KeyError: |
412 |
shortmsg = longmsg = "Unknown"
|
413 |
|
414 |
if err.message:
|
415 |
message = err.message |
416 |
else:
|
417 |
message = shortmsg |
418 |
|
419 |
values = { |
420 |
"code": err.code,
|
421 |
"message": cgi.escape(message),
|
422 |
"explain": longmsg,
|
423 |
} |
424 |
|
425 |
self.response_code = err.code
|
426 |
self.response_content_type = self.error_content_type |
427 |
self.response_body = self.error_message_format % values |
428 |
|
429 |
def HandleRequest(self): |
430 |
"""Handle the actual request.
|
431 |
|
432 |
Calls the actual handler function and converts exceptions into HTTP errors.
|
433 |
|
434 |
"""
|
435 |
# Don't do anything if there's already been a problem
|
436 |
if self.response_code != HTTP_OK: |
437 |
return
|
438 |
|
439 |
assert self.request_method, "Status code %s requires a method" % HTTP_OK |
440 |
|
441 |
# Check whether client is still there
|
442 |
self.rfile.read(0) |
443 |
|
444 |
try:
|
445 |
try:
|
446 |
result = self._server.HandleRequest(self) |
447 |
|
448 |
# TODO: Content-type
|
449 |
encoder = HTTPJsonConverter() |
450 |
body = encoder.Encode(result) |
451 |
|
452 |
self.response_content_type = encoder.CONTENT_TYPE
|
453 |
self.response_body = body
|
454 |
except (HTTPException, KeyboardInterrupt, SystemExit): |
455 |
raise
|
456 |
except Exception, err: |
457 |
logging.exception("Caught exception")
|
458 |
raise HTTPInternalError(message=str(err)) |
459 |
except:
|
460 |
logging.exception("Unknown exception")
|
461 |
raise HTTPInternalError(message="Unknown error") |
462 |
|
463 |
except HTTPException, err:
|
464 |
self._SetErrorStatus(err)
|
465 |
|
466 |
def SendResponse(self): |
467 |
"""Sends response to the client.
|
468 |
|
469 |
"""
|
470 |
# Check whether client is still there
|
471 |
self.rfile.read(0) |
472 |
|
473 |
logging.info("%s:%s %s %s", self.client_addr[0], self.client_addr[1], |
474 |
self.request_requestline, self.response_code) |
475 |
|
476 |
if self.response_code in self.responses: |
477 |
response_message = self.responses[self.response_code][0] |
478 |
else:
|
479 |
response_message = ""
|
480 |
|
481 |
if self.request_version != HTTP_0_9: |
482 |
self.wfile.write("%s %d %s\r\n" % |
483 |
(self.request_version, self.response_code, |
484 |
response_message)) |
485 |
self._SendHeader("Server", self.server_version) |
486 |
self._SendHeader("Date", self._DateTimeHeader()) |
487 |
self._SendHeader("Content-Type", self.response_content_type) |
488 |
self._SendHeader("Content-Length", str(len(self.response_body))) |
489 |
for key, val in self.response_headers.iteritems(): |
490 |
self._SendHeader(key, val)
|
491 |
|
492 |
# We don't support keep-alive at this time
|
493 |
self._SendHeader("Connection", "close") |
494 |
self.wfile.write("\r\n") |
495 |
|
496 |
if (self.request_method != HTTP_HEAD and |
497 |
self.response_code >= HTTP_OK and |
498 |
self.response_code not in (HTTP_NO_CONTENT, HTTP_NOT_MODIFIED)): |
499 |
self.wfile.write(self.response_body) |
500 |
|
501 |
def _SendHeader(self, name, value): |
502 |
if self.request_version != HTTP_0_9: |
503 |
self.wfile.write("%s: %s\r\n" % (name, value)) |
504 |
|
505 |
def _ReadRequest(self): |
506 |
"""Reads and parses request line
|
507 |
|
508 |
"""
|
509 |
raw_requestline = self.rfile.readline()
|
510 |
|
511 |
requestline = raw_requestline |
512 |
if requestline[-2:] == '\r\n': |
513 |
requestline = requestline[:-2]
|
514 |
elif requestline[-1:] == '\n': |
515 |
requestline = requestline[:-1]
|
516 |
|
517 |
if not requestline: |
518 |
raise HTTPBadRequest("Empty request line") |
519 |
|
520 |
self.request_requestline = requestline
|
521 |
|
522 |
logging.debug("HTTP request: %s", raw_requestline.rstrip("\r\n")) |
523 |
|
524 |
words = requestline.split() |
525 |
|
526 |
if len(words) == 3: |
527 |
[method, path, version] = words |
528 |
if version[:5] != 'HTTP/': |
529 |
raise HTTPBadRequest("Bad request version (%r)" % version) |
530 |
|
531 |
try:
|
532 |
base_version_number = version.split('/', 1)[1] |
533 |
version_number = base_version_number.split(".")
|
534 |
|
535 |
# RFC 2145 section 3.1 says there can be only one "." and
|
536 |
# - major and minor numbers MUST be treated as
|
537 |
# separate integers;
|
538 |
# - HTTP/2.4 is a lower version than HTTP/2.13, which in
|
539 |
# turn is lower than HTTP/12.3;
|
540 |
# - Leading zeros MUST be ignored by recipients.
|
541 |
if len(version_number) != 2: |
542 |
raise HTTPBadRequest("Bad request version (%r)" % version) |
543 |
|
544 |
version_number = int(version_number[0]), int(version_number[1]) |
545 |
except (ValueError, IndexError): |
546 |
raise HTTPBadRequest("Bad request version (%r)" % version) |
547 |
|
548 |
if version_number >= (2, 0): |
549 |
raise HTTPVersionNotSupported("Invalid HTTP Version (%s)" % |
550 |
base_version_number) |
551 |
|
552 |
elif len(words) == 2: |
553 |
version = HTTP_0_9 |
554 |
[method, path] = words |
555 |
if method != HTTP_GET:
|
556 |
raise HTTPBadRequest("Bad HTTP/0.9 request type (%r)" % method) |
557 |
|
558 |
else:
|
559 |
raise HTTPBadRequest("Bad request syntax (%r)" % requestline) |
560 |
|
561 |
# Examine the headers and look for a Connection directive
|
562 |
headers = mimetools.Message(self.rfile, 0) |
563 |
|
564 |
self.request_method = method
|
565 |
self.request_path = path
|
566 |
self.request_version = version
|
567 |
self.request_headers = headers
|
568 |
|
569 |
def _ReadPostData(self): |
570 |
"""Reads POST/PUT data
|
571 |
|
572 |
"""
|
573 |
if not self.request_method or self.request_method.upper() not in ("POST", "PUT"): |
574 |
self.request_post_data = None |
575 |
return
|
576 |
|
577 |
# TODO: Decide what to do when Content-Length header was not sent
|
578 |
try:
|
579 |
content_length = int(self.request_headers.get('Content-Length', 0)) |
580 |
except ValueError: |
581 |
raise HTTPBadRequest("No Content-Length header or invalid format") |
582 |
|
583 |
data = self.rfile.read(content_length)
|
584 |
|
585 |
# TODO: Content-type, error handling
|
586 |
self.request_post_data = HTTPJsonConverter().Decode(data)
|
587 |
|
588 |
logging.debug("HTTP POST data: %s", self.request_post_data) |
589 |
|
590 |
|
591 |
class HttpServer(object): |
592 |
"""Generic HTTP server class
|
593 |
|
594 |
Users of this class must subclass it and override the HandleRequest function.
|
595 |
Optionally, the ForkForRequest function can be overriden.
|
596 |
|
597 |
"""
|
598 |
MAX_CHILDREN = 20
|
599 |
|
600 |
def __init__(self, mainloop, server_address): |
601 |
self.mainloop = mainloop
|
602 |
self.server_address = server_address
|
603 |
|
604 |
# TODO: SSL support
|
605 |
self.ssl_cert = None |
606 |
self.ssl_key = self.ssl_cert |
607 |
|
608 |
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
609 |
|
610 |
if self.ssl_cert and self.ssl_key: |
611 |
ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD) |
612 |
ctx.set_options(OpenSSL.SSL.OP_NO_SSLv2) |
613 |
|
614 |
ctx.use_certificate_file(self.ssl_cert)
|
615 |
ctx.use_privatekey_file(self.ssl_key)
|
616 |
|
617 |
self.socket = OpenSSL.SSL.Connection(ctx, sock)
|
618 |
self._fileio_class = _SSLFileObject
|
619 |
else:
|
620 |
self.socket = sock
|
621 |
self._fileio_class = socket._fileobject
|
622 |
|
623 |
# Allow port to be reused
|
624 |
self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
625 |
|
626 |
self._children = []
|
627 |
|
628 |
mainloop.RegisterIO(self, self.socket.fileno(), select.POLLIN) |
629 |
mainloop.RegisterSignal(self)
|
630 |
|
631 |
def Start(self): |
632 |
self.socket.bind(self.server_address) |
633 |
self.socket.listen(5) |
634 |
|
635 |
def Stop(self): |
636 |
self.socket.close()
|
637 |
|
638 |
def OnIO(self, fd, condition): |
639 |
if condition & select.POLLIN:
|
640 |
self._IncomingConnection()
|
641 |
|
642 |
def OnSignal(self, signum): |
643 |
if signum == signal.SIGCHLD:
|
644 |
self._CollectChildren(True) |
645 |
|
646 |
def _CollectChildren(self, quick): |
647 |
"""Checks whether any child processes are done
|
648 |
|
649 |
@type quick: bool
|
650 |
@param quick: Whether to only use non-blocking functions
|
651 |
|
652 |
"""
|
653 |
if not quick: |
654 |
# Don't wait for other processes if it should be a quick check
|
655 |
while len(self._children) > self.MAX_CHILDREN: |
656 |
try:
|
657 |
pid, status = os.waitpid(0, 0) |
658 |
except os.error:
|
659 |
pid = None
|
660 |
if pid and pid in self._children: |
661 |
self._children.remove(pid)
|
662 |
|
663 |
for child in self._children: |
664 |
try:
|
665 |
pid, status = os.waitpid(child, os.WNOHANG) |
666 |
except os.error:
|
667 |
pid = None
|
668 |
if pid and pid in self._children: |
669 |
self._children.remove(pid)
|
670 |
|
671 |
def _IncomingConnection(self): |
672 |
connection, client_addr = self.socket.accept()
|
673 |
logging.info("Connection from %s:%s", client_addr[0], client_addr[1]) |
674 |
try:
|
675 |
handler = _HttpConnectionHandler(self, connection, client_addr, self._fileio_class) |
676 |
except (socket.error, SocketClosed):
|
677 |
return
|
678 |
|
679 |
def FinishRequest(): |
680 |
try:
|
681 |
try:
|
682 |
try:
|
683 |
handler.HandleRequest() |
684 |
finally:
|
685 |
# Try to send a response
|
686 |
handler.SendResponse() |
687 |
handler.Close() |
688 |
except SocketClosed:
|
689 |
pass
|
690 |
finally:
|
691 |
logging.info("Disconnected %s:%s", client_addr[0], client_addr[1]) |
692 |
|
693 |
# Check whether we should fork or not
|
694 |
if not handler.should_fork: |
695 |
FinishRequest() |
696 |
return
|
697 |
|
698 |
self._CollectChildren(False) |
699 |
|
700 |
pid = os.fork() |
701 |
if pid == 0: |
702 |
# Child process
|
703 |
try:
|
704 |
FinishRequest() |
705 |
except:
|
706 |
logging.exception("Error while handling request from %s:%s",
|
707 |
client_addr[0], client_addr[1]) |
708 |
os._exit(1)
|
709 |
os._exit(0)
|
710 |
else:
|
711 |
self._children.append(pid)
|
712 |
|
713 |
def HandleRequest(self, req): |
714 |
raise NotImplementedError() |
715 |
|
716 |
def ForkForRequest(self, req): |
717 |
return True |
718 |
|
719 |
|
720 |
class _SSLFileObject(object): |
721 |
"""Wrapper around socket._fileobject
|
722 |
|
723 |
This wrapper is required to handle OpenSSL exceptions.
|
724 |
|
725 |
"""
|
726 |
def _RequireOpenSocket(fn): |
727 |
def wrapper(self, *args, **kwargs): |
728 |
if self.closed: |
729 |
raise SocketClosed("Socket is closed") |
730 |
return fn(self, *args, **kwargs) |
731 |
return wrapper
|
732 |
|
733 |
def __init__(self, sock, mode='rb', bufsize=-1): |
734 |
self._base = socket._fileobject(sock, mode=mode, bufsize=bufsize)
|
735 |
|
736 |
def _ConnectionLost(self): |
737 |
self._base = None |
738 |
|
739 |
def _getclosed(self): |
740 |
return self._base is None or self._base.closed |
741 |
closed = property(_getclosed, doc="True if the file is closed") |
742 |
|
743 |
@_RequireOpenSocket
|
744 |
def close(self): |
745 |
return self._base.close() |
746 |
|
747 |
@_RequireOpenSocket
|
748 |
def flush(self): |
749 |
return self._base.flush() |
750 |
|
751 |
@_RequireOpenSocket
|
752 |
def fileno(self): |
753 |
return self._base.fileno() |
754 |
|
755 |
@_RequireOpenSocket
|
756 |
def read(self, size=-1): |
757 |
return self._ReadWrapper(self._base.read, size=size) |
758 |
|
759 |
@_RequireOpenSocket
|
760 |
def readline(self, size=-1): |
761 |
return self._ReadWrapper(self._base.readline, size=size) |
762 |
|
763 |
def _ReadWrapper(self, fn, *args, **kwargs): |
764 |
while True: |
765 |
try:
|
766 |
return fn(*args, **kwargs)
|
767 |
|
768 |
except OpenSSL.SSL.ZeroReturnError, err:
|
769 |
self._ConnectionLost()
|
770 |
return "" |
771 |
|
772 |
except OpenSSL.SSL.WantReadError:
|
773 |
continue
|
774 |
|
775 |
#except OpenSSL.SSL.WantWriteError:
|
776 |
# TODO
|
777 |
|
778 |
except OpenSSL.SSL.SysCallError, (retval, desc):
|
779 |
if ((retval == -1 and desc == "Unexpected EOF") |
780 |
or retval > 0): |
781 |
self._ConnectionLost()
|
782 |
return "" |
783 |
|
784 |
logging.exception("Error in OpenSSL")
|
785 |
self._ConnectionLost()
|
786 |
raise socket.error(err.args)
|
787 |
|
788 |
except OpenSSL.SSL.Error, err:
|
789 |
self._ConnectionLost()
|
790 |
raise socket.error(err.args)
|
791 |
|
792 |
@_RequireOpenSocket
|
793 |
def write(self, data): |
794 |
return self._WriteWrapper(self._base.write, data) |
795 |
|
796 |
def _WriteWrapper(self, fn, *args, **kwargs): |
797 |
while True: |
798 |
try:
|
799 |
return fn(*args, **kwargs)
|
800 |
except OpenSSL.SSL.ZeroReturnError, err:
|
801 |
self._ConnectionLost()
|
802 |
return 0 |
803 |
|
804 |
except OpenSSL.SSL.WantWriteError:
|
805 |
continue
|
806 |
|
807 |
#except OpenSSL.SSL.WantReadError:
|
808 |
# TODO
|
809 |
|
810 |
except OpenSSL.SSL.SysCallError, err:
|
811 |
if err.args[0] == -1 and data == "": |
812 |
# errors when writing empty strings are expected
|
813 |
# and can be ignored
|
814 |
return 0 |
815 |
|
816 |
self._ConnectionLost()
|
817 |
raise socket.error(err.args)
|
818 |
|
819 |
except OpenSSL.SSL.Error, err:
|
820 |
self._ConnectionLost()
|
821 |
raise socket.error(err.args)
|