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__ = [

86

"HTTPServer", "BaseHTTPRequestHandler",

87

"SimpleHTTPRequestHandler", "CGIHTTPRequestHandler",

88

]

Georg Brandl

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

[diff] [blame]

89

Berker Peksag

04bc5b9

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

[diff] [blame]

90

import email.utils

Georg Brandl

1f7fffb

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

[diff] [blame]

91

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

Senthil Kumaran

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

[diff] [blame]

104

import copy

Senthil Kumaran

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

[diff] [blame]

105

import argparse

106

Serhiy Storchaka

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

[diff] [blame]

107

from http import HTTPStatus

108

Georg Brandl

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

[diff] [blame]

109

110

# Default error message template

111

DEFAULT_ERROR_MESSAGE = """\

Senthil Kumaran

1b407fe

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

[diff] [blame]

112

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

113

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

Ezio Melotti

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

[diff] [blame]

114

<html>

Senthil Kumaran

b253c9f

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

[diff] [blame]

115

<head>

Senthil Kumaran

1b407fe

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

[diff] [blame]

116

Senthil Kumaran

b253c9f

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

[diff] [blame]

117

<title>Error response</title>

118

</head>

119

<body>

120

<h1>Error response</h1>

121

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

122

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

123

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

124

</body>

125

</html>

Georg Brandl

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

[diff] [blame]

126

"""

127

128

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

129

Georg Brandl

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

[diff] [blame]

130

class HTTPServer(socketserver.TCPServer):

131

132

allow_reuse_address = 1 # Seems to make sense in testing environment

133

134

def server_bind(self):

135

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

136

socketserver.TCPServer.server_bind(self)

Martin Panter

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

[diff] [blame]

137

host, port = self.server_address[:2]

Georg Brandl

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

[diff] [blame]

138

self.server_name = socket.getfqdn(host)

139

self.server_port = port

140

141

142

class BaseHTTPRequestHandler(socketserver.StreamRequestHandler):

143

144

"""HTTP request handler base class.

145

146

The following explanation of HTTP serves to guide you through the

147

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

148

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

149

:-).

150

151

HTTP (HyperText Transfer Protocol) is an extensible protocol on

152

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

153

recognizes three parts to a request:

154

155

1. One line identifying the request type and path

156

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

157

3. An optional data part

158

159

The headers and data are separated by a blank line.

160

161

The first line of the request has the form

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

166

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

167

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

168

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

169

the ASCII character with hex code xx).

170

171

The specification specifies that lines are separated by CRLF but

172

for compatibility with the widest range of clients recommends

173

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

174

is treated sensibly (allowing multiple spaces between components

175

and allowing trailing whitespace).

176

177

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

178

but most clients grok LF characters just fine.

179

180

If the first line of the request has the form

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

185

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

186

the reply consists of just the data.

187

188

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

189

190

1. One line giving the response code

191

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

192

3. The data

193

194

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

195

196

The response code line has the form

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

201

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

202

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

203

human-readable string explaining what the response code means.

204

205

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

206

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

207

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

208

such method exists the server sends an error response to the

209

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

214

are different requests).

215

216

The various request details are stored in instance variables:

217

218

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

219

port);

220

221

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

222

Barry Warsaw

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

[diff] [blame]

223

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

Georg Brandl

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

[diff] [blame]

224

class) containing the header information;

225

226

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

227

start of the optional input data part;

228

229

- wfile is a file object open for writing.

230

231

IT IS IMPORTANT TO ADHERE TO THE PROTOCOL FOR WRITING!

232

233

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

234

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

235

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

236

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

237

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

238

239

Content-type: <type>/<subtype>

240

241

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

242

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

"""

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

247

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

248

249

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

250

# The format is multiple whitespace-separated strings,

251

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

252

server_version = "BaseHTTP/" + __version__

253

254

error_message_format = DEFAULT_ERROR_MESSAGE

255

error_content_type = DEFAULT_ERROR_CONTENT_TYPE

256

257

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

258

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

259

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

260

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

261

default_request_version = "HTTP/0.9"

262

263

def parse_request(self):

264

"""Parse a request (internal).

265

266

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

267

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

268

self.headers.

269

270

Return True for success, False for failure; on failure, an

error is sent back.

"""

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

275

self.request_version = version = self.default_request_version

Benjamin Peterson

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

[diff] [blame]

276

self.close_connection = True

Georg Brandl

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

[diff] [blame]

277

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

Senthil Kumaran

3075549

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

[diff] [blame]

278

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

Georg Brandl

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

[diff] [blame]

279

self.requestline = requestline

280

words = requestline.split()

281

if len(words) == 3:

Senthil Kumaran

3075549

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

[diff] [blame]

282

command, path, version = words

Georg Brandl

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

[diff] [blame]

283

try:

Martin Panter

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

