# (c) 2009-2014 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
# Original PyFileServer (c) 2005 Ho Chun Wei.
# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
"""
ext_wsgiutils_server.py is an extension of the wsgiutils server in Paste.
It supports passing all of the HTTP and WebDAV (rfc 2518) methods.
It includes code from the following sources:
``wsgiServer.py`` from wsgiKit under PSF license,
``wsgiutils_server.py`` from Paste under PSF license,
flexible handler method under public domain.
Running as standalone server
----------------------------
To run as a standalone server using the bundled ext_wsgiutils_server.py::
usage: python ext_wsgiutils_server.py [options] [config-file]
config-file:
The configuration file for WsgiDAV. if omitted, the application
will look for a file named 'WsgiDAV.conf' in the current directory
options:
--port=PORT Port to serve on (default: 8080)
--host=HOST Host to serve from (default: localhost, which is only
accessible from the local computer; use 0.0.0.0 to make your
application public)
-h, --help show this help message and exit
Running using other web servers
-------------------------------
To run it with other WSGI web servers, you can::
from wsgidav.mainappwrapper import PyFileApp
publish_app = PyFileApp('WsgiDAV.conf')
# construct the application with configuration file
# if configuration file is omitted, the application
# will look for a file named 'WsgiDAV.conf'
# in the current directory
where ``publish_app`` is the WSGI application to be run, it will be called with
``publish_app(environ, start_response)`` for each incoming request, as described in
WSGI
Note: if you are using the paster development server (from Paste ), you can
copy ``ext_wsgi_server.py`` to ``/paste/servers`` and use this server to run the
application by specifying ``server='ext_wsgiutils'`` in the ``server.conf`` or appropriate paste
configuration.
"""
__docformat__ = "reStructuredText"
from wsgidav.version import __version__
import time
import httplib
import socket
import threading
import SocketServer, BaseHTTPServer, urlparse
import sys, logging
import traceback
from wsgidav import util
try:
from cStringIO import StringIO
except ImportError:
from StringIO import StringIO
_logger = util.getModuleLogger(__name__)
SERVER_ERROR = """\
Server Error
Server Error
A server error has occurred. Please contact the system administrator for
more information.
"""
class ExtHandler (BaseHTTPServer.BaseHTTPRequestHandler):
_SUPPORTED_METHODS = ["HEAD", "GET", "PUT", "POST", "OPTIONS", "TRACE",
"DELETE", "PROPFIND", "PROPPATCH", "MKCOL", "COPY",
"MOVE", "LOCK", "UNLOCK"]
# Enable automatic keep-alive:
protocol_version = "HTTP/1.1"
server_version = "WsgiDAV/%s %s" % (__version__,
BaseHTTPServer.BaseHTTPRequestHandler.server_version)
def log_message (self, *args):
pass
# BaseHTTPServer.BaseHTTPRequestHandler.log_message(self, *args)
def log_request (self, *args):
pass
# BaseHTTPServer.BaseHTTPRequestHandler.log_request(self, *args)
def getApp (self):
# We want fragments to be returned as part of
_protocol, _host, path, _parameters, query, _fragment = urlparse.urlparse ("http://dummyhost%s" % self.path,
allow_fragments=False)
# Find any application we might have
for appPath, app in self.server.wsgiApplications:
if (path.startswith (appPath)):
# We found the application to use - work out the scriptName and pathInfo
pathInfo = path [len (appPath):]
if (len (pathInfo) > 0):
if (not pathInfo.startswith ("/")):
pathInfo = "/" + pathInfo
if (appPath.endswith ("/")):
scriptName = appPath[:-1]
else:
scriptName = appPath
# Return all this
return app, scriptName, pathInfo, query
return None, None, None, None
def handlerFunctionClosure(self,name):
def handlerFunction(*args,**kwargs):
self.do_method()
return handlerFunction
def do_method(self):
app, scriptName, pathInfo, query = self.getApp ()
if (not app):
self.send_error (404, "Application not found.")
return
self.runWSGIApp (app, scriptName, pathInfo, query)
def __getattr__(self, name):
if len(name)>3 and name[0:3] == "do_" and name[3:] in self._SUPPORTED_METHODS:
return self.handlerFunctionClosure(name)
else:
self.send_error (501, "Method Not Implemented.")
return
def runWSGIApp (self, application, scriptName, pathInfo, query):
logging.info ("Running application with SCRIPT_NAME %s PATH_INFO %s" % (scriptName, pathInfo))
if self.command == "PUT":
pass # breakpoint
env = {"wsgi.version": (1, 0),
"wsgi.url_scheme": "http",
"wsgi.input": self.rfile,
"wsgi.errors": sys.stderr,
"wsgi.multithread": 1,
"wsgi.multiprocess": 0,
"wsgi.run_once": 0,
"REQUEST_METHOD": self.command,
"SCRIPT_NAME": scriptName,
"PATH_INFO": pathInfo,
"QUERY_STRING": query,
"CONTENT_TYPE": self.headers.get("Content-Type", ""),
"CONTENT_LENGTH": self.headers.get("Content-Length", ""),
"REMOTE_ADDR": self.client_address[0],
"SERVER_NAME": self.server.server_address[0],
"SERVER_PORT": str(self.server.server_address[1]),
"SERVER_PROTOCOL": self.request_version,
}
for httpHeader, httpValue in self.headers.items():
if not httpHeader.lower() in ("content-type", "content-length"):
env ["HTTP_%s" % httpHeader.replace ("-", "_").upper()] = httpValue
# Setup the state
self.wsgiSentHeaders = 0
self.wsgiHeaders = []
try:
# We have there environment, now invoke the application
_logger.debug("runWSGIApp application()...")
result = application (env, self.wsgiStartResponse)
try:
for data in result:
if data:
self.wsgiWriteData(data)
else:
_logger.debug("runWSGIApp empty data")
finally:
_logger.debug("runWSGIApp finally.")
if hasattr(result, "close"):
result.close()
except:
_logger.debug("runWSGIApp caught exception...")
errorMsg = StringIO()
traceback.print_exc(file=errorMsg)
logging.error (errorMsg.getvalue())
if not self.wsgiSentHeaders:
self.wsgiStartResponse("500 Server Error", [("Content-type", "text/html")])
self.wsgiWriteData(SERVER_ERROR)
if not self.wsgiSentHeaders:
# GC issue 29 sending one byte, when content-length is '0' seems wrong
# We must write out something!
# self.wsgiWriteData (" ")
self.wsgiWriteData("")
return
def wsgiStartResponse (self, response_status, response_headers, exc_info=None):
_logger.debug("wsgiStartResponse(%s, %s, %s)" % (response_status, response_headers, exc_info))
if (self.wsgiSentHeaders):
raise Exception ("Headers already sent and start_response called again!")
# Should really take a copy to avoid changes in the application....
self.wsgiHeaders = (response_status, response_headers)
return self.wsgiWriteData
def wsgiWriteData (self, data):
if not self.wsgiSentHeaders:
status, headers = self.wsgiHeaders
# Need to send header prior to data
statusCode = status [:status.find (" ")]
statusMsg = status [status.find (" ") + 1:]
_logger.debug("wsgiWriteData: send headers '%r', %r" % (status, headers))
self.send_response (int (statusCode), statusMsg)
for header, value in headers:
self.send_header (header, value)
self.end_headers()
self.wsgiSentHeaders = 1
# Send the data
assert type(data) is str # If not, Content-Length is propably wrong!
try:
_logger.debug("wsgiWriteData: write %s bytes: '%r'..." % (len(data), data[:50]))
self.wfile.write(data)
except socket.error, e:
# Suppress stack trace when client aborts connection disgracefully:
# 10053: Software caused connection abort
# 10054: Connection reset by peer
if e[0] in (10053, 10054):
print >>sys.stderr, "*** Caught socket.error: ", e
else:
raise
class ExtServer (SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer):
def handle_error(self, request, client_address):
"""Handle an error gracefully. May be overridden.
The default is to print a traceback and continue.
"""
ei = sys.exc_info()
e = ei[1]
# Suppress stack trace when client aborts connection disgracefully:
# 10053: Software caused connection abort
# 10054: Connection reset by peer
if e[0] in (10053, 10054):
util.warn("*** Caught socket.error: %s" % e)
return
# This is what BaseHTTPServer.HTTPServer.handle_error does, but with
# added thread ID and using stderr
print >>sys.stderr, '-'*40
print >>sys.stderr, '<%s> Exception happened during processing of request from %s' % (threading._get_ident(), client_address)
print >>sys.stderr, client_address
traceback.print_exc()
print >>sys.stderr, '-'*40
print >>sys.stderr, request
# BaseHTTPServer.HTTPServer.handle_error(self, request, client_address)
def stop_serve_forever(self):
"""Stop serve_forever_stoppable()."""
assert hasattr(self, "stop_request"), "serve_forever_stoppable() must be called before"
assert not self.stop_request, "stop_serve_forever() must only be called once"
# # Flag stop request
self.stop_request = True
time.sleep(.01)
if self.stopped:
# print "stop_serve_forever() 'stopped'."
return
# Add a do_SHUTDOWN method to to the ExtHandler class
def _shutdownHandler(self):
"""Send 200 OK response, and set server.stop_request to True.
http://code.activestate.com/recipes/336012/
"""
# print "Handling do_SHUTDOWN request"
self.send_response(200)
self.end_headers()
self.server.stop_request = True
if not hasattr(ExtHandler, "do_SHUTDOWN"):
setattr(ExtHandler, "do_SHUTDOWN", _shutdownHandler)
# Send request, so socket is unblocked
(host, port) = self.server_address
# print "stop_serve_forever() sending %s:%s/ SHUTDOWN..." % (host, port)
conn = httplib.HTTPConnection("%s:%d" % (host, port))
conn.request("SHUTDOWN", "/")
# print "stop_serve_forever() sent SHUTDOWN request, reading response..."
conn.getresponse()
# print "stop_serve_forever() received SHUTDOWN response."
assert self.stop_request
def serve_forever_stoppable(self):
"""Handle one request at a time until stop_serve_forever().
http://code.activestate.com/recipes/336012/
"""
self.stop_request = False
self.stopped = False
while not self.stop_request:
self.handle_request()
# print "serve_forever_stoppable() stopped."
self.stopped = True
def __init__ (self, serverAddress, wsgiApplications, serveFiles=1):
BaseHTTPServer.HTTPServer.__init__ (self, serverAddress, ExtHandler)
appList = []
for urlPath, wsgiApp in wsgiApplications.items():
appList.append ((urlPath, wsgiApp))
self.wsgiApplications = appList
self.serveFiles = serveFiles
self.serverShuttingDown = 0
def serve(conf, app):
host = conf.get("host", "localhost")
port = int(conf.get("port", 8080))
server = ExtServer((host, port), {"": app})
if conf.get("verbose") >= 1:
if host in ("", "0.0.0.0"):
(hostname, _aliaslist, ipaddrlist) = socket.gethostbyname_ex(socket.gethostname())
print "WsgiDAV %s serving at %s, port %s (host='%s' %s)..." % (__version__, host, port, hostname, ipaddrlist)
else:
print "WsgiDAV %s serving at %s, port %s..." % (__version__, host, port)
server.serve_forever()
# server.serve_forever_stoppable()
if __name__ == "__main__":
raise RuntimeError("Use run_server.py")