Blame - Lib/http/server.py - platform/external/python/cpython3

2008-05-26 16:32:26 +0000

[diff] [blame]

1

"""HTTP server classes.

2

3

Note: BaseHTTPRequestHandler doesn't implement any HTTP request; see

4

SimpleHTTPRequestHandler for simple implementations of GET, HEAD and POST,

5

and CGIHTTPRequestHandler for CGI scripts.

6

7

It does, however, optionally implement HTTP/1.1 persistent connections,

8

as of version 0.3.

9

10

Notes on CGIHTTPRequestHandler

11

------------------------------

12

13

This class implements GET and POST requests to cgi-bin scripts.

14

15

If the os.fork() function is not present (e.g. on Windows),

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

16

subprocess.Popen() is used as a fallback, with slightly altered semantics.

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

17

18

In all cases, the implementation is intentionally naive -- all

19

requests are executed synchronously.

20

21

SECURITY WARNING: DON'T USE THIS CODE UNLESS YOU ARE INSIDE A FIREWALL

22

-- it may execute arbitrary Python code or external programs.

23

24

Note that status code 200 is sent prior to execution of a CGI script, so

25

scripts cannot send other status codes such as 302 (redirect).

XXX To do:

- log requests even later (to capture byte count)

30

- log user-agent header and other interesting goodies

31

- send error log to separate file

"""

# See also:

#

# HTTP Working Group T. Berners-Lee

38

# INTERNET-DRAFT R. T. Fielding

39

# <draft-ietf-http-v10-spec-00.txt> H. Frystyk Nielsen

40

# Expires September 8, 1995 March 8, 1995

41

#

42

# URL: http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-v10-spec-00.txt

#

# and

#

# Network Working Group R. Fielding

47

# Request for Comments: 2616 et al

48

# Obsoletes: 2068 June 1999

49

# Category: Standards Track

50

#

51

# URL: http://www.faqs.org/rfcs/rfc2616.html

# Log files

# ---------

#

# Here's a quote from the NCSA httpd docs about log file format.

57

#

58

# | The logfile format is as follows. Each line consists of:

59

# |

60

# | host rfc931 authuser [DD/Mon/YYYY:hh:mm:ss] "request" ddd bbbb

61

# |

62

# | host: Either the DNS name or the IP number of the remote client

63

# | rfc931: Any information returned by identd for this person,

64

# | - otherwise.

65

# | authuser: If user sent a userid for authentication, the user name,

66

# | - otherwise.

67

# | DD: Day

68

# | Mon: Month (calendar name)

69

# | YYYY: Year

70

# | hh: hour (24-hour format, the machine's timezone)

71

# | mm: minutes

72

# | ss: seconds

73

# | request: The first line of the HTTP request as sent by the client.

74

# | ddd: the status code returned by the server, - if not available.

75

# | bbbb: the total number of bytes sent,

76

# | *not including the HTTP/1.0 header*, - if not available

77

# |

78

# | You can determine the name of the file accessed through request.

79

#

80

# (Actually, the latter is only true if you know the server configuration

81

# at the time the request was made!)

__version__ = "0.6"

Berker Peksag

2015-02-13 20:48:15 +0200

[diff] [blame]

85

__all__ = [

Julien Palard

4f53e2a

2018-05-30 02:24:17 +0200

[diff] [blame]

86

"HTTPServer", "ThreadingHTTPServer", "BaseHTTPRequestHandler",

Berker Peksag

366c570

2015-02-13 20:48:15 +0200

[diff] [blame]

87

"SimpleHTTPRequestHandler", "CGIHTTPRequestHandler",

88

]

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

89

Pierre Quentel

2017-04-02 12:26:12 +0200

[diff] [blame]

90

import copy

91

import datetime

Berker Peksag

04bc5b9

2016-03-14 06:06:03 +0200

[diff] [blame]

92

import email.utils

Georg Brandl

1f7fffb

2010-10-15 15:57:45 +0000

[diff] [blame]

93

import html

Jeremy Hylton

914ab45

2009-03-27 17:16:06 +0000

[diff] [blame]

import http.client

import io

import mimetypes

import os

import posixpath

import select

import shutil

import socket # For gethostbyaddr()

import socketserver

import sys

import time

import urllib.parse

Stéphane Wirtel

2017-05-24 09:29:06 +0200

[diff] [blame]

106

from functools import partial

Senthil Kumaran

2012-06-03 16:15:54 +0800

[diff] [blame]

107

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

108

from http import HTTPStatus

109

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

110

111

# Default error message template

112

DEFAULT_ERROR_MESSAGE = """\

Senthil Kumaran

1b407fe

2011-03-20 10:44:30 +0800

[diff] [blame]

113

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"

114

"http://www.w3.org/TR/html4/strict.dtd">

Ezio Melotti

2011-11-02 19:33:29 +0200

[diff] [blame]

115

<html>

Senthil Kumaran

b253c9f

2011-03-17 16:43:22 +0800

[diff] [blame]

116

<head>

Senthil Kumaran

1b407fe

2011-03-20 10:44:30 +0800

[diff] [blame]

117

Senthil Kumaran

b253c9f

2011-03-17 16:43:22 +0800

[diff] [blame]

118

<title>Error response</title>

119

</head>

120

<body>

121

<h1>Error response</h1>

122

<p>Error code: %(code)d</p>

123

<p>Message: %(message)s.</p>

124

<p>Error code explanation: %(code)s - %(explain)s.</p>

125

</body>

126

</html>

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

127

"""

128

129

DEFAULT_ERROR_CONTENT_TYPE = "text/html;charset=utf-8"

130

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

131

class HTTPServer(socketserver.TCPServer):

132

133

allow_reuse_address = 1 # Seems to make sense in testing environment

134

135

def server_bind(self):

136

"""Override server_bind to store the server name."""

137

socketserver.TCPServer.server_bind(self)

Martin Panter

2016-04-03 01:28:53 +0000

[diff] [blame]

138

host, port = self.server_address[:2]

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

139

self.server_name = socket.getfqdn(host)

140

self.server_port = port

141

142

Julien Palard

4f53e2a

2018-05-30 02:24:17 +0200

[diff] [blame]

143

class ThreadingHTTPServer(socketserver.ThreadingMixIn, HTTPServer):

Miss Islington (bot)

f8d2c3c

2018-03-23 13:31:20 -0700

[diff] [blame]

144

daemon_threads = True

145

146

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

147

class BaseHTTPRequestHandler(socketserver.StreamRequestHandler):

148

149