[diff] [blame]

284

if version[:5] != 'HTTP/':

285

raise ValueError

Georg Brandl

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

[diff] [blame]

286

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

287

version_number = base_version_number.split(".")

288

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

289

# - major and minor numbers MUST be treated as

290

# separate integers;

291

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

292

# turn is lower than HTTP/12.3;

293

# - Leading zeros MUST be ignored by recipients.

294

if len(version_number) != 2:

295

raise ValueError

296

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

297

except (ValueError, IndexError):

Serhiy Storchaka

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

[diff] [blame]

298

self.send_error(

299

HTTPStatus.BAD_REQUEST,

300

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

Georg Brandl

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

[diff] [blame]

301

return False

302

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

Benjamin Peterson

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

[diff] [blame]

303

self.close_connection = False

Georg Brandl

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

[diff] [blame]

304

if version_number >= (2, 0):

Serhiy Storchaka

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

[diff] [blame]

305

self.send_error(

306

HTTPStatus.HTTP_VERSION_NOT_SUPPORTED,

Martin Panter

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

[diff] [blame]

307

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

Georg Brandl

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

[diff] [blame]

308

return False

309

elif len(words) == 2:

Senthil Kumaran

3075549

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

[diff] [blame]

310

command, path = words

Benjamin Peterson

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

[diff] [blame]

311

self.close_connection = True

Georg Brandl

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

[diff] [blame]

312

if command != 'GET':

Serhiy Storchaka

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

[diff] [blame]

313

self.send_error(

314

HTTPStatus.BAD_REQUEST,

315

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

Georg Brandl

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

[diff] [blame]

return False

elif not words:

return False

else:

Serhiy Storchaka

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

[diff] [blame]

320

self.send_error(

321

HTTPStatus.BAD_REQUEST,

322

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

Georg Brandl

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

[diff] [blame]

323

return False

324

self.command, self.path, self.request_version = command, path, version

325

326

# Examine the headers and look for a Connection directive.

Senthil Kumaran

5466bf1

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

[diff] [blame]

327

try:

328

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

329

_class=self.MessageClass)

Martin Panter

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

[diff] [blame]

330

except http.client.LineTooLong as err:

Serhiy Storchaka

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

[diff] [blame]

331

self.send_error(

Martin Panter

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

[diff] [blame]

332

HTTPStatus.REQUEST_HEADER_FIELDS_TOO_LARGE,

333

"Line too long",

334

str(err))

Senthil Kumaran

5466bf1

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

[diff] [blame]

335

return False

Martin Panter

acc0319

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

[diff] [blame]

336

except http.client.HTTPException as err:

337

self.send_error(

338

HTTPStatus.REQUEST_HEADER_FIELDS_TOO_LARGE,

"Too many headers",

str(err)

)

return False

Georg Brandl

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

[diff] [blame]

343

344

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

345

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

Benjamin Peterson

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

[diff] [blame]

346

self.close_connection = True

Georg Brandl

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

[diff] [blame]

347

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

348

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

Benjamin Peterson

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

[diff] [blame]

349

self.close_connection = False

Senthil Kumaran

0f476d4

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

[diff] [blame]

350

# Examine the headers and look for an Expect directive

351

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

352

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

353

self.protocol_version >= "HTTP/1.1" and

354

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

355

if not self.handle_expect_100():

return False

return True

def handle_expect_100(self):

360

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

361

362

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

363

respond with either a 100 Continue or a final response before

364

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

365

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

366

reject unauthorized requests) by overriding this method.

367

368

This method should either return True (possibly after sending

369

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

370

False.

371

372

"""

Serhiy Storchaka

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

[diff] [blame]

373

self.send_response_only(HTTPStatus.CONTINUE)

Benjamin Peterson

0442423

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

[diff] [blame]

374

self.end_headers()

Georg Brandl

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

[diff] [blame]

375

return True

376

377

def handle_one_request(self):

378

"""Handle a single HTTP request.

379

380

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

381

__doc__ string for information on how to handle specific HTTP

382

commands such as GET and POST.

383

384

"""

Kristján Valur Jónsson

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

[diff] [blame]

385

try:

Antoine Pitrou

c492437

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

[diff] [blame]

386

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

387

if len(self.raw_requestline) > 65536:

388

self.requestline = ''

389

self.request_version = ''

390

self.command = ''

Serhiy Storchaka

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

[diff] [blame]

391

self.send_error(HTTPStatus.REQUEST_URI_TOO_LONG)

Antoine Pitrou

c492437

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

[diff] [blame]

392

return

Kristján Valur Jónsson

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

[diff] [blame]

393

if not self.raw_requestline:

Benjamin Peterson

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

[diff] [blame]

394

self.close_connection = True

Kristján Valur Jónsson

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

[diff] [blame]

395

return

396

if not self.parse_request():

397

# An error code has been sent, just exit

398

return

399

mname = 'do_' + self.command

400

if not hasattr(self, mname):

Serhiy Storchaka

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

[diff] [blame]

401

self.send_error(

402

HTTPStatus.NOT_IMPLEMENTED,

403

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

Kristján Valur Jónsson

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

[diff] [blame]

404

return

405

method = getattr(self, mname)

406

method()

407

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

408

except socket.timeout as e:

409

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

410

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

Benjamin Peterson

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

[diff] [blame]

411

self.close_connection = True

Georg Brandl

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

[diff] [blame]

412

return

Georg Brandl

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

[diff] [blame]

413

414

def handle(self):

415

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

Benjamin Peterson

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

[diff] [blame]

416

self.close_connection = True

Georg Brandl

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

[diff] [blame]

417

418

self.handle_one_request()

419

while not self.close_connection:

420

self.handle_one_request()

421

Senthil Kumaran

2688644

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

[diff] [blame]

422

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

Georg Brandl

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

[diff] [blame]

423

"""Send and log an error reply.

424

Senthil Kumaran

2688644

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

[diff] [blame]

425

Arguments are

426

* code: an HTTP error code

427

3 digits

428

* message: a simple optional 1 line reason phrase.

429

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

430

defaults to short entry matching the response code

431

* explain: a detailed message defaults to the long entry

432

matching the response code.

Georg Brandl

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

[diff] [blame]

433

434

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

435

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

436

a piece of HTML explaining the error to the user.

"""

try:

shortmsg, longmsg = self.responses[code]

442

except KeyError:

443

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

444

if message is None:

445

message = shortmsg

Senthil Kumaran

2688644

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

[diff] [blame]

446

if explain is None:

447

explain = longmsg

Georg Brandl

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

[diff] [blame]

448

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

Martin Panter

da3bb38

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

[diff] [blame]

449

# HTML encode to prevent Cross Site Scripting attacks (see bug #1100201)

450

content = (self.error_message_format % {

451

'code': code,

452

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

453

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

454

})

Senthil Kumaran

52d2720

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

[diff] [blame]

455

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

Senthil Kumaran

1e7551d

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

[diff] [blame]

456

self.send_response(code, message)

Georg Brandl

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

[diff] [blame]

457

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

458

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

Senthil Kumaran

52d2720

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

[diff] [blame]

459

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

Georg Brandl

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

[diff] [blame]

460

self.end_headers()

Serhiy Storchaka

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

[diff] [blame]

461

462

if (self.command != 'HEAD' and

463

code >= 200 and

464

code not in (

465

HTTPStatus.NO_CONTENT, HTTPStatus.NOT_MODIFIED)):

Senthil Kumaran

52d2720

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

[diff] [blame]

466

self.wfile.write(body)

Georg Brandl

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

[diff] [blame]

467

468

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

Senthil Kumaran

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

[diff] [blame]

469

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

470

response code.

Georg Brandl

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

[diff] [blame]

471

472

Also send two standard headers with the server software

473

version and the current date.

474

475

"""

476

self.log_request(code)

Senthil Kumaran

0f476d4

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

[diff] [blame]

477

self.send_response_only(code, message)

478

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

479

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

480

481

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

482

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

Georg Brandl

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

[diff] [blame]

483

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

Martin Panter

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

[diff] [blame]

484

if message is None:

485

if code in self.responses:

486

message = self.responses[code][0]

487

else:

488

message = ''

Senthil Kumaran

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

[diff] [blame]

489

if not hasattr(self, '_headers_buffer'):

490

self._headers_buffer = []

491

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

492

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

493

'latin-1', 'strict'))

Georg Brandl

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

[diff] [blame]

494

495

def send_header(self, keyword, value):

Senthil Kumaran

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

[diff] [blame]

496

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

Georg Brandl

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

[diff] [blame]

497

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

Senthil Kumaran

e4dad4f

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

[diff] [blame]

498

if not hasattr(self, '_headers_buffer'):

499

self._headers_buffer = []

500

self._headers_buffer.append(

Marc-André Lemburg

8f36af7

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

[diff] [blame]

501

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

Georg Brandl

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

[diff] [blame]

502

503

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

504

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

Benjamin Peterson

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

[diff] [blame]

505

self.close_connection = True

Georg Brandl

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

[diff] [blame]

506

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

Benjamin Peterson

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

[diff] [blame]

507

self.close_connection = False

Georg Brandl

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

[diff] [blame]

508

509

def end_headers(self):

510

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

511

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

Senthil Kumaran

e4dad4f

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

[diff] [blame]

512

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

Senthil Kumaran

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

[diff] [blame]

513

self.flush_headers()

514

515

def flush_headers(self):

516

if hasattr(self, '_headers_buffer'):

Senthil Kumaran

e4dad4f

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

[diff] [blame]

517

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

518

self._headers_buffer = []

Georg Brandl

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

[diff] [blame]

519

520

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

521

"""Log an accepted request.

522

523

This is called by send_response().

524

525

"""

Serhiy Storchaka

c0a23e6

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

[diff] [blame]

526

if isinstance(code, HTTPStatus):

527

code = code.value

Georg Brandl

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

[diff] [blame]

528

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

529

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

530

531

def log_error(self, format, *args):

532

"""Log an error.

533

534

This is called when a request cannot be fulfilled. By

535

default it passes the message on to log_message().

536

537

Arguments are the same as for log_message().

538

539

XXX This should go to the separate error log.

"""

self.log_message(format, *args)

544

545

def log_message(self, format, *args):

546

"""Log an arbitrary message.

547

548

This is used by all other logging functions. Override

549

it if you have specific logging wishes.

550

551

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

552

message to be logged. If the format string contains

553

any % escapes requiring parameters, they should be

554

specified as subsequent arguments (it's just like

555

printf!).

556

Senthil Kumaran

db727b4

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

[diff] [blame]

557

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" %

563

(self.address_string(),

564

self.log_date_time_string(),

565

format%args))

566

567

def version_string(self):

568

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

569

return self.server_version + ' ' + self.sys_version

570

571

def date_time_string(self, timestamp=None):

572

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

573

if timestamp is None:

574

timestamp = time.time()

Berker Peksag

04bc5b9

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

[diff] [blame]

575

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

Georg Brandl

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

[diff] [blame]

576

577

def log_date_time_string(self):

578

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

579

now = time.time()

580

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

581

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

582

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

583

return s

584

585

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

586

587

monthname = [None,

588

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

589

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

590

591

def address_string(self):

Senthil Kumaran

1aacba4

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

[diff] [blame]

592

"""Return the client address."""

Georg Brandl

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

[diff] [blame]

593

Senthil Kumaran

1aacba4

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

[diff] [blame]

594

return self.client_address[0]

Georg Brandl

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

[diff] [blame]

595

596

# Essentially static class variables

597

598

# The version of the HTTP protocol we support.

599

# Set this to HTTP/1.1 to enable automatic keepalive

600

protocol_version = "HTTP/1.0"

601

Barry Warsaw

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

[diff] [blame]

602

# MessageClass used to parse headers

Barry Warsaw

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

[diff] [blame]

603

MessageClass = http.client.HTTPMessage

Georg Brandl

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

[diff] [blame]

604

Serhiy Storchaka

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

[diff] [blame]

605

# hack to maintain backwards compatibility

Georg Brandl

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

[diff] [blame]

606

responses = {

Serhiy Storchaka

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

[diff] [blame]

607

v: (v.phrase, v.description)

608

for v in HTTPStatus.__members__.values()

609

}

Georg Brandl

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

[diff] [blame]

610

611

612

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):

613

614

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

615

616

This serves files from the current directory and any of its

617

subdirectories. The MIME type for files is determined by

618

calling the .guess_type() method.

619

620

The GET and HEAD requests are identical except that the HEAD

621

request omits the actual contents of the file.

"""

server_version = "SimpleHTTP/" + __version__

626

627

def do_GET(self):

628

"""Serve a GET request."""

629

f = self.send_head()

630

if f:

Serhiy Storchaka

91b0bc2

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

[diff] [blame]

631

try:

632

self.copyfile(f, self.wfile)

633

finally:

634

f.close()

Georg Brandl

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

[diff] [blame]

635

636

def do_HEAD(self):

637

"""Serve a HEAD request."""

f = self.send_head()

if f:

f.close()

def send_head(self):

"""Common code for GET and HEAD commands.

644

645

This sends the response code and MIME headers.

646

647

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

648

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

649

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

650

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

651

652

"""

653

path = self.translate_path(self.path)

654

f = None

655

if os.path.isdir(path):

Benjamin Peterson

94cb7a2

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

[diff] [blame]

656

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

657

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

Georg Brandl

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

[diff] [blame]

658

# redirect browser - doing basically what apache does

Serhiy Storchaka

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

[diff] [blame]

659

self.send_response(HTTPStatus.MOVED_PERMANENTLY)

Benjamin Peterson

94cb7a2

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

[diff] [blame]

660

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

661

parts[3], parts[4])

662

new_url = urllib.parse.urlunsplit(new_parts)

663

self.send_header("Location", new_url)

Georg Brandl

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

[diff] [blame]

664

self.end_headers()

665

return None

666

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

667

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

668

if os.path.exists(index):

path = index

break

else:

return self.list_directory(path)

673

ctype = self.guess_type(path)

674

try:

675

f = open(path, 'rb')

Andrew Svetlov

f7a17b4

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

[diff] [blame]

676

except OSError:

Serhiy Storchaka

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

[diff] [blame]

677

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

Georg Brandl

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

[diff] [blame]

678

return None

Serhiy Storchaka

91b0bc2

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

[diff] [blame]

679

try:

Serhiy Storchaka

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

[diff] [blame]

680

self.send_response(HTTPStatus.OK)

Serhiy Storchaka

91b0bc2

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

[diff] [blame]

681

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

682

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

683

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

684

self.send_header("Last-Modified", self.date_time_string(fs.st_mtime))

self.end_headers()

return f

except:

f.close()

raise

Georg Brandl

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

[diff] [blame]

690

691

def list_directory(self, path):

692

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

693

694

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

695

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

696

interface the same as for send_head().

"""

try:

list = os.listdir(path)

Andrew Svetlov

ad28c7f

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

[diff] [blame]

701

except OSError:

Serhiy Storchaka

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

[diff] [blame]

702

self.send_error(

703

HTTPStatus.NOT_FOUND,

704

"No permission to list directory")

Georg Brandl

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

[diff] [blame]

705

return None

706

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

707

r = []

Serhiy Storchaka

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

[diff] [blame]

708

try:

709

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

710

errors='surrogatepass')

711

except UnicodeDecodeError:

712

displaypath = urllib.parse.unquote(path)

Martin Panter

da3bb38

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

[diff] [blame]

713

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

Ezio Melotti

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

[diff] [blame]

714

enc = sys.getfilesystemencoding()

715

title = 'Directory listing for %s' % displaypath

716

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

717

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

718

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

719

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

720

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

721

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

722

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

723

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

Georg Brandl

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

[diff] [blame]

724

for name in list:

725

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

726

displayname = linkname = name

727

# Append / for directories or @ for symbolic links

728

if os.path.isdir(fullname):

729

displayname = name + "/"

730

linkname = name + "/"

731

if os.path.islink(fullname):

732

displayname = name + "@"

733

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

Ezio Melotti

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

[diff] [blame]

734

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

Serhiy Storchaka

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

[diff] [blame]

735

% (urllib.parse.quote(linkname,

736

errors='surrogatepass'),

Martin Panter

da3bb38

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

[diff] [blame]

737

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

Ezio Melotti

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

[diff] [blame]

738

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

Serhiy Storchaka

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

[diff] [blame]

739

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

Georg Brandl

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

[diff] [blame]

740

f = io.BytesIO()

741

f.write(encoded)

742

f.seek(0)

Serhiy Storchaka

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

[diff] [blame]

743

self.send_response(HTTPStatus.OK)

Georg Brandl

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

[diff] [blame]

744

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

745

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

self.end_headers()

return f

def translate_path(self, path):

750

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

751

752

Components that mean special things to the local file system

753

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

754

probably be diagnosed.)

755

756

"""

757

# abandon query parameters

758

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

759

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

Senthil Kumaran

72c238e

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

[diff] [blame]

760

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

Senthil Kumaran

600b735

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

[diff] [blame]

761

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

Serhiy Storchaka

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

[diff] [blame]

762

try:

763

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

764

except UnicodeDecodeError:

765

path = urllib.parse.unquote(path)

766

path = posixpath.normpath(path)

Georg Brandl

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

[diff] [blame]

767

words = path.split('/')

768

words = filter(None, words)

769

path = os.getcwd()

770

for word in words:

771

drive, word = os.path.splitdrive(word)

772

head, word = os.path.split(word)

773

if word in (os.curdir, os.pardir): continue

774

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

Senthil Kumaran

72c238e

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

[diff] [blame]

775

if trailing_slash:

776

path += '/'

Georg Brandl

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

[diff] [blame]

777

return path

778

779

def copyfile(self, source, outputfile):

780

"""Copy all data between two file objects.

781

782

The SOURCE argument is a file object open for reading

783

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

784

argument is a file object open for writing (or

785

anything with a write() method).

786

787

The only reason for overriding this would be to change

788

the block size or perhaps to replace newlines by CRLF

789

-- note however that this the default server uses this

790

to copy binary data as well.

791

792

"""

793

shutil.copyfileobj(source, outputfile)

794

795

def guess_type(self, path):

796

"""Guess the type of a file.

797

798

Argument is a PATH (a filename).

799

800

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

801

usable for a MIME Content-type header.

802

803

The default implementation looks the file's extension

804

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

805

as a default; however it would be permissible (if

806

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

"""

base, ext = posixpath.splitext(path)

811

if ext in self.extensions_map:

812

return self.extensions_map[ext]

813

ext = ext.lower()

814

if ext in self.extensions_map:

815

return self.extensions_map[ext]

816

else:

817

return self.extensions_map['']

818

819

if not mimetypes.inited:

820

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

821

extensions_map = mimetypes.types_map.copy()

822

extensions_map.update({

823

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

'.py': 'text/plain',

'.c': 'text/plain',

'.h': 'text/plain',

})

# Utilities for CGIHTTPRequestHandler

831

Senthil Kumaran

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

[diff] [blame]

832

def _url_collapse_path(path):

Benjamin Peterson

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

[diff] [blame]

833

"""

834

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

Martin Panter

9955a37

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

[diff] [blame]

835

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

Benjamin Peterson

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

[diff] [blame]

836

837

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]

838

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

839

preventing some security attacks.

Benjamin Peterson

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

[diff] [blame]

840

Martin Panter

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

[diff] [blame]

841

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

Benjamin Peterson

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

[diff] [blame]

842

843

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

Senthil Kumaran

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

[diff] [blame]

844

Benjamin Peterson

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

[diff] [blame]

845

"""

Martin Panter

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

[diff] [blame]

846

# Query component should not be involved.

847

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

848

path = urllib.parse.unquote(path)

849

Benjamin Peterson

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

[diff] [blame]

850

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

851

# path semantics rather than local operating system semantics.

Senthil Kumaran

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

[diff] [blame]

852

path_parts = path.split('/')

853

head_parts = []

854

for part in path_parts[:-1]:

855

if part == '..':

856

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

857

elif part and part != '.':

858

head_parts.append( part )

Benjamin Peterson

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

[diff] [blame]

859

if path_parts:

Senthil Kumaran

dbb369d

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

[diff] [blame]

860

tail_part = path_parts.pop()

Senthil Kumaran

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

[diff] [blame]

861

if tail_part:

862

if tail_part == '..':

863

head_parts.pop()

864

tail_part = ''

865

elif tail_part == '.':

866

tail_part = ''

Benjamin Peterson

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

[diff] [blame]

867

else:

868

tail_part = ''

Senthil Kumaran

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

[diff] [blame]

869

Martin Panter

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

[diff] [blame]

870

if query:

871

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

872

Senthil Kumaran

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

[diff] [blame]

873

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

874

collapsed_path = "/".join(splitpath)

875

876

return collapsed_path

877

Benjamin Peterson

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

[diff] [blame]

878

879

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]

