I brewed a simple Python-based http server using sockets today and I wanted to share the code, along with some comments. Sure, there is the http.server class, but why not have some fun? Building a fully-fledged HTTP server is a big undertaking. I focused on building a small server, supporting only the basic functionality of the Hyper Text Transfer Protocol (namely the GET and HEAD request methods).
Some basic info
In short, HTTP is a request-response protocol. The web browser attempts to connects to the http server, HTTP server (usually) accepts the connection requests and goes into receiving mode. The client (e.g. web browser) sends one of the nine request methods to the server, along with the methods arguments. Server then processes the request and issues appropriate response. An example request looks like this:
As I have already mentioned, my server support only a GET and HEAD request method. the GET request method request specific a resource from the server. The server responds with headers and the resource body. The HEAD method is similar to GET, it differs in that the server responds only with the headers. This can be useful when a client wants to determine whether e.g. a time stamp on a resource has changed, and whether it has to be re-requested.
I designed by server class to expect a port number on which it is to listen for connection, with a default value of 80. However you might need to run the server script in a privileged mode in order to successfully acquire this (or any other low) port from your system. Thus, in case the script fails to acquire the default or user provided port, it will attempt to acquire port 8080 as a last resort.
When the client requests a resource, the server attempts to open it from the local www/ folder. If the resource is present, server serves it, accompanied with appropriate headers (status 200 OK). If the resource is not present, the server then serves a error 404 web page, along with a slightly different header set describing the encountered problem.
Notice, that web server does parse in any way the GET arguments if they are provided in the URL (URL encoded arguments, in the form of index.html?arg1=val1&arg2=val2). It does, however, strip them from the URL, if they are present and servers the resource. Also note that this server runs only a single thread, thus serving one user at a time. The server is not meant to be fast nor secure. I must say that coding this server made for fun-filled afternoon. If I will have some free time in the future maybe I will extend it’s functionality a bit.
Sample HEAD request to my server issued by Firefox
HEAD /index.html HTTP/1.1 Host: localhost User-Agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:22.214.171.124) Gecko/20100423 Ubuntu/10.04 (lucid) Firefox/3.6.3 Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115 Connection: keep-alive
The most important is the first line. It specifies the request method (HEAD) and it’s arguments, most notably the file which is being requested. The second lines specifies the internet host and port of the resource requested. Lack of port following the local host implies port 80. More on the following lines can be found here. Response
Sample response headers sent from the server to the client:
HTTP/1.1 200 OK Date: Sat, 19 Mar 2011 16:42:17 Server: Simple-Python-HTTP-Server Connection: close
Notice, that it’s only basic response, containing only some basic information — most notably the first line, confirming that the requested resource exists. For the contrast, here is a sample response header from the server after the client had requested a non-existing resource:
HTTP/1.1 404 Not Found Date: Sat, 19 Mar 2011 16:44:53 Server: Simple-Python-HTTP-Server Connection: close
Final HTTP server code
And now for the code. Oh, and here’s the code along with some simple html/css/jpg files for testing: python-http-server.tar.gz. Also, you might want to check out some kind of a browser plugin which allows to issue custom HTTP request methods and view the response, such as this one.
#!/usr/bin/python import socket # Networking support import signal # Signal support (server shutdown on signal receive) import time # Current time class Server: """ Class describing a simple HTTP server objects.""" def __init__(self, port = 80): """ Constructor """ self.host = '' # <-- works on all avaivable network interfaces self.port = port self.www_dir = 'www' # Directory where webpage files are stored def activate_server(self): """ Attempts to aquire the socket and launch the server """ self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try: # user provided in the __init__() port may be unavaivable print("Launching HTTP server on ", self.host, ":",self.port) self.socket.bind((self.host, self.port)) except Exception as e: print ("Warning: Could not aquite port:",self.port,"\n") print ("I will try a higher port") # store to user provideed port locally for later (in case 8080 fails) user_port = self.port self.port = 8080 try: print("Launching HTTP server on ", self.host, ":",self.port) self.socket.bind((self.host, self.port)) except Exception as e: print("ERROR: Failed to acquire sockets for ports ", user_port, " and 8080. ") print("Try running the Server in a privileged user mode.") self.shutdown() import sys sys.exit(1) print ("Server successfully acquired the socket with port:", self.port) print ("Press Ctrl+C to shut down the server and exit.") self._wait_for_connections() def shutdown(self): """ Shut down the server """ try: print("Shutting down the server") s.socket.shutdown(socket.SHUT_RDWR) except Exception as e: print("Warning: could not shut down the socket. Maybe it was already closed?",e) def _gen_headers(self, code): """ Generates HTTP response Headers. Ommits the first line! """ # determine response code h = '' if (code == 200): h = 'HTTP/1.1 200 OK\n' elif(code == 404): h = 'HTTP/1.1 404 Not Found\n' # write further headers current_date = time.strftime("%a, %d %b %Y %H:%M:%S", time.localtime()) h += 'Date: ' + current_date +'\n' h += 'Server: Simple-Python-HTTP-Server\n' h += 'Connection: close\n\n' # signal that the conection wil be closed after complting the request return h def _wait_for_connections(self): """ Main loop awaiting connections """ while True: print ("Awaiting New connection") self.socket.listen(3) # maximum number of queued connections conn, addr = self.socket.accept() # conn - socket to client # addr - clients address print("Got connection from:", addr) data = conn.recv(1024) #receive data from client string = bytes.decode(data) #decode it to string #determine request method (HEAD and GET are supported) request_method = string.split(' ') print ("Method: ", request_method) print ("Request body: ", string) #if string[0:3] == 'GET': if (request_method == 'GET') | (request_method == 'HEAD'): #file_requested = string[4:] # split on space "GET /file.html" -into-> ('GET','file.html',...) file_requested = string.split(' ') file_requested = file_requested # get 2nd element #Check for URL arguments. Disregard them file_requested = file_requested.split('?') # disregard anything after '?' if (file_requested == '/'): # in case no file is specified by the browser file_requested = '/index.html' # load index.html by default file_requested = self.www_dir + file_requested print ("Serving web page [",file_requested,"]") ## Load file content try: file_handler = open(file_requested,'rb') if (request_method == 'GET'): #only read the file when GET response_content = file_handler.read() # read file content file_handler.close() response_headers = self._gen_headers( 200) except Exception as e: #in case file was not found, generate 404 page print ("Warning, file not found. Serving response code 404\n", e) response_headers = self._gen_headers( 404) if (request_method == 'GET'): response_content = b"<html><body><p>Error 404: File not found</p><p>Python HTTP server</p></body></html>" server_response = response_headers.encode() # return headers for GET and HEAD if (request_method == 'GET'): server_response += response_content # return additional conten for GET only conn.send(server_response) print ("Closing connection with client") conn.close() else: print("Unknown HTTP request method:", request_method) def graceful_shutdown(sig, dummy): """ This function shuts down the server. It's triggered by SIGINT signal """ s.shutdown() #shut down the server import sys sys.exit(1) ########################################################### # shut down on ctrl+c signal.signal(signal.SIGINT, graceful_shutdown) print ("Starting web server") s = Server(80) # construct server object s.activate_server() # aquire the socket