"""HTTP request handler base class.

150

151

The following explanation of HTTP serves to guide you through the

152

code as well as to expose any misunderstandings I may have about

153

HTTP (so you don't need to read the code to figure out I'm wrong

154

:-).

155

156

HTTP (HyperText Transfer Protocol) is an extensible protocol on

157

top of a reliable stream transport (e.g. TCP/IP). The protocol

158

recognizes three parts to a request:

159

160

1. One line identifying the request type and path

161

2. An optional set of RFC-822-style headers

162

3. An optional data part

163

164

The headers and data are separated by a blank line.

165

166

The first line of the request has the form

where <command> is a (case-sensitive) keyword such as GET or POST,

171

<path> is a string containing path information for the request,

172

and <version> should be the string "HTTP/1.0" or "HTTP/1.1".

173

<path> is encoded using the URL encoding scheme (using %xx to signify

174

the ASCII character with hex code xx).

175

176

The specification specifies that lines are separated by CRLF but

177

for compatibility with the widest range of clients recommends

178

servers also handle LF. Similarly, whitespace in the request line

179

is treated sensibly (allowing multiple spaces between components

180

and allowing trailing whitespace).

181

182

Similarly, for output, lines ought to be separated by CRLF pairs

183

but most clients grok LF characters just fine.

184

185

If the first line of the request has the form

(i.e. <version> is left out) then this is assumed to be an HTTP

190

0.9 request; this form has no optional headers and data part and

191

the reply consists of just the data.

192

193

The reply form of the HTTP 1.x protocol again has three parts:

194

195

1. One line giving the response code

196

2. An optional set of RFC-822-style headers

197

3. The data

198

199

Again, the headers and data are separated by a blank line.

200

201

The response code line has the form

where <version> is the protocol version ("HTTP/1.0" or "HTTP/1.1"),

206

<responsecode> is a 3-digit response code indicating success or

207

failure of the request, and <responsestring> is an optional

208

human-readable string explaining what the response code means.

209

210

This server parses the request and the headers, and then calls a

211

function specific to the request type (<command>). Specifically,

212

a request SPAM will be handled by a method do_SPAM(). If no

213

such method exists the server sends an error response to the

214

client. If it exists, it is called with no arguments:

do_SPAM()

Note that the request name is case sensitive (i.e. SPAM and spam

219

are different requests).

220

221

The various request details are stored in instance variables:

222

223

- client_address is the client IP address in the form (host,

224

port);

225

226

- command, path and version are the broken-down request line;

227

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

228

- headers is an instance of email.message.Message (or a derived

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

229

class) containing the header information;

230

231

- rfile is a file object open for reading positioned at the

232

start of the optional input data part;

233

234

- wfile is a file object open for writing.

235

236

IT IS IMPORTANT TO ADHERE TO THE PROTOCOL FOR WRITING!

237

238

The first thing to be written must be the response line. Then

239

follow 0 or more header lines, then a blank line, and then the

240

actual data (if any). The meaning of the header lines depends on

241

the command executed by the server; in most cases, when data is

242

returned, there should be at least one header line of the form

243

244

Content-type: <type>/<subtype>

245

246

where <type> and <subtype> should be registered MIME types,

247

e.g. "text/html" or "text/plain".

"""

# The Python system version, truncated to its first component.

252

sys_version = "Python/" + sys.version.split()[0]

253

254

# The server software version. You may want to override this.

255

# The format is multiple whitespace-separated strings,

256

# where each string is of the form name[/version].

257

server_version = "BaseHTTP/" + __version__

258

259

error_message_format = DEFAULT_ERROR_MESSAGE

260

error_content_type = DEFAULT_ERROR_CONTENT_TYPE

261

262

# The default request version. This only affects responses up until

263

# the point where the request line is parsed, so it mainly decides what

264

# the client gets back when sending a malformed request line.

265

# Most web servers default to HTTP 0.9, i.e. don't send a status line.

266

default_request_version = "HTTP/0.9"

267

268

def parse_request(self):

269

"""Parse a request (internal).

270

271

The request should be stored in self.raw_requestline; the results

272

are in self.command, self.path, self.request_version and

273

self.headers.

274

Martin Panter

2016-11-19 01:06:37 +0000

[diff] [blame]

275

Return True for success, False for failure; on failure, any relevant

276

error response has already been sent back.

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

277

278

"""

279

self.command = None # set in case of error on the first line

280

self.request_version = version = self.default_request_version

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

281

self.close_connection = True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

282

requestline = str(self.raw_requestline, 'iso-8859-1')

Senthil Kumaran

3075549

2011-12-23 17:03:41 +0800

[diff] [blame]

283

requestline = requestline.rstrip('\r\n')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

284

self.requestline = requestline

285

words = requestline.split()

Martin Panter

2016-11-19 01:06:37 +0000

[diff] [blame]

if len(words) == 0:

return False

if len(words) >= 3: # Enough to determine protocol version

290

version = words[-1]

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

291

try:

Martin Panter

2016-11-19 01:06:37 +0000

[diff] [blame]

292

if not version.startswith('HTTP/'):

Martin Panter

2016-04-03 01:28:53 +0000

[diff] [blame]

293

raise ValueError

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

294

base_version_number = version.split('/', 1)[1]

295

version_number = base_version_number.split(".")

296

# RFC 2145 section 3.1 says there can be only one "." and

297

# - major and minor numbers MUST be treated as

298

# separate integers;

299

# - HTTP/2.4 is a lower version than HTTP/2.13, which in

300

# turn is lower than HTTP/12.3;

301

# - Leading zeros MUST be ignored by recipients.

302

if len(version_number) != 2:

303

raise ValueError

304

version_number = int(version_number[0]), int(version_number[1])

305

except (ValueError, IndexError):

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

306

self.send_error(

307

HTTPStatus.BAD_REQUEST,

308

"Bad request version (%r)" % version)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

309

return False

310

if version_number >= (1, 1) and self.protocol_version >= "HTTP/1.1":

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

311

self.close_connection = False

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

312

if version_number >= (2, 0):

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

313

self.send_error(

314

HTTPStatus.HTTP_VERSION_NOT_SUPPORTED,

Martin Panter

2016-04-03 01:28:53 +0000

[diff] [blame]

315

"Invalid HTTP version (%s)" % base_version_number)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

316

return False

Martin Panter

2016-11-19 01:06:37 +0000

[diff] [blame]

317

self.request_version = version

318

319

if not 2 <= len(words) <= 3:

320

self.send_error(

321

HTTPStatus.BAD_REQUEST,

322

"Bad request syntax (%r)" % requestline)

323

return False

324

command, path = words[:2]

325

if len(words) == 2:

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

326

self.close_connection = True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

327

if command != 'GET':

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

328

self.send_error(

329

HTTPStatus.BAD_REQUEST,

330

"Bad HTTP/0.9 request type (%r)" % command)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

331

return False

Martin Panter

2016-11-19 01:06:37 +0000

[diff] [blame]

332

self.command, self.path = command, path

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

333

334

# Examine the headers and look for a Connection directive.

Senthil Kumaran

5466bf1

2010-12-18 16:55:23 +0000

[diff] [blame]

335

try:

336

self.headers = http.client.parse_headers(self.rfile,

337

_class=self.MessageClass)

Martin Panter

2016-04-03 01:28:53 +0000

[diff] [blame]

338

except http.client.LineTooLong as err:

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

339

self.send_error(

Martin Panter

2016-04-03 01:28:53 +0000

[diff] [blame]

340

HTTPStatus.REQUEST_HEADER_FIELDS_TOO_LARGE,

341

"Line too long",

342

str(err))