889

except ImportError:

Georg Brandl

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

[diff] [blame]

890

return -1

891

try:

892

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

893

except KeyError:

Georg Brandl

cbd2ab1

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

[diff] [blame]

894

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):

899

"""Test for executable file."""

Victor Stinner

fb25ba9

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

[diff] [blame]

900

return os.access(path, os.X_OK)

Georg Brandl

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

[diff] [blame]

901

902

903

class CGIHTTPRequestHandler(SimpleHTTPRequestHandler):

904

905

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

906

907

GET and HEAD also support running CGI scripts.

908

909

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

"""

# Determine platform specifics

914

have_fork = hasattr(os, 'fork')

Georg Brandl

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

[diff] [blame]

915

916

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

917

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

rbufsize = 0

def do_POST(self):

"""Serve a POST request.

922

923

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]

930

self.send_error(

931

HTTPStatus.NOT_IMPLEMENTED,

932

"Can only POST to CGI scripts")

Georg Brandl

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

[diff] [blame]

933

934

def send_head(self):

935

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

936

if self.is_cgi():

937

return self.run_cgi()

938

else:

939

return SimpleHTTPRequestHandler.send_head(self)

940

941

def is_cgi(self):

942

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

943

Benjamin Peterson

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

[diff] [blame]

944

Returns True and updates the cgi_info attribute to the tuple

