127 lines
4 KiB
Python
127 lines
4 KiB
Python
#!/usr/bin/env python
|
|
# Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
# found in the LICENSE file.
|
|
|
|
"""A tiny web server.
|
|
|
|
This is intended to be used for testing, and only run from within the examples
|
|
directory.
|
|
"""
|
|
|
|
import BaseHTTPServer
|
|
import logging
|
|
import optparse
|
|
import os
|
|
import SimpleHTTPServer
|
|
import SocketServer
|
|
import sys
|
|
import urlparse
|
|
|
|
logging.getLogger().setLevel(logging.INFO)
|
|
|
|
# Using 'localhost' means that we only accept connections
|
|
# via the loop back interface.
|
|
SERVER_PORT = 5103
|
|
SERVER_HOST = ''
|
|
|
|
# We only run from the examples directory so that not too much is exposed
|
|
# via this HTTP server. Everything in the directory is served, so there should
|
|
# never be anything potentially sensitive in the serving directory, especially
|
|
# if the machine might be a multi-user machine and not all users are trusted.
|
|
# We only serve via the loopback interface.
|
|
def SanityCheckDirectory():
|
|
httpd_path = os.path.abspath(os.path.dirname(__file__))
|
|
serve_path = os.path.abspath(os.getcwd())
|
|
|
|
# Verify we are serving from the directory this script came from, or bellow
|
|
if serve_path[:len(httpd_path)] == httpd_path:
|
|
return
|
|
logging.error('For security, httpd.py should only be run from within the')
|
|
logging.error('example directory tree.')
|
|
logging.error('We are currently in %s.' % serve_path)
|
|
sys.exit(1)
|
|
|
|
|
|
# An HTTP server that will quit when |is_running| is set to False. We also use
|
|
# SocketServer.ThreadingMixIn in order to handle requests asynchronously for
|
|
# faster responses.
|
|
class QuittableHTTPServer(SocketServer.ThreadingMixIn,
|
|
BaseHTTPServer.HTTPServer):
|
|
def serve_forever(self, timeout=0.5):
|
|
self.is_running = True
|
|
self.timeout = timeout
|
|
while self.is_running:
|
|
self.handle_request()
|
|
|
|
def shutdown(self):
|
|
self.is_running = False
|
|
return 1
|
|
|
|
|
|
# "Safely" split a string at |sep| into a [key, value] pair. If |sep| does not
|
|
# exist in |str|, then the entire |str| is the key and the value is set to an
|
|
# empty string.
|
|
def KeyValuePair(str, sep='='):
|
|
if sep in str:
|
|
return str.split(sep)
|
|
else:
|
|
return [str, '']
|
|
|
|
|
|
# A small handler that looks for '?quit=1' query in the path and shuts itself
|
|
# down if it finds that parameter.
|
|
class QuittableHTTPHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
|
|
def do_GET(self):
|
|
(_, _, _, query, _) = urlparse.urlsplit(self.path)
|
|
url_params = dict([KeyValuePair(key_value)
|
|
for key_value in query.split('&')])
|
|
if 'quit' in url_params and '1' in url_params['quit']:
|
|
self.send_response(200, 'OK')
|
|
self.send_header('Content-type', 'text/html')
|
|
self.send_header('Content-length', '0')
|
|
self.end_headers()
|
|
self.server.shutdown()
|
|
return
|
|
|
|
SimpleHTTPServer.SimpleHTTPRequestHandler.do_GET(self)
|
|
|
|
|
|
def Run(server_address,
|
|
server_class=QuittableHTTPServer,
|
|
handler_class=QuittableHTTPHandler):
|
|
httpd = server_class(server_address, handler_class)
|
|
logging.info("Starting local server on port %d", server_address[1])
|
|
logging.info("To shut down send http://localhost:%d?quit=1",
|
|
server_address[1])
|
|
try:
|
|
httpd.serve_forever()
|
|
except KeyboardInterrupt:
|
|
logging.info("Received keyboard interrupt.")
|
|
httpd.server_close()
|
|
|
|
logging.info("Shutting down local server on port %d", server_address[1])
|
|
|
|
|
|
def main():
|
|
usage_str = "usage: %prog [options] [optional_portnum]"
|
|
parser = optparse.OptionParser(usage=usage_str)
|
|
parser.add_option(
|
|
'--no_dir_check', dest='do_safe_check',
|
|
action='store_false', default=True,
|
|
help='Do not ensure that httpd.py is being run from a safe directory.')
|
|
(options, args) = parser.parse_args(sys.argv)
|
|
if options.do_safe_check:
|
|
SanityCheckDirectory()
|
|
if len(args) > 2:
|
|
print 'Too many arguments specified.'
|
|
parser.print_help()
|
|
elif len(args) == 2:
|
|
Run((SERVER_HOST, int(args[1])))
|
|
else:
|
|
Run((SERVER_HOST, SERVER_PORT))
|
|
return 0
|
|
|
|
|
|
if __name__ == '__main__':
|
|
sys.exit(main())
|