wsgidir.py

   1 """WSGI handler for serving chained WSGI modules from physical files
   2
   3 The WSGI handler in this module ensures that the SCRIPT_FILENAME
   4 variable is properly set in every request and points out a file that
   5 exists and is readable. It then dispatches the request in one of two
   6 ways: If the header X-Ash-Python-Handler is set in the request, its
   7 value is used as the name of a handler object to dispatch the request
   8 to; otherwise, the file extension of the SCRIPT_FILENAME is used to
   9 determine the handler object.
  10
  11 The name of a handler object is specified as a string, which is split
  12 along its last constituent dot. The part left of the dot is the name
  13 of a module, which is imported; and the part right of the dot is the
  14 name of an object in that module, which should be a callable adhering
  15 to the WSGI specification. Alternatively, the module part may be
  16 omitted (such that the name is a string with no dots), in which case
  17 the handler object is looked up from this module.
  18
  19 By default, this module will handle files with the extensions `.wsgi'
  20 or `.wsgi3' using the `chain' handler, which chainloads such files and
  21 runs them as independent WSGI applications. See its documentation for
  22 details.
  23
  24 This module itself contains both an `application' and a `wmain'
  25 object. If this module is used by ashd-wsgi(1) or scgi-wsgi(1) so that
  26 its wmain function is called, arguments can be specified to it to
  27 install handlers for other file extensions. Such arguments take the
  28 form `.EXT=HANDLER', where EXT is the file extension to be handled,
  29 and HANDLER is a handler name, as described above. For example, the
  30 argument `.fpy=my.module.foohandler' can be given to pass requests for
  31 `.fpy' files to the function `foohandler' in the module `my.module'
  32 (which must, of course, be importable). When writing such handler
  33 functions, you may want to use the getmod() function in this module.
  34 """
  35
  36 import sys, os, threading, types, logging, importlib, getopt
  37 from . import wsgiutil
  38
  39 __all__ = ["application", "wmain", "getmod", "cachedmod", "chain"]
  40
  41 log = logging.getLogger("wsgidir")
  42
  43 class cachedmod(object):
  44     """Cache entry for modules loaded by getmod()
  45
  46     Instances of this class are returned by the getmod()
  47     function. They contain three data attributes:
  48      * mod - The loaded module
  49      * lock - A threading.Lock object, which can be used for
  50        manipulating this instance in a thread-safe manner
  51      * mtime - The time the file was last modified
  52
  53     Additional data attributes can be arbitrarily added for recording
  54     any meta-data about the module.
  55     """
  56     def __init__(self, mod = None, mtime = -1):
  57         self.lock = threading.Lock()
  58         self.mod = mod
  59         self.mtime = mtime
  60
  61 modcache = {}
  62 cachelock = threading.Lock()
  63
  64 def mangle(path):
  65     ret = ""
  66     for c in path:
  67         if c.isalnum():
  68             ret += c
  69         else:
  70             ret += "_"
  71     return ret
  72
  73 def getmod(path):
  74     """Load the given file as a module, caching it appropriately
  75
  76     The given file is loaded and compiled into a Python module. The
  77     compiled module is cached and returned upon subsequent requests
  78     for the same file, unless the file has changed (as determined by
  79     its mtime), in which case the cached module is discarded and the
  80     new file contents are reloaded in its place.
  81
  82     The return value is an instance of the cachedmod class, which can
  83     be used for locking purposes and for storing arbitrary meta-data
  84     about the module. See its documentation for details.
  85     """
  86     sb = os.stat(path)
  87     with cachelock:
  88         if path in modcache:
  89             entry = modcache[path]
  90         else:
  91             entry = [threading.Lock(), None]
  92             modcache[path] = entry
  93     with entry[0]:
  94         if entry[1] is None or sb.st_mtime > entry[1].mtime:
  95             with open(path, "rb") as f:
  96                 text = f.read()
  97             code = compile(text, path, "exec")
  98             mod = types.ModuleType(mangle(path))
  99             mod.__file__ = path
 100             exec(code, mod.__dict__)
 101             entry[1] = cachedmod(mod, sb.st_mtime)
 102         return entry[1]
 103
 104 class handler(object):
 105     def __init__(self):
 106         self.lock = threading.Lock()
 107         self.handlers = {}
 108         self.exts = {}
 109         self.addext("wsgi", "chain")
 110         self.addext("wsgi3", "chain")
 111
 112     def resolve(self, name):
 113         with self.lock:
 114             if name in self.handlers:
 115                 return self.handlers[name]
 116             p = name.rfind('.')
 117             if p < 0:
 118                 return globals()[name]
 119             mname = name[:p]
 120             hname = name[p + 1:]
 121             mod = importlib.import_module(mname)
 122             ret = getattr(mod, hname)
 123             self.handlers[name] = ret
 124             return ret
 125
 126     def addext(self, ext, handler):
 127         self.exts[ext] = self.resolve(handler)
 128
 129     def handle(self, env, startreq):
 130         if not "SCRIPT_FILENAME" in env:
 131             log.error("wsgidir called without SCRIPT_FILENAME set")
 132             return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "The server is erroneously configured.")
 133         path = env["SCRIPT_FILENAME"]
 134         if not os.access(path, os.R_OK):
 135             log.error("%s: not readable" % path)
 136             return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "The server is erroneously configured.")
 137         if "HTTP_X_ASH_PYTHON_HANDLER" in env:
 138             try:
 139                 handler = self.resolve(env["HTTP_X_ASH_PYTHON_HANDLER"])
 140             except Exception:
 141                 log.error("could not load handler %s" % env["HTTP_X_ASH_PYTHON_HANDLER"], exc_info=sys.exc_info())
 142                 return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "The server is erroneously configured.")
 143         else:
 144             base = os.path.basename(path)
 145             p = base.rfind('.')
 146             if p < 0:
 147                 log.error("wsgidir called with neither X-Ash-Python-Handler nor a file extension: %s" % path)
 148                 return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "The server is erroneously configured.")
 149             ext = base[p + 1:]
 150             if not ext in self.exts:
 151                 log.error("unregistered file extension: %s" % ext)
 152                 return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "The server is erroneously configured.")
 153             handler = self.exts[ext]
 154         return handler(env, startreq)
 155
 156 def wmain(*argv):
 157     """Main function for ashd(7)-compatible WSGI handlers
 158
 159     Returns the `application' function. If any arguments are given,
 160     they are parsed according to the module documentation.
 161     """
 162     hnd = handler()
 163     ret = hnd.handle
 164
 165     opts, args = getopt.getopt(argv, "-V")
 166     for o, a in opts:
 167         if o == "-V":
 168             import wsgiref.validate
 169             ret = wsgiref.validate.validator(ret)
 170
 171     for arg in args:
 172         if arg[0] == '.':
 173             p = arg.index('=')
 174             hnd.addext(arg[1:p], arg[p + 1:])
 175     return ret
 176
 177 def chain(env, startreq):
 178     """Chain-loading WSGI handler
 179
 180     This handler loads requested files, compiles them and loads them
 181     into their own modules. The compiled modules are cached and reused
 182     until the file is modified, in which case the previous module is
 183     discarded and the new file contents are loaded into a new module
 184     in its place. When chaining such modules, an object named `wmain'
 185     is first looked for and called with no arguments if found. The
 186     object it returns is then used as the WSGI application object for
 187     that module, which is reused until the module is reloaded. If
 188     `wmain' is not found, an object named `application' is looked for
 189     instead. If found, it is used directly as the WSGI application
 190     object.
 191     """
 192     path = env["SCRIPT_FILENAME"]
 193     try:
 194         mod = getmod(path)
 195     except Exception:
 196         log.error("Exception occurred when loading %s" % path, exc_info=sys.exc_info())
 197         return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "Could not load WSGI handler.")
 198     entry = None
 199     if mod is not None:
 200         with mod.lock:
 201             if hasattr(mod, "entry"):
 202                 entry = mod.entry
 203             else:
 204                 if hasattr(mod.mod, "wmain"):
 205                     entry = mod.mod.wmain()
 206                 elif hasattr(mod.mod, "application"):
 207                     entry = mod.mod.application
 208                 mod.entry = entry
 209     if entry is not None:
 210         return entry(env, startreq)
 211     return wsgiutil.simpleerror(env, startreq, 500, "Internal Error", "Invalid WSGI handler.")
 212
 213 application = handler().handle