Senthil Kumaran

5466bf1

2010-12-18 16:55:23 +0000

[diff] [blame]

343

return False

Martin Panter

acc0319

2016-04-03 00:45:46 +0000

[diff] [blame]

344

except http.client.HTTPException as err:

345

self.send_error(

346

HTTPStatus.REQUEST_HEADER_FIELDS_TOO_LARGE,

"Too many headers",

str(err)

)

return False

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

351

352

conntype = self.headers.get('Connection', "")

353

if conntype.lower() == 'close':

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

354

self.close_connection = True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

355

elif (conntype.lower() == 'keep-alive' and

356

self.protocol_version >= "HTTP/1.1"):

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

357

self.close_connection = False

Senthil Kumaran

0f476d4

2010-09-30 06:09:18 +0000

[diff] [blame]

358

# Examine the headers and look for an Expect directive

359

expect = self.headers.get('Expect', "")

360

if (expect.lower() == "100-continue" and

361

self.protocol_version >= "HTTP/1.1" and

362

self.request_version >= "HTTP/1.1"):

363

if not self.handle_expect_100():

return False

return True

def handle_expect_100(self):

368

"""Decide what to do with an "Expect: 100-continue" header.

369

370

If the client is expecting a 100 Continue response, we must

371

respond with either a 100 Continue or a final response before

372

waiting for the request body. The default is to always respond

373

with a 100 Continue. You can behave differently (for example,

374

reject unauthorized requests) by overriding this method.

375

376

This method should either return True (possibly after sending

377

a 100 Continue response) or send an error response and return

378

False.

379

380

"""

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

381

self.send_response_only(HTTPStatus.CONTINUE)

Benjamin Peterson

0442423

2014-01-18 21:50:18 -0500

[diff] [blame]

382

self.end_headers()

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

383

return True

384

385

def handle_one_request(self):

386

"""Handle a single HTTP request.

387

388

You normally don't need to override this method; see the class

389

__doc__ string for information on how to handle specific HTTP

390

commands such as GET and POST.

391

392

"""

Kristján Valur Jónsson

2009-07-01 10:01:31 +0000

[diff] [blame]

393

try:

Antoine Pitrou

c492437

2010-12-16 16:48:36 +0000

[diff] [blame]

394

self.raw_requestline = self.rfile.readline(65537)

395

if len(self.raw_requestline) > 65536:

396

self.requestline = ''

397

self.request_version = ''

398

self.command = ''

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

399

self.send_error(HTTPStatus.REQUEST_URI_TOO_LONG)

Antoine Pitrou

c492437

2010-12-16 16:48:36 +0000

[diff] [blame]

400

return

Kristján Valur Jónsson

2009-07-01 10:01:31 +0000

[diff] [blame]

401

if not self.raw_requestline:

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

402

self.close_connection = True

Kristján Valur Jónsson

2009-07-01 10:01:31 +0000

[diff] [blame]

403

return

404

if not self.parse_request():

405

# An error code has been sent, just exit

406

return

407

mname = 'do_' + self.command

408

if not hasattr(self, mname):

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

409

self.send_error(

410

HTTPStatus.NOT_IMPLEMENTED,

411

"Unsupported method (%r)" % self.command)

Kristján Valur Jónsson

2009-07-01 10:01:31 +0000

[diff] [blame]

412

return

413

method = getattr(self, mname)

414

method()

415

self.wfile.flush() #actually send the response if not already done.

416

except socket.timeout as e:

417

#a read or a write timed out. Discard this connection

418

self.log_error("Request timed out: %r", e)

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

419

self.close_connection = True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

420

return

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

421

422

def handle(self):

423

"""Handle multiple requests if necessary."""

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

424

self.close_connection = True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

425

426

self.handle_one_request()

427

while not self.close_connection:

428

self.handle_one_request()

429

Senthil Kumaran

2688644

2013-03-15 07:53:21 -0700

[diff] [blame]

430

def send_error(self, code, message=None, explain=None):

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

431

"""Send and log an error reply.

432

Senthil Kumaran

2688644

2013-03-15 07:53:21 -0700

[diff] [blame]

433

Arguments are

434

* code: an HTTP error code

435

3 digits

436

* message: a simple optional 1 line reason phrase.

437

*( HTAB / SP / VCHAR / %x80-FF )

438

defaults to short entry matching the response code

439

* explain: a detailed message defaults to the long entry

440

matching the response code.

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

441

442

This sends an error response (so it must be called before any

443

output has been generated), logs the error, and finally sends

444

a piece of HTML explaining the error to the user.

"""

try:

shortmsg, longmsg = self.responses[code]

450

except KeyError:

451

shortmsg, longmsg = '???', '???'

452

if message is None:

453

message = shortmsg

Senthil Kumaran

2688644

2013-03-15 07:53:21 -0700

[diff] [blame]

454

if explain is None:

455

explain = longmsg

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

456

self.log_error("code %d, message %s", code, message)

Senthil Kumaran

1e7551d

2013-03-05 02:25:58 -0800

[diff] [blame]

457

self.send_response(code, message)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

458

self.send_header('Connection', 'close')

Martin Panter

e42e129

2016-06-08 08:29:13 +0000

[diff] [blame]

459

460

# Message body is omitted for cases described in:

461

# - RFC7230: 3.3. 1xx, 204(No Content), 304(Not Modified)

462

# - RFC7231: 6.3.6. 205(Reset Content)

463

body = None

464

if (code >= 200 and

465

code not in (HTTPStatus.NO_CONTENT,

466

HTTPStatus.RESET_CONTENT,

467

HTTPStatus.NOT_MODIFIED)):

468

# HTML encode to prevent Cross Site Scripting attacks

469

# (see bug #1100201)

470

content = (self.error_message_format % {

471

'code': code,

Martin Panter

40de69a

2016-06-08 09:45:58 +0000

[diff] [blame]

472

'message': html.escape(message, quote=False),

473

'explain': html.escape(explain, quote=False)

Martin Panter

e42e129

2016-06-08 08:29:13 +0000

[diff] [blame]

474

})

475

body = content.encode('UTF-8', 'replace')

476

self.send_header("Content-Type", self.error_content_type)

Miss Islington (bot)

53d1e9f

2018-06-18 14:37:56 -0700

[diff] [blame]

477

self.send_header('Content-Length', str(len(body)))

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

478

self.end_headers()

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

479

Martin Panter

e42e129

2016-06-08 08:29:13 +0000

[diff] [blame]

480

if self.command != 'HEAD' and body:

Senthil Kumaran

52d2720

2012-10-10 23:16:21 -0700

[diff] [blame]

481

self.wfile.write(body)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

482

483

def send_response(self, code, message=None):

Senthil Kumaran

2011-05-09 23:25:02 +0800

[diff] [blame]

484

"""Add the response header to the headers buffer and log the

485

response code.

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

486

487

Also send two standard headers with the server software

488

version and the current date.

489

490

"""

491

self.log_request(code)

Senthil Kumaran

0f476d4

2010-09-30 06:09:18 +0000

[diff] [blame]

492

self.send_response_only(code, message)