945

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

946

Returns False otherwise.

Georg Brandl

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

[diff] [blame]

947

Benjamin Peterson

a7deeee

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

[diff] [blame]

948

If any exception is raised, the caller should assume that

949

self.path was rejected as invalid and act accordingly.

950

Benjamin Peterson

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

[diff] [blame]

951

The default implementation tests whether the normalized url

952

path begins with one of the strings in self.cgi_directories

953

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

Georg Brandl

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

[diff] [blame]

954

955

"""

Martin Panter

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

[diff] [blame]

956

collapsed_path = _url_collapse_path(self.path)

Senthil Kumaran

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

[diff] [blame]

957

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

958

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

Senthil Kumaran

dbb369d

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

[diff] [blame]

959

if head in self.cgi_directories:

960

self.cgi_info = head, tail

Benjamin Peterson

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

[diff] [blame]

961

return True

Georg Brandl

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

[diff] [blame]

962

return False

963

Senthil Kumaran

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

[diff] [blame]

964

Georg Brandl

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

[diff] [blame]

965

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

966

967

def is_executable(self, path):

968

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

969

return executable(path)

970

971

def is_python(self, path):

972

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

973

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

974

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

975

976

def run_cgi(self):

977

"""Execute a CGI script."""

Georg Brandl

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

[diff] [blame]

978

dir, rest = self.cgi_info

Ned Deily

915a30f

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

[diff] [blame]

979

path = dir + '/' + rest

980

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

Georg Brandl

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

[diff] [blame]

981

while i >= 0:

Ned Deily

915a30f

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

[diff] [blame]

982

nextdir = path[:i]

983

nextrest = path[i+1:]

Georg Brandl

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

[diff] [blame]

984

985

scriptdir = self.translate_path(nextdir)

986

if os.path.isdir(scriptdir):

987

dir, rest = nextdir, nextrest

Ned Deily

915a30f

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

[diff] [blame]

988

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]

993

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

Georg Brandl

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

[diff] [blame]

994

995

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

996

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

997

i = rest.find('/')

998

if i >= 0:

999

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

1000

else:

1001

script, rest = rest, ''

1002

1003

scriptname = dir + '/' + script

1004

scriptfile = self.translate_path(scriptname)

1005

if not os.path.exists(scriptfile):

Serhiy Storchaka

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

[diff] [blame]

1006

self.send_error(

1007

HTTPStatus.NOT_FOUND,

1008

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

Georg Brandl

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

[diff] [blame]

1009

return

1010

if not os.path.isfile(scriptfile):

Serhiy Storchaka

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

[diff] [blame]

1011

self.send_error(

1012

HTTPStatus.FORBIDDEN,

1013

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

Georg Brandl

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

[diff] [blame]

1014

return

1015

ispy = self.is_python(scriptname)

Victor Stinner

fb25ba9

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

[diff] [blame]

1016

if self.have_fork or not ispy:

Georg Brandl

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

[diff] [blame]

1017

if not self.is_executable(scriptfile):

Serhiy Storchaka

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

[diff] [blame]

1018

self.send_error(

1019

HTTPStatus.FORBIDDEN,

1020

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

Georg Brandl

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

[diff] [blame]

1021

return

1022

1023

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

1024

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

Senthil Kumaran

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

[diff] [blame]

1025

env = copy.deepcopy(os.environ)

Georg Brandl

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

[diff] [blame]

1026

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

1027

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

1028

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

1029

env['SERVER_PROTOCOL'] = self.protocol_version

1030

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

1031

env['REQUEST_METHOD'] = self.command

Jeremy Hylton

1afc169

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

[diff] [blame]

1032

uqrest = urllib.parse.unquote(rest)

Georg Brandl

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

[diff] [blame]

1033

env['PATH_INFO'] = uqrest

1034

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

1035

env['SCRIPT_NAME'] = scriptname

1036

if query:

1037

env['QUERY_STRING'] = query

Georg Brandl

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

[diff] [blame]

1038

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

Barry Warsaw

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

[diff] [blame]

1039

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

Georg Brandl

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

[diff] [blame]

1040

if authorization:

1041

authorization = authorization.split()

1042

if len(authorization) == 2:

1043

import base64, binascii

1044

env['AUTH_TYPE'] = authorization[0]

1045

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

1046

try:

1047

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

Georg Brandl

706824f

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

[diff] [blame]

1048

authorization = base64.decodebytes(authorization).\

Georg Brandl

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

[diff] [blame]

1049

decode('ascii')

1050

except (binascii.Error, UnicodeError):

1051

pass

1052

else:

1053

authorization = authorization.split(':')

1054

if len(authorization) == 2:

1055

env['REMOTE_USER'] = authorization[0]

1056

# XXX REMOTE_IDENT

Barry Warsaw

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

[diff] [blame]

1057

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

1058

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

Georg Brandl

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

[diff] [blame]

1059

else:

Barry Warsaw

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

[diff] [blame]

1060

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

1061

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

Georg Brandl

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

[diff] [blame]

1062

if length:

1063

env['CONTENT_LENGTH'] = length

Barry Warsaw

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

[diff] [blame]

1064

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

Georg Brandl

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

[diff] [blame]

1065

if referer:

1066

env['HTTP_REFERER'] = referer

1067

accept = []

1068

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

1069

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

1070

accept.append(line.strip())

1071

else:

1072

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

1073

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

Barry Warsaw

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

[diff] [blame]

1074

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

Georg Brandl

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

[diff] [blame]

1075

if ua:

1076

env['HTTP_USER_AGENT'] = ua

Barry Warsaw

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

[diff] [blame]

1077

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

Georg Brandl

62e2ca2

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

[diff] [blame]

1078

cookie_str = ', '.join(co)

1079

if cookie_str:

1080

env['HTTP_COOKIE'] = cookie_str

Georg Brandl

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

[diff] [blame]

1081

# XXX Other HTTP_* headers

1082

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

1083

# values to override previously set values

1084

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

1085

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

1086

env.setdefault(k, "")

Georg Brandl

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

[diff] [blame]

1087

Serhiy Storchaka

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

[diff] [blame]

1088

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

Senthil Kumaran

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

[diff] [blame]

1089

self.flush_headers()

Georg Brandl

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

[diff] [blame]

1090

1091

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

1092

1093

if self.have_fork:

1094

# Unix -- fork as we should

1095

args = [script]

1096

if '=' not in decoded_query:

1097

args.append(decoded_query)

1098

nobody = nobody_uid()

1099

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

pid = os.fork()

if pid != 0:

# Parent

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

1104

# throw away additional data [see bug #427345]

1105

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

1106

if not self.rfile.read(1):

1107

break

1108

if sts:

1109

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]

1115

except OSError:

Georg Brandl

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

[diff] [blame]

1116

pass

1117

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

1118

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

Senthil Kumaran

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

[diff] [blame]

1119

os.execve(scriptfile, args, env)

Georg Brandl

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

[diff] [blame]

1120

except:

1121

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

1122

os._exit(127)

1123

Amaury Forgeot d'Arc

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

[diff] [blame]

1124

else:

1125

# Non-Unix -- use subprocess

1126

import subprocess

Senthil Kumaran

e29cd16

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

[diff] [blame]

1127

cmdline = [scriptfile]

Georg Brandl

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

[diff] [blame]

1128

if self.is_python(scriptfile):

1129

interp = sys.executable

1130

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

1131

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

1132

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

Senthil Kumaran

e29cd16

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

[diff] [blame]

1133

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

1134

if '=' not in query:

1135

cmdline.append(query)

1136

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

Georg Brandl

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

[diff] [blame]

1137

try:

1138

nbytes = int(length)

1139

except (TypeError, ValueError):

1140

nbytes = 0

Amaury Forgeot d'Arc

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

[diff] [blame]

1141

p = subprocess.Popen(cmdline,

1142

stdin=subprocess.PIPE,

1143

stdout=subprocess.PIPE,

Senthil Kumaran

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

[diff] [blame]

1144

stderr=subprocess.PIPE,

1145

env = env

Amaury Forgeot d'Arc

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

[diff] [blame]

1146

)

Georg Brandl

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

[diff] [blame]

1147

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

1148

data = self.rfile.read(nbytes)

Amaury Forgeot d'Arc

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

[diff] [blame]

1149

else:

1150

data = None

Georg Brandl

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

[diff] [blame]

1151

# throw away additional data [see bug #427345]

1152

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

1153

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

1154

break

Amaury Forgeot d'Arc

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

[diff] [blame]

1155

stdout, stderr = p.communicate(data)

1156

self.wfile.write(stdout)

1157

if stderr:

1158

self.log_error('%s', stderr)

Brian Curtin

cbad4df

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

[diff] [blame]

1159

p.stderr.close()

1160

p.stdout.close()

Amaury Forgeot d'Arc

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

[diff] [blame]

1161

status = p.returncode

1162

if status:

1163

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

Georg Brandl

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

[diff] [blame]

1164

else:

1165

self.log_message("CGI script exited OK")

1166

1167

Senthil Kumaran

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

[diff] [blame]

1168

def test(HandlerClass=BaseHTTPRequestHandler,

1169

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

Georg Brandl

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

[diff] [blame]

1170

"""Test the HTTP request handler class.

