Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython2 / d8be9feb45baab60959d4076dc997062b307206f / . / Lib / SimpleHTTPServer.py
blob: 1a172968658759afd51c9679cbe714e38aa6679a [file] [log] [blame]
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]1"""Simple HTTP Server.
2
3This module builds on BaseHTTPServer by implementing the standard GET
4and HEAD requests in a fairly straightforward manner.
5
6"""
7
8
Guido van Rossum077153e2001-01-14 23:21:25 +0000[diff] [blame]9__version__ = "0.6"
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]10
Skip Montanaroe99d5ea2001-01-20 19:54:20 +0000[diff] [blame]11__all__ = ["SimpleHTTPRequestHandler"]
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]12
13import os
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]14import posixpath
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]15import BaseHTTPServer
Guido van Rossumd7b147b1999-11-16 19:04:32 +0000[diff] [blame]16import urllib
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]17import cgi
Senthil Kumaran38535862011-03-17 12:34:18 +0800[diff] [blame]18import sys
Moshe Zadka37c03ff2000-07-29 05:15:56 +0000[diff] [blame]19import shutil
Guido van Rossum077153e2001-01-14 23:21:25 +0000[diff] [blame]20import mimetypes
Raymond Hettingera6172712004-12-31 19:15:26 +0000[diff] [blame]21try:
22 from cStringIO import StringIO
23except ImportError:
24 from StringIO import StringIO
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]25
26
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]27class SimpleHTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
28
29 """Simple HTTP request handler with GET and HEAD commands.
30
31 This serves files from the current directory and any of its
Andrew M. Kuchlingb839c1f2004-08-07 19:02:19 +0000[diff] [blame]32 subdirectories. The MIME type for files is determined by
33 calling the .guess_type() method.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]34
35 The GET and HEAD requests are identical except that the HEAD
36 request omits the actual contents of the file.
37
38 """
39
40 server_version = "SimpleHTTP/" + __version__
41
42 def do_GET(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]43 """Serve a GET request."""
44 f = self.send_head()
45 if f:
46 self.copyfile(f, self.wfile)
47 f.close()
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]48
49 def do_HEAD(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]50 """Serve a HEAD request."""
51 f = self.send_head()
52 if f:
53 f.close()
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]54
55 def send_head(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]56 """Common code for GET and HEAD commands.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]57
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]58 This sends the response code and MIME headers.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]59
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]60 Return value is either a file object (which has to be copied
61 to the outputfile by the caller unless the command was HEAD,
62 and must be closed by the caller under all circumstances), or
63 None, in which case the caller has nothing further to do.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]64
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]65 """
66 path = self.translate_path(self.path)
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]67 f = None
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]68 if os.path.isdir(path):
Andrew M. Kuchling42819022006-12-22 19:06:16 +0000[diff] [blame]69 if not self.path.endswith('/'):
70 # redirect browser - doing basically what apache does
71 self.send_response(301)
72 self.send_header("Location", self.path + "/")
73 self.end_headers()
74 return None
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]75 for index in "index.html", "index.htm":
76 index = os.path.join(path, index)
77 if os.path.exists(index):
78 path = index
79 break
80 else:
81 return self.list_directory(path)
82 ctype = self.guess_type(path)
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]83 try:
Amaury Forgeot d'Arc0f7cddc2008-07-06 21:34:39 +0000[diff] [blame]84 # Always read in binary mode. Opening files in text mode may cause
85 # newline translations, making the actual size of the content
86 # transmitted *less* than the content-length!
87 f = open(path, 'rb')
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]88 except IOError:
89 self.send_error(404, "File not found")
90 return None
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]91 self.send_response(200)
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]92 self.send_header("Content-type", ctype)
Georg Brandl5d076962006-02-17 13:34:16 +0000[diff] [blame]93 fs = os.fstat(f.fileno())
94 self.send_header("Content-Length", str(fs[6]))
95 self.send_header("Last-Modified", self.date_time_string(fs.st_mtime))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]96 self.end_headers()
97 return f
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]98
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]99 def list_directory(self, path):
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]100 """Helper to produce a directory listing (absent index.html).
101
102 Return value is either a file object, or None (indicating an
103 error). In either case, the headers are sent, making the
104 interface the same as for send_head().
105
106 """
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]107 try:
108 list = os.listdir(path)
109 except os.error:
Jeremy Hylton5b48c452001-01-26 17:08:32 +0000[diff] [blame]110 self.send_error(404, "No permission to list directory")
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]111 return None
Raymond Hettinger6b59f5f2003-10-16 05:53:16 +0000[diff] [blame]112 list.sort(key=lambda a: a.lower())
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]113 f = StringIO()
Georg Brandl6ee69522005-12-16 19:36:08 +0000[diff] [blame]114 displaypath = cgi.escape(urllib.unquote(self.path))
Andrew M. Kuchlinga6298522008-02-28 14:03:03 +0000[diff] [blame]115 f.write('<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">')
116 f.write("<html>\n<title>Directory listing for %s</title>\n" % displaypath)
117 f.write("<body>\n<h2>Directory listing for %s</h2>\n" % displaypath)
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]118 f.write("<hr>\n<ul>\n")
119 for name in list:
120 fullname = os.path.join(path, name)
Johannes Gijsbers6d63a8d2004-08-21 10:43:29 +0000[diff] [blame]121 displayname = linkname = name
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]122 # Append / for directories or @ for symbolic links
123 if os.path.isdir(fullname):
124 displayname = name + "/"
Guido van Rossum1d105d12000-09-04 15:55:31 +0000[diff] [blame]125 linkname = name + "/"
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]126 if os.path.islink(fullname):
127 displayname = name + "@"
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]128 # Note: a link to a directory displays with @ and links with /
Johannes Gijsbers6d63a8d2004-08-21 10:43:29 +0000[diff] [blame]129 f.write('<li><a href="%s">%s</a>\n'
130 % (urllib.quote(linkname), cgi.escape(displayname)))
Andrew M. Kuchlinga6298522008-02-28 14:03:03 +0000[diff] [blame]131 f.write("</ul>\n<hr>\n</body>\n</html>\n")
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]132 length = f.tell()
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]133 f.seek(0)
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]134 self.send_response(200)
Senthil Kumaran38535862011-03-17 12:34:18 +0800[diff] [blame]135 encoding = sys.getfilesystemencoding()
136 self.send_header("Content-type", "text/html; charset=%s" % encoding)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]137 self.send_header("Content-Length", str(length))
Guido van Rossum1d10f3e2000-05-21 16:25:29 +0000[diff] [blame]138 self.end_headers()
Guido van Rossum57af0722000-05-09 14:57:09 +0000[diff] [blame]139 return f
140
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]141 def translate_path(self, path):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]142 """Translate a /-separated PATH to the local filename syntax.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]143
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]144 Components that mean special things to the local file system
145 (e.g. drive or directory names) are ignored. (XXX They should
146 probably be diagnosed.)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]147
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]148 """
Georg Brandl45ab2332006-01-13 17:05:56 +0000[diff] [blame]149 # abandon query parameters
Facundo Batistad14600e2008-02-18 12:48:43 +0000[diff] [blame]150 path = path.split('?',1)[0]
151 path = path.split('#',1)[0]
Senthil Kumarand4fac042013-09-13 00:18:55 -0700[diff] [blame]152 # Don't forget explicit trailing slash when normalizing. Issue17324
Senthil Kumarana719eed2013-09-29 18:57:42 -0700[diff] [blame]153 trailing_slash = path.rstrip().endswith('/')
Guido van Rossumd7b147b1999-11-16 19:04:32 +0000[diff] [blame]154 path = posixpath.normpath(urllib.unquote(path))
Eric S. Raymond304b6a32001-02-09 10:26:06 +0000[diff] [blame]155 words = path.split('/')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]156 words = filter(None, words)
157 path = os.getcwd()
158 for word in words:
159 drive, word = os.path.splitdrive(word)
160 head, word = os.path.split(word)
161 if word in (os.curdir, os.pardir): continue
162 path = os.path.join(path, word)
Senthil Kumarand4fac042013-09-13 00:18:55 -0700[diff] [blame]163 if trailing_slash:
164 path += '/'
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]165 return path
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]166
167 def copyfile(self, source, outputfile):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]168 """Copy all data between two file objects.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]169
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]170 The SOURCE argument is a file object open for reading
171 (or anything with a read() method) and the DESTINATION
172 argument is a file object open for writing (or
173 anything with a write() method).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]174
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]175 The only reason for overriding this would be to change
176 the block size or perhaps to replace newlines by CRLF
177 -- note however that this the default server uses this
178 to copy binary data as well.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]179
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]180 """
Moshe Zadka37c03ff2000-07-29 05:15:56 +0000[diff] [blame]181 shutil.copyfileobj(source, outputfile)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]182
183 def guess_type(self, path):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]184 """Guess the type of a file.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]185
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]186 Argument is a PATH (a filename).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]187
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]188 Return value is a string of the form type/subtype,
189 usable for a MIME Content-type header.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]190
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]191 The default implementation looks the file's extension
Andrew M. Kuchlingb839c1f2004-08-07 19:02:19 +0000[diff] [blame]192 up in the table self.extensions_map, using application/octet-stream
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]193 as a default; however it would be permissible (if
194 slow) to look inside the data to make a better guess.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]195
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]196 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]197
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]198 base, ext = posixpath.splitext(path)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000[diff] [blame]199 if ext in self.extensions_map:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]200 return self.extensions_map[ext]
Eric S. Raymondbf97c9d2001-02-09 10:18:37 +0000[diff] [blame]201 ext = ext.lower()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000[diff] [blame]202 if ext in self.extensions_map:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]203 return self.extensions_map[ext]
204 else:
205 return self.extensions_map['']
Tim Peters5d538b62006-06-14 22:38:13 +0000[diff] [blame]206
Georg Brandl83cc0d02006-06-14 08:50:03 +0000[diff] [blame]207 if not mimetypes.inited:
208 mimetypes.init() # try to read system mime.types
Guido van Rossum077153e2001-01-14 23:21:25 +0000[diff] [blame]209 extensions_map = mimetypes.types_map.copy()
210 extensions_map.update({
211 '': 'application/octet-stream', # Default
212 '.py': 'text/plain',
213 '.c': 'text/plain',
214 '.h': 'text/plain',
215 })
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]216
217
218def test(HandlerClass = SimpleHTTPRequestHandler,
Guido van Rossum5c3b3841998-12-07 04:08:30 +0000[diff] [blame]219 ServerClass = BaseHTTPServer.HTTPServer):
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]220 BaseHTTPServer.test(HandlerClass, ServerClass)
221
222
223if __name__ == '__main__':
224 test()