493

self.send_header('Server', self.version_string())

494

self.send_header('Date', self.date_time_string())

495

496

def send_response_only(self, code, message=None):

497

"""Send the response header only."""

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

498

if self.request_version != 'HTTP/0.9':

Martin Panter

2016-04-03 01:28:53 +0000

[diff] [blame]

499

if message is None:

500

if code in self.responses:

501

message = self.responses[code][0]

502

else:

503

message = ''

Senthil Kumaran

2011-05-09 23:25:02 +0800

[diff] [blame]

504

if not hasattr(self, '_headers_buffer'):

505

self._headers_buffer = []

506

self._headers_buffer.append(("%s %d %s\r\n" %

507

(self.protocol_version, code, message)).encode(

508

'latin-1', 'strict'))

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

509

510

def send_header(self, keyword, value):

Senthil Kumaran

2011-05-09 23:25:02 +0800

[diff] [blame]

511

"""Send a MIME header to the headers buffer."""

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

512

if self.request_version != 'HTTP/0.9':

Senthil Kumaran

e4dad4f

2010-11-21 14:36:14 +0000

[diff] [blame]

513

if not hasattr(self, '_headers_buffer'):

514

self._headers_buffer = []

515

self._headers_buffer.append(

Marc-André Lemburg

8f36af7

2011-02-25 15:42:01 +0000

[diff] [blame]

516

("%s: %s\r\n" % (keyword, value)).encode('latin-1', 'strict'))

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

517

518

if keyword.lower() == 'connection':

519

if value.lower() == 'close':

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

520

self.close_connection = True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

521

elif value.lower() == 'keep-alive':

Benjamin Peterson

2015-02-17 21:11:10 -0500

[diff] [blame]

522

self.close_connection = False

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

523

524

def end_headers(self):

525

"""Send the blank line ending the MIME headers."""

526

if self.request_version != 'HTTP/0.9':

Senthil Kumaran

e4dad4f

2010-11-21 14:36:14 +0000

[diff] [blame]

527

self._headers_buffer.append(b"\r\n")

Senthil Kumaran

2011-05-09 23:25:02 +0800

[diff] [blame]

528

self.flush_headers()

529

530

def flush_headers(self):

531

if hasattr(self, '_headers_buffer'):

Senthil Kumaran

e4dad4f

2010-11-21 14:36:14 +0000

[diff] [blame]

532

self.wfile.write(b"".join(self._headers_buffer))

533

self._headers_buffer = []

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

534

535

def log_request(self, code='-', size='-'):

536

"""Log an accepted request.

537

538

This is called by send_response().

539

540

"""

Serhiy Storchaka

c0a23e6

2015-03-07 11:51:37 +0200

[diff] [blame]

541

if isinstance(code, HTTPStatus):

542

code = code.value

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

543

self.log_message('"%s" %s %s',

544

self.requestline, str(code), str(size))

545

546

def log_error(self, format, *args):

547

"""Log an error.

548

549

This is called when a request cannot be fulfilled. By

550

default it passes the message on to log_message().

551

552

Arguments are the same as for log_message().

553

554

XXX This should go to the separate error log.

"""

self.log_message(format, *args)

559

560

def log_message(self, format, *args):

561

"""Log an arbitrary message.

562

563

This is used by all other logging functions. Override

564

it if you have specific logging wishes.

565

566

The first argument, FORMAT, is a format string for the

567

message to be logged. If the format string contains

568

any % escapes requiring parameters, they should be

569

specified as subsequent arguments (it's just like

570

printf!).

571

Senthil Kumaran

db727b4

2012-04-29 13:41:03 +0800

[diff] [blame]

572

The client ip and current date/time are prefixed to

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

every message.

"""

sys.stderr.write("%s - - [%s] %s\n" %

578

(self.address_string(),

579

self.log_date_time_string(),

580

format%args))

581

582

def version_string(self):

583

"""Return the server software version string."""

584

return self.server_version + ' ' + self.sys_version

585

586

def date_time_string(self, timestamp=None):

587

"""Return the current date and time formatted for a message header."""

588

if timestamp is None:

589

timestamp = time.time()

Berker Peksag

04bc5b9

2016-03-14 06:06:03 +0200

[diff] [blame]

590

return email.utils.formatdate(timestamp, usegmt=True)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

591

592

def log_date_time_string(self):

593

"""Return the current time formatted for logging."""

594

now = time.time()

595

year, month, day, hh, mm, ss, x, y, z = time.localtime(now)

596

s = "%02d/%3s/%04d %02d:%02d:%02d" % (

597

day, self.monthname[month], year, hh, mm, ss)

598

return s

599

600

weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']

601

602

monthname = [None,

603

'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',

604

'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']

605

606

def address_string(self):

Senthil Kumaran

1aacba4

2012-04-29 12:51:54 +0800

[diff] [blame]

607

"""Return the client address."""

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

608

Senthil Kumaran

1aacba4

2012-04-29 12:51:54 +0800

[diff] [blame]

609

return self.client_address[0]

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

610

611

# Essentially static class variables

612

613

# The version of the HTTP protocol we support.

614

# Set this to HTTP/1.1 to enable automatic keepalive

615

protocol_version = "HTTP/1.0"

616

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

617

# MessageClass used to parse headers

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

618

MessageClass = http.client.HTTPMessage

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

619

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

620

# hack to maintain backwards compatibility

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

621

responses = {

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

622

v: (v.phrase, v.description)

623

for v in HTTPStatus.__members__.values()

624

}

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

625

626

627

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):

628

629

"""Simple HTTP request handler with GET and HEAD commands.

630

631

This serves files from the current directory and any of its

632

subdirectories. The MIME type for files is determined by

633

calling the .guess_type() method.

634

635

The GET and HEAD requests are identical except that the HEAD

636

request omits the actual contents of the file.

"""

server_version = "SimpleHTTP/" + __version__

641

Stéphane Wirtel

2017-05-24 09:29:06 +0200

[diff] [blame]

642

def __init__(self, *args, directory=None, **kwargs):

643

if directory is None:

644

directory = os.getcwd()

645

self.directory = directory

646

super().__init__(*args, **kwargs)

647

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

648

def do_GET(self):

649

"""Serve a GET request."""

650

f = self.send_head()

651

if f:

Serhiy Storchaka

2014-01-25 19:43:02 +0200

[diff] [blame]

652

try:

653

self.copyfile(f, self.wfile)

654

finally:

655

f.close()

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

656

657

def do_HEAD(self):

658

"""Serve a HEAD request."""

f = self.send_head()

if f:

f.close()

def send_head(self):

"""Common code for GET and HEAD commands.

665

666

This sends the response code and MIME headers.

667

668

Return value is either a file object (which has to be copied

669

to the outputfile by the caller unless the command was HEAD,

670

and must be closed by the caller under all circumstances), or

671

None, in which case the caller has nothing further to do.

672

673

"""

674

path = self.translate_path(self.path)

675

f = None

676

if os.path.isdir(path):

Benjamin Peterson

94cb7a2

2014-12-26 10:53:43 -0600

