root / lib / http / server.py @ b7d7876b
History | View | Annotate | Download (17.6 kB)
1 | 02cab3e7 | Michael Hanselmann | #
|
---|---|---|---|
2 | 02cab3e7 | Michael Hanselmann | #
|
3 | 02cab3e7 | Michael Hanselmann | |
4 | db4e138b | Manuel Franceschini | # Copyright (C) 2007, 2008, 2010 Google Inc.
|
5 | 02cab3e7 | Michael Hanselmann | #
|
6 | 02cab3e7 | Michael Hanselmann | # This program is free software; you can redistribute it and/or modify
|
7 | 02cab3e7 | Michael Hanselmann | # it under the terms of the GNU General Public License as published by
|
8 | 02cab3e7 | Michael Hanselmann | # the Free Software Foundation; either version 2 of the License, or
|
9 | 02cab3e7 | Michael Hanselmann | # (at your option) any later version.
|
10 | 02cab3e7 | Michael Hanselmann | #
|
11 | 02cab3e7 | Michael Hanselmann | # This program is distributed in the hope that it will be useful, but
|
12 | 02cab3e7 | Michael Hanselmann | # WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | 02cab3e7 | Michael Hanselmann | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 | 02cab3e7 | Michael Hanselmann | # General Public License for more details.
|
15 | 02cab3e7 | Michael Hanselmann | #
|
16 | 02cab3e7 | Michael Hanselmann | # You should have received a copy of the GNU General Public License
|
17 | 02cab3e7 | Michael Hanselmann | # along with this program; if not, write to the Free Software
|
18 | 02cab3e7 | Michael Hanselmann | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 | 02cab3e7 | Michael Hanselmann | # 02110-1301, USA.
|
20 | 02cab3e7 | Michael Hanselmann | |
21 | 02cab3e7 | Michael Hanselmann | """HTTP server module.
|
22 | 02cab3e7 | Michael Hanselmann |
|
23 | 02cab3e7 | Michael Hanselmann | """
|
24 | 02cab3e7 | Michael Hanselmann | |
25 | 02cab3e7 | Michael Hanselmann | import BaseHTTPServer |
26 | 02cab3e7 | Michael Hanselmann | import cgi |
27 | 02cab3e7 | Michael Hanselmann | import logging |
28 | 02cab3e7 | Michael Hanselmann | import os |
29 | 02cab3e7 | Michael Hanselmann | import socket |
30 | 02cab3e7 | Michael Hanselmann | import time |
31 | 02cab3e7 | Michael Hanselmann | import signal |
32 | 112d240d | Guido Trotter | import asyncore |
33 | 02cab3e7 | Michael Hanselmann | |
34 | 02cab3e7 | Michael Hanselmann | from ganeti import http |
35 | 82869978 | Michael Hanselmann | from ganeti import utils |
36 | db4e138b | Manuel Franceschini | from ganeti import netutils |
37 | 02cab3e7 | Michael Hanselmann | |
38 | 02cab3e7 | Michael Hanselmann | |
39 | d0c8c01d | Iustin Pop | WEEKDAYNAME = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"] |
40 | 02cab3e7 | Michael Hanselmann | MONTHNAME = [None,
|
41 | d0c8c01d | Iustin Pop | "Jan", "Feb", "Mar", "Apr", "May", "Jun", |
42 | d0c8c01d | Iustin Pop | "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"] |
43 | 02cab3e7 | Michael Hanselmann | |
44 | 02cab3e7 | Michael Hanselmann | # Default error message
|
45 | 02cab3e7 | Michael Hanselmann | DEFAULT_ERROR_CONTENT_TYPE = "text/html"
|
46 | 02cab3e7 | Michael Hanselmann | DEFAULT_ERROR_MESSAGE = """\
|
47 | 02cab3e7 | Michael Hanselmann | <html>
|
48 | 02cab3e7 | Michael Hanselmann | <head>
|
49 | 02cab3e7 | Michael Hanselmann | <title>Error response</title>
|
50 | 02cab3e7 | Michael Hanselmann | </head>
|
51 | 02cab3e7 | Michael Hanselmann | <body>
|
52 | 02cab3e7 | Michael Hanselmann | <h1>Error response</h1>
|
53 | 02cab3e7 | Michael Hanselmann | <p>Error code %(code)d.
|
54 | 02cab3e7 | Michael Hanselmann | <p>Message: %(message)s.
|
55 | 02cab3e7 | Michael Hanselmann | <p>Error code explanation: %(code)s = %(explain)s.
|
56 | 02cab3e7 | Michael Hanselmann | </body>
|
57 | 02cab3e7 | Michael Hanselmann | </html>
|
58 | 02cab3e7 | Michael Hanselmann | """
|
59 | 02cab3e7 | Michael Hanselmann | |
60 | 02cab3e7 | Michael Hanselmann | |
61 | f30ca1e6 | Michael Hanselmann | def _DateTimeHeader(gmnow=None): |
62 | 02cab3e7 | Michael Hanselmann | """Return the current date and time formatted for a message header.
|
63 | 02cab3e7 | Michael Hanselmann |
|
64 | f30ca1e6 | Michael Hanselmann | The time MUST be in the GMT timezone.
|
65 | f30ca1e6 | Michael Hanselmann |
|
66 | 02cab3e7 | Michael Hanselmann | """
|
67 | f30ca1e6 | Michael Hanselmann | if gmnow is None: |
68 | f30ca1e6 | Michael Hanselmann | gmnow = time.gmtime() |
69 | f30ca1e6 | Michael Hanselmann | (year, month, day, hh, mm, ss, wd, _, _) = gmnow |
70 | 02cab3e7 | Michael Hanselmann | return ("%s, %02d %3s %4d %02d:%02d:%02d GMT" % |
71 | 02cab3e7 | Michael Hanselmann | (WEEKDAYNAME[wd], day, MONTHNAME[month], year, hh, mm, ss)) |
72 | 02cab3e7 | Michael Hanselmann | |
73 | 02cab3e7 | Michael Hanselmann | |
74 | 02cab3e7 | Michael Hanselmann | class _HttpServerRequest(object): |
75 | 02cab3e7 | Michael Hanselmann | """Data structure for HTTP request on server side.
|
76 | 02cab3e7 | Michael Hanselmann |
|
77 | 02cab3e7 | Michael Hanselmann | """
|
78 | a8950eb7 | Michael Hanselmann | def __init__(self, method, path, headers, body): |
79 | 02cab3e7 | Michael Hanselmann | # Request attributes
|
80 | a8950eb7 | Michael Hanselmann | self.request_method = method
|
81 | a8950eb7 | Michael Hanselmann | self.request_path = path
|
82 | a8950eb7 | Michael Hanselmann | self.request_headers = headers
|
83 | a8950eb7 | Michael Hanselmann | self.request_body = body
|
84 | 02cab3e7 | Michael Hanselmann | |
85 | 02cab3e7 | Michael Hanselmann | # Response attributes
|
86 | 02cab3e7 | Michael Hanselmann | self.resp_headers = {}
|
87 | 02cab3e7 | Michael Hanselmann | |
88 | 68fa9caf | Michael Hanselmann | # Private data for request handler (useful in combination with
|
89 | 68fa9caf | Michael Hanselmann | # authentication)
|
90 | 68fa9caf | Michael Hanselmann | self.private = None |
91 | 68fa9caf | Michael Hanselmann | |
92 | d44ea6a3 | Michael Hanselmann | def __repr__(self): |
93 | d44ea6a3 | Michael Hanselmann | status = ["%s.%s" % (self.__class__.__module__, self.__class__.__name__), |
94 | d44ea6a3 | Michael Hanselmann | self.request_method, self.request_path, |
95 | d44ea6a3 | Michael Hanselmann | "headers=%r" % str(self.request_headers), |
96 | d44ea6a3 | Michael Hanselmann | "body=%r" % (self.request_body, )] |
97 | d44ea6a3 | Michael Hanselmann | |
98 | d44ea6a3 | Michael Hanselmann | return "<%s at %#x>" % (" ".join(status), id(self)) |
99 | d44ea6a3 | Michael Hanselmann | |
100 | 02cab3e7 | Michael Hanselmann | |
101 | 02cab3e7 | Michael Hanselmann | class _HttpServerToClientMessageWriter(http.HttpMessageWriter): |
102 | 02cab3e7 | Michael Hanselmann | """Writes an HTTP response to client.
|
103 | 02cab3e7 | Michael Hanselmann |
|
104 | 02cab3e7 | Michael Hanselmann | """
|
105 | 02cab3e7 | Michael Hanselmann | def __init__(self, sock, request_msg, response_msg, write_timeout): |
106 | 358a8811 | Michael Hanselmann | """Writes the response to the client.
|
107 | 358a8811 | Michael Hanselmann |
|
108 | 358a8811 | Michael Hanselmann | @type sock: socket
|
109 | 358a8811 | Michael Hanselmann | @param sock: Target socket
|
110 | 358a8811 | Michael Hanselmann | @type request_msg: http.HttpMessage
|
111 | 358a8811 | Michael Hanselmann | @param request_msg: Request message, required to determine whether
|
112 | 25e7b43f | Iustin Pop | response may have a message body
|
113 | 358a8811 | Michael Hanselmann | @type response_msg: http.HttpMessage
|
114 | 358a8811 | Michael Hanselmann | @param response_msg: Response message
|
115 | 358a8811 | Michael Hanselmann | @type write_timeout: float
|
116 | 358a8811 | Michael Hanselmann | @param write_timeout: Write timeout for socket
|
117 | 02cab3e7 | Michael Hanselmann |
|
118 | 02cab3e7 | Michael Hanselmann | """
|
119 | 02cab3e7 | Michael Hanselmann | self._request_msg = request_msg
|
120 | 02cab3e7 | Michael Hanselmann | self._response_msg = response_msg
|
121 | 02cab3e7 | Michael Hanselmann | http.HttpMessageWriter.__init__(self, sock, response_msg, write_timeout)
|
122 | 02cab3e7 | Michael Hanselmann | |
123 | 02cab3e7 | Michael Hanselmann | def HasMessageBody(self): |
124 | 02cab3e7 | Michael Hanselmann | """Logic to detect whether response should contain a message body.
|
125 | 02cab3e7 | Michael Hanselmann |
|
126 | 02cab3e7 | Michael Hanselmann | """
|
127 | 02cab3e7 | Michael Hanselmann | if self._request_msg.start_line: |
128 | 02cab3e7 | Michael Hanselmann | request_method = self._request_msg.start_line.method
|
129 | 02cab3e7 | Michael Hanselmann | else:
|
130 | 02cab3e7 | Michael Hanselmann | request_method = None
|
131 | 02cab3e7 | Michael Hanselmann | |
132 | 02cab3e7 | Michael Hanselmann | response_code = self._response_msg.start_line.code
|
133 | 02cab3e7 | Michael Hanselmann | |
134 | 02cab3e7 | Michael Hanselmann | # RFC2616, section 4.3: "A message-body MUST NOT be included in a request
|
135 | 02cab3e7 | Michael Hanselmann | # if the specification of the request method (section 5.1.1) does not allow
|
136 | 02cab3e7 | Michael Hanselmann | # sending an entity-body in requests"
|
137 | 02cab3e7 | Michael Hanselmann | #
|
138 | 02cab3e7 | Michael Hanselmann | # RFC2616, section 9.4: "The HEAD method is identical to GET except that
|
139 | 02cab3e7 | Michael Hanselmann | # the server MUST NOT return a message-body in the response."
|
140 | 02cab3e7 | Michael Hanselmann | #
|
141 | 02cab3e7 | Michael Hanselmann | # RFC2616, section 10.2.5: "The 204 response MUST NOT include a
|
142 | 02cab3e7 | Michael Hanselmann | # message-body [...]"
|
143 | 02cab3e7 | Michael Hanselmann | #
|
144 | 02cab3e7 | Michael Hanselmann | # RFC2616, section 10.3.5: "The 304 response MUST NOT contain a
|
145 | 02cab3e7 | Michael Hanselmann | # message-body, [...]"
|
146 | 02cab3e7 | Michael Hanselmann | |
147 | 02cab3e7 | Michael Hanselmann | return (http.HttpMessageWriter.HasMessageBody(self) and |
148 | 3f3dfc15 | Iustin Pop | (request_method is not None and |
149 | 3f3dfc15 | Iustin Pop | request_method != http.HTTP_HEAD) and
|
150 | 02cab3e7 | Michael Hanselmann | response_code >= http.HTTP_OK and
|
151 | 3f3dfc15 | Iustin Pop | response_code not in (http.HTTP_NO_CONTENT, |
152 | 3f3dfc15 | Iustin Pop | http.HTTP_NOT_MODIFIED)) |
153 | 02cab3e7 | Michael Hanselmann | |
154 | 02cab3e7 | Michael Hanselmann | |
155 | 02cab3e7 | Michael Hanselmann | class _HttpClientToServerMessageReader(http.HttpMessageReader): |
156 | 02cab3e7 | Michael Hanselmann | """Reads an HTTP request sent by client.
|
157 | 02cab3e7 | Michael Hanselmann |
|
158 | 02cab3e7 | Michael Hanselmann | """
|
159 | 02cab3e7 | Michael Hanselmann | # Length limits
|
160 | 02cab3e7 | Michael Hanselmann | START_LINE_LENGTH_MAX = 4096
|
161 | 02cab3e7 | Michael Hanselmann | HEADER_LENGTH_MAX = 4096
|
162 | 02cab3e7 | Michael Hanselmann | |
163 | 02cab3e7 | Michael Hanselmann | def ParseStartLine(self, start_line): |
164 | 02cab3e7 | Michael Hanselmann | """Parses the start line sent by client.
|
165 | 02cab3e7 | Michael Hanselmann |
|
166 | 02cab3e7 | Michael Hanselmann | Example: "GET /index.html HTTP/1.1"
|
167 | 02cab3e7 | Michael Hanselmann |
|
168 | 02cab3e7 | Michael Hanselmann | @type start_line: string
|
169 | 02cab3e7 | Michael Hanselmann | @param start_line: Start line
|
170 | 02cab3e7 | Michael Hanselmann |
|
171 | 02cab3e7 | Michael Hanselmann | """
|
172 | 02cab3e7 | Michael Hanselmann | # Empty lines are skipped when reading
|
173 | 02cab3e7 | Michael Hanselmann | assert start_line
|
174 | 02cab3e7 | Michael Hanselmann | |
175 | 02cab3e7 | Michael Hanselmann | logging.debug("HTTP request: %s", start_line)
|
176 | 02cab3e7 | Michael Hanselmann | |
177 | 02cab3e7 | Michael Hanselmann | words = start_line.split() |
178 | 02cab3e7 | Michael Hanselmann | |
179 | 02cab3e7 | Michael Hanselmann | if len(words) == 3: |
180 | 02cab3e7 | Michael Hanselmann | [method, path, version] = words |
181 | d0c8c01d | Iustin Pop | if version[:5] != "HTTP/": |
182 | 02cab3e7 | Michael Hanselmann | raise http.HttpBadRequest("Bad request version (%r)" % version) |
183 | 02cab3e7 | Michael Hanselmann | |
184 | 02cab3e7 | Michael Hanselmann | try:
|
185 | 02cab3e7 | Michael Hanselmann | base_version_number = version.split("/", 1)[1] |
186 | 02cab3e7 | Michael Hanselmann | version_number = base_version_number.split(".")
|
187 | 02cab3e7 | Michael Hanselmann | |
188 | 02cab3e7 | Michael Hanselmann | # RFC 2145 section 3.1 says there can be only one "." and
|
189 | 02cab3e7 | Michael Hanselmann | # - major and minor numbers MUST be treated as
|
190 | 02cab3e7 | Michael Hanselmann | # separate integers;
|
191 | 02cab3e7 | Michael Hanselmann | # - HTTP/2.4 is a lower version than HTTP/2.13, which in
|
192 | 02cab3e7 | Michael Hanselmann | # turn is lower than HTTP/12.3;
|
193 | 02cab3e7 | Michael Hanselmann | # - Leading zeros MUST be ignored by recipients.
|
194 | 02cab3e7 | Michael Hanselmann | if len(version_number) != 2: |
195 | 02cab3e7 | Michael Hanselmann | raise http.HttpBadRequest("Bad request version (%r)" % version) |
196 | 02cab3e7 | Michael Hanselmann | |
197 | 02cab3e7 | Michael Hanselmann | version_number = (int(version_number[0]), int(version_number[1])) |
198 | 02cab3e7 | Michael Hanselmann | except (ValueError, IndexError): |
199 | 02cab3e7 | Michael Hanselmann | raise http.HttpBadRequest("Bad request version (%r)" % version) |
200 | 02cab3e7 | Michael Hanselmann | |
201 | 02cab3e7 | Michael Hanselmann | if version_number >= (2, 0): |
202 | 02cab3e7 | Michael Hanselmann | raise http.HttpVersionNotSupported("Invalid HTTP Version (%s)" % |
203 | 02cab3e7 | Michael Hanselmann | base_version_number) |
204 | 02cab3e7 | Michael Hanselmann | |
205 | 02cab3e7 | Michael Hanselmann | elif len(words) == 2: |
206 | 02cab3e7 | Michael Hanselmann | version = http.HTTP_0_9 |
207 | 02cab3e7 | Michael Hanselmann | [method, path] = words |
208 | 02cab3e7 | Michael Hanselmann | if method != http.HTTP_GET:
|
209 | 02cab3e7 | Michael Hanselmann | raise http.HttpBadRequest("Bad HTTP/0.9 request type (%r)" % method) |
210 | 02cab3e7 | Michael Hanselmann | |
211 | 02cab3e7 | Michael Hanselmann | else:
|
212 | 02cab3e7 | Michael Hanselmann | raise http.HttpBadRequest("Bad request syntax (%r)" % start_line) |
213 | 02cab3e7 | Michael Hanselmann | |
214 | 02cab3e7 | Michael Hanselmann | return http.HttpClientToServerStartLine(method, path, version)
|
215 | 02cab3e7 | Michael Hanselmann | |
216 | 02cab3e7 | Michael Hanselmann | |
217 | 1f8588f6 | Iustin Pop | class HttpServerRequestExecutor(object): |
218 | 02cab3e7 | Michael Hanselmann | """Implements server side of HTTP.
|
219 | 02cab3e7 | Michael Hanselmann |
|
220 | 25e7b43f | Iustin Pop | This class implements the server side of HTTP. It's based on code of
|
221 | 25e7b43f | Iustin Pop | Python's BaseHTTPServer, from both version 2.4 and 3k. It does not
|
222 | 25e7b43f | Iustin Pop | support non-ASCII character encodings. Keep-alive connections are
|
223 | 25e7b43f | Iustin Pop | not supported.
|
224 | 02cab3e7 | Michael Hanselmann |
|
225 | 02cab3e7 | Michael Hanselmann | """
|
226 | 02cab3e7 | Michael Hanselmann | # The default request version. This only affects responses up until
|
227 | 02cab3e7 | Michael Hanselmann | # the point where the request line is parsed, so it mainly decides what
|
228 | 02cab3e7 | Michael Hanselmann | # the client gets back when sending a malformed request line.
|
229 | 02cab3e7 | Michael Hanselmann | # Most web servers default to HTTP 0.9, i.e. don't send a status line.
|
230 | 02cab3e7 | Michael Hanselmann | default_request_version = http.HTTP_0_9 |
231 | 02cab3e7 | Michael Hanselmann | |
232 | 02cab3e7 | Michael Hanselmann | # Error message settings
|
233 | 02cab3e7 | Michael Hanselmann | error_message_format = DEFAULT_ERROR_MESSAGE |
234 | 02cab3e7 | Michael Hanselmann | error_content_type = DEFAULT_ERROR_CONTENT_TYPE |
235 | 02cab3e7 | Michael Hanselmann | |
236 | 02cab3e7 | Michael Hanselmann | responses = BaseHTTPServer.BaseHTTPRequestHandler.responses |
237 | 02cab3e7 | Michael Hanselmann | |
238 | 02cab3e7 | Michael Hanselmann | # Timeouts in seconds for socket layer
|
239 | 02cab3e7 | Michael Hanselmann | WRITE_TIMEOUT = 10
|
240 | 02cab3e7 | Michael Hanselmann | READ_TIMEOUT = 10
|
241 | 02cab3e7 | Michael Hanselmann | CLOSE_TIMEOUT = 1
|
242 | 02cab3e7 | Michael Hanselmann | |
243 | 02cab3e7 | Michael Hanselmann | def __init__(self, server, sock, client_addr): |
244 | 02cab3e7 | Michael Hanselmann | """Initializes this class.
|
245 | 02cab3e7 | Michael Hanselmann |
|
246 | 02cab3e7 | Michael Hanselmann | """
|
247 | 02cab3e7 | Michael Hanselmann | self.server = server
|
248 | 02cab3e7 | Michael Hanselmann | self.sock = sock
|
249 | 02cab3e7 | Michael Hanselmann | self.client_addr = client_addr
|
250 | 02cab3e7 | Michael Hanselmann | |
251 | 02cab3e7 | Michael Hanselmann | self.request_msg = http.HttpMessage()
|
252 | 02cab3e7 | Michael Hanselmann | self.response_msg = http.HttpMessage()
|
253 | 02cab3e7 | Michael Hanselmann | |
254 | 02cab3e7 | Michael Hanselmann | self.response_msg.start_line = \
|
255 | 02cab3e7 | Michael Hanselmann | http.HttpServerToClientStartLine(version=self.default_request_version,
|
256 | 02cab3e7 | Michael Hanselmann | code=None, reason=None) |
257 | 02cab3e7 | Michael Hanselmann | |
258 | 02cab3e7 | Michael Hanselmann | # Disable Python's timeout
|
259 | 02cab3e7 | Michael Hanselmann | self.sock.settimeout(None) |
260 | 02cab3e7 | Michael Hanselmann | |
261 | 02cab3e7 | Michael Hanselmann | # Operate in non-blocking mode
|
262 | 02cab3e7 | Michael Hanselmann | self.sock.setblocking(0) |
263 | 02cab3e7 | Michael Hanselmann | |
264 | 14d57a8b | Iustin Pop | logging.debug("Connection from %s:%s", client_addr[0], client_addr[1]) |
265 | 02cab3e7 | Michael Hanselmann | try:
|
266 | 02cab3e7 | Michael Hanselmann | request_msg_reader = None
|
267 | 02cab3e7 | Michael Hanselmann | force_close = True
|
268 | 02cab3e7 | Michael Hanselmann | try:
|
269 | f2e13d55 | Michael Hanselmann | # Do the secret SSL handshake
|
270 | f2e13d55 | Michael Hanselmann | if self.server.using_ssl: |
271 | f2e13d55 | Michael Hanselmann | self.sock.set_accept_state()
|
272 | f2e13d55 | Michael Hanselmann | try:
|
273 | aea0ed67 | Michael Hanselmann | http.Handshake(self.sock, self.WRITE_TIMEOUT) |
274 | f2e13d55 | Michael Hanselmann | except http.HttpSessionHandshakeUnexpectedEOF:
|
275 | f2e13d55 | Michael Hanselmann | # Ignore rest
|
276 | f2e13d55 | Michael Hanselmann | return
|
277 | f2e13d55 | Michael Hanselmann | |
278 | 02cab3e7 | Michael Hanselmann | try:
|
279 | 02cab3e7 | Michael Hanselmann | try:
|
280 | 02cab3e7 | Michael Hanselmann | request_msg_reader = self._ReadRequest()
|
281 | 200e38ac | Michael Hanselmann | |
282 | 200e38ac | Michael Hanselmann | # RFC2616, 14.23: All Internet-based HTTP/1.1 servers MUST respond
|
283 | 200e38ac | Michael Hanselmann | # with a 400 (Bad Request) status code to any HTTP/1.1 request
|
284 | 200e38ac | Michael Hanselmann | # message which lacks a Host header field.
|
285 | 200e38ac | Michael Hanselmann | if (self.request_msg.start_line.version == http.HTTP_1_1 and |
286 | 200e38ac | Michael Hanselmann | http.HTTP_HOST not in self.request_msg.headers): |
287 | 200e38ac | Michael Hanselmann | raise http.HttpBadRequest(message="Missing Host header") |
288 | 200e38ac | Michael Hanselmann | |
289 | 02cab3e7 | Michael Hanselmann | self._HandleRequest()
|
290 | 02cab3e7 | Michael Hanselmann | |
291 | 02cab3e7 | Michael Hanselmann | # Only wait for client to close if we didn't have any exception.
|
292 | 02cab3e7 | Michael Hanselmann | force_close = False
|
293 | 02cab3e7 | Michael Hanselmann | except http.HttpException, err:
|
294 | 02cab3e7 | Michael Hanselmann | self._SetErrorStatus(err)
|
295 | 02cab3e7 | Michael Hanselmann | finally:
|
296 | 02cab3e7 | Michael Hanselmann | # Try to send a response
|
297 | 02cab3e7 | Michael Hanselmann | self._SendResponse()
|
298 | 02cab3e7 | Michael Hanselmann | finally:
|
299 | aea0ed67 | Michael Hanselmann | http.ShutdownConnection(sock, self.CLOSE_TIMEOUT, self.WRITE_TIMEOUT, |
300 | 02cab3e7 | Michael Hanselmann | request_msg_reader, force_close) |
301 | 02cab3e7 | Michael Hanselmann | |
302 | 02cab3e7 | Michael Hanselmann | self.sock.close()
|
303 | 02cab3e7 | Michael Hanselmann | self.sock = None |
304 | 02cab3e7 | Michael Hanselmann | finally:
|
305 | 14d57a8b | Iustin Pop | logging.debug("Disconnected %s:%s", client_addr[0], client_addr[1]) |
306 | 02cab3e7 | Michael Hanselmann | |
307 | 02cab3e7 | Michael Hanselmann | def _ReadRequest(self): |
308 | 02cab3e7 | Michael Hanselmann | """Reads a request sent by client.
|
309 | 02cab3e7 | Michael Hanselmann |
|
310 | 02cab3e7 | Michael Hanselmann | """
|
311 | 02cab3e7 | Michael Hanselmann | try:
|
312 | 02cab3e7 | Michael Hanselmann | request_msg_reader = \ |
313 | 02cab3e7 | Michael Hanselmann | _HttpClientToServerMessageReader(self.sock, self.request_msg, |
314 | 02cab3e7 | Michael Hanselmann | self.READ_TIMEOUT)
|
315 | 02cab3e7 | Michael Hanselmann | except http.HttpSocketTimeout:
|
316 | 02cab3e7 | Michael Hanselmann | raise http.HttpError("Timeout while reading request") |
317 | 02cab3e7 | Michael Hanselmann | except socket.error, err:
|
318 | 02cab3e7 | Michael Hanselmann | raise http.HttpError("Error reading request: %s" % err) |
319 | 02cab3e7 | Michael Hanselmann | |
320 | 02cab3e7 | Michael Hanselmann | self.response_msg.start_line.version = self.request_msg.start_line.version |
321 | 02cab3e7 | Michael Hanselmann | |
322 | 02cab3e7 | Michael Hanselmann | return request_msg_reader
|
323 | 02cab3e7 | Michael Hanselmann | |
324 | 02cab3e7 | Michael Hanselmann | def _HandleRequest(self): |
325 | 02cab3e7 | Michael Hanselmann | """Calls the handler function for the current request.
|
326 | 02cab3e7 | Michael Hanselmann |
|
327 | 02cab3e7 | Michael Hanselmann | """
|
328 | a8950eb7 | Michael Hanselmann | handler_context = _HttpServerRequest(self.request_msg.start_line.method,
|
329 | a8950eb7 | Michael Hanselmann | self.request_msg.start_line.path,
|
330 | a8950eb7 | Michael Hanselmann | self.request_msg.headers,
|
331 | bb3776b4 | Michael Hanselmann | self.request_msg.body)
|
332 | 02cab3e7 | Michael Hanselmann | |
333 | d44ea6a3 | Michael Hanselmann | logging.debug("Handling request %r", handler_context)
|
334 | 02cab3e7 | Michael Hanselmann | |
335 | 02cab3e7 | Michael Hanselmann | try:
|
336 | 68fa9caf | Michael Hanselmann | try:
|
337 | 68fa9caf | Michael Hanselmann | # Authentication, etc.
|
338 | 68fa9caf | Michael Hanselmann | self.server.PreHandleRequest(handler_context)
|
339 | 68fa9caf | Michael Hanselmann | |
340 | 68fa9caf | Michael Hanselmann | # Call actual request handler
|
341 | 68fa9caf | Michael Hanselmann | result = self.server.HandleRequest(handler_context)
|
342 | 68fa9caf | Michael Hanselmann | except (http.HttpException, KeyboardInterrupt, SystemExit): |
343 | 68fa9caf | Michael Hanselmann | raise
|
344 | 68fa9caf | Michael Hanselmann | except Exception, err: |
345 | 68fa9caf | Michael Hanselmann | logging.exception("Caught exception")
|
346 | 68fa9caf | Michael Hanselmann | raise http.HttpInternalServerError(message=str(err)) |
347 | 68fa9caf | Michael Hanselmann | except:
|
348 | 68fa9caf | Michael Hanselmann | logging.exception("Unknown exception")
|
349 | 68fa9caf | Michael Hanselmann | raise http.HttpInternalServerError(message="Unknown error") |
350 | 68fa9caf | Michael Hanselmann | |
351 | ab221ddf | Michael Hanselmann | if not isinstance(result, basestring): |
352 | ab221ddf | Michael Hanselmann | raise http.HttpError("Handler function didn't return string type") |
353 | ab221ddf | Michael Hanselmann | |
354 | 68fa9caf | Michael Hanselmann | self.response_msg.start_line.code = http.HTTP_OK
|
355 | 68fa9caf | Michael Hanselmann | self.response_msg.headers = handler_context.resp_headers
|
356 | ab221ddf | Michael Hanselmann | self.response_msg.body = result
|
357 | 68fa9caf | Michael Hanselmann | finally:
|
358 | 68fa9caf | Michael Hanselmann | # No reason to keep this any longer, even for exceptions
|
359 | 68fa9caf | Michael Hanselmann | handler_context.private = None
|
360 | 02cab3e7 | Michael Hanselmann | |
361 | 02cab3e7 | Michael Hanselmann | def _SendResponse(self): |
362 | 02cab3e7 | Michael Hanselmann | """Sends the response to the client.
|
363 | 02cab3e7 | Michael Hanselmann |
|
364 | 02cab3e7 | Michael Hanselmann | """
|
365 | 02cab3e7 | Michael Hanselmann | if self.response_msg.start_line.code is None: |
366 | 02cab3e7 | Michael Hanselmann | return
|
367 | 02cab3e7 | Michael Hanselmann | |
368 | 02cab3e7 | Michael Hanselmann | if not self.response_msg.headers: |
369 | 02cab3e7 | Michael Hanselmann | self.response_msg.headers = {}
|
370 | 02cab3e7 | Michael Hanselmann | |
371 | 02cab3e7 | Michael Hanselmann | self.response_msg.headers.update({
|
372 | 02cab3e7 | Michael Hanselmann | # TODO: Keep-alive is not supported
|
373 | 02cab3e7 | Michael Hanselmann | http.HTTP_CONNECTION: "close",
|
374 | 02cab3e7 | Michael Hanselmann | http.HTTP_DATE: _DateTimeHeader(), |
375 | 02cab3e7 | Michael Hanselmann | http.HTTP_SERVER: http.HTTP_GANETI_VERSION, |
376 | 02cab3e7 | Michael Hanselmann | }) |
377 | 02cab3e7 | Michael Hanselmann | |
378 | 02cab3e7 | Michael Hanselmann | # Get response reason based on code
|
379 | 02cab3e7 | Michael Hanselmann | response_code = self.response_msg.start_line.code
|
380 | 02cab3e7 | Michael Hanselmann | if response_code in self.responses: |
381 | 02cab3e7 | Michael Hanselmann | response_reason = self.responses[response_code][0] |
382 | 02cab3e7 | Michael Hanselmann | else:
|
383 | 02cab3e7 | Michael Hanselmann | response_reason = ""
|
384 | 02cab3e7 | Michael Hanselmann | self.response_msg.start_line.reason = response_reason
|
385 | 02cab3e7 | Michael Hanselmann | |
386 | 02cab3e7 | Michael Hanselmann | logging.info("%s:%s %s %s", self.client_addr[0], self.client_addr[1], |
387 | 02cab3e7 | Michael Hanselmann | self.request_msg.start_line, response_code)
|
388 | 02cab3e7 | Michael Hanselmann | |
389 | 02cab3e7 | Michael Hanselmann | try:
|
390 | 02cab3e7 | Michael Hanselmann | _HttpServerToClientMessageWriter(self.sock, self.request_msg, |
391 | 02cab3e7 | Michael Hanselmann | self.response_msg, self.WRITE_TIMEOUT) |
392 | 02cab3e7 | Michael Hanselmann | except http.HttpSocketTimeout:
|
393 | 02cab3e7 | Michael Hanselmann | raise http.HttpError("Timeout while sending response") |
394 | 02cab3e7 | Michael Hanselmann | except socket.error, err:
|
395 | 02cab3e7 | Michael Hanselmann | raise http.HttpError("Error sending response: %s" % err) |
396 | 02cab3e7 | Michael Hanselmann | |
397 | 02cab3e7 | Michael Hanselmann | def _SetErrorStatus(self, err): |
398 | 02cab3e7 | Michael Hanselmann | """Sets the response code and body from a HttpException.
|
399 | 02cab3e7 | Michael Hanselmann |
|
400 | 02cab3e7 | Michael Hanselmann | @type err: HttpException
|
401 | 02cab3e7 | Michael Hanselmann | @param err: Exception instance
|
402 | 02cab3e7 | Michael Hanselmann |
|
403 | 02cab3e7 | Michael Hanselmann | """
|
404 | 02cab3e7 | Michael Hanselmann | try:
|
405 | 02cab3e7 | Michael Hanselmann | (shortmsg, longmsg) = self.responses[err.code]
|
406 | 02cab3e7 | Michael Hanselmann | except KeyError: |
407 | 02cab3e7 | Michael Hanselmann | shortmsg = longmsg = "Unknown"
|
408 | 02cab3e7 | Michael Hanselmann | |
409 | 02cab3e7 | Michael Hanselmann | if err.message:
|
410 | 02cab3e7 | Michael Hanselmann | message = err.message |
411 | 02cab3e7 | Michael Hanselmann | else:
|
412 | 02cab3e7 | Michael Hanselmann | message = shortmsg |
413 | 02cab3e7 | Michael Hanselmann | |
414 | 02cab3e7 | Michael Hanselmann | values = { |
415 | 02cab3e7 | Michael Hanselmann | "code": err.code,
|
416 | 02cab3e7 | Michael Hanselmann | "message": cgi.escape(message),
|
417 | 02cab3e7 | Michael Hanselmann | "explain": longmsg,
|
418 | 02cab3e7 | Michael Hanselmann | } |
419 | 02cab3e7 | Michael Hanselmann | |
420 | 02cab3e7 | Michael Hanselmann | self.response_msg.start_line.code = err.code
|
421 | a8e01e9f | Michael Hanselmann | |
422 | a8e01e9f | Michael Hanselmann | headers = {} |
423 | a8e01e9f | Michael Hanselmann | if err.headers:
|
424 | a8e01e9f | Michael Hanselmann | headers.update(err.headers) |
425 | a8e01e9f | Michael Hanselmann | headers[http.HTTP_CONTENT_TYPE] = self.error_content_type
|
426 | a8e01e9f | Michael Hanselmann | self.response_msg.headers = headers
|
427 | a8e01e9f | Michael Hanselmann | |
428 | 1f8588f6 | Iustin Pop | self.response_msg.body = self._FormatErrorMessage(values) |
429 | 02cab3e7 | Michael Hanselmann | |
430 | 1f8588f6 | Iustin Pop | def _FormatErrorMessage(self, values): |
431 | 1f8588f6 | Iustin Pop | """Formats the body of an error message.
|
432 | 1f8588f6 | Iustin Pop |
|
433 | 1f8588f6 | Iustin Pop | @type values: dict
|
434 | 1f8588f6 | Iustin Pop | @param values: dictionary with keys code, message and explain.
|
435 | 1f8588f6 | Iustin Pop | @rtype: string
|
436 | 1f8588f6 | Iustin Pop | @return: the body of the message
|
437 | 1f8588f6 | Iustin Pop |
|
438 | 1f8588f6 | Iustin Pop | """
|
439 | 1f8588f6 | Iustin Pop | return self.error_message_format % values |
440 | 02cab3e7 | Michael Hanselmann | |
441 | 57fd6d0b | Michael Hanselmann | |
442 | 112d240d | Guido Trotter | class HttpServer(http.HttpBase, asyncore.dispatcher): |
443 | 02cab3e7 | Michael Hanselmann | """Generic HTTP server class
|
444 | 02cab3e7 | Michael Hanselmann |
|
445 | 02cab3e7 | Michael Hanselmann | Users of this class must subclass it and override the HandleRequest function.
|
446 | 02cab3e7 | Michael Hanselmann |
|
447 | 02cab3e7 | Michael Hanselmann | """
|
448 | 02cab3e7 | Michael Hanselmann | MAX_CHILDREN = 20
|
449 | 02cab3e7 | Michael Hanselmann | |
450 | 02cab3e7 | Michael Hanselmann | def __init__(self, mainloop, local_address, port, |
451 | 1f8588f6 | Iustin Pop | ssl_params=None, ssl_verify_peer=False, |
452 | 1f8588f6 | Iustin Pop | request_executor_class=None):
|
453 | 02cab3e7 | Michael Hanselmann | """Initializes the HTTP server
|
454 | 02cab3e7 | Michael Hanselmann |
|
455 | 02cab3e7 | Michael Hanselmann | @type mainloop: ganeti.daemon.Mainloop
|
456 | 02cab3e7 | Michael Hanselmann | @param mainloop: Mainloop used to poll for I/O events
|
457 | c41eea6e | Iustin Pop | @type local_address: string
|
458 | 02cab3e7 | Michael Hanselmann | @param local_address: Local IP address to bind to
|
459 | 02cab3e7 | Michael Hanselmann | @type port: int
|
460 | 02cab3e7 | Michael Hanselmann | @param port: TCP port to listen on
|
461 | 02cab3e7 | Michael Hanselmann | @type ssl_params: HttpSslParams
|
462 | 02cab3e7 | Michael Hanselmann | @param ssl_params: SSL key and certificate
|
463 | 02cab3e7 | Michael Hanselmann | @type ssl_verify_peer: bool
|
464 | 25e7b43f | Iustin Pop | @param ssl_verify_peer: Whether to require client certificate
|
465 | 25e7b43f | Iustin Pop | and compare it with our certificate
|
466 | 1f8588f6 | Iustin Pop | @type request_executor_class: class
|
467 | 1f8588f6 | Iustin Pop | @param request_executor_class: an class derived from the
|
468 | 1f8588f6 | Iustin Pop | HttpServerRequestExecutor class
|
469 | 02cab3e7 | Michael Hanselmann |
|
470 | 02cab3e7 | Michael Hanselmann | """
|
471 | f4322a1e | Michael Hanselmann | http.HttpBase.__init__(self)
|
472 | 112d240d | Guido Trotter | asyncore.dispatcher.__init__(self)
|
473 | 02cab3e7 | Michael Hanselmann | |
474 | 1f8588f6 | Iustin Pop | if request_executor_class is None: |
475 | 1f8588f6 | Iustin Pop | self.request_executor = HttpServerRequestExecutor
|
476 | 1f8588f6 | Iustin Pop | else:
|
477 | 1f8588f6 | Iustin Pop | self.request_executor = request_executor_class
|
478 | 1f8588f6 | Iustin Pop | |
479 | 02cab3e7 | Michael Hanselmann | self.mainloop = mainloop
|
480 | 02cab3e7 | Michael Hanselmann | self.local_address = local_address
|
481 | 02cab3e7 | Michael Hanselmann | self.port = port
|
482 | db4e138b | Manuel Franceschini | family = netutils.IPAddress.GetAddressFamily(local_address) |
483 | db4e138b | Manuel Franceschini | self.socket = self._CreateSocket(ssl_params, ssl_verify_peer, family) |
484 | 02cab3e7 | Michael Hanselmann | |
485 | 02cab3e7 | Michael Hanselmann | # Allow port to be reused
|
486 | 02cab3e7 | Michael Hanselmann | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
487 | 02cab3e7 | Michael Hanselmann | |
488 | 02cab3e7 | Michael Hanselmann | self._children = []
|
489 | 112d240d | Guido Trotter | self.set_socket(self.socket) |
490 | 112d240d | Guido Trotter | self.accepting = True |
491 | 02cab3e7 | Michael Hanselmann | mainloop.RegisterSignal(self)
|
492 | 02cab3e7 | Michael Hanselmann | |
493 | 02cab3e7 | Michael Hanselmann | def Start(self): |
494 | 02cab3e7 | Michael Hanselmann | self.socket.bind((self.local_address, self.port)) |
495 | 59305197 | Michael Hanselmann | self.socket.listen(1024) |
496 | 02cab3e7 | Michael Hanselmann | |
497 | 02cab3e7 | Michael Hanselmann | def Stop(self): |
498 | 02cab3e7 | Michael Hanselmann | self.socket.close()
|
499 | 02cab3e7 | Michael Hanselmann | |
500 | 112d240d | Guido Trotter | def handle_accept(self): |
501 | 112d240d | Guido Trotter | self._IncomingConnection()
|
502 | 02cab3e7 | Michael Hanselmann | |
503 | 02cab3e7 | Michael Hanselmann | def OnSignal(self, signum): |
504 | 02cab3e7 | Michael Hanselmann | if signum == signal.SIGCHLD:
|
505 | 02cab3e7 | Michael Hanselmann | self._CollectChildren(True) |
506 | 02cab3e7 | Michael Hanselmann | |
507 | 02cab3e7 | Michael Hanselmann | def _CollectChildren(self, quick): |
508 | 02cab3e7 | Michael Hanselmann | """Checks whether any child processes are done
|
509 | 02cab3e7 | Michael Hanselmann |
|
510 | 02cab3e7 | Michael Hanselmann | @type quick: bool
|
511 | 02cab3e7 | Michael Hanselmann | @param quick: Whether to only use non-blocking functions
|
512 | 02cab3e7 | Michael Hanselmann |
|
513 | 02cab3e7 | Michael Hanselmann | """
|
514 | 02cab3e7 | Michael Hanselmann | if not quick: |
515 | 02cab3e7 | Michael Hanselmann | # Don't wait for other processes if it should be a quick check
|
516 | 02cab3e7 | Michael Hanselmann | while len(self._children) > self.MAX_CHILDREN: |
517 | 02cab3e7 | Michael Hanselmann | try:
|
518 | 02cab3e7 | Michael Hanselmann | # Waiting without a timeout brings us into a potential DoS situation.
|
519 | 02cab3e7 | Michael Hanselmann | # As soon as too many children run, we'll not respond to new
|
520 | 02cab3e7 | Michael Hanselmann | # requests. The real solution would be to add a timeout for children
|
521 | 02cab3e7 | Michael Hanselmann | # and killing them after some time.
|
522 | 7c4d6c7b | Michael Hanselmann | pid, _ = os.waitpid(0, 0) |
523 | 02cab3e7 | Michael Hanselmann | except os.error:
|
524 | 02cab3e7 | Michael Hanselmann | pid = None
|
525 | 02cab3e7 | Michael Hanselmann | if pid and pid in self._children: |
526 | 02cab3e7 | Michael Hanselmann | self._children.remove(pid)
|
527 | 02cab3e7 | Michael Hanselmann | |
528 | 02cab3e7 | Michael Hanselmann | for child in self._children: |
529 | 02cab3e7 | Michael Hanselmann | try:
|
530 | 1122eb25 | Iustin Pop | pid, _ = os.waitpid(child, os.WNOHANG) |
531 | 02cab3e7 | Michael Hanselmann | except os.error:
|
532 | 02cab3e7 | Michael Hanselmann | pid = None
|
533 | 02cab3e7 | Michael Hanselmann | if pid and pid in self._children: |
534 | 02cab3e7 | Michael Hanselmann | self._children.remove(pid)
|
535 | 02cab3e7 | Michael Hanselmann | |
536 | 02cab3e7 | Michael Hanselmann | def _IncomingConnection(self): |
537 | 02cab3e7 | Michael Hanselmann | """Called for each incoming connection
|
538 | 02cab3e7 | Michael Hanselmann |
|
539 | 02cab3e7 | Michael Hanselmann | """
|
540 | 7260cfbe | Iustin Pop | # pylint: disable-msg=W0212
|
541 | 02cab3e7 | Michael Hanselmann | (connection, client_addr) = self.socket.accept()
|
542 | 02cab3e7 | Michael Hanselmann | |
543 | 02cab3e7 | Michael Hanselmann | self._CollectChildren(False) |
544 | 02cab3e7 | Michael Hanselmann | |
545 | 02cab3e7 | Michael Hanselmann | pid = os.fork() |
546 | 02cab3e7 | Michael Hanselmann | if pid == 0: |
547 | 02cab3e7 | Michael Hanselmann | # Child process
|
548 | 02cab3e7 | Michael Hanselmann | try:
|
549 | bcb1a39e | Michael Hanselmann | # The client shouldn't keep the listening socket open. If the parent
|
550 | bcb1a39e | Michael Hanselmann | # process is restarted, it would fail when there's already something
|
551 | bcb1a39e | Michael Hanselmann | # listening (in this case its own child from a previous run) on the
|
552 | bcb1a39e | Michael Hanselmann | # same port.
|
553 | bcb1a39e | Michael Hanselmann | try:
|
554 | bcb1a39e | Michael Hanselmann | self.socket.close()
|
555 | bcb1a39e | Michael Hanselmann | except socket.error:
|
556 | bcb1a39e | Michael Hanselmann | pass
|
557 | bcb1a39e | Michael Hanselmann | self.socket = None |
558 | bcb1a39e | Michael Hanselmann | |
559 | 82869978 | Michael Hanselmann | # In case the handler code uses temporary files
|
560 | 82869978 | Michael Hanselmann | utils.ResetTempfileModule() |
561 | 82869978 | Michael Hanselmann | |
562 | 1f8588f6 | Iustin Pop | self.request_executor(self, connection, client_addr) |
563 | 7260cfbe | Iustin Pop | except Exception: # pylint: disable-msg=W0703 |
564 | 02cab3e7 | Michael Hanselmann | logging.exception("Error while handling request from %s:%s",
|
565 | 02cab3e7 | Michael Hanselmann | client_addr[0], client_addr[1]) |
566 | 02cab3e7 | Michael Hanselmann | os._exit(1)
|
567 | 02cab3e7 | Michael Hanselmann | os._exit(0)
|
568 | 02cab3e7 | Michael Hanselmann | else:
|
569 | 02cab3e7 | Michael Hanselmann | self._children.append(pid)
|
570 | 02cab3e7 | Michael Hanselmann | |
571 | f8bd7df3 | Michael Hanselmann | def PreHandleRequest(self, req): |
572 | f8bd7df3 | Michael Hanselmann | """Called before handling a request.
|
573 | f8bd7df3 | Michael Hanselmann |
|
574 | 5bbd3f7f | Michael Hanselmann | Can be overridden by a subclass.
|
575 | f8bd7df3 | Michael Hanselmann |
|
576 | f8bd7df3 | Michael Hanselmann | """
|
577 | f8bd7df3 | Michael Hanselmann | |
578 | 02cab3e7 | Michael Hanselmann | def HandleRequest(self, req): |
579 | 02cab3e7 | Michael Hanselmann | """Handles a request.
|
580 | 02cab3e7 | Michael Hanselmann |
|
581 | 5bbd3f7f | Michael Hanselmann | Must be overridden by subclass.
|
582 | 02cab3e7 | Michael Hanselmann |
|
583 | 02cab3e7 | Michael Hanselmann | """
|
584 | 02cab3e7 | Michael Hanselmann | raise NotImplementedError() |