Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 1 | """Simple HTTP Server. |
| 2 | |
| 3 | This module builds on BaseHTTPServer by implementing the standard GET |
| 4 | and HEAD requests in a fairly straightforward manner. |
| 5 | |
| 6 | """ |
| 7 | |
| 8 | |
| 9 | __version__ = "0.3" |
| 10 | |
| 11 | |
| 12 | import os |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 13 | import sys |
| 14 | import time |
| 15 | import socket |
| 16 | import string |
| 17 | import posixpath |
| 18 | import SocketServer |
| 19 | import BaseHTTPServer |
| 20 | |
| 21 | |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 22 | class SimpleHTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler): |
| 23 | |
| 24 | """Simple HTTP request handler with GET and HEAD commands. |
| 25 | |
| 26 | This serves files from the current directory and any of its |
| 27 | subdirectories. It assumes that all files are plain text files |
| 28 | unless they have the extension ".html" in which case it assumes |
| 29 | they are HTML files. |
| 30 | |
| 31 | The GET and HEAD requests are identical except that the HEAD |
| 32 | request omits the actual contents of the file. |
| 33 | |
| 34 | """ |
| 35 | |
| 36 | server_version = "SimpleHTTP/" + __version__ |
| 37 | |
| 38 | def do_GET(self): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 39 | """Serve a GET request.""" |
| 40 | f = self.send_head() |
| 41 | if f: |
| 42 | self.copyfile(f, self.wfile) |
| 43 | f.close() |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 44 | |
| 45 | def do_HEAD(self): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 46 | """Serve a HEAD request.""" |
| 47 | f = self.send_head() |
| 48 | if f: |
| 49 | f.close() |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 50 | |
| 51 | def send_head(self): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 52 | """Common code for GET and HEAD commands. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 53 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 54 | This sends the response code and MIME headers. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 55 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 56 | Return value is either a file object (which has to be copied |
| 57 | to the outputfile by the caller unless the command was HEAD, |
| 58 | and must be closed by the caller under all circumstances), or |
| 59 | None, in which case the caller has nothing further to do. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 60 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 61 | """ |
| 62 | path = self.translate_path(self.path) |
| 63 | if os.path.isdir(path): |
| 64 | self.send_error(403, "Directory listing not supported") |
| 65 | return None |
| 66 | try: |
| 67 | f = open(path) |
| 68 | except IOError: |
| 69 | self.send_error(404, "File not found") |
| 70 | return None |
| 71 | self.send_response(200) |
| 72 | self.send_header("Content-type", self.guess_type(path)) |
| 73 | self.end_headers() |
| 74 | return f |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 75 | |
| 76 | def translate_path(self, path): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 77 | """Translate a /-separated PATH to the local filename syntax. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 78 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 79 | Components that mean special things to the local file system |
| 80 | (e.g. drive or directory names) are ignored. (XXX They should |
| 81 | probably be diagnosed.) |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 82 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 83 | """ |
| 84 | path = posixpath.normpath(path) |
| 85 | words = string.splitfields(path, '/') |
| 86 | words = filter(None, words) |
| 87 | path = os.getcwd() |
| 88 | for word in words: |
| 89 | drive, word = os.path.splitdrive(word) |
| 90 | head, word = os.path.split(word) |
| 91 | if word in (os.curdir, os.pardir): continue |
| 92 | path = os.path.join(path, word) |
| 93 | return path |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 94 | |
| 95 | def copyfile(self, source, outputfile): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 96 | """Copy all data between two file objects. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 97 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 98 | The SOURCE argument is a file object open for reading |
| 99 | (or anything with a read() method) and the DESTINATION |
| 100 | argument is a file object open for writing (or |
| 101 | anything with a write() method). |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 102 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 103 | The only reason for overriding this would be to change |
| 104 | the block size or perhaps to replace newlines by CRLF |
| 105 | -- note however that this the default server uses this |
| 106 | to copy binary data as well. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 107 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 108 | """ |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 109 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 110 | BLOCKSIZE = 8192 |
| 111 | while 1: |
| 112 | data = source.read(BLOCKSIZE) |
| 113 | if not data: break |
| 114 | outputfile.write(data) |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 115 | |
| 116 | def guess_type(self, path): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 117 | """Guess the type of a file. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 118 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 119 | Argument is a PATH (a filename). |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 120 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 121 | Return value is a string of the form type/subtype, |
| 122 | usable for a MIME Content-type header. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 123 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 124 | The default implementation looks the file's extension |
| 125 | up in the table self.extensions_map, using text/plain |
| 126 | as a default; however it would be permissible (if |
| 127 | slow) to look inside the data to make a better guess. |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 128 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 129 | """ |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 130 | |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 131 | base, ext = posixpath.splitext(path) |
| 132 | if self.extensions_map.has_key(ext): |
| 133 | return self.extensions_map[ext] |
| 134 | ext = string.lower(ext) |
| 135 | if self.extensions_map.has_key(ext): |
| 136 | return self.extensions_map[ext] |
| 137 | else: |
| 138 | return self.extensions_map[''] |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 139 | |
| 140 | extensions_map = { |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 141 | '': 'text/plain', # Default, *must* be present |
| 142 | '.html': 'text/html', |
| 143 | '.htm': 'text/html', |
| 144 | '.gif': 'image/gif', |
| 145 | '.jpg': 'image/jpeg', |
| 146 | '.jpeg': 'image/jpeg', |
| 147 | } |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 148 | |
| 149 | |
| 150 | def test(HandlerClass = SimpleHTTPRequestHandler, |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 151 | ServerClass = SocketServer.TCPServer): |
Guido van Rossum | 5c97167 | 1996-07-22 15:23:25 +0000 | [diff] [blame] | 152 | BaseHTTPServer.test(HandlerClass, ServerClass) |
| 153 | |
| 154 | |
| 155 | if __name__ == '__main__': |
| 156 | test() |