[diff] [blame]

677

parts = urllib.parse.urlsplit(self.path)

678

if not parts.path.endswith('/'):

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

679

# redirect browser - doing basically what apache does

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

680

self.send_response(HTTPStatus.MOVED_PERMANENTLY)

Benjamin Peterson

94cb7a2

2014-12-26 10:53:43 -0600

[diff] [blame]

681

new_parts = (parts[0], parts[1], parts[2] + '/',

682

parts[3], parts[4])

683

new_url = urllib.parse.urlunsplit(new_parts)

684

self.send_header("Location", new_url)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

685

self.end_headers()

686

return None

687

for index in "index.html", "index.htm":

688

index = os.path.join(path, index)

689

if os.path.exists(index):

path = index

break

else:

return self.list_directory(path)

694

ctype = self.guess_type(path)

695

try:

696

f = open(path, 'rb')

Andrew Svetlov

f7a17b4

2012-12-25 16:47:37 +0200

[diff] [blame]

697

except OSError:

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

698

self.send_error(HTTPStatus.NOT_FOUND, "File not found")

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

699

return None

Pierre Quentel

2017-04-02 12:26:12 +0200

[diff] [blame]

700

Serhiy Storchaka

2014-01-25 19:43:02 +0200

[diff] [blame]

701

try:

Pierre Quentel

2017-04-02 12:26:12 +0200

[diff] [blame]

702

fs = os.fstat(f.fileno())

703

# Use browser cache if possible

704

if ("If-Modified-Since" in self.headers

705

and "If-None-Match" not in self.headers):

706

# compare If-Modified-Since and time of last file modification

707

try:

708

ims = email.utils.parsedate_to_datetime(

709

self.headers["If-Modified-Since"])

710

except (TypeError, IndexError, OverflowError, ValueError):

711

# ignore ill-formed values

712

pass

713

else:

714

if ims.tzinfo is None:

715

# obsolete format with no timezone, cf.

716

# https://tools.ietf.org/html/rfc7231#section-7.1.1.1

717

ims = ims.replace(tzinfo=datetime.timezone.utc)

718

if ims.tzinfo is datetime.timezone.utc:

719

# compare to UTC datetime of last modification

720

last_modif = datetime.datetime.fromtimestamp(

721

fs.st_mtime, datetime.timezone.utc)

722

# remove microseconds, like in If-Modified-Since

723

last_modif = last_modif.replace(microsecond=0)

Serhiy Storchaka

13ad3b7

2017-09-14 09:38:36 +0300

[diff] [blame]

724

Pierre Quentel

2017-04-02 12:26:12 +0200

[diff] [blame]

725

if last_modif <= ims:

726

self.send_response(HTTPStatus.NOT_MODIFIED)

self.end_headers()

f.close()

return None

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

731

self.send_response(HTTPStatus.OK)

Serhiy Storchaka

2014-01-25 19:43:02 +0200

[diff] [blame]

732

self.send_header("Content-type", ctype)

Serhiy Storchaka

2014-01-25 19:43:02 +0200

[diff] [blame]

733

self.send_header("Content-Length", str(fs[6]))

Serhiy Storchaka

13ad3b7

2017-09-14 09:38:36 +0300

[diff] [blame]

734

self.send_header("Last-Modified",

Pierre Quentel

2017-04-02 12:26:12 +0200

[diff] [blame]

735

self.date_time_string(fs.st_mtime))

Serhiy Storchaka

2014-01-25 19:43:02 +0200

[diff] [blame]

self.end_headers()

return f

except:

f.close()

raise

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

741

742

def list_directory(self, path):

743

"""Helper to produce a directory listing (absent index.html).

744

745

Return value is either a file object, or None (indicating an

746

error). In either case, the headers are sent, making the

747

interface the same as for send_head().

"""

try:

list = os.listdir(path)

Andrew Svetlov

ad28c7f

2012-12-18 22:02:39 +0200

[diff] [blame]

752

except OSError:

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

753

self.send_error(

754

HTTPStatus.NOT_FOUND,

755

"No permission to list directory")

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

756

return None

757

list.sort(key=lambda a: a.lower())

758

r = []

Serhiy Storchaka

2014-08-17 08:22:11 +0300

[diff] [blame]

759

try:

760

displaypath = urllib.parse.unquote(self.path,

761

errors='surrogatepass')

762

except UnicodeDecodeError:

763

displaypath = urllib.parse.unquote(path)

Martin Panter

da3bb38

2016-04-11 00:40:08 +0000

[diff] [blame]

764

displaypath = html.escape(displaypath, quote=False)

Ezio Melotti

2011-11-02 19:33:29 +0200

[diff] [blame]

765

enc = sys.getfilesystemencoding()

766

title = 'Directory listing for %s' % displaypath

767

r.append('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '

768

'"http://www.w3.org/TR/html4/strict.dtd">')

769

r.append('<html>\n<head>')

770

r.append('<meta http-equiv="Content-Type" '

771

'content="text/html; charset=%s">' % enc)

772

r.append('<title>%s</title>\n</head>' % title)

773

r.append('<body>\n<h1>%s</h1>' % title)

774

r.append('<hr>\n<ul>')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

775

for name in list:

776

fullname = os.path.join(path, name)

777

displayname = linkname = name

778

# Append / for directories or @ for symbolic links

779

if os.path.isdir(fullname):

780

displayname = name + "/"

781

linkname = name + "/"

782

if os.path.islink(fullname):

783

displayname = name + "@"

784

# Note: a link to a directory displays with @ and links with /

Ezio Melotti

2011-11-02 19:33:29 +0200

[diff] [blame]

785

r.append('<li><a href="%s">%s</a></li>'

Serhiy Storchaka

2014-08-17 08:22:11 +0300

[diff] [blame]

786

% (urllib.parse.quote(linkname,

787

errors='surrogatepass'),

Martin Panter

da3bb38

2016-04-11 00:40:08 +0000

[diff] [blame]

788

html.escape(displayname, quote=False)))

Ezio Melotti

2011-11-02 19:33:29 +0200

[diff] [blame]

789

r.append('</ul>\n<hr>\n</body>\n</html>\n')

Serhiy Storchaka

2014-08-17 08:22:11 +0300

[diff] [blame]

790

encoded = '\n'.join(r).encode(enc, 'surrogateescape')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

791

f = io.BytesIO()

792

f.write(encoded)

793

f.seek(0)

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

794

self.send_response(HTTPStatus.OK)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

795

self.send_header("Content-type", "text/html; charset=%s" % enc)

796

self.send_header("Content-Length", str(len(encoded)))

self.end_headers()

return f

def translate_path(self, path):

801

"""Translate a /-separated PATH to the local filename syntax.

802

803

Components that mean special things to the local file system

804

(e.g. drive or directory names) are ignored. (XXX They should

805

probably be diagnosed.)

806

807

"""

808

# abandon query parameters

809

path = path.split('?',1)[0]

810

path = path.split('#',1)[0]

Senthil Kumaran

72c238e

2013-09-13 00:21:18 -0700

[diff] [blame]

811