1171

Robert Collins

9644f24

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

[diff] [blame]

1172

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

Georg Brandl

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

[diff] [blame]

1173

1174

"""

Senthil Kumaran

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

[diff] [blame]

1175

server_address = (bind, port)

Georg Brandl

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

[diff] [blame]

1176

1177

HandlerClass.protocol_version = protocol

1178

httpd = ServerClass(server_address, HandlerClass)

1179

1180

sa = httpd.socket.getsockname()

1181

print("Serving HTTP on", sa[0], "port", sa[1], "...")

Alexandre Vassalotti

b5292a2

2009-04-03 07:16:55 +0000

[diff] [blame]

1182

try:

1183

httpd.serve_forever()

1184

except KeyboardInterrupt:

1185

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

1186

httpd.server_close()

1187

sys.exit(0)

Georg Brandl

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

[diff] [blame]

1188

1189

if __name__ == '__main__':

Senthil Kumaran

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

[diff] [blame]

1190

parser = argparse.ArgumentParser()

1191

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

1192

help='Run as CGI Server')

Senthil Kumaran

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

[diff] [blame]

1193

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

1194

help='Specify alternate bind address '

1195

'[default: all interfaces]')

Senthil Kumaran

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

[diff] [blame]

1196

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

1197

default=8000, type=int,

1198

nargs='?',

1199

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

1200

args = parser.parse_args()

1201

if args.cgi:

Senthil Kumaran

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

[diff] [blame]

1202

handler_class = CGIHTTPRequestHandler

Senthil Kumaran

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

[diff] [blame]

1203

else:

Senthil Kumaran