# Don't forget explicit trailing slash when normalizing. Issue17324

Senthil Kumaran

600b735

2013-09-29 18:59:04 -0700

[diff] [blame]

812

trailing_slash = path.rstrip().endswith('/')

Serhiy Storchaka

2014-08-17 08:22:11 +0300

[diff] [blame]

813

try:

814

path = urllib.parse.unquote(path, errors='surrogatepass')

815

except UnicodeDecodeError:

816

path = urllib.parse.unquote(path)

817

path = posixpath.normpath(path)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

818

words = path.split('/')

819

words = filter(None, words)

Stéphane Wirtel

2017-05-24 09:29:06 +0200

[diff] [blame]

820

path = self.directory

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

821

for word in words:

Martin Panter

d274b3f

2016-04-18 03:45:18 +0000

[diff] [blame]

822

if os.path.dirname(word) or word in (os.curdir, os.pardir):

823

# Ignore components that are not a simple file/directory name

824

continue

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

825

path = os.path.join(path, word)

Senthil Kumaran

72c238e

2013-09-13 00:21:18 -0700

[diff] [blame]

826

if trailing_slash:

827

path += '/'

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

828

return path

829

830

def copyfile(self, source, outputfile):

831

"""Copy all data between two file objects.

832

833

The SOURCE argument is a file object open for reading

834

(or anything with a read() method) and the DESTINATION

835

argument is a file object open for writing (or

836

anything with a write() method).

837

838

The only reason for overriding this would be to change

839

the block size or perhaps to replace newlines by CRLF

840

-- note however that this the default server uses this

841

to copy binary data as well.

842

843

"""

844

shutil.copyfileobj(source, outputfile)

845

846

def guess_type(self, path):

847

"""Guess the type of a file.

848

849

Argument is a PATH (a filename).

850

851

Return value is a string of the form type/subtype,

852

usable for a MIME Content-type header.

853

854

The default implementation looks the file's extension

855

up in the table self.extensions_map, using application/octet-stream

856

as a default; however it would be permissible (if

857

slow) to look inside the data to make a better guess.

"""

base, ext = posixpath.splitext(path)

862

if ext in self.extensions_map:

863

return self.extensions_map[ext]

864

ext = ext.lower()

865

if ext in self.extensions_map:

866

return self.extensions_map[ext]

867

else:

868

return self.extensions_map['']

869

870

if not mimetypes.inited:

871

mimetypes.init() # try to read system mime.types

872

extensions_map = mimetypes.types_map.copy()

873

extensions_map.update({

874

'': 'application/octet-stream', # Default

'.py': 'text/plain',

'.c': 'text/plain',

'.h': 'text/plain',

})

# Utilities for CGIHTTPRequestHandler

882

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

883

def _url_collapse_path(path):

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

884

"""

885

Given a URL path, remove extra '/'s and '.' path elements and collapse

Martin Panter

9955a37

2015-10-07 10:26:23 +0000

[diff] [blame]

886

any '..' references and returns a collapsed path.

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

887

888

Implements something akin to RFC-2396 5.2 step 6 to parse relative paths.

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

889

The utility of this function is limited to is_cgi method and helps

890

preventing some security attacks.

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

891

Martin Panter

2015-10-03 05:55:46 +0000

[diff] [blame]

892

Returns: The reconstituted URL, which will always start with a '/'.

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

893

894

Raises: IndexError if too many '..' occur within the path.

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

895

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

896

"""

Martin Panter

2015-10-03 05:55:46 +0000

[diff] [blame]

897

# Query component should not be involved.

898

path, _, query = path.partition('?')

899

path = urllib.parse.unquote(path)

900

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

901

# Similar to os.path.split(os.path.normpath(path)) but specific to URL

902

# path semantics rather than local operating system semantics.

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

903

path_parts = path.split('/')

904

head_parts = []

905

for part in path_parts[:-1]:

906

if part == '..':

907

head_parts.pop() # IndexError if more '..' than prior parts

908

elif part and part != '.':

909

head_parts.append( part )

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

910

if path_parts:

Senthil Kumaran

dbb369d

2012-04-11 03:15:28 +0800

[diff] [blame]

911

tail_part = path_parts.pop()

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

912

if tail_part:

913

if tail_part == '..':

914

head_parts.pop()

915

tail_part = ''

916

elif tail_part == '.':

917

tail_part = ''

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

918

else:

919

tail_part = ''

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

920

Martin Panter

2015-10-03 05:55:46 +0000

[diff] [blame]

921

if query:

922

tail_part = '?'.join((tail_part, query))

923

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

924

splitpath = ('/' + '/'.join(head_parts), tail_part)

925

collapsed_path = "/".join(splitpath)

926

927

return collapsed_path

928

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

929

930

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

nobody = None

def nobody_uid():

"""Internal routine to get nobody's uid"""

global nobody

if nobody:

return nobody

try:

import pwd

Brett Cannon

cd171c8

2013-07-04 17:43:24 -0400

[diff] [blame]

940

except ImportError:

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

941

return -1

942

try:

943

nobody = pwd.getpwnam('nobody')[2]

944

except KeyError:

Georg Brandl

cbd2ab1

2010-12-04 10:39:14 +0000

[diff] [blame]

945

nobody = 1 + max(x[2] for x in pwd.getpwall())

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

return nobody

def executable(path):

950

"""Test for executable file."""

Victor Stinner

fb25ba9

2011-06-20 17:45:54 +0200

[diff] [blame]

951

return os.access(path, os.X_OK)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

952

953

954

class CGIHTTPRequestHandler(SimpleHTTPRequestHandler):

955

956

"""Complete HTTP server with GET, HEAD and POST commands.

957

958

GET and HEAD also support running CGI scripts.

959

960

The POST command is *only* implemented for CGI scripts.

"""

# Determine platform specifics

965

have_fork = hasattr(os, 'fork')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

966

967

# Make rfile unbuffered -- we need to read one line and then pass

968

# the rest to a subprocess, so we can't use buffered input.

rbufsize = 0

def do_POST(self):

"""Serve a POST request.

973

974

This is only implemented for CGI scripts.

"""

if self.is_cgi():

self.run_cgi()

else:

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

981

self.send_error(

982

HTTPStatus.NOT_IMPLEMENTED,

983

"Can only POST to CGI scripts")

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

984

985

def send_head(self):

986

"""Version of send_head that support CGI scripts"""

987

if self.is_cgi():

988

return self.run_cgi()

989

else:

990

return SimpleHTTPRequestHandler.send_head(self)

991

992

def is_cgi(self):

993

"""Test whether self.path corresponds to a CGI script.

994

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

995

Returns True and updates the cgi_info attribute to the tuple

996

(dir, rest) if self.path requires running a CGI script.

997

Returns False otherwise.

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

998

Benjamin Peterson

a7deeee

2009-05-08 20:54:42 +0000

[diff] [blame]

999

If any exception is raised, the caller should assume that

1000

self.path was rejected as invalid and act accordingly.

1001

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

1002

The default implementation tests whether the normalized url

1003

path begins with one of the strings in self.cgi_directories

1004

(and the next character is a '/' or the end of the string).

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1005

1006

"""

Martin Panter

2015-10-03 05:55:46 +0000

[diff] [blame]

1007

collapsed_path = _url_collapse_path(self.path)

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

1008

dir_sep = collapsed_path.find('/', 1)

1009

head, tail = collapsed_path[:dir_sep], collapsed_path[dir_sep+1:]

Senthil Kumaran

dbb369d

2012-04-11 03:15:28 +0800

[diff] [blame]

1010

if head in self.cgi_directories:

1011

self.cgi_info = head, tail

Benjamin Peterson

2009-04-11 20:12:10 +0000

[diff] [blame]

1012

return True

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1013

return False

1014

Senthil Kumaran

2012-04-12 02:34:32 +0800

[diff] [blame]

1015

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1016

cgi_directories = ['/cgi-bin', '/htbin']

1017

1018

def is_executable(self, path):

1019

"""Test whether argument path is an executable file."""

1020

return executable(path)

1021

1022

def is_python(self, path):

1023

"""Test whether argument path is a Python script."""

1024

head, tail = os.path.splitext(path)

1025

return tail.lower() in (".py", ".pyw")

1026

1027

def run_cgi(self):

1028

"""Execute a CGI script."""

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1029

dir, rest = self.cgi_info

Ned Deily

915a30f

2014-07-12 22:06:26 -0700

[diff] [blame]

1030

path = dir + '/' + rest

1031

i = path.find('/', len(dir)+1)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1032

while i >= 0:

Ned Deily

915a30f

2014-07-12 22:06:26 -0700

[diff] [blame]

1033

nextdir = path[:i]

1034

nextrest = path[i+1:]

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1035

1036

scriptdir = self.translate_path(nextdir)

1037

if os.path.isdir(scriptdir):

1038

dir, rest = nextdir, nextrest

Ned Deily

915a30f

2014-07-12 22:06:26 -0700

[diff] [blame]

1039

i = path.find('/', len(dir)+1)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

else:

break

# find an explicit query string, if present.

Martin Panter

a02e18a

2015-10-03 05:38:07 +0000

[diff] [blame]

1044

rest, _, query = rest.partition('?')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1045

1046

# dissect the part after the directory name into a script name &

1047

# a possible additional path, to be stored in PATH_INFO.

1048

i = rest.find('/')

1049

if i >= 0:

1050

script, rest = rest[:i], rest[i:]

1051

else:

1052

script, rest = rest, ''

1053

1054

scriptname = dir + '/' + script

1055

scriptfile = self.translate_path(scriptname)

1056

if not os.path.exists(scriptfile):

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

1057

self.send_error(

1058

HTTPStatus.NOT_FOUND,

1059

"No such CGI script (%r)" % scriptname)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1060

return

1061

if not os.path.isfile(scriptfile):

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

1062

self.send_error(

1063

HTTPStatus.FORBIDDEN,

1064

"CGI script is not a plain file (%r)" % scriptname)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1065

return

1066

ispy = self.is_python(scriptname)

Victor Stinner

fb25ba9

2011-06-20 17:45:54 +0200

[diff] [blame]

1067

if self.have_fork or not ispy:

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1068

if not self.is_executable(scriptfile):

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

1069

self.send_error(

1070

HTTPStatus.FORBIDDEN,

1071

"CGI script is not executable (%r)" % scriptname)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1072

return

1073

1074

# Reference: http://hoohoo.ncsa.uiuc.edu/cgi/env.html

1075

# XXX Much of the following could be prepared ahead of time!

Senthil Kumaran

4271372

2010-10-03 17:55:45 +0000

[diff] [blame]

1076

env = copy.deepcopy(os.environ)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1077

env['SERVER_SOFTWARE'] = self.version_string()

1078

env['SERVER_NAME'] = self.server.server_name

1079

env['GATEWAY_INTERFACE'] = 'CGI/1.1'

1080

env['SERVER_PROTOCOL'] = self.protocol_version

1081

env['SERVER_PORT'] = str(self.server.server_port)

1082

env['REQUEST_METHOD'] = self.command

Jeremy Hylton

1afc169

2008-06-18 20:49:58 +0000

[diff] [blame]

1083

uqrest = urllib.parse.unquote(rest)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1084

env['PATH_INFO'] = uqrest

1085

env['PATH_TRANSLATED'] = self.translate_path(uqrest)

1086

env['SCRIPT_NAME'] = scriptname

1087

if query:

1088

env['QUERY_STRING'] = query

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1089

env['REMOTE_ADDR'] = self.client_address[0]

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

1090

authorization = self.headers.get("authorization")

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1091

if authorization:

1092

authorization = authorization.split()

1093

if len(authorization) == 2:

1094

import base64, binascii

1095

env['AUTH_TYPE'] = authorization[0]

1096

if authorization[0].lower() == "basic":

1097

try:

1098

authorization = authorization[1].encode('ascii')

Georg Brandl

706824f

2009-06-04 09:42:55 +0000

[diff] [blame]

1099

authorization = base64.decodebytes(authorization).\

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1100

decode('ascii')

1101

except (binascii.Error, UnicodeError):

1102

pass

1103

else:

1104

authorization = authorization.split(':')

1105

if len(authorization) == 2:

1106

env['REMOTE_USER'] = authorization[0]

1107

# XXX REMOTE_IDENT

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

1108

if self.headers.get('content-type') is None:

1109

env['CONTENT_TYPE'] = self.headers.get_content_type()

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1110

else:

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

1111

env['CONTENT_TYPE'] = self.headers['content-type']

1112

length = self.headers.get('content-length')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1113

if length:

1114

env['CONTENT_LENGTH'] = length

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

1115

referer = self.headers.get('referer')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1116

if referer:

1117

env['HTTP_REFERER'] = referer

1118

accept = []

1119

for line in self.headers.getallmatchingheaders('accept'):

1120

if line[:1] in "\t\n\r ":

1121

accept.append(line.strip())

1122

else:

1123

accept = accept + line[7:].split(',')

1124

env['HTTP_ACCEPT'] = ','.join(accept)

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

1125

ua = self.headers.get('user-agent')

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1126

if ua:

1127

env['HTTP_USER_AGENT'] = ua

Barry Warsaw

2008-06-12 04:06:45 +0000

[diff] [blame]

1128

co = filter(None, self.headers.get_all('cookie', []))

Georg Brandl

62e2ca2

2010-07-31 21:54:24 +0000

[diff] [blame]

1129

cookie_str = ', '.join(co)

1130

if cookie_str:

1131

env['HTTP_COOKIE'] = cookie_str

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1132

# XXX Other HTTP_* headers

1133

# Since we're setting the env in the parent, provide empty

1134

# values to override previously set values

1135

for k in ('QUERY_STRING', 'REMOTE_HOST', 'CONTENT_LENGTH',

1136

'HTTP_USER_AGENT', 'HTTP_COOKIE', 'HTTP_REFERER'):

1137

env.setdefault(k, "")

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1138

Serhiy Storchaka

2014-12-23 16:28:28 +0200

[diff] [blame]

1139

self.send_response(HTTPStatus.OK, "Script output follows")

Senthil Kumaran

2011-05-09 23:25:02 +0800

[diff] [blame]

1140

self.flush_headers()

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1141

1142

decoded_query = query.replace('+', ' ')

1143

1144

if self.have_fork:

1145

# Unix -- fork as we should

1146

args = [script]

1147

if '=' not in decoded_query:

1148

args.append(decoded_query)

1149

nobody = nobody_uid()

1150

self.wfile.flush() # Always flush before forking

pid = os.fork()

if pid != 0:

# Parent

pid, sts = os.waitpid(pid, 0)

1155

# throw away additional data [see bug #427345]

1156

while select.select([self.rfile], [], [], 0)[0]:

1157

if not self.rfile.read(1):

1158

break

1159

if sts:

1160

self.log_error("CGI script exit status %#x", sts)

return

# Child

try:

try:

os.setuid(nobody)

Andrew Svetlov

ad28c7f

2012-12-18 22:02:39 +0200

[diff] [blame]

1166

except OSError:

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1167

pass

1168

os.dup2(self.rfile.fileno(), 0)

1169

os.dup2(self.wfile.fileno(), 1)

Senthil Kumaran

4271372

2010-10-03 17:55:45 +0000

[diff] [blame]

1170

os.execve(scriptfile, args, env)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1171

except:

1172

self.server.handle_error(self.request, self.client_address)

1173

os._exit(127)

1174

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

1175

else:

1176

# Non-Unix -- use subprocess

1177

import subprocess

Senthil Kumaran

e29cd16

2009-11-11 04:17:53 +0000

[diff] [blame]

1178

cmdline = [scriptfile]

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1179

if self.is_python(scriptfile):

1180

interp = sys.executable

1181

if interp.lower().endswith("w.exe"):

1182

# On Windows, use python.exe, not pythonw.exe

1183

interp = interp[:-5] + interp[-4:]

Senthil Kumaran

e29cd16

2009-11-11 04:17:53 +0000

[diff] [blame]

1184

cmdline = [interp, '-u'] + cmdline

1185

if '=' not in query:

1186

cmdline.append(query)

1187

self.log_message("command: %s", subprocess.list2cmdline(cmdline))

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1188

try:

1189

nbytes = int(length)

1190

except (TypeError, ValueError):

1191

nbytes = 0

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

1192

p = subprocess.Popen(cmdline,

1193

stdin=subprocess.PIPE,

1194

stdout=subprocess.PIPE,

Senthil Kumaran

4271372

2010-10-03 17:55:45 +0000

[diff] [blame]

1195

stderr=subprocess.PIPE,

1196

env = env

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

1197

)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1198

if self.command.lower() == "post" and nbytes > 0:

1199

data = self.rfile.read(nbytes)

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

1200

else:

1201

data = None

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1202

# throw away additional data [see bug #427345]

1203

while select.select([self.rfile._sock], [], [], 0)[0]:

1204

if not self.rfile._sock.recv(1):

1205

break

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

1206

stdout, stderr = p.communicate(data)

1207

self.wfile.write(stdout)

1208

if stderr:

1209

self.log_error('%s', stderr)

Brian Curtin

cbad4df

2010-11-05 15:04:48 +0000

[diff] [blame]

1210

p.stderr.close()

1211

p.stdout.close()

Amaury Forgeot d'Arc

2008-06-18 22:19:22 +0000

[diff] [blame]

1212

status = p.returncode

1213

if status:

1214

self.log_error("CGI script exit status %#x", status)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1215

else:

1216

self.log_message("CGI script exited OK")

1217

1218

Senthil Kumaran

2013-09-15 09:37:27 -0700

[diff] [blame]

1219

def test(HandlerClass=BaseHTTPRequestHandler,

Julien Palard

4f53e2a

2018-05-30 02:24:17 +0200

[diff] [blame]

1220

ServerClass=ThreadingHTTPServer,

Miss Islington (bot)

f8d2c3c

2018-03-23 13:31:20 -0700

[diff] [blame]

1221

protocol="HTTP/1.0", port=8000, bind=""):

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1222

"""Test the HTTP request handler class.

1223

Robert Collins

9644f24

2015-08-17 12:18:35 +1200

[diff] [blame]

1224

This runs an HTTP server on port 8000 (or the port argument).

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1225

1226

"""

Senthil Kumaran

2013-09-15 09:37:27 -0700

[diff] [blame]

1227

server_address = (bind, port)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1228

1229

HandlerClass.protocol_version = protocol

Martin Panter

0cab9c1

2016-04-13 00:36:52 +0000

[diff] [blame]

1230

with ServerClass(server_address, HandlerClass) as httpd:

1231

sa = httpd.socket.getsockname()

Berker Peksag

3a31cca

2016-04-29 16:48:11 +0300

[diff] [blame]

1232

serve_message = "Serving HTTP on {host} port {port} (http://{host}:{port}/) ..."

1233

print(serve_message.format(host=sa[0], port=sa[1]))

Martin Panter

0cab9c1

2016-04-13 00:36:52 +0000

[diff] [blame]

1234

try:

1235

httpd.serve_forever()

1236

except KeyboardInterrupt:

1237

print("\nKeyboard interrupt received, exiting.")

1238

sys.exit(0)

Georg Brandl

2008-05-26 16:32:26 +0000

[diff] [blame]

1239

1240

if __name__ == '__main__':

Serhiy Storchaka

7e4db2f

2017-05-04 08:17:47 +0300

[diff] [blame]

1241

import argparse

1242

Senthil Kumaran

2012-06-03 16:15:54 +0800

[diff] [blame]

1243

parser = argparse.ArgumentParser()

1244

parser.add_argument('--cgi', action='store_true',

1245

help='Run as CGI Server')

Senthil Kumaran

2013-09-15 09:37:27 -0700

[diff] [blame]

1246

parser.add_argument('--bind', '-b', default='', metavar='ADDRESS',

1247

help='Specify alternate bind address '

1248

'[default: all interfaces]')

Stéphane Wirtel

2017-05-24 09:29:06 +0200

[diff] [blame]

1249

parser.add_argument('--directory', '-d', default=os.getcwd(),

1250

help='Specify alternative directory '

1251

'[default:current directory]')

Senthil Kumaran

2012-06-03 16:15:54 +0800

[diff] [blame]

1252

parser.add_argument('port', action='store',

1253

default=8000, type=int,

1254

nargs='?',

1255

help='Specify alternate port [default: 8000]')

1256

args = parser.parse_args()

1257

if args.cgi:

Senthil Kumaran

2013-09-15 09:37:27 -0700

[diff] [blame]

1258

handler_class = CGIHTTPRequestHandler

Senthil Kumaran

2012-06-03 16:15:54 +0800

[diff] [blame]

1259

else:

Stéphane Wirtel

2017-05-24 09:29:06 +0200

[diff] [blame]

1260

handler_class = partial(SimpleHTTPRequestHandler,

1261

directory=args.directory)

Senthil Kumaran